summaryrefslogtreecommitdiff
path: root/doc/zebra.8.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zebra.8.in')
-rw-r--r--doc/zebra.8.in16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/zebra.8.in b/doc/zebra.8.in
index f5b8bd4d80..333e66fcf6 100644
--- a/doc/zebra.8.in
+++ b/doc/zebra.8.in
@@ -26,6 +26,9 @@ zebra \- a routing manager for use with associated @PACKAGE_FULLNAME@ components
] [
.B \-M
.I module:options
+] [
+.B \-z
+.I socketpath
]
.SH DESCRIPTION
.B zebra
@@ -97,6 +100,19 @@ respectively. The \fBfpm\fR module takes an additional colon-separated
argument specifying the encapsulation, either \fBnetlink\fR or \fBprotobuf\fR.
It should thus be loaded with \fB-M fpm:netlink\fR or \fB-M fpm:protobuf\fR.
.TP
+\fB\-z\fR, \fB\-\-socket \fR\fIsocketpath\fR
+Use the specified path to open the zebra API socket on.
+The default is \fB\fI@CFG_STATE@/zserv.api\fR. This option must be given with
+the same value to all FRR protocol daemons.
+
+For debugging purposes (using tcpdump or wireshark to trace cross-daemon
+communication), a TCP socket can be used by specifying \fI@tcp[46][:port]\fR.
+It is intentionally not possible to bind this to anything other than localhost
+since zebra and the other daemons need to be running on the same host. Using
+this feature \fBCREATES A SECURITY ISSUE\fR since nothing prevents other users
+on the local system from connecting to zebra and injecting bogus routing
+information.
+.TP
\fB\-v\fR, \fB\-\-version\fR
Print the version and exit.
.SH FILES