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

   1 .TH IMAGEX 1 "October 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] 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 UNSUPPORTED FEATURES
  82
  83 As of version 1.0.0, wimlib supports capturing and applying WIMs directly from
  84 NTFS and has much improved support for hard links and symbolic links.  In
  85 addition, you may now apply split WIMs and mount them read-only.  I don't think
  86 there are many other features that would be worth it to implement.  Besides
  87 porting the library to Windows (which I'm not really interested in), the main
  88 thing that could use improvement (in my opinion) is that the LZX compression
  89 ratio still isn't quite as good as Microsoft's version.  Furthermore, if
  90 Microsoft updates the WIM format, I'd need to support it, but it looks like the
  91 format for Windows 8 is the same as that of Windows 7.
  92
  93 .SH DIFFERENCES FROM MICROSOFT IMAGEX
  94
  95 While similar to Microsoft's "imagex.exe" program, this program is designed for
  96 UNIX-based systems and by the nature of the platform cannot be exactly the same
  97 as Microsoft's version.
  98
  99 In particular, because Microsoft designed the WIM file format to accomodate
 100 Windows-specific and NTFS-specific features, we must have two separate image
 101 capture and application modes (although the \fBimagex\fR subcommands for the
 102 modes are the same): one for general image capture and application, and one for
 103 the capture or application of an image specifically from/to an NTFS volume.
 104
 105 Some features, such as the ability to keep files hard-linked across WIM images
 106 when they are extracted from a WIM, are not available in Microsoft's version of
 107 imagex.  Also, this version of \fBimagex\fR lets you mount an image from a split
 108 WIM read-only, while Microsoft's version does not.
 109
 110 Microsoft's version has some weird limitations, like it won't let you extract a
 111 WIM on a shared folder, and it requires some commands to be run only from
 112 Windows PE and not from regular Windows.  This version does not have these
 113 unusual limitations, although it won't actually run on Windows anyway.
 114
 115 There are bugs in Microsoft's WIM library and I obviously have not included
 116 these bugs in my version; however it's to be expected that despite that fact, my
 117 version has more bugs because it's been less widely tested and used.
 118
 119 Obviously, this version of imagex is free software but Microsoft's version is
 120 not.
 121
 122 .SH WARNING
 123
 124 Note: \fBwimlib\fR and \fBimagex\fR are experimental.  Use Microsoft's
 125 imagex.exe if you have to make sure your WIM files are made "correctly".  Not
 126 all features listed under \fBSUPPORTED FEATURES\fR have been thoroughly tested.
 127 Feel free to submit a bug report if you find a bug.
 128
 129 Some parts of the WIM file format are poorly documented or even completely
 130 undocumented, so I've just had to do the best I can to read and write WIMs in a
 131 way that appears to be compatible with Microsoft's software.
 132
 133 .SH REPORTING BUGS
 134
 135 Report bugs to ebiggers3@gmail.com.
 136
 137 .SH SEE ALSO
 138 .BR imagex-append (1),
 139 .BR imagex-apply (1),
 140 .BR imagex-capture (1),
 141 .BR imagex-delete (1),
 142 .BR imagex-dir (1),
 143 .BR imagex-export (1),
 144 .BR imagex-info (1),
 145 .BR imagex-join (1),
 146 .BR imagex-mount (1),
 147 .BR imagex-mountrw (1),
 148 .BR imagex-split (1),
 149 .BR imagex-unmount (1),
 150