Pull in darkstat-3.0.718

[darkstat-debian] / darkstat.8.in

diff --git a/darkstat.8.in b/darkstat.8.in
index e786af3..9b5a0b4 100644 (file)
--- a/darkstat.8.in
+++ b/darkstat.8.in
@@ -1,6 +1,6 @@
 .\"
 .\" darkstat 3
-.\" Copyright 2001-2011, 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)
@@ -38,6 +38,8 @@ darkstat \- network statistics gatherer
 ] [
 .BI \-b " bindaddr"
 ] [
+.BI \-\-base " path"
+] [
 .BI \-f " filter"
 ] [
 .BI \-l " network/netmask"
@@ -169,11 +171,30 @@ 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;
 please refer to the
-.BR tcpdump (1)
+.BR tcpdump (8)
 documentation.
 .\"
 .TP
@@ -381,7 +402,7 @@ darkstat \-i fxp0 \-f "not (src net 192.168.0 and dst net 192.168.0)"
 .PP
 .\"
 (For a full reference on filter syntax, refer to the
-.BR tcpdump (1)
+.BR tcpdump (8)
 manpage)
 .PP
 .\"
@@ -439,7 +460,7 @@ You can also use it to do accounting for a whole subnet by specifying
 an appropriate netmask.
 .\"
 .SH SEE ALSO
-.BR tcpdump (1)
+.BR tcpdump (8)
 .\"
 .SH HISTORY
 .I darkstat