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 July 14, 2007
  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 however, require the third argument to be a
  64 .Vt caddr_t
  65 or an
  66 .Vt int .
  67 .Pp
  68 An
  69 .Fn ioctl
  70 .Fa request
  71 has encoded in it whether the argument is an
  72 .Dq in
  73 argument
  74 or
  75 .Dq out
  76 argument, and the size of the argument
  77 .Fa argp
  78 in bytes.
  79 Macros and defines used in specifying an ioctl
  80 .Fa request
  81 are located in the file
  82 .In sys/ioctl.h .
  83 .Sh RETURN VALUES
  84 If an error has occurred, a value of -1 is returned and
  85 .Va errno
  86 is set to indicate the error.
  87 .Sh ERRORS
  88 The
  89 .Fn ioctl
  90 system call
  91 will fail if:
  92 .Bl -tag -width Er
  93 .It Bq Er EBADF
  94 The
  95 .Fa d
  96 argument
  97 is not a valid descriptor.
  98 .It Bq Er ENOTTY
  99 The
 100 .Fa d
 101 argument
 102 is not associated with a character
 103 special device.
 104 .It Bq Er ENOTTY
 105 The specified request does not apply to the kind
 106 of object that the descriptor
 107 .Fa d
 108 references.
 109 .It Bq Er EINVAL
 110 The
 111 .Fa request
 112 or
 113 .Fa argp
 114 argument
 115 is not valid.
 116 .It Bq Er EFAULT
 117 The
 118 .Fa argp
 119 argument
 120 points outside the process's allocated address space.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr execve 2 ,
 124 .Xr fcntl 2 ,
 125 .Xr intro 4 ,
 126 .Xr tty 4
 127 .Sh HISTORY
 128 The
 129 .Fn ioctl
 130 function appeared in
 131 .At v7 .