imagex-update.1.in: Fixes
[wimlib] / doc / imagex-update.1.in
1 .TH IMAGEX "1" "April 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
2 .SH NAME
3 @IMAGEX_PROGNAME@-update \- Update a WIM image
4
5 .SH SYNOPSIS
6 \fB@IMAGEX_PROGNAME@ update\fR \fIWIMFILE\fR [\fIIMAGE\fR] [\fIOPTION\fR...] < \fICMDFILE\fR
7
8 .SH DESCRIPTION
9 .PP
10
11 \fB@IMAGEX_PROGNAME@ update\fR modifies the specified \fIIMAGE\fR in the Windows
12 Imaging (WIM) file \fIWIMFILE\fR by adding, deleting, or renaming files or
13 directories in it.
14
15 \fIIMAGE\fR specifies the image in \fIWIMFILE\fR to update.  It may be a 1-based
16 index of an image in the WIM or the name of an image in the WIM.  Use the
17 \fB@IMAGEX_PROGNAME@ info\fR (1) command to list the images a WIM file contains.
18 \fIIMAGE\fR may be omitted if \fIWIMFILE\fR contains only one image.
19
20 The modifications to perform on the WIM image are specified as a sequence of
21 commands, one per line, read in a text file from standard input.  It is
22 recommended that standard input be redirected from a file (\fICMDFILE\fR), as
23 shown above, rather than typing in commands interactively.
24
25 .SH AVAILABLE COMMANDS
26
27 This section documents the commands that may appear in the \fICMDFILE\fR
28 described above.
29
30 .SS \fBadd\fR [\fIOPTION\fR...] \fISOURCE\fR \fIDESTINATION\fR
31 Adds a file or directory tree to the WIM image.  \fISOURCE\fR must specify the
32 path to a file or directory on your filesystem.  \fIDESTINATION\fR must specify
33 the path inside the WIM image at which to add the file or directory tree.  If
34 \fIDESTINATION\fR already exists in the WIM image, then an overlay is attempted;
35 this can be used to add multiple files to an existing directory in the WIM image
36 in one command.  If \fIDESTINATION\fR does not exist, then any prerequisite
37 directories are created as needed to add the \fISOURCE\fR at that location.
38
39 The available options for the \fBadd\fR command are:
40
41 .TP 6
42 \fB--verbose\fR
43 Print the names of files as they are captured.
44 .TP
45 \fB--dereference\fR
46 (UNIX only) Follow symbolic links and archive the files they point to, rather
47 than archiving the links themselves.
48 .TP
49 \fB--unix-data\fR
50 (UNIX only) Store the UNIX owner, group, and mode of all captured files.  This
51 is done by adding a special alternate data stream to each directory entry that
52 contains this information.  Please note that this flag is for convenience only,
53 in case you want to use \fB@IMAGEX_PROGNAME@\fR to archive files on UNIX.
54 Microsoft's software will not understand this special information.
55 .TP
56 \fB--no-acls\fR
57 (Windows only) Do not capture files' security descriptors.
58 .TP
59 \fB--strict-acls\fR
60 (Windows only) Fail immediately if the full security descriptor of any file
61 cannot be read.  The default behavior without this option is to first try
62 omitting the SACL from the security descriptor, then to try omitting the
63 security descriptor entirely.  The purpose of this is to capture as much data as
64 possible without always requiring Administrator privileges.  However, if you
65 desire that all security descriptors be captured exactly, you may wish to
66 provide this option, although the Administrator should have permission to read
67 everything anyway.
68
69 .SS \fBdelete\fR [\fIOPTION\fR...] \fIPATH\fR
70 Deletes a file or directory tree from the WIM image.  \fIPATH\fR must specify the
71 path inside the WIM image of the file or directory tree to delete.
72
73 The available options for the \fBdelete\fR command are:
74
75 .TP 6
76 \fB--force\fR
77 Do not issue an error if the path to delete does not exist.
78 .TP
79 \fB--recursive\fR
80 Delete the file or directory tree recursively; if not specified, an error is
81 issued if the path to delete is a directory.
82
83 .SS \fBrename\fR \fIOLD_PATH\fR \fINEW_PATH\fR
84 Renames a file or directory tree inside the WIM image.  \fIOLD_PATH\fR must
85 specify the old path of the file or directory tree inside the WIM image, and
86 \fINEW_PATH\fR must specify the new path for the file or directory tree.  This
87 command follows the semantics of the POSIX \fBrename\fR (3) function; in
88 particular, a pre-existing file at \fINEW_PATH\fR will be deleted if present,
89 except in certain cases such as attempting to rename a directory to a
90 non-directory, which is not allowed.
91
92 There are no options available for the \fBrename\fR command.
93
94 .SH OPTIONS
95
96 The following options are accepted on the command line by \fB@IMAGEX_PROGNAME@
97 update\fR itself:
98
99 .TP 6
100 \fB--verbose\fR
101 Use \fB--verbose\fR for all \fBadd\fR commands.
102 .TP
103 \fB--dereference\fR
104 Use \fB--dereference\fR for all \fBadd\fR commands.
105 .TP
106 \fB--unix-data\fR
107 Use \fB--unix-data\fR for all \fBadd\fR commands.
108 .TP
109 \fB--no-acls\fR
110 Use \fB--no-acls\fR for all \fBadd\fR commands.
111 .TP
112 \fB--strict-acls\fR
113 Use \fB--strict-acls\fR for all \fBadd\fR commands.
114 .TP
115 \fB--config\fR=\fIFILE\fR
116 Set the capture configuration file for all \fBadd\fR commands.  See the
117 description of this option in \fB@IMAGEX_PROGNAME@-capture\fR (1).
118 .TP
119 \fB--force\fR
120 Use \fB--force\fR for all \fBdelete\fR commands.
121 .TP
122 \fB--recursive\fR
123 Use \fB--recursive\fR for all \fBdelete\fR commands.
124 .TP
125 \fB--check\fR
126 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
127 present; in addition, include an integrity table in the updated WIM.  If this
128 option is not specified, no integrity table is included in the updated WIM, even
129 if there was one in the original WIM.
130 .TP
131 \fB--threads\fR=\fINUM_THREADS\fR
132 Number of threads to use for compressing newly added files.  Default: autodetect
133 (number of processors).
134 .TP
135 \fB--rebuild\fR
136 Rebuild the entire WIM rather than appending the updated data to the end of it.
137 Rebuilding the WIM is slower, but will save a little bit of space that would
138 otherwise be left as a hole in the WIM.  Also see
139 \fB@IMAGEX_PROGNAME@-optimize\fR (1).
140
141 .SH NOTES
142
143 \fB@IMAGEX_PROGNAME@ update\fR is partly redundant with \fB@IMAGEX_PROGNAME@
144 mountrw\fR, since if a WIM image can be mounted read-write, then there
145 theoretically is no need for \fB@IMAGEX_PROGNAME@ update\fR.  The main advantage
146 of \fB@IMAGEX_PROGNAME@ update\fR is that it works on both UNIX and Windows,
147 whereas \fB@IMAGEX_PROGNAME@ mountrw\fR only works on UNIX.
148
149 Symbolic links inside a WIM image are not dereferenced when being interpreted.
150 So, for example, if you have a WIM image that contains a symbolic link
151 "/Documents and Settings" -> "/Users" where "/Users" is a directory, then a
152 subdirectory named "Public" in this directory must be specified as
153 "/Users/Public" rather than "/Documents and Settings/Public".
154
155 All paths to files or directories within the WIM image must be specified
156 relative to the root of the image.  However, the leading slash is optional, and
157 both forward slashes and backslashes are accepted.
158
159 The command file (\fICMDFILE\fR) is parsed by \fB@IMAGEX_PROGNAME@ update\fR
160 itself and not by the system shell.  Therefore, its syntax is limited.  However,
161 comment lines beginning with '#' are allowed, and it is also possible to quote
162 arguments with whitespace inside them.
163
164 On UNIX, you cannot use \fB@IMAGEX_PROGNAME@ update\fR to add files to an image
165 directly from a NTFS volume using libntfs-3g, even though \fB@IMAGEX_PROGNAME@
166 capture\fR supports capturing a full image this way.
167
168 It is safe to abort an \fB@IMAGEX_PROGNAME@ update\fR command partway through;
169 however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
170 optimize\fR to remove any data that was appended to the physical WIM file but
171 not yet incorporated into the structure of the WIM, unless \fB--rebuild\fR was
172 specified, in which case you should delete the temporary file left over.
173
174 .SH EXAMPLES
175
176 Delete two files from a WIM image:
177
178 .RS
179 \fIupdate_commands.txt\fR:
180 .RS
181 .PP
182 .nf
183 delete /setup.exe
184 delete /sources/setup.exe
185 .fi
186 .RE
187 .RE
188
189 .RS
190 $ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
191 .RE
192
193 Add some files and directories to a WIM image.  Note that the first path of each
194 \fBadd\fR command specifies the files to add, while the second path of each
195 \fBadd\fR command specify the locations at which to to add them \fIinside the
196 WIM image\fR:
197
198 .RS
199 \fIupdate_commands.txt\fR:
200 .RS
201 .PP
202 .nf
203 add somedir     /dir
204 add somefile    /dir/file
205 .fi
206 .RE
207 .RE
208
209 .RS
210 $ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
211 .RE
212
213 Rename a file inside a WIM image.
214
215 .RS
216 \fIupdate_commands.txt\fR:
217 .RS
218 .PP
219 .nf
220 rename /dir_in_wim/oldfile.txt /dir_in_wim/newfile.txt
221 .fi
222 .RE
223 .RE
224
225 .RS
226 $ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
227 .RE
228
229 Using additional features, such as comments, options, and overlays, and
230 including an integrity table in the updated WIM:
231
232 .RS
233 \fIupdate_commands.txt\fR:
234 .RS
235 .PP
236 .nf
237 #
238 # This file specifies some changes to make to a WIM image.
239 #
240
241 # Add a new directory containing files I want in the image.
242 # The quotes are necessary because the directory name
243 # contains a space.
244 add "My Directory" "/My Directory"
245
246 # Add the contents of "Another Directory" to the
247 # "/My Directory" we just created in the WIM image.  Since
248 # the destination path already exists, this performs an
249 # overlay.
250 add "Another Directory" "/My Directory"
251
252 # Rename some file for some reason.
253 rename /dir_in_wim/oldfile.txt /dir_in_wim/newfile.txt
254
255 # Delete an unwanted directory.
256 delete --recursive /Users/Me/Documents/Junk
257 .fi
258 .RE
259 .RE
260
261 .RS
262 $ @IMAGEX_PROGNAME@ update boot.wim 2 --check < update_commands.txt
263 .RE
264
265 .SH SEE ALSO
266 .BR @IMAGEX_PROGNAME@ (1)
267 .BR @IMAGEX_PROGNAME@-capture (1)
268 .BR @IMAGEX_PROGNAME@-info (1)
269 .BR @IMAGEX_PROGNAME@-mountrw (1)
270 .BR @IMAGEX_PROGNAME@-optimize (1)