-
Notifications
You must be signed in to change notification settings - Fork 21
/
archivemount.1.in
454 lines (407 loc) · 10 KB
/
archivemount.1.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
\" Process this file with
.\" groff -man -Tascii archivemount.1
.\"
.TH ARCHIVEMOUNT "1" "@RELEASE_DATE@" "ARCHIVEMOUNT version @VERSION@" "User Commands"
.SH NAME
archivemount \- mounts an archive for access as a file system
.SH SYNOPSIS
\fBarchivemount\fP [\fB-hVdfs\fP] [\fB-o\fP \fIoptions\fP] \fIarchivepath\fP \fImountpoint\fP
.SH DESCRIPTION
The \fBarchivemount\fP command mounts the file tree contained in the archive
\fIarchivepath\fP on the directory \fImountpoint\fP. The archive's contents
can subsequently be accessed inside \fImountpoint\fP as a file system. The
\fBumount\fP(8) command performs the corresponding unmount operation.
\fBarchivemount\fP is known to work under both linux and Mac OS X (via
MacFUSE).
.SH EXAMPLE SESSION
Consider the gzipped tar archive ``files.tgz'' containing files ``file1'' and
``file2'', and an empty directory ``mnt''.
.nf
$ ls
files.tgz mnt/
$ archivemount files.tgz mnt
.nf
$ ls mnt
file1 file2
[... Perform desired read/write operations on the archive via mnt/ ...]
.nf
$ umount mnt
[... Any changes are saved to the archive ...]
.SH ARCHIVE FORMATS
Archive format support is provided by the \fBlibarchive\fP(3) library.
Read operations are supported for:
.RS
.IP \(bu
old-style tar archives,
.IP \(bu
most variants of the POSIX ``ustar'' format,
.IP \(bu
the POSIX ``pax interchange'' format,
.IP \(bu
GNU-format tar archives,
.IP \(bu
most common cpio archive formats,
.IP \(bu
ISO9660 CD images (with or without RockRidge extensions),
.IP \(bu
Zip archives.
.RE
Archives compressed with \fBgzip\fP(1), \fBbzip2\fP(1), or
\fBcompress\fP(1) are automatically detected and transparently decompressed.
The following formats can be written:
.RS
.IP \(bu
POSIX-standard ``ustar'' archives,
.IP \(bu
POSIX ``pax interchange format'' archives,
.IP \(bu
POSIX octet-oriented cpio archives,
.IP \(bu
two different variants of shar archives.
.RE
Before writing, the original archive is renamed with a ``.orig'' extension
appended to it. More detail about the read/write support can be found in
the \fBlibarchive\fP(3) documentation.
.SH OPTIONS
\fBarchivemount\fP is built upon the FUSE (Filesystem in Userspace)
library, and the complete set of available options depends upon the
specific FUSE implementation. Execute \fBarchivemount -h\fP to retrieve
a definitive list.
.SS "general options"
.TP
\fB\-o\fR opt,[opt...]
mount options
.TP
\fB\-h\fR \fB\-\-help\fR
print help
.TP
\fB\-V\fR \fB\-\-version\fR
print version
.SS "archivemount mount options"
.TP
\fB\-o\fR readonly
disable write support
.TP
\fB\-o\fR password
prompt for a passphrase
.TP
\fB\-o\fR nobackup
remove archive file backups
.TP
\fB\-o\fR subtree=<regex>
mount only subtree of archive, strip subtree part from path
.SS "FUSE mount options"
These options are available to linux users using standard FUSE.
.TP
\fB\-d\fR \fB\-o\fR debug
enable debug output (implies \fB\-f\fR)
.TP
\fB\-f\fR
foreground operation
.TP
\fB\-s\fR
disable multi\-threaded operation
.TP
\fB\-o\fR allow_other
allow access to other users
.TP
\fB\-o\fR allow_root
allow access to root
.TP
\fB\-o\fR nonempty
allow mounts over non\-empty file/dir
.HP
\fB\-o\fR default_permissions
enable permission checking by kernel
.TP
\fB\-o\fR fsname=NAME
set filesystem name
.TP
\fB\-o\fR subtype=NAME
set filesystem type
.TP
\fB\-o\fR large_read
issue large read requests (2.4 only)
.TP
\fB\-o\fR max_read=N
set maximum size of read requests
.TP
\fB\-o\fR hard_remove
immediate removal (don't hide files)
.TP
\fB\-o\fR use_ino
let filesystem set inode numbers
.TP
\fB\-o\fR readdir_ino
try to fill in d_ino in readdir
.TP
\fB\-o\fR direct_io
use direct I/O
.TP
\fB\-o\fR kernel_cache
cache files in kernel
.TP
\fB\-o\fR [no]auto_cache
enable caching based on modification times
.TP
\fB\-o\fR umask=M
set file permissions (octal)
.TP
\fB\-o\fR uid=N
set file owner
.TP
\fB\-o\fR gid=N
set file group
.TP
\fB\-o\fR entry_timeout=T
cache timeout for names (1.0s)
.TP
\fB\-o\fR negative_timeout=T
cache timeout for deleted names (0.0s)
.TP
\fB\-o\fR attr_timeout=T
cache timeout for attributes (1.0s)
.TP
\fB\-o\fR ac_attr_timeout=T
auto cache timeout for attributes (attr_timeout)
.TP
\fB\-o\fR intr
allow requests to be interrupted
.TP
\fB\-o\fR intr_signal=NUM
signal to send on interrupt (10)
.TP
\fB\-o\fR modules=M1[:M2...]
names of modules to push onto filesystem stack
.TP
\fB\-o\fR max_write=N
set maximum size of write requests
.TP
\fB\-o\fR max_readahead=N
set maximum readahead
.TP
\fB\-o\fR async_read
perform reads asynchronously (default)
.TP
\fB\-o\fR sync_read
perform reads synchronously
.TP
\fB\-o\fR atomic_o_trunc
enable atomic open+truncate support
.SS "MacFUSE mount options"
These options are available to Mac users using MacFUSE.
.TP
\fB-o\fR allow_other
allow access to others besides the user who mounted the file system
.TP
\fB-o\fR allow_recursion
allow a mount point that itself resides on a MacFUSE volume (by default,
such mounting is disallowed)
.TP
\fB-o\fR allow_root
allow access to root (can't be used with allow_other)
.TP
\fB-o\fR auto_xattr
handle extended attributes entirely through ._ files
.TP
\fB-o\fR blocksize=SIZE
specify block size in bytes of "storage"
.TP
\fB-o\fR case_insensitive
enable case-insensitive mode
.TP
\fB-o\fR daemon_timeout=T
timeout in seconds for kernel calls to daemon
.TP
\fB-o\fR debug
turn on debug information printing
.TP
\fB-o\fR default_permissions
let the kernel handle permission checks locally
.TP
\fB-o\fR defer_permissions
defer permission checks to file operations themselves
.TP
\fB-o\fR direct_io
use alternative (direct) path for kernel-user I/O
.TP
\fB-o\fR extended_security
turn on Mac OS X extended security (ACLs)
.TP
\fB-o\fR fsid=FSID
set the second 32-bit component of the fsid
.TP
\fB-o\fR fsname=NAME
set the file system's name
.TP
\fB-o\fR fssubtype=NUM
set the file system's fssubtype identifier
.TP
\fB-o\fR fstypename=NAME
set the file system's type name
.TP
\fB-o\fR iosize=SIZE
specify maximum I/O size in bytes
.TP
\fB-o\fR jail_symlinks
contain symbolic links within the mount
.TP
\fB-o\fR kill_on_unmount
kernel will send a signal (SIGKILL by default) to the daemon after unmount
finishes
.TP
\fB-o\fR local
mark the volume as ``local'' (default is ``nonlocal'')
.TP
\fB-o\fR negative_vncache
enable vnode name caching of non-existent objects
.TP
\fB-o\fR volname=NAME
set the file system's volume name
.TP
\fB-o\fR noalerts
disable all graphical alerts (if any) in MacFUSE Core
.TP
\fB-o\fR noappledouble
ignore Apple Double (._) and .DS_Store files entirely
.TP
\fB-o\fR noapplexattr
ignore all ``com.apple.*'' extended attributes
.TP
\fB-o\fR nobrowse
mark the volume as non-browsable by the Finder
.TP
\fB-o\fR nolocalcaches
meta option equivalent to noreadahead,noubc,novncache
.TP
\fB-o\fR noping_diskarb
do not ping Disk Arbitration (pings by default)
.TP
\fB-o\fR noreadahead
disable I/O read-ahead behavior for this file system
.TP
\fB-o\fR nosynconclose
disable sync-on-close behavior (enabled by default)
.TP
\fB-o\fR nosyncwrites
disable synchronous-writes behavior (dangerous)
.TP
\fB-o\fR noubc
disable the unified buffer cache for this file system
.TP
\fB-o\fR novncache
disable the vnode name cache for this file system
.TP
\fB-o\fR hard_remove
immediate removal (don't hide files)
.TP
\fB-o\fR use_ino
let filesystem set inode numbers
.TP
\fB-o\fR readdir_ino
try to fill in d_ino in readdir
.TP
\fB-o\fR direct_io
use direct I/O
.TP
\fB-o\fR kernel_cache
cache files in kernel
.TP
\fB-o\fR [no]auto_cache
enable caching based on modification times
.TP
\fB-o\fR umask=M
set file permissions (octal)
.TP
\fB-o\fR uid=N
set file owner
.TP
\fB-o\fR gid=N
set file group
.TP
\fB-o\fR entry_timeout=T
cache timeout for names (1.0s)
.TP
\fB-o\fR negative_timeout=T
cache timeout for deleted names (0.0s)
.TP
\fB-o\fR attr_timeout=T
cache timeout for attributes (1.0s)
.TP
\fB-o\fR ac_attr_timeout=T
auto cache timeout for attributes (attr_timeout)
.TP
\fB-o\fR intr
allow requests to be interrupted
.TP
\fB-o\fR intr_signal=NUM
signal to send on interrupt (30)
.TP
\fB-o\fR modules=M1[:M2...]
names of modules to push onto filesystem stack
.TP
\fB-o\fR max_write=N
set maximum size of write requests
.TP
\fB-o\fR max_readahead=N
set maximum readahead
.TP
\fB-o\fR async_read
perform reads asynchronously (default)
.TP
\fB-o\fR sync_read
perform reads synchronously
.SS "Module options"
.TP
[subdir]
.TP
\fB\-o\fR subdir=DIR
prepend this directory to all paths (mandatory)
.TP
\fB\-o\fR [no]rellinks
transform absolute symlinks to relative
.TP
[iconv]
.TP
\fB\-o\fR from_code=CHARSET
original encoding of file names (default: UTF-8)
.TP
\fB\-o\fR to_code=CHARSET
new encoding of the file names (default: ISO-8859-2)
.PD
.SH LICENSE
This software is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This software is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this software; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
.SH KNOWN BUGS
This is beta software and should be treated as such. Bug reports to the
AUTHORS listed below would be appreciated.
archivemount is forced to run a single-thread mode for now. Support for
stable multithreading is planned in a future release.
.SH SEE ALSO
.BR bzip2 (1),
.BR compress (1),
.BR cpio (1),
.BR gzip (1),
.BR libarchive (3),
.BR pax (1),
.BR tar (1),
.BR umount (8),
and
.BR zip (1)
``Filesystem in Userspace'': http://fuse.sourceforge.net/
``MacFUSE'': http://code.google.com/p/macfuse/
.SH "AUTHORS"
.LP
Archivemount is written and maintained by Andre Landwehr <[email protected]>.
.LP
This man page was written by Tom Duck <[email protected]> with material drawn
from the page for \fBlibarchive\fP(3).