From: Donald Sharp <sharpd@cumulusnetworks.com>
Date: Fri, 31 May 2019 00:16:46 +0000 (-0400)
Subject: doc: Update the documentation to reflect -N changes
X-Git-Tag: frr-7.2~288^2
X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=6ed859503d1688151910fc7e33c944ab6ed3e5bc;p=mirror_frr.git

doc: Update the documentation to reflect -N changes

The -N <namespace> option is now used to control the location
of various control files and sockets.  Update the documentation
to reflect this.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
---

diff --git a/doc/user/basic.rst b/doc/user/basic.rst
index bc9a7d643..3d3a75d4b 100644
--- a/doc/user/basic.rst
+++ b/doc/user/basic.rst
@@ -479,6 +479,12 @@ These options apply to all |PACKAGE_NAME| daemons.
 
    Set the user and group to run as.
 
+.. option:: -N <namespace>
+
+   Set the namespace that the daemon will run in.  A "/<namespace>" will
+   be added to all files that use the statedir.  If you have "/var/run/frr"
+   as the default statedir then it will become "/var/run/frr/<namespace>".
+
 .. option:: -v, --version
 
    Print program version.
diff --git a/doc/user/bfd.rst b/doc/user/bfd.rst
index 33bc77049..32ca5707d 100644
--- a/doc/user/bfd.rst
+++ b/doc/user/bfd.rst
@@ -47,6 +47,9 @@ may also be specified (:ref:`common-invocation-options`).
 
       #define BFDD_CONTROL_SOCKET "|INSTALL_PREFIX_STATE|/bfdd.sock"
 
+   This option overrides the location addition that the -N option provides
+   to the bfdd.sock
+
 
 .. _bfd-commands:
 
diff --git a/doc/user/ldpd.rst b/doc/user/ldpd.rst
index 85d280343..977195d6a 100644
--- a/doc/user/ldpd.rst
+++ b/doc/user/ldpd.rst
@@ -24,6 +24,12 @@ Running Ldpd
 The *ldpd* daemon can be invoked with any of the common
 options (:ref:`common-invocation-options`).
 
+..option:: --ctl_socket
+
+   This option allows you to override the path to the ldpd.sock file
+   used to control this daemon.  If specified this option overrides
+   the -N option path addition.
+
 The *zebra* daemon must be running before *ldpd* is invoked.
 
 Configuration of *ldpd* is done in its configuration file
diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst
index 40d894929..eefc5802a 100644
--- a/doc/user/zebra.rst
+++ b/doc/user/zebra.rst
@@ -58,6 +58,12 @@ Besides the common invocation options (:ref:`common-invocation-options`), the
 
    .. seealso:: :ref:`zebra-vrf`
 
+.. option:: -z <path_to_socket>, --socket <path_to_socket>
+
+   If this option is supplied on the cli, the path to the zebra
+   control socket(zapi), is used.  This option overrides a -N <namespace>
+   option if handed to it on the cli.
+
 .. option:: --v6-rr-semantics
 
    The linux kernel is receiving the ability to use the same route