From patchwork Thu May 20 05:09:31 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Arne Schwabe X-Patchwork-Id: 1822 Return-Path: Delivered-To: patchwork@openvpn.net Delivered-To: patchwork@openvpn.net Received: from director12.mail.ord1d.rsapps.net ([172.30.191.6]) by backend30.mail.ord1d.rsapps.net with LMTP id GNr4D+57pmDTaAAAIUCqbw (envelope-from ) for ; Thu, 20 May 2021 11:10:38 -0400 Received: from proxy4.mail.ord1d.rsapps.net ([172.30.191.6]) by director12.mail.ord1d.rsapps.net with LMTP id YCnVD+57pmDVBQAAIasKDg (envelope-from ) for ; Thu, 20 May 2021 11:10:38 -0400 Received: from smtp2.gate.ord1c ([172.30.191.6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) by proxy4.mail.ord1d.rsapps.net with LMTPS id 6KZwD+57pmAAegAAiYrejw (envelope-from ) for ; Thu, 20 May 2021 11:10:38 -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: smtp2.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=none (p=nil; dis=none) header.from=rfc2549.org X-Suspicious-Flag: YES X-Classification-ID: 88571b36-b97d-11eb-b3ea-842b2b4e7063-1-1 Received: from [216.105.38.7] ([216.105.38.7:59494] helo=lists.sourceforge.net) by smtp2.gate.ord1c.rsapps.net (envelope-from ) (ecelerity 4.2.38.62370 r(:)) with ESMTPS (cipher=DHE-RSA-AES256-GCM-SHA384) id 90/FB-18795-DEB76A06; Thu, 20 May 2021 11:10:38 -0400 Received: from [127.0.0.1] (helo=sfs-ml-1.v29.lw.sourceforge.com) by sfs-ml-1.v29.lw.sourceforge.com with esmtp (Exim 4.90_1) (envelope-from ) id 1ljkIz-0005Gp-40; Thu, 20 May 2021 15:09:45 +0000 Received: from [172.30.20.202] (helo=mx.sourceforge.net) by sfs-ml-1.v29.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ljkIx-0005GS-R6 for openvpn-devel@lists.sourceforge.net; Thu, 20 May 2021 15:09:43 +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=5X9zLaf7BO6J1DRcc+VD2tJVPb9enUicMrimeoqgohs=; b=YHnTcPPpEqgDjdW/qgbw/8ad+y mN6XEYySd/SpDrOI1Ad88be+iqv/gyo8f8CseO8yKhMhcihbKH0HGcD9TiIsMfOZZDg7kd2xZtI65 URIv4JbgyYbSCeYGI7walTEW4v9XEqLKLt5ySmaMih4N1wIPNEjOQj80MEmFWB2Eo1OY=; 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=5X9zLaf7BO6J1DRcc+VD2tJVPb9enUicMrimeoqgohs=; b=A BXg6ELzodxRv9JHFovZRmCwtQoDGKL9YXUAvu2woWOsV2JRiR2VSh2aDgER0zNggNYvnacJp9EisU rCWBdZqHqoOlpyQgViBxlZDesPEezRF9aQdN3Tto2SPpzdapgoDnjYyYPrIgraPjCpKj4z+eCCRHD TQ8k2YBrG0/V6e/8=; Received: from mail.blinkt.de ([192.26.174.232]) by sfi-mx-2.v28.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92.3) id 1ljkIt-00081K-DC for openvpn-devel@lists.sourceforge.net; Thu, 20 May 2021 15:09:43 +0000 Received: from kamera.blinkt.de ([2001:638:502:390:20c:29ff:fec8:535c]) by mail.blinkt.de with smtp (Exim 4.94.2 (FreeBSD)) (envelope-from ) id 1ljkIm-000C15-CG for openvpn-devel@lists.sourceforge.net; Thu, 20 May 2021 17:09:32 +0200 Received: (nullmailer pid 2565263 invoked by uid 10006); Thu, 20 May 2021 15:09:32 -0000 From: Arne Schwabe To: openvpn-devel@lists.sourceforge.net Date: Thu, 20 May 2021 17:09:31 +0200 Message-Id: <20210520150932.2565217-1-arne@rfc2549.org> X-Mailer: git-send-email 2.25.1 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: makefile.am] 0.2 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different 0.0 SPF_NONE SPF: sender does not publish an SPF Record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record X-Headers-End: 1ljkIt-00081K-DC Subject: [Openvpn-devel] [PATCH v2 1/2] Move examples into openvpn-examples(5) man page 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 Signed-off-by: Arne Schwabe Acked-By: David Sommerseth --- .gitignore | 2 ++ doc/Makefile.am | 25 +++++++++++++++++++++---- doc/openvpn-examples.5.rst | 17 +++++++++++++++++ doc/openvpn.8.rst | 2 +- 4 files changed, 41 insertions(+), 5 deletions(-) create mode 100644 doc/openvpn-examples.5.rst diff --git a/.gitignore b/.gitignore index 25d06235b..178076ede 100644 --- a/.gitignore +++ b/.gitignore @@ -49,6 +49,8 @@ version.sh msvc-env-local.bat config-msvc-local.h config-msvc-version.h +doc/openvpn-examples.5 +doc/openvpn-examples.5.html doc/openvpn.8 doc/openvpn.8.html /doc/doxygen/html/ diff --git a/doc/Makefile.am b/doc/Makefile.am index e411f5f9d..1dbbddf58 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -20,6 +20,7 @@ dist_doc_DATA = \ dist_noinst_DATA = \ README.plugins interactive-service-notes.rst \ openvpn.8.rst \ + openvpn-examples.5.rst \ man-sections/advanced-options.rst \ man-sections/client-options.rst \ man-sections/connection-profiles.rst \ @@ -52,6 +53,14 @@ else @echo "Missing python-docutils - skipping man page generation" endif +openvpn-examples.5 : +if HAVE_PYDOCUTILS + $(RST2MAN) $(srcdir)/$@.rst > $@ +else + @echo "Missing python-docutils - skipping man page generation" +endif + + openvpn.8.html: if HAVE_PYDOCUTILS $(RST2HTML) $(srcdir)/openvpn.8.rst > $@ @@ -59,13 +68,21 @@ else @echo "Missing python-docutils - skipping man/html page generation" endif +openvpn-examples.5.html: +if HAVE_PYDOCUTILS + $(RST2HTML) $(srcdir)/openvpn-examples.5.rst > $@ +else + @echo "Missing python-docutils - skipping man/html page generation" +endif + + if HAVE_PYDOCUTILS -dist_noinst_DATA += openvpn.8 -dist_html_DATA = openvpn.8.html +dist_noinst_DATA += openvpn.8 openvpn-examples.5 +dist_html_DATA = openvpn.8.html openvpn-examples.5.html # Failsafe - do not delete these files unless we can recreate them CLEANFILES = \ - openvpn.8 openvpn.8.html + openvpn.8 openvpn.8.html openvpn-examples.5 openvpn-examples.5.html endif @@ -74,4 +91,4 @@ else dist_man_MANS = openvpn.8 endif -dist-hook : openvpn.8 openvpn.8.html +dist-hook : openvpn.8 openvpn.8.html openvpn-examples.5 openvpn-examples.5.html diff --git a/doc/openvpn-examples.5.rst b/doc/openvpn-examples.5.rst new file mode 100644 index 000000000..988b6027b --- /dev/null +++ b/doc/openvpn-examples.5.rst @@ -0,0 +1,17 @@ +=============================== + openvpn examples +=============================== +------------------------- + Secure IP tunnel daemon +------------------------- + +:Manual section: 5 +:Manual group: Configuration files + + +INTRODUCTION +============ + +This man page gives a few simple examples to create OpenVPN setups and configuration files. + +.. include:: man-sections/examples.rst diff --git a/doc/openvpn.8.rst b/doc/openvpn.8.rst index db81274fa..995467478 100644 --- a/doc/openvpn.8.rst +++ b/doc/openvpn.8.rst @@ -86,7 +86,6 @@ placed in a configuration file. .. include:: man-sections/connection-profiles.rst .. include:: man-sections/inline-files.rst .. include:: man-sections/signals.rst -.. include:: man-sections/examples.rst FAQ @@ -134,6 +133,7 @@ Report all bugs to the OpenVPN team info@openvpn.net SEE ALSO ======== +``openvpn-examples``\(5), ``dhcpcd``\(8), ``ifconfig``\(8), ``openssl``\(1),