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