~ubuntu-branches/ubuntu/gutsy/calamaris/gutsy

« back to all changes in this revision

Viewing changes to calamaris.1

  • Committer: Bazaar Package Importer
  • Author(s): Christian Perrier
  • Date: 2007-02-11 14:33:06 UTC
  • mfrom: (2.1.5 feisty)
  • Revision ID: james.westby@ubuntu.com-20070211143306-8j11b9oh15nqc3am
Tags: 2.99.4.0-3.1
* Non-maintainer upload to fix pending l10n issues.
* Debconf translations:
  - Portuguese fixed. Closes: #403499
  - German. Closes: #409696

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH CALAMARIS 1 "$Date: 2003/05/14 21:22:37 $" Handmade "Calamaris Manual"
2
 
 
3
 
.SH NAME
4
 
calamaris \- generate statistic out of log files from Proxy-Cache-Servers
5
 
 
6
 
.SH SYNOPSIS
 
1
.TH "CALAMARIS" "1" "$Date: 2006-03-19 17:52:48 $" "Handmade" "Calamaris Manual"
 
2
 
 
3
.SH "NAME"
 
4
.B calamaris
 
5
- generate text and graphical statistics out of log files from
 
6
Proxy-Cache-Servers
 
7
 
 
8
.SH "SYNOPSIS"
7
9
cat log |
8
10
.B calamaris
9
 
[ calamaris_options ]
10
 
 
11
 
.SH DESCRIPTION
12
 
.B Calamaris
13
 
is used to produce statistical output from
14
 
.BR Squid ,
15
 
.B NetCache,
16
 
.B Inktomi Traffic Server,
17
 
.B Oops! proxy server,
18
 
.B Compaq Tasksmart,
19
 
.B Cisco Content Engines
20
 
or related Proxy log files.  The resulting output can be
21
 
.I ascii
22
 
or
23
 
.IR html .
24
 
It is possible to cache calculated data in a file to use them in later runs.
25
 
 
26
 
This manual page describes the options of
27
 
.B Calamaris
28
 
and gives a few examples.
29
 
 
30
 
.SH OPTIONS
 
11
[ --config-file .../calamaris.conf ] [ switches ]
 
12
 
 
13
.SH "DESCRIPTION"
 
14
.B Calamaris
 
15
is used to produce statistical output from \fBSquid\fR, \fBNetCache\fR,
 
16
\fBInktomi Traffic Server\fR, \fBOops! proxy server\fR,
 
17
\fBCompaq Tasksmart\fR, \fBCisco Content Engines\fR or related Proxy log
 
18
files.  The resulting output can be ascii or html with or without graphic
 
19
and with or without frames. It is possible to cache calculated data in a
 
20
file to use them in later runs.
 
21
 
 
22
This manual page describes the options of \fBCalamaris\fR and gives a few
 
23
examples.
 
24
 
 
25
.SH "OPTIONS"
 
26
.SS Configuration File
 
27
 
 
28
.TP
 
29
.I --config-file file
 
30
 
 
31
Not all reports and modification can be made through command-line-switches.
 
32
To use all options of Calamaris you\'ll have to use the configuration file.
 
33
You'll find the configuration-directives below, always inside of braces.
 
34
Examples are in the calamaris.conf which should come with this package.
31
35
 
32
36
.SS Reports
33
37
 
34
38
.TP
35
 
.I -a
36
 
all: extracts all reports available,
37
 
.I -a
 
39
.I --all-useful-reports|-a
 
40
extracts all useful reports available,
 
41
.I --all-useful-reports
38
42
equals
39
 
.IR "-D 10 -d 20 -P 60 -r 20 -s -t 20" .
40
 
 
41
 
.TP
42
 
.I -d n
43
 
domain report: switches the top level and the second level report on.  The
44
 
data is derived from the URL.  The output is limited by n.  (-1 is unlimited)
45
 
 
46
 
.TP
47
 
.I -p type
48
 
peak report: Measures the peaks of the Proxy usage in requests per second,
49
 
