(split) LDP_man-pages: draft of ioctl.2 [JM:00406]

[linuxjm/LDP_man-pages.git] / draft / man2 / ioctl.2

.\" Copyright (c) 1980, 1991 Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"     This product includes software developed by the University of
.\"     California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)ioctl.2     6.4 (Berkeley) 3/10/91
.\"
.\" Modified 1993-07-23 by Rik Faith <faith@cs.unc.edu>
.\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com>
.\" Modified 1999-06-25 by Rachael Munns <vashti@dream.org.uk>
.\" Modified 2000-09-21 by Andries Brouwer <aeb@cwi.nl>
.\"
.\" Japanese Version Copyright (c) 1997-1999 HANATAKA Shinya
.\"         all rights reserved.
.\" Translated Sat Aug 14 10:10:27 JST 1999
.\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
.\" Modified 2002-09-24 by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\" Updated 2005-02-24, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\" Updated 2011-08-10, TACHIBANA Akira <tati@kc5.so-net.ne.jp>
.\" Updated 2011-09-15, TACHIBANA Akira <tati@kc5.so-net.ne.jp>
.\"
.\"WORD:        device                  ¥Ç¥Ð¥¤¥¹
.\"WORD:        control                 À©¸æ¤¹¤ë
.\"WORD:        special                 ¥¹¥Ú¥·¥ã¥ë
.\"WORD:        character               ¥­¥ã¥é¥¯¥¿
.\"WORD:        parameter               ¥Ñ¥é¥á¡¼¥¿
.\"WORD:        operate                 Áàºî
.\"WORD:        open                    ¥ª¡¼¥×¥ó
.\"WORD:        request                 ¥ê¥¯¥¨¥¹¥È
.\"WORD:        descriptor              ¥Ç¥£¥¹¥¯¥ê¥×¥¿
.\"WORD:        argument                °ú¤­¿ô
.\"WORD:        encode                  ¥¨¥ó¥³¡¼¥É
.\"
.TH IOCTL 2 2000-09-21 "Linux" "Linux Programmer's Manual"
.\"O .SH NAME
.\"O ioctl \- control device
.SH ̾Á°
ioctl \- ¥Ç¥Ð¥¤¥¹¤òÀ©¸æ¤¹¤ë
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.B #include <sys/ioctl.h>
.sp
.BI "int ioctl(int " d ", int " request ", ...);"
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O The
.\"O .BR ioctl ()
.\"O function manipulates the underlying device parameters of special files.
.\"O In particular, many operating characteristics of character special files
.\"O (e.g., terminals) may be controlled with
.\"O .BR ioctl ()
.\"O requests.
.\"O The argument
.\"O .I d
.\"O must be an open file descriptor.
.BR ioctl ()
´Ø¿ô¤Ï¥¹¥Ú¥·¥ã¥ë¡¦¥Õ¥¡¥¤¥ë¤ò¹½À®¤¹¤ë¥Ç¥Ð¥¤¥¹¤Î¥Ñ¥é¥á¡¼¥¿¤ò
Áàºî¤¹¤ë¡£Æäˡ¢¥­¥ã¥é¥¯¥¿·¿¤Î¥¹¥Ú¥·¥ã¥ë¡¦¥Õ¥¡¥¤¥ë (Î㤨¤ÐüËö (terminal))
¤Î¿¤¯¤ÎÁàºî²Äǽ¤ÊÆÃÀ­¤ò
.BR ioctl ()
¥ê¥¯¥¨¥¹¥È¤Ë¤è¤Ã¤ÆÀ©¸æ¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£°ú¤­¿ô
.I d
¤Ï¥ª¡¼¥×¥ó¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¡¦¥Ç¥£¥¹¥¯¥ê¥×¥¿¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.PP
.\"O The second argument is a device-dependent request code.
.\"O The third argument is an untyped pointer to memory.
.\"O It's traditionally
.\"O .BI "char *" argp
.\"O (from the days before
.\"O .B "void *"
.\"O was valid C), and will be so named for this discussion.
2 ÈÖÌܤΰú¤­¿ô¤Ï¡¢¥Ç¥Ð¥¤¥¹°Í¸¤Î¥ê¥¯¥¨¥¹¥È¡¦¥³¡¼¥É¤Ç¤¢¤ë¡£
3 ÈÖÌܤΰú¤­¿ô¤Ï¡¢¥á¥â¥ê¤Ø¤Î·¿¤ò»ØÄꤷ¤Ê¤¤¥Ý¥¤¥ó¥¿¤Ç¤¢¤ë¡£
¤³¤Î°ú¤­¿ô¤ÏÅÁÅýŪ¤Ë (C ¤Ç
.B "void *"
¤È¤¤¤¦½ñ¤­Êý¤¬Í­¸ú¤Ë¤Ê¤ëÁ°¤«¤é)
.BI "char *" argp
¤Èɽµ­¤µ¤ì¤Æ¤¤¤ë¡£¤·¤¿¤¬¤Ã¤Æ¡¢¤³¤Îʸ¾Ï¤Ç¤â¤½¤¦Ì¾ÉÕ¤±¤ë¤³¤È¤È¤¹¤ë¡£
.PP
.\"O An
.\"O .BR ioctl ()
.\"O .I request
.\"O has encoded in it whether the argument is an
.\"O .I in
.\"O parameter or
.\"O .I out
.\"O parameter, and the size of the argument
.\"O .I argp
.\"O in bytes.
.\"O Macros and defines used in specifying an
.\"O .BR ioctl ()
.\"O .I request
.\"O are located in the file
.\"O .IR <sys/ioctl.h> .
.BR ioctl ()
¤Î
.I request
¤Ë¤Ï¡¢
¤½¤Î°ú¤­¿ô¤¬
.I ÆþÎÏ
¥Ñ¥é¥á¡¼¥¿¤È
.I ½ÐÎÏ
¥Ñ¥é¥á¡¼¥¿¤Î¤É¤Á¤é¤Ç¤¢¤ë¤«¤Î¶èÊ̤䡢
.I argp
°ú¤­¿ô¤Î¥Ð¥¤¥Èñ°Ì¤Î¥µ¥¤¥º¡¢¤È¤¤¤Ã¤¿¾ðÊ󤬥¨¥ó¥³¡¼¥É¤µ¤ì¤Æ¤¤¤ë¡£
.BR ioctl ()
¤Î
.I request
¤ò»ØÄꤹ¤ë¤¿¤á¤Î¥Þ¥¯¥í (macro) ¤ÈÄêµÁ¤Ï
.I <sys/ioctl.h>
¥Õ¥¡¥¤¥ë¤Ë¤¢¤ë¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O Usually, on success zero is returned.
.\"O A few
.\"O .BR ioctl ()
.\"O requests use the return value as an output parameter
.\"O and return a nonnegative value on success.
¤¿¤¤¤Æ¤¤¤Î¾ì¹ç¡¢À®¸ù¤¹¤ë¤È¥¼¥í¤¬ÊÖ¤µ¤ì¤ë¡£
¤¿¤À¤·¡¢
.BR ioctl ()
¥ê¥¯¥¨¥¹¥È¤ÎÃæ¤Ë¤Ï¥Ñ¥é¥á¡¼¥¿¤Î½ÐÎϤËÊÖ¤êÃͤò»ÈÍѤ·¤Æ¤¤¤ë¤â¤Î¤¬¼ã´³¤¢¤ê¡¢
¤½¤Î¾ì¹ç¤Ï¡¢À®¸ù¤·¤¿¤È¤­¤ËÈóÉé¤ÎÃͤ¬ÊÖ¤µ¤ì¤ë¡£
.\"O On error, \-1 is returned, and
.\"O .I errno
.\"O is set appropriately.
¥¨¥é¡¼¤Î¾ì¹ç¤Ï \-1 ¤¬ÊÖ¤µ¤ì¡¢
.I errno
¤¬Å¬ÀÚ¤ËÀßÄꤵ¤ì¤ë¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.TP 0.7i
.B EBADF
.\"O .I d
.\"O is not a valid descriptor.
.I d
¤¬Í­¸ú¤Ê¥Ç¥£¥¹¥¯¥ê¥×¥¿¤Ç¤Ï¤Ê¤¤¡£
.TP
.B EFAULT
.\"O .I argp
.\"O references an inaccessible memory area.
.I argp
¤¬¥¢¥¯¥»¥¹ÉÔ²Äǽ¤Ê¥á¥â¥ê¤ò»²¾È¤·¤Æ¤¤¤ë¡£
.TP
.B EINVAL
.\"O .I Request
.\"O or
.\"O .I argp
.\"O is not valid.
.I request
¤Þ¤¿¤Ï
.I argp
¤¬ÉÔÀµ¤Ç¤¢¤ë¡£
.TP
.B ENOTTY
.\"O .I d
.\"O is not associated with a character special device.
.I d
¤¬¥­¥ã¥é¥¯¥¿·¿¤Î¥¹¥Ú¥·¥ã¥ë¡¦¥Ç¥Ð¥¤¥¹¤ò»²¾È¤·¤Æ¤¤¤Ê¤¤¡£
.TP
.B ENOTTY
.\"O The specified request does not apply to the kind of object that the
.\"O descriptor
.\"O .I d
.\"O references.
»ØÄꤵ¤ì¤¿¥ê¥¯¥¨¥¹¥È¤Ï¥Ç¥£¥¹¥¯¥ê¥×¥¿
.I d
¤¬»²¾È¤¹¤ë¼ïÎà¤Î¥ª¥Ö¥¸¥§¥¯¥È¤Ë¤ÏŬÍѤ¹¤ë¤³¤È¤¬¤Ç¤­¤Ê¤¤¡£
.\"O .SH CONFORMING TO
.SH ½àµò
.\"O No single standard.
.\"O Arguments, returns, and semantics of
.\"O .BR ioctl ()
.\"O vary according to the device driver in question (the call is used as a
.\"O catch-all for operations that don't cleanly fit the UNIX stream I/O
.\"O model).
.\"O See
.\"O .BR ioctl_list (2)
.\"O for a list of many of the known
.\"O .BR ioctl ()
.\"O calls.
¤É¤ì¤«°ì¤Ä¤Îɸ½à¤ËÂбþ¤·¤Æ¤¤¤ë¤ï¤±¤Ç¤Ï¤Ê¤¤¡£
.BR ioctl ()
¤Î°ú¤­¿ô¡¢ÊÖ¤êÃÍ¡¢²ò¼á¤Ï¡¢½èÍýÂоݤΥǥХ¤¥¹¡¦¥É¥é¥¤¥Ð¤´¤È¤Ë
°Û¤Ê¤ë (¤³¤Î´Ø¿ô¤Ï UNIX ¤Î ¥¹¥È¥ê¡¼¥à I/O ¥â¥Ç¥ë ¤Ë
¤­¤Á¤ó¤ÈŬ¹ç¤·¤Æ¤¤¤Ê¤¤Áàºî¤Î¤¿¤á¤ÎÊØÍø²°¤È¤·¤Æ»ÈÍѤµ¤ì¤ë)¡£
¤è¤¯ÃΤé¤ì¤Æ¤¤¤ë
.BR ioctl ()
¤Î¥ê¥¹¥È¤Ë¤Ä¤¤¤Æ¤Ï
.BR ioctl_list (2)
¤ò»²¾È¤¹¤ë¤³¤È¡£
.\"O The
.\"O .BR ioctl ()
.\"O function call appeared in Version 7 AT&T UNIX.
.BR ioctl ()
´Ø¿ô¥³¡¼¥ë¤Ï Version 7 AT&T UNIX ¤ÇÅо줷¤¿¡£
.\"O .SH NOTES
.SH Ãí°Õ
.\"O In order to use this call, one needs an open file descriptor.
.\"O Often the
.\"O .BR open (2)
.\"O call has unwanted side effects, that can be avoided under Linux
.\"O by giving it the
.\"O .B O_NONBLOCK
.\"O flag.
¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤ò»È¤¦¤Ë¤Ï¡¢¥ª¡¼¥×¥ó¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¡¦¥Ç¥£¥¹¥¯¥ê¥×¥¿¤¬
ɬÍפǤ¢¤ë¡£
.BR open (2)
¥³¡¼¥ë¤Ï¤·¤Ð¤·¤Ð˾¤ó¤Ç¤¤¤Ê¤¤ÉûºîÍѤòȼ¤¦¤³¤È¤¬¤¢¤ë¤¬¡¢Linux ¤Ç¤Ï
.BR open (2)
¤Ë
.B O_NONBLOCK
¥Õ¥é¥°¤ò¤Ä¤±¤ë¤³¤È¤Ç¤³¤ÎÉûºîÍѤòÈò¤±¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR execve (2),
.BR fcntl (2),
.BR ioctl_list (2),
.BR open (2),
.\" .BR mt (4),
.BR sd (4),
.BR tty (4)