Update example URL for FreeBSD port update.
[darkstat] / darkstat.8.in
index bece1b7..40b957d 100644 (file)
@@ -1,11 +1,11 @@
 .\"
 .\" darkstat 3
-.\" Copyright 2001-2010, Emil Mikulic.
+.\" Copyright 2001-2014, Emil Mikulic.
 .\"
 .\" 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 "June 2011" "@PACKAGE_STRING@"
 .SH NAME
 darkstat \- network statistics gatherer
 .\"
@@ -38,10 +38,14 @@ darkstat \- network statistics gatherer
 ] [
 .BI \-b " bindaddr"
 ] [
+.BI \-\-base " path"
+] [
 .BI \-f " filter"
 ] [
 .BI \-l " network/netmask"
 ] [
+.BI \-\-local\-only
+] [
 .BI \-\-chroot " dir"
 ] [
 .BI \-\-user " username"
@@ -167,6 +171,25 @@ Bind the web interface to the specified address.
 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 (i.e. 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;
@@ -188,6 +211,11 @@ See the usage example below.
 .RE
 .\"
 .TP
+.BI \-\-local\-only
+Make the web interface only display hosts on the "local network."
+This is intended to be used together with the \fB\-l\fR argument.
+.\"
+.TP
 .BI \-\-chroot " dir"
 Force \fIdarkstat\fR to \fBchroot()\fR into the specified directory.
 Without this argument, a default directory will be used, which is
@@ -443,4 +471,4 @@ cable Internet provider introducing a 3GB monthly traffic limit.
 Emil Mikulic and others. (see the AUTHORS file)
 .\"
 .SH WEBSITE
-http://dmr.ath.cx/net/darkstat/
+@PACKAGE_URL@