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