Browse code
Move examples into openvpn-examples(5) man page
Signed-off-by: Arne Schwabe <arne@rfc2549.org>
Acked-by: David Sommerseth <davids@openvpn.net>
Message-Id: <20210520150932.2565217-1-arne@rfc2549.org>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg22414.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
Arne Schwabe authored on 2021/05/21 00:09:31Showing 4 changed files
| ... | ... |
@@ -20,6 +20,7 @@ dist_doc_DATA = \ |
| 20 | 20 |
dist_noinst_DATA = \ |
| 21 | 21 |
README.plugins interactive-service-notes.rst \ |
| 22 | 22 |
openvpn.8.rst \ |
| 23 |
+ openvpn-examples.5.rst \ |
|
| 23 | 24 |
man-sections/advanced-options.rst \ |
| 24 | 25 |
man-sections/client-options.rst \ |
| 25 | 26 |
man-sections/connection-profiles.rst \ |
| ... | ... |
@@ -52,6 +53,14 @@ else |
| 52 | 52 |
@echo "Missing python-docutils - skipping man page generation" |
| 53 | 53 |
endif |
| 54 | 54 |
|
| 55 |
+openvpn-examples.5 : |
|
| 56 |
+if HAVE_PYDOCUTILS |
|
| 57 |
+ $(RST2MAN) $(srcdir)/$@.rst > $@ |
|
| 58 |
+else |
|
| 59 |
+ @echo "Missing python-docutils - skipping man page generation" |
|
| 60 |
+endif |
|
| 61 |
+ |
|
| 62 |
+ |
|
| 55 | 63 |
openvpn.8.html: |
| 56 | 64 |
if HAVE_PYDOCUTILS |
| 57 | 65 |
$(RST2HTML) $(srcdir)/openvpn.8.rst > $@ |
| ... | ... |
@@ -59,19 +68,27 @@ else |
| 59 | 59 |
@echo "Missing python-docutils - skipping man/html page generation" |
| 60 | 60 |
endif |
| 61 | 61 |
|
| 62 |
+openvpn-examples.5.html: |
|
| 63 |
+if HAVE_PYDOCUTILS |
|
| 64 |
+ $(RST2HTML) $(srcdir)/openvpn-examples.5.rst > $@ |
|
| 65 |
+else |
|
| 66 |
+ @echo "Missing python-docutils - skipping man/html page generation" |
|
| 67 |
+endif |
|
| 68 |
+ |
|
| 69 |
+ |
|
| 62 | 70 |
if HAVE_PYDOCUTILS |
| 63 |
-dist_noinst_DATA += openvpn.8 |
|
| 64 |
-dist_html_DATA = openvpn.8.html |
|
| 71 |
+dist_noinst_DATA += openvpn.8 openvpn-examples.5 |
|
| 72 |
+dist_html_DATA = openvpn.8.html openvpn-examples.5.html |
|
| 65 | 73 |
|
| 66 | 74 |
# Failsafe - do not delete these files unless we can recreate them |
| 67 | 75 |
CLEANFILES = \ |
| 68 |
- openvpn.8 openvpn.8.html |
|
| 76 |
+ openvpn.8 openvpn.8.html openvpn-examples.5 openvpn-examples.5.html |
|
| 69 | 77 |
|
| 70 | 78 |
endif |
| 71 | 79 |
|
| 72 | 80 |
if WIN32 |
| 73 | 81 |
else |
| 74 |
-dist_man_MANS = openvpn.8 |
|
| 82 |
+dist_man_MANS = openvpn.8 openvpn-examples.5 |
|
| 75 | 83 |
endif |
| 76 | 84 |
|
| 77 |
-dist-hook : openvpn.8 openvpn.8.html |
|
| 85 |
+dist-hook : openvpn.8 openvpn.8.html openvpn-examples.5 openvpn-examples.5.html |
| 78 | 86 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,17 @@ |
| 0 |
+=============================== |
|
| 1 |
+ openvpn examples |
|
| 2 |
+=============================== |
|
| 3 |
+------------------------- |
|
| 4 |
+ Secure IP tunnel daemon |
|
| 5 |
+------------------------- |
|
| 6 |
+ |
|
| 7 |
+:Manual section: 5 |
|
| 8 |
+:Manual group: Configuration files |
|
| 9 |
+ |
|
| 10 |
+ |
|
| 11 |
+INTRODUCTION |
|
| 12 |
+============ |
|
| 13 |
+ |
|
| 14 |
+This man page gives a few simple examples to create OpenVPN setups and configuration files. |
|
| 15 |
+ |
|
| 16 |
+.. include:: man-sections/examples.rst |
| ... | ... |
@@ -86,7 +86,6 @@ placed in a configuration file. |
| 86 | 86 |
.. include:: man-sections/connection-profiles.rst |
| 87 | 87 |
.. include:: man-sections/inline-files.rst |
| 88 | 88 |
.. include:: man-sections/signals.rst |
| 89 |
-.. include:: man-sections/examples.rst |
|
| 90 | 89 |
|
| 91 | 90 |
|
| 92 | 91 |
FAQ |
| ... | ... |
@@ -134,6 +133,7 @@ Report all bugs to the OpenVPN team info@openvpn.net |
| 134 | 134 |
SEE ALSO |
| 135 | 135 |
======== |
| 136 | 136 |
|
| 137 |
+``openvpn-examples``\(5), |
|
| 137 | 138 |
``dhcpcd``\(8), |
| 138 | 139 |
``ifconfig``\(8), |
| 139 | 140 |
``openssl``\(1), |