]> wimlib.net Git - wimlib/blobdiff - doc/man1/wimupdate.1
v1.14.4
[wimlib] / doc / man1 / wimupdate.1
index c1007a36f1be19b5df38d258e549a6022e979822..f1c82ba4e1104e5513ebe8918217028e1d8b6940 100644 (file)
@@ -1,4 +1,4 @@
-.TH WIMUPDATE "1" "November 2018" "wimlib 1.13.0" "User Commands"
+.TH WIMUPDATE "1" "February 2024" "wimlib 1.14.4" "User Commands"
 .SH NAME
 wimupdate \- Update a WIM image
 .SH SYNOPSIS
@@ -14,10 +14,11 @@ contains only one image.  You can use \fBwiminfo\fR(1) to list the images
 contained in \fIWIMFILE\fR.
 .PP
 The modifications to perform on the WIM image are specified as a sequence of
-commands, one per line, read in a text file from standard input.  It is
-recommended that standard input be redirected from a file (\fICMDFILE\fR), as
-shown above, rather than typing in commands interactively.  Alternatively, to
-specify a command directly on the command line, see the \fB--command\fR option.
+commands, one per line, read in a text file (UTF-8 or UTF-16LE encoded; plain
+ASCII is also fine) from standard input.  It is recommended that standard input
+be redirected from a file (\fICMDFILE\fR), as shown above, rather than typing in
+commands interactively.  Alternatively, to specify a command directly on the
+command line, see the \fB--command\fR option.
 .SH AVAILABLE COMMANDS
 This section documents the commands that may appear in the \fICMDFILE\fR
 described above.
@@ -163,6 +164,13 @@ Compact the WIM archive in-place and append any new data, eliminating "holes".
 This is efficient, but in general this option should \fInot\fR be used because a
 failed or interrupted compaction will corrupt the WIM archive.  For more
 information, see the documentation for this option in \fBwimoptimize\fR(1).
+.TP
+\fB--ref\fR="\fIGLOB\fR"
+File glob of WIM(s) on which the delta WIM is based.  Updating split WIMs is not
+allowed, but updating delta WIMs is allowed.  When updating a delta WIM, the
+WIM(s) on which the delta WIM is based should be specified using this option.
+(It isn't a hard requirement, but it's needed for data deduplication to work
+fully and for the TOTALBYTES statistic to be correctly updated.)
 .SH NOTES
 \fBwimupdate\fR can be viewed as redundant with \fBwimmountrw\fR, since a WIM
 image can also be updated by mounting it read-write.  However, \fBwimupdate\fR
@@ -220,7 +228,7 @@ $ wimupdate boot.wim 2 < update_commands.txt
 .PP
 Add some files and directories to a WIM image.  Note that the first path of each
 \fBadd\fR command specifies the files to add, while the second path of each
-\fBadd\fR command specify the locations at which to to add them inside the WIM
+\fBadd\fR command specify the locations at which to add them inside the WIM
 image:
 .PP
 .RS