X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex.1.in;h=3c14e64481a87bad1c08aa8ed03d3d0ef5f7acb8;hp=8f67adfbdd29f1dd62520e70051a043e5bb86b38;hb=6d23ff8bf6797cf541c9ea0c368f19f00af6fd9a;hpb=ebcb2402da0d554dcaafa46b8c1b9cc3362f6be3 diff --git a/doc/imagex.1.in b/doc/imagex.1.in index 8f67adfb..3c14e644 100644 --- a/doc/imagex.1.in +++ b/doc/imagex.1.in @@ -1,153 +1,215 @@ -.TH IMAGEX 1 "December 2012" "imagex (wimlib @VERSION@)" "User Commands" +.TH WIMLIB-IMAGEX 1 "August 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands" .SH NAME -imagex \- Create, modify, extract, mount, or unmount a WIM (Windows Imaging Format) archive +@IMAGEX_PROGNAME@ \- Create, modify, extract, mount, or unmount a WIM (Windows Imaging Format) archive .SH SYNOPSIS -\fBimagex append\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ append\fR \fIarguments...\fR .br -\fBimagex apply\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ apply\fR \fIarguments...\fR .br -\fBimagex capture\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ capture\fR \fIarguments...\fR .br -\fBimagex delete\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ delete\fR \fIarguments...\fR .br -\fBimagex dir\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ dir\fR \fIarguments...\fR .br -\fBimagex export\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ export\fR \fIarguments...\fR .br -\fBimagex info\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ extract\fR \fIarguments...\fR .br -\fBimagex join\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ info\fR \fIarguments...\fR .br -\fBimagex mount\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ join\fR \fIarguments...\fR .br -\fBimagex mountrw\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ mount\fR \fIarguments...\fR .br -\fBimagex optimize\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ mountrw\fR \fIarguments...\fR .br -\fBimagex split\fR \fIarguments...\fR +\fB@IMAGEX_PROGNAME@ optimize\fR \fIarguments...\fR .br -\fBimagex unmount\fR \fIarguments...\fR - +\fB@IMAGEX_PROGNAME@ split\fR \fIarguments...\fR +.br +\fB@IMAGEX_PROGNAME@ unmount\fR \fIarguments...\fR +.br +\fB@IMAGEX_PROGNAME@ update\fR \fIarguments...\fR .SH DESCRIPTION -\fBimagex\fR is able to deal with archives in the Windows Imaging Format (.wim -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 -if you wanted to. wimlib's public interface is documented. - -See \fBWARNING\fR. - +\fB@IMAGEX_PROGNAME@\fR deals with archives in the Windows Imaging Format (.wim +files). Its interface is meant to be similar to Microsoft's "imagex.exe" +program, but it also provide many useful extensions. +.PP +To do its work, \fB@IMAGEX_PROGNAME@\fR uses \fBwimlib\fR, a C library which +provides interfaces for manipulating WIM archives. You can wimlib in your own +programs if desired, although \fB@IMAGEX_PROGNAME@\fR already provides access to +most of wimlib's functionality. In some cases, however, there are general +interfaces which are only used by \fB@IMAGEX_PROGNAME@\fR in a specific way, so +it may be worth taking a look if you're looking to do something beyond what +\fB@IMAGEX_PROGNAME@\fR directly supports. .SH COMMANDS - -There is a separate manual page for each \fBimagex\fR command. - +\fB@IMAGEX_PROGNAME@\fR accepts one of a number of commands (listed above in +\fBSYNOPSYS\fR), and additional arguments depending on the specific command. +Although \fB@IMAGEX_PROGNAME@\fR will print usage information with \fB--help\fR +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 also be accessed as +simply \fBwim\fICOMMAND\fR; for example, \fBwimapply\fR for \fB@IMAGEX_PROGNAME@ +apply\fR. .SH SUPPORTED FEATURES - -The following features are currently supported: - -.IP \[bu] 3 -Create a stand-alone WIM from a directory or NTFS volume (\fBimagex capture\fR) +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 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 (\fBimagex +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 -(\fBimagex apply\fR) +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 standalone or split WIM read-only (\fB@IMAGEX_PROGNAME@ +mount\fR) (not available on Windows) +.IP \[bu] +Mount an image from a standalone WIM read-write (\fB@IMAGEX_PROGNAME@ +mountrw\fR) (not available on Windows) .IP \[bu] -Mount an image from a stand-alone or split WIM read-only (\fBimagex mount\fR) +Extract individual files or directories from a WIM without mounting it +(\fB@IMAGEX_PROGNAME@ extract\fR) .IP \[bu] -Mount an image from a stand-alone WIM read-write (\fBimagex mountrw\fR) +Make changes to a WIM image without mounting it (\fB@IMAGEX_PROGNAME@ update\fR) .IP \[bu] -Delete image(s) from a stand-alone WIM (\fBimagex 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 (\fBimagex export\fR) +Export image(s) from a standalone or split WIM (\fB@IMAGEX_PROGNAME@ export\fR) .IP \[bu] -Display information about a WIM file (\fBimagex info\fR, \fBimagex dir\fR) +Display information about a WIM file (\fB@IMAGEX_PROGNAME@ info\fR, \fB@IMAGEX_PROGNAME@ dir\fR) .IP \[bu] -Change the name or description of an image in the WIM (\fBimagex info\fR) +Change the name or description of an image in the WIM (\fB@IMAGEX_PROGNAME@ info\fR) .IP \[bu] -Change which image in a WIM is bootable (\fBimagex info\fR) +Change which image in a WIM is bootable (\fB@IMAGEX_PROGNAME@ info\fR) .IP \[bu] -Combine split WIMs into one stand-alone WIM (\fBimage join\fR) +Combine split WIMs into one standalone WIM (\fB@IMAGEX_PROGNAME@ join\fR) .IP \[bu] -Split a stand-alone WIM into multiple parts (\fBimage split\fR) +Split a standalone WIM into multiple parts (\fB@IMAGEX_PROGNAME@ split\fR) .IP \[bu] Support for all WIM compression types, both compression and decompression (LZX, XPRESS, and none) .IP \[bu] WIM integrity table is supported (\fB--check\fR option to many commands) -.IP \[bu] -WIM XML data (parsed and written using \fBlibxml\fR(3)) - -.SH UNSUPPORTED FEATURES - -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. In -addition, you may now apply split WIMs and mount them read-only. I don't think -there are many other features that would be worth it to implement. Besides -porting the library to Windows (which I'm not really interested in), the main -thing that could use improvement (in my opinion) is that the LZX compression -ratio still isn't quite as good as Microsoft's version. Furthermore, 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 - -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. - -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 across WIM images -when they are extracted from a WIM, are not available in Microsoft's version of -imagex. Also, this version of \fBimagex\fR lets you mount an image from a split -WIM read-only, while Microsoft's version does not. - -Microsoft's version has some weird limitations, like it won't let you extract a +Although \fB@IMAGEX_PROGNAME@\fR shares some similarities with Microsoft's +implementation of ImageX, this section lists some 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. +.IP \[bu] +The command-line syntax of the two programs is similar but not exactly the same. +.IP \[bu] +Because Microsoft designed the WIM file format to accomodate Windows-specific +and NTFS-specific features, on UNIX-like systems wimlib must have two separate +image capture and application modes (although the \fB@IMAGEX_PROGNAME@\fR +commands for the modes are the same): one for image capture and application +from/to a directory, and one for the capture or application of an image +specifically from/to an NTFS volume. +.IP "" +Note: the above applies to builds of \fB@IMAGEX_PROGNAME@\fR for UNIX-like +systems. On the Windows build, there is only one image capture and application +mode, similar to Microsoft's ImageX. +.IP \[bu] +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). +.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. +.IP \[bu] +For convenience, \fB@IMAGEX_PROGNAME@\fR automatically preserves the integrity +table in WIMs that have one, even when \fB--check\fR is not specified. +.IP \[bu] +wimlib supports a special "pipable" WIM format (not compatible with Microsoft's +software). This allows capturing and applying images directly to standard +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. +.IP \[bu] +Microsoft's ImageX 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. - -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. - -.SH WARNING - -Note: \fBwimlib\fR and \fBimagex\fR are experimental. Use Microsoft's -imagex.exe if you have to make sure your WIM files are made "correctly". Not -all features listed under \fBSUPPORTED FEATURES\fR have been thoroughly tested. -Feel free to submit a bug report if you find a bug. - -Some parts of the WIM file format are poorly documented or even completely -undocumented, so I've just had to do the best I can to read and write WIMs in a -way that appears to be compatible with Microsoft's software. - +Windows PE and not from regular Windows. \fB@IMAGEX_PROGNAME@\fR does not have +these unusual limitations. +.IP \[bu] +There are bugs in Microsoft's WIM library and I obviously have not included the +same bugs in wimlib, although in some cases I have had to work around bugs for +compatibility purposes. +.IP \[bu] +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. +.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. +.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. +.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 +and has no warranty; see COPYING for details. .SH REPORTING BUGS - Report bugs to ebiggers3@gmail.com. - .SH SEE ALSO -.BR imagex-append (1), -.BR imagex-apply (1), -.BR imagex-capture (1), -.BR imagex-delete (1), -.BR imagex-dir (1), -.BR imagex-export (1), -.BR imagex-info (1), -.BR imagex-join (1), -.BR imagex-mount (1), -.BR imagex-mountrw (1), -.BR imagex-optimize (1), -.BR imagex-split (1), -.BR imagex-unmount (1), - +.BR @IMAGEX_PROGNAME@-append (1), +.BR @IMAGEX_PROGNAME@-apply (1), +.BR @IMAGEX_PROGNAME@-capture (1), +.BR @IMAGEX_PROGNAME@-delete (1), +.BR @IMAGEX_PROGNAME@-dir (1), +.BR @IMAGEX_PROGNAME@-export (1), +.BR @IMAGEX_PROGNAME@-extract (1), +.BR @IMAGEX_PROGNAME@-info (1), +.BR @IMAGEX_PROGNAME@-join (1), +.BR @IMAGEX_PROGNAME@-mount (1), +.BR @IMAGEX_PROGNAME@-mountrw (1), +.BR @IMAGEX_PROGNAME@-optimize (1), +.BR @IMAGEX_PROGNAME@-split (1), +.BR @IMAGEX_PROGNAME@-unmount (1), +.BR @IMAGEX_PROGNAME@-update (1),