projects / mirror_iproute2.git / blame
| Commit | Line | Data |
|---|---|---|
| dcd8d142 RA |
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 | ||
| 1304f50a HL |
43 | .TP |
| 44 | .BR "\-j", " \-json" | |
| 45 | Output results in JavaScript Object Notation (JSON). | |
| 46 | ||
| 47 | .TP | |
| 48 | .BR "\-p", " \-pretty" | |
| 49 | The default JSON format is compact and more efficient to parse but hard for most users to read. | |
| 50 | This flag adds indentation for readability. | |
| 51 | ||
| dcd8d142 RA |
52 | .SH COMMANDS |
| 53 | ||
| 54 | .TP | |
| 55 | .B BEARER | |
| 56 | - Show or modify TIPC bearers | |
| 57 | ||
| 58 | .TP | |
| 59 | .B LINK | |
| 60 | - Show or modify TIPC links | |
| 61 | ||
| 62 | .TP | |
| 63 | .B MEDIA | |
| 64 | - Show or modify TIPC media | |
| 65 | ||
| 66 | .TP | |
| 67 | .B NAMETABLE | |
| 68 | - Show TIPC nametable | |
| 69 | ||
| 70 | .TP | |
| 71 | .B NODE | |
| 72 | - Show or modify TIPC node parameters | |
| 73 | ||
| 74 | .TP | |
| 75 | .B SOCKET | |
| 76 | - Show TIPC sockets | |
| 77 | ||
| 78 | .SH ARGUMENTS | |
| 79 | ||
| 80 | Command arguments are described in a command specific man page and typically | |
| 81 | consists of nested commands along with key value pairs. | |
| 82 | If no arguments are given a command typically shows its help text. The explicit | |
| 83 | help option | |
| 84 | .B -h | |
| 85 | or | |
| 86 | .B --help | |
| 87 | can occur anywhere among the arguments and will show help for the last valid | |
| 88 | command given. | |
| 89 | ||
| 90 | .SH EXIT STATUS | |
| 91 | Exit status is 0 if command was successful or a positive integer upon failure. | |
| 92 | ||
| 93 | .SH SEE ALSO | |
| 94 | .BR tipc-bearer (8), | |
| 95 | .BR tipc-link (8), | |
| 96 | .BR tipc-media (8), | |
| 97 | .BR tipc-nametable (8), | |
| 98 | .BR tipc-node (8), | |
| 535194a1 | 99 | .BR tipc-peer (8), |
| dcd8d142 RA |
100 | .BR tipc-socket (8) |
| 101 | .br | |
| 102 | .SH REPORTING BUGS | |
| 103 | Report any bugs to the Network Developers mailing list | |
| 104 | .B <netdev@vger.kernel.org> | |
| 105 | where the development and maintenance is primarily done. | |
| 106 | You do not have to be subscribed to the list to send a message there. | |
| 107 | ||
| 108 | .SH AUTHOR | |
| 109 | Richard Alpe <richard.alpe@ericsson.com> |