From patchwork Thu Jul 16 12:53:30 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Sommerseth X-Patchwork-Id: 1271 Return-Path: Delivered-To: patchwork@openvpn.net Delivered-To: patchwork@openvpn.net Received: from director8.mail.ord1d.rsapps.net ([172.28.255.1]) by backend30.mail.ord1d.rsapps.net with LMTP id uMPgG83aEF88bQAAIUCqbw for ; Thu, 16 Jul 2020 18:55:09 -0400 Received: from proxy4.mail.ord1c.rsapps.net ([172.28.255.1]) by director8.mail.ord1d.rsapps.net with LMTP id EEemG83aEF97IQAAfY0hYg ; Thu, 16 Jul 2020 18:55:09 -0400 Received: from smtp10.gate.ord1c ([172.28.255.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) by proxy4.mail.ord1c.rsapps.net with LMTP id mLZtG83aEF+SVAAAjcXvpA ; Thu, 16 Jul 2020 18:55:09 -0400 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.105.38.7] Authentication-Results: smtp10.gate.ord1c.rsapps.net; iprev=pass policy.iprev="216.105.38.7"; 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=fail (p=none; dis=none) header.from=openvpn.net X-Suspicious-Flag: YES X-Classification-ID: 65950fc6-c7b7-11ea-83ca-0026b954785f-1-1 Received: from [216.105.38.7] ([216.105.38.7:56414] helo=lists.sourceforge.net) by smtp10.gate.ord1c.rsapps.net (envelope-from ) (ecelerity 4.2.38.62370 r(:)) with ESMTPS (cipher=DHE-RSA-AES256-GCM-SHA384) id 19/81-02906-CCAD01F5; Thu, 16 Jul 2020 18:55:09 -0400 Received: from [127.0.0.1] (helo=sfs-ml-4.v29.lw.sourceforge.com) by sfs-ml-4.v29.lw.sourceforge.com with esmtp (Exim 4.90_1) (envelope-from ) id 1jwClg-00035R-A0; Thu, 16 Jul 2020 22:54:20 +0000 Received: from [172.30.20.202] (helo=mx.sourceforge.net) by sfs-ml-4.v29.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jwCle-00035J-CG for openvpn-devel@lists.sourceforge.net; Thu, 16 Jul 2020 22:54:18 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; h=Content-Transfer-Encoding:MIME-Version:Message-Id: Date:Subject:To:From:Sender:Reply-To:Cc:Content-Type: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=DUL6ZI2PLuZp5IL41KG9PN4a36LqNAcKMW2ENy8Heu0=; b=RLg6+paswXEmGEh6NUl7g+rA7m cjSCnVJuXqS/N1IEEiQRKu6BuMwrRWJiLf9SrGQpSbMHp18428LH4J968BcHQskFS80Zi8rvKKGKV ek+gNCGVW+/kohFnrd/ZxY8hpzPXpNP6jFMxyA3cKfXiD31LLWkT/33sCp0b3EF0s+Dw=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=Content-Transfer-Encoding:MIME-Version:Message-Id:Date:Subject:To:From: Sender:Reply-To:Cc:Content-Type: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=DUL6ZI2PLuZp5IL41KG9PN4a36LqNAcKMW2ENy8Heu0=; b=b hXvUltSGVbCxU+vYc419noc5+6ZwdF4yJ7rRbapdZPnSpl7OtVuqUFzFwR4Su/zt1oGb4UzIGAae6 hZWRI+h2+HCaZFjmNg/SjGqUYcQto9qf/0xKkspwtYf+/OyHDWJuqmNnffyBNbckqvhj5lrYOWIY4 k2zYklefgTWGyJbw=; Received: from mx0.basenordic.cloud ([185.212.44.139]) by sfi-mx-4.v28.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92.2) id 1jwCla-006dPA-7l for openvpn-devel@lists.sourceforge.net; Thu, 16 Jul 2020 22:54:18 +0000 Received: from localhost (unknown [IPv6:::1]) by mx0.basenordic.cloud (Postfix) with ESMTP id 7345483D6FC for ; Thu, 16 Jul 2020 22:54:03 +0000 (UTC) Received: from mx0.basenordic.cloud ([IPv6:::1]) by localhost (winterfell.topphemmelig.net [IPv6:::1]) (amavisd-new, port 10024) with ESMTP id FmXqEsLW_OuC for ; Fri, 17 Jul 2020 00:53:51 +0200 (CEST) Received: from zimbra.sommerseth.email (zimbra.sommerseth.email [172.16.33.42]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx0.basenordic.cloud (Postfix) with ESMTPS id 96F968239DF for ; Fri, 17 Jul 2020 00:53:51 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by zimbra.sommerseth.email (Postfix) with ESMTP id 1F2AF40210A2 for ; Fri, 17 Jul 2020 00:53:51 +0200 (CEST) Received: from zimbra.sommerseth.email ([127.0.0.1]) by localhost (zimbra.sommerseth.email [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id zqOQZT6NLBkb for ; Fri, 17 Jul 2020 00:53:51 +0200 (CEST) Received: from optimus.homebase.sommerseths.net (optimus.homebase.sommerseths.net [10.35.0.233]) by zimbra.sommerseth.email (Postfix) with ESMTPS id E4A7240202A4 for ; Fri, 17 Jul 2020 00:53:50 +0200 (CEST) From: David Sommerseth To: openvpn-devel@lists.sourceforge.net Date: Fri, 17 Jul 2020 00:53:30 +0200 Message-Id: <20200716225338.611-1-davids@openvpn.net> X-Mailer: git-send-email 2.26.0 MIME-Version: 1.0 X-Spam-Report: Spam Filtering performed by mx.sourceforge.net. See http://spamassassin.org/tag/ for more details. 0.0 URIBL_BLOCKED ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [URIs: configure.ac] -0.0 SPF_HELO_PASS SPF: HELO matches SPF record 0.0 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different -0.0 SPF_PASS SPF: sender matches SPF record X-Headers-End: 1jwCla-006dPA-7l Subject: [Openvpn-devel] [PATCH v2 0/8] man-page overhaul project - round 2 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: , Errors-To: openvpn-devel-bounces@lists.sourceforge.net X-getmail-retrieved-from-mailbox: Inbox Hi, In the community meeting 2020-07-16, it was agreed to try to squash several commits and reduce the number of patches. In addition to split up the biggest patch into two parts to try to sneak everything into the mailing list without sending too large patches. I've kept a few changes separate, as they are not strictly tied to this overhaul but these changes are important to get included. Richard Bonhomme has also contributed with a lot of language improvements which now has been squashed into one of these commits below. Unfortunately this squashing removed him as the author of that commit, but I wanted to be sure he gets the proper credit somehow. kind regards, David Sommerseth OpenVPN Inc David Sommerseth (7): doc/man: Add an .rst formatted version of the man page doc/man: Replace old man page with generated man page doc/man: Split up and reorganize main man page doc/man: Complete openvpn.8.rst splitting doc/man: Mark compression options as deprecated doc/man: Adopt compression documentation doc/man: Documentation for --bind-dev / VRFs on Linux Richard Bonhomme (1): doc/man: Update --txqueuelen default setting (Now OS default) .gitignore | 1 + INSTALL | 3 +- configure.ac | 15 +- doc/Makefile.am | 56 +- doc/README.man | 23 + doc/man-sections/advanced-options.rst | 107 + doc/man-sections/client-options.rst | 354 + doc/man-sections/connection-profiles.rst | 75 + doc/man-sections/encryption-options.rst | 136 + doc/man-sections/examples.rst | 241 + doc/man-sections/generic-options.rst | 436 + doc/man-sections/inline-files.rst | 25 + doc/man-sections/link-options.rst | 410 + doc/man-sections/log-options.rst | 74 + doc/man-sections/management-options.rst | 136 + doc/man-sections/network-config.rst | 10 + doc/man-sections/pkcs11-options.rst | 81 + doc/man-sections/plugin-options.rst | 60 + doc/man-sections/protocol-options.rst | 262 + doc/man-sections/proxy-options.rst | 66 + doc/man-sections/renegotiation.rst | 53 + doc/man-sections/script-options.rst | 807 ++ doc/man-sections/server-options.rst | 769 ++ doc/man-sections/signals.rst | 30 + doc/man-sections/tls-options.rst | 643 ++ doc/man-sections/unsupported-options.rst | 33 + .../virtual-routing-and-forwarding.rst | 78 + doc/man-sections/vpn-network-options.rst | 535 ++ doc/man-sections/windows-options.rst | 245 + doc/openvpn.8 | 7659 ----------------- doc/openvpn.8.rst | 169 + 31 files changed, 5918 insertions(+), 7674 deletions(-) create mode 100644 doc/README.man create mode 100644 doc/man-sections/advanced-options.rst create mode 100644 doc/man-sections/client-options.rst create mode 100644 doc/man-sections/connection-profiles.rst create mode 100644 doc/man-sections/encryption-options.rst create mode 100644 doc/man-sections/examples.rst create mode 100644 doc/man-sections/generic-options.rst create mode 100644 doc/man-sections/inline-files.rst create mode 100644 doc/man-sections/link-options.rst create mode 100644 doc/man-sections/log-options.rst create mode 100644 doc/man-sections/management-options.rst create mode 100644 doc/man-sections/network-config.rst create mode 100644 doc/man-sections/pkcs11-options.rst create mode 100644 doc/man-sections/plugin-options.rst create mode 100644 doc/man-sections/protocol-options.rst create mode 100644 doc/man-sections/proxy-options.rst create mode 100644 doc/man-sections/renegotiation.rst create mode 100644 doc/man-sections/script-options.rst create mode 100644 doc/man-sections/server-options.rst create mode 100644 doc/man-sections/signals.rst create mode 100644 doc/man-sections/tls-options.rst create mode 100644 doc/man-sections/unsupported-options.rst create mode 100644 doc/man-sections/virtual-routing-and-forwarding.rst create mode 100644 doc/man-sections/vpn-network-options.rst create mode 100644 doc/man-sections/windows-options.rst delete mode 100644 doc/openvpn.8 create mode 100644 doc/openvpn.8.rst