1
2ARCHIVEMOUNT(1)                  User Commands                 ARCHIVEMOUNT(1)
3
4
5

NAME

7       archivemount - mounts an archive for access as a file system
8

SYNOPSIS

10       archivemount [-hVdfs] [-o options] archivepath mountpoint
11

DESCRIPTION

13       The  archivemount command mounts the file tree contained in the archive
14       archivepath on the directory mountpoint.  The  archive's  contents  can
15       subsequently  be  accessed  inside  mountpoint  as  a file system.  The
16       umount(8) command performs the corresponding unmount operation.
17
18       archivemount is known to work under both linux and Mac OS X  (via  Mac‐
19       FUSE).
20
21
22

EXAMPLE SESSION

24       Consider   the  gzipped  tar  archive  ``files.tgz''  containing  files
25       ``file1'' and ``file2'', and an empty directory ``mnt''.
26
27       $ ls
28       files.tgz    mnt/
29
30       $ archivemount files.tgz mnt
31
32       $ ls mnt
33       file1    file2
34
35       [... Perform desired read/write operations on the archive via mnt/ ...]
36
37       $ umount mnt
38
39       [... Any changes are saved to the archive ...]
40
41

ARCHIVE FORMATS

43       Archive format support is provided by the libarchive(3) library.   Read
44       operations are supported for:
45
46              ·      old-style tar archives,
47
48              ·      most variants of the POSIX ``ustar'' format,
49
50              ·      the POSIX ``pax interchange'' format,
51
52              ·      GNU-format tar archives,
53
54              ·      most common cpio archive formats,
55
56              ·      ISO9660 CD images (with or without RockRidge extensions),
57
58              ·      Zip archives.
59
60       Archives compressed with gzip(1), bzip2(1), or compress(1) are automat‐
61       ically detected and transparently decompressed.
62
63       The following formats can be written:
64
65              ·      POSIX-standard ``ustar'' archives,
66
67              ·      POSIX ``pax interchange format'' archives,
68
69              ·      POSIX octet-oriented cpio archives,
70
71              ·      two different variants of shar archives.
72
73       Before writing, the original archive is renamed with a ``.orig'' exten‐
74       sion  appended  to it.  More detail about the read/write support can be
75       found in the libarchive(3) documentation.
76
77
78

OPTIONS

80       archivemount is built upon the FUSE (Filesystem in Userspace)  library,
81       and  the  complete  set  of available options depends upon the specific
82       FUSE implementation.  Execute archivemount -h to retrieve a  definitive
83       list.
84
85
86   general options
87       -o opt,[opt...]
88              mount options
89
90       -h   --help
91              print help
92
93       -V   --version
94              print version
95
96
97   archivemount mount options
98       -o readonly
99              disable write support
100
101       -o nobackup
102              remove archive file backups
103
104
105   FUSE mount options
106       These options are available to linux users using standard FUSE.
107
108
109       -d   -o debug
110              enable debug output (implies -f)
111
112       -f     foreground operation
113
114       -s     disable multi-threaded operation
115
116       -o allow_other
117              allow access to other users
118
119       -o allow_root
120              allow access to root
121
122       -o nonempty
123              allow mounts over non-empty file/dir
124
125       -o default_permissions enable permission checking by kernel
126
127       -o fsname=NAME
128              set filesystem name
129
130       -o subtype=NAME
131              set filesystem type
132
133       -o large_read
134              issue large read requests (2.4 only)
135
136       -o max_read=N
137              set maximum size of read requests
138
139       -o hard_remove
140              immediate removal (don't hide files)
141
142       -o use_ino
143              let filesystem set inode numbers
144
145       -o readdir_ino
146              try to fill in d_ino in readdir
147
148       -o direct_io
149              use direct I/O
150
151       -o kernel_cache
152              cache files in kernel
153
154       -o [no]auto_cache
155              enable caching based on modification times
156
157       -o umask=M
158              set file permissions (octal)
159
160       -o uid=N
161              set file owner
162
163       -o gid=N
164              set file group
165
166       -o entry_timeout=T
167              cache timeout for names (1.0s)
168
169       -o negative_timeout=T
170              cache timeout for deleted names (0.0s)
171
172       -o attr_timeout=T
173              cache timeout for attributes (1.0s)
174
175       -o ac_attr_timeout=T
176              auto cache timeout for attributes (attr_timeout)
177
178       -o intr
179              allow requests to be interrupted
180
181       -o intr_signal=NUM
182              signal to send on interrupt (10)
183
184       -o modules=M1[:M2...]
185              names of modules to push onto filesystem stack
186
187       -o max_write=N
188              set maximum size of write requests
189
190       -o max_readahead=N
191              set maximum readahead
192
193       -o async_read
194              perform reads asynchronously (default)
195
196       -o sync_read
197              perform reads synchronously
198
199       -o atomic_o_trunc
200              enable atomic open+truncate support
201
202
203
204   MacFUSE mount options
205       These options are available to Mac users using MacFUSE.
206
207
208       -o allow_other
209              allow   access   to   others   besides   the  user  who  mounted
210              the file system
211
212       -o allow_recursion
213              allow a mount point that itself resides on a MacFUSE volume  (by
214              default, such mounting is disallowed)
215
216       -o allow_root
217              allow access to root (can't be used with allow_other)
218
219       -o auto_xattr
220              handle extended attributes entirely through ._ files
221
222       -o blocksize=SIZE
223              specify block size in bytes of "storage"
224
225       -o case_insensitive
226              enable case-insensitive mode
227
228       -o daemon_timeout=T
229              timeout in seconds for kernel calls to daemon
230
231       -o debug
232              turn on debug information printing
233
234       -o default_permissions
235              let the kernel handle permission checks locally
236
237       -o defer_permissions
238              defer permission checks to file operations themselves
239
240       -o direct_io
241              use alternative (direct) path for kernel-user I/O
242
243       -o extended_security
244              turn on Mac OS X extended security (ACLs)
245
246       -o fsid=FSID
247              set the second 32-bit component of the fsid
248
249       -o fsname=NAME
250              set the file system's name
251
252       -o fssubtype=NUM
253              set the file system's fssubtype identifier
254
255       -o fstypename=NAME
256              set the file system's type name
257
258       -o iosize=SIZE
259              specify maximum I/O size in bytes
260
261       -o jail_symlinks
262              contain symbolic links within the mount
263
264       -o kill_on_unmount
265              kernel  will  send  a  signal (SIGKILL by default) to the daemon
266              after unmount finishes
267
268       -o local
269              mark the volume as ``local'' (default is ``nonlocal'')
270
271       -o negative_vncache
272              enable vnode name caching of non-existent objects
273
274       -o volname=NAME
275              set the file system's volume name
276
277
278       -o noalerts
279              disable all graphical alerts (if any) in MacFUSE Core
280
281       -o noappledouble
282              ignore Apple Double (._) and .DS_Store files entirely
283
284       -o noapplexattr
285              ignore all ``com.apple.*'' extended attributes
286
287       -o nobrowse
288              mark the volume as non-browsable by the Finder
289
290       -o nolocalcaches
291              meta option equivalent to noreadahead,noubc,novncache
292
293       -o noping_diskarb
294              do not ping Disk Arbitration (pings by default)
295
296       -o noreadahead
297              disable I/O read-ahead behavior for this file system
298
299       -o nosynconclose
300              disable sync-on-close behavior (enabled by default)
301
302       -o nosyncwrites
303              disable synchronous-writes behavior (dangerous)
304
305       -o noubc
306              disable the unified buffer cache for this file system
307
308       -o novncache
309              disable the vnode name cache for this file system
310
311
312       -o hard_remove
313              immediate removal (don't hide files)
314
315       -o use_ino
316              let filesystem set inode numbers
317
318       -o readdir_ino
319              try to fill in d_ino in readdir
320
321       -o direct_io
322              use direct I/O
323
324       -o kernel_cache
325              cache files in kernel
326
327       -o [no]auto_cache
328              enable caching based on modification times
329
330       -o umask=M
331              set file permissions (octal)
332
333       -o uid=N
334              set file owner
335
336       -o gid=N
337              set file group
338
339       -o entry_timeout=T
340              cache timeout for names (1.0s)
341
342       -o negative_timeout=T
343              cache timeout for deleted names (0.0s)
344
345       -o attr_timeout=T
346              cache timeout for attributes (1.0s)
347
348       -o ac_attr_timeout=T
349              auto cache timeout for attributes (attr_timeout)
350
351       -o intr
352              allow requests to be interrupted
353
354       -o intr_signal=NUM
355              signal to send on interrupt (30)
356
357       -o modules=M1[:M2...]
358              names of modules to push onto filesystem stack
359
360
361       -o max_write=N
362              set maximum size of write requests
363
364       -o max_readahead=N
365              set maximum readahead
366
367       -o async_read
368              perform reads asynchronously (default)
369
370       -o sync_read
371              perform reads synchronously
372
373
374   Module options
375       [subdir]
376
377       -o subdir=DIR
378              prepend this directory to all paths (mandatory)
379
380       -o [no]rellinks
381              transform absolute symlinks to relative
382
383       [iconv]
384
385       -o from_code=CHARSET
386              original encoding of file names (default: UTF-8)
387
388       -o to_code=CHARSET
389              new encoding of the file names (default: ISO-8859-2)
390
391
392

LICENSE

394       This sofware is free software; you can redistribute it and/or modify it
395       under  the terms of the GNU Library General Public License as published
396       by the Free Software Foundation; either version 2 of  the  License,  or
397       (at your option) any later version.
398
399       This  software  is  distributed in the hope that it will be useful, but
400       WITHOUT ANY  WARRANTY;  without  even  the  implied  warranty  of  MER‐
401       CHANTABILITY  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library
402       General Public License for more details.
403
404       You should have received a copy  of  the  GNU  Library  General  Public
405       License  along  with  this software; if not, write to the Free Software
406       Foundation, Inc., 59 Temple Place, Suite 330,  Boston,  MA   02111-1307
407       USA
408
409
410

KNOWN BUGS

412       This  is  beta  software and should be treated as such.  Bug reports to
413       the AUTHORS listed below would be appreciated.
414
415       archivemount is forced to run a single-thread mode for now. Support for
416       stable multithreading is planned in a future release.
417
418
419

SEE ALSO

421       bzip2(1), compress(1), cpio(1), gzip(1), libarchive(3), pax(1), tar(1),
422       umount(8), and zip(1)
423
424       ``Filesystem in Userspace'': http://fuse.sourceforge.net/
425
426       ``MacFUSE'': http://code.google.com/p/macfuse/
427
428

AUTHORS

430       Archivemount is written and maintained by Andre Landwehr <andrel@cyber‐
431       noia.de>.
432
433       This  man  page was written by Tom Duck <tom.duck@dal.ca> with material
434       drawn from the page for libarchive(3).
435
436
437
438ARCHIVEMOUNT version 0.6.1      1 November 2008                ARCHIVEMOUNT(1)
Impressum