From 9df4edbd5df8ff1e557f9e22b2612c06a6b1d505 Mon Sep 17 00:00:00 2001 From: David Oberhollenzer Date: Wed, 7 Aug 2019 12:08:37 +0200 Subject: Add documentation for sqfsdiff Signed-off-by: David Oberhollenzer --- README.md | 1 + doc/Makemodule.am | 2 +- doc/sqfsdiff.1 | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+), 1 deletion(-) create mode 100644 doc/sqfsdiff.1 diff --git a/README.md b/README.md index fc46164..48c4e7f 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ together with the existing tools: - `rdsquashfs` can be used to inspect and unpack SquashFS images. - `sqfs2tar` can turn a SquashFS image into a tarball, written to stdout. - `tar2sqfs` can turn a tarball (read from stdin) into a SquashFS image. + - `sqfsdiff` can compare the contents of two SquashFS images. # Getting and Building the Source Code diff --git a/doc/Makemodule.am b/doc/Makemodule.am index 1792da9..3619345 100644 --- a/doc/Makemodule.am +++ b/doc/Makemodule.am @@ -1,2 +1,2 @@ dist_man1_MANS += doc/gensquashfs.1 doc/rdsquashfs.1 doc/sqfs2tar.1 -dist_man1_MANS += doc/tar2sqfs.1 +dist_man1_MANS += doc/tar2sqfs.1 doc/sqfsdiff.1 diff --git a/doc/sqfsdiff.1 b/doc/sqfsdiff.1 new file mode 100644 index 0000000..ca3818f --- /dev/null +++ b/doc/sqfsdiff.1 @@ -0,0 +1,53 @@ +.TH SQFSDIFF "1" "August 2019" "sqfsdiff" "User Commands" +.SH NAME +sqfsdiff \- compare two squashfs images by contents and metadata +.SH SYNOPSIS +.B sqfsdiff +[\fI\,OPTIONS\/\fR...] \fI\, \/\fR +.SH DESCRIPTION +Compare two squashfs images. In contrast to doing a direct diff of the +images, this actually parses the filesystems and generates a more +meaningful difference report. +.PP +If only contents are compared, any differences in packed file layout, +ordering, compression, inode allocation and so on is ignored and the two +images are considered equal if each directory contains the same entries, +symlink with the same paths have the same targets, device nodes the same +device number and files the same size and contents. +.PP +A report of any difference is printed to stdout. The exit status is similar +that of diff(1): 0 means equal, 1 means different, 2 means problem. +.PP +Possible options: +.TP +\fB\-\-no\-contents\fR, \fB\-C\fR +Do not compare file contents. +.TP +\fB\-\-no\-owner\fR, \fB\-O\fR +Do not compare file owners. +.TP +\fB\-\-no\-permissions\fR, \fB\-P\fR +Do not compare permission bits. +.TP +\fB\-\-timestamps\fR, \fB\-T\fR +Compare file timestamps. +.TP +\fB\-\-inode\-num\fR, \fB\-I\fR +Compare inode numbers of all files. +.TP +\fB\-\-super\fR, \fB\-S\fR +Also compare metadata in super blocks. +.TP +\fB\-\-help\fR, \fB\-h\fR +Print help text and exit. +.TP +\fB\-\-version\fR, \fB\-V\fR +Print version information and exit. +.SH AUTHOR +Written by David Oberhollenzer. +.SH COPYRIGHT +Copyright \(co 2019 David Oberhollenzer et al +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. -- cgit v1.2.3