per minute and per hour.  It reports peaks for TCP, UDP and ALL requests. If
50
 
set to
 
43
.I --size-distribution-report 10
 
44
.I --domain-report 20
 
45
.I --performance-report 60
 
46
.I --requester-report 20
 
47
.I --status-report
 
48
.I --type-report 20
 
49
.I --response-time-report
 
50
.I --errorcode-distribution-report
 
51
.
 
52
 
 
53
.TP
 
54
.I --domain-report|-d n ($domain_report)
 
55
switches the top level and the second level report on.  The data is derived
 
56
from the URL.  The output is limited by n.  (-1 is unlimited)
 
57
 
 
58
.TP
 
59
.I --domain-report-limit n ($domain_report_limit)
 
60
limit the domain-report to lines which have n or more requests.
 
61
 
 
62
.TP
 
63
.I --domain-report-n-level|-N n ($domain_report_n_level)
 
64
All URL-Host reports will be switched from 2nd-level to n-level-reports. (-1
 
65
shows a full urlhost-report)
 
66
 
 
67
.B Note:
 
68
This option is only useful with activated domain-report.
 
69
 
 
70
.TP
 
71
.I --errorcode-distribution-report ($errorcode_distribution_report)
 
72
shows the Response code distribution over all objects
 
73
 
 
74
.TP
 
75
.I ($object_freshness_report)
 
76
shows the freshness of objects in your cache.
 
77
.B Calamaris
 
78
looks for freshness tags like 'TCP_HIT', 'TCP_REFRESH_MISS', ...  and make
 
79
statistics on it. With this information you can optimize the caching behaviour
 
80
of your cache depending on the objects content type.  E.g. squid admins could
 
81
use this information to configure the refresh_pattern. This option needs more
 
82
configuration in the configuration-file.
 
83
 
 
84
.TP
 
85
.I --peak-report|-p type ($peak_report)
 
86
Measures the peaks of the Proxy usage in requests per second, per minute and
 
87
per hour.  It reports peaks for TCP, UDP and ALL requests. If set to
51
88
.I 'old'
52
89
these values were calculated with the old slow method, if set to
53
90
.I 'new'
54
91
the new faster (but still slow) method is used.
55
92
 
56
93
.TP
57
 
.I -P n
58
 
performance report: Shows the throughput of TCP requests for every n minutes.
59
 
 
60
 
.TP
61
 
.I -r n
62
 
requester report: Switches the UDP and TCP requester reports on.  The output
63
 
is limited by n.  (-1 is unlimited)
64
 
 
65
 
.TP
66
 
.I -R n
67
 
Requested report: adds to each line of the requester report the requested
68
 
URLs. The output is limited by n.  (-1 is unlimited, and can result in very
69
 
very long reports.)
 
94
.I --performance-report|-P n ($performance_report)
 
95
Shows the throughput of TCP requests for every n minutes.
 
96
 
 
97
.TP
 
98
.I --performance-report-adjust|-T n ($performance_report_adjust)
 
99
Time: Adjust the Performancereport in minutes for non GMT-Timezoners.
 
100
 
 
101
.TP
 
102
.I --requester-report|-r n ($requester_report)
 
103
Switches the UDP and TCP requester reports on.  The output is limited by n.
 
104
(-1 is unlimited)
 
105
 
 
106
.TP
 
107
.I --requester-report-no-dns-lookup|-n ($requester_report_no_dns_lookup)
 
108
Switches the IP lookup for the requesters off.
 
109
 
 
110
.TP
 
111
.I --requester-report-use-user-info|-u ($requester_report_use_user_info)
 
112
Switches the usage of eventually available ident information for requester
 
113
reports on.
 
114
 
 
115
.B Warning:
 
116
This breaks the privacy of your users! (see PRIVACY-Section below)
 
117
 
 
118
.TP
 
119
.I --requester-report-with-targets|-R n ($requester_report_with_targets)
 
120
adds to each line of the requester report the requested URLs. The output is
 
