You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/manpages/mksquashfs.1
+25-35Lines changed: 25 additions & 35 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
.\" 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"
3
3
.SH NAME
4
4
mksquashfs - tool to create and append to squashfs filesystems
5
5
.SH SYNOPSIS
@@ -20,7 +20,7 @@ needed.
20
20
.SS "Filesystem compression options:"
21
21
.TP
22
22
\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.
24
24
.TP
25
25
\fB\-comp\fR COMP
26
26
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
91
91
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".
92
92
.TP
93
93
\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.
95
95
.TP
96
96
\fB\-root\-time\fR TIME
97
97
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
116
116
set root directory group to specified GROUP, GROUP can be either an integer gid or group name.
117
117
.TP
118
118
\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).
120
120
.TP
121
121
\fB\-force\-dir\-mode\fR MODE
122
122
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.
207
207
display progress bar when using the \fB\-info\fR option.
208
208
.TP
209
209
\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.
211
211
.TP
212
212
\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.
214
214
.TP
215
215
\fB\-limit\fR PERCENTAGE
216
216
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.
282
282
.SS "Tar file only options:"
283
283
.TP
284
284
\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.
286
286
.TP
287
287
\fB\-default\-uid\fR VALUE
288
288
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
298
298
do not pad filesystem to a multiple of 4K.
299
299
.TP
300
300
\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.
302
302
.TP
303
303
\fB\-o\fR OFFSET
304
304
synonym for \fB\-offset\fR.
305
305
.SS "Help options:"
306
306
.TP
307
307
\fB\-help\fR
308
-
print help summary information to stdout.
308
+
print help summary information to pager (or stdout if not a terminal).
309
309
.TP
310
310
\fB\-help\-option\fR REGEX
311
311
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.
333
333
.TP
334
334
\fB\-ha\fR
335
335
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.
336
342
.SS "Miscellaneous options:"
337
343
.TP
338
344
\fB\-fstime\fR TIME
@@ -417,35 +423,22 @@ create symlink with timestamp time.
417
423
\fB\-p\fR "filename I time mode uid gid [s|f]"
418
424
create socket/fifo with timestamp time.
419
425
.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.
422
427
.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.
425
429
.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.
429
431
.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.
438
433
.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.
441
435
.SH "EXIT STATUS"
442
436
.TP
443
437
0
444
438
Mksquashfs successfully generated a filesystem.
445
439
.TP
446
440
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).
449
442
.SH "COMPRESSORS AVAILABLE AND COMPRESSOR SPECIFIC OPTIONS"
450
443
.SS "gzip (default):"
451
444
.TP
@@ -474,7 +467,7 @@ Compress using LZ4 High Compression.
474
467
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.
475
468
.TP
476
469
\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.
478
471
.SS "zstd:"
479
472
.TP
480
473
\fB\-Xcompression\-level\fR COMPRESSION\-LEVEL
@@ -485,7 +478,7 @@ SQFS_CMDLINE
485
478
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.
486
479
.TP
487
480
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.
489
482
.TP
490
483
PAGER
491
484
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.
651
644
.SH "SEE ALSO"
652
645
unsquashfs(1), sqfstar(1), sqfscat(1)
653
646
.PP
654
-
The README for the Squashfs\-tools 4.7 release, describing the new features can
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
657
648
.PP
658
-
The Squashfs\-tools USAGE guides and other documentation can be read here
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
130
133
.PP
131
-
The Squashfs\-tools USAGE guides and other documentation can be read here
0 commit comments