lib/libsysdecode/sysdecode.3

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