X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fman1%2Fwimlib-imagex-capture.1;h=6198d52b1c6f06c171121d4f710149f4a5431d27;hp=6fc180b172c4cfd103824c78e93b643659c2b570;hb=35841ff14ad55b687d8efcfceecd9b05e946f328;hpb=3bdac428d5dfb5c609b8012e4a6a1df7a7eb91dd diff --git a/doc/man1/wimlib-imagex-capture.1 b/doc/man1/wimlib-imagex-capture.1 index 6fc180b1..6198d52b 100644 --- a/doc/man1/wimlib-imagex-capture.1 +++ b/doc/man1/wimlib-imagex-capture.1 @@ -1,4 +1,4 @@ -.TH WIMLIB-IMAGEX "1" "August 2015" "wimlib 1.8.2" "User Commands" +.TH WIMLIB-IMAGEX "1" "November 2015" "wimlib 1.8.3" "User Commands" .SH NAME wimlib-imagex-capture, wimlib-imagex-append \- Create or append a WIM image .SH SYNOPSIS @@ -204,7 +204,8 @@ If you are creating a solid WIM (using the \fB--solid\fR option), then you probably want \fB--solid-compress\fR instead. .IP "" Be careful if you choose LZMS compression. It is not compatible with wimlib -before v1.6.0, WIMGAPI before Windows 8, DISM before Windows 8.1, and 7-Zip. +before v1.6.0, WIMGAPI before Windows 8, DISM before Windows 8.1, and 7-Zip +before v15.12. .IP "" Also note that choosing LZMS compression does not automatically imply solid-mode compression, as it does with DISM. Use \fB--solid\fR if you want to create a @@ -279,6 +280,19 @@ optimize\fR(1). Specify a string to use in the element of the XML data for the new image. .TP +\fB--image-property\fR \fINAME\fR=\fIVALUE\fR +Specify an arbitrary per-image property to set in the XML document of the WIM +file. \fIVALUE\fR is the string to set as the property value. \fINAME\fR is +the name of the image property, for example "NAME", "DESCRIPTION", or +"TOTALBYTES". The name can contain forward slashes to indicate a nested XML +element; for example, "WINDOWS/VERSION/BUILD" indicates the BUILD element nested +within the VERSION element nested within the WINDOWS element. A bracketed +number can be used to indicate one of several identically-named elements; for +example, "WINDOWS/LANGUAGES/LANGUAGE[2]" indicates the second "LANGUAGE" element +nested within the "WINDOWS/LANGUAGES" element. When adding a list of elements +in this way, they must be specified in sequential order. Note that element +names are case-sensitive. This option may be specified multiple times. +.TP \fB--dereference\fR (UNIX-like systems only) Follow symbolic links and archive the files they point to, rather than archiving the links themselves. @@ -562,15 +576,25 @@ however, this may still be overridden through the \fB--config\fR parameter. .TP \fB--unsafe-compact\fR See the documentation for this option in \fBwimlib-imagex-optimize\fR (1). +.TP +\fB--snapshot\fR +EXPERIMENTAL: create a temporary filesystem snapshot of the source directory and +capture the files from it. Currently, this option is only supported on Windows +(Vista and later), where it uses the Volume Shadow Copy Service (VSS). Using +this option, you can create a consistent backup of the system volume of a +running Windows system without running into problems with locked files. For the +VSS snapshot to be successfully created, \fBwimlib-imagex\fR must be run as an +Administrator, and it cannot be run in WoW64 mode (i.e. if Windows is 64-bit, +then \fBwimlib-imagex\fR must be 64-bit as well). .SH NOTES \fBwimlib-imagex append\fR does not support appending an image to a split WIM. .PP -It is safe to abort an \fBwimlib-imagex append\fR command partway through; -however, after doing this, it is recommended to run \fBwimlib-imagex -optimize\fR to remove any data that was appended to the physical WIM file but -not yet incorporated into the structure of the WIM, unless the WIM was being -fully rebuilt (e.g. with \fB--rebuild\fR), in which case you should delete the -temporary file left over. +Except when using \fB--unsafe-compact\fR, it is safe to abort a \fBwimlib-imagex +append\fR command partway through; however, after doing this, it is recommended +to run \fBwimlib-imagex optimize\fR to remove any data that was appended to the +physical WIM file but not yet incorporated into the structure of the WIM, unless +the WIM was being fully rebuilt (e.g. with \fB--rebuild\fR), in which case you +should delete the temporary file left over. .PP \fBwimlib-imagex\fR creates WIMs compatible with Microsoft's software (WIMGAPI, ImageX, DISM), with some caveats: