X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fman1%2Fimagex-mount.1.in;h=b40a33f2eb96abf8a268826bbd421561feefb157;hp=c30620cd765d2622d4deca1d80c7cfaa43469dac;hb=aaa3f0eabacc3f364ee9f83069f5a063ac10d250;hpb=c07877105822d01725b36b011c93609559164b06 diff --git a/doc/man1/imagex-mount.1.in b/doc/man1/imagex-mount.1.in index c30620cd..b40a33f2 100644 --- a/doc/man1/imagex-mount.1.in +++ b/doc/man1/imagex-mount.1.in @@ -1,4 +1,4 @@ -.TH WIMLIB-IMAGEX "1" "March 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands" +.TH WIMLIB-IMAGEX "1" "August 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands" .SH NAME @IMAGEX_PROGNAME@-mount, @IMAGEX_PROGNAME@-mountrw, @IMAGEX_PROGNAME@-unmount \- Mount and unmount an image from a WIM archive .SH SYNOPSIS @@ -6,7 +6,7 @@ .br \fB@IMAGEX_PROGNAME@ mountrw\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...] .br -\fB@IMAGEX_PROGNAME@ unmount\fR \fIDIRECTORY\fR [--commit] [--check] [--rebuild] +\fB@IMAGEX_PROGNAME@ unmount\fR \fIDIRECTORY\fR [\fIOPTION\fR...] .SH DESCRIPTION The \fB@IMAGEX_PROGNAME@ mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR commands will mount the image in the Windows Imaging (WIM) file \fIWIMFILE\fR specified @@ -21,9 +21,9 @@ be the name of an image in the WIM. Use the \fB@IMAGEX_PROGNAME@ info\fR (1) command to see the available images in the WIM. \fIIMAGE\fR may be omitted if \fIWIMFILE\fR contains only one image. .PP -The WIM image can be unmounted using the \fB@IMAGEX_PROGNAME@ unmount\fR command. Changes -made to a WIM mounted read-write will be discarded unless the \fB--commit\fR -flag is provided to \fB@IMAGEX_PROGNAME@ unmount\fR. +The WIM image can be unmounted using the \fB@IMAGEX_PROGNAME@ unmount\fR +command. Changes made to a WIM mounted read-write will be discarded unless the +\fB--commit\fR flag is provided to \fB@IMAGEX_PROGNAME@ unmount\fR. .SH SPLIT WIMS You may use \fB@IMAGEX_PROGNAME@ mount\fR to mount an image from a split WIM read-only. However, you may not mount an image from a split WIM read-write. @@ -62,23 +62,23 @@ All files in the mounted WIM will be accessible regardless of whether there is a security descriptor in the WIM associated with the file or not. New files or directories created in a read-write mounted WIM will be created with no security descriptor. Although there is support for accessing named data streams (see the -\fB--streams-interface\fR option), it is currently not possible -to set or get DOS names, file attributes, or security -descriptors in a mounted WIM. +\fB--streams-interface\fR option), it is currently not possible to set or get +DOS names, file attributes, or security descriptors in a mounted WIM. .PP By default, changes to a read-write WIM are made in-place by appending to the WIM. This is nice for big WIM files, since the entire file doesn't have to be rebuilt to make a small change. But, if you are making many changes to a read-write mounted WIM, especially deleting large files, it is suggested to -provide the \fB--rebuild\fR option to \fB@IMAGEX_PROGNAME@ unmount\fR to force the WIM to -be rebuilt, or else run \fB@IMAGEX_PROGNAME@ optimize\fR on the WIM afterwards. +provide the \fB--rebuild\fR option to \fB@IMAGEX_PROGNAME@ unmount\fR to force +the WIM to be rebuilt, or else run \fB@IMAGEX_PROGNAME@ optimize\fR on the WIM +afterwards. .PP -wimlib v1.6.0 and later can mount version 3584 WIMs, which usually use packed, -LZMS-compressed streams and may carry the \fI.esd\fR file extension rather than -\fI.wim\fR. However, such files are not designed for random access, so reading -data from them when mounted may be very slow. In addition, \fI.esd\fR files -downloaded directly by the Windows 8 web downloader have encrypted segments, and -wimlib cannot mount such files until they are first decrypted. +wimlib v1.6.0 and later can mount version 3584 WIMs, which usually contain +LZMS-compressed solid blocks and may carry the \fI.esd\fR file extension rather +than \fI.wim\fR. However, such files are not designed for random access, so +reading data from them when mounted may be very slow. In addition, \fI.esd\fR +files downloaded directly by the Windows 8 web downloader have encrypted +segments, and wimlib cannot mount such files until they are first decrypted. .SH MOUNT OPTIONS .TP 6 \fB--check\fR @@ -123,17 +123,20 @@ Store temporary staging files in a subdirectory of the directory \fIDIR\fR. Only valid for \fB@IMAGEX_PROGNAME@ mountrw\fR. .TP \fB--unix-data\fR -By default, \fB@IMAGEX_PROGNAME@ mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR will ignore both -Windows-style security descriptors (which may have been set either from Windows or by -\fB@IMAGEX_PROGNAME@ capture\fR from a NTFS-volume) and UNIX-specific data (which is from using -\fB@IMAGEX_PROGNAME@ capture\fR with the \fB--unix-data\fR flag). In this default mode, -all files will simply be owned by the user running \fB@IMAGEX_PROGNAME@\fR and will have mode 0777. -(Note: they will still not be accessible to other users unless you also specify -\fB--allow-other\fR.) If you instead provide the \fB--unix-data\fR flag, these -default permissions will be overridden on a per-file basis with the -UNIX-specific data when available, and in the case of \fB@IMAGEX_PROGNAME@ mountrw\fR it -will be possible to change the UNIX permissions using the standard UNIX -tools and functions. +Honor UNIX-specific metadata that was captured by \fB@IMAGEX_PROGNAME@ +capture\fR with the \fB--unix-data option\fR. By default, \fB@IMAGEX_PROGNAME@ +mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR will ignore both Windows-style +security descriptors (which may have been set either from Windows or by +\fB@IMAGEX_PROGNAME@ capture\fR from an NTFS-volume) and UNIX-specific metadata. +In this default mode, all files will simply be owned by the user running +\fB@IMAGEX_PROGNAME@\fR and will have mode 0777. (Note: they will still not be +accessible to other users unless you also specify \fB--allow-other\fR.) If you +instead provide the \fB--unix-data\fR option, these default permissions will be +overridden on a per-file basis with the UNIX-specific data when available, and +in the case of \fB@IMAGEX_PROGNAME@ mountrw\fR it will be possible to change the +UNIX permissions using the standard UNIX tools and functions. In addition, with +wimlib v1.7.0 and later, you can create device nodes, named pipes, and sockets +on the mounted filesystem and have them stored in the WIM image. .TP \fB--allow-other\fR Pass the \fBallow_other\fR option to the FUSE mount. See \fBmount.fuse\fR (8). @@ -145,6 +148,15 @@ specified in /etc/fuse.conf (with the FUSE implementation on Linux, at least). Update the WIM file with the changes that have been made. Has no effect if the mount is read-only. .TP +\fB--force\fR +In combination with \fB--commit\fR, force the WIM image to be committed even if +there are open file descriptors to the WIM image. Any such file descriptors +will be immediately closed, and the WIM image will be committed and unmounted. +.IP +\fB--lazy\fR is a deprecated alias for \fB--force\fR. (Unmounts are now "lazy" +by default with regards to the kernel-level mountpoint, except in the case with +\fB--commit\fR described above.) +.TP \fB--check\fR When writing \fIWIMFILE\fR, include an integrity table. Has no effect if the mount is read-only or if \fB--commit\fR was not specified. The default behavior @@ -156,28 +168,23 @@ Rebuilding the WIM is slower, but will save a little bit of space that would otherwise be left as a hole in the WIM. Even more space will be saved if the read-write mount resulted in streams being deleted from the WIM. Also see .TP -\fB--lazy\fR -Pass the \fB-z\fR option to \fBfusermount\fR, which performs a "lazy" unmount -where the filesystem is detached immediately even if it is still busy. However, -even with this option, \fB@IMAGEX_PROGNAME@ unmount\fR still waits for the -filesystem to become unbusy; \fB--lazy\fR will only stop the unmount from -immediately failing. -.TP \fB--new-image\fR In combination with \fB--commit\fR for a read-write mounted image, causes the modified image to be committed as a new, unnamed image appended to the WIM archive. The original image will be unmodified. .SH IMPLEMENTATION DETAILS -Since a WIM is an archive and not a filesystem, \fB@IMAGEX_PROGNAME@ mountrw\fR creates a -temporary staging directory to contain files that are created or modified. This -directory is located in the same directory as \fIWIMFILE\fR by default, but the -location can be set using the \fB--staging-dir\fR option. When the filesystem -is unmounted with \fB--commit\fR, the WIM is modified in-place (or rebuild -completely with \fB--rebuild\fR), merging in the staging files as needed. Then, -the temporary staging directory is deleted. +Since a WIM is an archive and not a filesystem, \fB@IMAGEX_PROGNAME@ mountrw\fR +creates a temporary staging directory to contain files that are created or +modified. This directory is located in the same directory as \fIWIMFILE\fR by +default, but the location can be set using the \fB--staging-dir\fR option. When +the filesystem is unmounted with \fB--commit\fR, the WIM is modified in-place +(or rebuilt completely with \fB--rebuild\fR), merging in the staging files as +needed. Then, the temporary staging directory is deleted. .PP -\fB@IMAGEX_PROGNAME@ unmount\fR runs in a separate process from the process that previously -ran \fB@IMAGEX_PROGNAME@ mount\fR, and these two processes communicate using POSIX message -queues. See \fIsrc/mount_image.c\fR in the sources for details. +\fB@IMAGEX_PROGNAME@ unmount\fR runs in a separate process from the process that +previously ran \fB@IMAGEX_PROGNAME@ mount\fR. When unmounting a read-write +mounted WIM image with \fB--commit\fR, these two processes communicate using a +POSIX message queue so that the unmount process can track the progress of the +mount process. See \fIsrc/mount_image.c\fR in the sources for details. .SH SEE ALSO .BR @IMAGEX_PROGNAME@ (1)