Debian Admin - Your way to Debian World

February 22, 2008

colordiff — a tool to colorize diff output

by @ 12:03 am. Filed under General

If you're new here, you may want to subscribe to my RSS feed. Thanks for visiting!

colordiff is a wrapper for diff and produces the same output as diff but with coloured syntax highlighting at the command line to improve readability. The output is similar to how a diff-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.

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.

colordiff has been tested on various flavours of Linux and under OpenBSD, but should be broadly portable to other systems.

Install colordiff in Debian

#aptitude install colordiff

This will complete the installation.

Using colordiff

colordiff Syntax

colordiff [diff options] {file1} {file2}

colordiff Examples

Use colordiff wherever you would normally use diff, or pipe output to colordiff:

$ colordiff file1 file2
$ diff -u file1 file2 | colordiff

You can pipe the output to ‘less’, using the ‘-R’ option (some systems or terminal types may get better results using ‘-r’ instead), which keeps the colour escape sequences, otherwise displayed incorrectly or discarded by ‘less’:

$ diff -u file1 file2 | colordiff | less -R

If you have wdiff installed, colordiff will correctly colourise the added and removed text, provided that the ‘-n’ option is given to wdiff:

$ wdiff -n file1 file2 | colordiff

You may find it useful to make diff automatically call colordiff. Add the following line to ~/.bashrc (or equivalent):

alias diff=colordiff

Any options passed to colordiff are passed through to diff.

Alternatively, a construct such as ‘cvs diff SOMETHING | colordiff’ can be included in ~/.bashrc as follows:

function cvsdiff () { cvs diff $@ | colordiff; }

Or, combining the idea above using ‘less’:

function cvsdiff () { cvs diff $@ | colordiff |less -R; }

Note that the function name, cvsdiff, can be customized.

Configuration files

/etc/colordiffrc - Central configuration file. User-specific settings can be enabled by copying this file to ~/.colordiffrc and making the appropriate changes.

colordiffrc-lightbg - Alternate configuration template for use with terminals having light backgrounds. Copy this to /etc/colordiffrc or ~/.colordiffrc and customize.

Tags: , , , ,

You may also be interested in...

Leave a Reply

Subscribe RSS Feed

subscribe to the Debian Admin RSS feed

Internal links:

Sponsors:



Categories:

Support Debian Admin

Amount $:
Website(Optional):

Sponsors:

Archives:

WidgetBucks - Trend Watch - WidgetBucks.com

Related Links:


WidgetBucks - Trend Watch - WidgetBucks.com

Favourite Sites:

Wordpress Collection
Windows Reference
Ubuntu Geek
DebianHelp
All About Debian Tutorials
Power Electrical
Check Your IP Here
Debian,Ubuntu News
DebCentral
Tuxmachines
Capnkirby
Libervis
Nuxifield
Linux Horizon
Linux Appfinder
Debuntu
GNU/Linux For Everyone
Free Penguin
DebianAdmin is not related to the Debian Project.
This site is copyright © 2006,2007 Debian Admin
All Trademarks are the property of their respective owners.
The contents of this website may not be mirrored or archived without the express written permission of DebianAdmin Site Owner.

DISCLAIMER: All the information, troubleshooting methods, utilities offered in this website is provided AS-IS, without any warranties. Though I strive for perfection, and always test the validity and effectiveness of the troubleshooting content in various systems, I assume no responsibility for your use of these Fixes, Utilities and other troubleshooting advice. The author will not be liable for any special, incidental, consequential or indirect damages due to loss of data or any other reason. All use is completely at your own risk. Changes to the existing content and new additions are made to this website periodically, without notification.
Rodney's Kontera DynamiContext Plugin plugged in.