Commit | Line | Data |
---|---|---|
931b8415 CL |
1 | .\" Copyright (c) 1980, 1991 Regents of the University of California. |
2 | .\" All rights reserved. | |
384b8076 | 3 | .\" |
c0567266 KB |
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 | .\" 3. All advertising materials mentioning features or use of this software | |
13 | .\" must display the following acknowledgement: | |
14 | .\" This product includes software developed by the University of | |
15 | .\" California, Berkeley and its contributors. | |
16 | .\" 4. Neither the name of the University nor the names of its contributors | |
17 | .\" may be used to endorse or promote products derived from this software | |
18 | .\" without specific prior written permission. | |
19 | .\" | |
20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
30 | .\" SUCH DAMAGE. | |
931b8415 | 31 | .\" |
af359dea C |
32 | .\" @(#)ioctl.2 6.4 (Berkeley) 3/10/91 |
33 | .\" | |
34 | .Dd March 10, 1991 | |
931b8415 CL |
35 | .Dt IOCTL 2 |
36 | .Os BSD 4 | |
37 | .Sh NAME | |
38 | .Nm ioctl | |
39 | .Nd control device | |
40 | .Sh SYNOPSIS | |
41 | .Fd #include <sys/ioctl.h> | |
42 | .Ft int | |
43 | .Fn ioctl "int d" "unsigned long request" "char *argp" | |
44 | .Sh DESCRIPTION | |
45 | The | |
46 | .Fn ioctl | |
47 | function manipulates the underlying device parameters of special files. | |
48 | In particular, many operating | |
6234b5e5 KM |
49 | characteristics of character special files (e.g. terminals) |
50 | may be controlled with | |
931b8415 | 51 | .Fn ioctl |
6234b5e5 | 52 | requests. |
931b8415 CL |
53 | The argument |
54 | .Fa d | |
55 | must be an open file descriptor. | |
56 | .Pp | |
6234b5e5 | 57 | An ioctl |
931b8415 CL |
58 | .Fa request |
59 | has encoded in it whether the argument is an | |
60 | .Dq in | |
61 | parameter | |
62 | or | |
63 | .Dq out | |
64 | parameter, and the size of the argument | |
65 | .Fa argp | |
66 | in bytes. | |
6234b5e5 | 67 | Macros and defines used in specifying an ioctl |
931b8415 | 68 | .Fa request |
6234b5e5 | 69 | are located in the file |
931b8415 CL |
70 | .Ao Pa sys/ioctl.h Ac . |
71 | .Sh RETURN VALUES | |
72 | If an error has occurred, a value of -1 is returned and | |
73 | .Va errno | |
6234b5e5 | 74 | is set to indicate the error. |
931b8415 CL |
75 | .Sh ERRORS |
76 | .Fn Ioctl | |
77 | will fail: | |
78 | .Bl -tag -width [ENOTTY] | |
79 | .It Bq Er EBADF | |
80 | .Fa d | |
81 | is not a valid descriptor. | |
82 | .It Bq Er ENOTTY | |
83 | .Fa d | |
84 | is not associated with a character | |
6234b5e5 | 85 | special device. |
931b8415 | 86 | .It Bq Er ENOTTY |
6234b5e5 | 87 | The specified request does not apply to the kind |
931b8415 CL |
88 | of object that the descriptor |
89 | .Fa d | |
90 | references. | |
91 | .It Bq Er EINVAL | |
92 | .Fa Request | |
93 | or | |
94 | .Fa argp | |
95 | is not valid. | |
96 | .El | |
97 | .Sh SEE ALSO | |
931b8415 CL |
98 | .Xr execve 2 , |
99 | .Xr fcntl 2 , | |
af359dea | 100 | .Xr mt 4 , |
931b8415 CL |
101 | .Xr tty 4 , |
102 | .Xr intro 4 | |
103 | .Sh HISTORY | |
104 | An | |
105 | .Nm | |
106 | function call appeared in Version 7 AT&T UNIX. |