More documentation updates

diff --git a/TODO b/TODO
index dbc3c8d7420544cbe04db70c6844961aa21f4f2b..2e10e8530f4911844ae7a9bbeb740bab178b2070 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,4 +1,4 @@
-See the LIMITATIONS section on the main page of the Doxygen documentation for
-wimlib.
-
-There should be some test cases to test the library.
+- Fix bugs
+- Add more test cases
+- Better support for split WIMs
+- Implement LZX block splitting to improve compression ratio

diff --git a/doc/imagex-append.1.in b/doc/imagex-append.1.in
index b48bfdb975a89b6684cbe1e1b22a6cbffb35028d..da020ce8ec572c3759f3f7015b5dd7339b383902 100644 (file)
--- a/doc/imagex-append.1.in
+++ b/doc/imagex-append.1.in
@@ -1,48 +1 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
-.SH NAME
-imagex append \- Append a directory to a WIM archive as a new image
-
-.SH SYNOPSIS
-\fBimagex append\fR \fIDIRECTORY\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR] \
-[\fIDESCRIPTION\fR] [\fIOPTION\fR]...
-
-.SH DESCRIPTION
-.PP
-Captures a WIM image from \fIDIRECTORY\fR and appends it to \fIWIMFILE\fR, which
-must be a valid WIM archive.  \fIDIRECTORY\fR becomes the root directory of the
-image.
-
-\fIIMAGE_NAME\fR and \fIDESCRIPTION\fR specify the name and description of the
-new image.  If \fIIMAGE_NAME\fR is not given, it is taken to be the same as the
-base name of \fIDIRECTORY\fR.  If \fIDESCRIPTION\fR is not given, the
-description is taken to be empty.
-
-.SH OPTIONS
-.TP 6
-\fB--boot\fR
-Specifies that the new image is to be the bootable image of the WIM archive.
-.TP
-\fB--check\fR
-When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
-present; additionally, when writing \fIWIMFILE\fR with the new image added,
-write an integrity table.  If this option is not specified, no integrity table
-is included in the new WIM file, even if there was one before.
-.TP
-\fB--flags\fR \fIEDITIONID\fR
-Specify a string to use in the <FLAGS> element of the XML data for the image.
-.TP
-\fB--dereference\fR
-Follow symlinks; archive and dump the files they point to.  (The default is to
-archive the symlinks themselves)
-
-.SH EXAMPLES
-.IP 
-image append boot.wim winpe/ "Microsoft Windows PE"
-.LP 
-Add a new image to the existing WIM file boot.wim.  The files in the directory 'winpe' 
-are added recursively to the image.  The image is given the name "Microsoft
-Windows PE" and no description.
-
-.SH SEE ALSO
-.BR imagex (1)
-
+.so man1/imagex-capture.1

diff --git a/doc/imagex-apply.1.in b/doc/imagex-apply.1.in
index 0c81915b2f95fbb05700f1ecc6217e076040fca1..b4b16eaeec7fcbe1508992b3e857797ec071ed0c 100644 (file)
--- a/doc/imagex-apply.1.in
+++ b/doc/imagex-apply.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"

 .SH NAME
 imagex apply \- Extract one image, or all images, from a WIM archive
 
 .SH NAME
 imagex apply \- Extract one image, or all images, from a WIM archive
 


@@ -31,12 +31,13 @@ extracted with the root of the image corresponding to the directory named by
 \fBTARGET\fR; or, if the keyword \fBall\fR is given, the images are extracted
 into subdirectories of \fITARGET\fR that will be named after the image names,
 falling back to the image indices if there is an image with no name.
 \fBTARGET\fR; or, if the keyword \fBall\fR is given, the images are extracted
 into subdirectories of \fITARGET\fR that will be named after the image names,
 falling back to the image indices if there is an image with no name.

+\fITARGET\fR can specify a directory on any type of filesystem.

 
 In the normal mode of extraction, the following information will be extracted
 from the WIM image(s):
 
 .IP \[bu] 4
 
 In the normal mode of extraction, the following information will be extracted
 from the WIM image(s):
 
 .IP \[bu] 4

-The default (unnamed) data streams of each file
+The default (unnamed) data stream of each file

 .IP \[bu]
 Hard links, if supported by the underlying filesystem
 .IP \[bu]
 .IP \[bu]
 Hard links, if supported by the underlying filesystem
 .IP \[bu]


@@ -77,6 +78,11 @@ the \fBmkntfs\fR (8) command.
 The NTFS extraction mode is not available if wimlib was compiled using the
 --without-ntfs-3g option.
 
 The NTFS extraction mode is not available if wimlib was compiled using the
 --without-ntfs-3g option.
 

+Please note that the NTFS extraction mode is \fInot\fR entered if \fITARGET\fR
+is a directory, even if a NTFS filesystem is mounted on \fITARGET\fR.  You must
+specify the NTFS volume itself (and it must be unmounted, and you must have
+permission to write to it).
+

 In the NTFS extraction mode, the following information will be extracted from
 the WIM image:
 
 In the NTFS extraction mode, the following information will be extracted from
 the WIM image:
 


@@ -176,6 +182,16 @@ extracted, and some additional informational messages.
 
 \fBimagex apply\fR does not yet support split WIMs.
 
 
 \fBimagex apply\fR does not yet support split WIMs.
 

+\fBimagex apply\fR calculates the SHA1 message digest of every file stream it
+extracts and verifies that it is the same as the SHA1 message digest provided in
+the WIM file.  It is an error if the message digests don't match.  It's also
+considered to be an error if any WIM resources cannot be found in the stream
+lookup table.  So you can be sure that the files are extracted correctly, even
+though we don't provide a \fB/verify\fR option like Microsoft's version of
+imagex does.  Please note that this is separate from the integrity table of the
+WIM, which provides SHA1 message digests over raw chunks of the entire WIM file
+and is checked separately if the \fB--check\fR option is specified.
+

 .SH EXAMPLES
 .SS Normal extraction mode
 Extract the first image from the Windows PE image from the Windows Vista/7/8
 .SH EXAMPLES
 .SS Normal extraction mode
 Extract the first image from the Windows PE image from the Windows Vista/7/8

diff --git a/doc/imagex-capture.1.in b/doc/imagex-capture.1.in
index 5e76499d3296eda60aeb59e8d00b68f83dc1fe57..5e5fe0bdff27dbf5609bddc55d7a9564d2034566 100644 (file)
--- a/doc/imagex-capture.1.in
+++ b/doc/imagex-capture.1.in
@@ -1,22 +1,98 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"

 .SH NAME
 .SH NAME

-imagex capture \- Create a new WIM file from a directory.
+imagex capture, append \- Capture a WIM image from a directory tree

 
 .SH SYNOPSIS
 
 .SH SYNOPSIS

-\fBimagex capture\fR \fIDIRECTORY\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR] \
+\fBimagex capture\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR] \
+[\fIDESCRIPTION\fR] [\fIOPTION\fR]...
+.br
+\fBimagex append\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR] \

 [\fIDESCRIPTION\fR] [\fIOPTION\fR]...
 
 .SH DESCRIPTION
 .PP
 
 [\fIDESCRIPTION\fR] [\fIOPTION\fR]...
 
 .SH DESCRIPTION
 .PP
 

-Captures a WIM image from \fIDIRECTORY\fR and creates a new WIM archive,
-\fIWIMFILE\fR, that contains it.  \fIDIRECTORY\fR becomes the root directory of
-the image.
+The \fBimagex capture\fR and \fBimagex append\fR commands create a Windows
+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.
+
+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.
+
+\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.  If \fISOURCE\fR is a regular file or block device, it is interpreted
+as a NTFS volume from which a WIM image is to be captured.

 
 \fIIMAGE_NAME\fR and \fIDESCRIPTION\fR specify the name and description of the
 new image.  If \fIIMAGE_NAME\fR is not given, it is taken to be the same as the
 
 \fIIMAGE_NAME\fR and \fIDESCRIPTION\fR specify the name and description of the
 new image.  If \fIIMAGE_NAME\fR is not given, it is taken to be the same as the

-base name of \fIDIRECTORY\fR.  If \fIDESCRIPTION\fR is not given, the
-description is taken to be empty.
+base name of \fISOURCE\fR.  If \fIDESCRIPTION\fR is not given, no description is
+given to the new image.
+
+.SH NORMAL MODE
+
+The normal image capture mode is entered when \fISOURCE\fR specifies a
+directory.  The WIM image will be captured from the directory tree rooted at
+this directory.  The directory may be on any type of filesystem.
+
+In this normal image capture mode, we capture the following information from the
+directory tree:
+
+.IP \[bu] 4
+The "normal" name and contents of each file and directory
+.IP \[bu]
+File and directory creation, access, and modification timestamps to the nearest
+nanosecond, if supported by the underlying filesystem
+.IP \[bu]
+Hard links and symbolic links
+
+.PP
+
+However, in the normal image capture mode, we do \fInot\fR capture the following
+information from the directory tree:
+
+.IP \[bu] 4
+File permissions.  The resulting WIM image will not contain any security
+descriptors because the format of the security descriptors is Windows-specific,
+and they cannot contain UNIX file modes.
+.IP \[bu]
+No alternate data streams will be captured, since these do not exist on
+POSIX-compliant filesystems.  The resulting WIM image will not contain any
+alternate data streams.
+
+.SH NTFS MODE
+
+A special image capture mode is entered when \fISOURCE\fR is a regular file or
+block device.  \fISOURCE\fR is interpreted as an NTFS volume and opened using
+libntfs-3g.  If successful, a WIM image is captured containing the contents of
+the NTFS volume, including NTFS-specific data.
+
+Please note that the NTFS image capture mode is \fInot\fR entered if
+\fISOURCE\fR is a directory, even if a NTFS filesystem is mounted on
+\fISOURCE\fR.  You must specify the NTFS volume itself (and it must be
+unmounted, and you must have permission to read from it).
+
+More specifically, in this mode, we capture the following types of information
+from the NTFS volume:
+
+.IP \[bu] 4
+All data streams of all files, including the un-named data stream as well as all
+named data streams.
+.IP \[bu]
+Reparse points, including symbolic links, junction points, and other reparse
+points.
+.IP \[bu]
+File and directory creation, access, and modification timestamps from NTFS
+inodes (these have a resolution of 100 nanoseconds).
+.IP \[bu]
+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.

 
 .SH OPTIONS
 .TP 6
 
 .SH OPTIONS
 .TP 6


@@ -24,30 +100,113 @@ description is taken to be empty.
 Specifies that the new image is to be made the bootable image of the WIM archive.
 .TP
 \fB--check\fR
 Specifies that the new image is to be made the bootable image of the WIM archive.
 .TP
 \fB--check\fR

-Include an integrity table in the new WIM file.
+Include an integrity table in the new WIM file or the modified WIM file.  If
+this option is not specified, no integrity table is included in \fIWIMFILE\fR,
+even if there was one before in the case of \fBimagex append\fR.

 .TP
 .TP

-\fB--compress\fR[=\fITYPE\fR]
-Specifies the compression type for the WIM file.  \fITYPE\fR may be "none",
-"maximum", or "fast".  By default, the compression type is "none".  If \fB--compress\fR
-is specified but \fITYPE\fR is not, the compression type is taken to be
-"maximum", which is LZX compression.  "fast" compression is XPRESS compression.
+\fB--compress\fR=\fITYPE\fR
+Specifies the compression type for the new WIM file.  This flag is only valid
+for \fBimagex capture\fR, since the compression mode for \fBimagex append\fR
+must be the same as that of the existing WIM.  \fITYPE\fR may be "none",
+"maximum", or "fast".  By default, it is "fast".
+
+You may also specify the actual names of the compression algorithms, "XPRESS"
+and "LZX", instead of "fast" and "maximum", respectively.

 .TP
 .TP

-\fB--flags\fR \fIEDITIONID\fR
-Specify a string to use in the <FLAGS> element of the XML data for the image.
+\fB--flags\fR=\fIEDITIONID\fR
+Specify a string to use in the <FLAGS> element of the XML data for the new
+image.

 .TP
 \fB--verbose\fR
 .TP
 \fB--verbose\fR

-Print the names of files and directories as they are captured.
+Print the names of files and directories as they are captured, as well as a few
+other informational messages.

 .TP
 \fB--dereference\fR
 Follow symlinks; archive and dump the files they point to.  (The default is to
 .TP
 \fB--dereference\fR
 Follow symlinks; archive and dump the files they point to.  (The default is to

-archive the symlinks themselves)
+archive the symlinks themselves.)  This flag is only valid in the normal image
+capture mode.
+.TP
+\fB--config\fR=\fIFILE\fR
+Specifies a configuration file for capturing the new image.  The configuration
+file specifies files that are to be treated specially during the image capture.
+
+The format of the configuration file is a number of sections containing file
+globs one per line, where each section begins with the tag [ExclusionList],
+[ExclusionException], [CompressionExclusionList], or [AlignmentList].
+Currently, only the [ExclusionList] and [ExclusionException] sections are
+implemented.  The [ExclusionList] section specifies a list of file globs to
+exclude from capture, while the [ExclusionException] section specifies a list of
+file globs to include in the capture even if the matched file or directory name
+also appears in the [ExclusionList].
+
+Relative globs with only one path component match against a filename in any
+directory.  Relative globs with multiple path components, as well as absolute
+globs, are treated as paths starting at the root directory of capture, or the
+root of the NTFS volume for NTFS capture mode.  If a directory is matched by a
+glob in the [ExclusionList], the entire directory tree rooted at that directory
+is excluded from the capture, unless \fB--dereference\fR is specified and there
+is another path into that directory through a symbolic link.
+
+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.  However, globs with spaces in them currently must not be quoted.
+Empty lines are ignored.
+
+If this option is not specified the following default configuration file is
+used:
+
+.RS
+.RS
+.PP
+.nf
+[ExclusionList]
+\\$ntfs.log
+\\hiberfil.sys
+\\pagefile.sys
+\\System Volume Information
+\\RECYCLER
+\\Windows\\CSC
+
+[CompressionExclusionList]
+*.mp3
+*.zip
+*.cab
+\\WINDOWS\\inf\\*.pnf
+.RE
+.RE
+
+.SH NOTES
+
+\fBimage append\fR does not support appending an image to a split WIM.
+
+The two 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
+different modes.  However, all images in a WIM must have the same compression
+type, and \fBimagex\fR always enforces this.
+
+\fBimagex\fR writes WIMs having the version number 0x10d00 and a compressed
+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.

 
 .SH EXAMPLES
 
 .SH EXAMPLES

-.IP 
-image capture boot boot.wim --compress=maximum --check
-.LP 
-Create a new WIM 'boot.wim' from the directory 'boot', using LZX compression and
-including an integrity table.
+Create a new WIM 'mywim.wim' from the directory 'somedir', using LZX compression and
+including an integrity table:
+.RS
+.PP
+imagex capture somedir mywim.wim --compress=maximum --check
+.RE
+.PP
+Append an image to the WIM we just captured, but do it from a NTFS volume on the
+partition /dev/sda2, and name the image "Windows 7" and give it a description.
+You do not need to specify the compression type, because the WIM already is
+using LZX compression and this cannot be changed.  You need to specify --check
+if you don't want the integrity table to be discarded.
+.RS
+.PP
+imagex append /dev/sda2 mywim.wim --check "Windows 7" "Warning: This operating
+system has been approved by Bill Gates"
+.RE
+.PP

 
 .SH SEE ALSO
 .BR imagex (1)
 
 .SH SEE ALSO
 .BR imagex (1)

diff --git a/doc/imagex-delete.1.in b/doc/imagex-delete.1.in
index 463171449fc444b306c1c82b555b8122a884c910..0594c3345610751376dc8d4ca93e3c7f85e37613 100644 (file)
--- a/doc/imagex-delete.1.in
+++ b/doc/imagex-delete.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"

 .SH NAME
 imagex delete \- Delete an image from a WIM archive
 
 .SH NAME
 imagex delete \- Delete an image from a WIM archive
 

