Some preparations for supporting NTFS capture and apply.
[wimlib] / doc / imagex-mount.1.in
1 .TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
2 .SH NAME
3 imagex mount \- Mount an image from a WIM archive readonly
4
5 .SH SYNOPSIS
6 \fBimagex mount\fR \fIWIMFILE\fR (\fIIMAGE_NUM\fR | \fIIMAGE_NAME\fR)  \
7 \fIDIRECTORY\fR [--check] [--stream-interface=\fIINTERFACE\fR]
8
9 .SH DESCRIPTION
10 .PP
11 \fBimagex mount\fR mounts the image specified by \fIIMAGE_NUM\fR or
12 \fIIMAGE_NAME\fR on the directory \fIDIRECTORY\fR using FUSE (Filesystem in
13 UserSpace).  It is mounted read-only.
14
15 It is permissible to omit the \fIIMAGE_NUM\fR or \fIIMAGE_NAME\fR only if
16 \fIWIMFILE\fR contains only one image.
17
18 .SH OPTIONS
19 .TP 6
20 \fB--check\fR
21 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
22 present. 
23 .TP
24 \fB--stream-interface\fR \fIINTERFACE\fR
25 Specify the interface to alternate data streams (ADS) in the WIM that will be
26 provided by the mounted filesystem.  These are a NTFS feature that found their
27 way into the WIM file format.
28
29 If "none", it will be impossible to read or write the ADS.
30
31 If "xattr" (default), the ADS will be accessible through extended attributes.
32 Each ADS will be an extended attribute named "user.*", where the * is the name
33 of the ADS.  See \fBsetfattr\fR (1) and \fBgetfattr\fR (1).
34
35 If "windows", the ADS will be accessible by specifing the filename, then a
36 colon, then the name of the ADS; for example, "myfile:mystream".
37
38 .SH SEE ALSO
39 .BR imagex (1)
40