xref: /freebsd/usr.bin/genl/genl.1 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\"
2.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3.\"
4.\" Copyright (c) 2023 Baptiste Daroussin <bapt@nours.eu>
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd Oct 5, 2023
28.Dt GENL 1
29.Os
30.Sh NAME
31.Nm genl
32.Nd "generic netlink"
33.Sh SYNOPSIS
34.Nm
35.Pp
36.Nm Cm list
37.Pp
38.Nm Cm monitor Ao family Ac Ao multicast group Ac
39.Sh DESCRIPTION
40The
41.Nm
42utility is design to provide access to the user to generic netlink
43protocols.
44.Pp
45The following commands are available:
46.Bl -tag -ident
47.It Cm list Po default Pc
48Lists all available generic netlink protocols, and presents its details:
49.Bl -tag -width "multicast groups"
50.It operations
51Id of the operation if any and associated capabilities
52.It multicast groups
53If of the available multicast group if any and it associated name
54.El
55.It Cm monitor Ao family Ac Ao multicast group Ac
56Connect to the
57.Ar family
58protocol and subscribe to the
59.Ar mulicast group
60then print the received messages in a readable format if the protocol is known.
61So far only
62.Qq nlctrl
63is known.
64.El
65.Sh SEE ALSO
66.Xr genetlink 4 ,
67.Xr netlink 4
68