diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | doc/Makefile.am | 27 | ||||
| -rw-r--r-- | doc/openvpn-examples.5.rst | 17 | ||||
| -rw-r--r-- | doc/openvpn.8.rst | 2 |
4 files changed, 42 insertions, 6 deletions
@@ -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 a58a141..9f1c2fc 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,19 +68,27 @@ 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 if WIN32 else -dist_man_MANS = openvpn.8 +dist_man_MANS = openvpn.8 openvpn-examples.5 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 0000000..988b602 --- /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 db81274..9954674 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), |