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

   1 .TH IMAGEX 1 "September 2012" "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 split\fR \fIarguments...\fR
  26 .br
  27 \fBimagex unmount\fR \fIarguments...\fR
  28
  29 .SH DESCRIPTION
  30 \fBimagex\fR is able to deal with archives in the Windows Imaging Format (.wim
  31 files). Its interface is meant to be similar to Microsoft's imagex.exe program.
  32
  33 To do its work, \fBimagex\fR uses \fBwimlib\fR, a library which provides
  34 interfaces for manipulating WIM archives.  You could wimlib in your own programs
  35 if you wanted to.  wimlib's public interface is documented.
  36
  37 See \fBWARNING\fR.
  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 features are currently supported:
  46
  47 .IP \[bu] 2
  48 Mount an image in a WIM read-only (\fBimagex mount\fR)
  49 .IP \[bu] 2
  50 Mount an image in a WIM read-write (\fBimagex mountrw\fR)
  51 .IP \[bu] 2
  52 Create a WIM from a directory or NTFS volume (\fBimagex capture\fR)
  53 .IP \[bu] 2
  54 Append a directory or NTFS volume onto a WIM as a new image (\fBimagex
  55 append\fR)
  56 .IP \[bu] 2
  57 Delete image(s) from a WIM (\fBimagex delete\fR)
  58 .IP \[bu] 2
  59 Export image(s) from a WIM (\fBimagex export\fR)
  60 .IP \[bu] 2
  61 Display information about a WIM file (\fBimagex info\fR, \fBimagex dir\fR)
  62 .IP \[bu] 2
  63 Change the name or description of an image in the WIM (\fBimagex info\fR)
  64 .IP \[bu] 2
  65 Change which image in a WIM is bootable (\fBimagex info\fR)
  66 .IP \[bu] 2
  67 Combine split WIMs into one WIM (\fBimage join\fR)
  68 .IP \[bu] 2
  69 Split a WIM into multiple parts (\fBimage split\fR)
  70 .IP \[bu] 2
  71 Support for all WIM compression types, both compression and decompression (LZX,
  72 XPRESS, and none)
  73 .IP \[bu] 2
  74 Integrity table
  75 .IP \[bu] 2
  76 XML data (parsed and written using \fBlibxml\fR(3))
  77
  78 .SH UNSUPPORTED FEATURES
  79
  80 As of version 1.0.0, wimlib supports capturing and applying WIMs directly from
  81 NTFS and has much improved support for hard links and symbolic links.  I don't
  82 think there are many other features that would be worth it to implement; the
  83 only significant thing missing (in my opinion) is that split WIMs need to be
  84 handled better (e.g. it should be possible to apply a split WIM using \fBimagex
  85 apply\fR).  And if Microsoft updates the WIM format, I'd need to support it, but
  86 it looks like the format for Windows 8 is the same as that of Windows 7.
  87
  88 .SH DIFFERENCES FROM MICROSOFT IMAGEX
  89
  90 While similar to Microsoft's "imagex.exe" program, this program is designed for
  91 UNIX-based systems and by the nature of the platform cannot be exactly the same
  92 as Microsoft's version.
  93
  94 In particular, because Microsoft designed the WIM file format to accomodate
  95 Windows-specific and NTFS-specific features, we must have two separate image
  96 capture and application modes (although the \fBimagex\fR subcommands for the
  97 modes are the same): one for general image capture and application, and one for
  98 the capture or application of an image specifically from/to an NTFS volume.
  99
 100 Some features, such as the ability to keep files hard-linked across WIM images
 101 when they are extracted from a WIM, are not available in Microsoft's version of
 102 imagex.  Also, doesn't seem to be an equivalent of \fBimagex join\fR in
 103 Microsoft's version; you would have to use \fBimagex.exe /export\fR, but that
 104 doesn't let you export all images at once.
 105
 106 Microsoft's version has some weird limitations, like it won't let you extract a
 107 WIM on a shared folder, and it requires some commands to be run only from
 108 Windows PE and not from regular Windows.  This version does not have these
 109 unusual limitations, although it won't actually run on Windows anyway.
 110
 111 There are bugs in Microsoft's WIM library and I obviously have not included
 112 these bugs in my version; however it's to be expected that despite that fact, my
 113 version has more bugs because it's been less widely tested and used.
 114
 115 Obviously, this version of imagex is free software but Microsoft's version is
 116 not.
 117
 118 .SH WARNING
 119
 120 Note: \fBwimlib\fR and \fBimagex\fR are experimental.  Use Microsoft's
 121 imagex.exe if you have to make sure your WIM files are made "correctly".  Not
 122 all features listed under \fBSUPPORTED FEATURES\fR have been thoroughly tested.
 123 Feel free to submit a bug report if you find a bug.
 124
 125 Some parts of the WIM file format are poorly documented or even completely
 126 undocumented, so I've just had to do the best I can to read and write WIMs in a
 127 way that appears to be compatible with Microsoft's software.
 128
 129 .SH REPORTING BUGS
 130
 131 Report bugs to ebiggers3@gmail.com.
 132
 133 .SH SEE ALSO
 134 .BR imagex-append (1),
 135 .BR imagex-apply (1),
 136 .BR imagex-capture (1),
 137 .BR imagex-delete (1),
 138 .BR imagex-dir (1),
 139 .BR imagex-export (1),
 140 .BR imagex-info (1),
 141 .BR imagex-join (1),
 142 .BR imagex-mount (1),
 143 .BR imagex-mountrw (1),
 144 .BR imagex-split (1),
 145 .BR imagex-unmount (1),
 146