]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: Add doc for new configure option 3581/head
authorDonald Sharp <sharpd@cumulusnetworks.com>
Tue, 29 Jan 2019 13:54:57 +0000 (08:54 -0500)
committerDonald Sharp <sharpd@cumulusnetworks.com>
Fri, 31 May 2019 14:06:42 +0000 (10:06 -0400)
Add documentation for the '--command-log-always' daemon cli
and how to use it.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
doc/user/basic.rst

index 3df60169f7f75a526296b41a6faedeec4d9a2c76..bc9a7d64319aa702f15bd381bffaad0a22bb0a5f 100644 (file)
@@ -180,13 +180,14 @@ Basic Config Commands
    In this example, the precision is set to provide timestamps with
    millisecond accuracy.
 
-.. index:: log commands
-.. clicmd:: log commands
+.. index:: [no] log commands
+.. clicmd:: [no] log commands
 
    This command enables the logging of all commands typed by a user to all
    enabled log destinations. The note that logging includes full command lines,
-   including passwords. Once set, command logging can only be turned off by
-   restarting the daemon.
+   including passwords. If the daemon startup option `--command-log-always`
+   is used to start the daemon then this command is turned on by default
+   and cannot be turned off and the [no] form of the command is dissallowed.
 
 .. index:: service password-encryption
 .. clicmd:: service password-encryption
@@ -482,6 +483,13 @@ These options apply to all |PACKAGE_NAME| daemons.
 
    Print program version.
 
+.. option:: --command-log-always
+
+   Cause the daemon to always log commands entered to the specified log file.
+   This also makes the `no log commands` command dissallowed.  Enabling this
+   is suggested if you have need to track what the operator is doing on
+   this router.
+
 .. option:: --log <stdout|syslog|file:/path/to/log/file>
 
    When initializing the daemon, setup the log to go to either stdout,