diff options
Diffstat (limited to 'usr/src/man/man7i')
| -rw-r--r-- | usr/src/man/man7i/agpgart_io.7i | 169 | ||||
| -rw-r--r-- | usr/src/man/man7i/audio.7i | 41 | ||||
| -rw-r--r-- | usr/src/man/man7i/cdio.7i | 113 | ||||
| -rw-r--r-- | usr/src/man/man7i/dkio.7i | 173 | ||||
| -rw-r--r-- | usr/src/man/man7i/dsp.7i | 91 | ||||
| -rw-r--r-- | usr/src/man/man7i/fbio.7i | 2 | ||||
| -rw-r--r-- | usr/src/man/man7i/fdio.7i | 28 | ||||
| -rw-r--r-- | usr/src/man/man7i/hdio.7i | 14 | ||||
| -rw-r--r-- | usr/src/man/man7i/iec61883.7i | 57 | ||||
| -rw-r--r-- | usr/src/man/man7i/ipnat.7i | 37 | ||||
| -rw-r--r-- | usr/src/man/man7i/mhd.7i | 40 | ||||
| -rw-r--r-- | usr/src/man/man7i/mixer.7i | 93 | ||||
| -rw-r--r-- | usr/src/man/man7i/mtio.7i | 86 | ||||
| -rw-r--r-- | usr/src/man/man7i/prnio.7i | 39 | ||||
| -rw-r--r-- | usr/src/man/man7i/quotactl.7i | 37 | ||||
| -rw-r--r-- | usr/src/man/man7i/sesio.7i | 25 | ||||
| -rw-r--r-- | usr/src/man/man7i/sockio.7i | 8 | ||||
| -rw-r--r-- | usr/src/man/man7i/streamio.7i | 296 | ||||
| -rw-r--r-- | usr/src/man/man7i/termio.7i | 397 | ||||
| -rw-r--r-- | usr/src/man/man7i/termiox.7i | 74 | ||||
| -rw-r--r-- | usr/src/man/man7i/uscsi.7i | 75 | ||||
| -rw-r--r-- | usr/src/man/man7i/visual_io.7i | 28 | ||||
| -rw-r--r-- | usr/src/man/man7i/vt.7i | 22 |
23 files changed, 322 insertions, 1623 deletions
diff --git a/usr/src/man/man7i/agpgart_io.7i b/usr/src/man/man7i/agpgart_io.7i index 0ef0dd7a76..d92e300d99 100644 --- a/usr/src/man/man7i/agpgart_io.7i +++ b/usr/src/man/man7i/agpgart_io.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH agpgart_io 7I "25 Sep 2008" "SunOS 5.11" "Ioctl Requests" +.TH AGPGART_IO 7I "Sep 25, 2008" .SH NAME agpgart_io \- Solaris agpgart driver I/O control operations .SH SYNOPSIS @@ -64,7 +64,6 @@ AGPIOC_RELEASE. If the AGP_DEVICE fails to open, it may be due to one of the following reasons: .sp .ne 2 -.mk .na \fBEAGAIN\fR .ad @@ -75,7 +74,6 @@ GART table allocation failed. .sp .ne 2 -.mk .na \fBEIO\fR .ad @@ -86,7 +84,6 @@ Internal hardware initialization failed. .sp .ne 2 -.mk .na \fBENXIO\fR .ad @@ -97,7 +94,6 @@ Getting device soft state error. (This is unlikely to happen.) .sp .ne 2 -.mk .na \fB EPERM\fR .ad @@ -118,7 +114,6 @@ Common ioctl error codes are shown below. (Additional error codes may be displayed by individual ioctls.) .sp .ne 2 -.mk .na \fBENXIO\fR .ad @@ -129,7 +124,6 @@ Ioctl command not supported or getting device soft state error. .sp .ne 2 -.mk .na \fBEPERM\fR .ad @@ -140,7 +134,6 @@ Process not privileged. .sp .ne 2 -.mk .na \fB\fBAGPIOC_INFO\fR\fR .ad @@ -152,10 +145,10 @@ any process from user or kernel context. .in +2 .nf The argument is a pointer to agp_info_t structure. - + typedef struct _agp_info { agp_version_t agpi_version; /* OUT: AGP version supported */ - uint32_t agpi_devid; /* OUT: bridge vendor + device */ + uint32_t agpi_devid; /* OUT: bridge vendor + device */ uint32_t agpi_mode; /* OUT: mode of bridge */ ulong_t agpi_aperbase; /* OUT: base of aperture */ size_t agpi_apersize; /* OUT: aperture size in MB */ @@ -163,21 +156,21 @@ The argument is a pointer to agp_info_t structure. uint32_t agpi_pgsystem; /* OUT: same as pg_total */ uint32_t agpi_pgused; /* OUT: no. of currently used pages */ } agp_info_t; - + agpi_version The version of AGP protocol the bridge device is compatible with, for example, major 3 and minor 0 means AGP version 3.0. - + typedef struct _agp_version { uint16_t agpv_major; uint16_t agpv_minor; } agp_version_t; - + agpi_devid AGP bridge vendor and device ID. agpi_mode Current AGP mode, read from AGP status register of target device. The main bits are defined as below. /* AGP status register bits definition */ - + #define AGPSTAT_RQ_MASK 0xff000000 #define AGPSTAT_SBA (0x1 << 9) #define AGPSTAT_OVER4G (0x1 << 5) @@ -195,29 +188,29 @@ agpi_mode Current AGP mode, read from AGP status register of /* rate for 3.0 mode */ #define AGP3_RATE_4X 0x1 #define AGP3_RATE_8X 0x2 - + agpi_aperbase The base address of aperture in PCI memory space. agpi_apersize The size of the aperture in megabytes. -agpi_pgtotal Represents the maximum memory - pages the system can allocate - according to aperture size and - system memory size (which may differ - from the maximum locked memory a process +agpi_pgtotal Represents the maximum memory + pages the system can allocate + according to aperture size and + system memory size (which may differ + from the maximum locked memory a process can have. The latter is subject - to the memory resource limit imposed - by the resource_controls(5) for each + to the memory resource limit imposed + by the resource_controls(5) for each project(4)): project.max-device-locked-memory - - This value can be modified through system + + This value can be modified through system utilities like prctl(1). agpi_pgsystem Same as pg_total. agpi_pgused System pages already allocated by the driver. - + Return Values: - + EFAULT Argument copy out error EINVAL Command invalid 0 Success @@ -228,7 +221,6 @@ Return Values: .sp .ne 2 -.mk .na \fB\fBAGPIOC_ACQUIRE\fR\fR .ad @@ -246,23 +238,19 @@ The argument should be NULL. Return values: .sp .ne 2 -.mk .na \fBEBUSY\fR .ad .RS 9n -.rt GART has been acquired .RE .sp .ne 2 -.mk .na \fB0\fR .ad .RS 9n -.rt Success. .RE @@ -270,7 +258,6 @@ Success. .sp .ne 2 -.mk .na \fB\fBAGPIOC_RELEASE\fR\fR .ad @@ -288,23 +275,19 @@ The argument should be NULL. Return values: .sp .ne 2 -.mk .na \fBEPERM\fR .ad .RS 9n -.rt Not owner of GART. .RE .sp .ne 2 -.mk .na \fB0\fR .ad .RS 9n -.rt Success. .RE @@ -312,7 +295,6 @@ Success. .sp .ne 2 -.mk .na \fB\fBAGPIOC_SETUP\fR\fR .ad @@ -330,10 +312,10 @@ The argument is a pointer to agp_setup_t structure: typedef struct _agp_setup { uint32_t agps_mode; /* IN: value to be set for AGPCMD */ } agp_setup_t; - + agps_mode Specifying the mode to be set. Each bit of the value may have a specific meaning, please refer to AGP 2.0/3.0 specification - or hardware datasheets for details. + or hardware datasheets for details. /* AGP command register bits definition */ #define AGPCMD_RQ_MASK 0xff000000 @@ -355,56 +337,46 @@ decided by the agps_mode value and AGPSTAT of the master and target devices. Return Values: .sp .ne 2 -.mk .na \fBEPERM\fR .ad .RS 10n -.rt Not owner of GART. .RE .sp .ne 2 -.mk .na \fBEFAULT\fR .ad .RS 10n -.rt Argument copy in error. .RE .sp .ne 2 -.mk .na \fBEINVAL\fR .ad .RS 10n -.rt Command invalid for non-AGP system. .RE .sp .ne 2 -.mk .na \fBEIO\fR .ad .RS 10n -.rt Hardware setup error. .RE .sp .ne 2 -.mk .na \fB0\fR .ad .RS 10n -.rt Success. .RE @@ -412,7 +384,6 @@ Success. .sp .ne 2 -.mk .na \fB\fBAGPIOC_ALLOCATE\fR\fR .ad @@ -442,23 +413,19 @@ The argument is a pointer to agp_allocate_t structure. .sp .ne 2 -.mk .na \fBagpa_key\fR .ad .RS 21n -.rt Unique ID of the allocated memory. .RE .sp .ne 2 -.mk .na \fBagpa_pgcount\fR .ad .RS 21n -.rt Number of pages to be allocated. The driver currently supports only 4K pages. The value cannot exceed the agpi_pgtotal value returned by AGPIOC_INFO ioct and is subject to the limit of project.max-device-locked-memory. If the memory @@ -469,12 +436,10 @@ resource limit beforehand. .sp .ne 2 -.mk .na \fBagpa_type\fR .ad .RS 21n -.rt Type of memory to be allocated. The valid value of agpa_type should be AGP_NORMAL. It is defined as: .sp @@ -491,67 +456,55 @@ which doesn't consume kernel virtual space but can be mapped to user space by .sp .ne 2 -.mk .na \fBagpa_physical\fR .ad .RS 21n -.rt Reserved for special uses. In normal operations, the value is undefined. .sp Return Values: .sp .ne 2 -.mk .na \fBEPERM\fR .ad .RS 10n -.rt Not owner of GART. .RE .sp .ne 2 -.mk .na \fBEINVAL\fR .ad .RS 10n -.rt Argument not valid. .RE .sp .ne 2 -.mk .na \fBEFAULT\fR .ad .RS 10n -.rt Argument copy in/out error. .RE .sp .ne 2 -.mk .na \fBENOMEM\fR .ad .RS 10n -.rt Memory allocation error. .RE .sp .ne 2 -.mk .na \fB0\fR .ad .RS 10n -.rt Success. .RE @@ -559,12 +512,10 @@ Success. .sp .ne 2 -.mk .na \fBAGPIOC_DEALLOCATE\fR .ad .RS 21n -.rt Deallocate the memory identified by a key assigned in a previous allocation. If the memory isn't unbound from GART, this command unbinds it automatically. The memory should no longer be used and those still in mapping to userland cannot @@ -578,34 +529,28 @@ The input argument is a key of type int32_t, no output argument. Return Values: .sp .ne 2 -.mk .na \fBEPERM\fR .ad .RS 10n -.rt Not owner of GART. .RE .sp .ne 2 -.mk .na \fBEINVAL\fR .ad .RS 10n -.rt Key not valid or memory in use. .RE .sp .ne 2 -.mk .na \fB0\fR .ad .RS 10n -.rt Success. .RE @@ -613,12 +558,10 @@ Success. .sp .ne 2 -.mk .na \fBAGPIOC_BIND\fR .ad .RS 21n -.rt Bind allocated memory. This command binds the allocated memory identified by a key to a specific offset of the GART table, which enables GART to translate the aperture range at the offset to system memory. Each GART entry @@ -641,80 +584,66 @@ The argument is a pointer to agp_bind_t structure: .sp .ne 2 -.mk .na \fBagpb_key\fR .ad .RS 20n -.rt The unique ID of the memory to be bound, which is previously allocated by calling AGPIOC_ALLOCATE. .RE .sp .ne 2 -.mk .na \fBagpb_pgstart\fR .ad .RS 20n -.rt The starting page offset to be bound in aperture space. .RE Return Values: .sp .ne 2 -.mk .na \fBEPERM\fR .ad .RS 20n -.rt Not owner of GART. .RE .sp .ne 2 -.mk .na \fBEFAULT\fR .ad .RS 20n -.rt Argument copy in error. .RE .sp .ne 2 -.mk .na \fBEINVAL\fR .ad .RS 20n -.rt Argument not valid. .RE .sp .ne 2 -.mk .na \fBEIO\fR .ad .RS 20n -.rt Binding to the GTT table of IGD devices failed. .RE .sp .ne 2 -.mk .na \fB0\fR .ad .RS 20n -.rt Success. .RE @@ -722,12 +651,10 @@ Success. .sp .ne 2 -.mk .na \fBAGPIOC_UNBIND\fR .ad .RS 21n -.rt Unbind memory identified by a key from the GART. This command clears the corresponding entries in the GART table. Only the memory not in mapping to userland is allowed to be unbound. @@ -747,80 +674,66 @@ The argument is a pointer to agp_unbind_t structure. .sp .ne 2 -.mk .na \fBagpu_key\fR .ad .RS 20n -.rt Unique ID of the memory to be unbound which was previously bound by calling AGPIOC_BIND. .RE .sp .ne 2 -.mk .na \fBagpu_pri\fR .ad .RS 20n -.rt Reserved for compatibility with X.org/XFree86, not used. .RE Return Values: .sp .ne 2 -.mk .na \fBEPERM\fR .ad .RS 20n -.rt Not owner of GART. .RE .sp .ne 2 -.mk .na \fBEFAULT\fR .ad .RS 20n -.rt Argument copy in error. .RE .sp .ne 2 -.mk .na \fBEINVAL\fR .ad .RS 20n -.rt Argument not valid or memory in use. .RE .sp .ne 2 -.mk .na \fBEIO\fR .ad .RS 20n -.rt Unbinding from the GTT table of IGD devices failed. .RE .sp .ne 2 -.mk .na \fB0\fR .ad .RS 20n -.rt Success .RE @@ -857,13 +770,13 @@ int main(int argc, char *argv[]) int *p = NULL; off_t mapoff; size_t maplen; - + if((fd = open(AGP_DEVICE, O_RDWR))== -1) { printf("open AGP_DEVICE error with %d\en", errno);\e exit(-1); } printf("device opened\en"); - + ret = ioctl(fd, AGPIOC_INFO, &agpinfo); if(ret == -1) { printf("Get info error %d\n", errno); @@ -873,20 +786,20 @@ int main(int argc, char *argv[]) printf("APBASE is %x\en", agpinfo.agpi_aperbase); printf("APSIZE is %dMB\en", agpinfo.agpi_apersize); printf("pg_total is %d\en", agpinfo.agpi_pgtotal); - + ret = ioctl(fd, AGPIOC_ACQUIRE); if(ret == -1) { printf(" Acquire GART error %d\en", errno); exit(-1); } - + modesetup.agps_mode = agpinfo.agpi_mode; ret = ioctl(fd, AGPIOC_SETUP, &modesetup); if(ret == -1) { printf("set up AGP mode error\en", errno); exit(-1); } - + printf("Please input the number of pages you want to allocate\en"); scanf("%d", &alloc.agpa_pgcount); alloc.agpa_type = AGP_NORMAL; @@ -895,7 +808,7 @@ int main(int argc, char *argv[]) printf("Allocate memory error %d\en", errno); exit(-1); } - + printf("Please input the aperture page offset to bind\en"); scanf("%d", &bindinfo.agpb_pgstart); bindinfo.agpb_key = alloc.agpa_key; @@ -905,14 +818,14 @@ int main(int argc, char *argv[]) exit(-1); } printf("Bind successful\en"); - + /* * Now gart aperture space from (bindinfo.agpb_pgstart) to * (bindinfo.agpb_pgstart + alloc.agpa_pgcount) can be used for * AGP graphics transactions */ ... - + /* * mmap can allow user processes to store graphics data * to the aperture space @@ -927,14 +840,14 @@ int main(int argc, char *argv[]) } printf("Mmap successful\en"); ... - + /* * When user processes finish access to the aperture space, * unmap the memory range */ munmap((void *)p, maplen); ... - + /* * After finishing AGP transactions, the resources can be freed * step by step or simply by close device. @@ -944,13 +857,13 @@ int main(int argc, char *argv[]) printf(" Deallocate memory error %d\en", errno); exit(-1); } - + ret = ioctl(fd, AGPIOC_RELEASE); if(ret == -1) { printf(" Release GART error %d\en", errno); exit(-1); } - + close(fd); } .fi @@ -959,7 +872,6 @@ int main(int argc, char *argv[]) .SH FILES .sp .ne 2 -.mk .na \fB\fB/dev/agpgart\fR\fR .ad @@ -970,7 +882,6 @@ Symbolic link to the pseudo agpgart device. .sp .ne 2 -.mk .na \fB\fB/platform/i86pc/kernel/drv/agpgart\fR\fR .ad @@ -981,7 +892,6 @@ agpgart pseudo driver. .sp .ne 2 -.mk .na \fB\fB/platform/i86pc/kernel/drv/agpgart.conf\fR\fR .ad @@ -998,15 +908,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(1.83i) |cw(3.67i) -lw(1.83i) |lw(3.67i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitectureX86 +Architecture X86 _ -Stability levelUnstable +Stability level Unstable .TE .SH SEE ALSO diff --git a/usr/src/man/man7i/audio.7i b/usr/src/man/man7i/audio.7i index 126b4fca4a..5a6a54ffec 100644 --- a/usr/src/man/man7i/audio.7i +++ b/usr/src/man/man7i/audio.7i @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH audio 7I "6 May 2009" "SunOS 5.11" "Ioctl Requests" +.TH AUDIO 7I "May 6, 2009" .SH NAME audio \- generic audio device interface .SH SYNOPSIS .LP .nf -\fB#include\fR \fB<sys/audio.h>\fR +\fB#include\fR \fB<sys/audio.h>\fR .fi .SH OVERVIEW @@ -595,12 +595,10 @@ notification of audio status changes, as described above. The audio device additionally supports the following \fBioctl\fR commands: .sp .ne 2 -.mk .na \fB\fBAUDIO_DRAIN\fR\fR .ad .RS 17n -.rt The argument is ignored. This command suspends the calling process until the output STREAMS queue is empty and all queued samples have been played, or until a signal is delivered to the calling process. It may not be issued for the @@ -610,12 +608,10 @@ final \fBclose()\fR of \fB/dev/audio\fR. .sp .ne 2 -.mk .na \fB\fBAUDIO_GETDEV\fR\fR .ad .RS 17n -.rt The argument is a pointer to an \fBaudio_device_t\fR structure. This command may be issued for either \fB/dev/audio\fR or \fB/dev/audioctl\fR. The returned value in the name field will be a string that will identify the current @@ -628,12 +624,10 @@ pages to determine the actual strings returned by the device driver. .sp .ne 2 -.mk .na \fB\fBAUDIO_GETINFO\fR\fR .ad .RS 17n -.rt The argument is a pointer to an \fBaudio_info_t\fR structure. This command may be issued for either \fB/dev/audio\fR or \fB/dev/audioctl\fR. The current state of the \fB/dev/audio\fR device is returned in the structure. @@ -644,12 +638,10 @@ the process, and do not necessarily reflect the actual hardware device itself. .sp .ne 2 -.mk .na \fB\fBAUDIO_SETINFO\fR\fR .ad .RS 17n -.rt The argument is a pointer to an \fBaudio_info_t\fR structure. This command may be issued for either the \fB/dev/audio\fR or the \fB/dev/audioctl\fR device with some restrictions. This command configures the audio device according to @@ -711,24 +703,20 @@ This technique eliminates problems associated with using a sequence of An \fBopen()\fR will fail if: .sp .ne 2 -.mk .na \fB\fBEBUSY\fR\fR .ad .RS 9n -.rt The requested play or record access is busy and either the \fBO_NDELAY\fR or \fBO_NONBLOCK\fR flag was set in the \fBopen()\fR request. .RE .sp .ne 2 -.mk .na \fB\fBEINTR\fR\fR .ad .RS 9n -.rt The requested play or record access is busy and a signal interrupted the \fBopen()\fR request. .RE @@ -738,12 +726,10 @@ The requested play or record access is busy and a signal interrupted the An \fBioctl()\fR will fail if: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt The parameter changes requested in the \fBAUDIO_SETINFO()\fR ioctl are invalid or are not supported by the device. .RE @@ -755,56 +741,46 @@ The physical audio device names are system dependent and are rarely used by programmers. Programmers should use the following generic device names: .sp .ne 2 -.mk .na \fB\fB/dev/audio\fR\fR .ad .RS 28n -.rt Symbolic link to the system's primary audio device .RE .sp .ne 2 -.mk .na \fB\fB/dev/audioctl\fR\fR .ad .RS 28n -.rt Symbolic link to the control device for \fB/dev/audio\fR .RE .sp .ne 2 -.mk .na \fB\fB/dev/sound/0\fR\fR .ad .RS 28n -.rt First audio device in the system .RE .sp .ne 2 -.mk .na \fB\fB/dev/sound/0ctl\fR\fR .ad .RS 28n -.rt Audio control device for \fB/dev/sound/0\fR .RE .sp .ne 2 -.mk .na \fB\fB/usr/share/audio/samples\fR\fR .ad .RS 28n -.rt Audio files .RE @@ -816,15 +792,14 @@ See \fBattributes\fR(5) for a description of the following attributes: .sp .TS -tab() box; -cw(1.82i) |cw(3.68i) -lw(1.82i) |lw(3.68i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitectureSPARC, x86 +Architecture SPARC, x86 _ -Stability LevelObsolete Uncommitted +Stability Level Obsolete Uncommitted .TE .SH SEE ALSO diff --git a/usr/src/man/man7i/cdio.7i b/usr/src/man/man7i/cdio.7i index 2ed53a4d9d..5a10b12bb7 100644 --- a/usr/src/man/man7i/cdio.7i +++ b/usr/src/man/man7i/cdio.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH cdio 7I "4 Oct 2001" "SunOS 5.11" "Ioctl Requests" +.TH CDIO 7I "Oct 4, 2001" .SH NAME cdio \- CD-ROM control operations .SH SYNOPSIS @@ -39,67 +39,55 @@ The following \fBI/O\fR controls do not have any additional data passed into or received from them. .sp .ne 2 -.mk .na \fB\fBCDROMSTART\fR\fR .ad .RS 18n -.rt This \fBioctl()\fR spins up the disc and seeks to the last address requested. .RE .sp .ne 2 -.mk .na \fB\fBCDROMSTOP\fR\fR .ad .RS 18n -.rt This \fBioctl()\fR spins down the disc. .RE .sp .ne 2 -.mk .na \fB\fBCDROMPAUSE\fR\fR .ad .RS 18n -.rt This \fBioctl()\fR pauses the current audio play operation. .RE .sp .ne 2 -.mk .na \fB\fBCDROMRESUME\fR\fR .ad .RS 18n -.rt This \fBioctl()\fR resumes the paused audio play operation. .RE .sp .ne 2 -.mk .na \fB\fBCDROMEJECT\fR\fR .ad .RS 18n -.rt This \fBioctl()\fR ejects the caddy with the disc. .RE .sp .ne 2 -.mk .na \fB\fBCDROMCLOSETRAY\fR\fR .ad .RS 18n -.rt This \fBioctl()\fR closes the caddy with the disc. .RE @@ -109,12 +97,10 @@ The following \fBI/O\fR controls require a pointer to the structure for that \fBioctl()\fR, with data being passed into the \fBioctl()\fR. .sp .ne 2 -.mk .na \fB\fBCDROMPLAYMSF\fR\fR .ad .RS 19n -.rt This \fBioctl()\fR command requests the drive to output the audio signals at the specified starting address and continue the audio play until the specified ending address is detected. The address is in \fBMSF\fR format. The third @@ -149,12 +135,10 @@ time of the last audio track. .sp .ne 2 -.mk .na \fB\fBCDROMPLAYTRKIND\fR\fR .ad .RS 19n -.rt This \fBioctl()\fR command is similar to \fBCDROMPLAYMSF\fR. The starting and ending address is in track/index format. The third argument of the \fBioctl()\fR call is a pointer to the type \fBstruct cdrom_ti\fR. @@ -177,12 +161,10 @@ struct cdrom_ti { .sp .ne 2 -.mk .na \fB\fBCDROMVOLCTRL\fR\fR .ad .RS 19n -.rt This \fBioctl()\fR command controls the audio output level. The \fBSCSI\fR command allows the control of up to four channels. The current implementation of the supported \fBCD-ROM\fR drive only uses channel 0 and channel 1. The @@ -213,12 +195,10 @@ The following \fBI/O\fR controls take a pointer that will have data returned to the user program from the \fBCD-ROM\fR driver. .sp .ne 2 -.mk .na \fB\fBCDROMREADTOCHDR\fR\fR .ad .RS 21n -.rt This \fBioctl()\fR command returns the header of the table of contents (TOC). The header consists of the starting tracking number and the ending track number of the disc. These two numbers are returned through a pointer of \fBstruct @@ -241,12 +221,10 @@ struct cdrom_tochdr { .sp .ne 2 -.mk .na \fB\fBCDROMREADTOCENTRY\fR\fR .ad .RS 21n -.rt This \fBioctl()\fR command returns the information of a specified track. The third argument of the function call is a pointer to the type \fBstruct cdrom_tocentry\fR. The caller needs to supply the track number and the address @@ -282,12 +260,10 @@ To get the information from the leadout track, the following value is appropriate for the \fBcdte_track\fR field: .sp .ne 2 -.mk .na \fB\fBCDROM_LEADOUT\fR\fR .ad .RS 17n -.rt Leadout track .RE @@ -295,35 +271,29 @@ To get the information from the data track, the following value is appropriate for the \fBcdte_ctrl\fR field: .sp .ne 2 -.mk .na \fB\fBCDROM_DATA_TRACK\fR\fR .ad .RS 20n -.rt Data track .RE The following values are appropriate for the \fBcdte_format\fR field: .sp .ne 2 -.mk .na \fB\fBCDROM_LBA\fR\fR .ad .RS 13n -.rt \fBLBA\fR format .RE .sp .ne 2 -.mk .na \fB\fBCDROM_MSF\fR\fR .ad .RS 13n -.rt \fBMSF\fR format .RE @@ -331,12 +301,10 @@ The following values are appropriate for the \fBcdte_format\fR field: .sp .ne 2 -.mk .na \fB\fBCDROMSUBCHNL\fR\fR .ad .RS 21n -.rt This \fBioctl()\fR command reads the Q sub-channel data of the current block. The subchannel data includes track number, index number, absolute \fBCD-ROM\fR address, track relative \fBCD-ROM\fR address, control data and audio status. @@ -376,67 +344,55 @@ The following values are valid for the audio status field returned from \fBREAD\fR \fBSUBCHANNEL\fR command: .sp .ne 2 -.mk .na \fB\fBCDROM_AUDIO_INVALID\fR\fR .ad .RS 25n -.rt Audio status not supported. .RE .sp .ne 2 -.mk .na \fB\fBCDROM_AUDIO_PLAY\fR\fR .ad .RS 25n -.rt Audio play operation in progress. .RE .sp .ne 2 -.mk .na \fB\fBCDROM_AUDIO_PAUSED\fR\fR .ad .RS 25n -.rt Audio play operation paused. .RE .sp .ne 2 -.mk .na \fB\fBCDROM_AUDIO_COMPLETED\fR\fR .ad .RS 25n -.rt Audio play successfully completed. .RE .sp .ne 2 -.mk .na \fB\fBCDROM_AUDIO_ERROR\fR\fR .ad .RS 25n -.rt Audio play stopped due to error. .RE .sp .ne 2 -.mk .na \fB\fBCDROM_AUDIO_NO_STATUS\fR\fR .ad .RS 25n -.rt No current audio status to return. .RE @@ -444,12 +400,10 @@ No current audio status to return. .sp .ne 2 -.mk .na \fB\fBCDROMREADOFFSET\fR\fR .ad .RS 21n -.rt This \fBioctl()\fR command returns the absolute \fBCD-ROM\fR address of the first track in the last session of a Multi-Session \fBCD-ROM\fR. The third argument of the \fBioctl()\fR call is a pointer to an \fBint\fR. @@ -457,12 +411,10 @@ argument of the \fBioctl()\fR call is a pointer to an \fBint\fR. .sp .ne 2 -.mk .na \fB\fBCDROMCDDA\fR\fR .ad .RS 21n -.rt This \fBioctl()\fR command returns the \fBCD-DA\fR data or the subcode data. The third argument of the \fBioctl()\fR call is a pointer to the type \fBstruct cdrom_cdda\fR. In addition to allocating memory and supplying its address, the @@ -494,45 +446,37 @@ To get the subcode information related to \fBCD-DA\fR data, the following values are appropriate for the \fBcdda_subcode\fR field: .sp .ne 2 -.mk .na \fB\fBCDROM_DA_NO_SUBCODE\fR\fR .ad .RS 25n -.rt \fBCD-DA\fR data with no subcode. .RE .sp .ne 2 -.mk .na \fB\fBCDROM_DA_SUBQ\fR\fR .ad .RS 25n -.rt \fBCD-DA\fR data with sub Q code. .RE .sp .ne 2 -.mk .na \fB\fBCDROM_DA_ALL_SUBCODE\fR\fR .ad .RS 25n -.rt \fBCD-DA\fR data with all subcode. .RE .sp .ne 2 -.mk .na \fB\fBCDROM_DA_SUBCODE_ONLY\fR\fR .ad .RS 25n -.rt All subcode only. .RE @@ -540,7 +484,6 @@ To allocate the memory related to \fBCD-DA\fR and/or subcode data, the following values are appropriate for each data block transferred: .sp .ne 2 -.mk .na \fB\fBCD-DA\fR data with no subcode\fR .ad @@ -551,7 +494,6 @@ following values are appropriate for each data block transferred: .sp .ne 2 -.mk .na \fB\fBCD-DA\fR data with sub Q code\fR .ad @@ -562,7 +504,6 @@ following values are appropriate for each data block transferred: .sp .ne 2 -.mk .na \fB\fBCD-DA\fR data with all subcode\fR .ad @@ -573,7 +514,6 @@ following values are appropriate for each data block transferred: .sp .ne 2 -.mk .na \fBAll subcode only\fR .ad @@ -586,12 +526,10 @@ following values are appropriate for each data block transferred: .sp .ne 2 -.mk .na \fB\fBCDROMCDXA\fR\fR .ad .RS 21n -.rt This \fBioctl()\fR command returns the \fBCD-ROM\fR \fBXA\fR (CD-ROM Extended Architecture) data according to \fBCD-ROM\fR \fBXA\fR format. The third argument of the \fBioctl()\fR call is a pointer to the type \fBstruct @@ -619,34 +557,28 @@ To get the proper \fBCD-ROM\fR \fBXA\fR data, the following values are appropriate for the \fBcdxa_format\fR field: .sp .ne 2 -.mk .na \fB\fBCDROM_XA_DATA\fR\fR .ad .RS 25n -.rt \fBCD-ROM\fR \fBXA\fR data only .RE .sp .ne 2 -.mk .na \fB\fBCDROM_XA_SECTOR_DATA\fR\fR .ad .RS 25n -.rt \fBCD-ROM\fR \fBXA\fR all sector data .RE .sp .ne 2 -.mk .na \fB\fBCDROM_XA_DATA_W_ERROR\fR\fR .ad .RS 25n -.rt \fBCD-ROM\fR \fBXA\fR data with error flags data .RE @@ -654,7 +586,6 @@ To allocate the memory related to \fBCD-ROM\fR \fBXA\fR format, the following values are appropriate for each data block transferred: .sp .ne 2 -.mk .na \fB\fBCD-ROM XA\fR data only\fR .ad @@ -665,7 +596,6 @@ values are appropriate for each data block transferred: .sp .ne 2 -.mk .na \fB\fBCD-ROM XA\fR all sector data\fR .ad @@ -676,7 +606,6 @@ values are appropriate for each data block transferred: .sp .ne 2 -.mk .na \fB\fBCD-ROM XA\fR data with error flags data\fR .ad @@ -689,12 +618,10 @@ values are appropriate for each data block transferred: .sp .ne 2 -.mk .na \fB\fBCDROMSUBCODE\fR\fR .ad .RS 21n -.rt This \fBioctl()\fR command returns raw subcode data (subcodes P ~ W are described in the "Red Book," see \fBSEE ALSO\fR) to the initiator while the target is playing audio. The third argument of the \fBioctl()\fR call is a @@ -723,12 +650,10 @@ The next group of \fBI/O\fR controls get and set various \fBCD-ROM\fR drive parameters. .sp .ne 2 -.mk .na \fB\fBCDROMGBLKMODE\fR\fR .ad .RS 18n -.rt This \fBioctl()\fR command returns the current block size used by the \fBCD-ROM\fR drive. The third argument of the \fBioctl()\fR call is a pointer to an integer. @@ -736,12 +661,10 @@ to an integer. .sp .ne 2 -.mk .na \fB\fBCDROMSBLKMODE\fR\fR .ad .RS 18n -.rt This \fBioctl()\fR command requests the \fBCD-ROM\fR drive to change from the current block size to the requested block size. The third argument of the \fBioctl()\fR call is an integer which contains the requested block size. @@ -755,122 +678,100 @@ device on block boundaries and in block multiples. To set the proper block size, the following values are appropriate: .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_512\fR\fR .ad .RS 18n -.rt 512 bytes .RE .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_1024\fR\fR .ad .RS 18n -.rt 1024 bytes .RE .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_2048\fR\fR .ad .RS 18n -.rt 2048 bytes .RE .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_2056\fR\fR .ad .RS 18n -.rt 2056 bytes .RE .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_2336\fR\fR .ad .RS 18n -.rt 2336 bytes .RE .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_2340\fR\fR .ad .RS 18n -.rt 2340 bytes .RE .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_2352\fR\fR .ad .RS 18n -.rt 2352 bytes .RE .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_2368\fR\fR .ad .RS 18n -.rt 2368 bytes .RE .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_2448\fR\fR .ad .RS 18n -.rt 2448 bytes .RE .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_2646\fR\fR .ad .RS 18n -.rt 2646 bytes .RE .sp .ne 2 -.mk .na \fB\fBCDROM_BLK_2647\fR\fR .ad .RS 18n -.rt 2647 bytes .RE @@ -878,24 +779,20 @@ To set the proper block size, the following values are appropriate: .sp .ne 2 -.mk .na \fB\fBCDROMGDRVSPEED\fR\fR .ad .RS 18n -.rt This \fBioctl()\fR command returns the current \fBCD-ROM\fR drive speed. The third argument of the \fBioctl()\fR call is a pointer to an integer. .RE .sp .ne 2 -.mk .na \fB\fBCDROMSDRVSPEED\fR\fR .ad .RS 18n -.rt This \fBioctl()\fR command requests the \fBCD-ROM\fR drive to change the current drive speed to the requested drive speed. This speed setting is only applicable when reading data areas. The third argument of the \fBioctl()\fR is @@ -905,45 +802,37 @@ To set the \fBCD-ROM\fR drive to the proper speed, the following values are appropriate: .sp .ne 2 -.mk .na \fB\fBCDROM_NORMAL_SPEED\fR\fR .ad .RS 23n -.rt 150k/second .RE .sp .ne 2 -.mk .na \fB\fBCDROM_DOUBLE_SPEED\fR\fR .ad .RS 23n -.rt 300k/second .RE .sp .ne 2 -.mk .na \fB\fBCDROM_QUAD_SPEED\fR\fR .ad .RS 23n -.rt 600k/second .RE .sp .ne 2 -.mk .na \fB\fBCDROM_MAXIMUM_SPEED\fR\fR .ad .RS 23n -.rt 300k/second (2x drive) 600k/second (4x drive) .RE diff --git a/usr/src/man/man7i/dkio.7i b/usr/src/man/man7i/dkio.7i index 14f1d6238a..455954c160 100644 --- a/usr/src/man/man7i/dkio.7i +++ b/usr/src/man/man7i/dkio.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH dkio 7I "3 Aug 2009" "SunOS 5.11" "Ioctl Requests" +.TH DKIO 7I "Aug 3, 2009" .SH NAME dkio \- disk control operations .SH SYNOPSIS @@ -31,7 +31,6 @@ The following \fBioctl()\fR requests set and/or retrieve the current disk controller, partitions, or geometry information on all architectures: .sp .ne 2 -.mk .na \fB\fBDKIOCINFO\fR\fR .ad @@ -49,7 +48,7 @@ processing done on the controller. * Structures and definitions for disk I/O control commands */ #define DK_DEVLEN 16 /* device name max length, */ - /* including unit # and NULL */ + /* including unit # and NULL */ /* Used for controller info */ struct dk_cinfo { char dki_cname[DK_DEVLEN]; /* controller name */ @@ -109,7 +108,7 @@ struct dk_cinfo { /* bad sector fwding */ #define DKI_MAPTRK 0x02 /* controller does */ /* track mapping */ - #define DKI_FMTTRK 0x04 /* formats only full + #define DKI_FMTTRK 0x04 /* formats only full /* track at a time*/ #define DKI_FMTVOL 0x08 /* formats only full */ /* volume at a time*/ @@ -124,7 +123,6 @@ struct dk_cinfo { .sp .ne 2 -.mk .na \fB\fBDKIOCGAPART\fR\fR .ad @@ -137,7 +135,6 @@ for disk drive. .sp .ne 2 -.mk .na \fB\fBDKIOCSAPART\fR\fR .ad @@ -168,12 +165,10 @@ struct dk_allmap { .sp .ne 2 -.mk .na \fB\fBDKIOCGGEOM\fR\fR .ad .RS 14n -.rt The argument is a pointer to a \fBdk_geom\fR structure (described below). This \fBioctl()\fR gets the controller's notion of the current geometry of the disk drive. @@ -181,12 +176,10 @@ drive. .sp .ne 2 -.mk .na \fB\fBDKIOCSGEOM\fR\fR .ad .RS 14n -.rt The argument is a pointer to a \fBdk_geom\fR structure (described below). This \fBioctl()\fR sets the controller's notion of the geometry without changing the disk itself. @@ -194,12 +187,10 @@ disk itself. .sp .ne 2 -.mk .na \fB\fBDKIOCGVTOC\fR\fR .ad .RS 14n -.rt The argument is a pointer to a \fBvtoc\fR structure (described below). This \fBioctl()\fR returns the device's current volume table of contents (VTOC.) For disks larger than 1TB, DKIOCGEXTVTOC must be used instead. @@ -207,12 +198,10 @@ disks larger than 1TB, DKIOCGEXTVTOC must be used instead. .sp .ne 2 -.mk .na \fB\fBDKIOCSVTOC\fR\fR .ad .RS 14n -.rt The argument is a pointer to a \fBvtoc\fR structure (described below). This \fBioctl()\fR changes the VTOC associated with the device. For disks larger than 1TB, DKIOCSEXTVTOC must be used instead. @@ -223,10 +212,10 @@ than 1TB, DKIOCSEXTVTOC must be used instead. .nf struct partition { ushort_t p_tag; /* ID tag of partition */ -ushort_t p_flag; /* permission flags */ -daddr_t p_start; /* start sector of partition */ -long p_size; /* # of blocks in partition */ -}; +ushort_t p_flag; /* permission flags */ +daddr_t p_start; /* start sector of partition */ +long p_size; /* # of blocks in partition */ +}; .fi .in -2 @@ -238,50 +227,47 @@ cylinder, multiply the number of heads by the number of sectors per track. .sp .in +2 .nf -struct vtoc { +struct vtoc { unsigned long v_bootinfo[3]; /* info needed by mboot - /* (unsupported)*/ + /* (unsupported)*/ unsigned long v_sanity; /* to verify vtoc */ /* sanity */ -unsigned long v_version; /* layout version */ +unsigned long v_version; /* layout version */ char v_volume[LEN_DKL_VVOL]; /* volume name */ -ushort_t v_sectorsz; \* - sector size in bytes*/ -ushort_t v_nparts; \* - number of partitions*/ -unsigned long v_reserved[10]; /* free space */ -struct partition v_part[V_NUMPAR]; /* partition headers */ +ushort_t v_sectorsz; /* sector size in bytes*/ +ushort_t v_nparts; /* number of partitions*/ +unsigned long v_reserved[10]; /* free space */ +struct partition v_part[V_NUMPAR]; /* partition headers */ time_t timestamp[V_NUMPAR]; /* partition timestamp */ - /* (unsupported) */ -char v_asciilabel[LEN_DKL_ASCII]; /* compatibility */ -}; - -/* -* Partition permission flags -*/ - -#define V_UNMNT 0x01 /* Unmountable partition */ -#define V_RONLY 0x10 /* Read only */ - -/* -* Partition identification tags -*/ - -#define V_UNASSIGNED 0x00 /* unassigned partition */ -#define V_BOOT 0x01 /* Boot partition */ -#define V_ROOT 0x02 /* Root filesystem */ -#define V_SWAP 0x03 /* Swap filesystem */ -#define V_USR 0x04 /* Usr filesystem */ -#define V_BACKUP 0x05 /* full disk */ -#define V_VAR 0x07 /* Var partition */ -#define V_HOME 0x08 /* Home partition */ -#define V_ALTSCTR 0x09 /* Alternate sector partition */ + /* (unsupported) */ +char v_asciilabel[LEN_DKL_ASCII]; /* compatibility */ +}; + +/* +* Partition permission flags +*/ + +#define V_UNMNT 0x01 /* Unmountable partition */ +#define V_RONLY 0x10 /* Read only */ + +/* +* Partition identification tags +*/ + +#define V_UNASSIGNED 0x00 /* unassigned partition */ +#define V_BOOT 0x01 /* Boot partition */ +#define V_ROOT 0x02 /* Root filesystem */ +#define V_SWAP 0x03 /* Swap filesystem */ +#define V_USR 0x04 /* Usr filesystem */ +#define V_BACKUP 0x05 /* full disk */ +#define V_VAR 0x07 /* Var partition */ +#define V_HOME 0x08 /* Home partition */ +#define V_ALTSCTR 0x09 /* Alternate sector partition */ .fi .in -2 .sp .ne 2 -.mk .na \fB\fBDKIOCGEXTVTOC\fR\fR .ad @@ -295,7 +281,6 @@ ioctl must be used instead of \fBDKIOCGVTOC\fR. .sp .ne 2 -.mk .na \fB\fBDKIOCSEXTVTOC\fR\fR .ad @@ -315,8 +300,8 @@ ushort_t p_pad[2]; /* reserved */ diskaddr_t p_start; /* start sector no of partition */ diskaddr_t p_size; /* # of blocks in partition */ }; - - + + struct extvtoc { uint64_t v_bootinfo[3]; /* info needed by mboot (unsupported) */ uint64_t v_sanity; /* to verify vtoc sanity */ @@ -331,7 +316,7 @@ uint64_t timestamp[V_NUMPAR]; /* partition timestamp (unsupported)*/ char v_asciilabel[LEN_DKL_ASCII]; /* for compatibility */ }; -Partition permissions flags and identification tags +Partition permissions flags and identification tags are defined the same as vtoc structure. .fi .in -2 @@ -340,7 +325,6 @@ are defined the same as vtoc structure. .sp .ne 2 -.mk .na \fB\fBDKIOCEJECT\fR\fR .ad @@ -352,7 +336,6 @@ drive to eject its disk. .sp .ne 2 -.mk .na \fB\fBDKIOCREMOVABLE\fR\fR .ad @@ -366,7 +349,6 @@ to \fB0\fR. .sp .ne 2 -.mk .na \fB\fBDKIOCHOTPLUGGABLE\fR\fR .ad @@ -380,7 +362,6 @@ to 0. .sp .ne 2 -.mk .na \fB\fBDKIOCSTATE\fR\fR .ad @@ -394,10 +375,10 @@ to by the argument is updated with the current state of the drive. .sp .in +2 .nf -enum dkio_state { -DKIO_NONE, /* Return disk's current state */ -DKIO_EJECTED, /* Disk state is 'ejected' */ -DKIO_INSERTED /* Disk state is 'inserted' */ +enum dkio_state { +DKIO_NONE, /* Return disk's current state */ +DKIO_EJECTED, /* Disk state is 'ejected' */ +DKIO_INSERTED /* Disk state is 'inserted' */ }; .fi .in -2 @@ -406,7 +387,6 @@ DKIO_INSERTED /* Disk state is 'inserted' */ .sp .ne 2 -.mk .na \fB\fBDKIOCLOCK\fR\fR .ad @@ -418,7 +398,6 @@ lock the door. .sp .ne 2 -.mk .na \fB\fBDKIOCUNLOCK\fR\fR .ad @@ -430,7 +409,6 @@ unlock the door. .sp .ne 2 -.mk .na \fB\fBDKIOCGMEDIAINFO\fR\fR .ad @@ -446,7 +424,6 @@ blocks. .sp .ne 2 -.mk .na \fB\fBDKIOCGMEDIAINFOEXT\fR\fR .ad @@ -489,8 +466,8 @@ uint_t dki_pbsize; /* Physical blocksize of media */ #define DK_UNKNOWN 0x00 /* Media inserted - type unknown */ /* -* SFF 8090 Specification Version 3, media types 0x01 - 0xfffe are -* retained to maintain compatibility with SFF8090. The following +* SFF 8090 Specification Version 3, media types 0x01 - 0xfffe are +* retained to maintain compatibility with SFF8090. The following * define the optical media type. */ #define DK_MO_ERASABLE 0x03 /* MO Erasable */ @@ -532,7 +509,6 @@ If identification is not possible, the host returns media type \fBDK_UNKNOWN\fR. See \fINOTES\fR for blocksize usage and capacity information. .sp .ne 2 -.mk .na \fB\fBDKIOCSMBOOT\fR\fR .ad @@ -604,7 +580,6 @@ partitions. .sp .ne 2 -.mk .na \fB\fBDKIOCGETVOLCAP\fR\fR .ad @@ -617,10 +592,10 @@ This ioctl provides information and status of available capabilities. .in +2 .nf DKV_ABR_CAP - Capable of application-based recovery -DKV_DMR_CAP - Ability to read specific copy of data when - multiple copies exist. For example, in a two +DKV_DMR_CAP - Ability to read specific copy of data when + multiple copies exist. For example, in a two way mirror, this ioctl is used to read each - side of the mirror. + side of the mirror. .fi .in -2 @@ -630,7 +605,7 @@ DKV_DMR_CAP - Ability to read specific copy of data when .nf DKV_ABR_CAP - This flag is set if ABR has been set on a device that supports ABR functionality. -DKV_DMR_CAP - Directed read has been enabled. +DKV_DMR_CAP - Directed read has been enabled. .fi .in -2 @@ -646,23 +621,19 @@ persistent so that the VM know whether or not to perform recovery. Return Errors: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 11n -.rt Invalid device for this operation. .RE .sp .ne 2 -.mk .na \fB\fBENOTSUP\fR\fR .ad .RS 11n -.rt Functionality that is attempted to be set is not supported. .RE @@ -670,7 +641,6 @@ Functionality that is attempted to be set is not supported. .sp .ne 2 -.mk .na \fB\fBDKIOCSETVOLCAP\fR\fR .ad @@ -686,7 +656,7 @@ is not set in vc_set, that capability is cleared. .in +2 .nf DKV_ABR_CAP - Flag to set application-based recovery. A device can - successfully support ABR only if it is capable. + successfully support ABR only if it is capable. DKV_DMR_CAP - Flag to set directed read. @@ -699,7 +669,6 @@ ioctl(int , DKIODMR, vol_directed_rd *); .sp .ne 2 -.mk .na \fB\fBDKIODMR\fR\fR .ad @@ -713,8 +682,8 @@ from the underlying devices of a replicated device. vdr_offset - offset at which the read should occur. vdr_nbytes - number of bytes to be read vdr_bytesread - number of bytes successfully read by the kernel. -vdr_data - pointer to a user allocated buffer to return the - data read +vdr_data - pointer to a user allocated buffer to return the + data read vdr_side - side to be read. Initialized to DKV_SIDE_INIT vdr_side_name - The volume name that has been read. @@ -796,7 +765,6 @@ The following \fBioctl()\fR requests set and/or retrieve the current disk controller, partitions, or geometry information on the x86 architecture. .sp .ne 2 -.mk .na \fB\fBDKIOCG_PHYGEOM\fR\fR .ad @@ -809,7 +777,6 @@ drive. It is functionally identical to the \fBDKIOCGGEOM\fR \fBioctl()\fR. .sp .ne 2 -.mk .na \fB\fBDKIOCG_VIRTGEOM\fR\fR .ad @@ -826,26 +793,26 @@ geometry is not relevant or useful for this drive. .sp .in +2 .nf -/* -* Definition of a disk's geometry +/* +* Definition of a disk's geometry */ -*/struct dk_geom { -unsigned shor dkg_ncyl; /* # of data cylinders */ -unsigned shor dkg_acyl; /* # of alternate cylinders */ +*/struct dk_geom { +unsigned shor dkg_ncyl; /* # of data cylinders */ +unsigned shor dkg_acyl; /* # of alternate cylinders */ unsigned short dkg_bcyl; /* cyl offset (for fixed head */ /* area) */ -unsigned short dkg_nhead; /* # of heads */ -unsigned short dkg_obs1; /* obsolete */ +unsigned short dkg_nhead; /* # of heads */ +unsigned short dkg_obs1; /* obsolete */ unsigned short dkg_nsect; /* # of sectors per track*/ -unsigned short dkg_intrlv; /* interleave factor */ -unsigned short dkg_obs2; /* obsolete */ -unsigned short dkg_obs3; /* obsolete */ +unsigned short dkg_intrlv; /* interleave factor */ +unsigned short dkg_obs2; /* obsolete */ +unsigned short dkg_obs3; /* obsolete */ unsigned short dkg_apc; /* alternates per cylinder */ - /* (SCSI only) */ -unsigned short dkg_rpm; /* revolutions per min*/ -unsigned short dkg_pcyl; /* # of physical cylinders */ + /* (SCSI only) */ +unsigned short dkg_rpm; /* revolutions per min*/ +unsigned short dkg_pcyl; /* # of physical cylinders */ unsigned short dkg_write_reinstruct; /* # sectors to skip, writes*/ -unsigned short dkg_read_reinstruct; /* # sectors to skip, reads*/ +unsigned short dkg_read_reinstruct; /* # sectors to skip, reads*/ unsigned short dkg_extra[7]; /* for compatible expansion*/ }; .fi @@ -853,7 +820,6 @@ unsigned short dkg_extra[7]; /* for compatible expansion*/ .sp .ne 2 -.mk .na \fB\fBDKIOCADDBAD\fR\fR .ad @@ -869,7 +835,6 @@ alternate sectors. .sp .ne 2 -.mk .na \fB\fBDKIOCPARTINFO\fR\fR .ad @@ -895,7 +860,6 @@ int p_length; .sp .ne 2 -.mk .na \fB\fBDKIOCEXTPARTINFO\fR\fR .ad @@ -922,7 +886,6 @@ diskaddr_t p_length; .sp .ne 2 -.mk .na \fB\fBDKIOCSETEXTPART\fR\fR .ad diff --git a/usr/src/man/man7i/dsp.7i b/usr/src/man/man7i/dsp.7i index 9333ed1ea8..d4cee9fba3 100644 --- a/usr/src/man/man7i/dsp.7i +++ b/usr/src/man/man7i/dsp.7i @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH dsp 7I "11 May 2009" "SunOS 5.11" "Ioctl Requests" +.TH DSP 7I "May 11, 2009" .SH NAME dsp \- generic audio device interface .SH SYNOPSIS .LP .nf -\fB#include\fR \fB<sys/soundcard.h>\fR +\fB#include\fR \fB<sys/soundcard.h>\fR .fi .SH DESCRIPTION @@ -180,12 +180,10 @@ SNDCTL_CARDINFO The \fBdsp\fR device supports the following ioctl commands: .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_SYNC\fR\fR .ad .RS 27n -.rt The argument is ignored. This command suspends the calling process until the output FIFOs are empty and all queued samples have been played, or until a signal is delivered to the calling process. An implicit \fBSNDCTL_DSP_SYNC\fR @@ -198,7 +196,6 @@ correct use of this ioctl is just before changing sample formats. .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_HALT\fR\fR .ad @@ -211,19 +208,16 @@ correct use of this ioctl is just before changing sample formats. \fB\fBSNDCTL_DSP_HALT_OUTPUT\fR\fR .ad .RS 27n -.rt The argument is ignored. All input or output (or both) associated with the file is halted, and any pending data is discarded. .RE .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_SPEED\fR\fR .ad .RS 27n -.rt The argument is a pointer to an integer, indicating the sample rate (in Hz) to be used. The rate applies to both input and output for the file descriptor. On return the actual rate, which can differ from that requested, is stored in the @@ -233,12 +227,10 @@ changing it the value 0 can be used by the application .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_GETFMTS\fR\fR .ad .RS 27n -.rt The argument is a pointer to an integer, which receives a bit mask of encodings supported by the device. Possible values are .sp @@ -247,31 +239,31 @@ supported by the device. Possible values are AFMT_MU_LAW 8-bit unsigned u-Law AFMT_A_LAW 8-bit unsigned a-Law AFMT_U8 8-bit unsigned linear PCM -AFMT_S16_LE 16-bit signed +AFMT_S16_LE 16-bit signed little-endian linear PCM -AFMT_S16_BE 16-bit signed +AFMT_S16_BE 16-bit signed big-endian linear PCM -AFMT_S16_NE 16-bit signed native-endian +AFMT_S16_NE 16-bit signed native-endian linear PCM -AFMT_U16_LE 16-bit unsigned +AFMT_U16_LE 16-bit unsigned little-endian linear PCM -AFMT_U16_BE 16-bit unsigned big-endian +AFMT_U16_BE 16-bit unsigned big-endian linear PCM -AFMT_U16_NE 16-bit unsigned big-endian +AFMT_U16_NE 16-bit unsigned big-endian linear PCM -AFMT_S24_LE 24-bit signed little-endian +AFMT_S24_LE 24-bit signed little-endian linear PCM, 32-bit aligned -AFMT_S24_BE 24-bit signed big-endian +AFMT_S24_BE 24-bit signed big-endian linear PCM, 32-bit aligned -AFMT_S24_NE 24-bit signed native-endian +AFMT_S24_NE 24-bit signed native-endian linear PCM, 32-bit aligned -AFMT_S32_LE 32-bit signed little-endian +AFMT_S32_LE 32-bit signed little-endian linear PCM -AFMT_S32_BE 32-bit signed big-endian +AFMT_S32_BE 32-bit signed big-endian linear PCM -AFMT_S32_NE 32-bit signed native-endian +AFMT_S32_NE 32-bit signed native-endian linear PCM -AFMT_S24_PACKED 24-bit signed little-endian +AFMT_S24_PACKED 24-bit signed little-endian packed linear PCM .fi .in -2 @@ -283,12 +275,10 @@ Not all devices support all of these encodings. This implementation uses .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_SETFMT\fR\fR .ad .RS 27n -.rt The argument is a pointer to an integer, which indicates the encoding to be used. The same values as for \fBSNDCTL_DSP_GETFMT\fR can be used, but the caller can only specify a single option. The encoding is used for both input @@ -297,12 +287,10 @@ and output performed on the file descriptor. .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_CHANNELS\fR\fR .ad .RS 27n -.rt The argument is a pointer to an integer, indicating the number of channels to be used (1 for mono, 2 for stereo, etc.) The value applies to both input and output for the file descriptor. On return the actual channel configuration @@ -313,12 +301,10 @@ can be used by the application. .sp .ne 2 -.mk .na \fB\fBSNDDCTL_DSP_GETCAPS\fR\fR .ad .RS 27n -.rt The argument is a pointer to an integer bit mask, which indicates the capabilities of the device. The bits returned can include .sp @@ -336,7 +322,6 @@ PCM_CAP_DUPLEX Device supports simultaneous .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_GETPLAYVOL\fR\fR .ad @@ -345,7 +330,6 @@ PCM_CAP_DUPLEX Device supports simultaneous \fB\fBSNDCTL_DSP_GETRECVOL\fR\fR .ad .RS 27n -.rt The argument is a pointer to an integer to receive the volume level for either playback or record. The value is encoded as a stereo value with the values for two channels in the least significant two bytes. The value for each channel @@ -356,7 +340,6 @@ both channel levels being identical) is returned for compatibility. .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_SETPLAYVOL\fR\fR .ad @@ -365,7 +348,6 @@ both channel levels being identical) is returned for compatibility. \fB\fBSNDCTL_DSP_SETRECVOL\fR\fR .ad .RS 27n -.rt The argument is a pointer to an integer indicating volume level for either playback or record. The value is encoded as a stereo value with the values for two channels in the least significant two bytes. The value for each channel has @@ -376,7 +358,6 @@ should assign the same value to both bytes .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_GETISPACE\fR\fR .ad @@ -385,7 +366,6 @@ should assign the same value to both bytes \fB\fBSNDCTL_DSP_GETOSPACE\fR\fR .ad .RS 27n -.rt The argument is a pointer to a \fBstruct audio_buf_info\fR, which has the following structure: .sp @@ -399,7 +379,7 @@ typedef struct audio_buf_info { /* Size of a fragment in bytes */ int bytes; /* Available space in bytes */ - /* Note! 'bytes' could be more than + /* Note! 'bytes' could be more than fragments*fragsize */ } audio_buf_info; .fi @@ -414,7 +394,6 @@ contains the number of bytes that can be transferred without blocking. .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_CURRENT_IPTR\fR\fR .ad @@ -423,7 +402,6 @@ contains the number of bytes that can be transferred without blocking. \fB\fBSNDCTL_DSP_CURRENT_OPTR\fR\fR .ad .RS 27n -.rt The argument is a pointer to an \fBoss_count_t\fR, which has the following definition: .sp @@ -448,7 +426,6 @@ calculations. .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_GETIPTR\fR\fR .ad @@ -457,7 +434,6 @@ calculations. \fB\fBSNDCTL_DSP_GETOPTR\fR\fR .ad .RS 27n -.rt The argument is a pointer to a \fBstruct count_info\fR, which has the following definition: .sp @@ -467,7 +443,7 @@ typedef struct count_info { unsigned int bytes; /* Total # of bytes processed */ int blocks; - /* # of fragment transitions since + /* # of fragment transitions since last time */ int ptr;/* Current DMA pointer value */ } count_info; @@ -481,12 +457,10 @@ by most applications. .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_GETODELAY\fR\fR .ad .RS 27n -.rt The argument is a pointer to an integer. On return, the integer contains the number of bytes still to be played before the next byte written are played. This can be used for accurate determination of device latency. The result can @@ -496,12 +470,10 @@ typically 64 bytes. .sp .ne 2 -.mk .na \fB\fBSNDCTL_DSP_GETERROR\fR\fR .ad .RS 27n -.rt The argument is a pointer to a \fBstruct audio_errinfo\fR, defined as follows: .sp .in +2 @@ -573,36 +545,30 @@ SNDCTL_ENGINEINFO An \fBopen()\fR fails if: .sp .ne 2 -.mk .na \fB\fBEBUSY\fR\fR .ad .RS 10n -.rt The requested play or record access isbusy and either the \fBO_NDELAY\fR or \fBO_NONBLOCK\fR flag was set in the \fBopen()\fR request. .RE .sp .ne 2 -.mk .na \fB\fBEINTR\fR\fR .ad .RS 10n -.rt The requested play or record access is busy and a signal interrupted the \fBopen()\fR request. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt The device cannot support the requested play or record access. .RE @@ -611,12 +577,10 @@ The device cannot support the requested play or record access. An \fBioctl()\fR fails if: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt The parameter changes requested in the ioctl are invalid or are not supported by the device. .RE @@ -628,45 +592,37 @@ The physical audio device names are system dependent and are rarely used by programmers. Programmers should use the generic device names listed below. .sp .ne 2 -.mk .na \fB\fB/dev/dsp\fR\fR .ad .RS 28n -.rt Symbolic link to the system's primary audio device .RE .sp .ne 2 -.mk .na \fB\fB/dev/mixer\fR\fR .ad .RS 28n -.rt Symbolic link to the pseudo mixer device for the system .RE .sp .ne 2 -.mk .na \fB\fB/dev/sndstat\fR\fR .ad .RS 28n -.rt Symbolic link to the pseudo mixer device for the system .RE .sp .ne 2 -.mk .na \fB\fB/usr/share/audio/samples\fR\fR .ad .RS 28n -.rt Audio files .RE @@ -678,15 +634,14 @@ See \fBattributes\fR(5) for a description of the following attributes: .sp .TS -tab() box; -cw(1.82i) |cw(3.68i) -lw(1.82i) |lw(3.68i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitectureSPARC, x86 +Architecture SPARC, x86 _ -Stability LevelUncommitted +Stability Level Uncommitted .TE .SH SEE ALSO diff --git a/usr/src/man/man7i/fbio.7i b/usr/src/man/man7i/fbio.7i index 1440f2b5e3..792147714d 100644 --- a/usr/src/man/man7i/fbio.7i +++ b/usr/src/man/man7i/fbio.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH fbio 7I "12 May 2003" "SunOS 5.11" "Ioctl Requests" +.TH FBIO 7I "May 12, 2003" .SH NAME fbio \- frame buffer control operations .SH DESCRIPTION diff --git a/usr/src/man/man7i/fdio.7i b/usr/src/man/man7i/fdio.7i index 3a28799011..1cc1487095 100644 --- a/usr/src/man/man7i/fdio.7i +++ b/usr/src/man/man7i/fdio.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH fdio 7I "26 April 2001" "SunOS 5.11" "Ioctl Requests" +.TH FDIO 7I "Apr 26, 2001" .SH NAME fdio \- floppy disk control operations .SH SYNOPSIS @@ -25,12 +25,10 @@ The following \fBioctl\fR(\|) requests are available on the Solaris floppy driver. .sp .ne 2 -.mk .na \fB\fBFDDEFGEOCHAR\fR\fR .ad .RS 16n -.rt x86 based systems: This \fBioctl\fR(\|) forces the floppy driver to restore the diskette and drive characteristics and geometry, and partition information to default values based on the device configuration. @@ -38,12 +36,10 @@ to default values based on the device configuration. .sp .ne 2 -.mk .na \fB\fBFDGETCHANGE\fR\fR .ad .RS 16n -.rt The argument is a pointer to an \fBint.\fR This \fBioctl\fR(\|) returns the status of the diskette-changed signal from the floppy interface. The following defines are provided for cohesion. @@ -59,7 +55,7 @@ on x86 based systems) instead of \fBFDGC_HISTORY.\fR /* * Used by FDGETCHANGE, returned state of the sense disk change bit. */ -#define FDGC_HISTORY 0x01 /* disk has changed since insertion or +#define FDGC_HISTORY 0x01 /* disk has changed since insertion or last FDGETCHANGE call */ #define FDGC_CURRENT 0x02 /* if set, indicates drive has floppy, > otherwise, drive is empty */ @@ -70,12 +66,10 @@ on x86 based systems) instead of \fBFDGC_HISTORY.\fR .sp .ne 2 -.mk .na \fB\fBFDIOGCHAR\fR\fR .ad .RS 13n -.rt The argument is a pointer to an \fBfd_char\fR structure (described below). This \fBioctl\fR(\|) gets the characteristics of the floppy diskette from the floppy controller. @@ -83,12 +77,10 @@ controller. .sp .ne 2 -.mk .na \fB\fBFDIOSCHAR\fR\fR .ad .RS 13n -.rt The argument is a pointer to an \fBfd_char\fR structure (described below). This \fBioctl\fR(\|) sets the characteristics of the floppy diskette for the floppy controller. Typical values in the \fBfd_char\fR structure for a high density @@ -129,12 +121,10 @@ struct fd_char { .sp .ne 2 -.mk .na \fB\fBFDGETDRIVECHAR\fR\fR .ad .RS 18n -.rt The argument to this \fBioctl\fR(\|) is a pointer to an \fBfd_drive\fR structure (described below). This \fBioctl\fR(\|) gets the characteristics of the floppy drive from the floppy controller. @@ -142,12 +132,10 @@ the floppy drive from the floppy controller. .sp .ne 2 -.mk .na \fB\fBFDSETDRIVECHAR\fR\fR .ad .RS 18n -.rt x86 based systems: The argument to this \fBioctl\fR(\|) is a pointer to an \fBfd_drive\fR structure (described below). This \fBioctl\fR(\|) sets the characteristics of the floppy drive for the floppy controller. Only @@ -182,45 +170,37 @@ struct fd_drive { .sp .ne 2 -.mk .na \fB\fBFDGETSEARCH\fR\fR .ad .RS 15n -.rt Not available. .RE .sp .ne 2 -.mk .na \fB\fBFDSETSEARCH\fR\fR .ad .RS 15n -.rt Not available. .RE .sp .ne 2 -.mk .na \fB\fBFDEJECT\fR\fR .ad .RS 15n -.rt SPARC: This \fBioctl\fR(\|) requests the floppy drive to eject the diskette. .RE .sp .ne 2 -.mk .na \fB\fBFDIOCMD\fR\fR .ad .RS 15n -.rt The argument is a pointer to an \fBfd_cmd\fR structure (described below). This \fBioctl\fR(\|) allows access to the floppy diskette using the floppy device driver. Only the \fBFDCMD_WRITE\fR, \fBFDCMD_READ\fR, and @@ -250,7 +230,7 @@ assumed to be large enough to accommodate the transfer. .in +2 .nf { -/* +/* * Floppy commands */ #define FDCMD_WRITE 1 @@ -265,12 +245,10 @@ assumed to be large enough to accommodate the transfer. .sp .ne 2 -.mk .na \fB\fBFDRAW\fR\fR .ad .RS 9n -.rt The argument is a pointer to an \fBfd_raw\fR structure (described below). This \fBioctl\fR(\|) allows direct control of the floppy drive using the floppy controller. Refer to the appropriate floppy-controller data sheet for full diff --git a/usr/src/man/man7i/hdio.7i b/usr/src/man/man7i/hdio.7i index 5a0644f569..5fb6f841db 100644 --- a/usr/src/man/man7i/hdio.7i +++ b/usr/src/man/man7i/hdio.7i @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH hdio 7I "13 Aug 2002" "SunOS 5.11" "Ioctl Requests" +.TH HDIO 7I "Aug 13, 2002" .SH NAME hdio \- SMD and IPI disk control operations .SH SYNOPSIS .LP .nf -#include <sys/hdio.h> +#include <sys/hdio.h> .fi .SH DESCRIPTION @@ -28,24 +28,20 @@ these \fBioctl()\fR requests are the definitions in <\fBsys/hdio.h\fR>. .SH IOCTLS .sp .ne 2 -.mk .na \fB\fBHDKIOCGTYPE\fR\fR .ad .RS 15n -.rt The argument is a pointer to a \fBhdk_type\fR structure (described below). This \fBioctl()\fR gets specific information from the hard disk. .RE .sp .ne 2 -.mk .na \fB\fBHDKIOCSTYPE\fR\fR .ad .RS 15n -.rt The argument is a pointer to a \fBhdk_type\fR structure (described below). This \fBioctl()\fR sets specific information about the hard disk. .RE @@ -67,24 +63,20 @@ struct hdk_type { .sp .ne 2 -.mk .na \fB\fBHDKIOCGBAD\fR\fR .ad .RS 14n -.rt The argument is a pointer to a \fBhdk_badmap\fR structure (described below). This \fBioctl()\fR is used to get the bad sector map from the disk. .RE .sp .ne 2 -.mk .na \fB\fBHDKIOCSBAD\fR\fR .ad .RS 14n -.rt The argument is a pointer to a \fBhdk_badmap\fR structure (described below). This \fBioctl()\fR is used to set the bad sector map on the disk. .RE @@ -103,12 +95,10 @@ struct hdk_badmap { .sp .ne 2 -.mk .na \fB\fBHDKIOCGDIAG\fR\fR .ad .RS 15n -.rt The argument is a pointer to a \fBhdk_diag\fR structure (described below). This \fBioctl()\fR gets the most recent command that failed along with the sector and error number from the hard disk. diff --git a/usr/src/man/man7i/iec61883.7i b/usr/src/man/man7i/iec61883.7i index 793062445d..58b939ce0f 100644 --- a/usr/src/man/man7i/iec61883.7i +++ b/usr/src/man/man7i/iec61883.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH iec61883 7I "27 Mar 2009" "SunOS 5.11" "Ioctl Requests" +.TH IEC61883 7I "Mar 27, 2009" .SH NAME iec61883 \- IEC 61883 interfaces .SH SYNOPSIS @@ -121,7 +121,6 @@ typedef struct iec61883_arq { \fBarq_type\fR contains \fBARQ\fR type: .sp .ne 2 -.mk .na \fB\fBIEC61883_ARQ_FCP_CMD\fR\fR .ad @@ -139,7 +138,6 @@ See \fIIEC 61883-1\fR for the FCP frame structure definition. .sp .ne 2 -.mk .na \fB\fBIEC61883_ARQ_BUS_RESET\fR\fR .ad @@ -197,7 +195,6 @@ any active transfers that were in progress. The following commands only apply to isochronous nodes: .sp .ne 2 -.mk .na \fB\fBIEC61883_ISOCH_INIT\fR\fR .ad @@ -242,7 +239,6 @@ compatible with \fBii_bus_speed\fR. \fBii_direction\fR can take one of the following values: .sp .ne 2 -.mk .na \fB\fBIEC61883_DIR_RECV\fR\fR .ad @@ -253,7 +249,6 @@ Receiving isochronous data. .sp .ne 2 -.mk .na \fB\fBIEC61883_DIR_XMIT\fR\fR .ad @@ -285,7 +280,6 @@ set by \fBii_rate_n\fR and \fBii_rate_d\fR respectively. Any integer numbers can be used, or the following predefined constants: .sp .ne 2 -.mk .na \fB\fBIEC61883_RATE_N_DV_NTSC IEC61883_RATE_D_DV_NTSC\fR\fR .ad @@ -296,7 +290,6 @@ Data rate expected by \fBDV-NTSC\fR devices. .sp .ne 2 -.mk .na \fB\fBIEC61883_RATE_N_DV_PAL IEC61883_RATE_D_DV_PAL\fR\fR .ad @@ -309,7 +302,6 @@ During data transmission, a timestamp based on the current value of the cycle timer is usually required. \fBii_ts_mode\fR defines timestamp mode to be used: .sp .ne 2 -.mk .na \fB\fBIEC61883_TS_SYT\fR\fR .ad @@ -320,7 +312,6 @@ Driver puts a timestamp in the SYT field of the first CIP header of each frame. .sp .ne 2 -.mk .na \fB\fBIEC61883_TS_NONE\fR\fR .ad @@ -355,7 +346,6 @@ In case of command success, \fBii_error\fR is set to 0; otherwise one of the following values can be returned: .sp .ne 2 -.mk .na \fB\fBIEC61883_ERR_NOMEM\fR\fR .ad @@ -366,7 +356,6 @@ Not enough memory for the data buffer. .sp .ne 2 -.mk .na \fB\fBIEC61883_ERR_NOCHANNEL\fR\fR .ad @@ -377,7 +366,6 @@ Cannot allocate isochronous channel. .sp .ne 2 -.mk .na \fB\fBIEC61883_ERR_PKT_SIZE\fR\fR .ad @@ -388,7 +376,6 @@ Packet size is not allowed at this bus speed. .sp .ne 2 -.mk .na \fB\fBIEC61883_ERR_VERSION\fR\fR .ad @@ -399,7 +386,6 @@ Interface version is not supported. .sp .ne 2 -.mk .na \fB\fBIEC61883_ERR_INVAL\fR\fR .ad @@ -410,7 +396,6 @@ One or more the parameters are invalid .sp .ne 2 -.mk .na \fB\fBIEC61883_ERR_OTHER\fR\fR .ad @@ -423,7 +408,6 @@ Unspecified error type. .sp .ne 2 -.mk .na \fB\fBIEC61883_ISOCH_FINI\fR\fR .ad @@ -436,7 +420,6 @@ and the data buffer must be unmapped; otherwise the command fails. .sp .ne 2 -.mk .na \fB\fBIEC61883_START\fR\fR .ad @@ -448,7 +431,6 @@ by \fBIEC61883_ISOCH_INIT\fR. .sp .ne 2 -.mk .na \fB\fBIEC61883_STOP\fR\fR .ad @@ -460,7 +442,6 @@ by \fBIEC61883_ISOCH_INIT\fR. .sp .ne 2 -.mk .na \fB\fBIEC61883_RECV\fR\fR .ad @@ -510,7 +491,6 @@ continuity counters (DBC field of the CIP header). .sp .ne 2 -.mk .na \fB\fBIEC61883_XMIT\fR\fR .ad @@ -550,7 +530,6 @@ frame buffer to be the first packet of an AV frame. .sp .ne 2 -.mk .na \fB\fBIEC61883_PLUG_INIT\fR\fR .ad @@ -579,7 +558,6 @@ typedef struct iec61883_plug_init { \fBpi_loc\fR specifies plug location: .sp .ne 2 -.mk .na \fB\fBIEC61883_LOC_LOCAL\fR\fR .ad @@ -591,7 +569,6 @@ Command fails if the plug already exists .sp .ne 2 -.mk .na \fB\fBIEC61883_LOC_REMOTE\fR\fR .ad @@ -604,7 +581,6 @@ otherwise the command fails. \fBpi_type\fR specifies isochronous plug type: .sp .ne 2 -.mk .na \fB\fBIEC61883_PLUG_IN IEC61883_PLUG_OUT\fR\fR .ad @@ -615,7 +591,6 @@ Input or output plugs. .sp .ne 2 -.mk .na \fB\fBIEC61883_PLUG_MASTER_IN IEC61883_PLUG_MASTER_OUT\fR\fR .ad @@ -637,7 +612,6 @@ with other plug commands. .sp .ne 2 -.mk .na \fB\fBIEC61883_PLUG_FINI\fR\fR .ad @@ -649,7 +623,6 @@ any resources associated with this handle, including the PCR. .sp .ne 2 -.mk .na \fB\fBIEC61883_PLUG_REG_READ\fR\fR .ad @@ -673,7 +646,6 @@ value is returned in \fBpr_val\fR. .sp .ne 2 -.mk .na \fB\fBIEC61883_PLUG_REG_CAS\fR\fR .ad @@ -706,7 +678,6 @@ pl_old. The following commands only apply to asynchronous nodes: .sp .ne 2 -.mk .na \fB\fBIEC61883_ARQ_GET_IBUF_SIZE\fR\fR .ad @@ -718,7 +689,6 @@ pointer to \fBint\fR. .sp .ne 2 -.mk .na \fB\fBIEC61883_ARQ_SET_IBUF_SIZE\fR\fR .ad @@ -731,35 +701,29 @@ size in bytes. .SH FILES .sp .ne 2 -.mk .na \fB\fB/dev/av/N/async\fR\fR .ad .RS 19n -.rt Device node for asynchronous data .RE .sp .ne 2 -.mk .na \fB\fB/dev/av/N/isoch\fR\fR .ad .RS 19n -.rt Device has been disconnected .RE .SH ERRORS .sp .ne 2 -.mk .na \fB\fBEIO\fR\fR .ad .RS 10n -.rt Bus operation failed. .sp DMA failure. @@ -767,34 +731,28 @@ DMA failure. .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt \fBioctl\fR(2) argument points to an illegal address. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt Invalid argument or argument combination. .RE .sp .ne 2 -.mk .na \fB\fBENODEV\fR\fR .ad .RS 10n -.rt Device has been disconnected. .RE @@ -806,15 +764,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(1.83i) |cw(3.67i) -lw(1.83i) |lw(3.67i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitectureAll +Architecture All _ -Stability levelCommitted +Stability level Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man7i/ipnat.7i b/usr/src/man/man7i/ipnat.7i index ec46376b6b..551790aa7e 100644 --- a/usr/src/man/man7i/ipnat.7i +++ b/usr/src/man/man7i/ipnat.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH ipnat 7I "22 May 2008" "SunOS 5.11" "Ioctl Requests" +.TH IPNAT 7I "May 22, 2008" .SH NAME ipnat \- IP Filter/NAT module interface .SH DESCRIPTION @@ -61,24 +61,20 @@ only accept calls from 64-bit applications. Calls from 32-bit applications fail with \fBEINVAL\fR. .sp .ne 2 -.mk .na \fB\fBSIOCSTLCK\fR\fR .ad .RS 13n -.rt Set or clear the NAT lock to prevent table updates attributable to packet flow-through. .RE .sp .ne 2 -.mk .na \fB\fBSIOCGNATL\fR\fR .ad .RS 13n -.rt Search the NAT table for the rdr entry that matches the fields in the natlookup structure. The caller must populate the structure with the address/port information of the accepted TCP connection (nl_inip, nl_inport) and the @@ -103,7 +99,7 @@ cleared in the structure returned to the caller. i6addr_t nl_inipaddr; i6addr_t nl_outipaddr; i6addr_t nl_realipaddr; - int nl_v; + int nl_v; int nl_flags; u_short nl_inport; u_short nl_outport; @@ -116,7 +112,7 @@ cleared in the structure returned to the caller. #define nl_inip6 nl_inipaddr.in6 #define nl_outip6 nl_outipaddr.in6 #define nl_realip6 nl_realipaddr.in6 - + /* * Accepted values for nl_flags */ @@ -129,12 +125,10 @@ cleared in the structure returned to the caller. .sp .ne 2 -.mk .na \fB\fBSIOCSTPUT\fR\fR .ad .RS 13n -.rt Move a NAT mapping structure from user space into the kernel. This ioctl is used by \fBipfs\fR(1M) to restore NAT sessions saved in \fB/var/db/ipf/ipnat.ipf\fR. The nat_save structure must have its ipn_nat and @@ -377,12 +371,10 @@ int .SH ERRORS .sp .ne 2 -.mk .na \fBEPERM\fR .ad .RS 10n -.rt The device has been opened for reading only. To succeed, the ioctl call must be opened for both reading and writing. The call may be returned if it is privileged and the calling process did not assert {\fBPRIV_SYS_NET_CONFIG\fR} @@ -391,12 +383,10 @@ in the effective set. .sp .ne 2 -.mk .na \fBENOMEM\fR .ad .RS 10n -.rt More memory was allocated than the kernel can provide. The call may also be returned if the application inserts a NAT entry that exceeds the hash bucket chain's maximum length. @@ -404,46 +394,38 @@ chain's maximum length. .sp .ne 2 -.mk .na \fBEFAULT\fR .ad .RS 10n -.rt The calling process specified an invalid pointer in the ipfobj structure. .RE .sp .ne 2 -.mk .na \fBEINVAL\fR .ad .RS 10n -.rt The calling process detected a parameter or field set to an unacceptable value. .RE .sp .ne 2 -.mk .na \fBEEXIST\fR .ad .RS 10n -.rt The calling process, via \fBSIOCSTPUT\fR, attempted to add a NAT entry that already exists in the NAT table. .RE .sp .ne 2 -.mk .na \fBESRCH\fR .ad .RS 10n -.rt The calling process called \fBSIOCSTPUT\fR before setting the SI_NEWFR flag and providing a pointer in the nat_fr field that cannot be found in the current rule set. @@ -451,12 +433,10 @@ rule set. .sp .ne 2 -.mk .na \fBEACESS\fR .ad .RS 10n -.rt The calling process issued a \fBSIOCSTPUT\fR before issuing a SIOCSTLCK. .RE @@ -468,13 +448,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man7i/mhd.7i b/usr/src/man/man7i/mhd.7i index fc990cd6bb..ddfc5d3c30 100644 --- a/usr/src/man/man7i/mhd.7i +++ b/usr/src/man/man7i/mhd.7i @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH mhd 7i "18 Mar 2011" "SunOS 5.11" "Ioctl Requests" +.TH MHD 7I "Mar 18, 2011" .SH NAME mhd \- multihost disk control operations .SH SYNOPSIS .LP .nf -\fB#include\fR \fB<sys/mhd.h>\fR +\fB#include\fR \fB<sys/mhd.h>\fR .fi .SH DESCRIPTION @@ -93,12 +93,10 @@ ioctl(fd, MHIOCQRESERVE); .sp .ne 2 -.mk .na \fB\fBMHIOCTKOWN\fR \fR .ad .RS 18n -.rt Forcefully acquires exclusive access rights to the multihost disk for the local host. Revokes all access rights to the multihost disk from remote hosts. Causes the disk to enter the exclusive access state. @@ -110,24 +108,20 @@ the automatic probe function described below. .sp .ne 2 -.mk .na \fB\fBMHIOCRELEASE\fR \fR .ad .RS 18n -.rt Relinquishes exclusive access rights to the multihost disk for the local host. On success, causes the disk to enter the non- exclusive access state. .RE .sp .ne 2 -.mk .na \fB\fBMHIOCSTATUS\fR \fR .ad .RS 18n -.rt Probes a multihost disk to determine whether the local host has access rights to the disk. Returns \fB0\fR if the local host has access to the disk, \fB1\fR if it doesn't, and \fB-1\fR with errno set to \fBEIO\fR if the probe @@ -136,12 +130,10 @@ failed for some other reason. .sp .ne 2 -.mk .na \fB\fBMHIOCQRESERVE\fR \fR .ad .RS 18n -.rt Issues, simply and only, a SCSI-2 Reserve command. If the attempt to reserve fails due to the SCSI error Reservation Conflict (which implies that some other host has the device reserved), then the ioctl will return \fB-1\fR with errno @@ -170,7 +162,6 @@ The function prototypes and descriptions for the shared multihost ioctls are as follows: .sp .ne 2 -.mk .na \fB\fBioctl\fR(\fBfd\fR, \fBMHIOCGRP_INKEYS\fR, (\fBmhioc_inkeys_t\fR) \fI*k\fR\fB);\fR\fR @@ -194,7 +185,6 @@ then this ioctl returns \fB-1\fR with \fBerrno\fR set to \fBENOTSUP\fR. .sp .ne 2 -.mk .na \fB\fBioctl\fR(\fBfd\fR, \fBMHIOCGRP_INRESV\fR, (\fBmhioc_inresvs_t\fR) \fI*r\fR\fB);\fR\fR @@ -209,7 +199,6 @@ then this ioctl returns \fB-1\fR with \fBerrno\fR set to \fBENOTSUP\fR. .sp .ne 2 -.mk .na \fB\fBioctl\fR(\fBfd\fR, \fBMHIOCGRP_REGISTER\fR, (\fBmhioc_register_t\fR) \fI*r\fR\fB);\fR\fR @@ -234,7 +223,6 @@ Reservation Conflict, this ioctl returns \fB-1\fR with \fBerrno\fR set to .sp .ne 2 -.mk .na \fB\fBioctl\fR(\fBfd\fR, \fBMHIOCGRP_RESERVE\fR, (\fBmhioc_resv_desc_t\fR) \fI*r\fR\fB);\fR\fR @@ -249,7 +237,6 @@ returns \fB-1\fR with \fBerrno\fR set to \fBEACCES.\fR .sp .ne 2 -.mk .na \fB\fBioctl\fR(\fBfd\fR, \fBMHIOCGRP_PREEMPTANDABORT\fR, (\fBmhioc_preemptandabort_t\fR) \fI*r\fR\fB);\fR\fR @@ -268,7 +255,6 @@ Reservation Conflict, this ioctl returns \fB-1\fR with \fBerrno\fR set to .sp .ne 2 -.mk .na \fB\fBioctl\fR(\fBfd\fR, \fBMHIOCGRP_PREEMPT\fR, (\fBmhioc_preemptandabort_t\fR) \fI*r\fR\fB);\fR\fR @@ -282,7 +268,6 @@ implemented). .sp .ne 2 -.mk .na \fB\fBioctl\fR(\fBfd\fR, \fBMHIOCGRP_CLEAR\fR, (\fBmhioc_resv_key_t\fR) \fI*r\fR\fB);\fR\fR @@ -312,7 +297,6 @@ The \fBMHIOCENFAILFAST\fR ioctl is applicable for both non-shared and shared disks, and may be used with either the non-shared or shared ioctls. .sp .ne 2 -.mk .na \fB\fBioctl\fR(\fBfd\fR, \fBMHIOENFAILFAST\fR, (unsigned int \fI*\fR) \fImillisecs\fR\fB);\fR\fR @@ -361,46 +345,38 @@ Each request returns \fB-1\fR on failure and sets \fBerrno\fR to indicate the error. .sp .ne 2 -.mk .na \fB\fBEPERM\fR \fR .ad .RS 14n -.rt Caller is not root. .RE .sp .ne 2 -.mk .na \fB\fBEACCES\fR \fR .ad .RS 14n -.rt Access rights were denied. .RE .sp .ne 2 -.mk .na \fB\fBEIO\fR\fR .ad .RS 14n -.rt The multihost disk or controller was unable to successfully complete the requested operation. .RE .sp .ne 2 -.mk .na \fB\fBEOPNOTSUP\fR \fR .ad .RS 14n -.rt The multihost disk does not support the operation. For example, it does not support the SCSI-2 Reserve/Release command set, or the SCSI-3 Persistent Reservation command set. @@ -414,12 +390,12 @@ See \fBattributes\fR(5) for a description of the following attributes: .sp .TS -tab() box; -lw(2.75i) lw(2.75i) -lw(2.75i) lw(2.75i) -. -\fBATTRIBUTE TYPE\fR\fBATTRIBUTE VALUE\fR -StabilityEvolving +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Stability Evolving .TE .SH SEE ALSO diff --git a/usr/src/man/man7i/mixer.7i b/usr/src/man/man7i/mixer.7i index 8bb993f574..6516e78d1e 100644 --- a/usr/src/man/man7i/mixer.7i +++ b/usr/src/man/man7i/mixer.7i @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH mixer 7I "21 May 2009" "SunOS 5.11" "Ioctl Requests" +.TH MIXER 7I "May 21, 2009" .SH NAME mixer \- generic mixer device interface .SH SYNOPSIS .LP .nf -\fB#include\fR \fB<sys/soundcard.h>\fR +\fB#include\fR \fB<sys/soundcard.h>\fR .fi .SH DESCRIPTION @@ -65,12 +65,10 @@ devices and mixers are available on the system, and then use about the audio devices or mixers, respectively. .sp .ne 2 -.mk .na \fB\fBOSS_GETVERSION\fR\fR .ad .RS 20n -.rt The argument is a pointer to an integer, which retrieves the version of the \fBOSS API\fR used. The value is encoded with the major version (currently 4) encoded in the most significant 16 bits, and a minor version encoded in the @@ -79,12 +77,10 @@ lower 16 bits. .sp .ne 2 -.mk .na \fB\fBSNDCTL_SYSINFO\fR\fR .ad .RS 20n -.rt The argument is a pointer to an \fBoss_sysinfo\fR structure, which has the following definition: .sp @@ -104,11 +100,11 @@ typedef struct oss_sysinfo { int numtimers; /* NOT SUPPORTED, always 0 */ int nummixers; /* # of mixer devices */ - int openedmidi[8]; /* Mask of midi devices are + int openedmidi[8]; /* Mask of midi devices are busy */ - int numcards; /* Number of sound cards in + int numcards; /* Number of sound cards in the system */ - int numaudioengines; /* Number of audio engines in + int numaudioengines; /* Number of audio engines in the system */ char license[16]; /* E.g. "GPL" or "CDDL" */ char revision_info[256]; /* Reserved */ @@ -128,12 +124,10 @@ typically there is exactly one audio device and one mixer for each card. .sp .ne 2 -.mk .na \fB\fBSNDCTL_AUDIOINFO\fR\fR .ad .RS 20n -.rt The argument is a pointer to an \fBoss_audioinfo\fR structure, which has the following structure: .sp @@ -152,15 +146,15 @@ typedef struct oss_audioinfo { int card_number; int port_number; /* reserved */ int mixer_dev; - int legacy_device; /* Obsolete field. + int legacy_device; /* Obsolete field. Replaced by devnode */ int enabled; /* reserved */ int flags; /* reserved */ int min_rate; /* Minimum sample rate */ int max_rate; /* Maximum sample rate */ - int min_channels; /* Minimum number + int min_channels; /* Minimum number of channels */ - int max_channels; /* Maximum number + int max_channels; /* Maximum number of channels */ int binding; /* reserved */ int rate_source; /* reserved */ @@ -170,7 +164,7 @@ typedef struct oss_audioinfo { char song_name[64]; /* reserved */ char label[16]; /* reserved */ int latency; /* reserved */ - char devnode[32]; /* Device special file + char devnode[32]; /* Device special file name (absolute path) */ int next_play_engine; /* reserved */ int next_rec_engine; /* reserved */ @@ -227,12 +221,10 @@ this file to access the device. .sp .ne 2 -.mk .na \fB\fBSNDCTL_CARDINFO\fR\fR .ad .RS 20n -.rt The argument is a pointer to a \fBstruct oss_card_info\fR, which has the following definition: .sp @@ -271,12 +263,10 @@ The flag, intr_count, and ack_count fields are not used by this implementation. .sp .ne 2 -.mk .na \fB\fBSNDCTL_MIXERINFO\fR\fR .ad .RS 20n -.rt The argument is a pointer to a \fBstruct oss_mixer_info\fR, which has the following definition: .sp @@ -296,7 +286,7 @@ typedef struct oss_mixerinfo { int flags;/* Reserved */ int nrext; int priority; - char devnode[32];/* Device special file name + char devnode[32];/* Device special file name (absolute path) */ int legacy_device;/* Reserved */ int filler[245];/* Reserved */ @@ -378,12 +368,10 @@ application should specify \fB-1\fR, although for compatibility the mixer allows the application to specify the mixer device number. .sp .ne 2 -.mk .na \fB\fBSNDCTL_MIX_NRMIX\fR\fR .ad .RS 23n -.rt The argument is a pointer to an integer, which receives the number of mixer devices in the system. Each can be queried by using its number with the \fBSNDCTL_MIXERINFO\fR ioctl. The same information is available using the @@ -392,12 +380,10 @@ devices in the system. Each can be queried by using its number with the .sp .ne 2 -.mk .na \fB\fBSNDCTL_MIX_NREXT\fR\fR .ad .RS 23n -.rt The argument is a pointer to an integer. On entry, the integer should contain the special value \fB-1\fR. On return the argument receives the number of mixer extensions (or mixer controls) supported by the mixer device. More details @@ -406,12 +392,10 @@ about each extension can be obtained by \fBSNDCTL_MIX_EXTINFO\fR ioctl. .sp .ne 2 -.mk .na \fB\fBSNDCTL_MIX_EXTINFO\fR\fR .ad .RS 23n -.rt The argument is a pointer to an \fBoss_mixext\fR structure which is defined as follows: .sp @@ -425,14 +409,14 @@ typedef struct oss_mixext { int minvalue; int flags; char id[16]; /* Mnemonic ID (internal use) */ - int parent; /* Entry# of parent + int parent; /* Entry# of parent (-1 if root) */ int dummy; /* NOT SUPPORTED */ int timestamp; char data[64]; /* Reserved */ - unsigned char enum_present[32]; /* Mask - of allowed - enum + unsigned char enum_present[32]; /* Mask + of allowed + enum values */ int control_no; /* Reserved */ unsigned int desc; /* NOT SUPPORTED */ @@ -465,7 +449,7 @@ MIXT_GROUP Logical grouping of controls MXIT_ONOFF Boolean value, 0 = off, 1 = on. MIXT_ENUM Enumerated value, 0 to maxvalue. MIXT_MONOSLIDER Monophonic slider, 0 to 255. -MIXT_STEREOSLIDER Stereophonic slider, 0 to 255 +MIXT_STEREOSLIDER Stereophonic slider, 0 to 255 (encoded as lower two bytes in value.) MIXT_MARKER Place holder, can ignore. @@ -481,13 +465,13 @@ possible bits: MIXF_READABLE Extension's value is readable. MIXF_WRITEABLE Extension's value is modifiable. MIXF_POLL Extension can self-update. -MIXF_PCMVOL Extension is for master +MIXF_PCMVOL Extension is for master PCM playback volume. -MIXF_MAINVOL Extension is for a typical +MIXF_MAINVOL Extension is for a typical analog volume -MIXF_RECVOL Extension is for master +MIXF_RECVOL Extension is for master record gain. -MIXF_MONVOL Extension is for a monitor +MIXF_MONVOL Extension is for a monitor source's gain. .fi .in -2 @@ -509,13 +493,13 @@ layout hints to applications. The following hints are available: .sp .in +2 .nf -MIXEXT_SCOPE_MASK Mask of possible scope +MIXEXT_SCOPE_MASK Mask of possible scope values. -MIXEXT_SCOPE_INPUT Extension is an input +MIXEXT_SCOPE_INPUT Extension is an input control. -MIXEXT_SCOPE_OUTPUT Extension is an +MIXEXT_SCOPE_OUTPUT Extension is an output control. -MIXEXT_SCOPE_MONITOR Extension relates to +MIXEXT_SCOPE_MONITOR Extension relates to input monitoring. MIXEXT_SCOPE_OTHER No scoping hint provided. .fi @@ -530,12 +514,10 @@ changed. .sp .ne 2 -.mk .na \fB\fBSNDCTL_MIX_ENUMINFO\fR\fR .ad .RS 23n -.rt The argument is a pointer to an \fBoss_mixer_enuminfo\fR structure, which is defined as follows: .sp @@ -565,7 +547,6 @@ pointing to an \fBASCIIZ\fR describing the enumeration value. .sp .ne 2 -.mk .na \fB\fBSNDCTL_MIX_READ\fR\fR .ad @@ -574,7 +555,6 @@ pointing to an \fBASCIIZ\fR describing the enumeration value. \fB\fBSNDCTL_MIX_WRITE\fR\fR .ad .RS 23n -.rt The argument is a pointer to an \fBoss_mixer_value\fR structure, defined as follows: .sp @@ -584,11 +564,11 @@ typedef struct oss_mixer_value { int dev; int ctrl; int value; - int flags; /* Reserved for future use. + int flags; /* Reserved for future use. Initialize to 0 */ - int timestamp; /* Must be set to + int timestamp; /* Must be set to oss_mixext.timestamp */ - int filler[8]; /* Reserved for future use. + int filler[8]; /* Reserved for future use. Initialize to 0 */ } oss_mixer_value; .fi @@ -650,47 +630,39 @@ should not be used in new applications. An \fBioctl()\fR fails if: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt The parameter changes requested in the ioctl are invalid or are not supported by the device. .RE .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 10n -.rt The device or extension referenced does not exist. .RE .SH FILES .sp .ne 2 -.mk .na \fB\fB/dev/mixer\fR\fR .ad .RS 16n -.rt Symbolic link to the pseudo mixer device for the system .RE .sp .ne 2 -.mk .na \fB\fB/dev/sndstat\fR\fR .ad .RS 16n -.rt Sound status device .RE @@ -702,15 +674,14 @@ See \fBattributes\fR(5) for a description of the following attributes: .sp .TS -tab() box; -cw(1.8i) |cw(3.7i) -lw(1.8i) |lw(3.7i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitectureSPARC, x86 +Architecture SPARC, x86 _ -Stability LevelSee below. +Stability Level See below. .TE .sp diff --git a/usr/src/man/man7i/mtio.7i b/usr/src/man/man7i/mtio.7i index b3512f06f5..7b3d9eee8a 100644 --- a/usr/src/man/man7i/mtio.7i +++ b/usr/src/man/man7i/mtio.7i @@ -3,15 +3,15 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH mtio 7I "15 Sep 2007" "SunOS 5.11" "Ioctl Requests" +.TH MTIO 7I "Sep 15, 2007" .SH NAME mtio \- general magnetic tape interface .SH SYNOPSIS .LP .nf #include <sys/types.h> -#include <sys/ioctl.h> -#include <sys/mtio.h> +#include <sys/ioctl.h> +#include <sys/mtio.h> .fi .SH DESCRIPTION @@ -323,11 +323,11 @@ Bits 7-15 behavior Select Select on Close Bits 0-1 #define MT_BSD (1 <<6) /* BSD behavior on close */ -/* Structure for MTIOCTOP \(mi magnetic tape operation command */ +/* Structure for MTIOCTOP \(mi magnetic tape operation command */ -struct mtop { - short mt_op; /* operation */ - daddr_t mt_count; /* number of operations */ +struct mtop { + short mt_op; /* operation */ + daddr_t mt_count; /* number of operations */ }; .fi .in -2 @@ -351,243 +351,199 @@ The following operations of \fBMTIOCTOP\fR and \fBMTIOCLTOP\fR ioctls are supported: .sp .ne 2 -.mk .na \fBMTWEOF\fR .ad .RS 17n -.rt write an end-of-file record .RE .sp .ne 2 -.mk .na \fBMTFSF\fR .ad .RS 17n -.rt forward space over file mark .RE .sp .ne 2 -.mk .na \fBMTBSF\fR .ad .RS 17n -.rt backward space over file mark (1/2", 8mm only) .RE .sp .ne 2 -.mk .na \fBMTFSR\fR .ad .RS 17n -.rt forward space to inter-record gap .RE .sp .ne 2 -.mk .na \fBMTBSR\fR .ad .RS 17n -.rt backward space to inter-record gap .RE .sp .ne 2 -.mk .na \fBMTREW\fR .ad .RS 17n -.rt rewind .RE .sp .ne 2 -.mk .na \fBMTOFFL\fR .ad .RS 17n -.rt rewind and take the drive off-line .RE .sp .ne 2 -.mk .na \fBMTNOP\fR .ad .RS 17n -.rt no operation, sets status only .RE .sp .ne 2 -.mk .na \fBMTRETEN\fR .ad .RS 17n -.rt retension the tape (cartridge tape only) .RE .sp .ne 2 -.mk .na \fBMTERASE\fR .ad .RS 17n -.rt erase the entire tape and rewind .RE .sp .ne 2 -.mk .na \fBMTEOM\fR .ad .RS 17n -.rt position to EOM .RE .sp .ne 2 -.mk .na \fBMTNBSF\fR .ad .RS 17n -.rt backward space file to beginning of file .RE .sp .ne 2 -.mk .na \fBMTSRSZ\fR .ad .RS 17n -.rt set record size .RE .sp .ne 2 -.mk .na \fBMTGRSZ\fR .ad .RS 17n -.rt get record size .RE .sp .ne 2 -.mk .na \fBMTTELL\fR .ad .RS 17n -.rt get current position .RE .sp .ne 2 -.mk .na \fBMTSEEK\fR .ad .RS 17n -.rt go to requested position .RE .sp .ne 2 -.mk .na \fBMTFSSF\fR .ad .RS 17n -.rt forward to requested number of sequential file marks .RE .sp .ne 2 -.mk .na \fBMTBSSF\fR .ad .RS 17n -.rt backward to requested number of sequential file marks .RE .sp .ne 2 -.mk .na \fBMTLOCK\fR .ad .RS 17n -.rt prevent media removal .RE .sp .ne 2 -.mk .na \fBMTUNLOCK\fR .ad .RS 17n -.rt allow media removal .RE .sp .ne 2 -.mk .na \fBMTLOAD\fR .ad .RS 17n -.rt load the next tape cartridge into the tape drive .RE .sp .ne 2 -.mk .na \fBMTIOCGETERROR\fR .ad .RS 17n -.rt retrieve error records from the st driver .RE @@ -651,9 +607,9 @@ struct mtdrivetype { ST_EOM, /* at physical eot */ ST_WRITE_AFTER_EOM /* flag allowing writes after EOM */ }pstatus; - + typedef enum { invalid, legacy, logical } posmode; - + typedef struct tapepos { uint64_t lgclblkno; /* Blks from start of partition */ int32_t fileno; /* Num. of current file */ @@ -663,7 +619,7 @@ struct mtdrivetype { posmode pmode; /* which pos. data is valid */ char pad[4]; }tapepos_t; - + If the pmode is legacy,fileno and blkno fields are valid. If the pmode is logical, lgclblkno field is valid. .fi @@ -832,45 +788,37 @@ The MTIOCRESTPOS ioctl restores a saved position from the MTIOCGETPOS. .SS "Persistent Error Handling IOCTLs and Asynchronous Tape Operations" .sp .ne 2 -.mk .na \fBMTIOCPERSISTENT\fR .ad .RS 25n -.rt enables/disables persistent error handling .RE .sp .ne 2 -.mk .na \fBMTIOCPERSISTENTSTATUS\fR .ad .RS 25n -.rt queries for persistent error handling .RE .sp .ne 2 -.mk .na \fBMTIOCLRERR\fR .ad .RS 25n -.rt clears persistent error handling .RE .sp .ne 2 -.mk .na \fBMTIOCGUARANTEEDORDER\fR .ad .RS 25n -.rt checks whether driver guarantees order of I/O's .RE @@ -933,12 +881,10 @@ on persistent error handling. .SS "Asynchronous and State Change IOCTLS" .sp .ne 2 -.mk .na \fB\fBMTIOCSTATE\fR\fR .ad .RS 14n -.rt This ioctl blocks until the state of the drive, inserted or ejected, is changed. The argument is a pointer to a \fBmtio_state\fR, \fBenum\fR, whose possible enumerations are listed below. The initial value should be either the @@ -965,34 +911,28 @@ commands to complete before they are executed. .SS "IOCTLS for Multi-initiator Configurations" .sp .ne 2 -.mk .na \fBMTIOCRESERVE\fR .ad .RS 21n -.rt reserve the tape drive .RE .sp .ne 2 -.mk .na \fBMTIOCRELEASE\fR .ad .RS 21n -.rt revert back to the default behavior of reserve on open/release on close .RE .sp .ne 2 -.mk .na \fBMTIOCFORCERESERVE\fR .ad .RS 21n -.rt reserve the tape unit by breaking reservation held by another host .RE @@ -1032,35 +972,29 @@ ioctl(fd, MTIOCFORCERESERVE); .SS "IOCTLS for Handling Tape Configuration Options" .sp .ne 2 -.mk .na \fBMTIOCSHORTFMK\fR .ad .RS 23n -.rt enables/disable support for writing short filemarks. This is specific to Exabyte drives. .RE .sp .ne 2 -.mk .na \fBMTIOCREADIGNOREILI\fR .ad .RS 23n -.rt enables/disable supress incorrect length indicator support during reads .RE .sp .ne 2 -.mk .na \fBMTIOCREADIGNOREEOFS\fR .ad .RS 23n -.rt enables/disable support for reading past two EOF marks which otherwise indicate End-Of-recording-Media (EOM) in the case of 1/2" reel tape drives .RE diff --git a/usr/src/man/man7i/prnio.7i b/usr/src/man/man7i/prnio.7i index 19cf506ebe..2814f70083 100644 --- a/usr/src/man/man7i/prnio.7i +++ b/usr/src/man/man7i/prnio.7i @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH prnio 7I "2 Jan 2002" "SunOS 5.11" "Ioctl Requests" +.TH PRNIO 7I "Jan 2, 2002" .SH NAME prnio \- generic printer interface .SH SYNOPSIS @@ -86,12 +86,10 @@ during the Abort phase as described in \fBPRNIOC_GET_IFCAP\fR section. .SH IOCTLS .sp .ne 2 -.mk .na \fB\fBPRNIOC_GET_IFCAP\fR\fR .ad .RS 21n -.rt Application can retrieve printer interface capabilities using this command. The \fBioctl\fR(2) argument is a pointer to \fBuint_t\fR, a bit field representing a set of properties and services provided by a printer driver. Set bit means @@ -138,12 +136,10 @@ data. Only STREAMS drivers can support this capability. .sp .ne 2 -.mk .na \fBPRNIOC_SET_IFCAP\fR .ad .RS 21n -.rt This ioctl can be used to change interface capabilities. The argument is a pointer to \fBuint_t\fR bit field that is described in detail in the \fBPRNIOC_GET_IFCAP\fR section. Capabilities should be set one at a time; @@ -162,12 +158,10 @@ followed by \fBPRNIOC_GET_IFCAP\fR. .sp .ne 2 -.mk .na \fBPRNIOC_GET_IFINFO\fR .ad .RS 21n -.rt This command can be used to retrieve printer interface info string, which is an arbitrary format string usually describing the bus type. The argument is a pointer to \fBstruct prn_interface_info\fR as described below.\f(CW\fR @@ -214,17 +208,15 @@ macros: .in -2 .br .in +2 -Printer interface info string is for information only: no implications should +Printer interface info string is for information only: no implications should be made from its value. .in -2 .sp .ne 2 -.mk .na \fBPRNIOC_RESET\fR .ad .RS 25n -.rt Some applications may want to reset the printer state during Setup and/or Cleanup phase using \fBPRNIOC_RESET\fR command. Reset semantics are device-specific, and in general, applications using this command should be @@ -238,13 +230,11 @@ corresponding man page and printer manual. .sp .ne 2 -.mk .na \fBPRNIOC_GET_1284_DEVID\fR .ad .RS 25n -.rt -This command can be used to retrieve printer device ID as defined by \fIIEEE +This command can be used to retrieve printer device ID as defined by \fIIEEE 1284-1994\fR.The \fBioctl\fR(2) argument is a pointer to \fBstruct prn_1284_device_id\fR as described below. .RE @@ -263,7 +253,7 @@ struct prn_1284_device_id { .sp .LP For convenience, the two-byte length field is not considered part of device ID -string and is not returned in the user buffer. Instead, \fBid_rlen\fR value +string and is not returned in the user buffer. Instead, \fBid_rlen\fR value shall be set to (length - 2) by the driver, where length is the ID length field value. If buffer length is less than \fBid_rlen\fR, the driver returns the first \fBid_len\fR bytes of the ID. @@ -272,12 +262,10 @@ first \fBid_len\fR bytes of the ID. The printer driver must return the most up-to-date value of the device ID. .sp .ne 2 -.mk .na \fBPRNIOC_GET_STATUS\fR .ad .RS 21n -.rt This command can be used by applications to retrieve current device status. The argument is a pointer to \fBuint_t\fR, where the status word is returned. Status is a combination of the following bits: @@ -296,12 +284,10 @@ data. Applications may use this bit for an outbound flow control .in -2 .sp .ne 2 -.mk .na \fB\fBPRNIOC_GET_1284_STATUS\fR\fR .ad .RS 26n -.rt Devices that support \fBPRN_1284_STATUS\fR capability accept this ioctl to retrieve the device status lines defined in \fIIEEE 1284\fR for use in Compatibility mode. The following bits may be set by the driver: @@ -325,12 +311,10 @@ Compatibility mode. The following bits may be set by the driver: .sp .ne 2 -.mk .na \fB\fBPRNIOC_GET_TIMEOUTS\fR\fR .ad .RS 26n -.rt This command retrieves current transfer timeout values for the driver. The argument is a pointer to \fBstruct prn_timeouts\fR as described below. .RE @@ -352,12 +336,10 @@ timeouts in seconds. This command is only valid for drivers that support \fBPRN_TIMEOUTS\fR capability. .sp .ne 2 -.mk .na \fB\fBPRNIOC_SET_TIMEOUTS\fR\fR .ad .RS 23n -.rt This command sets current transfer timeout values for the driver. The argument is a pointer to \fBstruct prn_timeouts\fR. See \fBPRNIOC_GET_TIMEOUTS\fR for description of this structure. This command is @@ -372,15 +354,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Architecture SPARC, IA +Architecture SPARC, IA _ -Interface StabilityEvolving +Interface Stability Evolving .TE .SH SEE ALSO diff --git a/usr/src/man/man7i/quotactl.7i b/usr/src/man/man7i/quotactl.7i index 2c70a47e8d..39717a8dff 100644 --- a/usr/src/man/man7i/quotactl.7i +++ b/usr/src/man/man7i/quotactl.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH quotactl 7I "14 June 2004" "SunOS 5.11" "Ioctl Requests" +.TH QUOTACTL 7I "Jun 14, 2004" .SH NAME quotactl \- manipulate disk quotas .SH SYNOPSIS @@ -40,12 +40,10 @@ structure which is copied in or out of the system. The interpretation of \fIaddr\fR is given with each value of \fIop\fR below. .sp .ne 2 -.mk .na \fB\fBQ_QUOTAON\fR\fR .ad .RS 14n -.rt Turn on quotas for a file system. \fIaddr\fR points to the full pathname of the \fBquotas\fR file. \fIuid\fR is ignored. It is recommended that \fIuid\fR have the value of \fB0\fR. This call is restricted to the super-user. @@ -53,12 +51,10 @@ the value of \fB0\fR. This call is restricted to the super-user. .sp .ne 2 -.mk .na \fB\fBQ_QUOTAOFF\fR\fR .ad .RS 14n -.rt Turn off quotas for a file system. \fIaddr\fR and \fIuid\fR are ignored. It is recommended that \fIaddr\fR have the value of \fINULL\fR and \fIuid\fR have the value of \fB0\fR. This call is restricted to the super-user. @@ -66,12 +62,10 @@ value of \fB0\fR. This call is restricted to the super-user. .sp .ne 2 -.mk .na \fB\fBQ_GETQUOTA\fR\fR .ad .RS 14n -.rt Get disk quota limits and current usage for user \fIuid\fR. \fIaddr\fR is a pointer to a \fBdqblk\fR structure (defined in \fB<sys/fs/ufs_quota.h>\fR). Only the super-user may get the quotas of a user other than himself. @@ -79,12 +73,10 @@ Only the super-user may get the quotas of a user other than himself. .sp .ne 2 -.mk .na \fB\fBQ_SETQUOTA\fR\fR .ad .RS 14n -.rt Set disk quota limits and current usage for user \fIuid\fR. \fIaddr\fR is a pointer to a \fBdqblk\fR structure (defined in \fBsys/fs/ufs_quota.h\fR). This call is restricted to the super-user. @@ -92,12 +84,10 @@ call is restricted to the super-user. .sp .ne 2 -.mk .na \fB\fBQ_SETQLIM\fR\fR .ad .RS 14n -.rt Set disk quota limits for user \fIuid\fR. \fIaddr\fR is a pointer to a \fBdqblk\fR structure (defined in \fBsys/fs/ufs_quota.h\fR). This call is restricted to the super-user. @@ -105,24 +95,20 @@ restricted to the super-user. .sp .ne 2 -.mk .na \fB\fBQ_SYNC\fR\fR .ad .RS 14n -.rt Update the on-disk copy of quota usages for this file system. \fIaddr\fR and \fIuid\fR are ignored. .RE .sp .ne 2 -.mk .na \fB\fBQ_ALLSYNC\fR\fR .ad .RS 14n -.rt Update the on-disk copy of quota usages for all file systems with active quotas. \fIaddr\fR and \fIuid\fR are ignored. .RE @@ -133,93 +119,77 @@ quotas. \fIaddr\fR and \fIuid\fR are ignored. This \fBioctl()\fR returns: .sp .ne 2 -.mk .na \fB\fB0\fR\fR .ad .RS 9n -.rt on success. .RE .sp .ne 2 -.mk .na \fB\fB\(mi1\fR\fR .ad .RS 9n -.rt on failure and sets \fBerrno\fR to indicate the error. .RE .SH ERRORS .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt \fIaddr\fR is invalid. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt The kernel has not been compiled with the \fBQUOTA\fR option. \fIop\fR is invalid. .RE .sp .ne 2 -.mk .na \fB\fBENOENT\fR\fR .ad .RS 10n -.rt The \fBquotas\fR file specified by \fIaddr\fR does not exist. .RE .sp .ne 2 -.mk .na \fB\fBEPERM\fR\fR .ad .RS 10n -.rt The call is privileged and the calling process did not assert {PRIV_SYS_MOUNT} in the effective set. .RE .sp .ne 2 -.mk .na \fB\fBESRCH\fR\fR .ad .RS 10n -.rt No disk quota is found for the indicated user. Quotas have not been turned on for this file system. .RE .sp .ne 2 -.mk .na \fB\fBEUSERS\fR\fR .ad .RS 10n -.rt The quota table is full. .RE @@ -228,12 +198,10 @@ The quota table is full. If \fIop\fR is \fBQ_QUOTAON\fR, \fBioctl()\fR may set \fBerrno\fR to: .sp .ne 2 -.mk .na \fB\fBEACCES\fR\fR .ad .RS 10n -.rt The quota file pointed to by \fIaddr\fR exists but is not a regular file. The quota file pointed to by \fIaddr\fR exists but is not on the file system pointed to by \fIspecial\fR. @@ -241,12 +209,10 @@ pointed to by \fIspecial\fR. .sp .ne 2 -.mk .na \fB\fBEIO\fR\fR .ad .RS 10n -.rt Internal I/O error while attempting to read the \fBquotas\fR file pointed to by \fIaddr\fR. .RE @@ -254,7 +220,6 @@ Internal I/O error while attempting to read the \fBquotas\fR file pointed to by .SH FILES .sp .ne 2 -.mk .na \fB\fB/usr/include/sys/fs/ufs_quota.h\fR\fR .ad diff --git a/usr/src/man/man7i/sesio.7i b/usr/src/man/man7i/sesio.7i index 1c4965a475..a130d35c6c 100644 --- a/usr/src/man/man7i/sesio.7i +++ b/usr/src/man/man7i/sesio.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH sesio 7I "27 Mar 1997" "SunOS 5.11" "Ioctl Requests" +.TH SESIO 7I "Mar 27, 1997" .SH NAME sesio \- enclosure services device driver interface .SH SYNOPSIS @@ -23,23 +23,19 @@ SCSI enclosure services devices. The \fBses\fR driver supports the following ioctls: .sp .ne 2 -.mk .na \fB\fBSES_IOCTL_GETSTATE\fR\fR .ad .RS 22n -.rt This ioctl obtains enclosure state in the \fBses_ioctl\fR structure. .RE .sp .ne 2 -.mk .na \fB\fBSES_IOCTL_SETSTATE\fR\fR .ad .RS 22n -.rt This ioctl is used to set parameters on the enclosure services device. The \fBses_ioctl\fR structure is used to pass information into the driver. .RE @@ -47,46 +43,38 @@ This ioctl is used to set parameters on the enclosure services device. The .SH ERRORS .sp .ne 2 -.mk .na \fB\fBEIO\fR\fR .ad .RS 10n -.rt The \fBses\fR driver was unable to obtain data from the enclosure services device or the data transfer could not be completed. .RE .sp .ne 2 -.mk .na \fB\fBENOTTY\fR\fR .ad .RS 10n -.rt The \fBses\fR driver does not support the requested ioctl function. .RE .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 10n -.rt The enclosure services device does not exist. .RE .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt The user specified a bad data length. .RE @@ -133,13 +121,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -ArchitectureSPARC +Architecture SPARC .TE .SH SEE ALSO diff --git a/usr/src/man/man7i/sockio.7i b/usr/src/man/man7i/sockio.7i index 1e274f9897..96c49b5ca2 100644 --- a/usr/src/man/man7i/sockio.7i +++ b/usr/src/man/man7i/sockio.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH sockio 7I "8 Nov 1996" "SunOS 5.11" "Ioctl Requests" +.TH SOCKIO 7I "Nov 8, 1996" .SH NAME sockio \- ioctls that operate directly on sockets .SH SYNOPSIS @@ -23,12 +23,10 @@ specific network interface or protocol are documented in the manual page for that interface or protocol. .sp .ne 2 -.mk .na \fB\fBSIOCSPGRP\fR\fR .ad .RS 15n -.rt The argument is a pointer to an \fBint\fR. Set the process-group \fBID\fR that will subsequently receive \fBSIGIO\fR or \fBSIGURG\fR signals for the socket referred to by the descriptor passed to \fBioctl\fR to the value of that @@ -38,12 +36,10 @@ process \fBID)\fR or negative (in which case it must be a process group). .sp .ne 2 -.mk .na \fB\fBSIOCGPGRP\fR\fR .ad .RS 15n -.rt The argument is a pointer to an \fBint\fR. Set the value of that \fBint\fR to the process-group \fBID\fR that is receiving \fBSIGIO\fR or \fBSIGURG\fR signals for the socket referred to by the descriptor passed to \fBioctl\fR. @@ -51,12 +47,10 @@ signals for the socket referred to by the descriptor passed to \fBioctl\fR. .sp .ne 2 -.mk .na \fB\fBSIOCCATMARK\fR\fR .ad .RS 15n -.rt The argument is a pointer to an \fBint\fR. Set the value of that \fBint\fR to \fB1\fR if the read pointer for the socket referred to by the descriptor passed to \fBioctl\fR points to a mark in the data stream for an out-of-band message. diff --git a/usr/src/man/man7i/streamio.7i b/usr/src/man/man7i/streamio.7i index d28b82db7c..2b7e45629b 100644 --- a/usr/src/man/man7i/streamio.7i +++ b/usr/src/man/man7i/streamio.7i @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH streamio 7I "8 Apr 2009" "SunOS 5.11" "Ioctl Requests" +.TH STREAMIO 7I "Apr 8, 2009" .SH NAME streamio \- STREAMS ioctl commands .SH SYNOPSIS @@ -52,12 +52,10 @@ The following \fBioctl\fR commands, with error values indicated, are applicable to all STREAMS files: .sp .ne 2 -.mk .na \fB\fBI_PUSH\fR\fR .ad .RS 15n -.rt Pushes the module whose name is pointed to by \fIarg\fR onto the top of the current stream, just below the STREAM head. If the STREAM is a pipe, the module will be inserted between the stream heads of both ends of the pipe. It then @@ -65,56 +63,46 @@ calls the open routine of the newly-pushed module. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 11n -.rt Invalid module name. .RE .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 11n -.rt \fIarg\fR points outside the allocated address space. .RE .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 11n -.rt Open routine of new module failed. .RE .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 11n -.rt Hangup received on \fIfildes\fR. .RE .sp .ne 2 -.mk .na \fB\fBENOTSUP\fR\fR .ad .RS 11n -.rt Pushing a module is not supported on this stream. .RE @@ -122,12 +110,10 @@ Pushing a module is not supported on this stream. .sp .ne 2 -.mk .na \fB\fBI_POP\fR\fR .ad .RS 15n -.rt Removes the module just below the STREAM head of the STREAM pointed to by \fIfildes\fR. To remove a module from a pipe requires that the module was pushed on the side it is being removed from. \fIarg\fR should be \fB0\fR in an @@ -135,45 +121,37 @@ pushed on the side it is being removed from. \fIarg\fR should be \fB0\fR in an values: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 11n -.rt No module present in the stream. .RE .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 11n -.rt Hangup received on \fIfildes\fR. .RE .sp .ne 2 -.mk .na \fB\fBEPERM\fR\fR .ad .RS 11n -.rt Attempt to pop through an anchor by an unprivileged process. .RE .sp .ne 2 -.mk .na \fB\fBENOTSUP\fR\fR .ad .RS 11n -.rt Removal is not supported. .RE @@ -181,24 +159,20 @@ Removal is not supported. .sp .ne 2 -.mk .na \fB\fBI_ANCHOR\fR\fR .ad .RS 15n -.rt Positions the stream anchor to be at the stream's module directly below the stream head. Once this has been done, only a privileged process may pop modules below the anchor on the stream. \fIarg\fR must be \fB0\fR in an \fBI_ANCHOR\fR request. On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt Request to put an anchor on a pipe. .RE @@ -206,12 +180,10 @@ Request to put an anchor on a pipe. .sp .ne 2 -.mk .na \fB\fBI_LOOK\fR\fR .ad .RS 15n -.rt Retrieves the name of the module just below the stream head of the stream pointed to by \fIfildes\fR, and places it in a null terminated character string pointed at by \fIarg\fR. The buffer pointed to by \fIarg\fR should be at least @@ -219,23 +191,19 @@ pointed at by \fIarg\fR. The buffer pointed to by \fIarg\fR should be at least <sys/conf.h>\fR. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt \fIarg\fR points outside the allocated address space. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt No module present in stream. .RE @@ -243,44 +211,36 @@ No module present in stream. .sp .ne 2 -.mk .na \fB\fBI_FLUSH\fR\fR .ad .RS 15n -.rt This request flushes all input and/or output queues, depending on the value of \fIarg\fR. Legal \fIarg\fR values are: .sp .ne 2 -.mk .na \fBFLUSHR\fR .ad .RS 11n -.rt Flush read queues. .RE .sp .ne 2 -.mk .na \fBFLUSHW\fR .ad .RS 11n -.rt Flush write queues. .RE .sp .ne 2 -.mk .na \fBFLUSHRW\fR .ad .RS 11n -.rt Flush read and write queues. .RE @@ -306,35 +266,29 @@ pipe so that it is at the midpoint of the pipe itself. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBENOSR\fR\fR .ad .RS 10n -.rt Unable to allocate buffers for flush message due to insufficient stream memory resources. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt Invalid \fIarg\fR value. .RE .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 10n -.rt Hangup received on \fIfildes\fR. .RE @@ -342,12 +296,10 @@ Hangup received on \fIfildes\fR. .sp .ne 2 -.mk .na \fB\fBI_FLUSHBAND\fR\fR .ad .RS 15n -.rt Flushes a particular band of messages. \fIarg\fR points to a \fBbandinfo\fR structure that has the following members: .sp @@ -364,12 +316,10 @@ The \fBbi_flag\fR field may be one of \fBFLUSHR\fR, \fBFLUSHW\fR, or .sp .ne 2 -.mk .na \fB\fBI_SETSIG\fR\fR .ad .RS 15n -.rt Informs the stream head that the user wishes the kernel to issue the \fBSIGPOLL\fR signal (see \fBsignal\fR(3C)) when a particular event has occurred on the stream associated with \fIfildes\fR. \fBI_SETSIG\fR supports an @@ -378,12 +328,10 @@ bitmask that specifies the events for which the user should be signaled. It is the bitwise OR of any combination of the following constants: .sp .ne 2 -.mk .na \fB\fBS_INPUT\fR\fR .ad .RS 13n -.rt Any message other than an \fBM_PCPROTO\fR has arrived on a stream head read queue. This event is maintained for compatibility with previous releases. This event is triggered even if the message is of zero length. @@ -391,71 +339,59 @@ event is triggered even if the message is of zero length. .sp .ne 2 -.mk .na \fB\fBS_RDNORM\fR\fR .ad .RS 13n -.rt An ordinary (non-priority) message has arrived on a stream head read queue. This event is triggered even if the message is of zero length. .RE .sp .ne 2 -.mk .na \fB\fBS_RDBAND\fR\fR .ad .RS 13n -.rt A priority band message (band > 0) has arrived on a stream head read queue. This event is triggered even if the message is of zero length. .RE .sp .ne 2 -.mk .na \fB\fBS_HIPRI\fR\fR .ad .RS 13n -.rt A high priority message is present on the stream head read queue. This event is triggered even if the message is of zero length. .RE .sp .ne 2 -.mk .na \fB\fBS_OUTPUT\fR\fR .ad .RS 13n -.rt The write queue just below the stream head is no longer full. This notifies the user that there is room on the queue for sending (or writing) data downstream. .RE .sp .ne 2 -.mk .na \fB\fBS_WRNORM\fR\fR .ad .RS 13n -.rt This event is the same as \fBS_OUTPUT\fR. .RE .sp .ne 2 -.mk .na \fB\fBS_WRBAND\fR\fR .ad .RS 13n -.rt A priority band greater than 0 of a queue downstream exists and is writable. This notifies the user that there is room on the queue for sending (or writing) priority data downstream. @@ -463,46 +399,38 @@ priority data downstream. .sp .ne 2 -.mk .na \fB\fBS_MSG\fR\fR .ad .RS 13n -.rt A STREAMS signal message that contains the \fBSIGPOLL\fR signal has reached the front of the stream head read queue. .RE .sp .ne 2 -.mk .na \fB\fBS_ERROR\fR\fR .ad .RS 13n -.rt An \fBM_ERROR\fR message has reached the stream head. .RE .sp .ne 2 -.mk .na \fB\fBS_HANGUP\fR\fR .ad .RS 13n -.rt An \fBM_HANGUP\fR message has reached the stream head. .RE .sp .ne 2 -.mk .na \fB\fBS_BANDURG\fR\fR .ad .RS 13n -.rt When used in conjunction with \fBS_RDBAND\fR, \fBSIGURG\fR is generated instead of \fBSIGPOLL\fR when a priority message reaches the front of the stream head read queue. @@ -521,24 +449,20 @@ will not receive further \fBSIGPOLL\fR signals. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIarg\fR value is invalid or \fIarg\fR is zero and process is not registered to receive the \fBSIGPOLL\fR signal. .RE .sp .ne 2 -.mk .na \fB\fBEAGAIN\fR\fR .ad .RS 10n -.rt Allocation of a data structure to store the signal request failed. .RE @@ -546,12 +470,10 @@ Allocation of a data structure to store the signal request failed. .sp .ne 2 -.mk .na \fB\fBI_GETSIG\fR\fR .ad .RS 15n -.rt Returns the events for which the calling process is currently registered to be sent a \fBSIGPOLL\fR signal. The events are returned as a bitmask pointed to by \fIarg\fR, where the events are those specified in the description of @@ -559,23 +481,19 @@ by \fIarg\fR, where the events are those specified in the description of values: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt Process not registered to receive the \fBSIGPOLL\fR signal. .RE .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt \fIarg\fR points outside the allocated address space. .RE @@ -583,35 +501,29 @@ Process not registered to receive the \fBSIGPOLL\fR signal. .sp .ne 2 -.mk .na \fB\fBI_FIND\fR\fR .ad .RS 15n -.rt Compares the names of all modules currently present in the stream to the name pointed to by \fIarg\fR, and returns 1 if the named module is present in the stream. It returns 0 if the named module is not present. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt \fIarg\fR points outside the allocated address space. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIarg\fR does not contain a valid module name. .RE @@ -619,12 +531,10 @@ stream. It returns 0 if the named module is not present. On failure, .sp .ne 2 -.mk .na \fB\fBI_PEEK\fR\fR .ad .RS 15n -.rt Allows a user to retrieve the information in the first message on the stream head read queue without taking the message off the queue. \fBI_PEEK\fR is analogous to \fBgetmsg\fR(2) except that it does not remove the message from @@ -654,46 +564,38 @@ contains the value \fBRS_HIPRI\fR or \fB0\fR. On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 11n -.rt \fIarg\fR points, or the buffer area specified in \fBctlbuf\fR or \fBdatabuf\fR is, outside the allocated address space. .RE .sp .ne 2 -.mk .na \fB\fBEBADMSG\fR\fR .ad .RS 11n -.rt Queued message to be read is not valid for \fBI_PEEK\fR. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 11n -.rt Illegal value for \fBflags\fR. .RE .sp .ne 2 -.mk .na \fB\fBENOSR\fR\fR .ad .RS 11n -.rt Unable to allocate buffers to perform the I_PEEK due to insufficient STREAMS memory resources. .RE @@ -702,44 +604,36 @@ memory resources. .sp .ne 2 -.mk .na \fB\fBI_SRDOPT\fR\fR .ad .RS 15n -.rt Sets the read mode (see \fBread\fR(2)) using the value of the argument \fIarg\fR. Legal \fIarg\fR values are: .sp .ne 2 -.mk .na \fBRNORM\fR .ad .RS 9n -.rt Byte-stream mode, the default. .RE .sp .ne 2 -.mk .na \fBRMSGD\fR .ad .RS 9n -.rt Message-discard mode. .RE .sp .ne 2 -.mk .na \fBRMSGN\fR .ad .RS 9n -.rt Message-nondiscard mode. .RE @@ -747,36 +641,30 @@ In addition, the stream head's treatment of control messages may be changed by setting the following flags in \fIarg\fR: .sp .ne 2 -.mk .na \fBRPROTNORM\fR .ad .RS 13n -.rt Reject \fBread()\fR with \fBEBADMSG\fR if a control message is at the front of the stream head read queue. .RE .sp .ne 2 -.mk .na \fBRPROTDAT\fR .ad .RS 13n -.rt Deliver the control portion of a message as data when a user issues \fBread()\fR. This is the default behavior. .RE .sp .ne 2 -.mk .na \fBRPROTDIS\fR .ad .RS 13n -.rt Discard the control portion of a message, delivering any data portion, when a user issues a \fBread\fR(\|). .RE @@ -784,12 +672,10 @@ user issues a \fBread\fR(\|). On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIarg\fR is not one of the above legal values, or \fIarg\fR is the bitwise inclusive \fBOR\fR of \fBRMSGD\fR and \fBRMSGN\fR. .RE @@ -798,23 +684,19 @@ inclusive \fBOR\fR of \fBRMSGD\fR and \fBRMSGN\fR. .sp .ne 2 -.mk .na \fB\fBI_GRDOPT\fR\fR .ad .RS 15n -.rt Returns the current read mode setting in an \fBint\fR pointed to by the argument \fIarg\fR. Read modes are described in \fBread\fR(\|). On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt \fIarg\fR points outside the allocated address space. .RE @@ -822,12 +704,10 @@ argument \fIarg\fR. Read modes are described in \fBread\fR(\|). On failure, .sp .ne 2 -.mk .na \fB\fBI_NREAD\fR\fR .ad .RS 15n -.rt Counts the number of data bytes in data blocks in the first message on the stream head read queue, and places this value in the location pointed to by \fIarg\fR. The return value for the command is the number of messages on the @@ -837,12 +717,10 @@ zero-length message is next on the queue. On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt \fIarg\fR points outside the allocated address space. .RE @@ -850,12 +728,10 @@ following value: .sp .ne 2 -.mk .na \fB\fBI_FDINSERT\fR\fR .ad .RS 15n -.rt Creates a message from specified buffer(s), adds information about another stream and sends the message downstream. The message contains a control part and an optional data part. The data and control parts to be sent are @@ -902,12 +778,10 @@ partial message is sent. The \fBioctl()\fR function with the \fBI_FDINSERT\fR command will fail if: .sp .ne 2 -.mk .na \fB\fBEAGAIN\fR\fR .ad .RS 10n -.rt A non-priority message is specified, the \fBO_NDELAY\fR or \fBO_NONBLOCK\fR flag is set, and the stream write queue is full due to internal flow control conditions. @@ -915,35 +789,29 @@ conditions. .sp .ne 2 -.mk .na \fB\fBENOSR\fR\fR .ad .RS 10n -.rt Buffers can not be allocated for the message that is to be created. .RE .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt The \fIarg\fR argument points, or the buffer area specified in \fBctlbuf\fR or \fBdatabuf\fR is, outside the allocated address space. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt One of the following: The \fBfildes\fR member of the \fBstrfdinsert\fR structure is not a valid, open stream file descriptor; the size of a \fBt_uscalar_t\fR plus \fBoffset\fR is greater than the \fBlen\fR member for @@ -954,24 +822,20 @@ is stored in \fBflags\fR. .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 10n -.rt Hangup received on the \fBfildes\fR argument of the \fBioctl\fR call or the \fBfildes\fR member of the \fBstrfdinsert\fR structure. .RE .sp .ne 2 -.mk .na \fB\fBERANGE\fR\fR .ad .RS 10n -.rt The \fBlen\fR field for the buffer specified through \fBdatabuf\fR does not fall within the range specified by the maximum and minimum packet sizes of the topmost stream module; or the \fBlen\fR member for the buffer specified through @@ -988,12 +852,10 @@ in the message. .sp .ne 2 -.mk .na \fB\fBI_STR\fR\fR .ad .RS 15n -.rt Constructs an internal \fBSTREAMS\fR ioctl message from the data pointed to by \fIarg\fR, and sends that message downstream. .sp @@ -1043,24 +905,20 @@ structure to an internal \fBioctl\fR command message and send it downstream. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBENOSR\fR\fR .ad .RS 10n -.rt Unable to allocate buffers for the \fBioctl\fR message due to insufficient STREAMS memory resources. .RE .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt Either \fIarg\fR points outside the allocated address space, or the buffer area specified by \fBic_dp\fR and \fBic_len\fR (separately for data sent and data returned) is outside the allocated address space. @@ -1068,12 +926,10 @@ returned) is outside the allocated address space. .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fBic_len\fR is less than 0 or \fBic_len\fR is larger than the maximum configured size of the data part of a message or \fBic_timout\fR is less than -1. @@ -1081,23 +937,19 @@ configured size of the data part of a message or \fBic_timout\fR is less than .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 10n -.rt Hangup received on \fIfildes\fR. .RE .sp .ne 2 -.mk .na \fB\fBETIME\fR\fR .ad .RS 10n -.rt A downstream \fBioctl\fR timed out before acknowledgement was received. .RE @@ -1110,22 +962,18 @@ in the event the ioctl command sent downstream fails. For these cases, .sp .ne 2 -.mk .na \fB\fBI_SWROPT\fR\fR .ad .RS 15n -.rt Sets the write mode using the value of the argument \fIarg\fR. Legal bit settings for \fIarg\fR are: .sp .ne 2 -.mk .na \fB\fBSNDZERO\fR\fR .ad .RS 11n -.rt Send a zero-length message downstream when a write of 0 bytes occurs. .RE @@ -1135,12 +983,10 @@ not be set in \fIarg\fR. On failure, \fBerrno\fR may be set to the following value: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIarg\fR is not the above legal value. .RE @@ -1148,24 +994,20 @@ On failure, \fBerrno\fR may be set to the following value: .sp .ne 2 -.mk .na \fB\fBI_GWROPT\fR\fR .ad .RS 15n -.rt Returns the current write mode setting, as described above, in the \fBint\fR that is pointed to by the argument \fIarg\fR. .RE .sp .ne 2 -.mk .na \fB\fBI_SENDFD\fR\fR .ad .RS 15n -.rt Requests the stream associated with \fIfildes\fR to send a message, containing a file pointer, to the stream head at the other end of a stream pipe. The file pointer corresponds to \fIarg\fR, which must be an open file descriptor. @@ -1178,58 +1020,48 @@ stream head at the other end of the stream pipe to which it is connected. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBEAGAIN\fR\fR .ad .RS 10n -.rt The sending stream is unable to allocate a message block to contain the file pointer. .RE .sp .ne 2 -.mk .na \fB\fBEAGAIN\fR\fR .ad .RS 10n -.rt The read queue of the receiving stream head is full and cannot accept the message sent by \fBI_SENDFD.\fR .RE .sp .ne 2 -.mk .na \fB\fBEBADF\fR\fR .ad .RS 10n -.rt \fIarg\fR is not a valid, open file descriptor. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIfildes\fR is not connected to a stream pipe. .RE .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 10n -.rt Hangup received on \fIfildes\fR. .RE @@ -1237,12 +1069,10 @@ Hangup received on \fIfildes\fR. .sp .ne 2 -.mk .na \fB\fBI_RECVFD\fR\fR .ad .RS 15n -.rt Retrieves the file descriptor associated with the message sent by an \fBI_SENDFD\fR \fBioctl\fR over a stream pipe. \fIarg\fR is a pointer to a data buffer large enough to hold an \fBstrrecvfd\fR data structure containing the @@ -1272,69 +1102,57 @@ pointed to by \fIarg\fR. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBEAGAIN\fR\fR .ad .RS 13n -.rt A message is not present at the stream head read queue, and the \fBO_NDELAY\fR or \fBO_NONBLOCK\fR flag is set. .RE .sp .ne 2 -.mk .na \fB\fBEBADMSG\fR\fR .ad .RS 13n -.rt The message at the stream head read queue is not a message containing a passed file descriptor. .RE .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 13n -.rt \fIarg\fR points outside the allocated address space. .RE .sp .ne 2 -.mk .na \fB\fBEMFILE\fR\fR .ad .RS 13n -.rt \fBNOFILES\fR file descriptors are currently open. .RE .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 13n -.rt Hangup received on \fIfildes\fR. .RE .sp .ne 2 -.mk .na \fB\fBEOVERFLOW\fR\fR .ad .RS 13n -.rt \fIuid\fR or \fIgid\fR is too large to be stored in the structure pointed to by \fIarg\fR. .RE @@ -1343,12 +1161,10 @@ Hangup received on \fIfildes\fR. .sp .ne 2 -.mk .na \fB\fBI_LIST\fR\fR .ad .RS 15n -.rt Allows the user to list all the module names on the stream, up to and including the topmost driver name. If \fIarg\fR is \fINULL\fR, the return value is the number of modules, including the driver, that are on the stream pointed to by @@ -1383,23 +1199,19 @@ end of the stream is reached, or the number of requested modules following values: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt The \fBsl_nmods\fR member is less than 1. .RE .sp .ne 2 -.mk .na \fB\fBEAGAIN\fR\fR .ad .RS 10n -.rt Unable to allocate buffers .RE @@ -1407,35 +1219,29 @@ Unable to allocate buffers .sp .ne 2 -.mk .na \fB\fBI_ATMARK\fR\fR .ad .RS 15n -.rt Allows the user to see if the current message on the stream head read queue is ``marked'' by some module downstream. \fIarg\fR determines how the checking is done when there may be multiple marked messages on the stream head read queue. It may take the following values: .sp .ne 2 -.mk .na \fB\fBANYMARK\fR\fR .ad .RS 12n -.rt Check if the message is marked. .RE .sp .ne 2 -.mk .na \fB\fBLASTMARK\fR\fR .ad .RS 12n -.rt Check if the message is the last one marked on the queue. .RE @@ -1443,12 +1249,10 @@ The return value is \fB1\fR if the mark condition is satisfied and \fB0\fR otherwise. On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt Invalid \fIarg\fR value. .RE @@ -1456,12 +1260,10 @@ Invalid \fIarg\fR value. .sp .ne 2 -.mk .na \fB\fBI_CKBAND\fR\fR .ad .RS 15n -.rt Check if the message of a given priority band exists on the stream head read queue. This returns \fB1\fR if a message of a given priority exists, \fB0\fR if not, or \fB\(mi1\fR on error. \fIarg\fR should be an integer containing the @@ -1469,12 +1271,10 @@ value of the priority band in question. On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt Invalid \fIarg\fR value. .RE @@ -1482,23 +1282,19 @@ Invalid \fIarg\fR value. .sp .ne 2 -.mk .na \fB\fBI_GETBAND\fR\fR .ad .RS 15n -.rt Returns the priority band of the first message on the stream head read queue in the integer referenced by \fIarg\fR. On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBENODATA\fR\fR .ad .RS 11n -.rt No message on the stream head read queue. .RE @@ -1506,24 +1302,20 @@ No message on the stream head read queue. .sp .ne 2 -.mk .na \fB\fBI_CANPUT\fR\fR .ad .RS 15n -.rt Check if a certain band is writable. \fIarg\fR is set to the priority band in question. The return value is \fB0\fR if the priority band \fIarg\fR is flow controlled, \fB1\fR if the band is writable, or \fB\(mi1\fR on error. On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt Invalid \fIarg\fR value. .RE @@ -1531,12 +1323,10 @@ Invalid \fIarg\fR value. .sp .ne 2 -.mk .na \fB\fBI_SETCLTIME\fR\fR .ad .RS 15n -.rt Allows the user to set the time the stream head will delay when a stream is closing and there are data on the write queues. Before closing each module and driver, the stream head will delay for the specified amount of time to allow @@ -1549,12 +1339,10 @@ The default is fifteen seconds. On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt Invalid \fIarg\fR value. .RE @@ -1562,23 +1350,19 @@ Invalid \fIarg\fR value. .sp .ne 2 -.mk .na \fB\fBI_GETCLTIME\fR\fR .ad .RS 15n -.rt Returns the close time delay in the integer pointed by \fIarg\fR. .RE .sp .ne 2 -.mk .na \fB\fBI_SERROPT\fR\fR .ad .RS 15n -.rt Sets the error mode using the value of the argument \fIarg\fR. .sp Normally stream head errors are persistent; once they are set due to an @@ -1591,46 +1375,38 @@ controlled independently for read and write side errors. Legal \fIarg\fR values are either none or one of: .sp .ne 2 -.mk .na \fB\fBRERRNORM\fR\fR .ad .RS 18n -.rt Persistent read errors, the default. .RE .sp .ne 2 -.mk .na \fB\fBRERRNONPERSIST\fR\fR .ad .RS 18n -.rt Non-persistent read errors. .RE \fBOR'ed\fR with either none or one of: .sp .ne 2 -.mk .na \fB\fBWERRNORM\fR\fR .ad .RS 18n -.rt Persistent write errors, the default. .RE .sp .ne 2 -.mk .na \fB\fBWERRNONPERSIST\fR\fR .ad .RS 18n -.rt Non-persistent write errors. .sp When no value is specified e.g. for the read side error behavior then the @@ -1640,12 +1416,10 @@ behavior for that side will be left unchanged. On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIarg\fR is not one of the above legal values. .RE @@ -1653,23 +1427,19 @@ On failure, \fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBI_GERROPT\fR\fR .ad .RS 15n -.rt Returns the current error mode setting in an \fBint\fR pointed to by the argument \fIarg\fR. Error modes are described above for \fBI_SERROPT\fR. On failure,\fBerrno\fR is set to the following value: .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt \fIarg\fR points outside the allocated address space. .RE @@ -1681,12 +1451,10 @@ The following four commands are used for connecting and disconnecting multiplexed STREAMS configurations. .sp .ne 2 -.mk .na \fB\fBI_LINK\fR\fR .ad .RS 13n -.rt Connects two streams, where \fIfildes\fR is the file descriptor of the stream connected to the multiplexing driver, and \fIarg\fR is the file descriptor of the stream connected to another driver. The stream designated by \fIarg\fR gets @@ -1697,90 +1465,74 @@ used to disconnect the multiplexor, see \fBI_UNLINK\fR) on success, and -1 on failure. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 10n -.rt Hangup received on \fIfildes\fR. .RE .sp .ne 2 -.mk .na \fB\fBETIME\fR\fR .ad .RS 10n -.rt Time out before acknowledgement message was received at stream head. .RE .sp .ne 2 -.mk .na \fB\fBEAGAIN\fR\fR .ad .RS 10n -.rt Temporarily unable to allocate storage to perform the \fBI_LINK.\fR .RE .sp .ne 2 -.mk .na \fB\fBENOSR\fR\fR .ad .RS 10n -.rt Unable to allocate storage to perform the \fBI_LINK\fR due to insufficient \fBSTREAMS\fR memory resources. .RE .sp .ne 2 -.mk .na \fB\fBEBADF\fR\fR .ad .RS 10n -.rt \fIarg\fR is not a valid, open file descriptor. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIfildes\fR stream does not support multiplexing. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIarg\fR is not a stream, or is already linked under a multiplexor. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt The specified link operation would cause a ``cycle'' in the resulting configuration; that is, a driver would be linked into the multiplexing configuration in more than one place. @@ -1788,23 +1540,19 @@ configuration in more than one place. .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIfildes\fR is the file descriptor of a pipe or FIFO. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt Either the upper or lower stream has a major number >= the maximum major number on the system. .RE @@ -1818,12 +1566,10 @@ returned in the positive or negative acknowledgement message. For these cases, .sp .ne 2 -.mk .na \fB\fBI_UNLINK\fR\fR .ad .RS 13n -.rt Disconnects the two streams specified by \fIfildes\fR and \fIarg\fR. \fIfildes\fR is the file descriptor of the stream connected to the multiplexing driver. \fIarg\fR is the multiplexor ID number that was returned by the @@ -1833,58 +1579,48 @@ multiplexing driver to acknowledge the unlink. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 10n -.rt Hangup received on \fIfildes\fR. .RE .sp .ne 2 -.mk .na \fB\fBETIME\fR\fR .ad .RS 10n -.rt Time out before acknowledgement message was received at stream head. .RE .sp .ne 2 -.mk .na \fB\fBENOSR\fR\fR .ad .RS 10n -.rt Unable to allocate storage to perform the \fBI_UNLINK\fR due to insufficient STREAMS memory resources. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIarg\fR is an invalid multiplexor ID number or \fIfildes\fR is not the stream on which the \fBI_LINK\fR that returned \fIarg\fR was performed. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIfildes\fR is the file descriptor of a pipe or FIFO. .RE @@ -1897,12 +1633,10 @@ returned in the positive or negative acknowledgement message. For these cases, .sp .ne 2 -.mk .na \fB\fBI_PLINK\fR\fR .ad .RS 13n -.rt Connects two streams, where \fIfildes\fR is the file descriptor of the stream connected to the multiplexing driver, and \fIarg\fR is the file descriptor of the stream connected to another driver. The stream designated by \fIarg\fR gets @@ -1916,78 +1650,64 @@ disconnect the multiplexor, see \fBI_PUNLINK\fR) on success, and -1 on failure. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 10n -.rt Hangup received on \fIfildes\fR. .RE .sp .ne 2 -.mk .na \fB\fBETIME\fR\fR .ad .RS 10n -.rt Time out before acknowledgement message was received at the stream head. .RE .sp .ne 2 -.mk .na \fB\fBEAGAIN\fR\fR .ad .RS 10n -.rt Unable to allocate STREAMS storage to perform the \fBI_PLINK.\fR .RE .sp .ne 2 -.mk .na \fB\fBEBADF\fR\fR .ad .RS 10n -.rt \fIarg\fR is not a valid, open file descriptor. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIfildes\fR does not support multiplexing. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIarg\fR is not a stream or is already linked under a multiplexor. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt The specified link operation would cause a ``cycle'' in the resulting configuration; that is, if a driver would be linked into the multiplexing configuration in more than one place. @@ -1995,12 +1715,10 @@ configuration in more than one place. .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIfildes\fR is the file descriptor of a pipe or FIFO. .RE @@ -2013,12 +1731,10 @@ returned in the positive or negative acknowledgement message. For these cases, .sp .ne 2 -.mk .na \fB\fBI_PUNLINK\fR\fR .ad .RS 13n -.rt Disconnects the two streams specified by \fIfildes\fR and \fIarg\fR that are connected with a persistent link. \fIfildes\fR is the file descriptor of the stream connected to the multiplexing driver. \fIarg\fR is the multiplexor ID @@ -2029,56 +1745,46 @@ command requires the multiplexing driver to acknowledge the unlink. On failure, \fBerrno\fR is set to one of the following values: .sp .ne 2 -.mk .na \fB\fBENXIO\fR\fR .ad .RS 10n -.rt Hangup received on \fIfildes\fR. .RE .sp .ne 2 -.mk .na \fB\fBETIME\fR\fR .ad .RS 10n -.rt Time out before acknowledgement message was received at the stream head. .RE .sp .ne 2 -.mk .na \fB\fBEAGAIN\fR\fR .ad .RS 10n -.rt Unable to allocate buffers for the acknowledgement message. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt Invalid multiplexor ID number. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt \fIfildes\fR is the file descriptor of a pipe or FIFO. .RE diff --git a/usr/src/man/man7i/termio.7i b/usr/src/man/man7i/termio.7i index 111ae5326b..8921aa67c0 100644 --- a/usr/src/man/man7i/termio.7i +++ b/usr/src/man/man7i/termio.7i @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH termio 7I "14 Sep 2005" "SunOS 5.11" "Ioctl Requests" +.TH TERMIO 7I "Sep 14, 2005" .SH NAME termio \- general terminal interface .SH SYNOPSIS @@ -158,12 +158,10 @@ bursty and short-term data transmissions. The four possible values for \fBMIN\fR and \fBTIME\fR and their interactions are described below. .sp .ne 2 -.mk .na \fBCase A: MIN > 0, TIME > 0\fR .ad .RS 29n -.rt In this case, \fBTIME\fR serves as an intercharacter timer and is activated after the first character is received. Since it is an intercharacter timer, it is reset after a character is received. The interaction between \fBMIN\fR and @@ -183,12 +181,10 @@ immediately. .sp .ne 2 -.mk .na \fBCase B: MIN > 0, TIME = 0\fR .ad .RS 29n -.rt In this case, since the value of \fBTIME\fR is zero, the timer plays no role and only \fBMIN\fR is significant. A pending read is not satisfied until \fBMIN\fR characters are received (the pending read sleeps until \fBMIN\fR @@ -198,12 +194,10 @@ terminal \fBI/O\fR may block indefinitely in the read operation. .sp .ne 2 -.mk .na \fBCase C: MIN = 0, TIME > 0\fR .ad .RS 29n -.rt In this case, since \fBMIN\fR = 0, \fBTIME\fR no longer represents an intercharacter timer: it now serves as a read timer that is activated as soon as a \fBread\fR is done. A read is satisfied as soon as a single character is @@ -217,12 +211,10 @@ returns with zero characters. .sp .ne 2 -.mk .na \fBCase D: MIN = 0, TIME = 0\fR .ad .RS 29n -.rt In this case, return is immediate. The minimum of either the number of characters requested or the number of characters currently available is returned without waiting for more characters to be input. @@ -285,12 +277,10 @@ Certain characters have special functions on input. These functions and their default character values are summarized as follows: .sp .ne 2 -.mk .na \fB\fBINTR\fR\fR .ad .RS 11n -.rt (Control-c or \fBASCII ETX\fR) generates a \fBSIGINT\fR signal. \fBSIGINT\fR is sent to all foreground processes associated with the controlling terminal. Normally, each such process is forced to terminate, but arrangements may be @@ -300,12 +290,10 @@ location. (See \fBsignal.h\fR(3HEAD)). .sp .ne 2 -.mk .na \fB\fBQUIT\fR\fR .ad .RS 11n -.rt (Control-| or \fBASCII FS\fR) generates a \fBSIGQUIT\fR signal. Its treatment is identical to the interrupt signal except that, unless a receiving process has made other arrangements, it will not only be terminated but a core image @@ -314,12 +302,10 @@ file (called \fBcore\fR) will be created in the current working directory. .sp .ne 2 -.mk .na \fB\fBERASE\fR\fR .ad .RS 11n -.rt (DEL) erases the preceding character. It does not erase beyond the start of a line, as delimited by a \fBNL\fR, \fBEOF\fR, \fBEOL\fR, or \fBEOL2\fR character. @@ -327,12 +313,10 @@ character. .sp .ne 2 -.mk .na \fB\fBWERASE\fR\fR .ad .RS 11n -.rt (Control-w or \fBASCII ETX\fR) erases the preceding "word". It does not erase beyond the start of a line, as delimited by a \fBNL\fR, \fBEOF\fR, \fBEOL\fR, or \fBEOL2\fR character. @@ -340,36 +324,30 @@ or \fBEOL2\fR character. .sp .ne 2 -.mk .na \fB\fBKILL\fR\fR .ad .RS 11n -.rt (Control-u or \fBASCII NAK\fR) deletes the entire line, as delimited by a \fBNL\fR, \fBEOF\fR, \fBEOL\fR, or \fBEOL2\fR character. .RE .sp .ne 2 -.mk .na \fB\fBREPRINT\fR\fR .ad .RS 11n -.rt (Control-r or \fBASCII DC2\fR) reprints all characters, preceded by a newline, that have not been read. .RE .sp .ne 2 -.mk .na \fB\fBEOF\fR\fR .ad .RS 11n -.rt (Control-d or \fBASCII EOT\fR) may be used to generate an end-of-file from a terminal. When received, all the characters waiting to be read are immediately passed to the program, without waiting for a newline, and the \fBEOF\fR is @@ -382,46 +360,38 @@ terminals that respond to \fBEOT\fR from hanging up. .sp .ne 2 -.mk .na \fB\fBNL\fR\fR .ad .RS 11n -.rt (ASCII LF) is the normal line delimiter. It cannot be changed or escaped. .RE .sp .ne 2 -.mk .na \fB\fBEOL\fR\fR .ad .RS 11n -.rt (ASCII NULL) is an additional line delimiter, like \fBNL\fR . It is not normally used. .RE .sp .ne 2 -.mk .na \fB\fBEOL2\fR\fR .ad .RS 11n -.rt is another additional line delimiter. .RE .sp .ne 2 -.mk .na \fB\fBSWTCH\fR\fR .ad .RS 11n -.rt (Control-z or \fBASCII EM\fR) Header file symbols related to this special character are present for compatibility purposes only and the kernel takes no special action on matching SWTCH (except to discard the character). @@ -429,24 +399,20 @@ special action on matching SWTCH (except to discard the character). .sp .ne 2 -.mk .na \fB\fBSUSP\fR\fR .ad .RS 11n -.rt (Control-z or \fBASCII SUB\fR) generates a \fBSIGTSTP\fR signal. \fBSIGTSTP\fR stops all processes in the foreground process group for that terminal. .RE .sp .ne 2 -.mk .na \fB\fBDSUSP\fR\fR .ad .RS 11n -.rt (Control-y or \fBASCII EM\fR). It generates a \fBSIGTSTP\fR signal as \fBSUSP\fR does, but the signal is sent when a process in the foreground process group attempts to read the \fBDSUSP\fR character, rather than when it @@ -455,12 +421,10 @@ is typed. .sp .ne 2 -.mk .na \fB\fBSTOP\fR\fR .ad .RS 11n -.rt (Control-s or \fBASCII DC3\fR) can be used to suspend output temporarily. It is useful with \fBCRT\fR terminals to prevent output from disappearing before it can be read. While output is suspended, \fBSTOP\fR characters are ignored and @@ -469,12 +433,10 @@ not read. .sp .ne 2 -.mk .na \fB\fBSTART\fR\fR .ad .RS 11n -.rt (Control-q or \fBASCII DC1\fR) is used to resume output. Output has been suspended by a \fBSTOP\fR character. While output is not suspended, \fBSTART\fR characters are ignored and not read. @@ -482,12 +444,10 @@ suspended by a \fBSTOP\fR character. While output is not suspended, .sp .ne 2 -.mk .na \fB\fBDISCARD\fR\fR .ad .RS 11n -.rt (Control-o or \fBASCII SI\fR) causes subsequent output to be discarded. Output is discarded until another \fBDISCARD\fR character is typed, more input arrives, or the condition is cleared by a program. @@ -495,12 +455,10 @@ arrives, or the condition is cleared by a program. .sp .ne 2 -.mk .na \fB\fBLNEXT\fR\fR .ad .RS 11n -.rt (Control-v or \fBASCII SYN\fR) causes the special meaning of the next character to be ignored. This works for all the special characters mentioned above. It allows characters to be input that would otherwise be interpreted by the system @@ -570,45 +528,44 @@ typical default values for each function are as follows: .sp .TS -tab() box; -cw(1.83i) |cw(1.83i) |cw(1.83i) -lw(1.83i) |lw(1.83i) |lw(1.83i) -. -Relative PositionSubscript NameTypical Default Value +box; +c | c | c +l | l | l . +Relative Position Subscript Name Typical Default Value _ -0VINTRETX +0 VINTR ETX _ -1 VQUITFS +1 VQUIT FS _ -2VERASEDEL +2 VERASE DEL _ -3VKILLNAK +3 VKILL NAK _ -4VEOFEOT +4 VEOF EOT _ -5VEOLNUL +5 VEOL NUL _ -6VEOL2NUL +6 VEOL2 NUL _ -7VWSTCHNUL +7 VWSTCH NUL _ -8VSTARTNUL +8 VSTART NUL _ -9VSTOPDC3 +9 VSTOP DC3 _ -10VSUSPSUB +10 VSUSP SUB _ -11VDSUSPEM +11 VDSUSP EM _ -12VREPRINTDC2 +12 VREPRINT DC2 _ -13VDISCARDSI +13 VDISCARD SI _ -14VWERASEETB +14 VWERASE ETB _ -15VLNEXTSYN +15 VLNEXT SYN _ -16-19Reserved +16-19 Reserved .TE .SS "Input Modes" @@ -617,155 +574,127 @@ _ The \fBc_iflag\fR field describes the basic terminal input control: .sp .ne 2 -.mk .na \fB\fBIGNBRK\fR\fR .ad .RS 11n -.rt Ignore break condition. .RE .sp .ne 2 -.mk .na \fB\fBBRKINT\fR\fR .ad .RS 11n -.rt Signal interrupt on break. .RE .sp .ne 2 -.mk .na \fB\fBIGNPAR\fR\fR .ad .RS 11n -.rt Ignore characters with parity errors. .RE .sp .ne 2 -.mk .na \fB\fBPARMRK\fR\fR .ad .RS 11n -.rt Mark parity errors. .RE .sp .ne 2 -.mk .na \fB\fBINPCK\fR\fR .ad .RS 11n -.rt Enable input parity check. .RE .sp .ne 2 -.mk .na \fB\fBISTRIP\fR\fR .ad .RS 11n -.rt Strip character. .RE .sp .ne 2 -.mk .na \fB\fBINLCR\fR\fR .ad .RS 11n -.rt Map NL to CR on input. .RE .sp .ne 2 -.mk .na \fB\fBIGNCR\fR\fR .ad .RS 11n -.rt Ignore CR. .RE .sp .ne 2 -.mk .na \fB\fBICRNL\fR\fR .ad .RS 11n -.rt Map CR to NL on input. .RE .sp .ne 2 -.mk .na \fB\fBIUCLC\fR\fR .ad .RS 11n -.rt Map upper-case to lower-case on input. .RE .sp .ne 2 -.mk .na \fB\fBIXON\fR\fR .ad .RS 11n -.rt Enable start/stop output control. .RE .sp .ne 2 -.mk .na \fB\fBIXANY\fR\fR .ad .RS 11n -.rt Enable any character to restart output. .RE .sp .ne 2 -.mk .na \fB\fBIXOFF\fR\fR .ad .RS 11n -.rt Enable start/stop input control. .RE .sp .ne 2 -.mk .na \fB\fBIMAXBEL\fR\fR .ad .RS 11n -.rt Echo \fBBEL\fR on input line too long. .RE @@ -846,100 +775,82 @@ the input stream overflows. The \fBc_oflag\fR field specifies the system treatment of output: .sp .ne 2 -.mk .na \fB\fBOPOST\fR\fR .ad .RS 10n -.rt Post-process output. .RE .sp .ne 2 -.mk .na \fB\fBOLCUC\fR\fR .ad .RS 10n -.rt Map lower case to upper on output. .RE .sp .ne 2 -.mk .na \fB\fBONLCR\fR\fR .ad .RS 10n -.rt Map NL to CR-NL on output. .RE .sp .ne 2 -.mk .na \fB\fBOCRNL\fR\fR .ad .RS 10n -.rt Map CR to NL on output. .RE .sp .ne 2 -.mk .na \fB\fBONOCR\fR\fR .ad .RS 10n -.rt No \fBCR\fR output at column 0. .RE .sp .ne 2 -.mk .na \fB\fBONLRET\fR\fR .ad .RS 10n -.rt \fBNL\fR performs \fBCR\fR function. .RE .sp .ne 2 -.mk .na \fB\fBOFILL\fR\fR .ad .RS 10n -.rt Use fill characters for delay. .RE .sp .ne 2 -.mk .na \fB\fBOFDEL\fR\fR .ad .RS 10n -.rt Fill is \fBDEL\fR, else \fINULL\fR. .RE .sp .ne 2 -.mk .na \fB\fBNLDLY\fR\fR .ad .RS 10n -.rt Select newline delays: .br .in +2 @@ -953,12 +864,10 @@ Select newline delays: .sp .ne 2 -.mk .na \fB\fBCRDLY\fR\fR .ad .RS 10n -.rt Select carriage-return delays: .br .in +2 @@ -980,65 +889,53 @@ Select carriage-return delays: .sp .ne 2 -.mk .na \fB\fBTABDLY\fR\fR .ad .RS 10n -.rt Select horizontal tab delays or tab expansion: .sp .ne 2 -.mk .na \fB\fBTAB0\fR\fR .ad .RS 9n -.rt - + .RE .sp .ne 2 -.mk .na \fB\fBTAB1\fR\fR .ad .RS 9n -.rt - + .RE .sp .ne 2 -.mk .na \fB\fBTAB2\fR\fR .ad .RS 9n -.rt - + .RE .sp .ne 2 -.mk .na \fB\fBTAB3\fR\fR .ad .RS 9n -.rt Expand tabs to spaces .RE .sp .ne 2 -.mk .na \fB\fBXTABS\fR\fR .ad .RS 9n -.rt Expand tabs to spaces .RE @@ -1046,12 +943,10 @@ Expand tabs to spaces .sp .ne 2 -.mk .na \fB\fBBSDLY\fR\fR .ad .RS 10n -.rt Select backspace delays: .br .in +2 @@ -1065,12 +960,10 @@ Select backspace delays: .sp .ne 2 -.mk .na \fB\fBVTDLY\fR\fR .ad .RS 10n -.rt Select vertical tab delays: .br .in +2 @@ -1084,12 +977,10 @@ Select vertical tab delays: .sp .ne 2 -.mk .na \fB\fBFFDLY\fR\fR .ad .RS 10n -.rt Select form feed delays: .br .in +2 @@ -1163,474 +1054,388 @@ The actual delays depend on line speed and system load. The \fBc_cflag\fR field describes the hardware control of the terminal: .sp .ne 2 -.mk .na \fB\fBCBAUD\fR\fR .ad .RS 13n -.rt Baud rate: .RE .sp .ne 2 -.mk .na \fB\fBB0\fR\fR .ad .RS 13n -.rt Hang up .RE .sp .ne 2 -.mk .na \fB\fBB50\fR\fR .ad .RS 13n -.rt 50 baud .RE .sp .ne 2 -.mk .na \fB\fBB75\fR\fR .ad .RS 13n -.rt 75 baud .RE .sp .ne 2 -.mk .na \fB\fBB110\fR\fR .ad .RS 13n -.rt 110 baud .RE .sp .ne 2 -.mk .na \fB\fBB134\fR\fR .ad .RS 13n -.rt 134 baud .RE .sp .ne 2 -.mk .na \fB\fBB150\fR\fR .ad .RS 13n -.rt 150 baud .RE .sp .ne 2 -.mk .na \fB\fBB200\fR\fR .ad .RS 13n -.rt 200 baud .RE .sp .ne 2 -.mk .na \fB\fBB300\fR\fR .ad .RS 13n -.rt 300 baud .RE .sp .ne 2 -.mk .na \fB\fBB600\fR\fR .ad .RS 13n -.rt 600 baud .RE .sp .ne 2 -.mk .na \fB\fBB1200\fR\fR .ad .RS 13n -.rt 1200 baud .RE .sp .ne 2 -.mk .na \fB\fBB1800\fR\fR .ad .RS 13n -.rt 1800 baud .RE .sp .ne 2 -.mk .na \fB\fBB2400\fR\fR .ad .RS 13n -.rt 2400 baud .RE .sp .ne 2 -.mk .na \fB\fBB4800\fR\fR .ad .RS 13n -.rt 4800 baud .RE .sp .ne 2 -.mk .na \fB\fBB9600\fR\fR .ad .RS 13n -.rt 9600 baud .RE .sp .ne 2 -.mk .na \fB\fBB19200\fR\fR .ad .RS 13n -.rt 19200 baud .RE .sp .ne 2 -.mk .na \fB\fBEXTA\fR\fR .ad .RS 13n -.rt External A .RE .sp .ne 2 -.mk .na \fB\fBB38400\fR\fR .ad .RS 13n -.rt 38400 baud .RE .sp .ne 2 -.mk .na \fB\fBEXTB\fR\fR .ad .RS 13n -.rt External B .RE .sp .ne 2 -.mk .na \fB\fBB57600\fR\fR .ad .RS 13n -.rt 57600 baud .RE .sp .ne 2 -.mk .na \fB\fBB76800\fR\fR .ad .RS 13n -.rt 76800 baud .RE .sp .ne 2 -.mk .na \fB\fBB115200\fR\fR .ad .RS 13n -.rt 115200 baud .RE .sp .ne 2 -.mk .na \fB\fBB153600\fR\fR .ad .RS 13n -.rt 153600 baud .RE .sp .ne 2 -.mk .na \fB\fBB230400\fR\fR .ad .RS 13n -.rt 230400 baud .RE .sp .ne 2 -.mk .na \fB\fBB307200\fR\fR .ad .RS 13n -.rt 307200 baud .RE .sp .ne 2 -.mk .na \fB\fBB460800\fR\fR .ad .RS 13n -.rt 460800 baud .RE .sp .ne 2 -.mk .na \fB\fBCSIZE\fR\fR .ad .RS 13n -.rt Character size: .RE .sp .ne 2 -.mk .na \fB\fBCS5\fR\fR .ad .RS 13n -.rt 5 bits .RE .sp .ne 2 -.mk .na \fB\fBCS6\fR\fR .ad .RS 13n -.rt 6 bits .RE .sp .ne 2 -.mk .na \fB\fBCS7\fR\fR .ad .RS 13n -.rt 7 bits .RE .sp .ne 2 -.mk .na \fB\fBCS8\fR\fR .ad .RS 13n -.rt 8 bits .RE .sp .ne 2 -.mk .na \fB\fBCSTOPB\fR\fR .ad .RS 13n -.rt Send two stop bits, else one .RE .sp .ne 2 -.mk .na \fB\fBCREAD\fR\fR .ad .RS 13n -.rt Enable receiver .RE .sp .ne 2 -.mk .na \fB\fBPARENB\fR\fR .ad .RS 13n -.rt Parity enable .RE .sp .ne 2 -.mk .na \fB\fBPARODD\fR\fR .ad .RS 13n -.rt Odd parity, else even .RE .sp .ne 2 -.mk .na \fB\fBHUPCL\fR\fR .ad .RS 13n -.rt Hang up on last close .RE .sp .ne 2 -.mk .na \fB\fBCLOCAL\fR\fR .ad .RS 13n -.rt Local line, else dial-up .RE .sp .ne 2 -.mk .na \fB\fBCIBAUD\fR\fR .ad .RS 13n -.rt Input baud rate, if different from output rate .RE .sp .ne 2 -.mk .na \fB\fBPAREXT\fR\fR .ad .RS 13n -.rt Extended parity for mark and space parity .RE .sp .ne 2 -.mk .na \fB\fBCRTSXOFF\fR\fR .ad .RS 13n -.rt Enable inbound hardware flow control .RE .sp .ne 2 -.mk .na \fB\fBCRTSCTS\fR\fR .ad .RS 13n -.rt Enable outbound hardware flow control .RE .sp .ne 2 -.mk .na \fB\fBCBAUDEXT\fR\fR .ad .RS 13n -.rt Bit to indicate output speed > B38400 .RE .sp .ne 2 -.mk .na \fB\fBCIBAUDEXT\fR\fR .ad .RS 13n -.rt Bit to indicate input speed > B38400 .RE @@ -1755,24 +1560,20 @@ The four possible combinations for the state of \fBCRTSCTS\fR and \fBCRTSXOFF\fR bits and their interactions are described below. .sp .ne 2 -.mk .na \fBCase A:\fR .ad .RS 11n -.rt \fBCRTSCTS\fR off, \fBCRTSXOFF\fR off. In this case the hardware flow control is disabled. .RE .sp .ne 2 -.mk .na \fBCase B:\fR .ad .RS 11n -.rt \fBCRTSCTS\fR on, \fBCRTSXOFF\fR off. In this case only outbound hardware flow control is enabled. The state of CTS signal is used to do outbound flow control. It is expected that output will be suspended if CTS is low and resumed @@ -1781,12 +1582,10 @@ when CTS is high. .sp .ne 2 -.mk .na \fBCase C:\fR .ad .RS 11n -.rt \fBCRTSCTS\fR off, \fBCRTSXOFF\fR on. In this case only inbound hardware flow control is enabled. The state of RTS signal is used to do inbound flow control. It is expected that input will be suspended if RTS is low and resumed when RTS @@ -1795,12 +1594,10 @@ is high. .sp .ne 2 -.mk .na \fBCase D:\fR .ad .RS 11n -.rt \fBCRTSCTS\fR on, \fBCRTSXOFF\fR on. In this case both inbound and outbound hardware flow control are enabled. Uses the state of CTS signal to do outbound flow control and RTS signal to do inbound flow control. @@ -1814,166 +1611,136 @@ discipline to control terminal functions. The basic line discipline provides the following: .sp .ne 2 -.mk .na \fB\fBISIG\fR\fR .ad .RS 11n -.rt Enable signals. .RE .sp .ne 2 -.mk .na \fB\fBICANON\fR\fR .ad .RS 11n -.rt Canonical input (erase and kill processing). .RE .sp .ne 2 -.mk .na \fB\fBXCASE\fR\fR .ad .RS 11n -.rt Canonical upper/lower presentation. .RE .sp .ne 2 -.mk .na \fB\fBECHO\fR\fR .ad .RS 11n -.rt Enable echo. .RE .sp .ne 2 -.mk .na \fB\fBECHOE\fR\fR .ad .RS 11n -.rt Echo erase character as \fBBS-SP-BS\fR &. .RE .sp .ne 2 -.mk .na \fB\fBECHOK\fR\fR .ad .RS 11n -.rt Echo \fBNL\fR after kill character. .RE .sp .ne 2 -.mk .na \fB\fBECHONL\fR\fR .ad .RS 11n -.rt Echo \fBNL\fR . .RE .sp .ne 2 -.mk .na \fB\fBNOFLSH\fR\fR .ad .RS 11n -.rt Disable flush after interrupt or quit. .RE .sp .ne 2 -.mk .na \fB\fBTOSTOP\fR\fR .ad .RS 11n -.rt Send \fBSIGTTOU\fR for background output. .RE .sp .ne 2 -.mk .na \fB\fBECHOCTL\fR\fR .ad .RS 11n -.rt Echo control characters as \fIchar,\fR delete as ^?. .RE .sp .ne 2 -.mk .na \fB\fBECHOPRT\fR\fR .ad .RS 11n -.rt Echo erase character as character erased. .RE .sp .ne 2 -.mk .na \fB\fBECHOKE\fR\fR .ad .RS 11n -.rt \fBBS-SP-BS\fR erase entire line on line kill. .RE .sp .ne 2 -.mk .na \fB\fBFLUSHO\fR\fR .ad .RS 11n -.rt Output is being flushed. .RE .sp .ne 2 -.mk .na \fB\fBPENDIN\fR\fR .ad .RS 11n -.rt Retype pending input at next read or input character. .RE .sp .ne 2 -.mk .na \fB\fBIEXTEN\fR\fR .ad .RS 11n -.rt Enable extended (implementation-defined) functions. .RE @@ -2006,23 +1773,22 @@ following escape sequences are generated on output and accepted on input: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -FOR:USE: +box; +c | c +l | l . +FOR: USE: _ -`\e' +` \e' _ -|\e! +| \e! _ -\(ap\e^ +\(ap \e^ _ -{\e( +{ \e( _ -}\e) +} \e) _ -\e\e\e +\e \e\e .TE .sp @@ -2167,27 +1933,26 @@ default values for each function are as follows: .sp .TS -tab() box; -cw(1.83i) |cw(1.83i) |cw(1.83i) -lw(1.83i) |lw(1.83i) |lw(1.83i) -. -Relative PositionsSubscript NamesTypical Default Values +box; +c | c | c +l | l | l . +Relative Positions Subscript Names Typical Default Values _ -0VINTREXT +0 VINTR EXT _ -1VQUITFS +1 VQUIT FS _ -2VERASEDEL +2 VERASE DEL _ -3VKILLNAK +3 VKILL NAK _ -4VEOFEOT +4 VEOF EOT _ -5VEOLNUL +5 VEOL NUL _ -6VEOL2NUL +6 VEOL2 NUL _ -7Reserved +7 Reserved .TE .sp @@ -2211,100 +1976,82 @@ Status lines are read-only. The following modem control and status lines may be supported by a device; they are defined by \fBsys/termios.h\fR: .sp .ne 2 -.mk .na \fB\fBTIOCM_LE\fR\fR .ad .RS 13n -.rt line enable .RE .sp .ne 2 -.mk .na \fB\fBTIOCM_DTR\fR\fR .ad .RS 13n -.rt data terminal ready .RE .sp .ne 2 -.mk .na \fB\fBTIOCM_RTS\fR\fR .ad .RS 13n -.rt request to send .RE .sp .ne 2 -.mk .na \fB\fBTIOCM_ST\fR\fR .ad .RS 13n -.rt secondary transmit .RE .sp .ne 2 -.mk .na \fB\fBTIOCM_SR\fR\fR .ad .RS 13n -.rt secondary receive .RE .sp .ne 2 -.mk .na \fB\fBTIOCM_CTS\fR\fR .ad .RS 13n -.rt clear to send .RE .sp .ne 2 -.mk .na \fB\fBTIOCM_CAR\fR\fR .ad .RS 13n -.rt carrier detect .RE .sp .ne 2 -.mk .na \fB\fBTIOCM_RNG\fR\fR .ad .RS 13n -.rt ring .RE .sp .ne 2 -.mk .na \fB\fBTIOCM_DSR\fR\fR .ad .RS 13n -.rt data set ready .RE @@ -2358,24 +2105,20 @@ available through the preferred function call interface specified on \fBtermios\fR. .sp .ne 2 -.mk .na \fB\fBTCGETS\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBtermios\fR structure. The current terminal parameters are fetched and stored into that structure. .RE .sp .ne 2 -.mk .na \fB\fBTCSETS\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBtermios\fR structure. The current terminal parameters are set from the values stored in that structure. The change is immediate. @@ -2383,12 +2126,10 @@ immediate. .sp .ne 2 -.mk .na \fB\fBTCSETSW\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBtermios\fR structure. The current terminal parameters are set from the values stored in that structure. The change occurs after all characters queued for output have been transmitted. This form should @@ -2397,12 +2138,10 @@ be used when changing parameters that affect output. .sp .ne 2 -.mk .na \fB\fBTCSETSF\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBtermios\fR structure. The current terminal parameters are set from the values stored in that structure. The change occurs after all characters queued for output have been transmitted; all characters @@ -2411,12 +2150,10 @@ queued for input are discarded and then the change occurs. .sp .ne 2 -.mk .na \fB\fBTCGETA\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBtermio\fR structure. The current terminal parameters are fetched, and those parameters that can be stored in a \fBtermio\fR structure are stored into that structure. @@ -2424,12 +2161,10 @@ parameters are fetched, and those parameters that can be stored in a .sp .ne 2 -.mk .na \fB\fBTCSETA\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBtermio\fR structure. Those terminal parameters that can be stored in a \fBtermio\fR structure are set from the values stored in that structure. The change is immediate. @@ -2437,12 +2172,10 @@ values stored in that structure. The change is immediate. .sp .ne 2 -.mk .na \fB\fBTCSETAW\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBtermio\fR structure. Those terminal parameters that can be stored in a \fBtermio\fR structure are set from the values stored in that structure. The change occurs after all characters queued @@ -2452,12 +2185,10 @@ parameters that affect output. .sp .ne 2 -.mk .na \fB\fBTCSETAF\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBtermio\fR structure. Those terminal parameters that can be stored in a \fBtermio\fR structure are set from the values stored in that structure. The change occurs after all characters queued @@ -2467,24 +2198,20 @@ and then the change occurs. .sp .ne 2 -.mk .na \fB\fBTCSBRK\fR\fR .ad .RS 16n -.rt The argument is an \fBint\fR value. Wait for the output to drain. If the argument is \fB0\fR, then send a break (zero valued bits for 0.25 seconds). .RE .sp .ne 2 -.mk .na \fB\fBTCXONC\fR\fR .ad .RS 16n -.rt Start/stop control. The argument is an \fBint\fR value. If the argument is \fB0\fR, suspend output; if \fB1\fR, restart suspended output; if \fB2\fR, suspend input; if \fB3\fR, restart suspended input. @@ -2492,12 +2219,10 @@ suspend input; if \fB3\fR, restart suspended input. .sp .ne 2 -.mk .na \fB\fBTCFLSH\fR\fR .ad .RS 16n -.rt The argument is an \fBint\fR value. If the argument is \fB0\fR, flush the input queue; if \fB1\fR, flush the output queue; if \fB2\fR, flush both the input and output queues. @@ -2505,12 +2230,10 @@ output queues. .sp .ne 2 -.mk .na \fB\fBTIOCGPGRP\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBpid_t\fR. Set the value of that \fBpid_t\fR to the process group \fBID\fR of the foreground process group associated with the terminal. See \fBtermios\fR(3C) for a description of \fBTCGETPGRP\fR. @@ -2518,12 +2241,10 @@ the terminal. See \fBtermios\fR(3C) for a description of \fBTCGETPGRP\fR. .sp .ne 2 -.mk .na \fB\fBTIOCSPGRP\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBpid_t\fR. Associate the process group whose process group \fBID\fR is specified by the value of that \fBpid_t\fR with the terminal. The new process group value must be in the range of valid process @@ -2532,36 +2253,30 @@ group \fBID\fR values. Otherwise, the error \fBEPERM\fR is returned. .sp .ne 2 -.mk .na \fB\fBTIOCGSID\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBpid_t\fR. The session ID of the terminal is fetched and stored in the \fBpid_t\fR. .RE .sp .ne 2 -.mk .na \fB\fBTIOCGWINSZ\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBwinsize\fR structure. The terminal driver's notion of the terminal size is stored into that structure. .RE .sp .ne 2 -.mk .na \fB\fBTIOCSWINSZ\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBwinsize\fR structure. The terminal driver's notion of the terminal size is set from the values specified in that structure. If the new sizes are different from the old sizes, a \fBSIGWINCH\fR signal is @@ -2570,12 +2285,10 @@ set to the process group of the terminal. .sp .ne 2 -.mk .na \fB\fBTIOCMBIS\fR\fR .ad .RS 16n -.rt The argument is a pointer to an \fBint\fR whose value is a mask containing modem control lines to be turned on. The control lines whose bits are set in the argument are turned on; no other control lines are affected. @@ -2583,12 +2296,10 @@ the argument are turned on; no other control lines are affected. .sp .ne 2 -.mk .na \fB\fBTIOCMBIC\fR\fR .ad .RS 16n -.rt The argument is a pointer to an \fBint\fR whose value is a mask containing modem control lines to be turned off. The control lines whose bits are set in the argument are turned off; no other control lines are affected. @@ -2596,12 +2307,10 @@ the argument are turned off; no other control lines are affected. .sp .ne 2 -.mk .na \fB\fBTIOCMGET\fR\fR .ad .RS 16n -.rt The argument is a pointer to an \fBint\fR. The current state of the modem status lines is fetched and stored in the \fBint\fR pointed to by the argument. @@ -2609,12 +2318,10 @@ argument. .sp .ne 2 -.mk .na \fB\fBTIOCMSET\fR\fR .ad .RS 16n -.rt The argument is a pointer to an \fBint\fR containing a new set of modem control lines. The modem control lines are turned on or off, depending on whether the bit for that mode is set or clear. @@ -2622,12 +2329,10 @@ whether the bit for that mode is set or clear. .sp .ne 2 -.mk .na \fB\fBTIOCSPPS\fR\fR .ad .RS 16n -.rt The argument is a pointer to an \fBint\fR that determines whether pulse-per-second event handling is to be enabled (non-zero) or disabled (zero). If a one-pulse-per-second reference clock is attached to the serial line's data @@ -2638,12 +2343,10 @@ is ignored. .sp .ne 2 -.mk .na \fB\fBTIOCGPPS\fR\fR .ad .RS 16n -.rt The argument is a pointer to an \fBint\fR, in which the state of the even handling is returned. The \fBint\fR is set to a non-zero value if pulse-per-second (PPS) handling has been enabled. Otherwise, it is set to zero. @@ -2651,24 +2354,20 @@ pulse-per-second (PPS) handling has been enabled. Otherwise, it is set to zero. .sp .ne 2 -.mk .na \fB\fBTIOCGSOFTCAR\fR\fR .ad .RS 16n -.rt The argument is a pointer to an \fBint\fR whose value is \fB1\fR or \fB0\fR, depending on whether the software carrier detect is turned on or off. .RE .sp .ne 2 -.mk .na \fB\fBTIOCSSOFTCAR\fR\fR .ad .RS 16n -.rt The argument is a pointer to an \fBint\fR whose value is \fB1\fR or \fB0\fR. The value of the integer should be \fB0\fR to turn off software carrier, or \fB1\fR to turn it on. @@ -2676,12 +2375,10 @@ The value of the integer should be \fB0\fR to turn off software carrier, or .sp .ne 2 -.mk .na \fB\fBTIOCGPPSEV\fR\fR .ad .RS 16n -.rt The argument is a pointer to a \fBstruct\fR \fBppsclockev\fR. This structure contains the following members: .sp diff --git a/usr/src/man/man7i/termiox.7i b/usr/src/man/man7i/termiox.7i index b56d3cbe48..1b22b6f20d 100644 --- a/usr/src/man/man7i/termiox.7i +++ b/usr/src/man/man7i/termiox.7i @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH termiox 7I "3 Jul 1990" "SunOS 5.11" "Ioctl Requests" +.TH TERMIOX 7I "Jul 3, 1990" .SH NAME termiox \- extended general terminal interface .SH DESCRIPTION @@ -95,23 +95,21 @@ The \fBx_hflag\fR field describes hardware flow control modes: .sp .TS -tab(); -lw(1.28i) lw(1.06i) lw(3.17i) -lw(1.28i) lw(1.06i) lw(3.17i) -. -RTSXOFF 0000001T{ +l l l +l l l . +RTSXOFF 0000001 T{ Enable RTS hardware flow control on input. T} -CTSXON 0000002T{ +CTSXON 0000002 T{ Enable CTS hardware flow control on output. T} -DTRXOFF 0000004T{ +DTRXOFF 0000004 T{ Enable DTR hardware flow control on input. T} -CDXON 0000010T{ +CDXON 0000010 T{ Enable CD hardware flow control on output. T} -ISXOFF 0000020T{ +ISXOFF 0000020 T{ Enable isochronous hardware flow control on input T} .TE @@ -187,60 +185,58 @@ The \fBx_cflag\fR field specifies the system treatment of clock modes. .sp .TS -tab(); -lw(1.5i) lw(.94i) lw(3.06i) -lw(1.5i) lw(.94i) lw(3.06i) -. -\fBXMTCLK\fR0000007Transmit clock source: -\fBXCIBRG\fR0000000 T{ +l l l +l l l . +\fBXMTCLK\fR 0000007 Transmit clock source: +\fBXCIBRG\fR 0000000 T{ Get transmit clock from internal baud rate generator. T} -\fBXCTSET\fR0000001 T{ +\fBXCTSET\fR 0000001 T{ Get transmit clock from transmitter signal element timing (DCE source) lead, CCITT V.24 circuit 114, EIA-232-D pin 15. T} -\fBXCRSET\fR0000002 T{ +\fBXCRSET\fR 0000002 T{ Get transmit clock from receiver signal element timing (DCE source) lead, CCITT V.24 circuit 115, EIA-232-D pin 17. T} -\fBRCVCLK\fR0000070 Receive clock source: -\fBRCIBRG\fR0000000 T{ +\fBRCVCLK\fR 0000070 Receive clock source: +\fBRCIBRG\fR 0000000 T{ Get receive clock from internal baud rate generator. T} -\fBRCTSET\fR0000010 T{ +\fBRCTSET\fR 0000010 T{ Get receive clock from transmitter signal element timing (DCE source) lead, CCITT V.24 circuit 114, EIA-232-D pin 15. T} -\fBRCRSET\fR0000020 T{ +\fBRCRSET\fR 0000020 T{ Get receive clock from receiver signal element timing (DCE source) lead, CCITT V.24 circuit 115, EIA-232-D pin 17. T} -\fBTSETCLK\fR0000700 T{ +\fBTSETCLK\fR 0000700 T{ Transmitter signal element timing (DTE source) lead, CCITT V.24 circuit 113, EIA-232-D pin 24, clock source: T} -\fBTSETCOFF\fR0000000 TSET clock not provided. -\fBTSETCRBRG\fR0000100 T{ +\fBTSETCOFF\fR 0000000 TSET clock not provided. +\fBTSETCRBRG\fR 0000100 T{ Output receive baud rate generator on circuit 113. T} -\fBTSETCTBRG\fR0000200 T{ +\fBTSETCTBRG\fR 0000200 T{ Output transmit baud rate generator on circuit 113 T} -\fBTSETCTSET\fR0000300 T{ +\fBTSETCTSET\fR 0000300 T{ Output transmitter signal element timing (DCE source) on circuit 113. T} -\fBTSETCRSET\fR0000400 T{ +\fBTSETCRSET\fR 0000400 T{ Output receiver signal element timing (DCE source) on circuit 113. T} -\fBRSETCLK\fR0007000 T{ +\fBRSETCLK\fR 0007000 T{ Receiver signal element timing (DTE source) lead, CCITT V.24 circuit 128, no EIA-232-D pin, clock source: T} -\fBRSETCOFF\fR0000000 RSET clock not provided. -\fBRSETCRBRG\fR0001000 T{ +\fBRSETCOFF\fR 0000000 RSET clock not provided. +\fBRSETCRBRG\fR 0001000 T{ Output receive baud rate generator on circuit 128. T} -\fBRSETCTBRG\fR0002000 T{ +\fBRSETCTBRG\fR 0002000 T{ Output transmit baud rate generator on circuit 128. T} -\fBRSETCTSET\fR0003000 T{ +\fBRSETCTSET\fR 0003000 T{ Output transmitter signal element timing (DCE source) on circuit 128. T} -\fBRSETCRSET\fR0004000 T{ +\fBRSETCRSET\fR 0004000 T{ Output receiver signal element timing (DCE) on circuit 128. T} .TE @@ -298,7 +294,7 @@ The \fBioctl\fR(2) system calls have the form: .sp .in +2 .nf -\fBioctl\fR (\fIfildes, command, arg\fR) \fBstruct termiox *\fR \fIarg\fR; +\fBioctl\fR (\fIfildes, command, arg\fR) \fBstruct termiox *\fR \fIarg\fR; .fi .in -2 @@ -307,24 +303,20 @@ The \fBioctl\fR(2) system calls have the form: The commands using this form are: .sp .ne 2 -.mk .na \fB\fBTCGETX\fR\fR .ad .RS 11n -.rt The argument is a pointer to a \fBtermiox\fR structure. The current terminal parameters are fetched and stored into that structure. .RE .sp .ne 2 -.mk .na \fB\fBTCSETX\fR\fR .ad .RS 11n -.rt The argument is a pointer to a \fBtermiox\fR structure. The current terminal parameters are set from the values stored in that structure. The change is immediate. @@ -332,12 +324,10 @@ immediate. .sp .ne 2 -.mk .na \fB\fBTCSETXW\fR\fR .ad .RS 11n -.rt The argument is a pointer to a \fBtermiox\fR structure. The current terminal parameters are set from the values stored in that structure. The change occurs after all characters queued for output have been transmitted. This form should @@ -346,12 +336,10 @@ be used when changing parameters that will affect output. .sp .ne 2 -.mk .na \fB\fBTCSETXF\fR\fR .ad .RS 11n -.rt The argument is a pointer to a \fBtermiox\fR structure. The current terminal parameters are set from the values stored in that structure. The change occurs after all characters queued for output have been transmitted; all characters diff --git a/usr/src/man/man7i/uscsi.7i b/usr/src/man/man7i/uscsi.7i index 4892c68201..3247f53cc1 100644 --- a/usr/src/man/man7i/uscsi.7i +++ b/usr/src/man/man7i/uscsi.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH uscsi 7I "29 May 2007" "SunOS 5.11" "Ioctl Requests" +.TH USCSI 7I "May 29, 2007" .SH NAME uscsi \- user SCSI command interface .SH SYNOPSIS @@ -64,127 +64,105 @@ void *uscsi_reserved_5; /* Reserved for future use */ The fields of the \fBuscsi_cmd\fR structure have the following meanings: .sp .ne 2 -.mk .na \fB\fBuscsi_flags\fR\fR .ad .RS 20n -.rt The \fBI/O\fR direction and other details of how to carry out the \fBSCSI\fR command. Possible values are described below. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_status\fR\fR .ad .RS 20n -.rt The \fBSCSI\fR status byte returned by the device is returned in this field. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_timeout\fR\fR .ad .RS 20n -.rt Time in seconds to allow for completion of the command. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_cdb\fR\fR .ad .RS 20n -.rt A pointer to the \fBSCSI\fR CDB (command descriptor block) to be transferred to the device in command phase. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_bufaddr\fR\fR .ad .RS 20n -.rt The user buffer containing the data to be read from or written to the device. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_buflen\fR\fR .ad .RS 20n -.rt The length of \fBuscsi_bufaddr\fR. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_resid\fR\fR .ad .RS 20n -.rt If a data transfer terminates without transferring the entire requested amount, the remainder, or residue, is returned in this field. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_cdblen\fR\fR .ad .RS 20n -.rt The length of the \fBSCSI\fR CDB to be transferred to the device in command phase. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_rqlen\fR\fR .ad .RS 20n -.rt The length of \fBuscsi_rqbuf\fR, the application's Request Sense buffer. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_rqstatus\fR\fR .ad .RS 20n -.rt The \fBSCSI\fR status byte returned for the Request Sense command executed automatically by the driver in response to a Check Condition status return. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_rqresid\fR\fR .ad .RS 20n -.rt The residue, or untransferred data length, of the Request Sense data transfer (the number of bytes, less than or equal to \fBuscsi_rqlen\fR, which were not filled with sense data). @@ -192,24 +170,20 @@ filled with sense data). .sp .ne 2 -.mk .na \fB\fBuscsi_rqbuf\fR\fR .ad .RS 20n -.rt Points to a buffer in application address space to which the results of an automatic Request Sense command are written. .RE .sp .ne 2 -.mk .na \fB\fBuscsi_reserved_5\fR\fR .ad .RS 20n -.rt Reserved for future use. .RE @@ -240,125 +214,103 @@ USCSI_RENEGOT /* renegotiate wide/sync on next I/O */ The \fBuscsi_flags\fR bits have the following interpretation: .sp .ne 2 -.mk .na \fB\fBUSCSI_WRITE\fR\fR .ad .RS 22n -.rt Data will be written from the initiator to the target. .RE .sp .ne 2 -.mk .na \fB\fBUSCSI_SILENT\fR\fR .ad .RS 22n -.rt The driver should not print any console error messages or warnings regarding failures associated with this \fBSCSI\fR command. .RE .sp .ne 2 -.mk .na \fB\fBUSCSI_DIAGNOSE\fR\fR .ad .RS 22n -.rt The driver should not attempt any retries or other recovery mechanisms if this \fBSCSI\fR command terminates abnormally in any way. .RE .sp .ne 2 -.mk .na \fB\fBUSCSI_ISOLATE\fR\fR .ad .RS 22n -.rt This \fBSCSI\fR command should not be executed with other commands. .RE .sp .ne 2 -.mk .na \fB\fBUSCSI_READ\fR\fR .ad .RS 22n -.rt Data will be read from the target to the initiator. .RE .sp .ne 2 -.mk .na \fB\fBUSCSI_ASYNC\fR\fR .ad .RS 22n -.rt Set the \fBSCSI\fR bus to asynchronous mode before running this command. .RE .sp .ne 2 -.mk .na \fB\fBUSCSI_SYNC\fR\fR .ad .RS 22n -.rt Set the \fBSCSI\fR bus to synchronous mode before running this command. .RE .sp .ne 2 -.mk .na \fB\fBUSCSI_RESET\fR\fR .ad .RS 22n -.rt Send a \fBSCSI\fR bus device reset message to this target. .RE .sp .ne 2 -.mk .na \fB\fBUSCSI_RESET_TARGET\fR\fR .ad .RS 22n -.rt Same as USCSI_RESET. Use this flag to request TARGET RESET. (USCSI_RESET is maintained only for compatibility with old applications). .RE .sp .ne 2 -.mk .na \fB\fBUSCSI_RESET_LUN\fR\fR .ad .RS 22n -.rt Send a \fBSCSI\fR logical unit reset message to this target. .RE .sp .ne 2 -.mk .na \fB\fBUSCSI_RESET_ALL\fR\fR .ad .RS 22n -.rt USCSI_RESET_ALL, USCSI_RESET/USCSI_RESET_TARGET and USCSI_RESET_LUN are mutually exclusive options and issuing them in any simultaneous combination will result in implementation-dependent behavior @@ -372,12 +324,10 @@ in the uscsi_cmd are ignored. The uscsi_cdblen \fBmust\fR be set to zero. .sp .ne 2 -.mk .na \fB\fBUSCSI_RQENABLE\fR\fR .ad .RS 22n -.rt Enable Request Sense extensions. If the user application is prepared to receive sense data, this bit must be set, the fields \fBuscsi_rqbuf\fR and \fBuscsi_rqbuflen\fR must be non-zero, and the \fBuscsi_rqbuf\fR must point to @@ -386,12 +336,10 @@ memory writable by the application. .sp .ne 2 -.mk .na \fB\fBUSCSI_RENEGOT\fR\fR .ad .RS 22n -.rt Tells USCSI to renegotiate wide mode and synchronous transfer speed before the transmitted SCSI command is executed. This flag in effects tells the target driver to pass the \fBFLAG_RENEGOTIATE_WIDE_SYNC\fR flag in the SCSI packet @@ -407,12 +355,10 @@ information. The \fBioctl\fR supported by drivers providing the \fBuscsi\fR interface is: .sp .ne 2 -.mk .na \fB\fBUSCSICMD\fR\fR .ad .RS 12n -.rt The argument is a pointer to a \fBuscsi_cmd\fR structure. The \fBSCSI\fR device addressed by that driver is selected, and given the \fBSCSI\fR command addressed by \fBuscsi_cdb\fR. If this command requires a data phase, the @@ -428,45 +374,37 @@ Sense data transfer. .SH ERRORS .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n -.rt A parameter has an incorrect, or unsupported, value. .RE .sp .ne 2 -.mk .na \fB\fBEIO\fR\fR .ad .RS 10n -.rt An error occurred during the execution of the command. .RE .sp .ne 2 -.mk .na \fB\fBEPERM\fR\fR .ad .RS 10n -.rt A process without root credentials tried to execute the \fBUSCSICMD\fR ioctl. .RE .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 10n -.rt The \fBuscsi_cmd\fR itself, the \fBuscsi_cdb\fR, the \fBuscsi_buf\fR, or the \fBuscsi_rqbuf\fR point to an invalid address. .RE @@ -479,13 +417,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface Stability Committed +Interface Stability Committed .TE .SH SEE ALSO diff --git a/usr/src/man/man7i/visual_io.7i b/usr/src/man/man7i/visual_io.7i index 364022ef6c..984fe948a8 100644 --- a/usr/src/man/man7i/visual_io.7i +++ b/usr/src/man/man7i/visual_io.7i @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH visual_io 7I "14 Oct 2005" "SunOS 5.11" "Ioctl Requests" +.TH VISUAL_IO 7I "Oct 14, 2005" .SH NAME visual_io \- Solaris VISUAL I/O control operations .SH SYNOPSIS .LP .nf -\fB#include <sys/visual_io.h>\fR +\fB#include <sys/visual_io.h>\fR .fi .SH DESCRIPTION @@ -43,12 +43,10 @@ restrictions, described below. .SH IOCTLS .sp .ne 2 -.mk .na \fB\fBVIS_GETIDENTIFIER\fR\fR .ad .RS 21n -.rt This \fBioctl()\fR returns an identifier string to uniquely identify a device used in the Solaris VISUAL environment. This is a mandatory ioctl and must return a unique string. We suggest that the name be formed as @@ -71,7 +69,6 @@ struct vis_identifier { .sp .ne 2 -.mk .na \fB\fBVIS_GETCURSOR\fR\fR .ad @@ -80,7 +77,6 @@ struct vis_identifier { \fB\fBVIS_SETCURSOR\fR\fR .ad .RS 21n -.rt These ioctls fetch and set various cursor attributes, using the \fBvis_cursor\fR structure. .sp @@ -130,7 +126,6 @@ The \fBvis_cursorcmap\fR structure should contain pointers to two elements, specifying the red, green, and blue values for foreground and background. .sp .ne 2 -.mk .na \fB\fBVIS_SETCURSORPOS\fR\fR .ad @@ -139,7 +134,6 @@ specifying the red, green, and blue values for foreground and background. \fB\fBVIS_MOVECURSOR\fR\fR .ad .RS 20n -.rt These ioctls fetch and move the current cursor position, using the \fBvis_cursorpos\fR structure. .RE @@ -159,7 +153,6 @@ corner of the device, with rows increasing toward the bottom of the device and columns increasing from left to right. .sp .ne 2 -.mk .na \fBVIS_PUTCMAP\fR .ad @@ -168,7 +161,6 @@ columns increasing from left to right. \fB\fBVIS_GETCMAP\fR\fR .ad .RS 15n -.rt Set or get color map entries. .RE @@ -204,12 +196,10 @@ arrays which contain the color map info to set or where the color map info is placed on a get. .sp .ne 2 -.mk .na \fB\fBVIS_DEVINIT\fR\fR .ad .RS 15n -.rt Initializes the graphics driver as a console device. .RE @@ -287,12 +277,10 @@ to the \fBmodechg_cb\fR function when the driver notifies the terminal emulator of a video mode change. .sp .ne 2 -.mk .na \fB\fBVIS_DEVFINI\fR\fR .ad .RS 18n -.rt Tells the graphics driver that it is no longer the system console device. There is no argument to this ioctl. The driver is expected to free any locally kept state information related to the console. @@ -300,12 +288,10 @@ state information related to the console. .sp .ne 2 -.mk .na \fB\fBVIS_CONSCURSOR\fR\fR .ad .RS 18n -.rt Describes the size and placement of the cursor on the screen. The graphics driver is expected to display or hide the cursor at the indicated position. .RE @@ -353,12 +339,10 @@ indexes to use when the \fBaction\fR (see below) is set to either \fBVIS_HIDE_CURSOR\fR or \fBVIS_DISPLAY_CURSOR\fR. .sp .ne 2 -.mk .na \fB\fBVIS_CONSDISPLAY\fR\fR .ad .RS 19n -.rt Display data on the graphics device. The graphics driver is expected to display the data contained in the \fBvis_display\fR structure at the specified position on the console. @@ -418,12 +402,10 @@ background color map indexes to use when displaying the data. \fBfb_color\fR is used for "on" pixels and \fBbg_color\fR is used for "off" pixels. .sp .ne 2 -.mk .na \fB\fBVIS_CONSCOPY\fR\fR .ad .RS 16n -.rt Copy data from one location on the device to another. The driver is expected to copy the specified data. The source data should not be modified. Any modifications to the source data should be as a side effect of the copy @@ -493,8 +475,8 @@ console extension is implemented. struct vis_polledio { struct vis_polledio_arg *arg; void (*display)(vis_polledio_arg *, struct vis_consdisplay *); - void (*copy)(vis_polledio_arg *, struct vis_conscopy *); - void (*cursor)(vis_polledio_arg *, struct vis_conscursor *); + void (*copy)(vis_polledio_arg *, struct vis_conscopy *); + void (*cursor)(vis_polledio_arg *, struct vis_conscursor *); }; .fi .in -2 @@ -570,12 +552,10 @@ that the driver supports the kernel terminal emulator. By exporting driver. .sp .ne 2 -.mk .na \fBtem-support\fR .ad .RS 15n -.rt This DDI property, set to 1, means driver is compatible with the console kernel framebuffer interface. .RE diff --git a/usr/src/man/man7i/vt.7i b/usr/src/man/man7i/vt.7i index 39785aa605..b824af02fb 100644 --- a/usr/src/man/man7i/vt.7i +++ b/usr/src/man/man7i/vt.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH vt 7I "22 Sep 2008" "SunOS 5.11" "Ioctl Requests" +.TH VT 7I "Sep 22, 2008" .SH NAME vt \- Solaris virtual console interface .SH SYNOPSIS @@ -27,9 +27,9 @@ support and switch between multiple screen faces on a single physical device. .LP VT's are accessed in the same way as other devices. The \fBopen\fR(2) system call is used to open the virtual console and \fBread\fR(2), \fBwrite\fR(2) and -\fBioctl\fR(2) are used in the normal way and support the functionality of the +\fBioctl\fR(2) are used in the normal way and support the functionality of the underlying device. In addition, some virtual console-specific ioctls are -provided and described below. +provided and described below. .sp .LP The VT provides a link between different screen faces and the device. The @@ -95,7 +95,6 @@ controlling tty and privilege check for query/view operations. The following ioctls apply to devices that support virtual consoles: .sp .ne 2 -.mk .na \fB\fBVT_ENABLED\fR\fR .ad @@ -108,7 +107,6 @@ integer is 1, otherwise it is 0. .sp .ne 2 -.mk .na \fB\fBVT_OPENQRY\fR\fR .ad @@ -122,7 +120,6 @@ VT's, -1 is filled in. .sp .ne 2 -.mk .na \fB\fBVT_GETMODE\fR\fR .ad @@ -156,7 +153,6 @@ struct vt_mode { .sp .ne 2 -.mk .na \fB\fBVT_SETMODE\fR\fR .ad @@ -171,13 +167,12 @@ the signal default is \fBSIGUSR1\fR (for relsig and acqsig). .sp .ne 2 -.mk .na \fB\fBVT_RELDISP\fR\fR .ad .sp .6 .RS 4n -Tells the VT manager if the process releases (or refuses to release) the +Tells the VT manager if the process releases (or refuses to release) the display. An argument of 1 indicates the VT is released. An argument of 0 indicates refusal to release. The \fBVT_ACKACQ\fR argument indicates if acquisition of the VT has been completed. @@ -185,7 +180,6 @@ acquisition of the VT has been completed. .sp .ne 2 -.mk .na \fB\fBVT_ACTIVATE\fR\fR .ad @@ -198,20 +192,18 @@ exist, the call fails and errno is set to \fBENXIO\fR. .sp .ne 2 -.mk .na \fB\fBVT_WAITACTIVE\fR\fR .ad .sp .6 .RS 4n If the specified VT is currently active, this call returns immediately. -Otherwise, it sleeps until the specified VT becomes active, at which point it +Otherwise, it sleeps until the specified VT becomes active, at which point it returns. .RE .sp .ne 2 -.mk .na \fB\fBVT_GETSTATE\fR\fR .ad @@ -239,7 +231,6 @@ VT in v_state. Next, the VT manager transfers the information in structure .sp .ne 2 -.mk .na \fB\fBKDGETMODE\fR\fR .ad @@ -258,7 +249,6 @@ Obtains the text/graphics mode associated with the VT. .sp .ne 2 -.mk .na \fB\fBKDSETMODE\fR\fR .ad @@ -296,12 +286,10 @@ console text mode. .SH FILES .sp .ne 2 -.mk .na \fB\fB/dev/vt/#\fR \fR .ad .RS 14n -.rt VT devices. .RE |