xref: /freebsd/lib/libsysdecode/sysdecode_sockopt_name.3 (revision 5dae51da3da0cc94d17bd67b308fad304ebec7e0)
1.\"
2.\" Copyright (c) 2016 John Baldwin <jhb@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd October 17, 2016
29.Dt sysdecode_sockopt_name 3
30.Os
31.Sh NAME
32.Nm sysdecode_sockopt_name
33.Nd lookup name of socket option
34.Sh LIBRARY
35.Lb libsysdecode
36.Sh SYNOPSIS
37.In sys/types.h
38.In stdbool.h
39.In sysdecode.h
40.Ft const char *
41.Fn sysdecode_sockopt_name "int level" "int optname"
42.Sh DESCRIPTION
43The
44.Fn sysdecode_sockopt_name
45function returns a text description of the socket option name passed in the
46.Fa optname
47argument to
48.Xr getsockopt 2 .
49.Fn sysdecode_sockopt_name
50takes the socket option
51.Fa level
52as well as the option name to uniquely identify the option.
53.Sh SEE ALSO
54.Xr sysdecode_sockopt_level 3
55.Sh BUGS
56Socket option levels and names are protocol-specific.
57Both
58.Fn sysdecode_sockopt_level
59and
60.Fn sysdecode_sockopt_name
61should possibly accept the protocol family as an additional argument.
62