121
limited by n.  (-1 is unlimited, and can result in very very long reports.)
70
122
 
71
123
.B Warning:
72
124
Using this option breaks the privacy of your users! (see PRIVACY-Section
73
125
below)
74
126
 
75
127
.TP
76
 
.I -s
77
 
status report: alters the default behaviour of
 
128
.I --response-time-report ($response_time_report)
 
129
sums up the time distribution over all objects
 
130
 
 
131
.TP
 
132
.I (@response_time_report_interval)
 
133
This array defines the time steps, which should be reported in the
 
134
response-time-report.
 
135
 
 
136
.TP
 
137
.I --size-distribution-report|-D n ($size_distribution_report)
 
138
shows size-based distribution of requested objects, smaller numbers result in
 
139
more verbose reports. (choose 2, 10 or 100 for useful output.)
 
140
 
 
141
.TP
 
142
.I --status-report|-s ($status_report)
 
143
alters the default behaviour of
78
144
.B Calamaris
79
145
and makes the status reports more verbose.
80
146
 
81
147
.TP
82
 
.I -t n
83
 
type report: switches the content type and the file extension report on.  The
84
 
output is limited by n.  (-1 is unlimited)
85
 
 
86
 
.TP
87
 
.I -D n
88
 
Distribution Histogram: shows size-based distribution of requested objects,
89
 
smaller numbers result in more verbose reports. (choose 2, 10 or 100 for
90
 
useful output.)
91
 
 
92
 
Allocation report: shows how different sized objects perform on your Proxy.
93
 
 
94
 
.SS Input Format
95
 
.TP
96
 
.I -f type
97
 
format: sets the type of input logfiles. If set to
 
148
.I --type-report|-t n ($type_report)
 
149
switches the content type and the file extension report on.  The output is
 
150
limited by n.  (-1 is unlimited)
 
151
 
 
152
.TP
 
153
.I --type-report-ignore-case|-c ($type_report_ignore_case)
 
154
Switch to case-insensitive. This is useful for the 'Requested extensions'
 
155
report.
 
156
 
 
157
.SS Input
 
158
.TP
 
159
.I --input-format|-f type ($input_format)
 
160
sets the type of input logfiles. If set to
98
161
 
99
162
.I 'auto'
100
163
.B Calamaris
101
164
tries to guess the input file format.  This is the Default.
102
165
 
103
166
.B Note:
104
 
If the first line of your input file is corrupted, Calamaris will stop with
105
 
an error.
 
167
If the first line of your input file is corrupted,
 
168
.B Calamaris
 
169
will stop with an error.
106
170
 
107
171
.I 'squid'
108
172
.B Calamaris
109
173
expects native logfile derived from
110
 
.B Squid V1.1.beta26-V2.x
111
 
or
 
174
.B Squid
 
175
V1.1.beta26-V2.x or
112
176
.B OOPS.
113
177
 
114
178
.I 'squid-extended'
115
179
.B Calamaris
116
180
expects native logfile derived from
117
 
.B Squid V1.1.alpha1-V2.x
118
 
with
 
181
.B Squid
 
182
V1.1.alpha1-V2.x with
119
183
.I log_mime_hdrs
120
184
enabled or
121
185
.B Squid
122
186
with
123
 
.B Smartfilter-Patch.
 
187
.B Smartfilter-Patch
124
188
or squid-style logfiles out of
125
189
.B Cisco Content Engines.
126
190
(This only enables parsing of these kind of logfile, the additional
132
196
.I 'squid-old'
133
197
.B Calamaris
134
198
expects native logfile derived from
135
 
.B Squid V1.1.alpha1-V1.1.beta25.
 
199
.B Squid
 
200
V1.1.alpha1-V1.1.beta25.
136
201
 
137
202
.I 'nc'
138
203
.B Calamaris
139
204
expects Logfiles from
140
 
.B NetCache up to V4.x.
141
 
(Please see the README on this.)
 
205
.B NetCache
 
206
up to V4.x. (Please see the README on this.)
142
207
 
143
208
.I 'its'
144
209
.B Calamaris
151
216
.B Compaq Tasksmart,
152
217
.B Novell Internet Caching System
153
218
or
154
 
.B NetCache V5.x
155
 
)
 
