mirror of
https://git.proxmox.com/git/mirror_frr
synced 2025-08-02 18:52:04 +00:00
doc: update for new daemons settings
watchfrr_enable is ignored, watchfrr_options is unneeded and the valgrind options have been replaced with daemon_wrap/all_wrap. Signed-off-by: David Lamparter <equinox@diac24.net>
This commit is contained in:
parent
1569f22439
commit
bd2893d57f
@ -22,21 +22,6 @@ In order to avoid restarting the daemons in quick succession, you can supply the
|
||||
|
||||
OPTIONS
|
||||
=======
|
||||
The following 3 options specify scripts that |DAEMON| uses to perform start/stop/restart actions. These options are mandatory unless the --dry option is used:
|
||||
|
||||
.. option:: -s command, --start-command command
|
||||
|
||||
Supply a Bourne shell command to start a single daemon. The command string should contain the '%s' placeholder to be sub‐ stituted with the daemon name.
|
||||
|
||||
.. option:: -k command, --kill-command command
|
||||
|
||||
Supply a Bourne shell command to stop a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
|
||||
|
||||
.. option:: -r command, --restart command
|
||||
|
||||
Supply a Bourne shell command to restart a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
|
||||
|
||||
Other options:
|
||||
|
||||
.. option:: --dry
|
||||
|
||||
@ -92,6 +77,20 @@ Other options:
|
||||
|
||||
Display the usage information and exit.
|
||||
|
||||
The following 3 options specify scripts that |DAEMON| uses to perform start/stop/restart actions. Reasonable default values are built into watchfrr, so the use of these options should no longer be necessary:
|
||||
|
||||
.. option:: -s command, --start-command command
|
||||
|
||||
Supply a Bourne shell command to start a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
|
||||
|
||||
.. option:: -k command, --kill-command command
|
||||
|
||||
Supply a Bourne shell command to stop a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
|
||||
|
||||
.. option:: -r command, --restart command
|
||||
|
||||
Supply a Bourne shell command to restart a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
|
||||
|
||||
PREVIOUS OPTIONS
|
||||
================
|
||||
Prior versions of |DAEMON| supported some additional options that no longer exist:::
|
||||
|
@ -72,13 +72,14 @@ This file has several parts. Here is an example:
|
||||
fabricd_options=" --daemon -A 127.0.0.1"
|
||||
|
||||
# The list of daemons to watch is automatically generated by the init script.
|
||||
watchfrr_enable=yes
|
||||
watchfrr_options=(-d -r /usr/sbin/servicebBfrrbBrestartbB%s -s /usr/sbin/servicebBfrrbBstartbB%s -k /usr/sbin/servicebBfrrbBstopbB%s -b bB)
|
||||
#watchfrr_options=""
|
||||
|
||||
# If valgrind_enable is 'yes' the frr daemons will be started via valgrind.
|
||||
# The use case for doing so is tracking down memory leaks, etc in frr.
|
||||
valgrind_enable=no
|
||||
valgrind=/usr/bin/valgrind
|
||||
# for debugging purposes, you can specify a "wrap" command to start instead
|
||||
# of starting the daemon directly, e.g. to use valgrind on ospfd:
|
||||
# ospfd_wrap="/usr/bin/valgrind"
|
||||
# or you can use "all_wrap" for all daemons, e.g. to use perf record:
|
||||
# all_wrap="/usr/bin/perf record --call-graph -"
|
||||
# the normal daemon command is added to this at the end.
|
||||
|
||||
Breaking this file down:
|
||||
|
||||
@ -101,22 +102,8 @@ from the service script. Usually daemons will have ``--daemon`` and ``-A
|
||||
<address>`` specified in order to daemonize and listen for VTY commands on a
|
||||
particular address.
|
||||
|
||||
::
|
||||
|
||||
# The list of daemons to watch is automatically generated by the init script.
|
||||
watchfrr_enable=yes
|
||||
watchfrr_options=(-d -r /usr/sbin/servicebBfrrbBrestartbB%s -s /usr/sbin/servicebBfrrbBstartbB%s -k /usr/sbin/servicebBfrrbBstopbB%s -b bB)
|
||||
|
||||
Options for the ``watchfrr``, the watchdog daemon.
|
||||
|
||||
::
|
||||
|
||||
valgrind_enable=no
|
||||
valgrind=/usr/bin/valgrind
|
||||
|
||||
Whether or not to start FRR daemons under Valgrind. This is primarily useful
|
||||
for gathering information for bug reports and for developers.
|
||||
``valgrind_enable`` should be ``no`` for production use.
|
||||
The remaining file content regarding `watchfrr_options` and `*_wrap` settings
|
||||
should not normally be needed; refer to the comments in case they are.
|
||||
|
||||
Services
|
||||
--------
|
||||
|
Loading…
Reference in New Issue
Block a user