| 1 |
.TH GENL 8 "29 Oct 2015" "iproute2" "Linux" |
| 2 |
.SH NAME |
| 3 |
genl \- generic netlink utility frontend |
| 4 |
.SH SYNOPSIS |
| 5 |
.in +8 |
| 6 |
.ti -8 |
| 7 |
.BR genl "[ " OPTIONS " ] " OBJECT |
| 8 |
.ti -8 |
| 9 |
.BR genl " { " -V [ ersion "] | " -h [ elp "] }" |
| 10 |
|
| 11 |
.ti -8 |
| 12 |
.IR OPTIONS " := { " |
| 13 |
\fB\-s\fR[\fItatistics\fR] | |
| 14 |
\fB\-d\fR[\fIetails\fR] | |
| 15 |
\fB\-j\fR[son\fR] | |
| 16 |
\fB\-p\fR[retty\fR] } |
| 17 |
|
| 18 |
.ti -8 |
| 19 |
.IR OBJECT " := { " |
| 20 |
.B ctrl |
| 21 |
.IR CTRL_OPTS " }" |
| 22 |
|
| 23 |
.ti -8 |
| 24 |
.IR CTRL_OPTS " := { " |
| 25 |
.BR help " | " list " | " monitor " | " get |
| 26 |
.IR PARMS " }" |
| 27 |
|
| 28 |
.ti -8 |
| 29 |
.IR PARMS " := { " |
| 30 |
.B name |
| 31 |
.IR NAME " | " |
| 32 |
.B id |
| 33 |
.IR ID " }" |
| 34 |
.SH DESCRIPTION |
| 35 |
The |
| 36 |
.B genl |
| 37 |
utility provides a simple frontend to the generic netlink library. Although it's |
| 38 |
designed to support multiple |
| 39 |
.IR OBJECT s, |
| 40 |
for now only the |
| 41 |
.B ctrl |
| 42 |
object is available, which is used to query the generic netlink controller. |
| 43 |
.SS ctrl |
| 44 |
The generic netlink controller can be queried in various ways: |
| 45 |
.TP |
| 46 |
.B help |
| 47 |
This command just prints a help text for the |
| 48 |
.B ctrl |
| 49 |
object. |
| 50 |
.TP |
| 51 |
.B list |
| 52 |
Show the registered netlink users. |
| 53 |
.TP |
| 54 |
.B monitor |
| 55 |
Listen for generic netlink notifications. |
| 56 |
.TP |
| 57 |
.B get |
| 58 |
Query the controller for a given user, identified either by |
| 59 |
.BR name " or " id . |
| 60 |
.SH OPTIONS |
| 61 |
genl supports the following options. |
| 62 |
.TP |
| 63 |
.B \-h, \-help |
| 64 |
Show summary of options. |
| 65 |
.TP |
| 66 |
.B \-V, \-Version |
| 67 |
Show version of program. |
| 68 |
.TP |
| 69 |
.B \-s, \-stats, \-statistics |
| 70 |
Show object statistics. |
| 71 |
.TP |
| 72 |
.B \-d, \-details |
| 73 |
Show object details. |
| 74 |
.TP |
| 75 |
.B -j, \-json |
| 76 |
Output results in JavaScript Object Notation (JSON). |
| 77 |
.TP |
| 78 |
.B -p, \-pretty |
| 79 |
Add indentation for readability. |
| 80 |
.TP |
| 81 |
.B \-r, \-raw |
| 82 |
Dump raw output only. |
| 83 |
.SH SEE ALSO |
| 84 |
.BR ip (8) |
| 85 |
.br |
| 86 |
.SH AUTHOR |
| 87 |
genl was written by Jamal Hadi Salim <[email protected]>. |
| 88 |
.PP |
| 89 |
This manual page was written by Petr Sabata <[email protected]>. |