ntfs capture: can no longer get DOS name from multi-linked files

[wimlib] / doc / imagex-capture.1.in

diff --git a/doc/imagex-capture.1.in b/doc/imagex-capture.1.in
index 1647f7a1c2ceb4b9a5d18a58651c6d50775b1d35..df4685adfbd414f39be93f033a700f37f9d75436 100644 (file)
--- a/doc/imagex-capture.1.in
+++ b/doc/imagex-capture.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX "1" "November 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "January 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands"
 .SH NAME
 imagex-capture, imagex-append \- Capture a WIM image from a directory tree
 
@@ -91,8 +91,9 @@ The security descriptor for each NTFS inode.
 .IP \[bu]
 File attribute flags.
 .IP \[bu]
-All names of all files, including names in the Win32 namespace, DOS namespace,
-Win32+DOS namespace, and POSIX namespace.  This includes hard links.
+All names of all singly-linked files, including names in the Win32 namespace,
+DOS namespace, Win32+DOS namespace, and POSIX namespace; all names of all
+multi-linked files except DOS names.
 
 .SH OPTIONS
 .TP 6
@@ -200,12 +201,23 @@ type, and \fBimagex\fR always enforces this.
 stream chunk size of 32768.  The only WIMs I've seen that are different from
 this are some pre-Vista WIMs that had a different version number.
 
-Unless --rebuild is specified, aborting an \fBimagex append\fR command mid-way
-through has a small chance of corrupting the WIM file.  However, a precaution is
-taken against this, so it should be very unlikely.  In the event of an aborted
-\fBimagex append\fR, \fBimagex optimize\fR may be run to remove extra data that
-may have been partially appended to the physical WIM file but not yet
-incorporated into the structure of the WIM.
+Unless \fB--rebuild\fR is specified, aborting an \fBimagex append\fR command
+mid-way through has a small chance of corrupting the WIM file.  However, a
+precaution is taken against this, so it should be very unlikely.  In the event
+of an aborted \fBimagex append\fR, \fBimagex optimize\fR may be run to remove
+extra data that may have been partially appended to the physical WIM file but
+not yet incorporated into the structure of the WIM.
+
+Capturing or appending an image happens in two main phases: (1) scanning the
+directory or NTFS volume to checksum all the files and determine the streams to
+be written, and (2) writing the new streams to the WIM file.  Streams are not
+stored in memory after (1), since there could easily be gigabytes of data;
+instead, they are read again during step (2); however, duplicate streams in the
+image, and streams already existing in any other image in the WIM, are not read
+again.  In the future, it may be possible to introduce the ability to capture an
+image with reading each file only one time, although this mode would have some
+limitations--- for example, a stream might be compressed only to be thrown away
+as a duplicate once it's been checksummed.
 
 .SH EXAMPLES
 Create a new WIM 'mywim.wim' from the directory 'somedir', using LZX compression and