Browse code

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>

Gert van Dijk authored on 2017/11/12 01:11:21
Showing 1 changed files
... ...
@@ -2460,12 +2460,37 @@ seconds.
2460 2460
 Status can also be written to the syslog by sending a
2461 2461
 .B SIGUSR2
2462 2462
 signal.
2463
+
2464
+With multi\-client capability enabled on a server, the status file includes a
2465
+list of clients and a routing table. The output format can be controlled by the
2466
+.B \-\-status\-version
2467
+option in that case.
2468
+
2469
+For clients or instances running in point\-to\-point mode, it will contain the
2470
+traffic statistics.
2463 2471
 .\"*********************************************************
2464 2472
 .TP
2465 2473
 .B \-\-status\-version [n]
2466
-Choose the status file format version number.  Currently
2467
-.B n
2468
-can be 1, 2, or 3 and defaults to 1.
2474
+Set the status file format version number to
2475
+.B n\fR.
2476
+
2477
+This only affects the status file on servers with multi\-client capability
2478
+enabled.
2479
+
2480
+.B 1
2481
+\-\- traditional format (default). The client list contains the following
2482
+fields comma\-separated: Common Name, Real Address, Bytes Received, Bytes Sent,
2483
+Connected Since.
2484
+.br
2485
+.B 2
2486
+\-\- a more reliable format for external processing. Compared to version 1, the
2487
+client list contains some additional fields: Virtual Address, Virtual IPv6
2488
+Address, Username, Client ID, Peer ID.
2489
+Future versions may extend the number of fields.
2490
+.br
2491
+.B 3
2492
+\-\- identical to 2, but fields are tab\-separated.
2493
+
2469 2494
 .\"*********************************************************
2470 2495
 .TP
2471 2496
 .B \-\-mute n