.\"  $HeadURL$ $LastChangedRevision$
.\"
.pso ade-config --format=man
.so \*[ade_include_prefix]/ade.man
.pso fad-config --format=man
.TH FADDIFF 1 "ADE_APP_TOKEN_RELEASE_DATE_MAN"
.ne 5
.SH NAME
faddiff \- report differences between FAD files
.br
.ne 5
.SH SYNOPSIS
.B faddiff
\*[ade_standard_synopsis_component]
[ 
.B \-u 
|
.B \-\-ignore\-uid
] [
.B \-g 
|
.B \-\-ignore\-gid
] [
.B \-m 
|
.B \-\-ignore\-mode
] [ 
.B \-o
.I outfile
|
.B \-\-file=\fIoutfile
] 
.I file1
.I file2
.br
.ne 5
.SH DESCRIPTION
.B Faddiff
reports differences between two FAD files (see 
.B fad\fR(5)),
such as have been generated with 
.B mkfad\fR(1).
The input files must be specified on the command line, though
either one of them may be replaced with 
.B \(oq\-\fR'
to indicate that it should be read from standard input. The
result is written to the standard output.
.PP 
All differences between the state of an individual file in
the two FAD files are reported on one line. The format of
of such a line is:
.IP "" 15
.nf
\fIpath\fR: \fIchangetype\fR(\fIoldvalue\fR -> \fInewvalue\fR), ...
.fi
.PP
.I path
represents the path of the file that has changed. 
.I changetype
may be one of the following:
.TP 15
.B added
.I path
is mentioned in the second FAD file only. The brackets are empty.
.TP
.B deleted
.I path
is mentioned in the first FAD file only. The brackets are empty.
.TP
.B mode
.I path
has different permissions in the two FAD files. Bracketed
are the permissions, expressed as octal numbers, in the first file and
then in the second.
.TP
.B owner
.I path 
has different a different owner in the two FAD files. Bracketed
are the numeric user ids in the first file and
then in the second.
.TP
.B group
.I path 
has different a different group in the two FAD files. Bracketed
are the numeric group ids in the first file and
then in the second.
.TP
.B links
.I path
has a different set of hard links in the two FAD files. Bracketed
are the names of the other hard links in the first file and then
in the second.
.TP
.B type
.I path
has changed type. This indicates that 
.I path
has been deleted and subsequently recreated as a file-system object
of a different type. Bracketed are the types in the first file and
then in the second file. The types are represented by the following
characters:
.RS 15
.TP 5
.B f
file
.TP 
.B d
directory
.TP
.B p
pipe
.TP
.B l
symbolic link
.TP
.B b
block device
.TP
.B c
character device
.TP
.B s
socket
.RE
.TP 15
.B checksum
.I path
is a file whose contents is different as gauged by the 
.I path\fR's
32 bit checksum. Bracketed are the checksums in the first file and then 
in the second.
.TP
.B linked_to
.I path 
is a symbolic link which has different destinations in
the two FAD files. Bracketed are the symbolic link destinations in the first 
file and then in the second.
.TP
.B major/minor
.I path
is a special device file which has different major or minor numbers in
the two FAD files. Bracketed are the combined major and minor numbers in
the first file and then in the second.
.PP
.PP
.B Faddiff
can read and write plain files or files compressed with 
either
.B compress\fR(1)
or 
.B gzip\fR(1), 
but only if they have the correct file extension and are
specified on the command line, rather than fed through
standard input.
.br
.ne 5
.SH CONFIGURATION
None.
.br
.ne 5
.SH OPTIONS
\*[ade_standard_options_component]
.TP
.B \-g\fR,\fB\-\-ignore\-gid
Ignores changes of group.
.TP
.B \-m\fR,\fB\-\-ignore\-mode
Ignores changes of mode.
.TP
.B \-o\fR,\fB\-\-file=\fIoutfile
Writes the database to 
.I outfile\fR.
The default is to write to standard output.
.TP
.B \-u\fR,\fB\-\-ignore\-uid
Ignores changes of owner/user.
.br
.ne 5
.SH EXIT STATUS
.B Faddiff
returns zero. On failure it returns non-zero and displays a diagnostic
message. (Note that prior to release 4.6.2, 
.B faddiff
returned 1 if differences were detected in the two FAD files.)
.br
.ne 5
.SH FILES
None.
.br
.ne 5
.SH ENVIRONMENT VARIABLES
None.
.br
.ne 5
.SH EXAMPLES
The following output shows the results on running
.B faddiff 
on two FAD files. These files were generated with
.B mkfad\fR(1).
In between time changes of a type corresponding
the the filenames were made:
.IP
.nf
.fam C
.B faddiff before.fad after.fad
testdir/changedest: linked_to(dest1 -> dest2)
testdir/changegrp: group(79 -> 0)
testdir/changeme: links( -> ./linkedfile), checksum(5233 -> 5300)
testdir/changemin: major/minor(515 -> 772)
testdir/changemytype: type(f -> d)
testdir/changeown: owner(1663 -> 1194)
testdir/changeperm: mode(100600 -> 100755)
testdir/deleteme: deleted()
testdir/fad1: checksum(0 -> 25025)
testdir/fad2: added()
testdir/linkedfile: added()
testdir/newfile: added()
.fam T
.fi
.br
.ne 5
.SH CAVEATS
None.
.br
.ne 5
.SH STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of
.B faddiff\fR.
.br
.ne 5
.SH SEE ALSO
perl(1), fad(5), faddiff(1), compress(1), uncompress(1), gzip(1), gunzip(1), fad-config(1)
.br
.ne 5
.SH AUTHOR
ADE_APP_TOKEN_AUTHOR_NAME <ADE_APP_TOKEN_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 1995-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME
\*[ade_standard_copyright_component]