Use PACKAGE_URL.
[darkstat] / darkstat.8.in
index 471f0a1..477f198 100644 (file)
@@ -5,7 +5,7 @@
 .\" You may use, modify and redistribute this file under the terms of the
 .\" GNU General Public License version 2. (see COPYING.GPL)
 .\"
 .\" You may use, modify and redistribute this file under the terms of the
 .\" GNU General Public License version 2. (see COPYING.GPL)
 .\"
-.TH darkstat 8 "March 2010" "@PACKAGE_STRING@"
+.TH darkstat 8 "September 2010" "@PACKAGE_STRING@"
 .SH NAME
 darkstat \- network statistics gatherer
 .\"
 .SH NAME
 darkstat \- network statistics gatherer
 .\"
@@ -38,6 +38,8 @@ darkstat \- network statistics gatherer
 ] [
 .BI \-b " bindaddr"
 ] [
 ] [
 .BI \-b " bindaddr"
 ] [
+.BI \-\-base " path"
+] [
 .BI \-f " filter"
 ] [
 .BI \-l " network/netmask"
 .BI \-f " filter"
 ] [
 .BI \-l " network/netmask"
@@ -167,6 +169,25 @@ Bind the web interface to the specified address.
 The default is to listen on all interfaces.
 .\"
 .TP
 The default is to listen on all interfaces.
 .\"
 .TP
+.BI \-\-base " path"
+.RS
+Specify the path of the base URL.
+This can be useful if \fIdarkstat\fR is accessed via a reverse proxy.
+
+For example, if you use Apache's \fImod_proxy\fR and want to avoid a
+complicated setup with \fImod_proxy_html\fR (and \fImod_header\fR to unset
+the \fIAccept-Encoding\fR header), just set the base path to something like
+\fIstats\fR and use a config similar to the following snippet:
+
+.IP
+ ProxyPass /stats/ http://localhost:667/stats/
+ ProxyPassReverse /stats/ http://localhost:667/stats/
+.PP
+
+The default is \fI/\fR (ie. the root).
+.RE
+.\"
+.TP
 .BI \-f " filter"
 Use the specified filter expression when capturing traffic.
 The filter syntax is beyond the scope of this manual page;
 .BI \-f " filter"
 Use the specified filter expression when capturing traffic.
 The filter syntax is beyond the scope of this manual page;
@@ -248,7 +269,8 @@ database.
 .\"
 .TP
 .BI \-\-export " filename"
 .\"
 .TP
 .BI \-\-export " filename"
-On shutdown, and upon receiving SIGUSR1, export the in-memory database
+On shutdown, or upon receiving SIGUSR1 or SIGUSR2,
+export the in-memory database
 to the named file, relative to the chroot directory.
 If you wish to use \fB\-\-export\fR, you must first specify a
 \fB\-\-chroot\fR directory, and it must be writeable by the
 to the named file, relative to the chroot directory.
 If you wish to use \fB\-\-export\fR, you must first specify a
 \fB\-\-chroot\fR directory, and it must be writeable by the
@@ -404,6 +426,7 @@ Sending the SIGUSR1 signal will cause \fIdarkstat\fR to empty out its
 in-memory database.
 If an \fB\-\-export\fR file was set, it will first save the database to
 file.
 in-memory database.
 If an \fB\-\-export\fR file was set, it will first save the database to
 file.
+Sending SIGUSR2 will save the database without emptying it.
 .PP
 .\"
 .SH FREQUENTLY ASKED QUESTIONS
 .PP
 .\"
 .SH FREQUENTLY ASKED QUESTIONS
@@ -441,4 +464,4 @@ cable Internet provider introducing a 3GB monthly traffic limit.
 Emil Mikulic and others. (see the AUTHORS file)
 .\"
 .SH WEBSITE
 Emil Mikulic and others. (see the AUTHORS file)
 .\"
 .SH WEBSITE
-http://dmr.ath.cx/net/darkstat/
+@PACKAGE_URL@