summaryrefslogtreecommitdiffstats
path: root/doc/manpages
diff options
context:
space:
mode:
authorDonatas Abraitis <donatas.abraitis@gmail.com>2021-04-12 10:57:11 +0200
committerDonatas Abraitis <donatas.abraitis@gmail.com>2021-04-12 16:33:36 +0200
commitb993aae0d04d8a9480e8252510aad2f196e96469 (patch)
tree2bd5e8db8ac80d402bb2be25dbfd91b61d0c7454 /doc/manpages
parentvtysh: Set history file on demand (diff)
downloadfrr-b993aae0d04d8a9480e8252510aad2f196e96469.tar.xz
frr-b993aae0d04d8a9480e8252510aad2f196e96469.zip
doc: Add an option for vtysh to override history file path
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
Diffstat (limited to 'doc/manpages')
-rw-r--r--doc/manpages/vtysh.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/manpages/vtysh.rst b/doc/manpages/vtysh.rst
index 3e496956c..b930cb915 100644
--- a/doc/manpages/vtysh.rst
+++ b/doc/manpages/vtysh.rst
@@ -53,6 +53,10 @@ OPTIONS available for the vtysh command:
When executing cli that does not invoke a vtysh shell, if an error ocurrs ignore it for purposes of return codes from vtysh.
+.. option:: -H, --histfile
+
+ Override the history file for vtysh commands. You can set ``vtysh -H /dev/null`` to turn logging of at all.
+
.. option:: -u, --user
Restrict access to configuration commands by preventing use of the "enable" command. This option provides the same limited "security" as password-protected telnet access. *This security should not be relied on in production environments.*
@@ -68,6 +72,10 @@ ENVIRONMENT VARIABLES
VTYSH_PAGER
This should be the name of the pager to use. Default is more.
+VTYSH_HISTFILE
+ Override the history file for vtysh commands. Logging can be turned off using ``VTYSH_HISTFILE=/dev/null vtysh``.
+ Environment is prefered way to override the history file path over command line argument (-H/--histfile).
+
FILES
=====
|INSTALL_PREFIX_SBIN|/vtysh