X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=doc%2Fimagex.1.in;h=8ba1ed9598e092b5f0a352446a8ce002c4375a68;hb=98ed2c50486c2f54f88040c17c191158fd417514;hp=fc0edd28ebde1ebc5c0af89c556066a6f5004b80;hpb=811f0b5538c0e7ea50e4b62b61194c783c0f209e;p=wimlib diff --git a/doc/imagex.1.in b/doc/imagex.1.in index fc0edd28..8ba1ed95 100644 --- a/doc/imagex.1.in +++ b/doc/imagex.1.in @@ -1,4 +1,4 @@ -.TH WIMLIB-IMAGEX 1 "August 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands" +.TH WIMLIB-IMAGEX 1 "January 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands" .SH NAME @IMAGEX_PROGNAME@ \- Create, modify, extract, mount, or unmount a WIM (Windows Imaging Format) archive .SH SYNOPSIS @@ -51,31 +51,31 @@ or if you invoke it incorrectly, the full documentation for each \fB@IMAGEX_PROGNAME@\fR command can be found in the appropriate manual page. .PP Note: to save typing, if appropriate hard links or batch files have been -installed, a command \fB@IMAGEX_PROGNAME@ \fICOMMAND\fR can be accessed as +installed, a command \fB@IMAGEX_PROGNAME@ \fICOMMAND\fR can also be accessed as simply \fBwim\fICOMMAND\fR; for example, \fBwimapply\fR for \fB@IMAGEX_PROGNAME@ apply\fR. .SH SUPPORTED FEATURES The following are some of the main features currently supported by \fB@IMAGEX_PROGNAME@\fR, and pointers to the relevant commands: .IP \[bu] 4 -Create a stand-alone WIM from a directory or NTFS volume (\fB@IMAGEX_PROGNAME@ capture\fR) +Create a standalone WIM from a directory or NTFS volume (\fB@IMAGEX_PROGNAME@ capture\fR) .IP \[bu] Capture a WIM image directly to standard output in a special pipable format (\fB@IMAGEX_PROGNAME@ capture\fR) .IP \[bu] -Append a directory or NTFS volume onto a stand-alone WIM as a new image (\fB@IMAGEX_PROGNAME@ +Append a directory or NTFS volume onto a standalone WIM as a new image (\fB@IMAGEX_PROGNAME@ append\fR) .IP \[bu] -Apply an image from a stand-alone or split WIM to a directory or NTFS volume +Apply an image from a standalone or split WIM to a directory or NTFS volume (\fB@IMAGEX_PROGNAME@ apply\fR) .IP \[bu] Apply an image from a special pipable WIM format sent over standard input (\fB@IMAGEX_PROGNAME@ apply\fR) .IP \[bu] -Mount an image from a stand-alone or split WIM read-only (\fB@IMAGEX_PROGNAME@ +Mount an image from a standalone or split WIM read-only (\fB@IMAGEX_PROGNAME@ mount\fR) (not available on Windows) .IP \[bu] -Mount an image from a stand-alone WIM read-write (\fB@IMAGEX_PROGNAME@ +Mount an image from a standalone WIM read-write (\fB@IMAGEX_PROGNAME@ mountrw\fR) (not available on Windows) .IP \[bu] Extract individual files or directories from a WIM without mounting it @@ -83,9 +83,9 @@ Extract individual files or directories from a WIM without mounting it .IP \[bu] Make changes to a WIM image without mounting it (\fB@IMAGEX_PROGNAME@ update\fR) .IP \[bu] -Delete image(s) from a stand-alone WIM (\fB@IMAGEX_PROGNAME@ delete\fR) +Delete image(s) from a standalone WIM (\fB@IMAGEX_PROGNAME@ delete\fR) .IP \[bu] -Export image(s) from a stand-alone or split WIM (\fB@IMAGEX_PROGNAME@ export\fR) +Export image(s) from a standalone or split WIM (\fB@IMAGEX_PROGNAME@ export\fR) .IP \[bu] Display information about a WIM file (\fB@IMAGEX_PROGNAME@ info\fR, \fB@IMAGEX_PROGNAME@ dir\fR) .IP \[bu] @@ -93,9 +93,12 @@ Change the name or description of an image in the WIM (\fB@IMAGEX_PROGNAME@ info .IP \[bu] Change which image in a WIM is bootable (\fB@IMAGEX_PROGNAME@ info\fR) .IP \[bu] -Combine split WIMs into one stand-alone WIM (\fB@IMAGEX_PROGNAME@ join\fR) +Combine split WIMs into one standalone WIM (\fB@IMAGEX_PROGNAME@ join\fR) .IP \[bu] -Split a stand-alone WIM into multiple parts (\fB@IMAGEX_PROGNAME@ split\fR) +Split a standalone WIM into multiple parts (\fB@IMAGEX_PROGNAME@ split\fR) +.IP \[bu] +Easily remove wasted space in a WIM file and optionally recompress it (\fB +@IMAGEX_PROGNAME@ optimize\fR) .IP \[bu] Support for all WIM compression types, both compression and decompression (LZX, XPRESS, and none) @@ -103,8 +106,8 @@ XPRESS, and none) WIM integrity table is supported (\fB--check\fR option to many commands) .SH DIFFERENCES FROM MICROSOFT IMAGEX Although \fB@IMAGEX_PROGNAME@\fR shares some similarities with Microsoft's -implementation of ImageX, this section lists some noteworthy differences between -the two programs: +implementation of ImageX, this section lists some of the many noteworthy +differences between the two programs: .IP \[bu] 4 \fB@IMAGEX_PROGNAME@\fR is supported on both UNIX-like systems and Windows; thus, some functionality was designed around this. @@ -125,23 +128,14 @@ mode, similar to Microsoft's ImageX. wimlib supports multithreaded compression, which can make it much faster to create compressed WIM files. .IP \[bu] -wimlib's XPRESS compressor is slightly better than Microsoft's (in terms of -compression ratio). -.IP \[bu] -wimlib's LZX compressor is slightly worse than Microsoft's (in terms of -compression ratio), but it's still better than XPRESS compression. -.IP \[bu] -\fB@IMAGEX_PROGNAME@ capture\fR defaults to LZX ("maximum") compression for new -WIMs, as opposed to Microsoft's software which defaults to XPRESS ("fast") -compression. -.IP \[bu] \fB@IMAGEX_PROGNAME@\fR offers the extra commands \fB@IMAGEX_PROGNAME@ extract\fR and \fB@IMAGEX_PROGNAME@ update\fR, which let you quickly extract files from or make changes to a WIM image without mounting it. .IP \[bu] \fB@IMAGEX_PROGNAME@\fR offers the extra command \fB@IMAGEX_PROGNAME@ optimize\fR, which lets you easily remove wasted space in a WIM (which can arise -after a WIM image is appended or mounted read-write). +after a WIM image is appended or mounted read-write). It also makes it easy to +recompress a WIM file at the highest compression level. .IP \[bu] \fB@IMAGEX_PROGNAME@\fR also offers the command \fB@IMAGEX_PROGNAME@ join\fR, which lets you easily join the parts of a split WIM. @@ -155,6 +149,9 @@ output or from standard input, respectively; this can be used to pipe images to or from a server over the network to implement fast filesystem imaging and restore. .IP \[bu] +\fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR support +options to optimize incremental backups and to create "delta" WIM files. +.IP \[bu] wimlib (and \fB@IMAGEX_PROGNAME@\fR via \fB@IMAGEX_PROGNAME@ capture\fR) supports combining multiple separate directories and files together in a configurable way to create a WIM image. @@ -172,22 +169,39 @@ wimlib (and \fB@IMAGEX_PROGNAME@\fR via \fB@IMAGEX_PROGNAME@ mount\fR) support mounting an image from a split WIM, but Microsoft's software does not. (Note: this functionality is not available in Windows builds of wimlib and \fB@IMAGEX_PROGNAME@\fR.) -.IP \[bu] -\fB@IMAGEX_PROGNAME@ capture\fR supports a special mode where UNIX file modes, -owners, and groups are stored. (Note: this functionality is only available in -builds of wimlib for UNIX-like systems.) .SH LOCALES AND CHARACTER ENCODINGS -On Windows, wimlib works in UTF-16LE, and there should be no problems with -character encodings. +WIM files themselves store file and stream names using UTF-16LE. On Windows, +wimlib works in UTF-16LE, so conversions are usually not necessary and there +should be no problems with character encodings. .PP -On UNIX, wimlib works primarily in the locale-dependent multibyte encoding, -which you are strongly recommended to set to UTF-8 to avoid any problems. +On UNIX-like systems, wimlib works primarily in the locale-dependent multibyte +encoding, which you are strongly recommended to set to UTF-8 to avoid any +problems. You can alternatively set the environmental variable +\fBWIMLIB_IMAGEX_USE_UTF8\fR to force \fB@IMAGEX_PROGNAME@\fR to use UTF-8 +character encoding internally, even if the current locale is not UTF-8 +compatible. .SH CASE SENSITIVITY -The case sensitivity of \fB@IMAGEX_PROGNAME@\fR differs somewhat between -UNIX-like systems and Windows. Filenames are internally treated as -case-sensitive, but on Windows paths actually provided by the user will be -treated as case-insensitive in order to get the "expected" behavior. Otherwise, -options and non-path arguments should be specified in lower case. +By default, the case sensitivity of \fB@IMAGEX_PROGNAME@\fR differs somewhat +between UNIX-like systems and Windows. WIM images may (but usually do not) have +multiple files with the same case-insensitive name. Internally, wimlib +stores filenames as case-sensitive, but on Windows paths +actually provided by the user for use in a WIM image (e.g. for extracting, +adding, renaming, or deleting files) will by default be treated as +case-insensitive in order to get the "expected" behavior. This differs from the +default behavior on UNIX-like systems, where such paths will be treated as +case-sensitive. Note that with case insensitivity, a path component may in +general be ambiguous due to multiple files or directories having the same +case-insensitive name. In such cases, if there is a file or directory with an +exactly matching name, it is chosen; otherwise, one of the case-insensitively +matching file or directories is chosen arbitrarily. +.PP +The default behavior can be overridden by explicitly setting the environmental +variable \fBWIMLIB_IMAGEX_IGNORE_CASE\fR to 1, in which case such paths will be +treated case insensitively, or 0, in which such paths will be treated case +sensitively. +.PP +Regardless of these settings, options and non-path arguments must be specified +in lower case. .SH LICENSE wimlib and \fB@IMAGEX_PROGNAME@\fR are distributed under the GNU General Public License version 3 or later. Be aware this means this software is provided as-is