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 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
'\" t
.\" Title: colordiff
.\" Author: Dave Ewart
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 11/14/2012
.\" Manual: User Commands
.\" Source: colordiff
.\" Language: English
.\"
.TH "COLORDIFF" "1" "11/14/2012" "colordiff" "User Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
colordiff \- a tool to colorize \fBdiff\fR output
.SH "SYNOPSIS"
.HP \w'\fBcolordiff\fR\ 'u
\fBcolordiff\fR [\fIdiff\ options\fR] [\fIcolordiff\ options\fR] {\fIfile1\fR} {\fIfile2\fR}
.SH "DESCRIPTION"
.PP
colordiff
is a wrapper for
\fBdiff\fR
and produces the same output as
\fBdiff\fR
but with coloured syntax highlighting at the command line to improve readability\&. The output is similar to how a
\fBdiff\fR\-generated patch might appear in
Vim
or
Emacs
with the appropriate syntax highlighting options enabled\&. The colour schemes can be read from a central configuration file or from a local user
~/\&.colordiffrc
file\&.
.PP
colordiff
makes use of ANSI colours and as such will only work when ANSI colours can be used \- typical examples are xterms and Eterms, as well as console sessions\&.
.PP
colordiff
has been tested on various flavours of Linux and under OpenBSD, but should be broadly portable to other systems\&.
.SH "USAGE"
.PP
Use
colordiff
wherever you would normally use
\fBdiff\fR, or instead pipe output to
colordiff:
.PP
For example:
.sp
.if n \{\
.RS 4
.\}
.nf
$ colordiff file1 file2
$ diff \-u file1 file2 | colordiff
.fi
.if n \{\
.RE
.\}
.PP
You can pipe the output to \*(Aqless\*(Aq, using the \*(Aq\-R\*(Aq option (some systems or terminal types may get better results using \*(Aq\-r\*(Aq instead), which keeps the colour escape sequences, otherwise displayed incorrectly or discarded by \*(Aqless\*(Aq:
.sp
.if n \{\
.RS 4
.\}
.nf
$ diff \-u file1 file2 | colordiff | less \-R
.fi
.if n \{\
.RE
.\}
.PP
If you have
\fBwdiff\fR
installed, colordiff will correctly colourise the added and removed text, provided that the \*(Aq\-n\*(Aq option is given to
\fBwdiff\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
$ wdiff \-n file1 file2 | colordiff
.fi
.if n \{\
.RE
.\}
.PP
You may find it useful to make
\fBdiff\fR
automatically call
\fBcolordiff\fR\&. Add the following line to
~/\&.bashrc
(or equivalent):
.sp
.if n \{\
.RS 4
.\}
.nf
alias diff=colordiff
.fi
.if n \{\
.RE
.\}
.PP
Any options passed to
colordiff
are passed through to
\fBdiff\fR
except for the colordiff\-specific option \*(Aqdifftype\*(Aq, e\&.g\&.
.sp
.if n \{\
.RS 4
.\}
.nf
colordiff \-\-difftype=debdiff file1 file2
.fi
.if n \{\
.RE
.\}
.PP
Valid values for \*(Aqdifftype\*(Aq are: diff, diffc, diffu, diffy, wdiff, debdiff; these correspond to plain diffs, context diffs, unified diffs, side\-by\-side diffs, wdiff output and debdiff output respectively\&. Use these overrides when colordiff is not able to determine the diff\-type automatically\&.
.PP
Alternatively, a construct such as \*(Aqcvs diff SOMETHING | colordiff\*(Aq can be included in
~/\&.bashrc
as follows:
.sp
.if n \{\
.RS 4
.\}
.nf
function cvsdiff () { cvs diff $@ | colordiff; }
.fi
.if n \{\
.RE
.\}
.PP
Or, combining the idea above using \*(Aqless\*(Aq:
.sp
.if n \{\
.RS 4
.\}
.nf
function cvsdiff () { cvs diff $@ | colordiff |less \-R; }
.fi
.if n \{\
.RE
.\}
.PP
Note that the function name, cvsdiff, can be customized\&.
.SH "FILES"
.PP
/etc/colordiffrc
.RS 4
Central configuration file\&. User\-specific settings can be enabled by copying this file to
~/\&.colordiffrc
and making the appropriate changes\&.
.RE
.PP
colordiffrc\-lightbg
.RS 4
Alternate configuration template for use with terminals having light backgrounds\&. Copy this to /etc/colordiffrc or ~/\&.colordiffrc and customize\&.
.RE
.SH "BUGS"
.PP
Bug reports and suggestions/patches to
davee@sungate\&.co\&.uk
please\&.
.SH "AUTHORS"
.PP
\fBDave Ewart\fR
.RS 4
colordiff author and Debian packager
.RE
.PP
\fBGraham Wilson\fR
.RS 4
Manual page and XML source author
.RE
.PP
\fBColin Tuckley\fR
.RS 4
Debian package sponsor
.RE
|