add_image.c: Add debugging statements for branch attachment

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

diff --git a/doc/imagex-capture.1.in b/doc/imagex-capture.1.in
index 677ddcfc54b040cd4212b826b85c9f226eda3254..b306cbfad74d2b475350919999a6426114b80fdc 100644 (file)
--- a/doc/imagex-capture.1.in
+++ b/doc/imagex-capture.1.in
@@ -17,6 +17,9 @@ Imaging (WIM) image from a directory tree.  The \fBimagex capture\fR command
 creates a new WIM file containing the captured image, while the \fBimagex
 append\fR command appends the captured image to an existing WIM file.
 
+Note: this man page primarily documents the UNIX behavior.  See \fBWINDOWS
+VERSION\fR for information specific to the Windows build of wimlib.
+
 A WIM image is an independent directory tree in the WIM file.  A WIM file may
 contain any number of separate images.  However, files are stored only one time
 in the entire WIM, regardless of how many images the file appears in.
@@ -106,6 +109,29 @@ multiple files or directories to be incorporated into a WIM image using a single
 \fBimagex capture\fR or \fBimagex append\fR command.  See the documentation for
 \fB--source-list\fR below.
 
+.SH WINDOWS VERSION
+
+This section documents the differences between \fBimagex capture\fR and
+\fBimagex append\fR in the Windows builds of wimlib versus the rest of this man
+page, which is written to document UNIX build.
+
+\fBimagex capture\fR and \fBimagex append\fR do not have separate "normal" and
+"NTFS" modes on Windows.  There is simply one mode, and it uses the Windows API
+to capture NTFS-specific information, including alternate data streams, reparse
+points, hard links, and file attributes.  So, you essentially get the advantages
+of the "NTFS mode" documented above, but you can capture a WIM image from any
+directory, not just an entire NTFS volume.  This is essentially the same
+behavior as Microsoft's ImageX.
+
+The \fB--source-list\fR option is supported on Windows, but the
+\fB--dereference\fR option is not.
+
+Except for the differences documented in this section, the Windows build of
+\fBimagex capture\fR and \fBimagex append\fR should be essentially equivalent to
+the UNIX build.  However, one additional thing to note is that wimlib's Windows
+ImageX is NOT written to be command-line compatible with Microsoft's ImageX,
+although they are very similar.
+
 .SH OPTIONS
 .TP 6
 \fB--boot\fR
@@ -209,7 +235,7 @@ UNIX.  Microsoft's software will not understand this special
 information.
 .TP
 \fB--source-list\fR
-\fBimagex capture\fR and \fBimagex append\fR, as of wimlib 1.2.7, support a new
+\fBimagex capture\fR and \fBimagex append\fR, as of wimlib 1.3.0, support a new
 option to create a WIM image from multiple files or directories.  When
 \fB--source-list\fR is specified, the \fISOURCE\fR argument specifies the name
 of a text file, each line of which is either 1 or 2 whitespace separated
@@ -240,7 +266,7 @@ overlay     /overlay
 
 Subdirectories in the WIM are created as needed.  Multiple source directories
 may share the same target, which implies an overlay; however, an error is issued
-if the same file appears in different overlays.
+if the same file appears in different overlays to the same directory.
 
 Filenames containing whitespace may be quoted with either single quotes or
 double quotes.  Quotes may not be escaped.