219
.B NetCache
 
220
V5.x)
156
221
 
157
222
.I 'nse'
158
223
.B Calamaris
159
224
expects Logfiles in Netscape Extended-1 or Netscape Extended-2
160
225
Logfile Format (from
161
 
.B Netscape/ipoint Proxy-Server
 
226
.B Netscape/iPlanet/SunOne Proxy-Server
162
227
)
163
228
 
164
 
.SS Output Format
 
229
.TP
 
230
.I --ipfilter-exclude IP/range ($ipfilter_exclude)
 
231
all IPs are analyzed, except IP/range.
 
232
Format: 1.1.1.1/32:1.1.2.0/24
 
233
1.1.1.1/255.255.255.255:1.1.2.0/255.255.255.0
 
234
 
 
235
IP list separated by ':'
 
236
This switch needs the perl Module NetAddr::IP.
 
237
 
 
238
.B Warning:
 
239
This breaks the privacy of your users! (see PRIVACY-Section below)
 
240
 
 
241
.TP
 
242
.I --ipfilter-include IP/range ($ipfilter_include)
 
243
no IPs are analyzed, except IP/range. Format: see --ipfilter-exclude
 
244
 
 
245
.B Warning:
 
246
This breaks the privacy of your users! (see PRIVACY-Section below)
 
247
 
 
248
.TP
 
249
.I --no-input|-z ($no_input)
 
250
Switches reading from standard input off.  You can use this to merge
 
251
many cache files to one (see
 
252
.I --cache-input-file
 
253
and
 
254
.I --cache-output-file)
 
255
or to generate a report out of cache files.
 
256
 
 
257
.TP
 
258
.I --time-interval|-I t-t ($time_interval)
 
259
defines which time-interval should be parsed.  t has to be the
 
260
format yyyymmddhhmmss (localtime)
 
261
 
 
262
.B Note:
 
263
omitting the beginning or ending date is allowed.
 
264
 
 
265
.SS Output
165
266
Standard output format is plain ascii with 80 chars width.
166
267
 
167
268
.TP
168
 
.I -F type[,type[,type[,...]]]
 
269
.I ($column1_color)
 
270
.I ($column2_color)
 
271
defines the colors for the columns in graphics. (only useful with
 
272
.I --output-format
 
273
graph)
 
274
 
 
275
.TP
 
276
.I ($formats[n])
 
277
Through the config-file you are able to modify the width of the report and
 
278
alter the culomns that are displayed in the reports. n is the number of the
 
279
report, as displayed by --help in the --show-reports-option.
 
280
 
 
281
.TP
 
282
.I --hostname|-H name ($hostname)
 
283
The name for the title or subject of the output.  If set to
 
284
.I 'lookup'
 
285
.B Calamaris
 
286
looks up the host name of the system its been run on.
 
287
 
 
288
.TP
 
289
.I --image-type ($image_type)
 
290
Sets the image type to gif, png, jpeg, gd or gd2. Only useful when
 
291
.I
 
292
--output-format graph
 
293
is set. The available images types are dependend
 
294
on your GD::Graph installation. Default is 'png'.
 
295
 
 
296
.TP
 
297
.I --logo|-l string ($logo)
 
298
add a custom string to a HTML-Report. It'll be added to a table on the
 
299
top of the output.
 
300
.I -l '<A HREF="http://cord.de/"><IMG BORDER=0
 
301
SRC="http://cord.de/Images/cord/cordlog2n.gif" ALT="Cord"></A>'
 
302
will add my logo with a link to the Report.
 
303
 
 
304
.B Note:
 
305
.I --logo
 
306
works only in combination with
 
307
.I --output-format html or html-frame
 
308
 
 
309
.TP
 
310
.I --meta|-M string ($meta)
 
