[mirror_iproute2.git] / man / man8 / tipc-nametable.8

.TH TIPC-NAMETABLE 8 "02 Jun 2015" "iproute2" "Linux"

.\" For consistency, please keep padding right aligned.
.\" For example '.B "foo " bar' and not '.B foo " bar"'

.SH NAME
tipc-nametable \- show TIPC nametable

.SH SYNOPSIS
.ad l
.in +8

.ti -8
.B tipc nametable show
.br

.SH OPTIONS
Options (flags) that can be passed anywhere in the command chain.
.TP
.BR "\-h" , " --help"

.TP
.BR "\-j", " \-json"
Output results in JavaScript Object Notation (JSON).

.TP
.BR "\-p", " \-pretty"
The default JSON format is compact and more efficient to parse but hard for most users to read.
This flag adds indentation for readability.

Show help about last valid command. For example
.B tipc nametable --help
will show nametable help and
.B tipc --help
will show general help. The position of the option in the string is irrelevant.

.SH DESCRIPTION
The nametable shows TIPC publication information.

.SS Nametable format

.TP
.B Type
.br
The 32-bit type field of the port name. The type field often indicates the class of service
provided by a port.

.TP
.B Lower
.br
The lower bound of the 32-bit instance field of the port name.
The instance field is often used as as a sub-class indicator.

.TP
.B Upper
.br
The upper bound of the 32-bit instance field of the port name.
The instance field is often used as as a sub-class indicator.
A difference in
.BR "lower " "and " upper
means the socket is bound to the port name range [lower,upper]

.TP
.B Port Identity
.br
The unique socket (port) identifier within the TIPC cluster. The
.B port identity
consists of a node identity followed by a socket reference number.

.TP
.B Publication
.br
The
.B publication
ID is a random number used internally to represent a publication.

.TP
.B Scope
.br
The publication
.B scope
specifies the visibility of a bound port name.
The
.B scope
can be specified to comprise three different domains:
.BR node ", " "cluster " "and " zone.
Applications residing within the specified
.B scope
can see and access the port using the displayed port name.

.SH EXIT STATUS
Exit status is 0 if command was successful or a positive integer upon failure.

.SH SEE ALSO
.BR tipc (8),
.BR tipc-bearer (8),
.BR tipc-link (8),
.BR tipc-media (8),
.BR tipc-node (8),
.BR tipc-peer (8),
.BR tipc-socket (8)
.br
.SH REPORTING BUGS
Report any bugs to the Network Developers mailing list
.B <netdev@vger.kernel.org>
where the development and maintenance is primarily done.
You do not have to be subscribed to the list to send a message there.

.SH AUTHOR
Richard Alpe <richard.alpe@ericsson.com>
Commit	Line	Data
dcd8d142 RA	1	.TH TIPC-NAMETABLE 8 "02 Jun 2015" "iproute2" "Linux"
dcd8d142 RA	2
85e3c87c VS	3	.\" For consistency, please keep padding right aligned.
85e3c87c VS	4	.\" For example '.B "foo " bar' and not '.B foo " bar"'
dcd8d142 RA	5
	6	.SH NAME
	7	tipc-nametable \- show TIPC nametable
	8
	9	.SH SYNOPSIS
	10	.ad l
	11	.in +8
	12
	13	.ti -8
	14	.B tipc nametable show
	15	.br
	16
	17	.SH OPTIONS
	18	Options (flags) that can be passed anywhere in the command chain.
	19	.TP
	20	.BR "\-h" , " --help"
1304f50a HL	21
	22	.TP
	23	.BR "\-j", " \-json"
	24	Output results in JavaScript Object Notation (JSON).
	25
	26	.TP
	27	.BR "\-p", " \-pretty"
	28	The default JSON format is compact and more efficient to parse but hard for most users to read.
	29	This flag adds indentation for readability.
	30
dcd8d142 RA	31	Show help about last valid command. For example
	32	.B tipc nametable --help
	33	will show nametable help and
	34	.B tipc --help
	35	will show general help. The position of the option in the string is irrelevant.
	36
	37	.SH DESCRIPTION
	38	The nametable shows TIPC publication information.
	39
	40	.SS Nametable format
	41
	42	.TP
	43	.B Type
	44	.br
	45	The 32-bit type field of the port name. The type field often indicates the class of service
	46	provided by a port.
	47
	48	.TP
	49	.B Lower
	50	.br
	51	The lower bound of the 32-bit instance field of the port name.
	52	The instance field is often used as as a sub-class indicator.
	53
	54	.TP
	55	.B Upper
	56	.br
	57	The upper bound of the 32-bit instance field of the port name.
	58	The instance field is often used as as a sub-class indicator.
	59	A difference in
	60	.BR "lower " "and " upper
	61	means the socket is bound to the port name range [lower,upper]
	62
	63	.TP
	64	.B Port Identity
	65	.br
	66	The unique socket (port) identifier within the TIPC cluster. The
	67	.B port identity
	68	consists of a node identity followed by a socket reference number.
	69
	70	.TP
	71	.B Publication
	72	.br
	73	The
	74	.B publication
	75	ID is a random number used internally to represent a publication.
	76
	77	.TP
	78	.B Scope
	79	.br
	80	The publication
	81	.B scope
	82	specifies the visibility of a bound port name.
	83	The
	84	.B scope
	85	can be specified to comprise three different domains:
	86	.BR node ", " "cluster " "and " zone.
	87	Applications residing within the specified
	88	.B scope
	89	can see and access the port using the displayed port name.
	90
	91	.SH EXIT STATUS
	92	Exit status is 0 if command was successful or a positive integer upon failure.
	93
	94	.SH SEE ALSO
95	.BR tipc (8),
96	.BR tipc-bearer (8),
97	.BR tipc-link (8),
98	.BR tipc-media (8),
99	.BR tipc-node (8),
535194a1	100	.BR tipc-peer (8),
dcd8d142 RA	101	.BR tipc-socket (8)
	102	.br
	103	.SH REPORTING BUGS
	104	Report any bugs to the Network Developers mailing list
	105	.B <netdev@vger.kernel.org>
	106	where the development and maintenance is primarily done.
	107	You do not have to be subscribed to the list to send a message there.
	108
	109	.SH AUTHOR
	110	Richard Alpe <richard.alpe@ericsson.com>