]> wimlib.net Git - wimlib/blobdiff - doc/imagex-capture.1.in
imagex-capture.1.in: Fix brackets in --update-of docs
[wimlib] / doc / imagex-capture.1.in
index 407f063c97fcf1ae5790061b77853d8714cc9792..3ca9ecd2ebf264c04c037548ec1d4f188f3f6963 100644 (file)
@@ -24,13 +24,13 @@ in the entire WIM, regardless of how many images the file appears in.
 \fISOURCE\fR specifies the location of the files to create the new WIM image
 from.  If \fISOURCE\fR is a directory, the WIM image is captured from that
 directory (see \fBDIRECTORY CAPTURE (UNIX)\fR or \fBDIRECTORY CAPTURE
-(WINDOWS)\fR.   Alternatively, if the \fB--source-list\fR option is specified,
+(WINDOWS)\fR).   Alternatively, if the \fB--source-list\fR option is specified,
 \fISOURCE\fR is interpreted as a file that itself provides a list of
 files and directories to include in the new WIM image.  Still
 alternatively, only on UNIX-like systems, if \fISOURCE\fR is a
 regular file or block device, it is interpreted as an NTFS volume from
 which a WIM image is to be captured using libntfs-3g (see \fBNTFS VOLUME CAPTURE
-(UNIX)\fR.
+(UNIX)\fR).
 .PP
 \fIIMAGE_NAME\fR and \fIIMAGE_DESCRIPTION\fR specify the name and description to
 give the new WIM image.  If \fIIMAGE_NAME\fR is not specified, it defaults to
@@ -60,14 +60,11 @@ will \fInot\fR be stored is:
 UNIX file owners, groups, and modes.  (Exception: see the \fB--unix-data\fR
 option.)  As a result, file permissions will not be stored, and files that are
 neither regular files, directories, nor symbolic links, such as device files and
-FIFOs, cannot be captured.
+FIFOs, cannot be captured and will be excluded by default.
 .IP \[bu]
 Extended attributes.  This mainly includes extensions to the traditional UNIX
 security model, such as SELinux security labels, POSIX ACLs, and capabilities
 labels.
-.IP \[bu]
-Files that are neither regular files, directories, nor symbolic links, such as
-device files and FIFOs.  These will be excluded by default.
 .PP
 Notes: hard links and symbolic links are supported by the WIM format and
 \fIare\fR stored.  (Symbolic links are turned into "native" Windows symbolic
@@ -77,14 +74,13 @@ granularity and include last modification time (mtime) and last access time
 (atime), but not last status change time (ctime).
 .SH NTFS VOLUME CAPTURE (UNIX)
 This section documents how \fB@IMAGEX_PROGNAME@\fR captures files directly from
-an NTFS volume image on UNIX-like systems.  See \fBDIRECTORY CAPTURE
-(WINDOWS)\fR for the corresponding documentation for Windows.
+an NTFS volume image on UNIX-like systems.
 .PP
 On UNIX-like systems, a special image capture mode is entered when \fISOURCE\fR
 is a regular file or block device.  In this mode, \fISOURCE\fR is assumed to be
-an NTFS volume or volume image, and wimlib will capture a WIM image containing a
-full contents of the NTFS volume, including NTFS-specific data.  This is done
-using libntfs-3g.
+an NTFS volume or volume image, and \fB@IMAGEX_PROGNAME@\fR will capture a WIM
+image containing the full contents of the NTFS volume, including NTFS-specific
+data.  This is done using libntfs-3g.
 .PP
 Please note that the NTFS volume capture mode is \fInot\fR entered if
 \fISOURCE\fR is a directory, even if an NTFS filesystem is mounted on
@@ -133,9 +129,7 @@ supported.
 On Windows, \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR
 try to archive as much data and metadata as possible, including:
 .IP \[bu] 4
-All data streams of all files, unless running on a version of Windows prior to
-Vista, in which case named data streams (if supported by the source filesystem)
-will not be captured.
+All data streams of all files.
 .IP \[bu]
 Reparse points, including symbolic links, junction points, and other reparse
 points, if supported by the source filesystem.  (Note: see \fB--rpfix\fR and
@@ -166,7 +160,7 @@ Note: the capture process is reversible, since when \fB@IMAGEX_PROGNAME@
 apply\fR (on Windows) extracts the captured WIM image, it will extract all of
 the above information, at least to the extent supported by the destination
 filesystem.  One exception is that since encrypted files are stored as
-unencrypted, their data will not be available if restored on a Windows system
+encrypted, their data will not be available if restored on a Windows system
 that does not have the decryption key.
 .SH OPTIONS
 .TP 6
@@ -394,26 +388,27 @@ default for \fB@IMAGEX_PROGNAME@ capture\fR, except when writing to standard
 output (\fIWIMFILE\fR specified as "-"), and also for \fB@IMAGEX_PROGNAME@
 append\fR, except when appending to a WIM that is already pipable.
 .TP
-\fB--update-of\fR=[\fIWIMFILE\fR]:\fIIMAGE\fR
-Declares that the image being captured from \fISOURCE\fR is mostly the same as
+\fB--update-of\fR=[\fIWIMFILE\fR:]\fIIMAGE\fR
+Declares that the image being captured or appended from \fISOURCE\fR is mostly the same as
 the existing image \fIIMAGE\fR in \fIWIMFILE\fR, but captured at a later point
 in time, possibly with some modifications in the intervening time.  This is
 designed to be used in incremental backups of the same filesystem or directory
 tree.  \fIIMAGE\fR can be a 1-based index or name of an existing image in
 \fIWIMFILE\fR.  It can also be a negative integer to index backwards into the
-images (e.g.  -1 means the last existing image).
+images (e.g.  -1 means the last existing image in \fIWIMFILE\fR).
 .IP ""
 When this option is provided, the capture or append of the new image will be
 optimized by not reading files that, based on metadata such as timestamps,
 appear not to have been modified since they were archived in the existing
 \fIIMAGE\fR.  Barring manipulation of timestamps, this option only affects
-performance and does not change the resulting WIM file.
+performance and does not change the resulting WIM image.
 .IP ""
 As shown, the full syntax for the argument to this option is to specify the WIM
 file, a colon, and the image; for example, "--update-of mywim.wim:1".
-However, the WIM file may be omitted, in which case it will default to the WIM
-file being appended to for append operations, or the WIM file from which a delta
-is being taken (with \fB--delta-from\fR, if specified) for capture operations.
+However, the WIM file and colon may be omitted, in which case the WIM file will
+default to the WIM file being appended to for append operations, or the WIM file
+from which a delta is being taken (with \fB--delta-from\fR, if specified) for
+capture operations.
 .TP
 \fB--delta-from\fR=\fIWIMFILE\fR
 For \fB@IMAGEX_PROGNAME@ capture\fR only: capture the new WIM as a "delta" from