-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
sqsh-unpack.1.in
111 lines (83 loc) · 2.74 KB
/
sqsh-unpack.1.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
.TH sqsh-unpack 1 "March 17, 2023" "Version @VERSION@" "User Commands"
.SH NAME
sqsh-unpack \- extract files and directories from a squashfs archive.
.SH SYNOPSIS
.B sqsh-unpack
[\fB-o\fR \fIOFFSET\fR]
[\fB-cV\fR]
\fIFILESYSTEM\fR
[\fIPATH\fR]
[\fITARGET DIR\fR]
.br
.B sqsh-unpack
[\fB-v\fR]
.SH DESCRIPTION
.B sqsh-unpack
is a tool to extract files and directories from a squashfs archive.
The extracted files and directories are written to the \fITARGET
DIR\fR, or the current directory if no \fITARGET DIR\fR is specified.
If no \fIPATH\fR is specified, it extracts all files and directories in
the archive.
.SH OPTIONS
.TP
.BR \-v ", " \-\-version
Print the version of \fBsqsh-stat\fR and exit.
.TP
.BR \-o " " \fIOFFSET\fR ", " \fB\-\-offset " " \fIOFFSET\fR
skip OFFSET bytes at start of FILESYSTEM.
.TP
.BR \-c ", " \fB\-\-chown\fR
Change the owner and group of extracted files to match the user and
group ID of the current user.
.TP
.BR \-V ", " \fB\-\-verbose\fR
Print more verbose output during unpacking.
.TP
.BR \-R ", " \fB\-\-raw
When in verbose do not escape filenames, even if the output is a terminal.
.TP
.BR \-R ", " \fB\-\-escape
When in verbose escape filenames, even if the output is not a terminal.
.SH ARGUMENTS
.TP
.BR FILESYSTEM
The path to the squashfs archive to extract files from.
.TP
.BR PATH
Optional. The path within the archive to extract. If not specified, all
files and directories in the archive will be extracted.
.TP
.BR TARGET DIR
Optional. The directory to extract files to. If not specified, files
and directories will be extracted to the current directory.
.SH EXIT STATUS
The \fBsqsh-unpack\fR command exits with 0 on success, and non-zero on
failure.
.SH EXAMPLES
To extract all files and directories from a squashfs archive to the
current directory:
.BR sqsh-unpack " " /path/to/filesystem.sqsh
To extract a specific file or directory from a squashfs archive to the
current directory:
.BR sqsh-unpack " " /path/to/filesystem.sqsh " " /path/to/file
To extract a specific file or directory from a squashfs archive to a
target directory:
.BR sqsh-unpack " " /path/to/filesystem.sqsh " " /path/to/file " " /path/to/target/directory/
To extract all files and directories from a squashfs archive and change
the owner and group to match the current user:
.BR sqsh-unpack " " -c " " /path/to/filesystem.sqsh
To print the version of \fBsqsh-unpack\fR:
.BR sqsh-unpack " " -v
.SH SEE ALSO
.BR sqsh-cat (1),
.BR sqsh-ls (1),
.BR sqsh-mount (1),
.BR sqsh-stat (1),
.BR sqsh-xattr (1),
.BR squashfs (5)
.SH AUTHOR
Written by Enno Boland.
.SH COPYRIGHT
Copyright (C) 2023 Enno Boland. This is free software; see the source
for copying conditions. There is NO warranty; not even for
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.