summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2019-08-21 16:04:39 +0200
committerDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2019-08-21 16:44:11 +0200
commit6d3ff186da6f59d2164662ca5f1052219f1d92fd (patch)
tree89139746e4d6fe2c1708a6191ee19fe5595a0437 /doc
parenta408953eebb0dc65441e9ec4becbc8e2dba6c0e8 (diff)
Update man pages
- Add "see also" references - Make some adjustments as suggested by man-pages(7) - Clarify environment variable behaviour Signed-off-by: David Oberhollenzer <david.oberhollenzer@sigma-star.at>
Diffstat (limited to 'doc')
-rw-r--r--doc/gensquashfs.18
-rw-r--r--doc/rdsquashfs.12
-rw-r--r--doc/sqfs2tar.12
-rw-r--r--doc/sqfsdiff.15
-rw-r--r--doc/tar2sqfs.18
5 files changed, 23 insertions, 2 deletions
diff --git a/doc/gensquashfs.1 b/doc/gensquashfs.1
index 85c13d5..f2150cf 100644
--- a/doc/gensquashfs.1
+++ b/doc/gensquashfs.1
@@ -157,13 +157,19 @@ file /bin/bash 0755 0 0
file "/opt/my app/\\"special\\"/data" 0600 0 0
.fi
.in
-.SH ENVIRONEMNT VARIABLES
+.SH ENVIRONMENT
If the command line switch \fB\-\-defaults\fR is not used or no default mtime
is specified, the value of the environment variable \fBSOURCE\_DATE\_EPOCH\fR
is used for all file and filesystem timestamps.
If \fBSOURCE\_DATE\_EPOCH\fR is not set, not a parsable number or it is out of
range, the timestamps default to 0.
+
+Environment variables are only used if no explicit command line switches
+are set. Explicit command line switches are always preferred over the
+environment variables.
+.SH SEE ALSO
+rdsquashfs(1), tar2sqfs(1)
.SH AUTHOR
Written by David Oberhollenzer.
.SH COPYRIGHT
diff --git a/doc/rdsquashfs.1 b/doc/rdsquashfs.1
index 535161c..72c602a 100644
--- a/doc/rdsquashfs.1
+++ b/doc/rdsquashfs.1
@@ -93,6 +93,8 @@ Print help text and exit.
.TP
\fB\-\-version\fR, \fB\-V\fR
Print version information and exit.
+.SH SEE ALSO
+gensquashfs(1), sqfs2tar(1), sqfsdiff(1)
.SH AUTHOR
Written by David Oberhollenzer.
.SH COPYRIGHT
diff --git a/doc/sqfs2tar.1 b/doc/sqfs2tar.1
index bd80155..a71f603 100644
--- a/doc/sqfs2tar.1
+++ b/doc/sqfs2tar.1
@@ -59,6 +59,8 @@ sqfs2tar rootfs.sqfs | gzip > rootfs.tar.gz
Turn a squashfs image into an LZMA2 compressed tar archive:
.IP
sqfs2tar rootfs.sqfs | xz > rootfs.tar.xz
+.SH SEE ALSO
+rdsquashfs(1), tar2sqfs(1)
.SH AUTHOR
Written by David Oberhollenzer.
.SH COPYRIGHT
diff --git a/doc/sqfsdiff.1 b/doc/sqfsdiff.1
index 381a62b..3822308 100644
--- a/doc/sqfsdiff.1
+++ b/doc/sqfsdiff.1
@@ -61,6 +61,11 @@ Print help text and exit.
.TP
\fB\-\-version\fR, \fB\-V\fR
Print version information and exit.
+.SH EXIT STATUS
+The exit status is similar that of diff(1): 0 means equal, 1 means different,
+2 means problem.
+.SH SEE ALSO
+rdsquashfs(1), sqfs2tar(1)
.SH AUTHOR
Written by David Oberhollenzer.
.SH COPYRIGHT
diff --git a/doc/tar2sqfs.1 b/doc/tar2sqfs.1
index 463125b..abbde6a 100644
--- a/doc/tar2sqfs.1
+++ b/doc/tar2sqfs.1
@@ -100,13 +100,17 @@ If any unsupported section or extended attribute key is encountered in an
archive a warning message is written to stderr. If the \fB\-\-no\-skip\fR
option is set, processing aborts. By default, unknown sections and unsupported
extended attributes are simply skipped after issuing a warning.
-.SH ENVIRONEMNT VARIABLES
+.SH ENVIRONEMNT
If the command line switch \fB\-\-defaults\fR is not used or no default mtime
is specified, the value of the environment variable \fBSOURCE\_DATE\_EPOCH\fR
is used for all file and filesystem timestamps.
If \fBSOURCE\_DATE\_EPOCH\fR is not set, not a parsable number or it is out of
range, the timestamps default to 0.
+
+Environment variables are only used if no explicit command line switches
+are set. Explicit command line switches are always preferred over the
+environment variables.
.SH EXAMPLES
.TP
Turn an uncompressed tar archive into a squashfs image:
@@ -120,6 +124,8 @@ zcat rootfs.tar.gz | tar2sqfs rootfs.sqfs
Turn an LZMA2 compressed tar archive into a squashfs image:
.IP
xzcat rootfs.tar.xz | tar2sqfs rootfs.sqfs
+.SH SEE ALSO
+gensquashfs(1), rdsquashfs(1), sqfs2tar(1)
.SH AUTHOR
Written by David Oberhollenzer.
.SH COPYRIGHT