xref: /freebsd-12.1/lib/libsysdecode/sysdecode.3 (revision 9a16bd16)
1d6fb4894SJohn Baldwin.\"
2d6fb4894SJohn Baldwin.\" Copyright (c) 2015 John Baldwin <[email protected]>
3d6fb4894SJohn Baldwin.\" All rights reserved.
4d6fb4894SJohn Baldwin.\"
5d6fb4894SJohn Baldwin.\" Redistribution and use in source and binary forms, with or without
6d6fb4894SJohn Baldwin.\" modification, are permitted provided that the following conditions
7d6fb4894SJohn Baldwin.\" are met:
8d6fb4894SJohn Baldwin.\" 1. Redistributions of source code must retain the above copyright
9d6fb4894SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer.
10d6fb4894SJohn Baldwin.\" 2. Redistributions in binary form must reproduce the above copyright
11d6fb4894SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer in the
12d6fb4894SJohn Baldwin.\"    documentation and/or other materials provided with the distribution.
13d6fb4894SJohn Baldwin.\"
14d6fb4894SJohn Baldwin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15d6fb4894SJohn Baldwin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16d6fb4894SJohn Baldwin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17d6fb4894SJohn Baldwin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18d6fb4894SJohn Baldwin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19d6fb4894SJohn Baldwin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20d6fb4894SJohn Baldwin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21d6fb4894SJohn Baldwin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22d6fb4894SJohn Baldwin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23d6fb4894SJohn Baldwin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24d6fb4894SJohn Baldwin.\" SUCH DAMAGE.
25d6fb4894SJohn Baldwin.\"
26d6fb4894SJohn Baldwin.\" $FreeBSD$
27d6fb4894SJohn Baldwin.\"
28*9a16bd16SEd Maste.Dd April 26, 2018
29d6fb4894SJohn Baldwin.Dt SYSDECODE 3
30d6fb4894SJohn Baldwin.Os
31d6fb4894SJohn Baldwin.Sh NAME
32d6fb4894SJohn Baldwin.Nm sysdecode
33d6fb4894SJohn Baldwin.Nd system argument decoding library
34d6fb4894SJohn Baldwin.Sh LIBRARY
35d6fb4894SJohn Baldwin.Lb libsysdecode
369289f547SJohn Baldwin.Sh SYNOPSIS
379289f547SJohn Baldwin.In sys/types.h
389289f547SJohn Baldwin.In stdbool.h
399289f547SJohn Baldwin.In sysdecode.h
40d6fb4894SJohn Baldwin.Sh DESCRIPTION
41d6fb4894SJohn BaldwinThe
42d6fb4894SJohn Baldwin.Nm
43d6fb4894SJohn Baldwinlibrary includes several functions that provide descriptive names of
44d6fb4894SJohn Baldwinvalues associated with system calls.
45a5f14abfSJohn Baldwin.Ss Supported ABIs
46a5f14abfSJohn BaldwinSome functions in this library provide ABI-specific descriptions.
47a5f14abfSJohn BaldwinThe supported ABIs are named by the
48a5f14abfSJohn Baldwin.Vt enum sysdecode_abi
49a5f14abfSJohn Baldwinenumeration.
50a5f14abfSJohn Baldwin.Pp
515842bd68SJohn Baldwin.Bl -tag -width "Li SYSDECODE_ABI_CLOUDABI64" -compact
525842bd68SJohn Baldwin.It Li SYSDECODE_ABI_FREEBSD
53a5f14abfSJohn BaldwinNative FreeBSD binaries.
54a5f14abfSJohn BaldwinSupported on all platforms.
555842bd68SJohn Baldwin.It Li SYSDECODE_ABI_FREEBSD32
56a5f14abfSJohn Baldwin32-bit FreeBSD binaries.
57a5f14abfSJohn BaldwinSupported on amd64 and powerpc64.
585842bd68SJohn Baldwin.It Li SYSDECODE_ABI_LINUX
59a5f14abfSJohn BaldwinLinux binaries of the same platform.
60*9a16bd16SEd MasteSupported on amd64, i386, and arm64.
615842bd68SJohn Baldwin.It Li SYSDECODE_ABI_LINUX32
62a5f14abfSJohn Baldwin32-bit Linux binaries.
63a5f14abfSJohn BaldwinSupported on amd64.
6487f69beeSEd Schouten.It Li SYSDECODE_ABI_CLOUDABI32
6587f69beeSEd Schouten32-bit CloudABI binaries.
6687f69beeSEd SchoutenSupported on all platforms.
675842bd68SJohn Baldwin.It Li SYSDECODE_ABI_CLOUDABI64
68a5f14abfSJohn Baldwin64-bit CloudABI binaries.
6987f69beeSEd SchoutenSupported on all platforms.
705842bd68SJohn Baldwin.It Li SYSDECODE_ABI_UNKNOWN
71a5f14abfSJohn BaldwinA placeholder for use when the ABI is not known.
72a5f14abfSJohn Baldwin.El
73d6fb4894SJohn Baldwin.Sh SEE ALSO
74287b96ddSJohn Baldwin.Xr sysdecode_abi_to_freebsd_errno 3 ,
759289f547SJohn Baldwin.Xr sysdecode_cap_rights 3 ,
76a826eb5aSMichael Tuexen.Xr sysdecode_cmsg_type 3 ,
779289f547SJohn Baldwin.Xr sysdecode_enum 3 ,
789289f547SJohn Baldwin.Xr sysdecode_fcntl_arg 3 ,
79265e5898SJohn Baldwin.Xr sysdecode_ioctlname 3 ,
80ffb66079SJohn Baldwin.Xr sysdecode_kevent 3 ,
819289f547SJohn Baldwin.Xr sysdecode_mask 3 ,
829289f547SJohn Baldwin.Xr sysdecode_quotactl_cmd 3 ,
831e6455d8SMichael Tuexen.Xr sysdecode_sctp_sinfo_flags 3 ,
849289f547SJohn Baldwin.Xr sysdecode_sigcode 3 ,
852bdd2e7eSJohn Baldwin.Xr sysdecode_socket_protocol 3 ,
869289f547SJohn Baldwin.Xr sysdecode_sockopt_name 3 ,
87a5f14abfSJohn Baldwin.Xr sysdecode_syscallnames 3 ,
88d6fb4894SJohn Baldwin.Xr sysdecode_utrace 3
89d6fb4894SJohn Baldwin.Sh HISTORY
90d6fb4894SJohn BaldwinThe
91d6fb4894SJohn Baldwin.Nm
92d6fb4894SJohn Baldwinlibrary first appeared in
93d6fb4894SJohn Baldwin.Fx 11.0 .
94