diff options
| author | Bernhard Schmidt <berni@debian.org> | 2020-08-15 21:29:54 +0200 |
|---|---|---|
| committer | Bernhard Schmidt <berni@debian.org> | 2020-08-15 21:29:54 +0200 |
| commit | 7c229d538824cb679351220ad8911f7b2daa7c23 (patch) | |
| tree | 5c4d64b60da9018c7db3a9335a9787d326beade3 /doc/README.man | |
| parent | d3986a312f5fbcfd0e78e6b147eef419fb4e5f54 (diff) | |
| parent | 1079962e4c06f88a54e50d997c1b7e84303d30b4 (diff) | |
Update upstream source from tag 'upstream/2.5_beta1'
Update to upstream version '2.5~beta1'
with Debian dir d53f9a482ac24eb491a294b26c24bb1d87afad24
Diffstat (limited to 'doc/README.man')
| -rw-r--r-- | doc/README.man | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/README.man b/doc/README.man new file mode 100644 index 0000000..29654c1 --- /dev/null +++ b/doc/README.man @@ -0,0 +1,22 @@ + +man page documentation +====================== + +The man page content maintained in the openvpn.8.rst file and proper man and +the html version of the man page are generated using python-docutils. Both +the man page and html file are generated during 'make dist' or 'make distcheck' +and should be distributed inside the tarball by default. + +Users compiling OpenVPN from the tarball should not need to regenerate the +man/html files unless the source file needs to be modified. + +Further information: + +* Python docutils project: + https://docutils.sourceforge.io/ + +* Quickstart on .rst + https://docutils.sourceforge.io/docs/user/rst/quickstart.html + +* reStructuredText Markup Specifictaion (.rst) + https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html |