lib/libc/sys/ioctl.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)ioctl.2     8.2 (Berkeley) 12/11/93
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd December 11, 1993
  33 .Dt IOCTL 2
  34 .Os
  35 .Sh NAME
  36 .Nm ioctl
  37 .Nd control device
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/ioctl.h
  42 .Ft int
  43 .Fn ioctl "int d" "unsigned long request" ...
  44 .Sh DESCRIPTION
  45 The
  46 .Fn ioctl
  47 system call manipulates the underlying device parameters of special files.
  48 In particular, many operating
  49 characteristics of character special files (e.g.\& terminals)
  50 may be controlled with
  51 .Fn ioctl
  52 requests.
  53 The argument
  54 .Fa d
  55 must be an open file descriptor.
  56 .Pp
  57 The third argument to
  58 .Fn ioctl
  59 is traditionally named
  60 .Va "char *argp" .
  61 Most uses of
  62 .Fn ioctl
  63 in
  64 .Fx 3.0 ,
  65 however, require the third argument to be a
  66 .Vt caddr_t
  67 or an
  68 .Vt int .
  69 .Pp
  70 An
  71 .Fn ioctl
  72 .Fa request
  73 has encoded in it whether the argument is an
  74 .Dq in
  75 argument
  76 or
  77 .Dq out
  78 argument, and the size of the argument
  79 .Fa argp
  80 in bytes.
  81 Macros and defines used in specifying an ioctl
  82 .Fa request
  83 are located in the file
  84 .In sys/ioctl.h .
  85 .Sh RETURN VALUES
  86 If an error has occurred, a value of -1 is returned and
  87 .Va errno
  88 is set to indicate the error.
  89 .Sh ERRORS
  90 The
  91 .Fn ioctl
  92 system call
  93 will fail if:
  94 .Bl -tag -width Er
  95 .It Bq Er EBADF
  96 The
  97 .Fa d
  98 argument
  99 is not a valid descriptor.
 100 .It Bq Er ENOTTY
 101 The
 102 .Fa d
 103 argument
 104 is not associated with a character
 105 special device.
 106 .It Bq Er ENOTTY
 107 The specified request does not apply to the kind
 108 of object that the descriptor
 109 .Fa d
 110 references.
 111 .It Bq Er EINVAL
 112 The
 113 .Fa request
 114 or
 115 .Fa argp
 116 argument
 117 is not valid.
 118 .It Bq Er EFAULT
 119 The
 120 .Fa argp
 121 argument
 122 points outside the process's allocated address space.
 123 .El
 124 .Sh SEE ALSO
 125 .Xr execve 2 ,
 126 .Xr fcntl 2 ,
 127 .Xr intro 4 ,
 128 .Xr tty 4
 129 .Sh HISTORY
 130 The
 131 .Fn ioctl
 132 function appeared in
 133 .At v7 .