]> git.proxmox.com Git - mirror_iproute2.git/blob - man/man8/tipc.8
Merge branch 'master' into net-next
[mirror_iproute2.git] / man / man8 / tipc.8
1 .TH TIPC 8 "02 Jun 2015" "iproute2" "Linux"
2 .SH NAME
3 tipc \- a TIPC configuration and management tool
4 .SH SYNOPSIS
5
6 .ad l
7 .in +8
8 .ti -8
9 .B tipc
10 .RI "[ " OPTIONS " ] " COMMAND " " ARGUMENTS "
11 .sp
12
13 .ti -8
14 .IR COMMAND " := { "
15 .BR bearer " | " link " | " media " | " nametable " | " node " | " socket " }
16 .sp
17
18 .ti -8
19 .IR OPTIONS " := { "
20 \fB\-h\fR[\fIhelp\fR] }
21
22 .SH DESCRIPTION
23 The Transparent Inter-Process Communication (TIPC) protocol offers total address
24 transparency between processes which allows applications in a clustered computer
25 environment to communicate quickly and reliably with each other, regardless of
26 their location within the cluster.
27
28 TIPC originated at the telecommunications manufacturer Ericsson. The first open
29 source version of TIPC was created in 2000 when Ericsson released its first
30 Linux version of TIPC. TIPC was introduced in the mainline Linux kernel in 2006
31 and is now widely used both within and outside of Ericsson.
32
33 .SH OPTIONS
34
35 .TP
36 .BR "\-h" , " --help"
37 Show help about last given command. For example
38 .B tipc bearer --help
39 will show bearer help and
40 .B tipc --help
41 will show general help. The position of the option in the string is irrelevant.
42
43 .SH COMMANDS
44
45 .TP
46 .B BEARER
47 - Show or modify TIPC bearers
48
49 .TP
50 .B LINK
51 - Show or modify TIPC links
52
53 .TP
54 .B MEDIA
55 - Show or modify TIPC media
56
57 .TP
58 .B NAMETABLE
59 - Show TIPC nametable
60
61 .TP
62 .B NODE
63 - Show or modify TIPC node parameters
64
65 .TP
66 .B SOCKET
67 - Show TIPC sockets
68
69 .SH ARGUMENTS
70
71 Command arguments are described in a command specific man page and typically
72 consists of nested commands along with key value pairs.
73 If no arguments are given a command typically shows its help text. The explicit
74 help option
75 .B -h
76 or
77 .B --help
78 can occur anywhere among the arguments and will show help for the last valid
79 command given.
80
81 .SH EXIT STATUS
82 Exit status is 0 if command was successful or a positive integer upon failure.
83
84 .SH SEE ALSO
85 .BR tipc-bearer (8),
86 .BR tipc-link (8),
87 .BR tipc-media (8),
88 .BR tipc-nametable (8),
89 .BR tipc-node (8),
90 .BR tipc-socket (8)
91 .br
92 .SH REPORTING BUGS
93 Report any bugs to the Network Developers mailing list
94 .B <netdev@vger.kernel.org>
95 where the development and maintenance is primarily done.
96 You do not have to be subscribed to the list to send a message there.
97
98 .SH AUTHOR
99 Richard Alpe <richard.alpe@ericsson.com>