311
Meta: adds a custom string or the content of a file into the <HEAD> of a
 
312
HTML-Report. Useful if you want to add Stylesheets or something to the Report.
 
313
 
 
314
.B Note:
 
315
.I --meta
 
316
works only in combination with
 
317
.I --output-format html or html-frame
 
318
 
 
319
.TP
 
320
.I --output-format|-F type[,type[,type[,...]]] ($output_format)
169
321
Format: sets the format of the output-report. If set to
170
322
 
171
323
.I 'mail'
176
328
.I 'mail'
177
329
to send html mails.
178
330
 
 
331
.I 'html-frame'
 
332
all output is given in html frames with tables.
 
333
 
179
334
.I 'html-embed'
180
335
all output is given in html with tables without HTML-Headers. Useful for
181
336
Server-Side-Includes.
182
337
 
 
338
.I 'graph'
 
339
enables graphics for html, html-embed or html-frame.
 
340
 
183
341
.I 'unformatted'
184
342
gives out the raw numbers seperated by spaces. Useful for re-using the output
185
 
in other scripts. If you use this along with 
 
343
in other scripts. If you use this along with
186
344
.I -U,
187
345
the byte values are calculated in the given Unit, and displayed without
188
346
indication along with the numbers. the indication moves up to the header of
189
347
the report.
190
348
 
191
349
.TP
192
 
.I -M string
193
 
Meta: adds a custom string into the <HEAD> of a HTML-Report. Useful if you
194
 
want to add Stylesheets or something to the Report.
195
 
 
196
 
.B Note:
197
 
.I -M
198
 
works only in combination with
199
 
.IR -F
200
 
html.
201
 
 
202
 
.TP
203
 
.I -l string
204
 
logo: add a custom string to a HTML-Report. It'll be added to a table on the
205
 
top of the output.
206
 
.I -l '<A HREF="http://cord.de/"><IMG BORDER=0 SRC="http://cord.de/Images/cord/cordlog2n.gif" ALT="Cord"></A>'
207
 
will add my logo with a link to the Report.
208
 
 
209
 
.B Note:
210
 
.I -l
211
 
works only in combination with
212
 
.IR -F
213
 
html.
214
 
 
215
 
.TP
216
 
.I -U string
217
 
Unit: You can define this to K(ilo), M(ega), G(iga) or T(era) for
218
 
the Byte-units.
219
 
 
220
 
.TP
221
 
.I -S n[,n[,n[,...]]]
 
350
.I --output-path ($output_path)
 
351
output calamaris statistics to /path. In case of graph output, the graphics
 
352
destination is /path and the filename is index.html, else it is calamaris.txt.
 
353
If
 
354
.I --output-path
 
355
is not given, all graphics are written to the working directory.
 
356
 
 
357
.TP
 
358
.I --output-file ($output_file)
 
359
alter the filename of --output-path.
 
360
 
 
361
.TP
 
362
.I --output-file-prefix ($output_file_prefix)
 
363
adds a prefix to 
 
364
.I --output-file
 
365
.
 
366
.I %t
 
367
is replaced by the timerange of the report, 
 
368
.I %h
 
369
by the hostname (see
 
370
.I --hostname
 
371
)
 
372
 
 
373
.TP
 
374
.I --show-reports|-S n[,n[,n[,...]]] ($show_reports)
222
375
Show: Shows only the defined reports in the specified order. Default is to
223
376
display the reports as they are defined through the report-switches above. The
224
377
following numbers are defined:
230
383
1  Incoming request peak per protocol
231
384
.RE
232
385
.RS
233
 
2  Incoming transfer volume per protocol
 
386
2  Incoming transfer volume peak per protocol
234
387
.RE
235
388
.RS
236
389
3  Incoming requests by method
269
422
14 Incoming TCP-requests by host
270
423
.RE
271
424
.RS
272
 
15 Distribution Histogram
273
 
.RE
274
 
.RS
275
 
16 Performance in  minute steps
 
425
15 Size Distribution Diagram
 
