tipc: add link broadcast man page

Add a man page describing tipc link broadcast command get and set

Signed-off-by: Hoang Le <hoang.h.le@dektech.com.au>
Signed-off-by: David Ahern <dsahern@gmail.com>
This commit is contained in:
Hoang Le 2019-03-22 15:47:35 +07:00 committed by David Ahern
parent 5027f233e3
commit 35114a4cfe

View File

@ -1,4 +1,4 @@
.TH TIPC-LINK 8 "02 Jun 2015" "iproute2" "Linux" .TH TIPC-LINK 8 "22 Mar 2019" "iproute2" "Linux"
.\" For consistency, please keep padding right aligned. .\" For consistency, please keep padding right aligned.
.\" For example '.B "foo " bar' and not '.B foo " bar"' .\" For example '.B "foo " bar' and not '.B foo " bar"'
@ -14,18 +14,36 @@ tipc-link \- show links or modify link properties
.ti -8 .ti -8
.B tipc link set .B tipc link set
.RB "{ " "priority " .br
.RB "[ " "{ " "priority "
.IR PRIORITY .IR PRIORITY
.RB "| " tolerance .RB "| " tolerance
.IR TOLERANCE .IR TOLERANCE
.RB "| " window .RB "| " window
.IR "WINDOW " } .IR "WINDOW " }
.BI "link " LINK .BI "link " LINK " ]"
.RB "|"
.br
.RB "[ "
.RB "{ " broadcast " [ "
.IR BROADCAST
.RB " | "
.IR REPLICAST
.RB " | "
.IR AUTOSELECT
.RB "[ " ratio
.IR SIZE
.RB "] " ] " } " "]"
.ti -8 .ti -8
.B tipc link get .B tipc link get
.RB "{ " "priority" " | " tolerance " | " window " } " link .br
.I LINK .RB "[ " "{ " "priority" " | " tolerance " | " window " } " link
.IR LINK " ] "
.RB "|"
.br
.RB "[ " { " broadcast " } " ]"
.br
.ti -8 .ti -8
.B tipc link statistics .B tipc link statistics
@ -306,6 +324,31 @@ They are usually transient and occur during the cluster startup phase
or network reconfiguration. or network reconfiguration.
Possible status are: U or D. The status U implies up and D down. Possible status are: U or D. The status U implies up and D down.
.SS Broadcast properties
.TP
.B BROADCAST
.br
Forces all multicast traffic to be transmitted via broadcast only,
irrespective of cluster size and number of destinations.
.TP
.B REPLICAST
.br
Forces all multicast traffic to be transmitted via replicast only,
irrespective of cluster size and number of destinations.
.TP
.B AUTOSELECT
.br
Auto switching to broadcast or replicast depending on cluster size and
destination node number.
.TP
.B ratio SIZE
.br
Set the AUTOSELECT criteria, percentage of destination nodes vs cluster
size.
.SH EXAMPLES .SH EXAMPLES
.PP .PP
tipc link monitor list tipc link monitor list