| Message ID | 20171111161122.30087-1-gert@gertvandijk.net |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [Openvpn-devel,1/2] manpage: improve description of --status and --status-version | expand |
Hi, A very welcome improvement of the man page, but one consideration: On 11-11-17 17:11, Gert van Dijk wrote: > Signed-off-by: Gert van Dijk <gert@gertvandijk.net> > --- > doc/openvpn.8 | 31 ++++++++++++++++++++++++++++--- > 1 file changed, 28 insertions(+), 3 deletions(-) > > diff --git a/doc/openvpn.8 b/doc/openvpn.8 > index a4189ac2..267497fd 100644 > --- a/doc/openvpn.8 > +++ b/doc/openvpn.8 > @@ -2452,12 +2452,37 @@ seconds. > Status can also be written to the syslog by sending a > .B SIGUSR2 > signal. > + > +With multi\-client capability enabled on a server, the status file includes a Although 'server mode' is somewhat ambiguous, that is what most of the man page uses. So I'd suggest to change this to 'In server mode, ...'. (With 'server mode' we mean '--mode server' as described in the 'Server mode' section, but some might interpret 'tls-server' or 'tcp-server' as a 'server mode'.) -Steffan ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot
Acked-by: Gert Doering <gert@greenie.muc.de> Documentation is always welcome, and the new text is an improvement. Your patch has been applied to the master and release/2.4 branch. commit 308c9d7f001a97daebcccf503f255947c0e09183 (master) commit 5213573f7d6ba41639edc362801efe076906a7e4 (release/2.4) Author: Gert van Dijk Date: Sat Nov 11 17:11:21 2017 +0100 manpage: improve description of --status and --status-version Signed-off-by: Gert van Dijk <gert@gertvandijk.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20171111161122.30087-1-gert@gertvandijk.net> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg15818.html Signed-off-by: Gert Doering <gert@greenie.muc.de> -- kind regards, Gert Doering ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot
diff --git a/doc/openvpn.8 b/doc/openvpn.8 index a4189ac2..267497fd 100644 --- a/doc/openvpn.8 +++ b/doc/openvpn.8 @@ -2452,12 +2452,37 @@ seconds. Status can also be written to the syslog by sending a .B SIGUSR2 signal. + +With multi\-client capability enabled on a server, the status file includes a +list of clients and a routing table. The output format can be controlled by the +.B \-\-status\-version +option in that case. + +For clients or instances running in point\-to\-point mode, it will contain the +traffic statistics. .\"********************************************************* .TP .B \-\-status\-version [n] -Choose the status file format version number. Currently -.B n -can be 1, 2, or 3 and defaults to 1. +Set the status file format version number to +.B n\fR. + +This only affects the status file on servers with multi\-client capability +enabled. + +.B 1 +\-\- traditional format (default). The client list contains the following +fields comma\-separated: Common Name, Real Address, Bytes Received, Bytes Sent, +Connected Since. +.br +.B 2 +\-\- a more reliable format for external processing. Compared to version 1, the +client list contains some additional fields: Virtual Address, Virtual IPv6 +Address, Username, Client ID, Peer ID. +Future versions may extend the number of fields. +.br +.B 3 +\-\- identical to 2, but fields are tab\-separated. + .\"********************************************************* .TP .B \-\-mute n
Signed-off-by: Gert van Dijk <gert@gertvandijk.net> --- doc/openvpn.8 | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-)