diff --git a/doc/imagex-dir.1.in b/doc/imagex-dir.1.in
index 266ca18063eee111d45d5200ae51e461b103c9aa..229628fe4c491b7be7d6b490a06d7ec5cf18fedf 100644 (file)
--- a/doc/imagex-dir.1.in
+++ b/doc/imagex-dir.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"

 .SH NAME
 imagex dir \- Show the files contained in a WIM archive
 
 .SH NAME
 imagex dir \- Show the files contained in a WIM archive
 

diff --git a/doc/imagex-export.1.in b/doc/imagex-export.1.in
index 63ed09d2ab2f4c73ac3335790fb0570b91a399e2..d455e9d140a32194ab4effb295de50e15e0d6804 100644 (file)
--- a/doc/imagex-export.1.in
+++ b/doc/imagex-export.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"

 .SH NAME
 imagex export \- Exports an image from a WIM archive to an existing or new WIM archive
 
 .SH NAME
 imagex export \- Exports an image from a WIM archive to an existing or new WIM archive
 

diff --git a/doc/imagex-info.1.in b/doc/imagex-info.1.in
index 19b9cffe78266002f6b0fb5be08a9d71682e54ba..efbeb7c6ad216cf6a93a6791a116618bd69f9321 100644 (file)
--- a/doc/imagex-info.1.in
+++ b/doc/imagex-info.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"

 .SH NAME
 imagex info \- Display information about a WIM file, or change information about
 an image
 .SH NAME
 imagex info \- Display information about a WIM file, or change information about
 an image

diff --git a/doc/imagex-join.1.in b/doc/imagex-join.1.in
index 5b65238c9ee69cb0e9b05247f5af827ce590353b..596049f2faa94c8f33b18b5be0584122499572fe 100644 (file)
--- a/doc/imagex-join.1.in
+++ b/doc/imagex-join.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"

 .SH NAME
 imagex join \- Join split WIMs into a standalone one-part WIM
 
 .SH NAME
 imagex join \- Join split WIMs into a standalone one-part WIM
 

diff --git a/doc/imagex-mount.1.in b/doc/imagex-mount.1.in
index b9786c9fb8aa31b4737041cab491fbe8b585ba02..3f5eb4a6b6fe69994cea0ed296920d2bd09f5120 100644 (file)
--- a/doc/imagex-mount.1.in
+++ b/doc/imagex-mount.1.in
@@ -45,7 +45,7 @@ Mounting split WIMs is not yet supported.
 \fB--check\fR
 When reading the WIM, verify its integrity if it contains an integrity table.
 .TP
 \fB--check\fR
 When reading the WIM, verify its integrity if it contains an integrity table.
 .TP

-\fB--stream-interface\fR \fIINTERFACE\fR
+\fB--streams-interface\fR=\fIINTERFACE\fR

 
 This option is inspired by the ntfs-3g filesystem driver (see \fBntfs-3g\fR
 (8)).  It controls how alternate data streams, or named data streams, in WIM
 
 This option is inspired by the ntfs-3g filesystem driver (see \fBntfs-3g\fR
 (8)).  It controls how alternate data streams, or named data streams, in WIM

diff --git a/doc/imagex-split.1.in b/doc/imagex-split.1.in
index a1356df3e73320f0aa3acb114dce5e83c473dab1..eff44184177f071d148476458d6653fb7ca635c5 100644 (file)
--- a/doc/imagex-split.1.in
+++ b/doc/imagex-split.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"

 .SH NAME
 imagex split \- Split a WIM into multiple parts
 
 .SH NAME
 imagex split \- Split a WIM into multiple parts
 

