Added section numbers to xrefs to other pages

This commit is contained in:
Michael Kerrisk 2007-05-11 23:18:56 +00:00
parent 393a89e698
commit 5e21af3ab8
9 changed files with 36 additions and 36 deletions

View File

@ -29,7 +29,7 @@
.SH NAME
console ioctl \- ioctl's for console terminal and virtual consoles
.SH DESCRIPTION
The following Linux-specific \fBioctl\fP() requests are supported.
The following Linux-specific \fBioctl\fP(2) requests are supported.
Each requires a third argument, assumed here to be \fIargp\fP.
.IP \fBKDGETLED\fP
Get state of LEDs. \fIargp\fP points to a long int.

View File

@ -49,10 +49,10 @@ to send and receive data using the bi-directional handshaked host
port.
.PP
To send a data stream to the signal processor, use
.BR write ()
.BR write (2)
to the
device, and
.BR read ()
.BR read (2)
to receive processed data.
The data can be sent or
received in 8, 16, 24, or 32-bit quantities on the host side, but will
@ -65,7 +65,7 @@ calls are used to control the
.IP \fBDSP56K_UPLOAD\fP
resets the DSP56001 and uploads a program.
The third
.BR ioctl ()
.BR ioctl (2)
argument must be a pointer to a \fBstruct dsp56k_binary\fP with members
\fBbin\fP pointing to a DSP56001 binary program, and \fBlen\fP set to
the length of the program, counted in 24-bit words.
@ -93,7 +93,7 @@ Bits 0 and 1 can be written by the host, and bits 2 and
3 can be written by the DSP56001.
To access the host flags, the third
.BR ioctl ()
.BR ioctl (2)
argument must be a pointer
to a \fBstruct dsp56k_host_flags\fP.
If bit 0 or 1 is set in the

View File

@ -83,7 +83,7 @@ For that reason, the default value is 0.
This is used for both the polling and the interrupt driver.
.IP "\fBint ioctl(int \fP\fIfd\fP\fB, LPSETIRQ, int \fP\fIarg\fP\fB)\fP"
This
.BR ioctl ()
.BR ioctl (2)
requires superuser privileges.
It takes an int containing the new IRQ as argument.
As a side effect, the printer will be reset.

View File

@ -124,9 +124,9 @@ The file
.I write_wakeup_threshold
contains the number of bits of entropy below which we wake up
processes that do a
.BR select ()
.BR select (2)
or
.BR poll ()
.BR poll (2)
for write access to
.IR /dev/random .
These values can be changed by writing to the files.

View File

@ -116,7 +116,7 @@ the types of interrupt that occurred,
while the remaining 3 bytes contain the number of interrupts since the
last
.BR read (2).
.SS ioctl() interface
.SS ioctl(2) interface
The following
.BR ioctl (2)
requests are defined on file descriptors connected to RTC devices:
@ -147,14 +147,14 @@ The fields in this structure have the same meaning and ranges as for the
structure described in
.BR gmtime (3).
A pointer to this structure should be passed as the third
.BR ioctl ()
.BR ioctl (2)
argument.
.TP
.B RTC_SET_TIME
Sets this RTC's time to the time specified by the
.I rtc_time
structure pointed to by the third
.BR ioctl ()
.BR ioctl (2)
argument.
To set the
RTC's time the process must be privileged (i.e., have the
@ -166,7 +166,7 @@ Read and set the alarm time, for RTCs that support alarms.
The alarm interrupt must be separately enabled or disabled using the
.BR RTC_AIE_ON ", " RTC_AIE_OFF
requests.
The third \fBioctl\fP() argument is a pointer to an
The third \fBioctl\fP(2) argument is a pointer to an
.I rtc_time
structure.
Only the
@ -182,7 +182,7 @@ for RTCs that support periodic interrupts.
The periodic interrupt must be separately enabled or disabled using the
.BR RTC_PIE_ON ", " RTC_PIE_OFF
requests.
The third \fBioctl\fP() argument is a
The third \fBioctl\fP(2) argument is a
.I "unsigned long\ *"
or a
.IR "unsigned long" ,
@ -198,17 +198,17 @@ capability) can set frequencies above the value specified in
.TP
.BR RTC_AIE_ON ", " RTC_AIE_OFF
Enable or disable the alarm interrupt, for RTCs that support alarms.
The third \fBioctl\fP() argument is ignored.
The third \fBioctl\fP(2) argument is ignored.
.TP
.BR RTC_UIE_ON ", " RTC_UIE_OFF
Enable or disable the interrupt on every clock update,
for RTCs that support this once-per-second interrupt.
The third \fBioctl\fP() argument is ignored.
The third \fBioctl\fP(2) argument is ignored.
.TP
.BR RTC_PIE_ON ", " RTC_PIE_OFF
Enable or disable the periodic interrupt,
for RTCs that support these periodic interrupts.
The third \fBioctl\fP() argument is ignored.
The third \fBioctl\fP(2) argument is ignored.
Only a privileged process (i.e., one having the
.B CAP_SYS_RESOURCE
capability) can enable the periodic interrupt if the frequency is
@ -227,7 +227,7 @@ an RTC register for the year.
With some RTCs,
these operations can be used to read or to set the RTC's Epoch,
respectively.
The third \fBioctl\fP() argument is a
The third \fBioctl\fP(2) argument is a
.I "unsigned long\ *"
or a
.IR "unsigned long" ,
@ -276,7 +276,7 @@ and
.IR tm_year
fields are also valid.
A pointer to this structure should be passed as the third
.BR ioctl ()
.BR ioctl (2)
argument.
.SH FILES
.IR /dev/rtc ", "

