]> wimlib.net Git - wimlib/blobdiff - doc/imagex-capture.1.in
Update debian package
[wimlib] / doc / imagex-capture.1.in
index c04f2bc6fe1265961e1a3f4fcce317d4bcebd099..c345bd66a5b43a447a4981afdeb90033ac6fd38d 100644 (file)
@@ -2,8 +2,8 @@
 .SH NAME
 @IMAGEX_PROGNAME@-capture, @IMAGEX_PROGNAME@-append \- Create or append a WIM image
 .SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ capture\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR] \
-[\fIIMAGE_DESCRIPTION\fR] [\fIOPTION\fR...]
+\fB@IMAGEX_PROGNAME@ capture\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR \
+[\fIIMAGE_DESCRIPTION\fR]] [\fIOPTION\fR...]
 .br
 \fB@IMAGEX_PROGNAME@ append\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR \
 [\fIIMAGE_DESCRIPTION\fR]] [\fIOPTION\fR...]
@@ -23,7 +23,7 @@ from.  If \fISOURCE\fR is a directory, the WIM image is captured from that
 directory.   Alternatively, if the \fB--source-list\fR option is given,
 \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 builds of wimlib  if \fISOURCE\fR is a
+alternatively, only on UNIX builds of wimlib, 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. 
 .PP
@@ -193,7 +193,7 @@ For compatibility with Windows, the path separators in the globs may be either
 forward slashes or backslashes, and the line separators may be either UNIX-style
 or DOS-style.  Globs with spaces in them must be quoted, and leading and
 trailing whitespace is not significant.  Empty lines and lines beginning with
-'#' or whitespace followed by '#' are ignored.
+\'#' or whitespace followed by '#' are ignored.
 .IP ""
 Paths may not have drive letters in them, as they are all relative to the root
 of capture and not absolute external paths.
@@ -245,10 +245,10 @@ absolute symbolic links that point outside the directory tree being captured
 will be ignored and not be captured at all.  When disabled (\fB--norpfix\fR),
 absolute symbolic links will be captured exactly as is.
 .IP ""
-The default behavior for \fBimagex capture\fR is equivalent to \fB--rpfix\fR.
-The default behavior for \fBimagex append\fR will be \fB--rpfix\fR if reparse
-point fixups have previously been done on \fIWIMFILE\fR, otherwise
-\fB--norpfix\fR.
+The default behavior for \fB@IMAGEX_PROGNAME@ capture\fR is equivalent to
+\fB--rpfix\fR.  The default behavior for \fB@IMAGEX_PROGNAME@ append\fR will be
+\fB--rpfix\fR if reparse point fixups have previously been done on
+\fIWIMFILE\fR, otherwise \fB--norpfix\fR.
 .IP ""
 In the case of a multi-source capture, (\fB--source-list\fR specified), passing
 \fB--norpfix\fR is recommended.  Otherwise, reparse point fixups will be
@@ -301,7 +301,7 @@ input rather than an external file.
 The NTFS capture mode cannot be used with \fB--source-list\fR, as only capturing
 a full NTFS volume is supported.
 .SH NOTES
-\fBimage append\fR does not support appending an image to a split WIM.
+\fB@IMAGEX_PROGNAME@ append\fR does not support appending an image to a split WIM.
 .PP
 The different capture modes only specify the data that is captured and don't
 specify a special WIM format.  A WIM file can contain images captured using
@@ -323,6 +323,14 @@ itself.  However, additional symbolic links in subdirectories, or in additional
 source directories not destined for the WIM image root (with
 \fB--source-list\fR), are not dereferenced unless \fB--dereference\fR is
 specified.
+.PP
+With the UNIX version of \fB@IMAGEX_PROGNAME@\fR, it is possible to create a WIM
+image containing files with names differing only in case, or files with names
+containing the characters ':', '*', '?', '"', '<', '>', '|', or '\\', which are
+valid on POSIX-compliant filesystems but not Windows.  Be warned that such files
+will not be extracted by default by the Windows version of
+\fB@IMAGEX_PROGNAME@\fR, and Microsoft's ImageX might get confused by such
+names.
 .SH EXAMPLES
 Create a new WIM 'mywim.wim' from the directory 'somedir', using LZX compression and
 including an integrity table: