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 nobackup
102 remove archive file backups
103 -o subtree=<regex>
105 mount only subtree of archive, strip subtree part from path
106 FUSE mount options
109 These options are available to linux users using standard FUSE.
110 -d -o debug
113 enable debug output (implies -f)
114 -f foreground operation
116 -s disable multi-threaded operation
118 -o allow_other
120 allow access to other users
121 -o allow_root
123 allow access to root
124 -o nonempty
126 allow mounts over non-empty file/dir
127 -o default_permissions enable permission checking by kernel
129 -o fsname=NAME
131 set filesystem name
132 -o subtype=NAME
134 set filesystem type
135 -o large_read
137 issue large read requests (2.4 only)
138 -o max_read=N
140 set maximum size of read requests
141 -o hard_remove
143 immediate removal (don't hide files)
144 -o use_ino
146 let filesystem set inode numbers
147 -o readdir_ino
149 try to fill in d_ino in readdir
150 -o direct_io
152 use direct I/O
153 -o kernel_cache
155 cache files in kernel
156 -o [no]auto_cache
158 enable caching based on modification times
159 -o umask=M
161 set file permissions (octal)
162 -o uid=N
164 set file owner
165 -o gid=N
167 set file group
168 -o entry_timeout=T
170 cache timeout for names (1.0s)
171 -o negative_timeout=T
173 cache timeout for deleted names (0.0s)
174 -o attr_timeout=T
176 cache timeout for attributes (1.0s)
177 -o ac_attr_timeout=T
179 auto cache timeout for attributes (attr_timeout)
180 -o intr
182 allow requests to be interrupted
183 -o intr_signal=NUM
185 signal to send on interrupt (10)
186 -o modules=M1[:M2...]
188 names of modules to push onto filesystem stack
189 -o max_write=N
191 set maximum size of write requests
192 -o max_readahead=N
194 set maximum readahead
195 -o async_read
197 perform reads asynchronously (default)
198 -o sync_read
200 perform reads synchronously
201 -o atomic_o_trunc
203 enable atomic open+truncate support
204 MacFUSE mount options
208 These options are available to Mac users using MacFUSE.
209 -o allow_other
212 allow access to others besides the user who mounted
213 the file system
214 -o allow_recursion
216 allow a mount point that itself resides on a MacFUSE volume (by
217 default, such mounting is disallowed)
218 -o allow_root
220 allow access to root (can't be used with allow_other)
221 -o auto_xattr
223 handle extended attributes entirely through ._ files
224 -o blocksize=SIZE
226 specify block size in bytes of "storage"
227 -o case_insensitive
229 enable case-insensitive mode
230 -o daemon_timeout=T
232 timeout in seconds for kernel calls to daemon
233 -o debug
235 turn on debug information printing
236 -o default_permissions
238 let the kernel handle permission checks locally
239 -o defer_permissions
241 defer permission checks to file operations themselves
242 -o direct_io
244 use alternative (direct) path for kernel-user I/O
245 -o extended_security
247 turn on Mac OS X extended security (ACLs)
248 -o fsid=FSID
250 set the second 32-bit component of the fsid
251 -o fsname=NAME
253 set the file system's name
254 -o fssubtype=NUM
256 set the file system's fssubtype identifier
257 -o fstypename=NAME
259 set the file system's type name
260 -o iosize=SIZE
262 specify maximum I/O size in bytes
263 -o jail_symlinks
265 contain symbolic links within the mount
266 -o kill_on_unmount
268 kernel will send a signal (SIGKILL by default) to the daemon
269 after unmount finishes
270 -o local
272 mark the volume as ``local'' (default is ``nonlocal'')
273 -o negative_vncache
275 enable vnode name caching of non-existent objects
276 -o volname=NAME
278 set the file system's volume name
279 -o noalerts
282 disable all graphical alerts (if any) in MacFUSE Core
283 -o noappledouble
285 ignore Apple Double (._) and .DS_Store files entirely
286 -o noapplexattr
288 ignore all ``com.apple.*'' extended attributes
289 -o nobrowse
291 mark the volume as non-browsable by the Finder
292 -o nolocalcaches
294 meta option equivalent to noreadahead,noubc,novncache
295 -o noping_diskarb
297 do not ping Disk Arbitration (pings by default)
298 -o noreadahead
300 disable I/O read-ahead behavior for this file system
301 -o nosynconclose
303 disable sync-on-close behavior (enabled by default)
304 -o nosyncwrites
306 disable synchronous-writes behavior (dangerous)
307 -o noubc
309 disable the unified buffer cache for this file system
310 -o novncache
312 disable the vnode name cache for this file system
313 -o hard_remove
316 immediate removal (don't hide files)
317 -o use_ino
319 let filesystem set inode numbers
320 -o readdir_ino
322 try to fill in d_ino in readdir
323 -o direct_io
325 use direct I/O
326 -o kernel_cache
328 cache files in kernel
329 -o [no]auto_cache
331 enable caching based on modification times
332 -o umask=M
334 set file permissions (octal)
335 -o uid=N
337 set file owner
338 -o gid=N
340 set file group
341 -o entry_timeout=T
343 cache timeout for names (1.0s)
344 -o negative_timeout=T
346 cache timeout for deleted names (0.0s)
347 -o attr_timeout=T
349 cache timeout for attributes (1.0s)
350 -o ac_attr_timeout=T
352 auto cache timeout for attributes (attr_timeout)
353 -o intr
355 allow requests to be interrupted
356 -o intr_signal=NUM
358 signal to send on interrupt (30)
359 -o modules=M1[:M2...]
361 names of modules to push onto filesystem stack
362 -o max_write=N
365 set maximum size of write requests
366 -o max_readahead=N
368 set maximum readahead
369 -o async_read
371 perform reads asynchronously (default)
372 -o sync_read
374 perform reads synchronously
375 Module options
378 [subdir]
379 -o subdir=DIR
381 prepend this directory to all paths (mandatory)
382 -o [no]rellinks
384 transform absolute symlinks to relative
385 [iconv]
387 -o from_code=CHARSET
389 original encoding of file names (default: UTF-8)
390 -o to_code=CHARSET
392 new encoding of the file names (default: ISO-8859-2)
393
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 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 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
415 This is beta software and should be treated as such. Bug reports to
416 the AUTHORS listed below would be appreciated.
417 archivemount is forced to run a single-thread mode for now. Support for
419 stable multithreading is planned in a future release.
420
424 bzip2(1), compress(1), cpio(1), gzip(1), libarchive(3), pax(1), tar(1),
425 umount(8), and zip(1)
426 ``Filesystem in Userspace'': http://fuse.sourceforge.net/
428 ``MacFUSE'': http://code.google.com/p/macfuse/
430
433 Archivemount is written and maintained by Andre Landwehr <andrel@cyber‐
434 noia.de>.
435 This man page was written by Tom Duck <tom.duck@dal.ca> with material
437 drawn from the page for libarchive(3).
438ARCHIVEMOUNT version 0.8.12 27 March 2019 ARCHIVEMOUNT(1)