lib/libsysdecode/sysdecode.3

   1 .\"
   2 .\" Copyright (c) 2015 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 April 26, 2018
  28 .Dt SYSDECODE 3
  29 .Os
  30 .Sh NAME
  31 .Nm sysdecode
  32 .Nd system argument decoding library
  33 .Sh LIBRARY
  34 .Lb libsysdecode
  35 .Sh SYNOPSIS
  36 .In sys/types.h
  37 .In stdbool.h
  38 .In sysdecode.h
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 library includes several functions that provide descriptive names of
  43 values associated with system calls.
  44 .Ss Supported ABIs
  45 Some functions in this library provide ABI-specific descriptions.
  46 The supported ABIs are named by the
  47 .Vt enum sysdecode_abi
  48 enumeration.
  49 .Pp
  50 .Bl -tag -width "Li SYSDECODE_ABI_CLOUDABI64" -compact
  51 .It Li SYSDECODE_ABI_FREEBSD
  52 Native FreeBSD binaries.
  53 Supported on all platforms.
  54 .It Li SYSDECODE_ABI_FREEBSD32
  55 32-bit FreeBSD binaries.
  56 Supported on amd64 and powerpc64.
  57 .It Li SYSDECODE_ABI_LINUX
  58 Linux binaries of the same platform.
  59 Supported on amd64, i386, and arm64.
  60 .It Li SYSDECODE_ABI_LINUX32
  61 32-bit Linux binaries.
  62 Supported on amd64.
  63 .It Li SYSDECODE_ABI_CLOUDABI32
  64 32-bit CloudABI binaries.
  65 Supported on all platforms.
  66 .It Li SYSDECODE_ABI_CLOUDABI64
  67 64-bit CloudABI binaries.
  68 Supported on all platforms.
  69 .It Li SYSDECODE_ABI_UNKNOWN
  70 A placeholder for use when the ABI is not known.
  71 .El
  72 .Sh SEE ALSO
  73 .Xr sysdecode_abi_to_freebsd_errno 3 ,
  74 .Xr sysdecode_cap_rights 3 ,
  75 .Xr sysdecode_cmsg_type 3 ,
  76 .Xr sysdecode_enum 3 ,
  77 .Xr sysdecode_fcntl_arg 3 ,
  78 .Xr sysdecode_ioctlname 3 ,
  79 .Xr sysdecode_kevent 3 ,
  80 .Xr sysdecode_mask 3 ,
  81 .Xr sysdecode_quotactl_cmd 3 ,
  82 .Xr sysdecode_sctp_sinfo_flags 3 ,
  83 .Xr sysdecode_sigcode 3 ,
  84 .Xr sysdecode_socket_protocol 3 ,
  85 .Xr sysdecode_sockopt_name 3 ,
  86 .Xr sysdecode_syscallnames 3 ,
  87 .Xr sysdecode_utrace 3
  88 .Sh HISTORY
  89 The
  90 .Nm
  91 library first appeared in
  92 .Fx 11.0 .