426
.RE
 
427
.RS
 
428
16 Performance in n minute steps
 
429
.RE
 
430
.RS
 
431
17 UDP-Request duration distribution in msec
 
432
.RE
 
433
.RS
 
434
18 TCP-Request duration distribution in msec
 
435
.RE
 
436
.RS
 
437
19 UDP Response code distribution
 
438
.RE
 
439
.RS
 
440
20 TCP Response code distribution
 
441
.RE
276
442
 
277
443
.B Note:
278
444
Using this doesn't make
279
445
.B Calamaris
280
 
any faster, the internal calculations will
281
 
be done as the report-switches were set (see above).
 
446
any faster, the internal calculations will be done as the report-switches
 
447
were set (see above).
 
448
 
 
449
.TP
 
450
.I --sort-order|-O ($sort_order)
 
451
Changes the sort order in the reports to request size, default is
 
452
sorting by number of requests.
 
453
 
 
454
.TP
 
455
.I ($text_color)
 
456
defines the colors for text/axis/legend/labels in graphics. (only useful with
 
457
.I --output-format graph
 
458
)
 
459
 
 
460
.TP
 
461
.I --unit|-U string ($unit)
 
462
You can define this to K(ilo), M(ega), G(iga) or T(era) for the Byte-units.
 
463
 
 
464
.TP
 
465
.I ($width)
 
466
defines the width of the graphics. height is calculated from this with a
 
467
3:2-ratio. (only useful with
 
468
.I --output-format graph
 
469
)
 
470
 
 
471
.TP
 
472
.I ($x_scale)
 
473
defines how many datasets should be drawn on the graph. 30 is a good value,
 
474
but you can play with this. if $x_scale gets to big, you're on your own ;-)
 
475
 
 
476
.TP
 
477
.I --generate-index ($generate_index)
 
478
generates an index for all reports that match 
 
479
.I --output-file-prefix.
282
480
 
283
481
.SS Caching
284
482
 
285
483
.TP
286
 
.I -i file
287
 
input file: You can reuse a cache file generated with
288
 
.I -o file
 
484
.I --cache-input-file|-i file ($cache_input_file)
 
485
You can reuse a cache file generated with
 
486
.I --cache-output-file file
289
487
to add old data to a new report.  Several files can be seperated with a ':'.
290
488
 
291
489
.B Note:
295
493
.B Note:
296
494
if you reuse cache-files, which were not created with
297
495
.I -d -1 -r -1 -t -1 -R -1
298
 
the number of 'others' is likely wrong everywhere.
 
496
the number of 'others' would be wrong everywhere. In this 
 
497
case the number of 'others' are omitted.
299
498
 
300
499
.TP
301
 
.I -o file
302
 
output file:
 
500
.I --cache-output-file|-o file ($cache_output_file)
303
501
.B Calamaris
304
502
stores a summary of the computed information in
305
503
.I file
306
504
and you can reuse it at a later time with
307
 
.IR -i .
 
505
.I --cache-input-file
 
506
.
308
507
 
309
508
.B Note:
310
509
The output file can be the same as the input file: it is simply overwritten
315
514
.SS Misc
316
515
 
317
516
.TP
318
 
.I -H name
319
 
Host name: The name for the title or subject of the output.  If set to
320
 
.I 'lookup'
321
 
.B Calamaris
322
 
looks up the host name of the system its been run on.
323
 
 
324
 
.TP
325
 
.I -n
326
 
no lookup: Switches the IP lookup for the requesters off.
327
 
 
328
 
.TP
329
 
.I -O
330
 
Order: Changes the sort order in the reports to request size, default is
331
 
sorting by number of requests.
332
 
 
333
 
.TP
334
 
.I -I t-t  
335
 
Interval: defines which time-interval should be parsed.  t has to be the
336
 
format yyyymmddhhmmss
337
 
 
338
 
.B Note:
339
 
omitting the beginning or ending date is allowed.
340
 
 
341
 
.TP
342
 
.I -N
343
 
