wimlib.net Git - wimlib/blob - doc/imagex.1.in

   1 .TH IMAGEX 1 "March 2013" "imagex (wimlib @VERSION@)" "User Commands"
   2 .SH NAME
   3 imagex \- Create, modify, extract, mount, or unmount a WIM (Windows Imaging Format) archive
   4 .SH SYNOPSIS
   5 \fBimagex append\fR \fIarguments...\fR
   6 .br
   7 \fBimagex apply\fR \fIarguments...\fR
   8 .br
   9 \fBimagex capture\fR \fIarguments...\fR
  10 .br
  11 \fBimagex delete\fR \fIarguments...\fR
  12 .br
  13 \fBimagex dir\fR \fIarguments...\fR
  14 .br
  15 \fBimagex export\fR \fIarguments...\fR
  16 .br
  17 \fBimagex info\fR \fIarguments...\fR
  18 .br
  19 \fBimagex join\fR \fIarguments...\fR
  20 .br
  21 \fBimagex mount\fR \fIarguments...\fR
  22 .br
  23 \fBimagex mountrw\fR \fIarguments...\fR
  24 .br
  25 \fBimagex optimize\fR \fIarguments...\fR
  26 .br
  27 \fBimagex split\fR \fIarguments...\fR
  28 .br
  29 \fBimagex unmount\fR \fIarguments...\fR
  30
  31 .SH DESCRIPTION
  32 \fBimagex\fR is able to deal with archives in the Windows Imaging Format (.wim
  33 files). Its interface is meant to be similar to Microsoft's imagex.exe program.
  34
  35 To do its work, \fBimagex\fR uses \fBwimlib\fR, a library which provides
  36 interfaces for manipulating WIM archives.  You could wimlib in your own programs
  37 if you wanted to.  wimlib's public interface is documented.
  38
  39 .SH COMMANDS
  40
  41 There is a separate manual page for each \fBimagex\fR command.
  42
  43 .SH SUPPORTED FEATURES
  44
  45 The following general features are currently supported (note: this is not a
  46 complete list):
  47
  48 .IP \[bu] 3
  49 Create a stand-alone WIM from a directory or NTFS volume (\fBimagex capture\fR)
  50 .IP \[bu]
  51 Append a directory or NTFS volume onto a stand-alone WIM as a new image (\fBimagex
  52 append\fR)
  53 .IP \[bu]
  54 Apply an image from a stand-alone or split WIM to a directory or NTFS volume
  55 (\fBimagex apply\fR)
  56 .IP \[bu]
  57 Mount an image from a stand-alone or split WIM read-only (\fBimagex mount\fR)
  58 .IP \[bu]
  59 Mount an image from a stand-alone WIM read-write (\fBimagex mountrw\fR)
  60 .IP \[bu]
  61 Delete image(s) from a stand-alone WIM (\fBimagex delete\fR)
  62 .IP \[bu]
  63 Export image(s) from a stand-alone or split WIM (\fBimagex export\fR)
  64 .IP \[bu]
  65 Display information about a WIM file (\fBimagex info\fR, \fBimagex dir\fR)
  66 .IP \[bu]
  67 Change the name or description of an image in the WIM (\fBimagex info\fR)
  68 .IP \[bu]
  69 Change which image in a WIM is bootable (\fBimagex info\fR)
  70 .IP \[bu]
  71 Combine split WIMs into one stand-alone WIM (\fBimage join\fR)
  72 .IP \[bu]
  73 Split a stand-alone WIM into multiple parts (\fBimage split\fR)
  74 .IP \[bu]
  75 Support for all WIM compression types, both compression and decompression (LZX,
  76 XPRESS, and none)
  77 .IP \[bu]
  78 WIM integrity table is supported (\fB--check\fR option to many commands)
  79 .IP \[bu]
  80 WIM XML data (parsed and written using \fBlibxml\fR(3))
  81
  82 .SH DIFFERENCES FROM MICROSOFT IMAGEX
  83
  84 While similar to Microsoft's "imagex.exe" program, this program is designed for
  85 UNIX-based systems and by the nature of the platform cannot be exactly the same
  86 as Microsoft's version.  In addition, I have added additional useful features
  87 when appropriate.
  88
  89 .IP \[bu] 4
  90 Because Microsoft designed the WIM file format to accomodate Windows-specific
  91 and NTFS-specific features, wimlib must have two separate image capture and
  92 application modes (although the \fBimagex\fR subcommands for the modes are the
  93 same): one for general image capture and application, and one for the capture or
  94 application of an image specifically from/to an NTFS volume.
  95
  96 Note: the above applies to UNIX builds.  On the experimental Windows builds of
  97 wimlib, there is only one image capture and application mode, similar to
  98 Microsoft's ImageX.
  99
 100 .IP \[bu]
 101 Microsoft's version has some weird limitations, like it won't let you extract a
 102 WIM on a shared folder, and it requires some commands to be run only from
 103 Windows PE and not from regular Windows.  This version does not have these
 104 unusual limitations.
 105
 106 .IP \[bu]
 107 There are bugs in Microsoft's WIM library and I obviously have not included the
 108 same bugs in wimlib, although in some cases I have had to work around bugs for
 109 compatibility purposes.
 110
 111 .IP \[bu]
 112 wimlib's \fBimagex\fR offers the extra command \fBimagex optimize\fR,
 113 which lets you easily remove wasted space in a WIM (which can arise after
 114 a WIM image is appended or mounted read-write).
 115
 116 .IP \[bu]
 117 wimlib's \fBimagex\fR also offers the command \fBimagex join\fR, which lets you
 118 easily join the parts of a split WIM.
 119
 120 .IP \[bu]
 121 wimlib's \fBimagex apply\fR supports keeping files hard-linked or symlinked
 122 across WIM images when extracted from a WIM.  So you can, for example, extract
 123 different versions of Windows from an install.wim without using much extra
 124 space.  (Note: this functionality is only available in UNIX builds of wimlib.)
 125
 126 .IP \[bu]
 127 wimlib's \fBimagex capture\fR supports combining multiple separate directories
 128 and files together in a configurable way to create a WIM image.
 129
 130 .IP \[bu]
 131 wimlib's XPRESS compressor is better than Microsoft's.
 132
 133 .IP \[bu]
 134 wimlib supports multithreaded compression, which can make it much faster to
 135 create compressed WIM files.
 136
 137 .IP \[bu]
 138 wimlib's \fBimagex capture\fR supports a special mode where UNIX file modes,
 139 owners, and groups are stored.
 140
 141 .IP \[bu]
 142 wimlib's \fBimagex mount\fR and \fBimagex mountrw\fR are much faster than
 143 Microsoft's versions for some reason.  I don't know what they have their program
 144 do that takes so long to simply set up a mountpoint.  (Note: this functionality
 145 is only available on UNIX builds.)
 146
 147 .IP \[bu]
 148 wimlib's \fBimagex mount\fR supports mounting an image from a split WIM, but
 149 Microsoft's software does not.  (Note: this functionality is only available on
 150 UNIX builds.)
 151
 152 .SH WARNING
 153
 154 Note: \fBwimlib\fR and \fBimagex\fR are experimental.  Use Microsoft's
 155 imagex.exe if you have to make sure your WIM files are made "correctly".  Feel
 156 free to submit a bug report if you find a bug.
 157
 158 Some parts of the WIM file format are poorly documented or even completely
 159 undocumented, so I've just had to do the best I can to read and write WIMs in a
 160 way that appears to be compatible with Microsoft's software.
 161
 162 .SH REPORTING BUGS
 163
 164 Report bugs to ebiggers3@gmail.com.
 165
 166 .SH SEE ALSO
 167 .BR imagex-append (1),
 168 .BR imagex-apply (1),
 169 .BR imagex-capture (1),
 170 .BR imagex-delete (1),
 171 .BR imagex-dir (1),
 172 .BR imagex-export (1),
 173 .BR imagex-info (1),
 174 .BR imagex-join (1),
 175 .BR imagex-mount (1),
 176 .BR imagex-mountrw (1),
 177 .BR imagex-optimize (1),
 178 .BR imagex-split (1),
 179 .BR imagex-unmount (1),