File: diffstat.1

package info (click to toggle)
diffstat 1.43-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 612 kB
  • ctags: 151
  • sloc: sh: 2,873; ansic: 1,379; makefile: 130
file content (172 lines) | stat: -rw-r--r-- 5,567 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
.\"*****************************************************************************
.\" Copyright 1994-2004,2005 by Thomas E. Dickey                               *
.\" All Rights Reserved.                                                       *
.\"                                                                            *
.\" Permission to use, copy, modify, and distribute this software and its      *
.\" documentation for any purpose and without fee is hereby granted, provided  *
.\" that the above copyright notice appear in all copies and that both that    *
.\" copyright notice and this permission notice appear in supporting           *
.\" documentation, and that the name of the above listed copyright holder(s)   *
.\" not be used in advertising or publicity pertaining to distribution of the  *
.\" software without specific, written prior permission.                       *
.\"                                                                            *
.\" THE ABOVE LISTED COPYRIGHT HOLDER(S) DISCLAIM ALL WARRANTIES WITH REGARD   *
.\" TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND  *
.\" FITNESS, IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE  *
.\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES          *
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN      *
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR *
.\" IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.                *
.\"*****************************************************************************
.\" $Id: diffstat.1,v 1.18 2005/08/15 23:55:59 tom Exp $
.TH DIFFSTAT 1
.SH NAME
\fBdiffstat\fP \- make histogram from diff-output
.SH SYNOPSIS
\fBdiffstat\fP\fI [options] [file-specifications]\fP
.SH DESCRIPTION
This program reads the output of \fBdiff\fP and displays a histogram
of the insertions, deletions, and modifications per-file.
Diffstat 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.
If the input filename ends with .bz2, .Z or .gz, diffstat will read the
uncompressed data via a pipe from the corresponding program.
.PP
Diffstat recognizes the most popular types of output from diff:
.RS
.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 -c
prefix each line of output with "#", making it a comment-line for shell
scripts.
.TP
.BI -e " file"
redirect standard error to \fIfile\fR.
.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 -l
lists only the filenames.
No histogram is generated.
.TP
.BI -n " number"
specify the minimum width used for filenames.
If you don't specify this, \fBdiffstat\fP uses the length of the longest
filename, after stripping common prefixes.
.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.
.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 -t
overrides the histogram,
generates output of comma separated values.
.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.
.SH ENVIRONMENT
.PP
\fBDiffstat\fP runs in a portable UNIX\*R environment.
.SH FILES
.PP
\fBDiffstat\fP is a single binary module, which uses no auxiliary files.
.SH BUGS
.PP
\fBDiffstat\fP makes a lot of assumptions about the format of a \fBdiff\fP file.
.PP
There is no way to obtain a filename from the standard diff 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.
.SH SEE ALSO
.PP
diff (1).
.SH AUTHOR
.PP
Thomas Dickey <dickey@invisible-island.net>.