← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netams/quantal

« back to all changes in this revision

Viewing changes to .pc/05_manpage_whatis.diff/doc/netams.8

  • Committer: Bazaar Package Importer
  • Author(s): Alexander GQ Gerasiov
  • Date: 2010-07-24 16:37:01 UTC
  • mfrom: (2.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20100724163701-rni105xlqseqe26h
Tags: 3.4.5-2
http://bugs.debian.org/576026
* debian/Rules.make: Add -lcrypto to fix FTBFS with binutils-gold.
* debian/netams.postinst: Fix some sed magic in netams.conf
  processing.
* debian/control: Standards version updated.
* Vietnamese translation added. Closes: #576026. Thanks to Clytie
  Siddall.

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/05_manpage_whatis.diff/doc/netams.8
1
 
.\" -*-nroff-*-
2
 
.\" $Id: netams.8,v 1.8 2008-01-03 12:44:53 anton Exp $
3
 
.TH NETAMS 8 "24 November 2004"
4
 
 
5
 
.SH NAME
6
 
NeTAMS is a Network Traffic Accounting and Monitoring Software.
7
 
 
8
 
.SH SYNOPSIS
9
 
.B netams
10
 
[\-dlq]
11
 
[
12
 
-f <config-file>
13
 
]
14
 
 
15
 
.SH DESCRIPTION
16
 
.B NeTAMS
17
 
is a Network Traffic Accounting and Monitoring Software. It works as a
18
 
daemon for FreeBSD, Linux and Solaris operating systems. Supported traffic 
19
 
information sources are tee/divert/ip_queue/libpcap/netflow v5; storages are
20
 
BerkleyDB/MySQL/PostgresSQL. Various aggregation, vizualisation and notification
21
 
ways are implemented. Authorization, quotas, bandwidth control, flexible accounting and
22
 
blocking policies are also here.
23
 
 
24
 
.SH OPTIONS
25
 
.IP "-d" 
26
 
do not become daemon
27
 
.IP "-f config-file"
28
 
.I config-file
29
 
specifies an alternate configuration file to use. 
30
 
.IP "-l"
31
 
turn logging to file on
32
 
.IP "-L"
33
 
turn logging to syslog on
34
 
.IP "-p pid-file"
35
 
.I pid-file
36
 
specifies an alternate pid file to use.
37
 
.IP "-P"
38
 
do not create a pid file (by default, pid file created while options -l or -L used)
39
 
.IP "-q"
40
 
do not produce any output
41
 
 
42
 
.SH SYSTEM REQUIREMENTS
43
 
You can run NeTAMS in three different modes depending on data source type:
44
 
 
45
 
.B libpcap
46
 
allows you to capture all traffic on specified interface, exactly
47
 
as tcpdump does.
48
 
 
49
 
.B netflow
50
 
collects all NetFlow v5 UDP packets coming from Cisco router or external flow producer like 
51
 
flowprobe/ipfw2netflow/ng_netflow. You don't need in any additional system features 
52
 
to run libpcap or netflow accounting, but you cannot do any filtering with these data sources.
53
 
 
54
 
.B divert or ipq
55
 
captures all IP traffic going via your UNIX router, and you need to prepare system for that.
56
 
 
57
 
If you system is FreeBSD, your kernel configuration must have:
58
 
 
59
 
.br
60
 
options IPFIREWALL
61
 
.br
62
 
options IPDIVERT
63
 
 
64
 
otherwise you will be not able to pass data packets to the program. Type
65
 
"dmesg" and have a look.
66
 
 
67
 
If you have Linux, you must use kernels 2.4.* or above, and iptables. Your
68
 
system must have netfilter package and libipq library properly installed;
69
 
both are typically not in a default installation. You should visit
70
 
http://www.netfilter.org site, read the documentation, download, install it
71
 
and rebuild a kernel. Or at least check 'modprobe ip_queue'.
72
 
 
73
 
For a serious work, install the SQL database, 
74
 
http://www.mysql.com or http://postgresql.org, and do
75
 
not use unix hash database from libdb (also supported by NeTAMS).
76
 
 
77
 
.SH SIGNALS
78
 
.TP
79
 
.B SIGHUP
80
 
or
81
 
.B SIGUSR1
82
 
will cause log file to be closed and opened again.
83
 
Useful for logrotate.
84
 
.TP
85
 
.B SIGQUIT
86
 
will terminate the program safely.
87
 
 
88
 
.SH FILES
89
 
.TP
90
 
.B /var/lib/netams/netams.conf (symlink /etc/netams/netams.conf points to it)
91
 
Main configuration file.
92
 
.TP
93
 
.B /etc/init.d/netams
94
 
Startup script.
95
 
.TP
96
 
.B /var/log/netams.log
97
 
Daemon logs.
98
 
 
99
 
.SH SEE ALSO
100
 
.BR http://www.netams.com
101
 
 
102
 
.SH AUTHORS
103
 
Anton Vinokurov <anton@netams.com>, Yuriy Shkandybin <jura@netams.com>