diff --git a/doc/imagex.1.in b/doc/imagex.1.in
index 7fee130d3228208c741c7f03177b2f29e9c22884..1352ce77a489e9ad83c8394930e37cd8c44b2aa6 100644 (file)
--- a/doc/imagex.1.in
+++ b/doc/imagex.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX 1 "May 2012" "imagex (wimlib @VERSION@)" "User Commands"
+.TH IMAGEX 1 "September 2012" "imagex (wimlib @VERSION@)" "User Commands"

 .SH NAME
 imagex \- Create, modify, extract, mount, or unmount a WIM (Windows Imaging Format) archive
 .SH SYNOPSIS
 .SH NAME
 imagex \- Create, modify, extract, mount, or unmount a WIM (Windows Imaging Format) archive
 .SH SYNOPSIS


@@ -32,7 +32,7 @@ files). Its interface is meant to be similar to Microsoft's imagex.exe program.
 
 To do its work, \fBimagex\fR uses \fBwimlib\fR, a library which provides
 interfaces for manipulating WIM archives.  You could wimlib in your own programs
 
 To do its work, \fBimagex\fR uses \fBwimlib\fR, a library which provides
 interfaces for manipulating WIM archives.  You could wimlib in your own programs

-if you wanted to.  Wimlib's public interface is documented.
+if you wanted to.  wimlib's public interface is documented.

 
 See \fBWARNING\fR.
 
 
 See \fBWARNING\fR.
 


@@ -49,9 +49,10 @@ Mount an image in a WIM read-only (\fBimagex mount\fR)
 .IP \[bu] 2
 Mount an image in a WIM read-write (\fBimagex mountrw\fR)
 .IP \[bu] 2
 .IP \[bu] 2
 Mount an image in a WIM read-write (\fBimagex mountrw\fR)
 .IP \[bu] 2

-Create a WIM from a directory (\fBimagex capture\fR)
+Create a WIM from a directory or NTFS volume (\fBimagex capture\fR)

 .IP \[bu] 2
 .IP \[bu] 2

-Append a directory onto a WIM as a new image (\fBimagex append\fR)
+Append a directory or NTFS volume onto a WIM as a new image (\fBimagex
+append\fR)

 .IP \[bu] 2
 Delete image(s) from a WIM (\fBimagex delete\fR)
 .IP \[bu] 2
 .IP \[bu] 2
 Delete image(s) from a WIM (\fBimagex delete\fR)
 .IP \[bu] 2


@@ -63,9 +64,9 @@ Change the name or description of an image in the WIM (\fBimagex info\fR)
 .IP \[bu] 2
 Change which image in a WIM is bootable (\fBimagex info\fR)
 .IP \[bu] 2
 .IP \[bu] 2
 Change which image in a WIM is bootable (\fBimagex info\fR)
 .IP \[bu] 2

-Combining split WIMs into one WIM (\fBimage join\fR)
+Combine split WIMs into one WIM (\fBimage join\fR)

 .IP \[bu] 2
 .IP \[bu] 2

-Splitting a WIM into multiple parts (\fBimage split\fR)
+Split a WIM into multiple parts (\fBimage split\fR)

 .IP \[bu] 2
 Support for all WIM compression types, both compression and decompression (LZX,
 XPRESS, and none)
 .IP \[bu] 2
 Support for all WIM compression types, both compression and decompression (LZX,
 XPRESS, and none)


@@ -75,63 +76,41 @@ Integrity table
 XML data (parsed and written using \fBlibxml\fR(3))
 
 .SH UNSUPPORTED FEATURES
 XML data (parsed and written using \fBlibxml\fR(3))
 
 .SH UNSUPPORTED FEATURES

-The following features are currently unsupported:
-.IP \[bu] 2
-Wimlib cannot add security data when it captures a WIM file, although it will
-preserve security data for existing WIM files.  New files added to a mounted
-WIM will be added without security data.  This does not seem to matter for
-Windows PE, but this means that you should not use this program to image a drive
-containing Windows Vista/7/8 and expect it to be applied with the correct file
-permissions.
-.IP \[bu] 2
-Alternate file streams are unsupported and will be lost when wimlib writes a WIM
-file.  Note that you shouldn't really have these on your Windows system anyway
-because they are unneeded and a security risk.
-.IP \[bu] 2
-Directly applying or mounting split WIMs is unsupported.  You have to combine
-them together with \fBimagex join\fR first.
-.IP \[bu] 2
-The \fB--verify\fR option, for all commands that use it is unsupported.  Without
-this option, there theoretically could be a SHA1 hash collision between two
-files, although it's very unlikely.  You can still verify a WIM manually by
-capturing it, then applying it to a different location, then running a recursive
-diff on the two directory trees.
-.IP \[bu] 2
-The \fB--config\fR option, for all commands that use it.
-.IP \[bu] 2
-Different versions of the WIM file format (if different versions even exist).

 
 

