MAN page from OpenSuSE ccze-0.2.1.2-3.1.x86_64.rpm

CCZE

Section: CCZE (1)
Updated: 2003-04-24
Index 

NAME

ccze - A robust log colorizer 

SYNOPSIS

ccze[options] <logfile 

DESCRIPTION

This manual page documents briefly thecczeutility, which is a drop-in replacement forcolorize,but written in C, to be faster and less resource-hungry. The goal wasto be fully backwards compatible, yet superior with respect to speedand features. 

OPTIONS

These programs follow the usual GNU command line syntax, with longoptions starting with two dashes (`-'). A summary of options isincluded below.

-a, --argument PLUGIN=ARGUMENTS

Use this option to pass ARGUMENTS to the specifiedPLUGIN. The argument list is whitespace separated.

-A, --raw-ansi

If one wants to enable raw ANSI color sequences instead of usingcurses, this option does just that.

-c, --color KEY=COLOR

Set the color of the keyword KEY to COLOR, like one woulddo in one of the configuration files.

-C, --convert-date

Convert unix timestamp to readable date format (inoops and squid logs, for example).

-F, --rcfile rcfile

Read rcfile as a configuration file upon startup, instead of thedefault ones.

-h, --html

Instead of colorising the input onto the console, output it in HTMLformat instead.

-l, --list-plugins

List all available (loaded) plugins, along with their type and a shortdescription.

-m, --mode mode

Change the output mode. Available modes are curses, ansiand html.

-o, --options OPTIONS...

CCZE is able to toggle some of its features with thisoption. You can toggle the scroll, wordcolor,lookups, and transparent features, or you can fiddle withcssfile. All of these are enabled by default, exceptcssfile. One can turn them off by prefixing the option with a"no".

With scroll, one can enable or disable scrolling. If the outputis not redirected, it is wise to leave it enabled.

The wordcolor option makes ccze search for differentkeywords in unparsed input, and color those too. Since it is quitefast, and makes the output look better, it is recommended to leavethis enabled.

However, lookups is an option that might be better todisable. When on, ccze will try to look up usernames, servicenames, and lots of other stuff, which will slow down coloring a greatdeal. If one is piping a long log through ccze, this optionmight be turned off to speed up the process.

With the transparent option, one can make CCZE treat blackbackground colors as transparent - that means, a black backgroundwill appear transparent in a similar X terminal. If turned off, itwill appear as black.

If cssfile is set, then CCZE will not inline the Cascading StyleSheet information into the outputted HTML, but include a link to theexternal stylesheet given in this parameter.

-p, --plugin PLUGIN

While the default action is to load all plugins (see the Pluginssection below), when this option is present, only the specifiedplugins will be loaded. If one knows what kind of log will be pipedthrough ccze, using this option may result in a slight speedup.

-r, --remove-facility

Syslog-ng puts the facility level before log messages. With thisswitch, these can be cut off.

--help

Show summary of options and exit.

-V, --version

Show version of program.

 

PLUGINS

Different programs have different kind of logs, and every kind of logccze supports is implemented via a plug-in. They are by defaultlocated under /usr/lib64/ccze and $HOME/.ccze (so they canbe overridden by the user easily).

At the moment, the following modules are bundled with the officialrelease:

apm

For coloring apmd's logs.

distcc

For coloring distccd's logs. (See distccd(1))

exim

For coloring exim's main.log. (See exim(8))

fetchmail

For coloring fetchmail's log files. (See fetchmail(1))

ftpstats

For coloring ftpStats compatible log files, such as Pure-FTPD'sStats log format.

httpd

For coloring apache-style access.log and error.logfiles. (See apache(8))

As a side-effect, all compatible formats, like pure-ftpd(8)'scommon-log format is also supported by this plugin.

icecast

For coloring icecast/icecast.log and icecast/usage.logfiles. (See icecast(8))

oops

For coloring oops/oops.log files.

php

For coloring php.log files.

postfix

For coloring postfix logs. (See postfix(1))

procmail

For coloring procmail's log file. (See procmail(1))

proftpd

For coloring proftpd's access.log and auth.log files. (Seeproftpd(8))

squid

For coloring squid's access.log, store.log andcache.log files. (See squid(8))

sulog

For coloring sulog files. (See su(1))

super

For coloring super.log files. (See super(1))

syslog

For coloring generic syslog messages. (See syslogd(8))

ulogd

For coloring ulogd logs.

vsftpd

For coloring vsftpd.log files. (See vsftpd(8))

xferlog

For coloring xferlog files. (See xferlog(5))

 

FILES

/etc/colorizerc, $HOME/.colorizerc

These files are the default configuration files for colorize,and are parsed by ccze for the sake of full compatibility.

/etc/cczerc, $HOME/.cczerc

This two are the main configuration files, in which one can change thecolors used by the program to his liking. See the comments in thebeginning of /etc/cczerc for a description on the files'structure.

If neither of these files exist on your system, consider using theccze-dump utility in the source tree, which dumps the defaultcolor set to standard output.

 

SEE ALSO

colorize(1) 

AUTHOR

ccze was written by Gergely Nagy <algernonAATTbonehunter.rulez.org>,based on colorize by Istvan Karaszi <colorizeAATTspam.raszi.hu>.

---

 

Index

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

PLUGINS

FILES

SEE ALSO

AUTHOR

---

This document was created byman2html,using the manual pages.