Skip to content

Commit 619aef7

Browse files
committed
4.7.1 RELEASE
Signed-off-by: Phillip Lougher <phillip@squashfs.org.uk>
1 parent e22f0e2 commit 619aef7

File tree

8 files changed

+86
-125
lines changed

8 files changed

+86
-125
lines changed

Documentation/manpages/mksquashfs.1

Lines changed: 25 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2-
.TH MKSQUASHFS "1" "June 2025" "mksquashfs version 4.7" "User Commands"
2+
.TH MKSQUASHFS "1" "August 2025" "mksquashfs version 4.7.1" "User Commands"
33
.SH NAME
44
mksquashfs - tool to create and append to squashfs filesystems
55
.SH SYNOPSIS
@@ -20,7 +20,7 @@ needed.
2020
.SS "Filesystem compression options:"
2121
.TP
2222
\fB\-b\fR BLOCK\-SIZE
23-
set data block to BLOCK\-SIZE. Default 128 Kbytes. Optionally a suffix of K, KB, Kbytes or M, MB, Mbytes can be given to specify Kbytes or Mbytes respectively.
23+
set data block to BLOCK\-SIZE. Default 128 Kbytes. Optionally a suffix of K, KB, Kbytes or M, MB, Mbytes can be given to specify Kbytes or Mbytes respectively.
2424
.TP
2525
\fB\-comp\fR COMP
2626
select COMP compression. Run \fB\-help\-comp\fR COMP to get compressor options for COMP, or ALL for all the compressors. Compressors available: gzip (default), lzo, lz4, xz, zstd.
@@ -91,7 +91,7 @@ if one source directory is specified, create a root directory containing that di
9191
set filesystem creation timestamp to TIME. TIME can be "inode", which means use the latest inode timestamp, an unsigned 32\-bit int indicating seconds since the epoch (1970\-01\-01) or a string value which is passed to the "date" command to parse. Any string value which the date command recognises can be used such as "now", "last week", or "Wed Feb 15 21:02:39 GMT 2023".
9292
.TP
9393
\fB\-inode\-time\fR TIME
94-
set all file and directory timestamps to TIME. TIME can be "inode", which means use the latest inode timestamp, an unsigned 32\-bit int indicating seconds since the epoch (1970\-01\-01) or a string value which is passed to the "date" command to parse. Any string value which the date command recognises can be used such as "now", "last week", or "Wed Feb 15 21:02:39 GMT 2025". This option sets and overrides the \fB\-root\-time\fR option.
94+
set all file and directory timestamps to TIME. TIME can be "inode", which means use the latest inode timestamp, an unsigned 32\-bit int indicating seconds since the epoch (1970\-01\-01) or a string value which is passed to the "date" command to parse. Any string value which the date command recognises can be used such as "now", "last week", or "Wed Feb 15 21:02:39 GMT 2025". This option sets and overrides the \fB\-root\-time\fR option.
9595
.TP
9696
\fB\-root\-time\fR TIME
9797
set root directory time to TIME. TIME can be "inode", which means use the latest inode timestamp, an unsigned 32\-bit int indicating seconds since the epoch (1970\-01\-01) or a string value which is passed to the "date" command to parse. Any string value which the date command recognises can be used such as "now", "last week", or "Wed Feb 15 21:02:39 GMT 2025".
@@ -116,7 +116,7 @@ set root directory owner to specified USER, USER can be either an integer uid or
116116
set root directory group to specified GROUP, GROUP can be either an integer gid or group name.
117117
.TP
118118
\fB\-force\-file\-mode\fR MODE
119-
set all file (non\-directory) permissions to MODE. MODE can be symbolic or octal (see section Symbolic mode specification).
119+
set all file (non\-directory) permissions to MODE. MODE can be symbolic or octal (see section Symbolic mode specification).
120120
.TP
121121
\fB\-force\-dir\-mode\fR MODE
122122
set all directory permissions to MODE. MODE can be symbolic or octal (see section Symbolic mode specification).
@@ -207,10 +207,10 @@ do not display the progress bar.
207207
display progress bar when using the \fB\-info\fR option.
208208
.TP
209209
\fB\-percentage\fR
210-
display a percentage rather than the full progress bar. Can be used with dialog \fB\-\-gauge\fR etc.
210+
display a percentage rather than the full progress bar. Can be used with dialog \fB\-\-gauge\fR etc.
211211
.TP
212212
\fB\-throttle\fR PERCENTAGE
213-
throttle the I/O input rate by the given percentage. This can be used to reduce the I/O and CPU consumption of Mksquashfs.
213+
throttle the I/O input rate by the given percentage. This can be used to reduce the I/O and CPU consumption of Mksquashfs.
214214
.TP
215215
\fB\-limit\fR PERCENTAGE
216216
limit the I/O input rate to the given percentage. This can be used to reduce the I/O and CPU consumption of Mksquashfs (alternative to \fB\-throttle\fR).
@@ -282,7 +282,7 @@ as \fB\-false\-action\fR, but read actions from FILE.
282282
.SS "Tar file only options:"
283283
.TP
284284
\fB\-default\-mode\fR MODE
285-
tar files often do not store permissions for intermediate directories. This option sets the default directory permissions to MODE. MODE can be symbolic or octal (see section Symbolic mode specification). Default mode is u=rwx,go=rx or 0755 octal. This also sets the root directory mode.
285+
tar files often do not store permissions for intermediate directories. This option sets the default directory permissions to MODE. MODE can be symbolic or octal (see section Symbolic mode specification). Default mode is u=rwx,go=rx or 0755 octal. This also sets the root directory mode.
286286
.TP
287287
\fB\-default\-uid\fR VALUE
288288
tar files often do not store uids for intermediate directories. This option sets the default directory owner to VALUE, rather than the user running Mksquashfs. VALUE can be either an integer uid or user name. This also sets the root directory uid.
@@ -298,14 +298,14 @@ allow tar files to be concatenated together and fed to Mksquashfs. Normally a t
298298
do not pad filesystem to a multiple of 4K.
299299
.TP
300300
\fB\-offset\fR OFFSET
301-
skip OFFSET bytes at the beginning of FILESYSTEM. Optionally a suffix of K, M or G can be given to specify Kbytes, Mbytes or Gbytes respectively. Default 0 bytes.
301+
skip OFFSET bytes at the beginning of FILESYSTEM. Optionally a suffix of K, M or G can be given to specify Kbytes, Mbytes or Gbytes respectively. Default 0 bytes.
302302
.TP
303303
\fB\-o\fR OFFSET
304304
synonym for \fB\-offset\fR.
305305
.SS "Help options:"
306306
.TP
307307
\fB\-help\fR
308-
print help summary information to stdout.
308+
print help summary information to pager (or stdout if not a terminal).
309309
.TP
310310
\fB\-help\-option\fR REGEX
311311
print the help information for options matching REGEX to pager (or stdout if not a terminal).
@@ -333,6 +333,12 @@ shorthand alternative to \fB\-help\-section\fR.
333333
.TP
334334
\fB\-ha\fR
335335
shorthand alternative to \fB\-help\-all\fR.
336+
.TP
337+
\fB\-no\-pager\fR
338+
do not use a pager to output help information.
339+
.TP
340+
\fB\-cols\fR WIDTH
341+
use WIDTH columns to output help information. Useful if output is not to a terminal.
336342
.SS "Miscellaneous options:"
337343
.TP
338344
\fB\-fstime\fR TIME
@@ -417,35 +423,22 @@ create symlink with timestamp time.
417423
\fB\-p\fR "filename I time mode uid gid [s|f]"
418424
create socket/fifo with timestamp time.
419425
.SH "SYMBOLIC MODE SPECIFICATION"
420-
The symbolic mode is of the format [ugoa]*[[+\-=]PERMS]+. PERMS = [rwxXst]+ or
421-
[ugo], and the sequence can be repeated separated with commas.
426+
The symbolic mode is of the format [ugoa]*[[+\-=]PERMS]+. PERMS = [rwxXst]+ or [ugo], and the sequence can be repeated separated with commas.
422427
.PP
423-
A combination of the letters ugoa specify which permission bits will be
424-
affected, u means user, g means group, o means other, and a means all or ugo.
428+
A combination of the letters ugoa specify which permission bits will be affected, u means user, g means group, o means other, and a means all or ugo.
425429
.PP
426-
The next letter is +, \- or =. The letter + means add to the existing permission
427-
bits, \- means remove the bits from the existing permission bits, and = means set
428-
the permission bits.
430+
The next letter is +, \- or =. The letter + means add to the existing permission bits, \- means remove the bits from the existing permission bits, and = means set the permission bits.
429431
.PP
430-
The permission bits (PERMS) are a combination of [rwxXst] which
431-
sets/adds/removes those bits for the specified ugoa combination, r means read, w
432-
means write and x means execute for files or search for directories. X has a
433-
special meaning, if the file is a directory it is equivalent to x or search, but
434-
if it is a non\-directory, it only takes effect if execute is already set for
435-
user, group or other. The s flag sets user or group ID on execution, and the t
436-
flag on a directory sets restricted deletion, or historically made the file
437-
sticky if a non\-directory.
432+
The permission bits (PERMS) are a combination of [rwxXst] which sets/adds/removes those bits for the specified ugoa combination, r means read, w means write and x means execute for files or search for directories. X has a special meaning, if the file is a directory it is equivalent to x or search, but if it is a non\-directory, it only takes effect if execute is already set for user, group or other. The s flag sets user or group ID on execution, and the t flag on a directory sets restricted deletion, or historically made the file sticky if a non\-directory.
438433
.PP
439-
The permission bits can also be u, g or o, which takes the permission bits from
440-
the user, group or other of the file respectively.
434+
The permission bits can also be u, g or o, which takes the permission bits from the user, group or other of the file respectively.
441435
.SH "EXIT STATUS"
442436
.TP
443437
0
444438
Mksquashfs successfully generated a filesystem.
445439
.TP
446440
1
447-
Fatal errors occurred, Mksquashfs aborted and did not generate a
448-
filesystem (or update if appending).
441+
Fatal errors occurred, Mksquashfs aborted and did not generate a filesystem (or update if appending).
449442
.SH "COMPRESSORS AVAILABLE AND COMPRESSOR SPECIFIC OPTIONS"
450443
.SS "gzip (default):"
451444
.TP
@@ -474,7 +467,7 @@ Compress using LZ4 High Compression.
474467
Compress using filter1,filter2,...,filterN in turn (in addition to no filter), and choose the best compression. Available filters: x86, arm, armthumb, arm64, powerpc, sparc, ia64, riscv.
475468
.TP
476469
\fB\-Xdict\-size\fR DICT\-SIZE
477-
Use DICT\-SIZE as the XZ dictionary size. The dictionary size can be specified as a percentage of the block size, or as an absolute value. The dictionary size must be less than or equal to the block size and 8192 bytes or larger. It must also be storable in the xz header as either 2^n or as 2^n+2^(n+1). Example dict\-sizes are 75%, 50%, 37.5%, 25%, or 32K, 16K, 8K etc.
470+
Use DICT\-SIZE as the XZ dictionary size. The dictionary size can be specified as a percentage of the block size, or as an absolute value. The dictionary size must be less than or equal to the block size and 8192 bytes or larger. It must also be storable in the xz header as either 2^n or as 2^n+2^(n+1). Example dict\-sizes are 75%, 50%, 37.5%, 25%, or 32K, 16K, 8K etc.
478471
.SS "zstd:"
479472
.TP
480473
\fB\-Xcompression\-level\fR COMPRESSION\-LEVEL
@@ -485,7 +478,7 @@ SQFS_CMDLINE
485478
If set, this is used as the directory to write the file sqfs_cmdline which contains the command line arguments given to Mksquashfs. Each command line argument is wrapped in quotes to ensure there is no ambiguity when arguments contain spaces. If the file already exists then the command line is appended to the file.
486479
.TP
487480
SOURCE_DATE_EPOCH
488-
If set, this is used as the filesystem creation timestamp. Also any file timestamps which are after SOURCE_DATE_EPOCH will be clamped to SOURCE_DATE_EPOCH. See https://reproducible\-builds.org/docs/source\-date\-epoch/ for more information.
481+
If set, this is used as the filesystem creation timestamp. Also any file timestamps which are after SOURCE_DATE_EPOCH will be clamped to SOURCE_DATE_EPOCH. See https://reproducible\-builds.org/docs/source\-date\-epoch/ for more information.
489482
.TP
490483
PAGER
491484
If set, this is used as the name of the program used to display the help text. The value can be a simple command or a pathname. The default is \fI\,/usr/bin/pager\/\fP.
@@ -651,9 +644,6 @@ GNU General Public License for more details.
651644
.SH "SEE ALSO"
652645
unsquashfs(1), sqfstar(1), sqfscat(1)
653646
.PP
654-
The README for the Squashfs\-tools 4.7 release, describing the new features can
655-
be read here
656-
https://github.com/plougher/squashfs\-tools/blob/master/Documentation/4.7/README
647+
The README for the Squashfs\-tools 4.7.1 release, describing the new features can be read here https://github.com/plougher/squashfs\-tools/blob/master/Documentation/4.7.1/README
657648
.PP
658-
The Squashfs\-tools USAGE guides and other documentation can be read here
659-
https://github.com/plougher/squashfs\-tools/blob/master/Documentation/4.7
649+
The Squashfs\-tools USAGE guides and other documentation can be read here https://github.com/plougher/squashfs\-tools/blob/master/Documentation/4.7.1

