xref: /netbsd-src/usr.bin/kdump/ioctlprint.1 (revision 7d62b00eb9ad855ffcd7da46b41e23feb5476fac)
1.\" $NetBSD: ioctlprint.1,v 1.5 2020/04/03 06:12:48 wiz Exp $
2.\"
3.\" Copyright (c) 2020 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Kamil Rytarowski.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd April 2, 2020
31.Dt IOCTLPRINT 1
32.Os
33.Sh NAME
34.Nm ioctlprint
35.Nd display descriptive ioctl value
36.Sh SYNOPSIS
37.Nm
38.Op Fl l
39.Op Fl e Ar emulation
40.Op Fl f Ar format
41.Op Ar arg ...
42.Sh DESCRIPTION
43The
44.Nm
45utility displays information about the file ioctl operation pointed
46to by one or more
47.Ar arg
48arguments.
49The argument can either be an
50.Xr ioctl 2
51symbolic name or the ioctl value.
52.Pp
53The options are as follows:
54.Bl -tag -width 12n
55.It Fl e Ar emulation
56If an emulation of a process is unknown,
57interpret system call maps assuming the named emulation instead of
58default "netbsd".
59.It Fl f Ar format
60The argument is a
61.Xr printf 3
62style format string that allows customization of
63.Nm ioctlprint Ap s
64output.
65.Pp
66The following conversion characters can be used:
67.Bl -tag -width 9n
68.It \&%E
69Symbolic decoded ioctl string.
70.It \&%e
71Decoded ioctl string with hex values.
72.It \&%n
73Descriptive ioctl operation name.
74.It \&%x
75Hexadecimal ioctl number.
76.It \&%o
77Octal ioctl number.
78.It \&%d or \&%i
79Decimal ioctl number.
80.El
81.Pp
82The default format is:
83.Bd -literal -offset indent
84"%n %e %x\\n"
85.Ed
86.It Fl l
87List all known
88.Xr ioctl 2
89requests.
90.El
91.Sh SEE ALSO
92.Xr kdump 1 ,
93.Xr ktrace 1
94.Sh HISTORY
95The
96.Nm
97command first appeared in
98.Nx 10 .
99.Sh AUTHORS
100.An Kamil Rytarowski Aq Mt kamil@NetBSD.org
101