386e1771a1b497a371682c1fb53c4ef5a4aaf891
[wimlib] / doc / imagex-mount.1.in
1 .TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
2 .SH NAME
3 imagex mount, mountrw, 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]
8 .br
9 \fBimagex mountrw\fR \fIWIMFILE\fR \fIIMAGE\fR \fIDIRECTORY\fR [--check]
10 [--streams-interface=\fIINTERFACE\fR]
11 .br
12 \fBimagex unmount\fR \fIDIRECTORY\fR [--commit] [--check]
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 NOTES
32
33 If wimlib was configured using the --without-fuse flag, then the \fBimagex
34 mount\fR, \fBimagex mountrw\fR, and \fBimagex unmount\fR commands will not work.
35
36 All files in the mounted WIM will be accessible regardless of whether there is a
37 security descriptor in the WIM associated with the file or not.  New files or
38 directories created in a read-write mounted WIM will be created with no security
39 descriptor.
40
41 .SH MOUNT OPTIONS
42 .TP
43 \fB--check\fR
44 When reading the WIM, verify its integrity if it contains an integrity table.
45 .TP
46 \fB--stream-interface\fR \fIINTERFACE\fR
47
48 This option is inspired by the ntfs-3g filesystem driver (see \fBntfs-3g\fR
49 (8)).  It controls how alternate data streams, or named data streams, in WIM
50 files are made available.
51
52 If "none", it will be impossible to read or write the named data streams.
53
54 If "xattr" (default), named data streams will be accessible through extended
55 file attributes, unless this support was disabled when compiling wimlib.  The
56 named data streams may be accessed through extended attributes named "user.*",
57 where the * is the name of the named data stream.  See \fBsetfattr\fR (1) and
58 \fBgetfattr\fR (1).
59
60 If "windows", the named data streams will be accessible by specifying the
61 filename, then a colon, then the name of the named data stream; for example,
62 "myfile:mystream".
63
64 Please note that named data streams are a somewhat obscure NTFS feature that
65 aren't actually used much, even though they complicate the WIM file format
66 considerably.  Normally, all you care about is the default or "unnamed" data
67 stream.
68
69 .TP
70 \fB--debug\fR
71 Turn on debugging information printed by the FUSE library, and do not fork into
72 the background.
73
74 .SH UNMOUNT OPTIONS
75 .TP
76 \fB--commit\fR
77 Recreate the WIM file with the changes that have been made.  Has no effect if
78 the mount is read-only.
79 .TP 6
80 \fB--check\fR
81 When writing \fIWIMFILE\fR, include an integrity table.  Has no effect if the
82 mount is read-only or if --commit was not specified.
83
84 .SH IMPLEMENTATION DETAILS
85
86 Since a WIM is an archive and not a filesystem, \fBimagex mountrw\fR creates a
87 temporary staging directory to contain files that are created or modified.  When
88 the filesystem is unmounted with \fB--commit\fR, the WIM is rebuilt, merging in
89 the staging files as needed.  Then, the temporary staging directory is deleted.
90
91 \fBimagex unmount\fR executes the \fBfusermount\fR (1) program, which should be
92 installed as part of libfuse, to unmount the filesystem.  It then uses a POSIX
93 message queue (see \fBmq_overview\fR (7)) to communicate with the filesystem
94 daemon (the instance of \fBimagex\fR that has mounted the WIM image) so that it
95 can know whether whether changes are to be committed and whether an integrity
96 table is to be included.  A message is then sent from the filesystem daemon to
97 unmounting process when the unmounting has been completed, and this message
98 indicates whether the unmounting was successful or not.
99
100 If the filesystem daemon has crashed or been killed, is possible for \fBimagex
101 unmount\fR to wait a very long time before timing out.  A solution to this
102 problem may be implemented in the future.
103
104 .SH SEE ALSO
105 .BR imagex (1)
106