From ed121da8eb6d6d60a3fe83de41d12c7c694186cb Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Wed, 12 Nov 2014 15:11:16 +0100 Subject: doc: add documentation for the status socket option --- doc/source/manual/cmdline.rst | 3 +++ doc/source/manual/config.rst | 5 +++++ 2 files changed, 8 insertions(+) diff --git a/doc/source/manual/cmdline.rst b/doc/source/manual/cmdline.rst index 66211ca..bd17249 100644 --- a/doc/source/manual/cmdline.rst +++ b/doc/source/manual/cmdline.rst @@ -15,6 +15,9 @@ Command line options and config files are parsed in order they are specified, so --pid-file Writes fastd's PID to the specified file. +--status-socket + Configures a socket to get fastd's status. + --log-level Sets the stderr log level; default is info, if no alternative log destination ist configured. diff --git a/doc/source/manual/config.rst b/doc/source/manual/config.rst index d558e8a..5a09c6c 100644 --- a/doc/source/manual/config.rst +++ b/doc/source/manual/config.rst @@ -260,6 +260,11 @@ Example config: Setting this option to yes (the default) on one side is enough to ensure that a session established by two peers has not been downgraded. +| ``status socket "";`` + + Configures a UNIX socket which can be used to retrieve the current state of fastd. An example script + to get the status can be found at ``doc/examples/status.pl`` in the fastd repository. + | ``user "";`` Sets the user to run fastd as. -- cgit v1.2.3