Implement and document --syslog
[darkstat] / darkstat.8
index b095653..081b723 100644 (file)
@@ -1,6 +1,6 @@
 .\"
 .\" darkstat 3
-.\" Copyright 2001-2008, Emil Mikulic.
+.\" Copyright 2001-2009, Emil Mikulic.
 .\"
 .\" You may use, modify and redistribute this file under the terms of the
 .\" GNU General Public License version 2. (see COPYING.GPL)
@@ -16,8 +16,12 @@ darkstat \- network statistics gatherer
 ] [
 .BI \-r " file"
 ] [
+.BI \-\-snaplen " bytes"
+] [
 .BI \-\-pppoe
 ] [
+.BI \-\-syslog
+] [
 .BI \-\-verbose
 ] [
 .BI \-\-no\-daemon
@@ -28,6 +32,8 @@ darkstat \- network statistics gatherer
 ] [
 .BI \-\-no\-macs
 ] [
+.BI \-\-no\-lastseen
+] [
 .BI \-p " port"
 ] [
 .BI \-b " bindaddr"
@@ -57,6 +63,8 @@ darkstat \- network statistics gatherer
 .BI \-\-ports\-keep " count"
 ] [
 .BI \-\-highest\-port " port"
+] [
+.BI \-\-hexdump
 ]
 .\"
 .SH DESCRIPTION
@@ -87,6 +95,12 @@ and
 arguments are mutually exclusive.
 .\"
 .TP
+.BI \-\-snaplen " bytes"
+How many bytes to capture of the start of each packet.
+You should not need to specify this;
+\fIdarkstat\fR will calculate it automatically.
+.\"
+.TP
 .BI \-\-pppoe
 Don't use this.
 .RS
@@ -103,8 +117,16 @@ argument.
 .RE
 .\"
 .TP
+.BI \-\-syslog
+Errors, warnings, and verbose messages will go to \fBsyslog\fR (facility
+daemon, priority debug) instead of \fBstderr\fR.
+
+On some systems, these messages end up in \fB/var/log/debug\fR or
+\fBdebug.log\fR by default.
+.\"
+.TP
 .BI \-\-verbose
-Print debugging messages to the terminal.
+Output verbose debugging messages.
 .\"
 .TP
 .BI \-\-no\-daemon
@@ -127,7 +149,11 @@ as an extra process is created for DNS resolving.
 .\"
 .TP
 .BI \-\-no\-macs
-Do not display MAC addresses in hosts table.
+Do not display MAC addresses in the hosts table.
+.\"
+.TP
+.BI \-\-no\-lastseen
+Do not display the last seen time in the hosts table.
 .\"
 .TP
 .BI \-p " port"
@@ -290,6 +316,11 @@ for.
 This can be used to hide ephemeral ports.
 By default, all ports are tracked.
 .\"
+.TP
+.BI \-\-hexdump
+Show hex dumps of received traffic.
+This is only for debugging, and implies \-\-verbose and \-\-no\-daemon.
+.\"
 .\" --------------------------------------------------------------------
 .SH USAGE EXAMPLES
 To gather statistics on the