lib/libsysdecode/sysdecode_sockopt_name.3

   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 .Dd October 17, 2016
  26 .Dt sysdecode_sockopt_name 3
  27 .Os
  28 .Sh NAME
  29 .Nm sysdecode_sockopt_name
  30 .Nd lookup name of socket option
  31 .Sh LIBRARY
  32 .Lb libsysdecode
  33 .Sh SYNOPSIS
  34 .In sysdecode.h
  35 .Ft const char *
  36 .Fn sysdecode_sockopt_name "int level" "int optname"
  37 .Sh DESCRIPTION
  38 The
  39 .Fn sysdecode_sockopt_name
  40 function returns a text description of the socket option name passed in the
  41 .Fa optname
  42 argument to
  43 .Xr getsockopt 2 .
  44 .Fn sysdecode_sockopt_name
  45 takes the socket option
  46 .Fa level
  47 as well as the option name to uniquely identify the option.
  48 .Sh SEE ALSO
  49 .Xr sysdecode_sockopt_level 3
  50 .Sh BUGS
  51 Socket option levels and names are protocol-specific.
  52 Both
  53 .Fn sysdecode_sockopt_level
  54 and
  55 .Fn sysdecode_sockopt_name
  56 should possibly accept the protocol family as an additional argument.