N-level: All URL-Host reports will be switched from 2nd-level to
344
 
N-level-reports. (-1 shows a full urlhost-report)
345
 
 
346
 
.B Note:
347
 
This option is only useful with activated domain-report.
348
 
 
349
 
.TP
350
 
.I -T n
351
 
Time: Adjust the Performancereport in minutes for non GMT-Timezoners.
352
 
 
353
 
.TP
354
 
.I -c
355
 
case: Switch to case-insensitive. This is useful for
356
 
the 'Requested extensions' report.
357
 
 
358
 
.TP
359
 
.I -u
360
 
user: Switches the usage of eventually available ident information for
361
 
requester reports on.
362
 
 
363
 
.B Warning:
364
 
This breaks the privacy of your users! (see PRIVACY-Section below)
365
 
 
366
 
.TP
367
 
.I -z
368
 
zero: Switches reading from standard input off.  You can use this to merge
369
 
many cache files to one (see
370
 
.I -i
371
 
and
372
 
.IR -o )
373
 
or to generate a report out of cache files.
374
 
 
375
 
.TP
376
 
.I -b n
 
517
.I --benchmark|-b n ($benchmark)
377
518
benchmark: A switch for the impatient as it prints a '#' for every n parsed
378
519
lines.
379
520
 
380
521
.TP
381
 
.I -v
382
 
verbose: print more information about what is Calamaris is doing
383
 
and believing.
384
 
 
385
 
.TP
386
 
.I -L
387
 
Loop: prints the internal loop to STDERR. (for Debugging)
388
 
 
389
 
.TP
390
 
.I -C
391
 
Copyright: Prints the copyright information of
392
 
.BR Calamaris .
393
 
 
394
 
.TP
395
 
.I -h
396
 
help: Prints a brief description of the command line options.
397
 
 
398
 
.TP
399
 
.I -V
400
 
Version: Prints out the Version-Number.
401
 
 
402
 
.SH EXAMPLES
403
 
 
 
522
.I --copyright|-C
 
523
Prints the copyright information of
 
524
.B Calamaris
 
525
.
 
526
 
 
527
.TP
 
528
.I --help|-h
 
529
Prints a brief description of the command line options.
 
530
 
 
531
.TP
 
532
.I --version|-V
 
533
Prints out the Version-Number.
 
534
 
 
535
.SS Debug
 
536
 
 
537
.TP
 
538
.I --dump-loop|-L
 
539
prints the internal loop to STDERR. (for Debugging)
 
540
 
 
541
.TP
 
542
.I ($test)
 
543
activates some small tests for the programmer.
 
544
 
 
545
.TP
 
546
.I --verbose|-v ($verbose)
 
547
print more information about what is Calamaris is doing and believing.
 
548
 
 
549
.SH "EXAMPLES"
404
550
.TP
405
551
This example mails the daily statistics to root:
406
552
cat /var/log/squid/access.log | nice -39
407
553
.B calamaris
408
 
-aH 'daily worf' -F mail | mail root
 
554
.I --all-useful-reports
 
555
.I --hostname
 
556
'daily worf'
 
557
.I --output-format
 
558
mail | mail root
409
559
 
410
560
.TP
411
561
This one only caches a summary for later use:
412
562
cat /var/log/squid/access.log |
413
563
.B calamaris
414
 
-a -o daily.`date +"%w"` > /dev/null
 
564
--all-useful-reports --cache-output-file daily.`date +"%w"` > /dev/null
415
565
 
416
566
.TP
417
567
You can then use the caches to have weekly statistics:
418
568
 
419
569
if [ $DAYOFWEEK = "0" ]; then
420
570
.B calamaris
421
 
-a -i daily.1:daily.2:daily.3:daily.4:daily.5:daily.6:daily.0 -z -F mail -H "weekly worf" | mail root ;
 
571
--all-useful-reports --cache-input-file daily.1:daily.2:daily.3:daily.4:daily.5:daily.6:daily.0 --no-input --output-format mail --hostname "weekly worf" | mail root ;
422
572
fi
423
573
 
