doc/README.man

   1
   2 man page documentation
   3 ======================
   4
   5 The man page content maintained in the openvpn.8.rst file and proper man and
   6 the html version of the man page are generated using python-docutils.  Both
   7 the man page and html file are generated during 'make dist' or 'make distcheck'
   8 and should be distributed inside the tarball by default.
   9
  10 Users compiling OpenVPN from the tarball should not need to regenerate the
  11 man/html files unless the source file needs to be modified.
  12
  13 Further information:
  14
  15 * Python docutils project:
  16   https://docutils.sourceforge.io/
  17
  18 * Quickstart on .rst
  19   https://docutils.sourceforge.io/docs/user/rst/quickstart.html
  20
  21 * reStructuredText Markup Specifictaion (.rst)
  22   https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html