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