b1c6fc421d273a408b4725800933ee3f01325451
[wimlib] / doc / imagex-mount.1.in
1 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
2 .SH NAME
3 @IMAGEX_PROGNAME@-mount, @IMAGEX_PROGNAME@-mountrw, @IMAGEX_PROGNAME@-unmount \- Mount and unmount an image from a WIM archive
4 .SH SYNOPSIS
5 \fB@IMAGEX_PROGNAME@ mount\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...]
6 .br
7 \fB@IMAGEX_PROGNAME@ mountrw\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...]
8 .br
9 \fB@IMAGEX_PROGNAME@ unmount\fR \fIDIRECTORY\fR [--commit] [--check] [--rebuild]
10 .SH DESCRIPTION
11 The \fB@IMAGEX_PROGNAME@ mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR commands
12 will mount the image in the Windows Imaging (WIM) file \fIWIMFILE\fR specified
13 by \fIIMAGE\fR on the directory \fIDIRECTORY\fR using FUSE (Filesystem in
14 Userspace).  \fB@IMAGEX_PROGNAME@ mount\fR will mount the image read-only, while
15 \fB@IMAGEX_PROGNAME@ mountrw\fR will mount the image read-write.
16 .PP
17 \fIIMAGE\fR may be a 1-based index of the image in the WIM to mount, or it may
18 be the name of an image in the WIM.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
19 command to see the available images in the WIM.  \fIIMAGE\fR may be omitted if
20 \fIWIMFILE\fR contains only one image.
21 .PP
22 The WIM image can be unmounted using the \fB@IMAGEX_PROGNAME@ unmount\fR command.  Changes
23 made to a WIM mounted read-write will be discarded unless the \fB--commit\fR
24 flag is provided to \fB@IMAGEX_PROGNAME@ unmount\fR.
25 .SH SPLIT WIMS
26 You may use \fB@IMAGEX_PROGNAME@ mount\fR to mount an image from a split WIM read-only.
27 However, you may not mount an image from a split WIM read-write.
28 .PP
29 The \fIWIMFILE\fR argument is used to specify the first part of the split WIM, and
30 the \fB--refs\fR="\fIGLOB\fR" option is used to provide a shell-style file glob
31 that specifies the additional parts of the split WIM.  \fIGLOB\fR is expected to
32 be a single string on the command line, so \fIGLOB\fR must be quoted so that it
33 is protected against shell expansion.  \fIGLOB\fR must expand to all parts of
34 the split WIM, except optionally the first part which may either omitted or
35 included in the glob (but the first part MUST be specified as \fIWIMFILE\fR as
36 well).
37 .PP
38 Here's an example.  The names for the split WIMs usually go something like:
39 .RS
40 .PP
41 .nf
42 mywim.swm
43 mywim2.swm
44 mywim3.swm
45 mywim4.swm
46 mywim5.swm
47 .RE
48 .PP
49 To mount the first image of this split WIM to the directory "dir", we would do:
50 .PP
51 .RS
52 @IMAGEX_PROGNAME@ mount mywim.swm 1 dir --ref="mywim*.swm"
53 .RE
54 .PP
55 .SH NOTES
56 If wimlib was configured using the \fB--without-fuse\fR flag, then the
57 \fB@IMAGEX_PROGNAME@ mount\fR, \fB@IMAGEX_PROGNAME@ mountrw\fR, and
58 \fB@IMAGEX_PROGNAME@ unmount\fR commands will not work.  Also, these commands
59 are not available in the Windows builds of wimlib.
60 .PP
61 You can mount multiple images from a WIM file read-only at the same time, but
62 you can only mount one image at a time from a WIM read-write.
63 .PP
64 All files in the mounted WIM will be accessible regardless of whether there is a
65 security descriptor in the WIM associated with the file or not.  New files or
66 directories created in a read-write mounted WIM will be created with no security
67 descriptor.  Although there is support for accessing named data streams (see the
68 \fB--streams-interface\fR option), it is currently not possible
69 to set or get DOS names, file attributes, or security
70 descriptors in a mounted WIM.
71 .PP
72 By default, changes to a read-write WIM are made in-place by appending to the
73 WIM.  This is nice for big WIM files, since the entire file doesn't have to be
74 rebuilt to make a small change.  But, if you are making many changes to a
75 read-write mounted WIM, especially deleting large files, it is suggested to
76 provide the \fB--rebuild\fR option to \fB@IMAGEX_PROGNAME@ unmount\fR to force the WIM to
77 be rebuilt, or else run \fB@IMAGEX_PROGNAME@ optimize\fR on the WIM afterwards.
78 .SH MOUNT OPTIONS
79 .TP 6
80 \fB--check\fR
81 When reading the WIM, verify its integrity if it contains an integrity table.
82 .TP
83 \fB--streams-interface\fR=\fIINTERFACE\fR
84 This option is inspired by the ntfs-3g filesystem driver (see \fBntfs-3g\fR
85 (8)).  It controls how alternate data streams, or named data streams, in WIM
86 files are made available.
87 .IP ""
88 If "none", it will be impossible to read or write the named data streams.
89 .IP ""
90 If "xattr" (default), named data streams will be accessible through extended
91 file attributes, unless this support was disabled when compiling wimlib.  The
92 named data streams may be accessed through extended attributes named "user.*",
93 where the * is the name of the named data stream.  See \fBsetfattr\fR (1) and
94 \fBgetfattr\fR (1).
95 .IP ""
96 If "windows", the named data streams will be accessible by specifying the
97 filename, then a colon, then the name of the named data stream; for example,
98 "myfile:mystream".
99 .IP ""
100 Please note that named data streams are a somewhat obscure NTFS feature that
101 aren't actually used much, even though they complicate the WIM file format
102 considerably.  Normally, all you care about is the default or "unnamed" data
103 stream.
104 .TP
105 \fB--debug\fR
106 Turn on debugging information printed by the FUSE library, and do not fork into
107 the background.
108 .TP
109 \fB--ref\fR="\fIGLOB\fR"
110 File glob of additional split WIM parts that are part of the split WIM being
111 mounted.  This option is valid for \fB@IMAGEX_PROGNAME@ mount\fR but not \fB@IMAGEX_PROGNAME@
112 mountrw\fR.  See \fBSPLIT_WIMS\fR.
113 .TP
114 \fB--staging-dir\fR=\fIDIR\fR
115 Store temporary staging files in a subdirectory of the directory \fIDIR\fR.
116 Only valid for \fB@IMAGEX_PROGNAME@ mountrw\fR.
117 .TP
118 \fB--unix-data\fR
119 By default, \fB@IMAGEX_PROGNAME@ mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR will ignore both
120 Windows-style security descriptors (which may have been set either from Windows or by
121 \fB@IMAGEX_PROGNAME@ capture\fR from a NTFS-volume) and UNIX-specific data (which is from using
122 \fB@IMAGEX_PROGNAME@ capture\fR with the \fB--unix-data\fR flag).  In this default mode,
123 all files will simply be owned by the user running \fB@IMAGEX_PROGNAME@\fR and will have mode 0777.
124 (Note: they will still not be accessible to other users unless you also specify
125 \fB--allow-other\fR.)  If you instead provide the \fB--unix-data\fR flag, these
126 default permissions will be overridden on a per-file basis with the
127 UNIX-specific data when available, and in the case of \fB@IMAGEX_PROGNAME@ mountrw\fR it
128 will be possible to change the UNIX permissions using the standard UNIX
129 tools and functions.
130 .TP
131 \fB--allow-other\fR
132 Pass the \fBallow_other\fR option to the FUSE mount.  See \fBmount.fuse\fR (8).
133 Note: to do this is a non-root user, \fBuser_allow_other\fR needs to be
134 specified in /etc/fuse.conf (with the FUSE implementation on Linux, at least).
135 .SH UNMOUNT OPTIONS
136 .TP
137 \fB--commit\fR
138 Update the WIM file with the changes that have been made.  Has no effect if the
139 mount is read-only.
140 .TP
141 \fB--check\fR
142 When writing \fIWIMFILE\fR, include an integrity table.  Has no effect if the
143 mount is read-only or if \fB--commit\fR was not specified.
144 .TP
145 \fB--rebuild\fR
146 Rebuild the entire WIM rather than appending any new data to the end of it.
147 Rebuilding the WIM is slower, but will save a little bit of space that would
148 otherwise be left as a hole in the WIM.  Even more space will be saved if the
149 read-write mount resulted in streams being deleted from the WIM.  Also see
150 .TP
151 \fB--lazy\fR
152 Pass the \fB-z\fR option to \fBfusermount\fR, which performs a "lazy" unmount
153 where the filesystme is detached immediately even if it is still busy.  However,
154 even with this option, \fB@IMAGEX_PROGNAME@ unmount\fR still waits for the
155 filesystem to become unbusy; \fB--lazy\fR will only stop the unmount from
156 immediately failing.
157 .SH IMPLEMENTATION DETAILS
158 Since a WIM is an archive and not a filesystem, \fB@IMAGEX_PROGNAME@ mountrw\fR creates a
159 temporary staging directory to contain files that are created or modified.  This
160 directory is located in the same directory as \fIWIMFILE\fR by default, but the
161 location can be set using the \fB--staging-dir\fR option.  When the filesystem
162 is unmounted with \fB--commit\fR, the WIM is modified in-place (or rebuild
163 completely with \fB--rebuild\fR), merging in the staging files as needed.  Then,
164 the temporary staging directory is deleted.
165 .PP
166 \fB@IMAGEX_PROGNAME@ unmount\fR runs in a separate process from the process that previously
167 ran \fB@IMAGEX_PROGNAME@ mount\fR, and these two processes communicate using POSIX message
168 queues.  See \fIsrc/mount_image.c\fR in the sources for details.  Note: As of
169 wimlib v1.2.1, \fB@IMAGEX_PROGNAME@ unmount\fR correctly fails with an error within a
170 reasonable amount of time (1 second) if the filesystem daemon is abnormally
171 terminated.
172 .SH SEE ALSO
173 .BR @IMAGEX_PROGNAME@ (1)