Added pkgconfig file; man pages auto-generated
[wimlib] / doc / imagex-unmount.1.in
1 .TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
2 .SH NAME
3 imagex unmount \- Unmount a WIM archive
4
5 .SH SYNOPSIS
6 \fBimagex unmount\fR \fIDIRECTORY\fR [--commit] [--check]
7
8 .SH DESCRIPTION
9 .PP
10
11 \fBimagex unmount\fR unmounts the WIM image that has been mounted on
12 \fIDIRECTORY\fR.
13
14 By default, \fBno changes are saved\fR.  You must specify the \fB--commit\fR
15 option to save your changes to the WIM file.
16
17 .SH IMPLEMENTATION
18
19 \fBimagex unmount\fR uses WIMLIB's wimlib_unmount() function.  This function is
20 implemented by using \fBexeclp\fR (3) to execute \fBfusermount -u\fR.  This is
21 currently necessary because \fBfusermount\fR is installed with the setuid root
22 permission needed to perform an unmount.  Then, for mounts that are not
23 read-only, the instance of \fBimagex\fR that is managing the filesystem opens
24 and waits for a message in a POSIX message queue (see \fBmq_overview\fR (7)).
25 The instance of \fBimagex\fR that is executing the \fBunmount\fR command then
26 sends a message that indicates whether changes are to be committed or not, and
27 whether an integrity table is to be included or not.  A message is then sent in
28 the other direction when the unmounting has been completed, and it indicates
29 whether the unmounting was successful or not.
30
31 .SH OPTIONS
32 .TP 6
33 \fB--commit\fR
34 Recreate the WIM file with the changes that have been made.  Has no effect if
35 the mount is read-only.\fR.
36 .TP 6
37 \fB--check\fR
38 When writing \fIWIMFILE\fR, include an integrity table.  Has no effect if the
39 mount is read-only or if --commit was not specified.
40 .SH SEE ALSO
41 .BR imagex (1)
42