mirror of
https://github.com/OpenVPN/openvpn.git
synced 2024-09-20 20:03:13 +02:00
f500c49c8e
To avoid keeping around a full-size openvpn.rst file which is never needed but will take space in the repo forever, patches 01...04 of the big documentation overhaul projects were squashed togehter, keeping the individual commit logs and URL references below. Signed-off-by: Gert Doering <gert@greenie.muc.de> * This is a combination of 4 commits. * This is the 1st commit message: doc/man: Add an .rst formatted version of the man page This is the first step to move away from a manually editing g/nroff encoded man page. Some modifications was needed to ensure formatting was consistent and rendered reasonably okay in GitHub and that the generated man page (using rst2man) is looking as a proper man page. Unsupported options has also been moved into its own section. HTML rendering directly using rst2html has also been used to validate the conversion. The rst2man and rst2html utilities comes from the python-docutils project: https://docutils.sourceforge.io/ Signed-off-by: David Sommerseth <davids@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20200716225338.611-2-davids@openvpn.net> URL: https://sourceforge.net/p/openvpn/mailman/message/37063370/ Signed-off-by: Gert Doering <gert@greenie.muc.de> * This is the commit message #2: doc/man: Replace old man page with generated man page The doc/openvpn.8 and doc/openvpn.8.html files are now being removed from the git tree, as it will be generated from the doc/openvpn.8.rst file using python-docutils. An additional dist-hook is added so these files are generated automatically when source tarballs are generated for releases. This means users compiling directly from the source tarball will not need python-docutils installed. Signed-off-by: David Sommerseth <davids@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20200716225338.611-3-davids@openvpn.net> URL: https://sourceforge.net/p/openvpn/mailman/message/37063373/ Signed-off-by: Gert Doering <gert@greenie.muc.de> * This is the commit message #3: doc/man: Split up and reorganize main man page The openvpn.8.rst file is quite long and hard to edit, as it covers several hundred options. Some options were even documented multiple places. The example has also received some attention, cleaning up old and outdated infomration. In this commit the main man page is split up into multiple sections and options are sorted into each of the corresponding section. Inside each category, each option is for now sorted alphabetically. The main openvpn.8.rst file is currently kept unchanged and will be handled in the next commit. Many language improvements contributed by Richard Bonhomme has also been incorproated. Signed-off-by: David Sommerseth <davids@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20200716225338.611-4-davids@openvpn.net> URL: https://sourceforge.net/p/openvpn/mailman/message/37063376/ Signed-off-by: Gert Doering <gert@greenie.muc.de> * This is the commit message #4: doc/man: Complete openvpn.8.rst splitting This rebuilds the openvpn.8.rst content by using the text which was split out in the previous commit by using RST ..include statements. Signed-off-by: David Sommerseth <davids@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20200716225338.611-5-davids@openvpn.net> URL: https://sourceforge.net/p/openvpn/mailman/message/37063377/ Signed-off-by: Gert Doering <gert@greenie.muc.de>
74 lines
2.7 KiB
ReStructuredText
74 lines
2.7 KiB
ReStructuredText
Log options
|
|
-----------
|
|
|
|
--echo parms
|
|
Echo ``parms`` to log output.
|
|
|
|
Designed to be used to send messages to a controlling application which
|
|
is receiving the OpenVPN log output.
|
|
|
|
--errors-to-stderr
|
|
Output errors to stderr instead of stdout unless log output is
|
|
redirected by one of the ``--log`` options.
|
|
|
|
--log file
|
|
Output logging messages to ``file``, including output to stdout/stderr
|
|
which is generated by called scripts. If ``file`` already exists it will
|
|
be truncated. This option takes effect immediately when it is parsed in
|
|
the command line and will supersede syslog output if ``--daemon`` or
|
|
``--inetd`` is also specified. This option is persistent over the entire
|
|
course of an OpenVPN instantiation and will not be reset by
|
|
:code:`SIGHUP`, :code:`SIGUSR1`, or ``--ping-restart``.
|
|
|
|
Note that on Windows, when OpenVPN is started as a service, logging
|
|
occurs by default without the need to specify this option.
|
|
|
|
--log-append file
|
|
Append logging messages to ``file``. If ``file`` does not exist, it will
|
|
be created. This option behaves exactly like ``--log`` except that it
|
|
appends to rather than truncating the log file.
|
|
|
|
--machine-readable-output
|
|
Always write timestamps and message flags to log messages, even when
|
|
they otherwise would not be prefixed. In particular, this applies to log
|
|
messages sent to stdout.
|
|
|
|
--mute n
|
|
Log at most ``n`` consecutive messages in the same category. This is
|
|
useful to limit repetitive logging of similar message types.
|
|
|
|
--mute-replay-warnings
|
|
Silence the output of replay warnings, which are a common false alarm on
|
|
WiFi networks. This option preserves the security of the replay
|
|
protection code without the verbosity associated with warnings about
|
|
duplicate packets.
|
|
|
|
--suppress-timestamps
|
|
Avoid writing timestamps to log messages, even when they otherwise would
|
|
be prepended. In particular, this applies to log messages sent to
|
|
stdout.
|
|
|
|
--syslog progname
|
|
Direct log output to system logger, but do not become a daemon. See
|
|
``--daemon`` directive above for description of ``progname`` parameter.
|
|
|
|
--verb n
|
|
Set output verbosity to ``n`` (default :code:`1`). Each level shows all
|
|
info from the previous levels. Level :code:`3` is recommended if you want
|
|
a good summary of what's happening without being swamped by output.
|
|
|
|
:code:`0`
|
|
No output except fatal errors.
|
|
|
|
:code:`1` to :code:`4`
|
|
Normal usage range.
|
|
|
|
:code:`5`
|
|
Outputs :code:`R` and :code:`W` characters to the console for
|
|
each packet read and write, uppercase is used for TCP/UDP
|
|
packets and lowercase is used for TUN/TAP packets.
|
|
|
|
:code:`6` to :code:`11`
|
|
Debug info range (see :code:`errlevel.h` in the source code for
|
|
additional information on debug levels).
|