View File

@ -123,9 +123,9 @@ The
.BR ioctl (2)
operations are also supported.
If the
.BR ioctl ()
.BR ioctl (2)
parameter is required, and it is NULL, then
.BR ioctl ()
.BR ioctl (2)
will return \-EINVAL.
.SH FILES
/dev/sd[a\-h]: the whole device

View File

@ -123,7 +123,7 @@ For example, if the drive firmware selects fixed-block mode,
the tape device uses fixed-block mode.
The options can
be changed with explicit
.BR ioctl ()
.BR ioctl (2)
calls and remain in effect when the device is closed and reopened.
Setting the options affects both the auto-rewind and the non-rewind
device.
@ -145,19 +145,19 @@ have nothing to do with disk partitions.
A partitioned tape can be
seen as several logical tapes within one medium.)
Partition support has to be enabled with an
.BR ioctl ().
.BR ioctl (2).
The tape
location is preserved within each partition across partition changes.
The partition used for subsequent tape operations is
selected with an
.BR ioctl ().
.BR ioctl (2).
The partition switch is executed together with
the next tape operation in order to avoid unnecessary tape
movement.
The maximum number of partitions on a tape is defined by a
compile-time constant (originally four).
The driver contains an
.BR ioctl ()
.BR ioctl (2)
that can format a tape with either one or two partitions.
.PP
Device
@ -225,7 +225,7 @@ read calls.
The third read returns an error.
.SH IOCTLS
The driver supports three
.BR ioctl ()
.BR ioctl (2)
requests.
Requests not recognized by the
.B st
@ -666,7 +666,7 @@ writing on the current medium type.
.HP
\s-1GMT_ONLINE(\s+1\fIx\fP\s-1)\s+1:
The last
.BR open ()
.BR open (2)
found the drive with a tape in place and ready for operation.
.HP
\s-1GMT_D_6250(\s+1\fIx\fP\s-1)\s+1, \s-1GMT_D_1600(\s+1\fIx\fP\s-1)\s+1, \s-1GMT_D_800(\s+1\fIx\fP\s-1)\s+1:
@ -734,14 +734,14 @@ A write operation could not be completed because the tape reached
end-of-medium.
.IP ENOMEM
The byte count in
.BR read ()
.BR read (2)
is smaller than the next physical block on the tape.
(Before 2.2.18 and 2.4.0-test6 the extra bytes have been
silently ignored.)
.IP EACCES
An attempt was made to write or erase a write-protected tape.
(This error is not detected during
.BR open ().)
.BR open (2).)
.IP EFAULT
The command parameters point to memory not belonging to the calling
process.
@ -755,11 +755,11 @@ An attempt was made to read or write a variable-length block that is
larger than the driver's internal buffer.
.IP EINVAL
An
.BR ioctl ()
.BR ioctl (2)
had an illegal argument, or a requested block size was illegal.
.IP ENOSYS
Unknown
.BR ioctl ().
.BR ioctl (2).
.IP EROFS
Open is attempted with O_WRONLY or O_RDWR when the tape in the drive is
write-protected.
@ -815,9 +815,9 @@ if verbose SCSI messages are enabled in kernel configuration.
.PP
5. The driver's internal buffering allows good throughput in fixed-block
mode also with small
.BR read ()
.BR read (2)
and
.BR write ()
.BR write (2)
byte counts.
With direct transfers
this is not possible and may cause a surprise when moving to the 2.6

View File

@ -31,8 +31,8 @@ The file \fI/dev/tty\fP is a character file with major number 5 and
minor number 0, usually of mode 0666 and owner.group root.tty.
It is a synonym for the controlling terminal of a process, if any.
.LP
In addition to the \fBioctl\fP() requests supported by the device that
\fBtty\fP refers to, the \fBioctl\fP() request \fBTIOCNOTTY\fP is supported.
In addition to the \fBioctl\fP(2) requests supported by the device that
\fBtty\fP refers to, the \fBioctl\fP(2) request \fBTIOCNOTTY\fP is supported.
.SS TIOCNOTTY
Detach the current process from its controlling terminal.
.sp
@ -40,7 +40,7 @@ If the process is the session leader,
then SIGHUP and SIGCONT signals are sent to the foreground process group
and all processes in the current session lose their controlling tty.
.sp
This \fBioctl\fP() call only works on file descriptors connected
This \fBioctl\fP(2) call only works on file descriptors connected
to \fI/dev/tty\fP.
It is used by daemon processes when they are invoked
by a user at a terminal.

View File

@ -55,7 +55,7 @@ The devices for the first eight virtual consoles may be created by:
.fi
No
.BR ioctl ()
.BR ioctl (2)
requests are supported.
.SH EXAMPLE
You may do a screendump on vt3 by switching to vt1 and typing