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

LICENSE

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

KNOWN BUGS

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

SEE ALSO

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

AUTHORS

433       Archivemount is written and maintained by Andre Landwehr <andrel@cyber‐
434       noia.de>.
435
436       This  man  page was written by Tom Duck <tom.duck@dal.ca> with material
437       drawn from the page for libarchive(3).
438
439
440
441ARCHIVEMOUNT version 0.8.12      27 March 2019                 ARCHIVEMOUNT(1)
Impressum