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:
  46
  47 .IP \[bu] 3
  48 Create a stand-alone WIM from a directory or NTFS volume (\fBimagex capture\fR)
  49 .IP \[bu]
  50 Append a directory or NTFS volume onto a stand-alone WIM as a new image (\fBimagex
  51 append\fR)
  52 .IP \[bu]
  53 Apply an image from a stand-alone or split WIM to a directory or NTFS volume
  54 (\fBimagex apply\fR)
  55 .IP \[bu]
  56 Mount an image from a stand-alone or split WIM read-only (\fBimagex mount\fR)
  57 .IP \[bu]
  58 Mount an image from a stand-alone WIM read-write (\fBimagex mountrw\fR)
  59 .IP \[bu]
  60 Delete image(s) from a stand-alone WIM (\fBimagex delete\fR)
  61 .IP \[bu]
  62 Export image(s) from a stand-alone or split WIM (\fBimagex export\fR)
  63 .IP \[bu]
  64 Display information about a WIM file (\fBimagex info\fR, \fBimagex dir\fR)
  65 .IP \[bu]
  66 Change the name or description of an image in the WIM (\fBimagex info\fR)
  67 .IP \[bu]
  68 Change which image in a WIM is bootable (\fBimagex info\fR)
  69 .IP \[bu]
  70 Combine split WIMs into one stand-alone WIM (\fBimage join\fR)
  71 .IP \[bu]
  72 Split a stand-alone WIM into multiple parts (\fBimage split\fR)
  73 .IP \[bu]
  74 Support for all WIM compression types, both compression and decompression (LZX,
  75 XPRESS, and none)
  76 .IP \[bu]
  77 WIM integrity table is supported (\fB--check\fR option to many commands)
  78 .IP \[bu]
  79 WIM XML data (parsed and written using \fBlibxml\fR(3))
  80
  81 .SH DIFFERENCES FROM MICROSOFT IMAGEX
  82
  83 While similar to Microsoft's "imagex.exe" program, this program is designed for
  84 UNIX-based systems and by the nature of the platform cannot be exactly the same
  85 as Microsoft's version.  In addition, I have added additional useful features
  86 when appropriate.
  87
  88 .IP \[bu] 4
  89 Because Microsoft designed the WIM file format to accomodate Windows-specific
  90 and NTFS-specific features, \fBimagex\fR must have two separate image capture
  91 and application modes (although the \fBimagex\fR subcommands for the modes are
  92 the same): one for general image capture and application, and one for the
  93 capture or application of an image specifically from/to an NTFS volume.
  94
  95 .IP \[bu]
  96 Microsoft's version has some weird limitations, like it won't let you extract a
  97 WIM on a shared folder, and it requires some commands to be run only from
  98 Windows PE and not from regular Windows.  This version does not have these
  99 unusual limitations, although it won't actually run on Windows anyway.
 100
 101 .IP \[bu]
 102 There are bugs in Microsoft's WIM library and I obviously have not included the
 103 same bugs in wimlib, although in some cases I have had to work around some
 104 bugs for compatibility purposes.
 105
 106 .IP \[bu]
 107 wimlib's \fBimagex\fR offers the extra commands \fBimagex optimize\fR and
 108 \fBimagex join\fR to easily remove holes in a WIM or join the parts of a split
 109 WIM, respectively.
 110
 111 .IP \[bu]
 112 wimlib's \fBimagex apply\fR supports keeping files hard-linked or symlinked
 113 across WIM images when extracted from a WIM.  So you can, for example, extract
 114 different versions of Windows from an install.wim without using much extra space.
 115
 116 .IP \[bu]
 117 wimlib's \fBimagex capture\fR supports combining multiple separate directories
 118 and files together in a configurable way to create a WIM image.
 119
 120 .IP \[bu]
 121 wimlib's XPRESS compressor is better than Microsoft's.
 122
 123 .IP \[bu]
 124 wimlib supports multithreaded compression, which can make it much faster to
 125 create compressed WIM files.
 126
 127 .IP \[bu]
 128 wimlib's \fBimagex capture\fR supports a special mode where UNIX file modes,
 129 owners, and groups are stored.
 130
 131 .IP \[bu]
 132 wimlib's \fBimagex mount\fR and \fBimagex mountrw\fR are much faster than
 133 Microsoft's versions for some reason.  I don't know what they have their program
 134 do that takes so long to simply set up a mountpoint.
 135
 136 .SH WARNING
 137
 138 Note: \fBwimlib\fR and \fBimagex\fR are experimental.  Use Microsoft's
 139 imagex.exe if you have to make sure your WIM files are made "correctly".  Feel
 140 free to submit a bug report if you find a bug.
 141
 142 Some parts of the WIM file format are poorly documented or even completely
 143 undocumented, so I've just had to do the best I can to read and write WIMs in a
 144 way that appears to be compatible with Microsoft's software.
 145
 146 .SH REPORTING BUGS
 147
 148 Report bugs to ebiggers3@gmail.com.
 149
 150 .SH SEE ALSO
 151 .BR imagex-append (1),
 152 .BR imagex-apply (1),
 153 .BR imagex-capture (1),
 154 .BR imagex-delete (1),
 155 .BR imagex-dir (1),
 156 .BR imagex-export (1),
 157 .BR imagex-info (1),
 158 .BR imagex-join (1),
 159 .BR imagex-mount (1),
 160 .BR imagex-mountrw (1),
 161 .BR imagex-optimize (1),
 162 .BR imagex-split (1),
 163 .BR imagex-unmount (1),