1ARCHIVEMOUNT(1) User Commands ARCHIVEMOUNT(1)
3
7 archivemount - mounts an archive for access as a file system
8
10 archivemount [-hVdfs] [-o options] archivepath mountpoint
11
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 archivemount is known to work under both linux and Mac OS X (via Mac‐
19 FUSE).
20
24 Consider the gzipped tar archive ``files.tgz'' containing files
25 ``file1'' and ``file2'', and an empty directory ``mnt''.
26 $ ls
28 files.tgz mnt/
29 $ archivemount files.tgz mnt
31 $ ls mnt
33 file1 file2
34 [... Perform desired read/write operations on the archive via mnt/ ...]
36 $ umount mnt
38 [... Any changes are saved to the archive ...]
40
43 Archive format support is provided by the libarchive(3) library. Read
44 operations are supported for:
45 · old-style tar archives,
47 · most variants of the POSIX ``ustar'' format,
49 · the POSIX ``pax interchange'' format,
51 · GNU-format tar archives,
53 · most common cpio archive formats,
55 · ISO9660 CD images (with or without RockRidge extensions),
57 · Zip archives.
59 Archives compressed with gzip(1), bzip2(1), or compress(1) are automat‐
61 ically detected and transparently decompressed.
62 The following formats can be written:
64 · POSIX-standard ``ustar'' archives,
66 · POSIX ``pax interchange format'' archives,
68 · POSIX octet-oriented cpio archives,
70 · two different variants of shar archives.
72 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
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 general options
87 -o opt,[opt...]
88 mount options
89 -h --help
91 print help
92 -V --version
94 print version
95 archivemount mount options
98 -o readonly
99 disable write support
100 -o password
102 prompt for a passphrase
103 -o nobackup
105 remove archive file backups
106 -o subtree=<regex>
108 mount only subtree of archive, strip subtree part from path
109 FUSE mount options
112 These options are available to linux users using standard FUSE.
113 -d -o debug
116 enable debug output (implies -f)
117 -f foreground operation
119 -s disable multi-threaded operation
121 -o allow_other
123 allow access to other users
124 -o allow_root
126 allow access to root
127 -o nonempty
129 allow mounts over non-empty file/dir
130 -o default_permissions enable permission checking by kernel
132 -o fsname=NAME
134 set filesystem name
135 -o subtype=NAME
137 set filesystem type
138 -o large_read
140 issue large read requests (2.4 only)
141 -o max_read=N
143 set maximum size of read requests
144 -o hard_remove
146 immediate removal (don't hide files)
147 -o use_ino
149 let filesystem set inode numbers
150 -o readdir_ino
152 try to fill in d_ino in readdir
153 -o direct_io
155 use direct I/O
156 -o kernel_cache
158 cache files in kernel
159 -o [no]auto_cache
161 enable caching based on modification times
162 -o umask=M
164 set file permissions (octal)
165 -o uid=N
167 set file owner
168 -o gid=N
170 set file group
171 -o entry_timeout=T
173 cache timeout for names (1.0s)
174 -o negative_timeout=T
176 cache timeout for deleted names (0.0s)
177 -o attr_timeout=T
179 cache timeout for attributes (1.0s)
180 -o ac_attr_timeout=T
182 auto cache timeout for attributes (attr_timeout)
183 -o intr
185 allow requests to be interrupted
186 -o intr_signal=NUM
188 signal to send on interrupt (10)
189 -o modules=M1[:M2...]
191 names of modules to push onto filesystem stack
192 -o max_write=N
194 set maximum size of write requests
195 -o max_readahead=N
197 set maximum readahead
198 -o async_read
200 perform reads asynchronously (default)
201 -o sync_read
203 perform reads synchronously
204 -o atomic_o_trunc
206 enable atomic open+truncate support
207 MacFUSE mount options
211 These options are available to Mac users using MacFUSE.
212 -o allow_other
215 allow access to others besides the user who mounted
216 the file system
217 -o allow_recursion
219 allow a mount point that itself resides on a MacFUSE volume (by
220 default, such mounting is disallowed)
221 -o allow_root
223 allow access to root (can't be used with allow_other)
224 -o auto_xattr
226 handle extended attributes entirely through ._ files
227 -o blocksize=SIZE
229 specify block size in bytes of "storage"
230 -o case_insensitive
232 enable case-insensitive mode
233 -o daemon_timeout=T
235 timeout in seconds for kernel calls to daemon
236 -o debug
238 turn on debug information printing
239 -o default_permissions
241 let the kernel handle permission checks locally
242 -o defer_permissions
244 defer permission checks to file operations themselves
245 -o direct_io
247 use alternative (direct) path for kernel-user I/O
248 -o extended_security
250 turn on Mac OS X extended security (ACLs)
251 -o fsid=FSID
253 set the second 32-bit component of the fsid
254 -o fsname=NAME
256 set the file system's name
257 -o fssubtype=NUM
259 set the file system's fssubtype identifier
260 -o fstypename=NAME
262 set the file system's type name
263 -o iosize=SIZE
265 specify maximum I/O size in bytes
266 -o jail_symlinks
268 contain symbolic links within the mount
269 -o kill_on_unmount
271 kernel will send a signal (SIGKILL by default) to the daemon
272 after unmount finishes
273 -o local
275 mark the volume as ``local'' (default is ``nonlocal'')
276 -o negative_vncache
278 enable vnode name caching of non-existent objects
279 -o volname=NAME
281 set the file system's volume name
282 -o noalerts
285 disable all graphical alerts (if any) in MacFUSE Core
286 -o noappledouble
288 ignore Apple Double (._) and .DS_Store files entirely
289 -o noapplexattr
291 ignore all ``com.apple.*'' extended attributes
292 -o nobrowse
294 mark the volume as non-browsable by the Finder
295 -o nolocalcaches
297 meta option equivalent to noreadahead,noubc,novncache
298 -o noping_diskarb
300 do not ping Disk Arbitration (pings by default)
301 -o noreadahead
303 disable I/O read-ahead behavior for this file system
304 -o nosynconclose
306 disable sync-on-close behavior (enabled by default)
307 -o nosyncwrites
309 disable synchronous-writes behavior (dangerous)
310 -o noubc
312 disable the unified buffer cache for this file system
313 -o novncache
315 disable the vnode name cache for this file system
316 -o hard_remove
319 immediate removal (don't hide files)
320 -o use_ino
322 let filesystem set inode numbers
323 -o readdir_ino
325 try to fill in d_ino in readdir
326 -o direct_io
328 use direct I/O
329 -o kernel_cache
331 cache files in kernel
332 -o [no]auto_cache
334 enable caching based on modification times
335 -o umask=M
337 set file permissions (octal)
338 -o uid=N
340 set file owner
341 -o gid=N
343 set file group
344 -o entry_timeout=T
346 cache timeout for names (1.0s)
347 -o negative_timeout=T
349 cache timeout for deleted names (0.0s)
350 -o attr_timeout=T
352 cache timeout for attributes (1.0s)
353 -o ac_attr_timeout=T
355 auto cache timeout for attributes (attr_timeout)
356 -o intr
358 allow requests to be interrupted
359 -o intr_signal=NUM
361 signal to send on interrupt (30)
362 -o modules=M1[:M2...]
364 names of modules to push onto filesystem stack
365 -o max_write=N
368 set maximum size of write requests
369 -o max_readahead=N
371 set maximum readahead
372 -o async_read
374 perform reads asynchronously (default)
375 -o sync_read
377 perform reads synchronously
378 Module options
381 [subdir]
382 -o subdir=DIR
384 prepend this directory to all paths (mandatory)
385 -o [no]rellinks
387 transform absolute symlinks to relative
388 [iconv]
390 -o from_code=CHARSET
392 original encoding of file names (default: UTF-8)
393 -o to_code=CHARSET
395 new encoding of the file names (default: ISO-8859-2)
396
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 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 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
418 This is beta software and should be treated as such. Bug reports to
419 the AUTHORS listed below would be appreciated.
420 archivemount is forced to run a single-thread mode for now. Support for
422 stable multithreading is planned in a future release.
423
427 bzip2(1), compress(1), cpio(1), gzip(1), libarchive(3), pax(1), tar(1),
428 umount(8), and zip(1)
429 ``Filesystem in Userspace'': http://fuse.sourceforge.net/
431 ``MacFUSE'': http://code.google.com/p/macfuse/
433
436 Archivemount is written and maintained by Andre Landwehr <andrel@cyber‐
437 noia.de>.
438 This man page was written by Tom Duck <tom.duck@dal.ca> with material
440 drawn from the page for libarchive(3).
441ARCHIVEMOUNT version 0.9.1 20 April 2020 ARCHIVEMOUNT(1)