.\"*****************************************************************************
.\" Copyright 1994-2022,2024 by Thomas E. Dickey
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
.\" to deal in the Software without restriction, including without limitation
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
.\" and/or sell copies of the Software, and to permit persons to whom the
.\" Software is furnished to do so, subject to the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be included in
.\" all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
.\" THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
.\" DEALINGS IN THE SOFTWARE.
.\"
.\" Except as contained in this notice, the name(s) of the above copyright
.\" holders shall not be used in advertising or otherwise to promote the sale,
.\" use or other dealings in this Software without prior written authorization.
.\"*****************************************************************************
.\" $Id: diffstat.1,v 1.45 2024/11/11 12:59:28 tom Exp $
.TH DIFFSTAT 1 2024-11-11 "1.67" "User commands"
.ie \n(.g \{\
.ds `` \(lq
.ds '' \(rq
.ds '  \(aq
.\}
.el \{\
.ie t .ds `` ``
.el   .ds `` ""
.ie t .ds '' ''
.el   .ds '' ""
.ie t .ds '  \(aq
.el   .ds '  '
.\}
.SH NAME
\fBdiffstat\fP \-
make histogram from diff-output
.SH SYNOPSIS
\fBdiffstat\fI [options] [file-specifications]\fR
.SH DESCRIPTION
This program reads the output of \fBdiff\fP and displays a histogram
of the insertions, deletions, and modifications per-file.
\fBDiffstat\fP is a program that is useful for reviewing large,
complex patch files.
It reads from one or more input files which contain output from \fBdiff\fP,
producing a histogram of the total lines changed for each file referenced.
.PP
If the input filename ends with
\*(``.bz2\*('',
\*(``.gz\*('',
\*(``.lzma\*('',
\*(``.xz\*('',
\*(``.zst\*('',
\*(``.z\*('' or
\*(``.Z\*('',
\fBdiffstat\fP will read the
uncompressed data via a pipe from the corresponding program.
It also can infer the compression type from files piped via the standard input.
.PP
\fBDiffstat\fP recognizes the most popular types of output from \fBdiff\fP:
.RS 3
.TP
unified
preferred by the \fBpatch\fP utility.
.TP
context
best for readability, but not very compact.
.TP
default
not good for much, but simple to generate.
.RE
.PP
\fBDiffstat\fP detects the lines that are output by \fBdiff\fP to
tell which files are compared, and then counts the markers in the
first column that denote the type of change (insertion, deletion
or modification).
These are shown in the histogram as "+", "\-" and "!" characters.
.PP
If no filename is given on the command line,
\fBdiffstat\fP reads the differences from the standard input.
.SH OPTIONS
.TP
.B \-b
ignore lines matching "Binary files XXX and YYY differ" in the \fBdiff\fP
.TP
.B \-c
prefix each line of output with "#", making it a comment-line for shell
scripts.
.TP
.B \-C
add SGR color escape sequences to highlight the histogram.
.TP
.BI \-D " destination"
specify a directory containing files which can be referred to as
the result of applying the differences.
\fBdiffstat\fP will count the lines in the corresponding files
(after adjusting the names by the \fB\-p\fP option)
to obtain the total number of lines in each file.
.IP
The remainder, after subtracting modified and deleted lines,
is shown as "unchanged lines".
.TP
.B \-d
The debug prints a lot of information.
It is normally compiled-in, but can be suppressed.
.TP
.BI \-e " file"
redirect standard error to \fIfile\fR.
.TP
.B \-E
strip out ANSI escape sequences on each line before parsing the differences.
This allows \fBdiffstat\fP to be used with \fBcolordiff\fP.
.TP
.BI \-f " format"
specify the format of the histogram.
.RS
.TP 3
0
for concise, which shows only the value and a single histogram code for each of
insert (+),
delete (\-) or
modify (!)
.TP 3
1
for normal output,
.TP 3
2
to fill in the histogram with dots,
.TP 3
4
to print each value with the histogram.
.RE
.IP
Any nonzero value gives a histogram.
The dots and individual values can be combined,
e.g., \fB\-f6\fP gives both.
.TP
.B \-h
prints the usage message and exits.
.TP
.B \-k
suppress the merging of filenames in the report.
.TP
.B \-K
attempt to improve the annotation of "only" files
by looking for a match in the resulting set of files and
inferring whether the file was added or removed.
.IP
This does not currently work in combination with \fB\-R\fP because
\fBdiffstat\fP maintains only the resulting set of files.
.TP
.B \-l
lists only the filenames.
No histogram is generated.
.TP
.B \-m
merge insert/delete counts from each "chunk" of the patch file to
approximate a count of the modified lines.
.TP
.BI \-n " number"
specify the minimum width used for filenames.
If you do not specify this, \fBdiffstat\fP uses the length of the longest
filename, after stripping common prefixes.
.TP
.BI \-N " number"
specify the maximum width used for filenames.
Names longer than this limit are truncated on the left.
If you do not specify this, \fBdiffstat\fP next checks the \fB\-n\fP option.
.TP
.BI \-o " file"
redirect standard output to \fIfile\fR.
.TP
.BI \-p " number"
override the logic that strips common pathnames, simulating the \fBpatch\fP
"\-p" option.
.IP
If you do not give a \fB\-p\fP option, \fBdiffstat\fP examines the
differences and strips the common prefix from the pathnames.
This is not what \fBpatch\fP does.
.TP
.B \-q
suppress the "0 files changed" message for empty diffs.
.TP
.B \-r " code"
provides optional rounding of the data shown in histogram,
rather than truncating with error adjustments.
.RS
.TP 3
0
is the default.
No rounding is performed,
but accumulated errors are added to following columns.
.TP 3
1
rounds the data
.TP 3
2
rounds the data and adjusts the histogram to ensure that
it displays something if there are any differences even if
those would normally be rounded to zero.
.RE
.TP
.B \-R
Assume patch was created with old and new files swapped.
.TP
.B \-s
show only the summary line, e.g., number of insertions and deletions.
.TP
.BI \-S " source"
this is like the \fB\-D\fP option, but specifies a location where
the original files (before applying differences) can be found.
.TP
.B \-t
overrides the histogram,
generates output of comma separated values for the number of
changed lines found in the differences for each file:
inserted, deleted and modified.
.IP
If \fB\-S\fP or \fB\-D\fP options are given, the number of unchanged
lines precedes the number of changes.
.TP
.B \-T
prints the numbers that the \fB\-t\fP option would show,
between the pathname and histogram.
.IP
The width of the number of changes is determined
by the largest value (but at least 3).
The width given in the \fB\-w\fP option is separate from the width of these
numbers.
.TP
.B \-u
suppress the sorting of filenames in the report.
.TP
.B \-v
show progress,
e.g., if the output is redirected to a file,
write progress messages to the standard error.
.TP
.B \-V
prints the current version number and exits.
.TP
.BI \-w " number"
specify the maximum width of the histogram.
The histogram will never be shorter than 10 columns,
just in case the filenames get too large.
.IP
The default is 80 columns,
unless the output is to a terminal.
In that case, the default width is the terminal's width.
.SH ENVIRONMENT
\fBDiffstat\fP runs in a POSIX environment.
.PP
You can override the compiled-in paths of programs used for decompressing
input files by setting environment variables corresponding to their name:
.sp
.RS
.nf
DIFFSTAT_BZCAT_PATH
DIFFSTAT_BZIP2_PATH
DIFFSTAT_COMPRESS_PATH
DIFFSTAT_GZIP_PATH
DIFFSTAT_LZCAT_PATH
DIFFSTAT_PCAT_PATH
DIFFSTAT_UNCOMPRESS_PATH
DIFFSTAT_XZ_PATH
DIFFSTAT_ZCAT_PATH
DIFFSTAT_ZSTD_PATH
.fi
.RE
.PP
However, \fBdiffstat\fP assumes that the resulting program uses the
same command-line options, e.g., "\-c" to decompress to the standard output.
.SH FILES
\fBDiffstat\fP is a single binary module, which uses no auxiliary files.
.SH BUGS
\fBDiffstat\fP makes a lot of assumptions
about the format of \fBdiff\fP's output.
.PP
There is no way to obtain a filename from the standard \fBdiff\fP between
two files with no options.
Context diffs work,
as well as unified diffs.
.PP
There's no easy way to determine the degree of overlap between the
"before" and "after" displays of modified lines.
\fBdiffstat\fP simply counts the number of inserted and deleted lines
to approximate modified lines for the \fB\-m\fP option.
.SH AUTHORS
Thomas Dickey <dickey@invisible-island.net>.
.SH SEE ALSO
.BR diff (1),
.BR patch (1).