-Also see the Doxygen documentation for Wimlib.
+As of version 1.0.0, wimlib supports capturing and applying WIMs directly from
+NTFS and has much improved support for hard links and symbolic links.  I don't
+think there are many other features that would be worth it to implement; the
+only significant thing missing (in my opinion) is that split WIMs need to be
+handled better (e.g. it should be possible to apply a split WIM using \fBimagex
+apply\fR).  And if Microsoft updates the WIM format, I'd need to support it, but
+it looks like the format for Windows 8 is the same as that of Windows 7.

 
 .SH DIFFERENCES FROM MICROSOFT IMAGEX
 
 
 .SH DIFFERENCES FROM MICROSOFT IMAGEX
 

-See \fBUNSUPPORTED FEATURES\fR.
-
-The most important difference is that this version of \fBimagex\fR cannot
-capture and restore Windows images losslessly because file permissions and
-alternate file streams cannot be captured.  This is because Microsoft designed
-the WIM format to be specific to their NTFS filesystem and the Windows security
-model/API, which is difficult to support in a non-Windows program.  However, you
-can still create images of Windows PE, even from a directory tree on a non-NTFS
-filesystem.
+While similar to Microsoft's "imagex.exe" program, this program is designed for
+UNIX-based systems and by the nature of the platform cannot be exactly the same
+as Microsoft's version.

 
 

-See the documentation for each subcommand of \fBimagex\fR; in some cases they do
-not do exactly the same thing as imagex.exe.
+In particular, because Microsoft designed the WIM file format to accomodate
+Windows-specific and NTFS-specific features, we must have two separate image
+capture and application modes (although the \fBimagex\fR subcommands for the
+modes are the same): one for general image capture and application, and one for
+the capture or application of an image specifically from/to an NTFS volume.

 
 

-Some features, such as the ability to keep files hard-linked when they are
-extracted from a WIM, are not available in Microsoft's version of imagex.
-Also, doesn't seem to be an equivalent of \fBimagex join\fR in Microsoft's
-version; you would have to use \fBimagex.exe /export\fR, but that doesn't let
-you export all images at once.
+Some features, such as the ability to keep files hard-linked across WIM images
+when they are extracted from a WIM, are not available in Microsoft's version of
+imagex.  Also, doesn't seem to be an equivalent of \fBimagex join\fR in
+Microsoft's version; you would have to use \fBimagex.exe /export\fR, but that
+doesn't let you export all images at once.

 
 Microsoft's version has some weird limitations, like it won't let you extract a
 WIM on a shared folder, and it requires some commands to be run only from
 Windows PE and not from regular Windows.  This version does not have these
 unusual limitations, although it won't actually run on Windows anyway.
 
 
 Microsoft's version has some weird limitations, like it won't let you extract a
 WIM on a shared folder, and it requires some commands to be run only from
 Windows PE and not from regular Windows.  This version does not have these
 unusual limitations, although it won't actually run on Windows anyway.
 

-The \fB/scroll\fR and \fB/log\fR switches from Microsoft's version of imagex
-will not be implemented.  Note that to scroll the output in the UNIX shell you
-can just pipe the output into \fBless\fR(1).
+There are bugs in Microsoft's WIM library and I obviously have not included
+these bugs in my version; however it's to be expected that despite that fact, my
+version has more bugs because it's been less widely tested and used.

 
 Obviously, this version of imagex is free software but Microsoft's version is
 not.
 
 Obviously, this version of imagex is free software but Microsoft's version is
 not.