1CCZE(1)                              CCZE                              CCZE(1)
2
3
4

NAME

6       ccze - A robust log colorizer
7

SYNOPSIS

9       ccze [options] <logfile
10

DESCRIPTION

12       This manual page documents briefly the ccze utility, which is a drop-in
13       replacement for colorize, but written in  C,  to  be  faster  and  less
14       resource-hungry.  The  goal  was  to be fully backwards compatible, yet
15       superior with respect to speed and features.
16

OPTIONS

18       These programs follow the usual GNU  command  line  syntax,  with  long
19       options  starting  with  two  dashes  (`-').  A  summary  of options is
20       included below.
21
22       -a, --argument PLUGIN=ARGUMENTS
23              Use this option to pass ARGUMENTS to the specified  PLUGIN.  The
24              argument list is whitespace separated.
25
26       -A, --raw-ansi
27              If one wants to enable raw ANSI color sequences instead of using
28              curses, this option does just that.
29
30       -c, --color KEY=COLOR
31              Set the color of the keyword KEY to COLOR, like one would do  in
32              one of the configuration files.
33
34       -C, --convert-date
35              Convert  unix  timestamp  to  readable  date format (in oops and
36              squid logs, for example).
37
38       -F, --rcfile rcfile
39              Read rcfile as a configuration file upon startup, instead of the
40              default ones.
41
42       -h, --html
43              Instead  of  colorising the input onto the console, output it in
44              HTML format instead.
45
46       -l, --list-plugins
47              List all available (loaded) plugins, along with their type and a
48              short description.
49
50       -m, --mode mode
51              Change  the  output  mode.  Available modes are curses, ansi and
52              html.
53
54       -o, --options OPTIONS...
55              CCZE is able to toggle some of its features  with  this  option.
56              You  can  toggle the scroll, wordcolor, lookups, and transparent
57              features, or you can fiddle  with  cssfile.  All  of  these  are
58              enabled  by  default,  except  cssfile. One can turn them off by
59              prefixing the option with a "no".
60
61              With scroll, one can enable or disable scrolling. If the  output
62              is not redirected, it is wise to leave it enabled.
63
64              The wordcolor option makes ccze search for different keywords in
65              unparsed input, and color those too. Since it is quite fast, and
66              makes  the  output  look better, it is recommended to leave this
67              enabled.
68
69              However, lookups is an option that might be better  to  disable.
70              When  on, ccze will try to look up usernames, service names, and
71              lots of other stuff, which will slow down coloring a great deal.
72              If  one  is piping a long log through ccze, this option might be
73              turned off to speed up the process.
74
75              With the transparent option, one can make CCZE treat black back‐
76              ground  colors  as  transparent - that means, a black background
77              will appear transparent in a similar X terminal. If turned  off,
78              it will appear as black.
79
80              If cssfile is set, then CCZE will not inline the Cascading Style
81              Sheet information into the outputted HTML, but include a link to
82              the external stylesheet given in this paramater.
83
84       -p, --plugin PLUGIN
85              While the default action is to load all plugins (see the Plugins
86              section below), when this option is present, only the  specified
87              plugins  will  be  loaded. If one knows what kind of log will be
88              piped through ccze, using this option may  result  in  a  slight
89              speedup.
90
91       -r, --remove-facilty
92              Syslog-ng puts the facility level before log messages. With this
93              switch, these can be cut off.
94
95       --help Show summary of options and exit.
96
97       -V, --version
98              Show version of program.
99

PLUGINS

101       Different programs have different kind of logs, and every kind  of  log
102       ccze supports is implemented via a plug-in. They are by default located
103       under /usr/lib64/ccze and $HOME/.ccze (so they can be overridden by the
104       user easily).
105
106       At  the  moment,  the  following  modules are bundled with the official
107       release:
108
109       apm    For coloring apmd's logs.
110
111       distcc For coloring distccd's logs. (See distccd(1))
112
113       exim   For coloring exim's main.log. (See exim(8))
114
115       fetchmail
116              For coloring fetchmail's log files. (See fetchmail(1))
117
118       ftpstats
119              For coloring ftpStats compatible log files, such as  Pure-FTPD's
120              Stats log format.
121
122       httpd  For  coloring  apache-style access.log and error.log files. (See
123              apache(8))
124
125              As a side-effect, all compatible  formats,  like  pure-ftpd(8)'s
126              common-log format is also supported by this plugin.
127
128       icecast
129              For  coloring  icecast/icecast.log  and icecast/usage.log files.
130              (See icecast(8))
131
132       oops   For coloring oops/oops.log files.
133
134       php    For coloring php.log files.
135
136       postfix
137              For coloring postfix logs. (See postfix(1))
138
139       procmail
140              For coloring procmail's log file. (See procmail(1))
141
142       proftpd
143              For coloring  proftpd's  access.log  and  auth.log  files.  (See
144              proftpd(8))
145
146       squid  For  coloring squid's access.log, store.log and cache.log files.
147              (See squid(8))
148
149       sulog  For coloring sulog files. (See su(1))
150
151       super  For coloring super.log files. (See super(1))
152
153       syslog For coloring generic syslog messages. (See syslogd(8))
154
155       ulogd  For coloring ulogd logs.
156
157       vsftpd For coloring vsftpd.log files. (See vsftpd(8))
158
159       xferlog
160              For coloring xferlog files. (See xferlog(5))
161

FILES

163       /etc/colorizerc, $HOME/.colorizerc
164              These files are the default configuration  files  for  colorize,
165              and are parsed by ccze for the sake of full compatibility.
166       /etc/cczerc, $HOME/.cczerc
167              This  two  are  the  main  configuration files, in which one can
168              change the colors used by the program to  his  liking.  See  the
169              comments  in  the  beginning of /etc/cczerc for a description on
170              the files' structure.
171
172              If neither of these files exist on your system,  consider  using
173              the  ccze-dump  utility  in  the  source  tree,  which dumps the
174              default color set to standard output.
175

SEE ALSO

177       colorize(1)
178

AUTHOR

180       ccze was written by Gergely Nagy <algernon@bonehunter.rulez.org>, based
181       on colorize by Istvan Karaszi <colorize@spam.raszi.hu>.
182
183
184
185CCZE 0.2.1                        2003-04-24                           CCZE(1)
Impressum