From patchwork Sat Nov 11 05:11:21 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gert van Dijk X-Patchwork-Id: 64 Return-Path: Delivered-To: patchwork@openvpn.net Delivered-To: patchwork@openvpn.net Received: from director5.mail.ord1d.rsapps.net ([172.30.191.6]) by backend31.mail.ord1d.rsapps.net (Dovecot) with LMTP id vej0A0shB1pdZwAAgoeIoA for ; Sat, 11 Nov 2017 11:11:55 -0500 Received: from proxy8.mail.ord1d.rsapps.net ([172.30.191.6]) by director5.mail.ord1d.rsapps.net (Dovecot) with LMTP id ybISDEshB1oxCgAAsdCWiw ; Sat, 11 Nov 2017 11:11:55 -0500 Received: from smtp17.gate.ord1d ([172.30.191.6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) by proxy8.mail.ord1d.rsapps.net (Dovecot) with LMTP id xbjWAEshB1psBQAAGdz6CA ; Sat, 11 Nov 2017 11:11:55 -0500 X-Spam-Threshold: 95 X-Spam-Score: 0 X-Spam-Flag: NO X-Virus-Scanned: OK X-Orig-To: openvpnslackdevel@openvpn.net X-Originating-Ip: [216.34.181.88] Authentication-Results: smtp17.gate.ord1d.rsapps.net; iprev=pass policy.iprev="216.34.181.88"; spf=pass smtp.mailfrom="openvpn-devel-bounces@lists.sourceforge.net" smtp.helo="lists.sourceforge.net"; dkim=fail (signature verification failed) header.d=sourceforge.net; dkim=fail (signature verification failed) header.d=sf.net; dmarc=none (p=nil; dis=none) header.from=gertvandijk.net X-Classification-ID: 08d48484-c6fb-11e7-bcba-5254008de1cb-1-1 Received: from [216.34.181.88] ([216.34.181.88:21628] helo=lists.sourceforge.net) by smtp17.gate.ord1d.rsapps.net (envelope-from ) (ecelerity 4.2.1.56364 r(Core:4.2.1.14)) with ESMTPS (cipher=DHE-RSA-AES256-GCM-SHA384) id DC/07-20312-A41270A5; Sat, 11 Nov 2017 11:11:54 -0500 Received: from localhost ([127.0.0.1] helo=sfs-ml-2.v29.ch3.sourceforge.com) by sfs-ml-2.v29.ch3.sourceforge.com with esmtp (Exim 4.89) (envelope-from ) id 1eDYNS-0003jG-Ow; Sat, 11 Nov 2017 16:11:26 +0000 Received: from sfi-mx-4.v28.ch3.sourceforge.com ([172.29.28.194] helo=mx.sourceforge.net) by sfs-ml-2.v29.ch3.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.89) (envelope-from ) id 1eDYNR-0003j7-6u for openvpn-devel@lists.sourceforge.net; Sat, 11 Nov 2017 16:11:25 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; h=Message-Id:Date:Subject:To:From:Sender:Reply-To:Cc: MIME-Version:Content-Type:Content-Transfer-Encoding:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=IpCx+RzzlGJewRxokywQqkVLqYLA/RHwAGbpdp1TVC4=; b=JbHmEASSZG6dLtY/3zRKeYWwZI +I19s6PeInjOwq3R1J4xB5xskpOzlEd8u+E10g0+xl10B0vrrJqxfKcNvpOsmoca4WafsSZ1kVtZK nwjuerT4AITMgnUq/HwNaq9KIjcVg5ZkjYvBNsKU2UJSand1McIRIsgMhExDKnSUBKDM=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=Message-Id:Date:Subject:To:From:Sender:Reply-To:Cc:MIME-Version: Content-Type:Content-Transfer-Encoding:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: In-Reply-To:References:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=IpCx+RzzlGJewRxokywQqkVLqYLA/RHwAGbpdp1TVC4=; b=eAiEvzumTfPj/JvoaERpqLnl3f DvWUThgEUIGWzua18H5xoB5RT6ZTl92CzuvleqafKtvfNS9S36qyJzdhImvJMYnZJ19290iej1v8r St6N00fazhgt+sOjKB6+BOqNmV/KKA9MNEgWiDsbAfMM/AabYVvR5f7U7AEGSJUTUQcA=; Received: from droplet1.do.gertvandijk.net ([95.85.39.237]) by sfi-mx-4.v28.ch3.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128) (Exim 4.89) id 1eDYNP-0003VI-89 for openvpn-devel@lists.sourceforge.net; Sat, 11 Nov 2017 16:11:25 +0000 From: Gert van Dijk To: openvpn-devel@lists.sourceforge.net Date: Sat, 11 Nov 2017 17:11:21 +0100 Message-Id: <20171111161122.30087-1-gert@gertvandijk.net> X-Spam-Report: Spam Filtering performed by mx.sourceforge.net. See http://spamassassin.org/tag/ for more details. -0.0 SPF_PASS SPF: sender matches SPF record -0.0 RP_MATCHES_RCVD Envelope sender domain matches handover relay domain X-Headers-End: 1eDYNP-0003VI-89 Subject: [Openvpn-devel] [PATCH 1/2] manpage: improve description of --status and --status-version X-BeenThere: openvpn-devel@lists.sourceforge.net X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: openvpn-devel-bounces@lists.sourceforge.net X-getmail-retrieved-from-mailbox: Inbox Signed-off-by: Gert van Dijk Acked-by: Gert Doering --- 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 +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