Documentation/manpages/sqfscat.1

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2-
.TH SQFSCAT "1" "June 2025" "sqfscat version 4.7" "User Commands"
2+
.TH SQFSCAT "1" "August 2025" "sqfscat version 4.7.1" "User Commands"
33
.SH NAME
44
sqfscat - tool to cat files from a squashfs filesystem to stdout
55
.SH SYNOPSIS
@@ -52,7 +52,7 @@ treat filenames as POSIX regular expressions rather than use the default shell w
5252
.SS "Help options:"
5353
.TP
5454
\fB\-h\fR, \fB\-help\fR
55-
print help summary information to stdout.
55+
print help summary information to pager (or stdout if not a terminal).
5656
.TP
5757
\fB\-help\-option\fR REGEX
5858
print the help information for options matching REGEX to pager (or stdout if not a terminal).
@@ -71,6 +71,12 @@ shorthand alternative to \fB\-help\-section\fR.
7171
.TP
7272
\fB\-ha\fR
7373
shorthand alternative to \fB\-help\-all\fR.
74+
.TP
75+
\fB\-no\-pager\fR
76+
do not use a pager to output help information.
77+
.TP
78+
\fB\-cols\fR WIDTH
79+
use WIDTH columns to output help information. Useful if output is not to a terminal.
7480
.SH "EXIT STATUS"
7581
.TP
7682
0
@@ -82,8 +88,7 @@ FATAL errors occurred, e.g. filesystem corruption, I/O errors. Sqfscat did not
8288
2
8389
Non\-fatal errors occurred, e.g. not a regular file, or failed to resolve pathname. Sqfscat continued and did not abort.
8490
.PP
85-
See \fB\-ignore\-errors\fR, \fB\-strict\-errors\fR and \fB\-no\-exit\-code\fR options for how they affect
86-
the exit status.
91+
See \fB\-ignore\-errors\fR, \fB\-strict\-errors\fR and \fB\-no\-exit\-code\fR options for how they affect the exit status.
8792
.SH "DECOMPRESSORS AVAILABLE"
8893
gzip, lzo, lz4, xz, zstd
8994
.SH ENVIRONMENT
@@ -124,9 +129,6 @@ GNU General Public License for more details.
124129
.SH "SEE ALSO"
125130
mksquashfs(1), unsquashfs(1), sqfstar(1)
126131
.PP
127-
The README for the Squashfs\-tools 4.7 release, describing the new features can
128-
be read here
129-
https://github.com/plougher/squashfs\-tools/blob/master/Documentation/4.7/README
132+
The README for the Squashfs\-tools 4.7.1 release, describing the new features can be read here https://github.com/plougher/squashfs\-tools/blob/master/Documentation/4.7.1/README
130133
.PP
131-
The Squashfs\-tools USAGE guides and other documentation can be read here
132-
https://github.com/plougher/squashfs\-tools/blob/master/Documentation/4.7
134+
The Squashfs\-tools USAGE guides and other documentation can be read here https://github.com/plougher/squashfs\-tools/blob/master/Documentation/4.7.1

0 commit comments

Comments
 (0)