424
 
.SH BUGS
 
574
.SH "BUGS"
425
575
If you have a problem with
426
 
.BR Calamaris ,
427
 
please make sure that you use the recent version of
 
576
.B Calamaris
 
577
, please make sure that you use the recent version of
428
578
.B Calamaris
429
579
(see VERSION below). Also check that your proxy works correctly and doesn't
430
580
produce invalid Logfiles. (see the README for buglist and pointers.)
431
581
 
432
 
If you're sure that you've encountered a bug in Calamaris, please report it to
433
 
Calamaris-bug@cord.de. This also applies if Calamaris itself says 'please
434
 
report this'.
435
 
 
436
 
.SH PRIVACY
437
 
 
 
582
If you're sure that you've encountered a bug in
 
583
.B Calamaris
 
584
please report it to Calamaris-bug@cord.de. This also applies if
 
585
.B Calamaris
 
586
itself says 'please report this'.
 
587
 
 
588
.SH "PRIVACY"
438
589
.B Calamaris
439
590
can be (mis-)used to track what users are requesting.
440
591
 
456
607
 
457
608
.TP
458
609
-
459
 
If you still want to use Calamaris that way, let your vict^Wusers
460
 
know, that they'll be monitored. (in Germany you have to let them
461
 
know!)
 
610
If you still want to use
 
611
.B Calamaris
 
612
that way, let your vict^Wusers know, that they'll be monitored. (in Germany you
 
613
have to let them know!)
462
614
 
463
615
.SH "SEE ALSO"
464
616
.B squid(8)
465
617
 
466
 
.SH AUTHOR
467
 
Cord Beermann <Cord@Wunder-Nett.org>. There are also a lot of people who
468
 
contributed code, gave ideas or requested features. Look them up in the
469
 
executable.
 
618
.SH "AUTHOR"
 
619
Cord Beermann <Cord@Wunder-Nett.org>,
 
620
Michael Pophal <michael.pophal@nefkom.net>.
 
621
There are also a lot of people who contributed code, gave ideas or requested
 
622
features. Look them up in the executable.
470
623
 
471
624
This man page was written by Philipp Frauenfelder <pfrauenf@debian.org>,
472
625
maintainer of the Debian package.  Maintenance is now taken over by
473
626
Cord Beermann.
474
627
 
475
 
.SH VERSION
476
 
 
477
 
Version of this manpage: $Id: calamaris.1,v 1.28 2003/05/14 21:22:37 cord Exp $
478
 
 
479
 
It describes the usage of Calamaris V2.58 and later.
 
628
.SH "VERSION"
 
629
Version of this manpage: $Id: calamaris.1,v 3.1 2006-03-19 17:52:48 cord Exp $
 
630
 
 
631
It describes the usage of Calamaris V3.0 and later.
480
632
 
481
633
Information about new releases, mailing lists, and other related issues
482
634
can be found from the
483
635
.B Calamaris
484
 
home page at http://Calamaris.Cord.de/
 
636
home page at 
 
637
.URL http://Calamaris.Cord.de/
485
638
 
486
 
.SH WARRANTY
 
639
.SH "WARRANTY"
487
640
.B Calamaris
488
641
comes with "absolutely no warranty".
489
642
 
490
 
.SH COPYRIGHT
491
 
Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003 Cord Beermann
 
643
.SH "COPYRIGHT"
 
644
Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Cord Beermann
492
645
 
493
646
This program is free software; you can redistribute it and/or modify it under
494
647
the terms of the GNU General Public License as published by the Free Software
496
649
version.
497
650
 
498
651
(If you modify and want to publish it under the name
499
 
.BR Calamaris ,
500
 
please ask me.  I don't want to confuse the 'audience' with many different
 
652
.B Calamaris
 
653
, please ask me.  I don't want to confuse the 'audience' with many different
501
654
versions of the same name and/or Version number.  (This is not part of the
502
655
license, it is only a favour i asked of you.))
503
656