eaeaf1a7aa9de71900d801d11116a4fed365a35e
[wimlib] / doc / imagex-mount.1.in
1 .TH IMAGEX "1" "December 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
2 .SH NAME
3 imagex-mount, imagex-mountrw, imagex-unmount \- Mount and unmount an image from a WIM archive
4
5 .SH SYNOPSIS
6 \fBimagex mount\fR \fIWIMFILE\fR \fIIMAGE\fR \fIDIRECTORY\fR [--check]
7 [--streams-interface=\fIINTERFACE\fR] [--ref="\fIGLOB\fR"]
8 .br
9 \fBimagex mountrw\fR \fIWIMFILE\fR \fIIMAGE\fR \fIDIRECTORY\fR [--check]
10 [--streams-interface=\fIINTERFACE\fR] [--staging-dir=\fIDIR\fR]
11 .br
12 \fBimagex unmount\fR \fIDIRECTORY\fR [--commit] [--check] [--rebuild]
13
14 .SH DESCRIPTION
15 .PP
16 The \fBimagex mount\fR and \fBimagex mountrw\fR commands will mount the image in
17 the Windows Imaging (WIM) file \fIWIMFILE\fR specified by \fIIMAGE\fR on the
18 directory \fIDIRECTORY\fR using FUSE (Filesystem in Userspace).  \fBimagex
19 mount\fR will mount the image read-only, while \fBimagex mountrw\fR will mount
20 the image read-write.
21
22 \fIIMAGE\fR may be a 1-based index of the image in the WIM to mount, or it may
23 be the name of an image in the WIM.  Use the \fBimagex info\fR (1) command to
24 see the available images in the WIM.  It is possible to omit \fIIMAGE\fR, but
25 only if the WIM contains only one image.
26
27 The WIM image can be unmounted using the \fBimagex unmount\fR command.  Changes
28 made to a WIM mounted read-write will be discarded unless the \fB--commit\fR
29 flag is provided to \fBimagex unmount\fR.
30
31 .SH SPLIT WIMS
32
33 You may use \fBimagex mount\fR to mount an image from a split WIM read-only.
34 However, you may not mount an image from a split WIM read-write.
35
36 The \fIWIMFILE\fR argument is used to specify the first part of the split WIM, and
37 the \fB--refs\fR="\fIGLOB\fR" option is used to provide a shell-style file glob
38 that specifies the additional parts of the split WIM.  \fIGLOB\fR is expected to
39 be a single string on the command line, so \fIGLOB\fR must be quoted so that it
40 is protected against shell expansion.  \fIGLOB\fR must expand to all parts of
41 the split WIM, except optionally the first part which may either omitted or
42 included in the glob (but the first part MUST be specified as \fIWIMFILE\fR as
43 well).
44
45 Here's an example.  The names for the split WIMs usually go something like:
46         
47 .RS
48 .PP
49 .nf
50 mywim.swm
51 mywim2.swm
52 mywim3.swm
53 mywim4.swm
54 mywim5.swm
55 .RE
56
57 To mount the first image of this split WIM to the directory "dir", we would do:
58 .PP
59 .RS
60 imagex mount mywim.swm 1 dir --ref="mywim*.swm"
61 .RE
62 .PP
63
64 .SH NOTES
65
66 If wimlib was configured using the --without-fuse flag, then the \fBimagex
67 mount\fR, \fBimagex mountrw\fR, and \fBimagex unmount\fR commands will not work.
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 ideal 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 \fBimagex unmount\fR to force the WIM to
85 be rebuilt, or else run \fBimagex 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 \fBimagex mount\fR but not \fBimagex
122 mountrw\fR.  See \fBSPLIT_WIMS\fR.
123 .TP
124 \fB--staging-dir\fR=\fIDIR\fR
125 Store temporary staging files in the directory \fIDIR\fR.  Only valid for
126 \fBimagex mountrw\fR.
127
128 .SH UNMOUNT OPTIONS
129
130 .TP
131 \fB--commit\fR
132 Update the WIM file with the changes that have been made.  Has no effect if the
133 mount is read-only.
134 .TP
135 \fB--check\fR
136 When writing \fIWIMFILE\fR, include an integrity table.  Has no effect if the
137 mount is read-only or if --commit was not specified.
138 .TP
139 \fB--rebuild\fR
140 Rebuild the entire WIM rather than appending any new data to the end of it.
141 Rebuilding the WIM is slower, but will save a little bit of space that would
142 otherwise be left as a hole in the WIM.  Even more space will be saved if the
143 read-write mount resulted in streams being deleted from the WIM.  Also see
144 \fBimagex optimize\fR.  Has no effect if the mount is read-only or if --commit
145 was not specified.
146
147 .SH IMPLEMENTATION DETAILS
148
149 Since a WIM is an archive and not a filesystem, \fBimagex mountrw\fR creates a
150 temporary staging directory to contain files that are created or modified.  This
151 directory is located in the same directory as \fIWIMFILE\fR by default, but the
152 location can be set using the \fB--staging-dir\fR option.  When the filesystem
153 is unmounted with \fB--commit\fR, the WIM is modified in-place (or rebuild
154 completely with \fB--rebuild\fR), merging in the staging files as needed.  Then,
155 the temporary staging directory is deleted.
156
157 \fBimagex unmount\fR runs in a separate process from the process that previously
158 ran \fBimagex mount\fR, and these two processes communicate using POSIX message
159 queue.  See \fIsrc/mount_image.c\fR in the sources for details.  Note: As of wimlib
160 v1.2.1, \fBimagex unmount\fR correctly fails with an error within a reasonable
161 amount of time (1 second) if the filesystem daemon is abnormally terminated.
162
163 .SH SEE ALSO
164 .BR imagex (1)
165