$(LIBCRYPTO_CFLAGS)
-bin_PROGRAMS = imagex
-imagex_SOURCES = programs/imagex.c \
- include/wimlib.h \
- include/wimlib_tchar.h
-imagex_LDADD = $(top_builddir)/libwim.la
-imagex_CFLAGS = $(AM_CFLAGS) $(WINDOWS_CFLAGS) -Wno-deprecated-declarations
+bin_PROGRAMS = wimlib-imagex
+wimlib_imagex_SOURCES = \
+ programs/imagex.c \
+ include/wimlib.h \
+ include/wimlib_tchar.h
+wimlib_imagex_LDADD = $(top_builddir)/libwim.la
+wimlib_imagex_CFLAGS = $(AM_CFLAGS) $(WINDOWS_CFLAGS) -Wno-deprecated-declarations
if WINDOWS_NATIVE_BUILD
-imagex_SOURCES += programs/imagex-win32.c \
- programs/imagex-win32.h \
- programs/wgetopt.c \
- programs/wgetopt.h
+wimlib_imagex_SOURCES += \
+ programs/imagex-win32.c \
+ programs/imagex-win32.h \
+ programs/wgetopt.c \
+ programs/wgetopt.h
endif
-imagex_cmds = append \
- apply \
- capture \
- delete \
- dir \
- export \
- extract \
- info \
- join \
- mount \
- mountrw \
- optimize\
- split \
- unmount \
- update \
- verify
+wimlib_imagex_cmds = \
+ append \
+ apply \
+ capture \
+ delete \
+ dir \
+ export \
+ extract \
+ info \
+ join \
+ mount \
+ mountrw \
+ optimize \
+ split \
+ unmount \
+ update \
+ verify
install-exec-hook:
- if [ "@IMAGEX_PROGNAME@" != imagex ]; then \
- cd $(DESTDIR)$(bindir) && mv -f imagex "@IMAGEX_PROGNAME@"; \
- fi
- for cmd in $(imagex_cmds); do \
- cd $(DESTDIR)$(bindir) && \
- ln -f "@IMAGEX_PROGNAME@" wim$${cmd}; \
+ for cmd in $(wimlib_imagex_cmds); do \
+ cd $(DESTDIR)$(bindir) && \
+ ln -f wimlib-imagex wim$${cmd}; \
done
install-data-hook:
- for cmd in $(imagex_cmds); do \
- cd $(DESTDIR)$(mandir)/man1 && \
- ln -sf "@IMAGEX_PROGNAME@-$${cmd}.1" wim$${cmd}.1; \
+ for cmd in $(wimlib_imagex_cmds); do \
+ cd $(DESTDIR)$(mandir)/man1 && \
+ ln -sf wimlib-imagex-$${cmd}.1 wim$${cmd}.1; \
done
uninstall-hook:
- if [ "@IMAGEX_PROGNAME@" != imagex ]; then \
- rm -f $(DESTDIR)$(bindir)/"@IMAGEX_PROGNAME@"; \
- rm -f $(DESTDIR)$(bindir)/imagex; \
- fi
- for cmd in $(imagex_cmds); do \
- rm -f $(DESTDIR)$(bindir)/wim$${cmd}; \
+ for cmd in $(wimlib_imagex_cmds); do \
+ rm -f $(DESTDIR)$(bindir)/wim$${cmd}; \
+ rm -f $(DESTDIR)$(mandir)/man1/wim$${cmd}.1; \
done
- for cmd in $(imagex_cmds); do \
- rm -f $(DESTDIR)$(mandir)/man1/wim$${cmd}.1; \
- done
-
dist_bin_SCRIPTS = programs/mkwinpeimg
$(pkgconfig_DATA): config.status
wimlib_manpages = \
- doc/man1/@IMAGEX_PROGNAME@.1 \
- doc/man1/@IMAGEX_PROGNAME@-append.1 \
- doc/man1/@IMAGEX_PROGNAME@-apply.1 \
- doc/man1/@IMAGEX_PROGNAME@-capture.1 \
- doc/man1/@IMAGEX_PROGNAME@-delete.1 \
- doc/man1/@IMAGEX_PROGNAME@-dir.1 \
- doc/man1/@IMAGEX_PROGNAME@-export.1 \
- doc/man1/@IMAGEX_PROGNAME@-extract.1 \
- doc/man1/@IMAGEX_PROGNAME@-info.1 \
- doc/man1/@IMAGEX_PROGNAME@-join.1 \
- doc/man1/@IMAGEX_PROGNAME@-mount.1 \
- doc/man1/@IMAGEX_PROGNAME@-mountrw.1 \
- doc/man1/@IMAGEX_PROGNAME@-optimize.1 \
- doc/man1/@IMAGEX_PROGNAME@-split.1 \
- doc/man1/@IMAGEX_PROGNAME@-unmount.1 \
- doc/man1/@IMAGEX_PROGNAME@-update.1 \
- doc/man1/@IMAGEX_PROGNAME@-verify.1 \
+ doc/man1/wimlib-imagex.1 \
+ doc/man1/wimlib-imagex-append.1 \
+ doc/man1/wimlib-imagex-apply.1 \
+ doc/man1/wimlib-imagex-capture.1 \
+ doc/man1/wimlib-imagex-delete.1 \
+ doc/man1/wimlib-imagex-dir.1 \
+ doc/man1/wimlib-imagex-export.1 \
+ doc/man1/wimlib-imagex-extract.1 \
+ doc/man1/wimlib-imagex-info.1 \
+ doc/man1/wimlib-imagex-join.1 \
+ doc/man1/wimlib-imagex-mount.1 \
+ doc/man1/wimlib-imagex-mountrw.1 \
+ doc/man1/wimlib-imagex-optimize.1 \
+ doc/man1/wimlib-imagex-split.1 \
+ doc/man1/wimlib-imagex-unmount.1 \
+ doc/man1/wimlib-imagex-update.1 \
+ doc/man1/wimlib-imagex-verify.1 \
doc/man1/mkwinpeimg.1
man1_MANS = $(wimlib_manpages)
Slight performance improvements in compression and decompression.
+ Removed the --with-imagex-progname and --enable-more-assertions
+ configure options.
+
Version 1.7.3:
Fix for very slow export from solid WIM / ESD files.
PKGCONFIG_PRIVATE_REQUIRES=""
PKGCONFIG_PRIVATE_LIBS=""
-AC_ARG_WITH(imagex-progname,
- [AS_HELP_STRING([--with-imagex-progname=NAME],
- [Set the name of installed ImageX program (default: wimlib-imagex)])],
- [IMAGEX_PROGNAME=$withval],
- [IMAGEX_PROGNAME="wimlib-imagex"])
-
-AC_SUBST([IMAGEX_PROGNAME], [$IMAGEX_PROGNAME])
-AC_DEFINE_UNQUOTED([IMAGEX_PROGNAME], ["$IMAGEX_PROGNAME"],
- [Binary name for the implementation of ImageX distributed with wimlib])
-
AC_CONFIG_HEADERS([config.h])
AC_CONFIG_FILES([Makefile]
[doc/Doxyfile]
[wimlib.pc]
- [doc/man1/"$IMAGEX_PROGNAME".1:doc/man1/imagex.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-append.1:doc/man1/imagex-append.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-apply.1:doc/man1/imagex-apply.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-capture.1:doc/man1/imagex-capture.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-delete.1:doc/man1/imagex-delete.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-dir.1:doc/man1/imagex-dir.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-export.1:doc/man1/imagex-export.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-extract.1:doc/man1/imagex-extract.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-info.1:doc/man1/imagex-info.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-join.1:doc/man1/imagex-join.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-mount.1:doc/man1/imagex-mount.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-mountrw.1:doc/man1/imagex-mountrw.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-optimize.1:doc/man1/imagex-optimize.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-split.1:doc/man1/imagex-split.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-unmount.1:doc/man1/imagex-unmount.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-update.1:doc/man1/imagex-update.1.in]
- [doc/man1/"$IMAGEX_PROGNAME"-verify.1:doc/man1/imagex-verify.1.in]
+ [doc/man1/wimlib-imagex.1:doc/man1/imagex.1.in]
+ [doc/man1/wimlib-imagex-append.1:doc/man1/imagex-append.1.in]
+ [doc/man1/wimlib-imagex-apply.1:doc/man1/imagex-apply.1.in]
+ [doc/man1/wimlib-imagex-capture.1:doc/man1/imagex-capture.1.in]
+ [doc/man1/wimlib-imagex-delete.1:doc/man1/imagex-delete.1.in]
+ [doc/man1/wimlib-imagex-dir.1:doc/man1/imagex-dir.1.in]
+ [doc/man1/wimlib-imagex-export.1:doc/man1/imagex-export.1.in]
+ [doc/man1/wimlib-imagex-extract.1:doc/man1/imagex-extract.1.in]
+ [doc/man1/wimlib-imagex-info.1:doc/man1/imagex-info.1.in]
+ [doc/man1/wimlib-imagex-join.1:doc/man1/imagex-join.1.in]
+ [doc/man1/wimlib-imagex-mount.1:doc/man1/imagex-mount.1.in]
+ [doc/man1/wimlib-imagex-mountrw.1:doc/man1/imagex-mountrw.1.in]
+ [doc/man1/wimlib-imagex-optimize.1:doc/man1/imagex-optimize.1.in]
+ [doc/man1/wimlib-imagex-split.1:doc/man1/imagex-split.1.in]
+ [doc/man1/wimlib-imagex-unmount.1:doc/man1/imagex-unmount.1.in]
+ [doc/man1/wimlib-imagex-update.1:doc/man1/imagex-update.1.in]
+ [doc/man1/wimlib-imagex-verify.1:doc/man1/imagex-verify.1.in]
[doc/man1/mkwinpeimg.1])
AC_CONFIG_FILES([programs/mkwinpeimg], [chmod +x programs/mkwinpeimg])
-.so man1/@IMAGEX_PROGNAME@-capture.1
+.so man1/wimlib-imagex-capture.1
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-apply \- Extract one image, or all images, from a WIM archive
+wimlib-imagex-apply \- Extract one image, or all images, from a WIM archive
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ apply\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fITARGET\fR [\fIOPTION\fR...]
+\fBwimlib-imagex apply\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fITARGET\fR [\fIOPTION\fR...]
.SH DESCRIPTION
-\fB@IMAGEX_PROGNAME@ apply\fR extracts an image, or all images, from the Windows
+\fBwimlib-imagex apply\fR extracts an image, or all images, from the Windows
Imaging (WIM) file \fIWIMFILE\fR. This command is also available as simply
\fBwimapply\fR if the appropriate hard link or batch file has been installed.
.PP
This command is designed to extract, or "apply", one or more full WIM images.
If you instead want to extract only certain files or directories contained in a
-WIM image, consider using \fB@IMAGEX_PROGNAME@ extract\fR or
-\fB@IMAGEX_PROGNAME@ mount\fR instead. (\fB@IMAGEX_PROGNAME@ mount\fR is not
+WIM image, consider using \fBwimlib-imagex extract\fR or
+\fBwimlib-imagex mount\fR instead. (\fBwimlib-imagex mount\fR is not
supported on Windows.)
.PP
\fIIMAGE\fR specifies the WIM image in \fIWIMFILE\fR to extract. It may be a
1-based index of an image in \fIWIMFILE\fR, the name of an image in
\fIWIMFILE\fR, or the keyword "all" to indicate that all images in \fIWIMFILE\fR
-are to be extracted. Use the \fB@IMAGEX_PROGNAME@ info\fR (1) command to show
+are to be extracted. Use the \fBwimlib-imagex info\fR (1) command to show
what images a WIM file contains. \fIIMAGE\fR may be omitted if \fIWIMFILE\fR
contains only one image.
.PP
\fIWIMFILE\fR may be "-" to read the WIM from standard input rather than from a
file, but see \fBPIPABLE WIMS\fR for more information.
.PP
-\fB@IMAGEX_PROGNAME@ apply\fR supports applying images from stand-alone WIMs as
+\fBwimlib-imagex apply\fR supports applying images from stand-alone WIMs as
well as split WIMs. See \fBSPLIT WIMS\fR.
.SH DIRECTORY EXTRACTION (UNIX)
-This section documents how \fB@IMAGEX_PROGNAME@ apply\fR (and also
-\fB@IMAGEX_PROGNAME@ extract\fR) extract a WIM image (or a possibly a subset
-thereof, in the case of \fB@IMAGEX_PROGNAME@ extract\fR) to a directory on
+This section documents how \fBwimlib-imagex apply\fR (and also
+\fBwimlib-imagex extract\fR) extract a WIM image (or a possibly a subset
+thereof, in the case of \fBwimlib-imagex extract\fR) to a directory on
UNIX-like systems. See \fBDIRECTORY EXTRACTION (WINDOWS)\fR for the
corresponding documentation for Windows.
.PP
providing a \fITARGET\fR directory. However, it is important to keep in mind
that the WIM format was designed for Windows, and as a result WIM files can
contain data or metadata that cannot be represented on UNIX-like systems. The
-main information that \fB@IMAGEX_PROGNAME@\fR will \fInot\fR be able to extract
+main information that \fBwimlib-imagex\fR will \fInot\fR be able to extract
on UNIX-like systems is the following:
.IP \[bu] 4
Windows security descriptors (which include the file owner, group, and ACLs).
File creation timestamps.
.PP
Notes: Unsupported data and metadata is simply not extracted, but
-\fB@IMAGEX_PROGNAME@\fR will attempt to warn you when the contents of the WIM
+\fBwimlib-imagex\fR will attempt to warn you when the contents of the WIM
image can't be exactly represented when extracted. Last access and last
modification timestamps are specified to 100 nanosecond granularity in the WIM
file, but will only be extracted to the highest precision supported by the
be extracted as uncompressed, while encrypted files will not be extracted at
all.
.SH NTFS VOLUME EXTRACTION (UNIX)
-This section documents how \fB@IMAGEX_PROGNAME@ apply\fR extracts a WIM image
+This section documents how \fBwimlib-imagex apply\fR extracts a WIM image
directly to an NTFS volume image on UNIX-like systems.
.PP
-As mentioned, \fB@IMAGEX_PROGNAME@\fR running on a UNIX-like system can apply a
+As mentioned, \fBwimlib-imagex\fR running on a UNIX-like system can apply a
WIM image directly to an NTFS volume by specifying \fITARGET\fR as a regular file
or block device containing an NTFS filesystem. The NTFS filesystem need not be
empty, although it's expected that it be empty for the intended use cases. A
.PP
Regardless, since almost all information from the WIM image is restored in this
mode, it is possible to restore an image of an actual Windows installation using
-\fB@IMAGEX_PROGNAME@\fR on UNIX-like systems in addition to with
-\fB@IMAGEX_PROGNAME@\fR on Windows. In the examples at the end of this manual
+\fBwimlib-imagex\fR on UNIX-like systems in addition to with
+\fBwimlib-imagex\fR on Windows. In the examples at the end of this manual
page, there is an example of applying an image from the "install.wim" file
contained in the installation media for Windows Vista, Windows 7, and Windows 8
in the "sources" directory.
.PP
So let's say you applied an image from an existing "install.wim" as in the
example, or you've applied a custom Windows image that you've created using the
-\fB@IMAGEX_PROGNAME@ capture\fR (1) command. You've just applied the "Boot" partition, or
+\fBwimlib-imagex capture\fR (1) command. You've just applied the "Boot" partition, or
the main Windows partition, but there is no "System" partition yet (i.e. no
\\BOOTMGR and no \\Boot\\BCD).
.PP
bootable flag on it, and have a master boot record that loads the bootable
partition (Windows' MBR does, and SYSLINUX provides an equivalent MBR).
.SH DIRECTORY EXTRACTION (WINDOWS)
-On Windows, \fB@IMAGEX_PROGNAME@ apply\fR and \fB@IMAGEX_PROGNAME@ extract\fR
+On Windows, \fBwimlib-imagex apply\fR and \fBwimlib-imagex extract\fR
natively support Windows-specific and NTFS-specific data. For best results, the
-target directory should be located on an NTFS volume and \fB@IMAGEX_PROGNAME@\fR
+target directory should be located on an NTFS volume and \fBwimlib-imagex\fR
should be run with Administrator privileges; however, non-NTFS filesystems and
running without Administrator privileges are also supported.
.PP
-On Windows, \fB@IMAGEX_PROGNAME@ apply\fR and \fB@IMAGEX_PROGNAME@ extract\fR
+On Windows, \fBwimlib-imagex apply\fR and \fBwimlib-imagex extract\fR
try to extract as much data and metadata as possible, including:
.IP \[bu] 4
All data streams of all files. This includes the default file contents, as well
\fB--norpfix\fR for documentation on exactly how absolute symbolic links and
junctions are extracted.) However, as per the default security settings of
Windows, it is impossible to create a symbolic link or junction point without
-Administrator privileges; therefore, you must run \fB@IMAGEX_PROGNAME@\fR as the
+Administrator privileges; therefore, you must run \fBwimlib-imagex\fR as the
Administrator if you wish to fully restore an image containing symbolic links
and/or junction points. (Otherwise, merely a warning will be issued when a
symbolic link or junction point cannot be extracted due to insufficient
specified. Furthermore, unless \fB--strict-acls\fR is specified, the security
descriptors for individual files or directories may be omitted or only partially
set if the user does not have permission to set them, which can be a problem if
-\fB@IMAGEX_PROGNAME@\fR is run as a non-Administrator.
+\fBwimlib-imagex\fR is run as a non-Administrator.
.IP \[bu]
File attributes, including hidden, sparse, compressed, encrypted, etc, when
supported by the filesystem.
.PP
Additional notes about extracting files on Windows:
.IP \[bu] 4
-\fB@IMAGEX_PROGNAME@\fR will issue a warning when it is unable to extract the
+\fBwimlib-imagex\fR will issue a warning when it is unable to extract the
exact metadata and data of the WIM image, for example due to features mentioned
above not being supported by the target filesystem.
.IP \[bu]
Since encrypted files (with FILE_ATTRIBUTE_ENCRYPTED) are not stored in
-plaintext in the WIM image, \fB@IMAGEX_PROGNAME@\fR cannot restore encrypted
+plaintext in the WIM image, \fBwimlib-imagex\fR cannot restore encrypted
files to filesystems not supporting encryption. Therefore, on such filesystems,
encrypted files will not be extracted. Furthermore, even if encrypted
files are restored to a filesystem that supports encryption, they will only be
attributes; therefore, extracted files may have those attributes. If this is
not what you want, use the \fB--no-attributes\fR option.
.SH SPLIT WIMS
-You may use \fB@IMAGEX_PROGNAME@ apply\fR to apply images from a split WIM. The
+You may use \fBwimlib-imagex apply\fR to apply images from a split WIM. The
\fIWIMFILE\fR argument must specify the first part of the split WIM, while the
additional parts of the split WIM must be specified in one or more
\fB--ref\fR="\fIGLOB\fR" options. Since globbing is built into the \fB--ref\fR
To apply the first image of this split WIM to the directory "dir", run:
.PP
.RS
-@IMAGEX_PROGNAME@ apply mywim.swm 1 dir --ref="mywim*.swm"
+wimlib-imagex apply mywim.swm 1 dir --ref="mywim*.swm"
.RE
.PP
As a special case, if you are applying an image from standard input from a split
concatenated together on standard input. They can be provided in any order,
with the exception of the first part, which must be first.
.SH PIPABLE WIMS
-As of wimlib 1.5.0, \fB@IMAGEX_PROGNAME@ apply\fR supports applying a WIM from a
+As of wimlib 1.5.0, \fBwimlib-imagex apply\fR supports applying a WIM from a
nonseekable file, such as a pipe, provided that the WIM was captured with
-\fB--pipable\fR (see \fB@IMAGEX_PROGNAME@ capture\fR(1)). To use standard input
+\fB--pipable\fR (see \fBwimlib-imagex capture\fR(1)). To use standard input
as the WIM, specify "-" as \fIWIMFILE\fR. A useful use of this ability is to
apply an image from a WIM while streaming it from a server. For example, to
apply the first image from a WIM file available on a HTTP server to an NTFS
wget -O - http://myserver/mywim.wim | wimapply - 1 /dev/sda1
.RE
.PP
-(The above also used the \fBwimapply\fR abbreviation for \fB@IMAGEX_PROGNAME@
+(The above also used the \fBwimapply\fR abbreviation for \fBwimlib-imagex
apply\fR.) Note: WIM files are \fInot\fR pipable by default; you have to
explicitly capture them with \fB--pipable\fR, and they are \fInot\fR compatible
-with Microsoft's software. See \fB@IMAGEX_PROGNAME@ capture\fR(1) for more
+with Microsoft's software. See \fBwimlib-imagex capture\fR(1) for more
information.
.PP
It is possible to apply an image from a pipable WIM split into multiple parts;
File glob of additional WIMs or split WIM parts to reference resources from.
See \fBSPLIT_WIMS\fR. This option can be specified multiple times. Note:
\fIGLOB\fR is listed in quotes because it is interpreted by
-\fB@IMAGEX_PROGNAME@\fR and may need to be quoted to protect against shell
+\fBwimlib-imagex\fR and may need to be quoted to protect against shell
expansion.
.TP
\fB--rpfix\fR, \fB--norpfix\fR
Set whether to fix targets of absolute symbolic links (reparse points in Windows
terminology) or not. When enabled (\fB--rpfix\fR), extracted absolute symbolic
links that are marked in the WIM image as being fixed are assumed to have
-absolute targets relative to the image root, and therefore \fB@IMAGEX_PROGNAME@
+absolute targets relative to the image root, and therefore \fBwimlib-imagex
apply\fR prepends the absolute path to the extraction target directory to their
targets. The intention is that you can apply an image containing absolute
symbolic links and still have them be valid after it has been applied to any
.TP
\fB--unix-data\fR
(UNIX-like systems only) Restore UNIX owners, groups, modes, and device IDs
-(major and minor numbers) that were captured by \fB@IMAGEX_PROGNAME@ capture\fR
+(major and minor numbers) that were captured by \fBwimlib-imagex capture\fR
with the \fB--unix-data\fR option. As of wimlib v1.7.0, you can backup and
restore not only the standard UNIX file permission information, but also
character device nodes, block device nodes, named pipes (FIFOs), and UNIX domain
\fB--strict-acls\fR
Fail immediately if the full security descriptor of any file or directory cannot
be set exactly as specified in the WIM file. If this option is not specified,
-when \fB@IMAGEX_PROGNAME@\fR on Windows does not have permission to set a
+when \fBwimlib-imagex\fR on Windows does not have permission to set a
security descriptor on an extracted file, it falls back to setting it only
partially (e.g. with SACL omitted), and in the worst case omits it entirely.
-However, this should only be a problem when running \fB@IMAGEX_PROGNAME@\fR
+However, this should only be a problem when running \fBwimlib-imagex\fR
without Administrator rights. Also, on UNIX-like systems, this flag can also be
-combined with \fB--unix-data\fR to cause \fB@IMAGEX_PROGNAME@\fR to fail
+combined with \fB--unix-data\fR to cause \fBwimlib-imagex\fR to fail
immediately if the UNIX owner, group, or mode on an extracted file cannot be set
for any reason.
.TP
\'\\0', '\\', ':', '*', '?', '"', '<', '>', or '|', and cannot end with a space
or period. Ordinarily, files in WIM images should meet these conditions as
well. However, it is not guaranteed, and in particular a WIM image captured with
-\fB@IMAGEX_PROGNAME@\fR on a POSIX-compliant system could contain such files. By
+\fBwimlib-imagex\fR on a POSIX-compliant system could contain such files. By
default, invalid names will be ignored, and if there are multiple names
differing only in case, one will be chosen to extract arbitrarily; however, with
\fB--include-invalid-names\fR, all names will be sanitized and extracted in some
intent only. In addition, the Microsoft driver can externally back files from
WIM files that use XPRESS chunks of size 8192, 16384, and 32768, or LZX chunks
of size 32768, in addition to the default XPRESS chunks of size 4096 that are
-created when \fB@IMAGEX_PROGNAME@ capture\fR is run with the \fB--wimboot\fR
+created when \fBwimlib-imagex capture\fR is run with the \fB--wimboot\fR
option.
.SH NOTES
\fIData integrity\fR: WIM files include SHA1 message digests for file data.
-\fB@IMAGEX_PROGNAME@ apply\fR calculates the SHA1 message digest of every file
+\fBwimlib-imagex apply\fR calculates the SHA1 message digest of every file
it extracts and issues an error if it is not equal to the SHA1 message digest
provided in the WIM. (This default behavior seems equivalent to the
\fB/verify\fR option of ImageX.) Note that this is separate from the integrity
installation media to the directory "boot":
.RS
.PP
-@IMAGEX_PROGNAME@ apply /mnt/windows/sources/boot.wim 1 boot
+wimlib-imagex apply /mnt/windows/sources/boot.wim 1 boot
.RE
.PP
Same as above, but using the \fBwimapply\fR abbreviation:
which can be found on the Windows Vista/7/8 installation media:
.RS
.PP
-@IMAGEX_PROGNAME@ apply install.wim 1 E:\\
+wimlib-imagex apply install.wim 1 E:\\
.RE
.PP
Same as above, but running on a UNIX-like system where the corresponding
partition is /dev/sda2:
.RS
.PP
-@IMAGEX_PROGNAME@ apply install.wim 1 /dev/sda2
+wimlib-imagex apply install.wim 1 /dev/sda2
.RE
.PP
Note that before running either of the above commands, an NTFS filesystem may
WIMS\fR, and an example of applying a split WIM can be found in \fBSPLIT
WIMS\fR.
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
-.BR @IMAGEX_PROGNAME@-capture (1)
-.BR @IMAGEX_PROGNAME@-extract (1)
-.BR @IMAGEX_PROGNAME@-info (1)
+.BR wimlib-imagex (1)
+.BR wimlib-imagex-capture (1)
+.BR wimlib-imagex-extract (1)
+.BR wimlib-imagex-info (1)
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-capture, @IMAGEX_PROGNAME@-append \- Create or append a WIM image
+wimlib-imagex-capture, wimlib-imagex-append \- Create or append a WIM image
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ capture\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR \
+\fBwimlib-imagex capture\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR \
[\fIIMAGE_DESCRIPTION\fR]] [\fIOPTION\fR...]
.br
-\fB@IMAGEX_PROGNAME@ append\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR \
+\fBwimlib-imagex append\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR \
[\fIIMAGE_DESCRIPTION\fR]] [\fIOPTION\fR...]
.SH DESCRIPTION
-The \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR commands
+The \fBwimlib-imagex capture\fR and \fBwimlib-imagex append\fR commands
create a Windows Imaging (WIM) image from a directory tree. The
-\fB@IMAGEX_PROGNAME@ capture\fR command creates a new WIM file containing the
-captured image, while the \fB@IMAGEX_PROGNAME@ append\fR command appends the
+\fBwimlib-imagex capture\fR command creates a new WIM file containing the
+captured image, while the \fBwimlib-imagex append\fR command appends the
captured image to an existing WIM file.
These commands are also available as simply \fBwimcapture\fR and \fBwimappend\fR
if the appropriate hard links or batch files are installed.
assumed and the WIM file is written to standard output in a special pipable
format. See the documentation for \fB--pipable\fR for more details.
.SH DIRECTORY CAPTURE (UNIX)
-This section documents how \fB@IMAGEX_PROGNAME@\fR captures files from a
+This section documents how \fBwimlib-imagex\fR captures files from a
directory tree on UNIX-like systems. See \fBDIRECTORY CAPTURE (WINDOWS)\fR for
the corresponding documentation for Windows.
.PP
change time (ctime). Hard links and symbolic links are supported by the WIM
format and \fIare\fR stored. Symbolic links are turned into "native" Windows
symbolic links, or "reparse points"; this process is fully reversible, e.g.
-automatically by \fB@IMAGEX_PROGNAME@ apply\fR, unless the symbolic link target
+automatically by \fBwimlib-imagex apply\fR, unless the symbolic link target
contains backslash characters.
.PP
Pedantic note: A limitation of the WIM format prevents the unusual case where a
single symbolic link file itself has multiple names (hard links); in this
unlikely case, each symbolic link is stored as an independent file.
.SH NTFS VOLUME CAPTURE (UNIX)
-This section documents how \fB@IMAGEX_PROGNAME@\fR captures files directly from
+This section documents how \fBwimlib-imagex\fR captures files directly from
an NTFS volume image on UNIX-like systems.
.PP
On UNIX-like systems, a special image capture mode is entered when \fISOURCE\fR
is a regular file or block device. In this mode, \fISOURCE\fR is assumed to be
-an NTFS volume or volume image, and \fB@IMAGEX_PROGNAME@\fR will capture a WIM
+an NTFS volume or volume image, and \fBwimlib-imagex\fR will capture a WIM
image containing the full contents of the NTFS volume, including NTFS-specific
data. This is done using libntfs-3g.
.PP
the full data of the file rather than the "sparse" data. (The data is, however,
subject to the WIM format's compression.)
.SH DIRECTORY CAPTURE (WINDOWS)
-On Windows, \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR
+On Windows, \fBwimlib-imagex capture\fR and \fBwimlib-imagex append\fR
natively support Windows-specific and NTFS-specific data. They therefore act
similarly to the corresponding commands of Microsoft's ImageX or DISM. For best
results, the directory being captured should be on an NTFS volume and
-\fB@IMAGEX_PROGNAME@\fR should be run with Administrator privileges; however,
+\fBwimlib-imagex\fR should be run with Administrator privileges; however,
non-NTFS filesystems and running without Administrator privileges are also
supported.
.PP
-On Windows, \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR
+On Windows, \fBwimlib-imagex capture\fR and \fBwimlib-imagex append\fR
try to archive as much data and metadata as possible, including:
.IP \[bu] 4
All data streams of all files.
is not specified. However, beware that unless \fB--strict-acls\fR is specified,
the security descriptors for individual files or directories may be omitted or
only partially captured if the user does not have permission to read them, which
-can be a problem if \fB@IMAGEX_PROGNAME@\fR is run as a non-Administrator.
+can be a problem if \fBwimlib-imagex\fR is run as a non-Administrator.
.IP \[bu]
File attributes, including hidden, sparse, compressed, encrypted, etc.
Encrypted files will be stored in encrypted form rather than in plain text.
.IP \[bu]
Hard links, if supported by the source filesystem.
.PP
-Note: the capture process is reversible, since when \fB@IMAGEX_PROGNAME@
+Note: the capture process is reversible, since when \fBwimlib-imagex
apply\fR (on Windows) extracts the captured WIM image, it will extract all of
the above information, at least to the extent supported by the destination
filesystem. One exception is that since encrypted files are stored as
Specifies that the new image is to be made the bootable image of the WIM archive.
.TP
\fB--check\fR
-For \fB@IMAGEX_PROGNAME@ append\fR, before performing the append operation,
+For \fBwimlib-imagex append\fR, before performing the append operation,
check the integrity of \fIWIMFILE\fR if an integrity table is present.
Furthermore, include an integrity table in the new WIM file
-(\fB@IMAGEX_PROGNAME@ capture\fR) or the modified WIM file (\fB@IMAGEX_PROGNAME@
+(\fBwimlib-imagex capture\fR) or the modified WIM file (\fBwimlib-imagex
append\fR). If this option is not specified, no integrity table is included in
-a WIM file created with \fB@IMAGEX_PROGNAME@ capture\fR, while a WIM file
-updated with \fB@IMAGEX_PROGNAME@ append\fR will be written with an integrity
+a WIM file created with \fBwimlib-imagex capture\fR, while a WIM file
+updated with \fBwimlib-imagex append\fR will be written with an integrity
table if and only if one was present before.
.TP
\fB--compress\fR=\fITYPE\fR[:\fILEVEL\fR]
together, rather than each unique stream ("file") independently. This can
result in a significantly better compression ratio, but this format greatly
decreases the performance of random access to the data, as may occur on a WIM
-mounted with \fB@IMAGEX_PROGNAME@ mount\fR. Also, WIMs created using this
+mounted with \fBwimlib-imagex mount\fR. Also, WIMs created using this
option use a different version number in their header and are only compatible
with WIMGAPI Windows 8 and later, and DISM Windows 8.1 and later.
.IP ""
available CPUs).
.TP
\fB--rebuild\fR
-For \fB@IMAGEX_PROGNAME@ append\fR: rebuild the entire WIM rather than appending the new
+For \fBwimlib-imagex append\fR: rebuild the entire WIM rather than appending the new
data to the end of it. Rebuilding the WIM is slower, but will save a little bit
-of space that would otherwise be left as a hole in the WIM. Also see \fB@IMAGEX_PROGNAME@
+of space that would otherwise be left as a hole in the WIM. Also see \fBwimlib-imagex
optimize\fR(1).
.TP
\fB--flags\fR=\fIEDITIONID\fR
relative to the root of the directory tree being captured. When disabled
(\fB--norpfix\fR), absolute symbolic links will be captured exactly as is.
.IP ""
-The default behavior for \fB@IMAGEX_PROGNAME@ capture\fR is equivalent to
-\fB--rpfix\fR. The default behavior for \fB@IMAGEX_PROGNAME@ append\fR will be
+The default behavior for \fBwimlib-imagex capture\fR is equivalent to
+\fB--rpfix\fR. The default behavior for \fBwimlib-imagex append\fR will be
\fB--rpfix\fR if reparse point fixups have previously been done on
\fIWIMFILE\fR, otherwise \fB--norpfix\fR.
.IP ""
behavior from the previous paragraph.
.TP
\fB--source-list\fR
-\fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR support
+\fBwimlib-imagex capture\fR and \fBwimlib-imagex append\fR support
creating a WIM image from multiple separate files or directories. When
\fB--source-list\fR is specified, the \fISOURCE\fR argument specifies the name
of a text file, each line of which is either 1 or 2 whitespace separated file
.TP
\fB--pipable\fR
Create a "pipable" WIM, which can be applied fully sequentially, including from
-a pipe. An image in the resulting WIM can be applied with \fB@IMAGEX_PROGNAME@
+a pipe. An image in the resulting WIM can be applied with \fBwimlib-imagex
apply\fR, either normally by specifying the WIM file name, or with
-\fB@IMAGEX_PROGNAME@ apply -\fR to read the WIM from standard input. See
-\fB@IMAGEX_PROGNAME@ apply\fR(1) for more details.
+\fBwimlib-imagex apply -\fR to read the WIM from standard input. See
+\fBwimlib-imagex apply\fR(1) for more details.
.IP ""
For append operations, this option will result in a full rebuild of the WIM to
make it pipable. For capture operations, the captured WIM is simply created as
the WIM so that they can be read sequentially and also makes several other
modifications. As a result, these "pipable" WIMs are \fInot compatible with
Microsoft's software\fR, so keep this in mind if you're going to use them. If
-desired, you can use \fB@IMAGEX_PROGNAME@ optimize --not-pipable\fR to re-write
-a pipable WIM as a regular WIM. (\fB@IMAGEX_PROGNAME@ export\fR also provides
+desired, you can use \fBwimlib-imagex optimize --not-pipable\fR to re-write
+a pipable WIM as a regular WIM. (\fBwimlib-imagex export\fR also provides
the capability to export images from a pipable WIM into a non-pipable WIM, or
vice versa.)
.IP ""
(\fB--rebuild\fR is always implied), and also they aren't compatible with
Microsoft's software.
.IP ""
-\fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR can both
+\fBwimlib-imagex capture\fR and \fBwimlib-imagex append\fR can both
write a pipable WIM directly to standard output; this is done automatically if
\fIWIMFILE\fR is specified as "-". (In that case, \fB--pipable\fR is assumed.)
.TP
\fB--not-pipable\fR
Ensure the resulting WIM is in the normal, non-pipable WIM format. This is the
-default for \fB@IMAGEX_PROGNAME@ capture\fR, except when writing to standard
-output (\fIWIMFILE\fR specified as "-"), and also for \fB@IMAGEX_PROGNAME@
+default for \fBwimlib-imagex capture\fR, except when writing to standard
+output (\fIWIMFILE\fR specified as "-"), and also for \fBwimlib-imagex
append\fR, except when appending to a WIM that is already pipable.
.TP
\fB--update-of\fR=[\fIWIMFILE\fR:]\fIIMAGE\fR
once) for capture operations.
.TP
\fB--delta-from\fR=\fIWIMFILE\fR
-For \fB@IMAGEX_PROGNAME@ capture\fR only: capture the new WIM as a "delta" from
+For \fBwimlib-imagex capture\fR only: capture the new WIM as a "delta" from
\fIWIMFILE\fR. Any streams that would ordinarily need to be archived in the new
WIM are omitted if they are already present in the \fIWIMFILE\fR on which the
delta is being based. The new WIM will still contain a full copy of the image
WIM will only contain streams not present in any of the specified base WIMs.
.IP ""
To operate on the resulting delta WIM using other commands such as
-\fB@IMAGEX_PROGNAME@ apply\fR, you must specify the delta WIM as the WIM file to
+\fBwimlib-imagex apply\fR, you must specify the delta WIM as the WIM file to
operate on, but also reference the base WIM(s) using the \fB--ref\fR option.
Beware: to retain the proper functioning of the delta WIM, you can only add, not
delete, files and images to the base WIM(s) following the capture of a delta
.IP ""
However, note that as an alternative to the above sequence that used a delta
WIM, the second backup could have simply been appended to the WIM as new image
-using \fB@IMAGEX_PROGNAME@ append\fR. Delta WIMs should be used only if it's
+using \fBwimlib-imagex append\fR. Delta WIMs should be used only if it's
desired to base the backups or images on a separate, large file that is rarely
modified.
.IP ""
Microsoft's software. For example, you can use the /ref option of ImageX to
reference the base WIM(s), similar to above.
.IP ""
-Additional note: \fB@IMAGEX_PROGNAME@\fR is generalized enough that you can in
+Additional note: \fBwimlib-imagex\fR is generalized enough that you can in
fact combine \fB--pipable\fR and \fB--delta-from\fR to create pipable delta
WIMs. In such cases, the base WIM(s) must be captured as pipable as well as the
delta WIM, and when applying an image, the base WIM(s) must be sent over the
\fISOURCE\fR\\Windows\\System32\\WimBootCompress.ini if present and accessible;
however, this may still be overridden through the \fB--config\fR parameter.
.SH NOTES
-\fB@IMAGEX_PROGNAME@ append\fR does not support appending an image to a split WIM.
+\fBwimlib-imagex append\fR does not support appending an image to a split WIM.
.PP
-It is safe to abort an \fB@IMAGEX_PROGNAME@ append\fR command partway through;
-however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
+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.
.PP
-\fB@IMAGEX_PROGNAME@\fR creates WIMs compatible with Microsoft's software
+\fBwimlib-imagex\fR creates WIMs compatible with Microsoft's software
(WIMGAPI, ImageX, DISM), with some caveats:
.IP \[bu] 4
-With \fB@IMAGEX_PROGNAME@\fR on UNIX-like systems, it is possible to create a
+With \fBwimlib-imagex\fR on UNIX-like systems, it is possible to create a
WIM image containing files with names differing only in case, or files with
names containing the characters ':', '*', '?', '"', '<', '>', '|', or '\\',
which are valid on POSIX-compliant filesystems but not Windows. Be warned that
such files will not be extracted by default by the Windows version of
-\fB@IMAGEX_PROGNAME@\fR, and (even worse) Microsoft's ImageX can be confused by
+\fBwimlib-imagex\fR, and (even worse) Microsoft's ImageX can be confused by
such names and quit extracting the image partway through. (It perhaps is worth
pointing out that Windows' own default filesystem, NTFS, supports these
characters, although Windows does not!)
the image name need not be specified and will default to 'somedir':
.RS
.PP
-@IMAGEX_PROGNAME@ capture somedir mywim.wim
+wimlib-imagex capture somedir mywim.wim
.RE
.PP
or, if the \fBwimcapture\fR hard link or batch file has been installed, the
of a different directory tree to the WIM created above:
.RS
.PP
-@IMAGEX_PROGNAME@ append anotherdir mywim.wim
+wimlib-imagex append anotherdir mywim.wim
.RE
.PP
Easy enough, and the above examples of imaging directory trees work on both
with absolute symbolic links, and an image name and description:
.RS
.PP
-@IMAGEX_PROGNAME@ capture somedir mywim.wim --compress=fast \\
+wimlib-imagex capture somedir mywim.wim --compress=fast \\
.RS
--check --norpfix "Some Name" "Some Description"
.RE
containing an NTFS filesystem:
.RS
.PP
-@IMAGEX_PROGNAME@ capture /dev/sda2 windows7.wim "Windows 7"
+wimlib-imagex capture /dev/sda2 windows7.wim "Windows 7"
.RE
.PP
or, on Windows, to capture a full NTFS volume you instead need to specify the
root directory of the mounted volume, for example:
.RS
.PP
-@IMAGEX_PROGNAME@ capture E:\\ windows7.wim "Windows 7"
+wimlib-imagex capture E:\\ windows7.wim "Windows 7"
.RE
.PP
-Same as above example with capturing an NTFS volume from \fB@IMAGEX_PROGNAME@\fR
+Same as above example with capturing an NTFS volume from \fBwimlib-imagex\fR
running on a UNIX-like system, but capture the WIM in the wimlib-specific
-"pipable" format that can be piped to \fB@IMAGEX_PROGNAME@ apply\fR:
+"pipable" format that can be piped to \fBwimlib-imagex apply\fR:
.RS
.PP
-@IMAGEX_PROGNAME@ capture /dev/sda2 windows7.wim "Windows 7" \\
+wimlib-imagex capture /dev/sda2 windows7.wim "Windows 7" \\
.br
.RS
--pipable
specified when using standard output as the WIM "file":
.RS
.PP
-@IMAGEX_PROGNAME@ capture /dev/sda2 - "Windows 7" | someprog
+wimlib-imagex capture /dev/sda2 - "Windows 7" | someprog
.RE
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1),
-.BR @IMAGEX_PROGNAME@-apply (1)
+.BR wimlib-imagex (1),
+.BR wimlib-imagex-apply (1)
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-delete \- Delete an image from a WIM archive
+wimlib-imagex-delete \- Delete an image from a WIM archive
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ delete\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIOPTION\fR...]
+\fBwimlib-imagex delete\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIOPTION\fR...]
.SH DESCRIPTION
-\fB@IMAGEX_PROGNAME@ delete\fR deletes the specified image from the Windows Imaging (WIM)
+\fBwimlib-imagex delete\fR deletes the specified image from the Windows Imaging (WIM)
file \fIWIMFILE\fR.
This command is also available as simply \fBwimdelete\fR if the appropriate hard
link or batch file has been installed.
\fIIMAGE\fR specifies the WIM image in \fIWIMFILE\fR to delete. It may be a
1-based index of an image in the WIM, the name of an image in the WIM, or the
keyword "all" to indicate that all images are to be deleted. Use the
-\fB@IMAGEX_PROGNAME@ info\fR (1) command to show what images a WIM file
+\fBwimlib-imagex info\fR (1) command to show what images a WIM file
contains.
.SH NOTES
By default, the WIM file is rebuilt with all unnecessary file data removed.
Also wimlib allows you to delete all the images from a WIM and have a WIM with 0
images, although such a file wouldn't be very useful.
.PP
-\fB@IMAGEX_PROGNAME@ delete\fR does not support split WIMs.
+\fBwimlib-imagex delete\fR does not support split WIMs.
.SH OPTIONS
.TP 6
\fB--check\fR
referenced. This is probably not what you want, because no space will be
saved by deleting an image in this way.
.IP ""
-You may use \fB@IMAGEX_PROGNAME@ optimize\fR to delete unreferenced streams from a WIM that
+You may use \fBwimlib-imagex optimize\fR to delete unreferenced streams from a WIM that
has had images soft-deleted from it.
.SH EXAMPLES
Delete the first image from 'boot.wim':
.RS
.PP
-@IMAGEX_PROGNAME@ delete boot.wim 1
+wimlib-imagex delete boot.wim 1
.RE
.PP
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
-.BR @IMAGEX_PROGNAME@-info (1)
-.BR @IMAGEX_PROGNAME@-optimize (1)
+.BR wimlib-imagex (1)
+.BR wimlib-imagex-info (1)
+.BR wimlib-imagex-optimize (1)
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-dir \- Show the files contained in a WIM archive
+wimlib-imagex-dir \- Show the files contained in a WIM archive
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ dir\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIOPTIONS\fR]
+\fBwimlib-imagex dir\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIOPTIONS\fR]
.SH DESCRIPTION
Lists the files and directories contained in the specified image of the Windows
Imaging (WIM) file \fIWIMFILE\fR.
\fIIMAGE\fR specifies the image in \fIWIMFILE\fR to show the files of. It may
be a 1-based index of an image in \fIWIMFILE\fR, the name of an image in
\fIWIMFILE\fR, or the keyword "all" to indicate that files from all images in
-\fIWIMFILE\fR are to be shown. Use the \fB@IMAGEX_PROGNAME@ info\fR (1) command
+\fIWIMFILE\fR are to be shown. Use the \fBwimlib-imagex info\fR (1) command
to show what images a WIM file contains.
.SH OPTIONS
.TP 6
Show information about one file only. Intended for use with both \fB--path\fR
and \fB--detailed\fR.
.SH NOTES
-\fB@IMAGEX_PROGNAME@ dir\fR supports split WIMs, but it will only work on the
+\fBwimlib-imagex dir\fR supports split WIMs, but it will only work on the
first part of the split WIM.
.PP
DOS names and alternate (named) data streams are not listed unless the
List all files in the first image of 'boot.wim':
.RS
.PP
-@IMAGEX_PROGNAME@ dir boot.wim 1
+wimlib-imagex dir boot.wim 1
.RE
.PP
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
-.BR @IMAGEX_PROGNAME@-info (1)
+.BR wimlib-imagex (1)
+.BR wimlib-imagex-info (1)
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-export \- Exports an image from a WIM archive to an existing or new WIM archive
+wimlib-imagex-export \- Exports an image from a WIM archive to an existing or new WIM archive
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ export\fR \fISRC_WIMFILE\fR \fISRC_IMAGE\fR
+\fBwimlib-imagex export\fR \fISRC_WIMFILE\fR \fISRC_IMAGE\fR
\fIDEST_WIMFILE\fR [\fIDEST_IMAGE_NAME\fR [\fIDEST_IMAGE_DESCRIPTION\fR]]
[\fIOPTION\fR...]
.SH DESCRIPTION
\fISRC_IMAGE\fR specifies the image in \fISRC_WIMFILE\fR to export. It may be a
1-based index of an image in \fISRC_WIMFILE\fR, the name of an image in
\fISRC_WIMFILE\fR, or the keyword "all" to indicate that all images in
-\fISRC_WIMFILE\fR are to be exported. Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
+\fISRC_WIMFILE\fR are to be exported. Use the \fBwimlib-imagex info\fR (1)
command to list the images a WIM file contains.
.PP
If specified, \fIDEST_IMAGE_NAME\fR is the name to give the image being exported
being exported to \fIDEST_WIMFILE\fR. The default is its description in
\fISRC_WIMFILE\fR.
.PP
-\fB@IMAGEX_PROGNAME@ export\fR supports exporting images from stand-alone WIMs as well as
+\fBwimlib-imagex export\fR supports exporting images from stand-alone WIMs as well as
from split WIMs. However, you cannot export an image to a split WIM. See
\fBSPLIT WIMS\fR.
.PP
-\fB@IMAGEX_PROGNAME@ export\fR also supports exporting images from a non-pipable
+\fBwimlib-imagex export\fR also supports exporting images from a non-pipable
WIM into a (possibly new) pipable WIM, and vice versa. Furthermore, it will
export a pipable WIM directly to standard output if "-" is specified as
\fIDEST_WIMFILE\fR (this implies \fB--pipable\fR). See \fB--pipable\fR and
an effect if \fIDEST_WIMFILE\fR does not yet exist, since if \fIDEST_WIMFILE\fR
exists, the compression type must be the same as that of \fIDEST_WIMFILE\fR.
.IP ""
-See the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
+See the documentation for this option to \fBwimlib-imagex capture\fR (1) for
more details.
.TP
\fB--recompress\fR
.TP
\fB--chunk-size\fR=\fISIZE\fR
Set the WIM compression chunk size to \fISIZE\fR. See the documentation for
-this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
+this option to \fBwimlib-imagex capture\fR (1) for more details.
.TP
\fB--solid\fR
Create a "solid" archive that compresses multiple files together. This can
result in a higher compression ratio, but has disadvantages such as reduced
-compatibility. See the documentation for this option to \fB@IMAGEX_PROGNAME@
+compatibility. See the documentation for this option to \fBwimlib-imagex
capture\fR (1) for more details.
.TP
\fB--solid-chunk-size\fR=\fISIZE\fR
Like \fB--chunk-size\fR, but set the chunk size used in solid blocks. See the
-documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more
+documentation for this option to \fBwimlib-imagex capture\fR (1) for more
details.
.TP
\fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
Like \fB--compress\fR, but set the compression type used in solid blocks. See
-the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
+the documentation for this option to \fBwimlib-imagex capture\fR (1) for
more details.
.TP
\fB--threads\fR=\fINUM_THREADS\fR
When exporting image(s) to an existing WIM: rebuild the entire WIM rather than
appending data to the end of it. Rebuilding the WIM is slower, but will save a
little bit of space that would otherwise be left as a hole in the WIM. Also see
-\fB@IMAGEX_PROGNAME@ optimize\fR.
+\fBwimlib-imagex optimize\fR.
.TP
\fB--ref\fR="\fIGLOB\fR"
File glob of additional WIMs or split WIM parts to reference resources from.
See \fBSPLIT_WIMS\fR. This option can be specified multiple times. Note:
\fIGLOB\fR is listed in quotes because it is interpreted by
-\fB@IMAGEX_PROGNAME@\fR and may need to be quoted to protect against shell
+\fBwimlib-imagex\fR and may need to be quoted to protect against shell
expansion.
.TP
\fB--pipable\fR
Build, or rebuild, \fIDEST_WIMFILE\fR as a "pipable WIM" so that it can be
-applied fully sequentially, including from a pipe. See \fB@IMAGEX_PROGNAME@
+applied fully sequentially, including from a pipe. See \fBwimlib-imagex
capture\fR(1) for more details about creating pipable WIMs. The default without
this option is to make \fIDEST_WIMFILE\fR pipable if and only if it already
existed and was already pipable, or was "-" (standard output).
archive, set the compression type to that recommended for WIMBoot (currently,
XPRESS with 4096 byte chunks).
.SH SPLIT WIMS
-You may use \fB@IMAGEX_PROGNAME@ export\fR to export images from a split WIM.
+You may use \fBwimlib-imagex export\fR to export images from a split WIM.
The \fISRC_WIMFILE\fR argument must specify the first part of the split WIM,
while the additional parts of the split WIM must be specified in one or more
\fB--ref\fR="\fIGLOB\fR" options. Since globbing is built into the \fB--ref\fR
"other.wim", run:
.PP
.RS
-@IMAGEX_PROGNAME@ export mywim.swm 1 other.wim --ref="mywim*.swm"
+wimlib-imagex export mywim.swm 1 other.wim --ref="mywim*.swm"
.RE
.SH NOTES
-\fIData integrity\fR: It is safe to abort a \fB@IMAGEX_PROGNAME@ export\fR command partway through.
-However, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
+\fIData integrity\fR: It is safe to abort a \fBwimlib-imagex export\fR command partway through.
+However, after doing this, it is recommended to run \fBwimlib-imagex
optimize\fR on the destination WIM 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 rebuilt (e.g. with \fB--rebuild\fR), in which case you should
Export the second image of 'boot.wim' to the new WIM file 'new.wim':
.RS
.PP
-@IMAGEX_PROGNAME@ export boot.wim 2 new.wim
+wimlib-imagex export boot.wim 2 new.wim
.RE
.PP
The above example creates "new.wim" with the same compression type as
\fB--compress\fR=\fITYPE\fR; for example:
.RS
.PP
-@IMAGEX_PROGNAME@ export boot.wim 2 new.wim --compress=LZX
+wimlib-imagex export boot.wim 2 new.wim --compress=LZX
.RE
.PP
Export "ESD to WIM" --- that is, solid WIM to non-solid WIM:
.RS
.PP
-@IMAGEX_PROGNAME@ export install.esd all install.wim --compress=LZX
+wimlib-imagex export install.esd all install.wim --compress=LZX
.RE
.PP
Export "WIM to ESD" --- that is, non-solid WIM to solid WIM:
.RS
.PP
-@IMAGEX_PROGNAME@ export install.wim all install.esd --solid
+wimlib-imagex export install.wim all install.esd --solid
.RE
.PP
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
-.BR @IMAGEX_PROGNAME@-info (1)
-.BR @IMAGEX_PROGNAME@-optimize (1)
+.BR wimlib-imagex (1)
+.BR wimlib-imagex-info (1)
+.BR wimlib-imagex-optimize (1)
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-extract \- Extract files or directories from a WIM image
+wimlib-imagex-extract \- Extract files or directories from a WIM image
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ extract\fR \fIWIMFILE\fR \fIIMAGE\fR [(\fIPATH\fR | @\fILISTFILE\fR)...] [\fIOPTION\fR...]
+\fBwimlib-imagex extract\fR \fIWIMFILE\fR \fIIMAGE\fR [(\fIPATH\fR | @\fILISTFILE\fR)...] [\fIOPTION\fR...]
.SH DESCRIPTION
-\fB@IMAGEX_PROGNAME@ extract\fR extracts one or more files or directory trees
+\fBwimlib-imagex extract\fR extracts one or more files or directory trees
from the specified \fIIMAGE\fR contained in the Windows Imaging (WIM) file
\fIWIMFILE\fR.
This command is also available as simply \fBwimextract\fR if the appropriate hard
link or batch file has been installed.
.PP
-\fB@IMAGEX_PROGNAME@ extract\fR is intended for extracting only a subset of a
+\fBwimlib-imagex extract\fR is intended for extracting only a subset of a
WIM image. If you want to extract or "apply" a full WIM image to a directory or
-NTFS volume, use \fB@IMAGEX_PROGNAME@ apply\fR (1) instead.
+NTFS volume, use \fBwimlib-imagex apply\fR (1) instead.
.PP
\fIIMAGE\fR specifies the image in \fIWIMFILE\fR that contains the files or
directory trees to extract. It may be a 1-based index of an image in the WIM or
-the name of an image in the WIM. Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
+the name of an image in the WIM. Use the \fBwimlib-imagex info\fR (1)
command to show what images a WIM file contains.
.PP
If no additional arguments are given, the entire WIM image is extracted.
preserved. Use \fB--preserve-dir-structure\fR to always get the latter
behavior.
.PP
-\fB@IMAGEX_PROGNAME@ extract\fR supports extracting files and directory trees
+\fBwimlib-imagex extract\fR supports extracting files and directory trees
from stand-alone WIMs as well as split WIMs. See \fBSPLIT WIMS\fR.
.SH PATHS AND LISTFILES
Each path, including those on the command line and those in listfiles, must be
specified as an absolute path starting from the root of the WIM image, like
-those output by the \fB@IMAGEX_PROGNAME@ dir\fR (1) command. However, path
+those output by the \fBwimlib-imagex dir\fR (1) command. However, path
separators may be either forward or backward slashes, and the leading slash is
optional.
.PP
UNIX-like systems, by default paths are treated case-sensitively. In either
case, the default behavior may be overridden through the
\fBWIMLIB_IMAGEX_IGNORE_CASE\fR environmental variable, as documented in
-\fB@IMAGEX_PROGNAME@\fR (1).
+\fBwimlib-imagex\fR (1).
.PP
By default, each path may contain the wildcard characters '?' and '*'. The '?'
character matches any non-path-separator character, whereas the '*' character
\\Windows\\notepad*
.SH SPLIT WIMS
-You may use \fB@IMAGEX_PROGNAME@ extract\fR to extract files or directory trees
+You may use \fBwimlib-imagex extract\fR to extract files or directory trees
from a split WIM. This uses the \fB--refs\fR="\fIGLOB\fR" option in the same
-way as in other commands such as \fB@IMAGEX_PROGNAME@ apply\fR. See
-\fB@IMAGEX_PROGNAME@ apply\fR (1) for more details.
+way as in other commands such as \fBwimlib-imagex apply\fR. See
+\fBwimlib-imagex apply\fR (1) for more details.
.SH OPTIONS
.TP 6
\fB--check\fR
\fB--ref\fR="\fIGLOB\fR"
File glob of additional WIMs or split WIM parts to reference resources from.
See \fBSPLIT_WIMS\fR. Note: \fIGLOB\fR is listed in quotes because it is
-interpreted by \fB@IMAGEX_PROGNAME@\fR and may need to be quoted to protect
+interpreted by \fBwimlib-imagex\fR and may need to be quoted to protect
against shell expansion.
.TP
\fB--dest-dir\fR=\fIDIR\fR
extracted.
.TP
\fB--unix-data\fR
-See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
+See the documentation for this option in \fBwimlib-imagex-apply\fR (1).
.TP
\fB--no-acls\fR
-See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
+See the documentation for this option in \fBwimlib-imagex-apply\fR (1).
.TP
\fB--strict-acls\fR
-See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
+See the documentation for this option in \fBwimlib-imagex-apply\fR (1).
.TP
\fB--no-attributes\fR
-See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
+See the documentation for this option in \fBwimlib-imagex-apply\fR (1).
.TP
\fB--include-invalid-names\fR
-See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
+See the documentation for this option in \fBwimlib-imagex-apply\fR (1).
.TP
\fB--no-globs\fR
Do not recognize wildcard characters in paths. Each path will be searched for
command line.
.TP
\fB--wimboot\fR
-See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
+See the documentation for this option in \fBwimlib-imagex-apply\fR (1).
.SH NOTES
-See the documentation \fB@IMAGEX_PROGNAME@ apply\fR (1) for documentation about
+See the documentation \fBwimlib-imagex apply\fR (1) for documentation about
what data and metadata are extracted on UNIX-like systems versus on Windows.
.PP
On UNIX-like systems that support userspace filesystems with FUSE (e.g. Linux),
-one can alternatively mount the WIM image with \fB@IMAGEX_PROGNAME@ mount\fR (1)
+one can alternatively mount the WIM image with \fBwimlib-imagex mount\fR (1)
and then extract the desired files or directories using any standard
command-line or graphical program.
.PP
Reparse-point fixups (a.k.a. changing absolute symbolic links and junctions to
-point within the extraction location) are never done by \fB@IMAGEX_PROGNAME@
-extract\fR. Use \fB@IMAGEX_PROGNAME@ apply\fR if you want this behavior.
+point within the extraction location) are never done by \fBwimlib-imagex
+extract\fR. Use \fBwimlib-imagex apply\fR if you want this behavior.
.PP
-Unlike \fB@IMAGEX_PROGNAME@ apply\fR, \fB@IMAGEX_PROGNAME@ extract\fR does not
+Unlike \fBwimlib-imagex apply\fR, \fBwimlib-imagex extract\fR does not
support extracting files directly to an NTFS volume using libntfs-3g.
.PP
wimlib v1.6.0 and later can extract files from version 3584 WIMs, which usually
Extract a file from the first image in "boot.wim" to the current directory:
.RS
.PP
-@IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe
+wimlib-imagex extract boot.wim 1 /Windows/System32/notepad.exe
.RE
.PP
Extract a file from the first image in "boot.wim" to standard output:
.RS
.PP
-@IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe \\
+wimlib-imagex extract boot.wim 1 /Windows/System32/notepad.exe \\
.br
.RS
--to-stdout
Extract a file from the first image in "boot.wim" to the specified directory:
.RS
.PP
-@IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe \\
+wimlib-imagex extract boot.wim 1 /Windows/System32/notepad.exe \\
.br
.RS
--dest-dir=somedir
current directory:
.RS
.PP
-@IMAGEX_PROGNAME@ extract boot.wim 1 /sources
+wimlib-imagex extract boot.wim 1 /sources
.RE
.PP
Extract multiple files and directories in one command:
.RS
.PP
-@IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/Fonts \\
+wimlib-imagex extract boot.wim 1 /Windows/Fonts \\
.br
.RS
/sources /Windows/System32/cmd.exe
Extract many files to the current directory using a wildcard pattern:
.RS
.PP
-@IMAGEX_PROGNAME@ extract install.wim 1 "/Windows/Fonts/*.ttf"
+wimlib-imagex extract install.wim 1 "/Windows/Fonts/*.ttf"
.RE
.PP
Extract files using a list file:
.RS
.PP
-@IMAGEX_PROGNAME@ extract install.wim 1 @files.txt
+wimlib-imagex extract install.wim 1 @files.txt
.RE
.PP
... where files.txt could be something like:
.RE
.fi
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
-.BR @IMAGEX_PROGNAME@-apply (1)
-.BR @IMAGEX_PROGNAME@-dir (1)
-.BR @IMAGEX_PROGNAME@-info (1)
-.BR @IMAGEX_PROGNAME@-mount (1)
+.BR wimlib-imagex (1)
+.BR wimlib-imagex-apply (1)
+.BR wimlib-imagex-dir (1)
+.BR wimlib-imagex-info (1)
+.BR wimlib-imagex-mount (1)
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-info \- Display information about a WIM file, or change information about
+wimlib-imagex-info \- Display information about a WIM file, or change information about
an image
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ info\fR \fIWIMFILE\fR [\fIIMAGE\fR [\fINEW_NAME\fR
+\fBwimlib-imagex info\fR \fIWIMFILE\fR [\fIIMAGE\fR [\fINEW_NAME\fR
[\fINEW_DESC\fR]]] [\fIOPTION\fR...]
.SH DESCRIPTION
-\fB@IMAGEX_PROGNAME@ info\fR displays information about \fIWIMFILE\fR, and optionally
+\fBwimlib-imagex info\fR displays information about \fIWIMFILE\fR, and optionally
changes which image is bootable, or what the name and description of an image
are.
This command is also available as simply \fBwiminfo\fR if the appropriate hard
while \fINEW_DESC\fR is taken to be its new description. If \fINEW_DESC\fR is
not specified, the image's description is unchanged.
.PP
-\fB@IMAGEX_PROGNAME@ info\fR does not support modifying a split WIM, although you may
+\fBwimlib-imagex info\fR does not support modifying a split WIM, although you may
display information about one.
.SH OPTIONS
.TP 6
Prints the raw XML data from the WIM. Note: the XML data will be encoded using
UTF-16LE, and it will begin with a byte-order mark.
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
-.BR @IMAGEX_PROGNAME@-dir (1)
+.BR wimlib-imagex (1)
+.BR wimlib-imagex-dir (1)
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-join \- Join split WIMs into a standalone one-part WIM
+wimlib-imagex-join \- Join split WIMs into a standalone one-part WIM
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ join\fR [\fIOPTION\fR...] \fIOUT_WIMFILE\fR
+\fBwimlib-imagex join\fR [\fIOPTION\fR...] \fIOUT_WIMFILE\fR
\fISPLIT_WIM_PART\fR...
.SH DESCRIPTION
Joins the \fISPLIT_WIM_PARTs\fR into a standalone one-part WIM \fIOUT_WIMFILE\fR.
All parts of the split WIM must be specified. You probably want to do so using
a shell wildcard.
.PP
-\fB@IMAGEX_PROGNAME@ join\fR can join both non-pipable and pipable split WIMs.
+\fBwimlib-imagex join\fR can join both non-pipable and pipable split WIMs.
.SH OPTIONS
.TP 6
\fB--check\fR
number), and write the joined WIM to the file `windows.wim'.
.RS
.PP
-@IMAGEX_PROGNAME@ join windows.wim windows*.swm
+wimlib-imagex join windows.wim windows*.swm
.RE
.SH NOTES
-\fB@IMAGEX_PROGNAME@ join\fR is roughly equivalent to:
+\fBwimlib-imagex join\fR is roughly equivalent to:
.RS
.PP
-\fB@IMAGEX_PROGNAME@ export\fR \fISWM_PART_1\fR --ref="\fISWM_GLOB\fR" all \fIOUT_WIMFILE\fR
+\fBwimlib-imagex export\fR \fISWM_PART_1\fR --ref="\fISWM_GLOB\fR" all \fIOUT_WIMFILE\fR
.RE
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
-.BR @IMAGEX_PROGNAME@-export (1)
+.BR wimlib-imagex (1)
+.BR wimlib-imagex-export (1)
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-mount, @IMAGEX_PROGNAME@-mountrw, @IMAGEX_PROGNAME@-unmount \- Mount and unmount an image from a WIM archive
+wimlib-imagex-mount, wimlib-imagex-mountrw, wimlib-imagex-unmount \- Mount and unmount an image from a WIM archive
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ mount\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...]
+\fBwimlib-imagex mount\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...]
.br
-\fB@IMAGEX_PROGNAME@ mountrw\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...]
+\fBwimlib-imagex mountrw\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...]
.br
-\fB@IMAGEX_PROGNAME@ unmount\fR \fIDIRECTORY\fR [\fIOPTION\fR...]
+\fBwimlib-imagex unmount\fR \fIDIRECTORY\fR [\fIOPTION\fR...]
.SH DESCRIPTION
-The \fB@IMAGEX_PROGNAME@ mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR commands
+The \fBwimlib-imagex mount\fR and \fBwimlib-imagex mountrw\fR commands
will mount the image in the Windows Imaging (WIM) file \fIWIMFILE\fR specified
by \fIIMAGE\fR on the directory \fIDIRECTORY\fR using FUSE (Filesystem in
-Userspace). \fB@IMAGEX_PROGNAME@ mount\fR will mount the image read-only, while
-\fB@IMAGEX_PROGNAME@ mountrw\fR will mount the image read-write.
+Userspace). \fBwimlib-imagex mount\fR will mount the image read-only, while
+\fBwimlib-imagex mountrw\fR will mount the image read-write.
These commands are also available as simply \fBwimmount\fR, \fBwimmountrw\fR,
and \fBwimunmount\fR if the appropriate hard links or batch files are installed.
.PP
\fIIMAGE\fR may be a 1-based index of the image in the WIM to mount, or it may
-be the name of an image in the WIM. Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
+be the name of an image in the WIM. Use the \fBwimlib-imagex info\fR (1)
command to see the available images in the WIM. \fIIMAGE\fR may be omitted if
\fIWIMFILE\fR contains only one image.
.PP
-The WIM image can be unmounted using the \fB@IMAGEX_PROGNAME@ unmount\fR
+The WIM image can be unmounted using the \fBwimlib-imagex unmount\fR
command. Changes made to a WIM mounted read-write will be discarded unless the
-\fB--commit\fR flag is provided to \fB@IMAGEX_PROGNAME@ unmount\fR.
+\fB--commit\fR flag is provided to \fBwimlib-imagex unmount\fR.
.SH SPLIT WIMS
-You may use \fB@IMAGEX_PROGNAME@ mount\fR to mount an image from a split WIM
+You may use \fBwimlib-imagex mount\fR to mount an image from a split WIM
read-only. However, you may not mount an image from a split WIM read-write.
.PP
The \fIWIMFILE\fR argument must specify the first part of the split WIM, while
To mount the first image of this split WIM to the directory "dir", run:
.PP
.RS
-@IMAGEX_PROGNAME@ mount mywim.swm 1 dir --ref="mywim*.swm"
+wimlib-imagex mount mywim.swm 1 dir --ref="mywim*.swm"
.RE
.PP
.SH NOTES
If wimlib was configured using the \fB--without-fuse\fR flag, then the
-\fB@IMAGEX_PROGNAME@ mount\fR, \fB@IMAGEX_PROGNAME@ mountrw\fR, and
-\fB@IMAGEX_PROGNAME@ unmount\fR commands will not work. Also, these commands
-are not available in the Windows builds of \fB@IMAGEX_PROGNAME@\fR.
+\fBwimlib-imagex mount\fR, \fBwimlib-imagex mountrw\fR, and
+\fBwimlib-imagex unmount\fR commands will not work. Also, these commands
+are not available in the Windows builds of \fBwimlib-imagex\fR.
.PP
You can mount multiple images from a WIM file read-only at the same time, but
you can only mount one image at a time from a WIM read-write.
WIM. This is nice for big WIM files, since the entire file doesn't have to be
rebuilt to make a small change. But, if you are making many changes to a
read-write mounted WIM, especially deleting large files, it is suggested to
-provide the \fB--rebuild\fR option to \fB@IMAGEX_PROGNAME@ unmount\fR to force
-the WIM to be rebuilt, or else run \fB@IMAGEX_PROGNAME@ optimize\fR on the WIM
+provide the \fB--rebuild\fR option to \fBwimlib-imagex unmount\fR to force
+the WIM to be rebuilt, or else run \fBwimlib-imagex optimize\fR on the WIM
afterwards.
.PP
wimlib v1.6.0 and later can mount version 3584 WIMs, which usually contain
File glob of additional WIMs or split WIM parts to reference resources from.
See \fBSPLIT_WIMS\fR. This option can be specified multiple times. Note:
\fIGLOB\fR is listed in quotes because it is interpreted by
-\fB@IMAGEX_PROGNAME@\fR and may need to be quoted to protect against shell
+\fBwimlib-imagex\fR and may need to be quoted to protect against shell
expansion.
.TP
\fB--staging-dir\fR=\fIDIR\fR
Store temporary staging files in a subdirectory of the directory \fIDIR\fR.
-Only valid for \fB@IMAGEX_PROGNAME@ mountrw\fR.
+Only valid for \fBwimlib-imagex mountrw\fR.
.TP
\fB--unix-data\fR
-Honor UNIX-specific metadata that was captured by \fB@IMAGEX_PROGNAME@
-capture\fR with the \fB--unix-data option\fR. By default, \fB@IMAGEX_PROGNAME@
-mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR will ignore both Windows-style
+Honor UNIX-specific metadata that was captured by \fBwimlib-imagex
+capture\fR with the \fB--unix-data option\fR. By default, \fBwimlib-imagex
+mount\fR and \fBwimlib-imagex mountrw\fR will ignore both Windows-style
security descriptors (which may have been set either from Windows or by
-\fB@IMAGEX_PROGNAME@ capture\fR from an NTFS-volume) and UNIX-specific metadata.
+\fBwimlib-imagex capture\fR from an NTFS-volume) and UNIX-specific metadata.
In this default mode, all files will simply be owned by the user running
-\fB@IMAGEX_PROGNAME@\fR and will have mode 0777. (Note: they will still not be
+\fBwimlib-imagex\fR and will have mode 0777. (Note: they will still not be
accessible to other users unless you also specify \fB--allow-other\fR.) If you
instead provide the \fB--unix-data\fR option, these default permissions will be
overridden on a per-file basis with the UNIX-specific data when available, and
-in the case of \fB@IMAGEX_PROGNAME@ mountrw\fR it will be possible to change the
+in the case of \fBwimlib-imagex mountrw\fR it will be possible to change the
UNIX permissions using the standard UNIX tools and functions. In addition, with
wimlib v1.7.0 and later, you can create device nodes, named pipes, and sockets
on the mounted filesystem and have them stored in the WIM image.
modified image to be committed as a new, unnamed image appended to the WIM
archive. The original image will be unmodified.
.SH IMPLEMENTATION DETAILS
-Since a WIM is an archive and not a filesystem, \fB@IMAGEX_PROGNAME@ mountrw\fR
+Since a WIM is an archive and not a filesystem, \fBwimlib-imagex mountrw\fR
creates a temporary staging directory to contain files that are created or
modified. This directory is located in the same directory as \fIWIMFILE\fR by
default, but the location can be set using the \fB--staging-dir\fR option. When
(or rebuilt completely with \fB--rebuild\fR), merging in the staging files as
needed. Then, the temporary staging directory is deleted.
.PP
-\fB@IMAGEX_PROGNAME@ unmount\fR runs in a separate process from the process that
-previously ran \fB@IMAGEX_PROGNAME@ mount\fR. When unmounting a read-write
+\fBwimlib-imagex unmount\fR runs in a separate process from the process that
+previously ran \fBwimlib-imagex mount\fR. When unmounting a read-write
mounted WIM image with \fB--commit\fR, these two processes communicate using a
POSIX message queue so that the unmount process can track the progress of the
mount process. See \fIsrc/mount_image.c\fR in the sources for details.
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
+.BR wimlib-imagex (1)
-.so man1/@IMAGEX_PROGNAME@-mount.1
+.so man1/wimlib-imagex-mount.1
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-optimize \- Optimize a WIM archive
+wimlib-imagex-optimize \- Optimize a WIM archive
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ optimize\fR \fIWIMFILE\fR [\fIOPTION\fR...]
+\fBwimlib-imagex optimize\fR \fIWIMFILE\fR [\fIOPTION\fR...]
.SH DESCRIPTION
-\fB@IMAGEX_PROGNAME@ optimize\fR will rebuild the stand-alone WIM \fIWIMFILE\fR. The new
+\fBwimlib-imagex optimize\fR will rebuild the stand-alone WIM \fIWIMFILE\fR. The new
WIM is written to a temporary file, and it is renamed to the original file when
it's ready. This action will remove any holes that have been left as a result
of appending images, so the new WIM may be slightly smaller than the old WIM.
specified compression level for that compression type. This implies
\fB--recompress\fR.
.IP ""
-See the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
+See the documentation for this option to \fBwimlib-imagex capture\fR (1) for
more details.
.TP
\fB--chunk-size\fR=\fISIZE\fR
Set the WIM compression chunk size to \fISIZE\fR. See the documentation for
-this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
+this option to \fBwimlib-imagex capture\fR (1) for more details.
.TP
\fB--solid\fR
Create a "solid" archive that compresses multiple files together. This can
result in a higher compression ratio, but has disadvantages such as reduced
-compatibility. See the documentation for this option to \fB@IMAGEX_PROGNAME@
+compatibility. See the documentation for this option to \fBwimlib-imagex
capture\fR (1) for more details.
.TP
\fB--solid-chunk-size\fR=\fISIZE\fR
Like \fB--chunk-size\fR, but set the chunk size used in solid blocks. See the
-documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more
+documentation for this option to \fBwimlib-imagex capture\fR (1) for more
details.
.TP
\fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
Like \fB--compress\fR, but set the compression type used in solid blocks. See
-the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
+the documentation for this option to \fBwimlib-imagex capture\fR (1) for
more details.
.TP
\fB--threads\fR=\fINUM_THREADS\fR
.TP
\fB--pipable\fR
Rebuild the WIM so that it can be applied fully sequentially, including from a
-pipe. See \fB@IMAGEX_PROGNAME@ capture\fR(1) for more details about creating
+pipe. See \fBwimlib-imagex capture\fR(1) for more details about creating
pipable WIMs. By default, when neither \fB--pipable\fR or \fB--not-pipable\fR
is specified, the rebuilt WIM will be pipable if and only if it was already
pipable.
Rebuild the WIM in the non-pipable format. (This is the default if
\fIWIMFILE\fR is not pipable.)
.SH NOTES
-\fB@IMAGEX_PROGNAME@ optimize\fR does not support split WIMs.
+\fBwimlib-imagex optimize\fR does not support split WIMs.
.PP
-\fB@IMAGEX_PROGNAME@ optimize\fR is roughly equivalent to:
+\fBwimlib-imagex optimize\fR is roughly equivalent to:
.RS
.PP
-\fB@IMAGEX_PROGNAME@ export\fR \fIWIMFILE\fR all tmp.wim && mv tmp.wim \fIWIMFILE\fR
+\fBwimlib-imagex export\fR \fIWIMFILE\fR all tmp.wim && mv tmp.wim \fIWIMFILE\fR
.RE
.PP
.SH EXAMPLES
.RE
.PP
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
-.BR @IMAGEX_PROGNAME@-export (1)
-.BR @IMAGEX_PROGNAME@-verify (1)
+.BR wimlib-imagex (1)
+.BR wimlib-imagex-export (1)
+.BR wimlib-imagex-verify (1)
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-split \- Split a WIM into multiple parts
+wimlib-imagex-split \- Split a WIM into multiple parts
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ split\fR \fIWIMFILE\fR \fISPLIT_WIM_PART_1\fR \fIPART_SIZE\fR [\fIOPTION...\fR]
+\fBwimlib-imagex split\fR \fIWIMFILE\fR \fISPLIT_WIM_PART_1\fR \fIPART_SIZE\fR [\fIOPTION...\fR]
.SH DESCRIPTION
Splits \fIWIMFILE\fR into parts with size at most \fIPART_SIZE\fR mebibytes,
with the first part having the name \fISPLIT_WIM_PART_1\fR and the other parts
This command is also available as simply \fBwimsplit\fR if the appropriate
hard link or batch file has been installed.
.PP
-\fB@IMAGEX_PROGNAME@ split\fR can split both non-pipable and pipable WIMs.
+\fBwimlib-imagex split\fR can split both non-pipable and pipable WIMs.
.SH OPTIONS
.TP 6
\fB--check\fR
etc. where each part is at most 100 MiB:
.RS
.PP
-@IMAGEX_PROGNAME@ split windows.wim windows.swm 100
+wimlib-imagex split windows.wim windows.swm 100
.RE
.SH LIMITATIONS
It is possible for the size of the parts to exceed the \fIPART_SIZE\fR given.
least one part that is 100 MiB in size to contain that file. However, if the
WIM resources are compressed then less space would be needed.
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
+.BR wimlib-imagex (1)
-.so man1/@IMAGEX_PROGNAME@-mount.1
+.so man1/wimlib-imagex-mount.1
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-update \- Update a WIM image
+wimlib-imagex-update \- Update a WIM image
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ update\fR \fIWIMFILE\fR [\fIIMAGE\fR] [\fIOPTION\fR...] [< \fICMDFILE\fR]
+\fBwimlib-imagex update\fR \fIWIMFILE\fR [\fIIMAGE\fR] [\fIOPTION\fR...] [< \fICMDFILE\fR]
.SH DESCRIPTION
-\fB@IMAGEX_PROGNAME@ update\fR modifies the specified \fIIMAGE\fR in the Windows
+\fBwimlib-imagex update\fR modifies the specified \fIIMAGE\fR in the Windows
Imaging (WIM) file \fIWIMFILE\fR by adding, deleting, or renaming files or
directories in it.
This command is also available as simply \fBwimupdate\fR if the appropriate
.PP
\fIIMAGE\fR specifies the image in \fIWIMFILE\fR to update. It may be a 1-based
index of an image in the WIM or the name of an image in the WIM. Use the
-\fB@IMAGEX_PROGNAME@ info\fR (1) command to list the images a WIM file contains.
+\fBwimlib-imagex info\fR (1) command to list the images a WIM file contains.
\fIIMAGE\fR may be omitted if \fIWIMFILE\fR contains only one image.
.PP
The modifications to perform on the WIM image are specified as a sequence of
directories are created as needed to add the \fISOURCE\fR at that location.
.PP
The \fBadd\fR command supports a subset of the options accepted by
-\fB@IMAGEX_PROGNAME@ capture\fR; namely, \fB--dereference\fR,
+\fBwimlib-imagex capture\fR; namely, \fB--dereference\fR,
\fB--unix-data\fR, \fB--no-acls\fR, and \fB--strict-acls\fR. See
-\fB@IMAGEX_PROGNAME@-capture\fR (1) for explanations of these options.
+\fBwimlib-imagex-capture\fR (1) for explanations of these options.
.PP
In addition, the \fBadd\fR command supports the \fB--no-replace\fR option, which
causes the \fBadd\fR command to refuse to overwrite existing nondirectory files
.PP
There are no options available for the \fBrename\fR command.
.SH OPTIONS
-The following options are accepted on the command line by \fB@IMAGEX_PROGNAME@
+The following options are accepted on the command line by \fBwimlib-imagex
update\fR itself:
.TP 6
\fB--dereference\fR
.TP
\fB--config\fR=\fIFILE\fR
Set the capture configuration file for all \fBadd\fR commands. See the
-description of this option in \fB@IMAGEX_PROGNAME@-capture\fR (1).
+description of this option in \fBwimlib-imagex-capture\fR (1).
.TP
\fB--force\fR
Use \fB--force\fR for all \fBdelete\fR commands.
Rebuilding the WIM is slower, but will save a little bit of space that would
otherwise be left as a hole in the WIM file.
.IP
-See \fB@IMAGEX_PROGNAME@-optimize\fR (1) for a more customizable way of
+See \fBwimlib-imagex-optimize\fR (1) for a more customizable way of
rebuilding (and optionally recompressing) a WIM file. If running
-\fB@IMAGEX_PROGNAME@ optimize\fR after \fB@IMAGEX_PROGNAME@ update\fR, there is
-no need to specify \fB--rebuild\fR to \fB@IMAGEX_PROGNAME@ update\fR.
+\fBwimlib-imagex optimize\fR after \fBwimlib-imagex update\fR, there is
+no need to specify \fB--rebuild\fR to \fBwimlib-imagex update\fR.
.TP
\fB--command\fR=\fISTRING\fR
Instead of reading update commands from standard input, read a single update
.RS
.PP
.nf
-@IMAGEX_PROGNAME@ update boot.wim 1 \\
+wimlib-imagex update boot.wim 1 \\
.br
.RS
--command="add 'C:\\My Dir' '\\My Dir'"
.fi
.IP
This option is provided for convenience only. Do not execute
-\fB@IMAGEX_PROGNAME@ update\fR multiple consecutive times, each time passing the
+\fBwimlib-imagex update\fR multiple consecutive times, each time passing the
\fB--command\fR option! This is inefficient. Instead, generate an update
command file and provide it (on standard input) to a single invocation of
-\fB@IMAGEX_PROGNAME@ update\fR, as explained in this document.
+\fBwimlib-imagex update\fR, as explained in this document.
.TP
\fB--wimboot-config\fR=\fIFILE\fR
If this option is specified, no commands shall be read from standard input, and
[PrepopulateList] section of this file specifies path globs that shall not be
extracted as WIMBoot pointer files (perhaps due to being needed early in the
boot process). See the documentation for the \fB--wimboot\fR option of
-\fB@IMAGEX_PROGNAME@ apply\fR (1) for more information.
+\fBwimlib-imagex apply\fR (1) for more information.
.SH NOTES
-\fB@IMAGEX_PROGNAME@ update\fR is partly redundant with \fB@IMAGEX_PROGNAME@
+\fBwimlib-imagex update\fR is partly redundant with \fBwimlib-imagex
mountrw\fR, since if a WIM image can be mounted read-write, then there
-theoretically is no need for \fB@IMAGEX_PROGNAME@ update\fR. The main advantage
-of \fB@IMAGEX_PROGNAME@ update\fR is that it works on both UNIX-like systems and
-Windows, whereas \fB@IMAGEX_PROGNAME@ mountrw\fR is only available on UNIX-like
+theoretically is no need for \fBwimlib-imagex update\fR. The main advantage
+of \fBwimlib-imagex update\fR is that it works on both UNIX-like systems and
+Windows, whereas \fBwimlib-imagex mountrw\fR is only available on UNIX-like
systems, and even then it only works on those with a compatible FUSE
implementation.
.PP
be changed by setting the \fBWIMLIB_IMAGEX_IGNORE_CASE\fR environmental
variable to 0 or 1.
.PP
-The command file (\fICMDFILE\fR) is parsed by \fB@IMAGEX_PROGNAME@ update\fR
+The command file (\fICMDFILE\fR) is parsed by \fBwimlib-imagex update\fR
itself and not by the system shell. Therefore, its syntax is limited. However,
comment lines beginning with '#' are allowed, and it is also possible to quote
arguments with whitespace inside them.
.PP
-On UNIX-like systems, you cannot use \fB@IMAGEX_PROGNAME@ update\fR to add files
+On UNIX-like systems, you cannot use \fBwimlib-imagex update\fR to add files
to an image directly from an NTFS volume using libntfs-3g, even though
-\fB@IMAGEX_PROGNAME@ capture\fR supports capturing a full image this way.
+\fBwimlib-imagex capture\fR supports capturing a full image this way.
.PP
-It is safe to abort an \fB@IMAGEX_PROGNAME@ update\fR command partway through;
-however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
+It is safe to abort an \fBwimlib-imagex update\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 \fB--rebuild\fR was
specified, in which case you should delete the temporary file left over.
.SH EXAMPLES
All the examples below show the update command file to be created as well as the
-\fB@IMAGEX_PROGNAME@ update\fR command to run to perform the updates.
+\fBwimlib-imagex update\fR command to run to perform the updates.
.PP
Delete two files from a WIM image:
.PP
.RE
.PP
.RS
-$ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
+$ wimlib-imagex update boot.wim 2 < update_commands.txt
.RE
.PP
Add some files and directories to a WIM image. Note that the first path of each
.RE
.PP
.RS
-$ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
+$ wimlib-imagex update boot.wim 2 < update_commands.txt
.RE
.PP
Rename a file inside a WIM image.
.RE
.PP
.RS
-$ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
+$ wimlib-imagex update boot.wim 2 < update_commands.txt
.RE
.PP
Using additional features, such as comments, options, and overlays, and
.RE
.PP
.RS
-$ @IMAGEX_PROGNAME@ update boot.wim 2 --check < update_commands.txt
+$ wimlib-imagex update boot.wim 2 --check < update_commands.txt
.RE
.PP
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
-.BR @IMAGEX_PROGNAME@-capture (1)
-.BR @IMAGEX_PROGNAME@-info (1)
-.BR @IMAGEX_PROGNAME@-mountrw (1)
-.BR @IMAGEX_PROGNAME@-optimize (1)
+.BR wimlib-imagex (1)
+.BR wimlib-imagex-capture (1)
+.BR wimlib-imagex-info (1)
+.BR wimlib-imagex-mountrw (1)
+.BR wimlib-imagex-optimize (1)
-.TH WIMLIB-IMAGEX "1" "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@-verify \- Verify a WIM file
+wimlib-imagex-verify \- Verify a WIM file
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ verify\fR \fIWIMFILE\fR [\fIOPTION\fR...]
+\fBwimlib-imagex verify\fR \fIWIMFILE\fR [\fIOPTION\fR...]
.SH DESCRIPTION
-\fB@IMAGEX_PROGNAME@ verify\fR checks the validity of the specified WIM archive.
+\fBwimlib-imagex verify\fR checks the validity of the specified WIM archive.
This command is also available as simply \fBwimverify\fR if the appropriate hard
link or batch file has been installed.
.PP
\fB--ref\fR="\fIGLOB\fR"
File glob of additional WIMs or split WIM parts to reference resources from.
This option can be specified multiple times. Note: \fIGLOB\fR is listed in
-quotes because it is interpreted by \fB@IMAGEX_PROGNAME@\fR and may need to be
+quotes because it is interpreted by \fBwimlib-imagex\fR and may need to be
quoted to protect against shell expansion.
.TP
\fB--nocheck\fR
.RE
.PP
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
-.BR @IMAGEX_PROGNAME@-optimize (1)
+.BR wimlib-imagex (1)
+.BR wimlib-imagex-optimize (1)
-.TH WIMLIB-IMAGEX 1 "November 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX 1 "November 2014" "wimlib-imagex @VERSION@" "User Commands"
.SH NAME
-@IMAGEX_PROGNAME@ \- Extract, create, modify, or mount a WIM (Windows Imaging Format) archive
+wimlib-imagex \- Extract, create, modify, or mount a WIM (Windows Imaging Format) archive
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ append\fR \fIarguments...\fR
+\fBwimlib-imagex append\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ apply\fR \fIarguments...\fR
+\fBwimlib-imagex apply\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ capture\fR \fIarguments...\fR
+\fBwimlib-imagex capture\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ delete\fR \fIarguments...\fR
+\fBwimlib-imagex delete\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ dir\fR \fIarguments...\fR
+\fBwimlib-imagex dir\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ export\fR \fIarguments...\fR
+\fBwimlib-imagex export\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ extract\fR \fIarguments...\fR
+\fBwimlib-imagex extract\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ info\fR \fIarguments...\fR
+\fBwimlib-imagex info\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ join\fR \fIarguments...\fR
+\fBwimlib-imagex join\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ mount\fR \fIarguments...\fR
+\fBwimlib-imagex mount\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ mountrw\fR \fIarguments...\fR
+\fBwimlib-imagex mountrw\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ optimize\fR \fIarguments...\fR
+\fBwimlib-imagex optimize\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ split\fR \fIarguments...\fR
+\fBwimlib-imagex split\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ unmount\fR \fIarguments...\fR
+\fBwimlib-imagex unmount\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ update\fR \fIarguments...\fR
+\fBwimlib-imagex update\fR \fIarguments...\fR
.br
-\fB@IMAGEX_PROGNAME@ verify\fR \fIarguments...\fR
+\fBwimlib-imagex verify\fR \fIarguments...\fR
.SH DESCRIPTION
-\fB@IMAGEX_PROGNAME@\fR deals with archives in the Windows Imaging Format (WIM).
-Its interface is similar to Microsoft's ImageX, but \fB@IMAGEX_PROGNAME@\fR is
+\fBwimlib-imagex\fR deals with archives in the Windows Imaging Format (WIM).
+Its interface is similar to Microsoft's ImageX, but \fBwimlib-imagex\fR is
cross-platform and has useful improvements and extensions.
.PP
-To do its work, \fB@IMAGEX_PROGNAME@\fR uses \fBwimlib\fR, an open source C
+To do its work, \fBwimlib-imagex\fR uses \fBwimlib\fR, an open source C
library that provides interfaces for manipulating WIM archives. wimlib is
completely independent from the equivalent Microsoft implementation (WIMGAPI, or
wimgapi.dll). You can use wimlib in your own programs, although for
-command-line use \fB@IMAGEX_PROGNAME@\fR already provides access to most of
+command-line use \fBwimlib-imagex\fR already provides access to most of
wimlib's functionality.
.SH BACKGROUND INFORMATION
The Windows Imaging Format (WIM) was designed by Microsoft primarily for
.PP
An update of the WIM format released with Windows 8 features solid compression
using the LZMS compression algorithm. Such files are also called "ESD files"
-and may carry the extension \.esd instead of .wim. \fB@IMAGEX_PROGNAME@\fR
+and may carry the extension \.esd instead of .wim. \fBwimlib-imagex\fR
v1.6.0 and later supports these new files, unless they are encrypted.
.SH COMMANDS
-\fB@IMAGEX_PROGNAME@\fR accepts one of a number of commands (listed above in
+\fBwimlib-imagex\fR accepts one of a number of commands (listed above in
\fBSYNOPSYS\fR), and additional arguments depending on the specific command.
-Although \fB@IMAGEX_PROGNAME@\fR will print usage information with \fB--help\fR
+Although \fBwimlib-imagex\fR will print usage information with \fB--help\fR
or if you invoke it incorrectly, the full documentation for each
-\fB@IMAGEX_PROGNAME@\fR command can be found in the appropriate manual page.
+\fBwimlib-imagex\fR command can be found in the appropriate manual page.
.PP
Note: to save typing, if appropriate hard links or batch files have been
-installed, a command \fB@IMAGEX_PROGNAME@ \fICOMMAND\fR can also be accessed as
-simply \fBwim\fICOMMAND\fR; for example, \fBwimapply\fR for \fB@IMAGEX_PROGNAME@
+installed, a command \fBwimlib-imagex \fICOMMAND\fR can also be accessed as
+simply \fBwim\fICOMMAND\fR; for example, \fBwimapply\fR for \fBwimlib-imagex
apply\fR.
.SH GENERAL FEATURES
The following are some of the general features, or use cases, currently
-supported by \fB@IMAGEX_PROGNAME@\fR, and pointers to the relevant commands:
+supported by \fBwimlib-imagex\fR, and pointers to the relevant commands:
.IP \[bu] 4
Display information about a WIM file
- (\fB@IMAGEX_PROGNAME@ info\fR)
+ (\fBwimlib-imagex info\fR)
.IP \[bu]
List the files in a WIM image
- (\fB@IMAGEX_PROGNAME@ dir\fR)
+ (\fBwimlib-imagex dir\fR)
.IP \[bu]
Extract, or "apply", a full WIM image
- (\fB@IMAGEX_PROGNAME@ apply\fR)
+ (\fBwimlib-imagex apply\fR)
.IP \[bu]
Extract files or directories from a WIM image
- (\fB@IMAGEX_PROGNAME@ extract\fR)
+ (\fBwimlib-imagex extract\fR)
.IP \[bu] 4
Capture a WIM image and save it to a new WIM file
- (\fB@IMAGEX_PROGNAME@ capture\fR)
+ (\fBwimlib-imagex capture\fR)
.IP \[bu]
Capture a WIM image and append it to an existing WIM file
- (\fB@IMAGEX_PROGNAME@ append\fR)
+ (\fBwimlib-imagex append\fR)
.IP \[bu]
Modify a WIM image by adding, deleting, or renaming files
- (\fB@IMAGEX_PROGNAME@ update\fR)
+ (\fBwimlib-imagex update\fR)
.IP \[bu]
(Linux only) Mount a WIM image read-only
- (\fB@IMAGEX_PROGNAME@ mount\fR)
+ (\fBwimlib-imagex mount\fR)
.IP \[bu]
(Linux only) Mount a WIM image read-write
- (\fB@IMAGEX_PROGNAME@ mountrw\fR)
+ (\fBwimlib-imagex mountrw\fR)
.IP \[bu]
Delete an image from a WIM file
- (\fB@IMAGEX_PROGNAME@ delete\fR)
+ (\fBwimlib-imagex delete\fR)
.IP \[bu]
Export image(s) from a WIM file
- (\fB@IMAGEX_PROGNAME@ export\fR)
+ (\fBwimlib-imagex export\fR)
.IP \[bu]
Change the name or description of a WIM image
- (\fB@IMAGEX_PROGNAME@ info\fR)
+ (\fBwimlib-imagex info\fR)
.IP \[bu]
Change the bootable image index of a WIM file
- (\fB@IMAGEX_PROGNAME@ info\fR)
+ (\fBwimlib-imagex info\fR)
.IP \[bu]
Rebuild, and optionally recompress, a WIM file
- (\fB@IMAGEX_PROGNAME@ optimize\fR)
+ (\fBwimlib-imagex optimize\fR)
.IP \[bu]
Split a WIM file into multiple parts
- (\fB@IMAGEX_PROGNAME@ split\fR)
+ (\fBwimlib-imagex split\fR)
.IP \[bu]
Join a split WIM
- (\fB@IMAGEX_PROGNAME@ join\fR)
+ (\fBwimlib-imagex join\fR)
.IP \[bu]
Verify a WIM file
- (\fB@IMAGEX_PROGNAME@ verify\fR)
+ (\fBwimlib-imagex verify\fR)
.SH DETAILED FEATURES
This section presents some of the interesting features of
-\fB@IMAGEX_PROGNAME@\fR in more detail.
+\fBwimlib-imagex\fR in more detail.
.IP \[bu] 4
-Multi-platform support. \fB@IMAGEX_PROGNAME@\fR is supported on both UNIX-like
+Multi-platform support. \fBwimlib-imagex\fR is supported on both UNIX-like
systems (mainly Linux, but also FreeBSD, Mac OS X, etc.) and Windows, and most
code is shared among all platforms. However, platform-specific features are
supported when possible.
streams, which is otherwise only supported on Windows. This feature is
unavailable if wimlib was configured using --without-ntfs-3g.
.IP \[bu]
-Long path support on Windows. \fB@IMAGEX_PROGNAME@\fR can capture and apply
+Long path support on Windows. \fBwimlib-imagex\fR can capture and apply
files with paths exceeding the MAX_PATH (260 character) limitation of the Win32
subsystem.
.IP \[bu]
-Non-Administrator support on Windows. You can run \fB@IMAGEX_PROGNAME@\fR
+Non-Administrator support on Windows. You can run \fBwimlib-imagex\fR
without Administrator rights, subject to some limitations.
.IP \[bu]
Support for WIM integrity tables. An integrity table is a list of SHA-1 message
digests appended to the end of a WIM file which gives checksums over the WIM
-file itself. The \fB--check\fR option to several \fB@IMAGEX_PROGNAME@\fR
+file itself. The \fB--check\fR option to several \fBwimlib-imagex\fR
commands can be used to verify or add integrity tables.
.IP \[bu]
Support for "pipable" WIMs. This is a wimlib extension and is not compatible
with the Microsoft implementation. A pipable WIM, created with
-\fB@IMAGEX_PROGNAME@ capture\fR with the \fB--pipable\fR option, can be written
+\fBwimlib-imagex capture\fR with the \fB--pipable\fR option, can be written
to standard output or read from standard input. This can be used to pipe images
to or from a server over the network to implement fast filesystem imaging and
restore.
work but is untested.
.IP \[bu]
Split WIMs. A split WIM is a WIM archive split into multiple parts.
-\fB@IMAGEX_PROGNAME@ split\fR can create a split WIM from a standalone WIM, and
-\fB@IMAGEX_PROGNAME@ join\fR can create a standalone WIM from a split WIM.
+\fBwimlib-imagex split\fR can create a split WIM from a standalone WIM, and
+\fBwimlib-imagex join\fR can create a standalone WIM from a split WIM.
.IP \[bu]
Delta WIMs. A delta WIM contains image metadata but excludes file data already
present in another WIM file. A delta WIM can be created using
-\fB@IMAGEX_PROGNAME@ capture\fR with the \fB--delta-from\fR option.
+\fBwimlib-imagex capture\fR with the \fB--delta-from\fR option.
.IP \[bu]
WIMBoot support. On Windows 8.1 and later, files on an NTFS volume can be
externally backed by a WIM archive with the help of Microsoft's Windows Overlay
FileSystem Filter Driver (WOF). With the \fB--wimboot\fR flag,
-\fB@IMAGEX_PROGNAME@ apply\fR will extract "pointer files" (actually NTFS
+\fBwimlib-imagex apply\fR will extract "pointer files" (actually NTFS
reparse points handled by the WOF driver) to the WIM archive rather than the
files themselves.
.IP \[bu]
Fast incremental backups. Using the \fB--update-of\fR option of
-\fB@IMAGEX_PROGNAME@ capture\fR or \fB@IMAGEX_PROGNAME@ append\fR, you can
+\fBwimlib-imagex capture\fR or \fBwimlib-imagex append\fR, you can
optimize an image capture so that files that are unmodified based on timestamps
are not be read from disk. But even without this option, since the WIM format
features single-instance files, a file identical to any already present in the
On UNIX-like systems, wimlib works primarily in the locale-dependent multibyte
encoding, which you are strongly recommended to set to UTF-8 to avoid any
problems. You can alternatively set the environmental variable
-\fBWIMLIB_IMAGEX_USE_UTF8\fR to force \fB@IMAGEX_PROGNAME@\fR to use UTF-8
+\fBWIMLIB_IMAGEX_USE_UTF8\fR to force \fBwimlib-imagex\fR to use UTF-8
internally, even if the current locale is not UTF-8 compatible.
.SH CASE SENSITIVITY
-By default, the case sensitivity of \fB@IMAGEX_PROGNAME@\fR differs somewhat
+By default, the case sensitivity of \fBwimlib-imagex\fR differs somewhat
between UNIX-like systems and Windows. WIM images may (but usually do not) have
multiple files with the same case-insensitive name. Internally, wimlib
stores filenames as case-sensitive, but on Windows paths
chosen; otherwise, one of the case-insensitively matching file or directories is
chosen arbitrarily.
.PP
-The default case sensitivity of \fB@IMAGEX_PROGNAME@\fR can be overridden by
+The default case sensitivity of \fBwimlib-imagex\fR can be overridden by
explicitly setting the environmental variable \fBWIMLIB_IMAGEX_IGNORE_CASE\fR to
1, in which case such paths will be treated case insensitively, or 0, in which
such paths will be treated case sensitively.
Regardless of these settings, options and non-path arguments must be specified
in lower case.
.SH LICENSE
-@IMAGEX_PROGNAME@ is provided to you under the GNU General Public License
+wimlib-imagex is provided to you under the GNU General Public License
version 3. Be aware this means this software is provided as-is and has no
warranty.
.SH REPORTING BUGS
Report bugs to ebiggers3@gmail.com. Feedback and suggestions are also welcome.
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@-append (1),
-.BR @IMAGEX_PROGNAME@-apply (1),
-.BR @IMAGEX_PROGNAME@-capture (1),
-.BR @IMAGEX_PROGNAME@-delete (1),
-.BR @IMAGEX_PROGNAME@-dir (1),
-.BR @IMAGEX_PROGNAME@-export (1),
-.BR @IMAGEX_PROGNAME@-extract (1),
-.BR @IMAGEX_PROGNAME@-info (1),
-.BR @IMAGEX_PROGNAME@-join (1),
-.BR @IMAGEX_PROGNAME@-mount (1),
-.BR @IMAGEX_PROGNAME@-mountrw (1),
-.BR @IMAGEX_PROGNAME@-optimize (1),
-.BR @IMAGEX_PROGNAME@-split (1),
-.BR @IMAGEX_PROGNAME@-unmount (1),
-.BR @IMAGEX_PROGNAME@-update (1),
-.BR @IMAGEX_PROGNAME@-verify (1),
+.BR wimlib-imagex-append (1),
+.BR wimlib-imagex-apply (1),
+.BR wimlib-imagex-capture (1),
+.BR wimlib-imagex-delete (1),
+.BR wimlib-imagex-dir (1),
+.BR wimlib-imagex-export (1),
+.BR wimlib-imagex-extract (1),
+.BR wimlib-imagex-info (1),
+.BR wimlib-imagex-join (1),
+.BR wimlib-imagex-mount (1),
+.BR wimlib-imagex-mountrw (1),
+.BR wimlib-imagex-optimize (1),
+.BR wimlib-imagex-split (1),
+.BR wimlib-imagex-unmount (1),
+.BR wimlib-imagex-update (1),
+.BR wimlib-imagex-verify (1),
specify such a file. You may also add arbitrary files to \fIboot.wim\fR by
putting them in a directory, then specifying the \fB--overlay\fR \fIDIR\fR
option. However, for more extensive modifications, consider modifying the
-\fIboot.wim\fR file separately using \fB@IMAGEX_PROGNAME@ mountrw\fR or
-\fB@IMAGEX_PROGNAME@ update\fR, then providing it to \fBmkwinpeimg\fR using the
+\fIboot.wim\fR file separately using \fBwimlib-imagex mountrw\fR or
+\fBwimlib-imagex update\fR, then providing it to \fBmkwinpeimg\fR using the
\fB--wim\fR option.
.PP
\fBmkwinpeimg\fR can also make only a modified \fIboot.wim\fR, rather than a
.SH REPORTING BUGS
Report bugs to ebiggers3@gmail.com.
.SH SEE ALSO
-.BR @IMAGEX_PROGNAME@ (1)
+.BR wimlib-imagex (1)
{
static tchar buf[50];
if (cmd == CMD_NONE) {
- tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
+ return T("wimlib-imagex");
} else if (invocation_cmd != CMD_NONE) {
tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
} else {
{
static const tchar *s =
T(
-IMAGEX_PROGNAME " (distributed with " PACKAGE " " PACKAGE_VERSION ")\n"
+"wimlib-imagex (distributed with " PACKAGE " " PACKAGE_VERSION ")\n"
"Copyright (C) 2012, 2013, 2014 Eric Biggers\n"
"License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
"This is free software: you are free to change and redistribute it.\n"
/* Allow being invoked as wimCOMMAND (e.g. wimapply). */
cmd = CMD_NONE;
if (!tstrncmp(invocation_name, T("wim"), 3) &&
- tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
+ tstrcmp(invocation_name, T("wimlib-imagex"))) {
for (int i = 0; i < CMD_MAX; i++) {
if (!tstrcmp(invocation_name + 3,
imagex_commands[i].name))
script_name="$(basename "$0")"
PREFIX_REG="::"
WIMLIB_VERSION=@VERSION@
-imagex=@IMAGEX_PROGNAME@
calc_columns () {
STAT_COL=80
check_needed_programs() {
if [ -z "$waik_dir" -o -n "$modify_wim" ]; then
- if ! type -P "$imagex" &> /dev/null ; then
+ if ! type -P wimlib-imagex &> /dev/null ; then
cat 1>&2 << EOF
-ERROR: To make a customized image of Windows PE, we need the "$imagex" program
-from "wimlib" so that we can modify the boot.wim file. However, "$imagex"
+ERROR: To make a customized image of Windows PE, we need the wimlib-imagex program
+from "wimlib" so that we can modify the boot.wim file. However, wimlib-imagex
doesn't seem to be installed. Please install "wimlib" to continue.
EOF
exit 1
remove_setup=yes
wim="$windows_dir/sources/boot.wim"
stat_busy "Exporting image from \"$wim\""
- "$imagex" export "$windows_dir"/sources/boot.wim 2 \
+ wimlib-imagex export "$windows_dir"/sources/boot.wim 2 \
--boot "$boot_wim" || stat_fail
stat_done
fi
exec 3>&-
stat_busy "Rebuilding WIM with changes made"
- "$imagex" update "$boot_wim" --rebuild \
+ wimlib-imagex update "$boot_wim" --rebuild \
< "$tmp_dir/__mkwinpeimg.update.cmds" > /dev/null || stat_fail
stat_done
}
msg "Testing extracting file from WIM image to stdout"
rm -rf out.dir && mkdir out.dir
-../../imagex extract test.wim 1 /file --to-stdout > out.dir/file
+imagex_raw extract test.wim 1 /file --to-stdout > out.dir/file
../tree-cmp file out.dir/file && [ ! -e out.dir/1 ]
msg "Testing adding directories and files to WIM image"
{
echo "imagex $@"
if [[ $1 == info || $1 == mountrw ]]; then
- ../../imagex "$@"
+ ../../wimlib-imagex "$@"
else
- ../../imagex "$@" > /dev/null
+ ../../wimlib-imagex "$@" > /dev/null
fi
}
imagex_raw()
{
- ../../imagex "$@"
+ ../../wimlib-imagex "$@"
}
wim_ctype()
git://wimlib.net / wimlib / commitdiff