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

LICENSE

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

KNOWN BUGS

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

SEE ALSO

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

AUTHORS

436       Archivemount is written and maintained by Andre Landwehr <andrel@cyber‐
437       noia.de>.
438
439       This  man  page was written by Tom Duck <tom.duck@dal.ca> with material
440       drawn from the page for libarchive(3).
441
442
443
444ARCHIVEMOUNT version 0.9.1       20 April 2020                 ARCHIVEMOUNT(1)
Impressum