mirror of
https://github.com/google/fuse-archive.git
synced 2026-11-20 16:41:43 +00:00
Release version 1.22
This commit is contained in:
+1
-1
@@ -16,7 +16,7 @@ The project follows a stable/development minor versioning scheme:
|
||||
- **Even minor versions** (e.g., 1.20, 1.22) are **stable** releases.
|
||||
- **Odd minor versions** (e.g., 1.19, 1.21) are **development** versions.
|
||||
|
||||
Current state: **1.21 (Development)**.
|
||||
Current state: **1.22 (Stable)**.
|
||||
|
||||
## Build and Development
|
||||
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
title: fuse-archive
|
||||
section: 1
|
||||
header: User Manual
|
||||
footer: fuse-archive 1.21
|
||||
date: April 2026
|
||||
footer: fuse-archive 1.22
|
||||
date: May 2026
|
||||
---
|
||||
|
||||
# NAME
|
||||
|
||||
+100
-23
@@ -1,7 +1,7 @@
|
||||
'\" t
|
||||
.\" Automatically generated by Pandoc 3.1.11.1
|
||||
.\"
|
||||
.TH "fuse\-archive" "1" "April 2026" "fuse\-archive 1.21" "User Manual"
|
||||
.TH "fuse\-archive" "1" "May 2026" "fuse\-archive 1.22" "User Manual"
|
||||
.PD
|
||||
.SH NAME
|
||||
\f[B]fuse\-archive\f[R] \- Mount archives as a read\-only FUSE file
|
||||
@@ -89,6 +89,10 @@ Continue despite errors.
|
||||
Maximum number of filters per archive (default is 1).
|
||||
.PD
|
||||
.TP
|
||||
\f[B]\-o precache\f[R]
|
||||
Preemptive caching of uncompressed data (default).
|
||||
.PD
|
||||
.TP
|
||||
\f[B]\-o lazycache\f[R]
|
||||
Incremental caching of uncompressed data.
|
||||
.PD
|
||||
@@ -140,10 +144,23 @@ Do not report extended attributes.
|
||||
.PD
|
||||
.TP
|
||||
\f[B]\-o nobidding\f[R]
|
||||
Do not use libarchive's format bidding system to detect the archive format.
|
||||
Do not use libarchive\[cq]s format bidding system to detect the archive
|
||||
format.
|
||||
Instead, strictly rely on the file extension.
|
||||
.PD
|
||||
.TP
|
||||
\f[B]\-o noexternal\f[R]
|
||||
Do not use external programs for decompression.
|
||||
By default, external programs are allowed but searched for in a
|
||||
sanitized, fixed \f[CR]PATH\f[R]
|
||||
(\f[CR]/usr/bin:/bin:/usr/local/bin\f[R], plus
|
||||
\f[CR]/opt/homebrew/bin:/opt/local/bin\f[R] on macOS) to prevent local
|
||||
spoofing attacks.
|
||||
Using this option entirely clears the \f[CR]PATH\f[R], ensuring that
|
||||
only decompression filters implemented natively or statically linked
|
||||
into \f[B]libarchive\f[R] are used.
|
||||
.PD
|
||||
.TP
|
||||
\f[B]\-o dmask=M\f[R]
|
||||
Directory permission mask in octal (default is 0022).
|
||||
.PD
|
||||
@@ -162,9 +179,16 @@ Set the file group of all the items in the mounted archive (default is
|
||||
the current group).
|
||||
.PD
|
||||
.TP
|
||||
\f[B]\-o default_permissions\f[R]
|
||||
Use the file owner (UID), group (GID), and permissions stored with each
|
||||
item in the archive.
|
||||
\f[B]\-o enforce_permissions\f[R]
|
||||
Enforce standard UNIX permissions.
|
||||
By default, \f[B]fuse\-archive\f[R] presents all files as being owned by
|
||||
the current user and group, with standard read permissions.
|
||||
This option instructs \f[B]fuse\-archive\f[R] to use the exact UID, GID,
|
||||
and Unix permission bits stored within the archive for each item.
|
||||
This includes support for special bits such as \f[CR]SUID\f[R],
|
||||
\f[CR]SGID\f[R], and \f[CR]SVTX\f[R] (sticky bit).
|
||||
Note that this may result in access denied errors if you are not the
|
||||
owner of the files inside the archive.
|
||||
.PD
|
||||
.TP
|
||||
\f[B]\-f\f[R]
|
||||
@@ -278,6 +302,10 @@ files for efficient reading.
|
||||
.PD 0
|
||||
.IP \[bu] 2
|
||||
\f[B]Extended Attributes\f[R]: Supports reading xattrs from archives.
|
||||
.PD 0
|
||||
.IP \[bu] 2
|
||||
\f[B]High\-precision timestamps\f[R]: Supports full nanosecond precision
|
||||
for access, modification, and creation times.
|
||||
.RE
|
||||
.PD 0
|
||||
.IP \[bu] 2
|
||||
@@ -291,6 +319,31 @@ multiple archives or within a single archive.
|
||||
.IP \[bu] 2
|
||||
\f[B]Performance\f[R]: Optimized for speed through efficient caching.
|
||||
.PD
|
||||
.SH NAME DEDUPLICATION
|
||||
In case of name collision, \f[B]fuse\-archive\f[R] adds a number to
|
||||
deduplicate the conflicting file name:
|
||||
.IP
|
||||
.EX
|
||||
$ fuse\-archive \-o nomerge archive1.zip archive2.zip mnt
|
||||
|
||||
$ tree \-F mnt
|
||||
mnt
|
||||
├── archive1/
|
||||
│\ \ ├── file.txt
|
||||
│\ \ ├── file (1).txt
|
||||
│\ \ └── file (2).txt
|
||||
└── archive2/
|
||||
├── file.txt
|
||||
└── file (1).txt
|
||||
|
||||
2 directories, 5 files
|
||||
.EE
|
||||
.PD
|
||||
.PP
|
||||
Directories are never renamed.
|
||||
If a file is colliding with a directory, the file will be the one
|
||||
getting renamed.
|
||||
.PD
|
||||
.SH ARCHIVE FORMATS
|
||||
\f[B]fuse\-archive\f[R] is built on top of the \c
|
||||
.UR https://libarchive.org
|
||||
@@ -309,8 +362,8 @@ The version and build\-time configuration of the \f[B]libarchive\f[R]
|
||||
library.
|
||||
.PD 0
|
||||
.IP \[bu] 2
|
||||
The availability of external filter programs in your system\[cq]s
|
||||
\f[CR]PATH\f[R].
|
||||
The availability of external filter programs in the sanitized, fixed
|
||||
\f[CR]PATH\f[R] (see the \f[CR]\-o noexternal\f[R] option).
|
||||
.PD
|
||||
.PP
|
||||
To see the version of \f[B]libarchive\f[R] and other libraries linked
|
||||
@@ -355,11 +408,11 @@ It recognizes the following:
|
||||
.PD 0
|
||||
.IP \[bu] 2
|
||||
\f[B]Compression filters\f[R]: \f[CR]br\f[R], \f[CR]brotli\f[R],
|
||||
\f[CR]bz2\f[R], \f[CR]bzip2\f[R], \f[CR]grz\f[R], \f[CR]grzip\f[R],
|
||||
\f[CR]gz\f[R], \f[CR]gzip\f[R], \f[CR]lrz\f[R], \f[CR]lrzip\f[R],
|
||||
\f[CR]lz\f[R], \f[CR]lz4\f[R], \f[CR]lzip\f[R], \f[CR]lzma\f[R],
|
||||
\f[CR]lzo\f[R], \f[CR]lzop\f[R], \f[CR]xz\f[R], \f[CR]z\f[R],
|
||||
\f[CR]zst\f[R], \f[CR]zstd\f[R].
|
||||
\f[CR]bz\f[R], \f[CR]bz2\f[R], \f[CR]bzip2\f[R], \f[CR]grz\f[R],
|
||||
\f[CR]grzip\f[R], \f[CR]gz\f[R], \f[CR]gzip\f[R], \f[CR]lrz\f[R],
|
||||
\f[CR]lrzip\f[R], \f[CR]lz\f[R], \f[CR]lz4\f[R], \f[CR]lzip\f[R],
|
||||
\f[CR]lzma\f[R], \f[CR]lzo\f[R], \f[CR]lzop\f[R], \f[CR]xz\f[R],
|
||||
\f[CR]z\f[R], \f[CR]zst\f[R], \f[CR]zstd\f[R].
|
||||
.PD 0
|
||||
.IP \[bu] 2
|
||||
\f[B]ASCII encoding filters\f[R]: \f[CR]b64\f[R], \f[CR]base64\f[R],
|
||||
@@ -373,10 +426,14 @@ It recognizes the following:
|
||||
If the filename extension is not recognized, \f[B]fuse\-archive\f[R]
|
||||
will attempt to detect the format by examining the file\[cq]s byte
|
||||
contents.
|
||||
This fallback mechanism can be disabled using the
|
||||
\f[CR]\-o nobidding\f[R] option, forcing strict reliance on the file
|
||||
extension.
|
||||
.PD
|
||||
.SS External Filter Programs
|
||||
For some formats and encodings, \f[B]fuse\-archive\f[R] relies on the
|
||||
following external programs being available in your \f[CR]PATH\f[R]:
|
||||
following external programs being available in the sanitized, fixed
|
||||
\f[CR]PATH\f[R]:
|
||||
.PD 0
|
||||
.IP \[bu] 2
|
||||
\f[CR]base64\f[R]: For \f[CR]b64\f[R] and \f[CR]base64\f[R] encodings.
|
||||
@@ -482,8 +539,8 @@ built\-in.
|
||||
underlying \f[B]libarchive\f[R] library.
|
||||
.PD 0
|
||||
.IP \[bu] 2
|
||||
\f[B]ZIP\f[R]: Supported (may require specific \f[B]libarchive\f[R]
|
||||
build options).
|
||||
\f[B]ZIP\f[R]: Supported (understand legacy ZIP encryption as well as
|
||||
AES\-128, AES\-192 and AES\-256).
|
||||
.PD 0
|
||||
.IP \[bu] 2
|
||||
\f[B]7Z and RAR\f[R]: Native encryption for these formats is currently
|
||||
@@ -491,9 +548,27 @@ build options).
|
||||
.PD
|
||||
.PP
|
||||
When mounting a natively encrypted archive, \f[B]fuse\-archive\f[R] will
|
||||
securely prompt for a password in the terminal.
|
||||
You can also pipe the password to \f[B]fuse\-archive\f[R]\[cq]s standard
|
||||
input.
|
||||
securely prompt for a password in the terminal:
|
||||
.IP
|
||||
.EX
|
||||
$ fuse\-archive encrypted.zip mnt
|
||||
Need password for File [1] \[aq]/secret.txt\[aq]
|
||||
Password > Got it!
|
||||
Password is Ok
|
||||
|
||||
$ cat mnt/secret.txt
|
||||
This was encrypted.
|
||||
.EE
|
||||
.PD
|
||||
.PP
|
||||
For security reasons, \f[B]fuse\-archive\f[R] doesn\[cq]t allow the
|
||||
password to be specified on the command line.
|
||||
However, it is possible to pipe the password to
|
||||
\f[B]fuse\-archive\f[R]\[cq]s standard input:
|
||||
.IP
|
||||
.EX
|
||||
$ echo password | fuse\-archive encrypted.zip mnt
|
||||
.EE
|
||||
.PD
|
||||
.SS GPG Encryption
|
||||
\f[B]fuse\-archive\f[R] also supports archives and individual files
|
||||
@@ -534,8 +609,8 @@ and encryption (e.g., \f[CR]archive.tar.gz.gpg\f[R]).
|
||||
Use the \f[CR]\-o maxfilters\f[R] option to support these scenarios.
|
||||
.PD
|
||||
.PP
|
||||
Ensure that the \f[CR]gpg\f[R] program is installed and available in
|
||||
your \f[CR]PATH\f[R].
|
||||
Ensure that the \f[CR]gpg\f[R] program is installed and available in the
|
||||
sanitized, fixed \f[CR]PATH\f[R].
|
||||
.PD
|
||||
.SH CACHING
|
||||
\f[B]fuse\-archive\f[R] only does the minimum amount of work required to
|
||||
@@ -547,7 +622,7 @@ performance, mount time, and resource usage.
|
||||
The following strategies are mutually exclusive.
|
||||
If none is specified, pre\-emptive caching is used by default.
|
||||
.PD
|
||||
.SS Pre\-emptive Caching (Default)
|
||||
.SS Pre\-emptive Caching (\f[CR]\-o precache\f[R], Default)
|
||||
By default, \f[B]fuse\-archive\f[R] decompresses and caches the whole
|
||||
archive before serving its contents.
|
||||
The cost of decompression is incurred upfront at mount time, ensuring
|
||||
@@ -630,12 +705,14 @@ You can explicitly set the owner and group of all items in the mounted
|
||||
archive using the \f[CR]\-o uid\f[R] and \f[CR]\-o gid\f[R] options with
|
||||
the desired numerical IDs.
|
||||
.PD
|
||||
.SS Using Archive Permissions (\f[CR]\-o default_permissions\f[R])
|
||||
The \f[CR]\-o default_permissions\f[R] option instructs
|
||||
.SS Enforcing Archive Permissions (\f[CR]\-o enforce_permissions\f[R])
|
||||
The \f[CR]\-o enforce_permissions\f[R] option instructs
|
||||
\f[B]fuse\-archive\f[R] to use the exact UID, GID, and Unix permission
|
||||
bits stored within the archive for each item.
|
||||
This includes support for special bits such as \f[B]SUID\f[R],
|
||||
\f[B]SGID\f[R], and \f[B]SVTX\f[R] (sticky bit).
|
||||
Note that this may result in access denied errors if you are not the
|
||||
owner of the files inside the archive.
|
||||
.PD
|
||||
.SS Permission Masks (\f[CR]\-o dmask=M\f[R], \f[CR]\-o fmask=M\f[R])
|
||||
You can apply an octal permission mask to directories (\f[CR]dmask\f[R])
|
||||
|
||||
+1
-1
@@ -73,7 +73,7 @@
|
||||
#include "lib/util.h"
|
||||
|
||||
#define PROGRAM_NAME "fuse-archive"
|
||||
#define PROGRAM_VERSION "1.21"
|
||||
#define PROGRAM_VERSION "1.22"
|
||||
|
||||
// ---- Compile-time Configuration
|
||||
|
||||
|
||||
Reference in New Issue
Block a user