diff options
| author | Bernhard Schmidt <berni@debian.org> | 2020-09-01 16:52:17 +0200 |
|---|---|---|
| committer | Bernhard Schmidt <berni@debian.org> | 2020-09-01 16:52:17 +0200 |
| commit | 9fc3b98112217f2d92a67977dbde0987cc7a1803 (patch) | |
| tree | 29fcc8654ee65d9dd89ade797bea2f3d9dfd9cfd /doc/README.man | |
| parent | a8758c0e03eed188dcb9da0e4fd781a67c25bf1e (diff) | |
| parent | 69b02b1f7fd609d84ace13ab04697158de2418a9 (diff) | |
Merge branch 'debian/experimental-2.5'
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 |