diff options
| author | Richard Lowe <richlowe@richlowe.net> | 2011-03-14 14:05:30 -0400 |
|---|---|---|
| committer | Richard Lowe <richlowe@richlowe.net> | 2011-03-14 14:05:30 -0400 |
| commit | c10c16dec587a0662068f6e2991c29ed3a9db943 (patch) | |
| tree | f414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3head | |
| parent | 68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff) | |
| download | illumos-joyent-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz | |
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com
Reviewed by: gwr@nexenta.com
Reviewed by: trisk@opensolaris.org
Approved by: gwr@nexenta.com
--HG--
extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3head')
88 files changed, 20104 insertions, 0 deletions
diff --git a/usr/src/man/man3head/Makefile b/usr/src/man/man3head/Makefile new file mode 100644 index 0000000000..1cadc6af02 --- /dev/null +++ b/usr/src/man/man3head/Makefile @@ -0,0 +1,289 @@ +# +# This file and its contents are supplied under the terms of the +# Common Development and Distribution License ("CDDL"), version 1.0. +# You may only use this file in accordance with the terms of version +# 1.0 of the CDDL. +# +# A full copy of the text of the CDDL should have accompanied this +# source. A copy of the CDDL is also available via the Internet +# at http://www.illumos.org/license/CDDL. +# + +# Copyright 2011, Richard Lowe + +include ../../Makefile.master + +MANSECT = 3head + +MANFILES = acct.h.3head \ + aio.h.3head \ + ar.h.3head \ + archives.h.3head \ + assert.h.3head \ + complex.h.3head \ + cpio.h.3head \ + dirent.h.3head \ + errno.h.3head \ + fcntl.h.3head \ + fenv.h.3head \ + float.h.3head \ + floatingpoint.h.3head \ + fmtmsg.h.3head \ + fnmatch.h.3head \ + ftw.h.3head \ + glob.h.3head \ + grp.h.3head \ + iconv.h.3head \ + if.h.3head \ + in.h.3head \ + inet.h.3head \ + inttypes.h.3head \ + ipc.h.3head \ + iso646.h.3head \ + langinfo.h.3head \ + libgen.h.3head \ + libintl.h.3head \ + limits.h.3head \ + locale.h.3head \ + math.h.3head \ + mman.h.3head \ + monetary.h.3head \ + mqueue.h.3head \ + msg.h.3head \ + ndbm.h.3head \ + netdb.h.3head \ + nl_types.h.3head \ + poll.h.3head \ + pthread.h.3head \ + pwd.h.3head \ + regex.h.3head \ + resource.h.3head \ + sched.h.3head \ + search.h.3head \ + select.h.3head \ + sem.h.3head \ + semaphore.h.3head \ + setjmp.h.3head \ + shm.h.3head \ + siginfo.h.3head \ + signal.h.3head \ + socket.h.3head \ + spawn.h.3head \ + stat.h.3head \ + statvfs.h.3head \ + stdbool.h.3head \ + stddef.h.3head \ + stdint.h.3head \ + stdio.h.3head \ + stdlib.h.3head \ + string.h.3head \ + strings.h.3head \ + stropts.h.3head \ + syslog.h.3head \ + tar.h.3head \ + tcp.h.3head \ + termios.h.3head \ + tgmath.h.3head \ + time.h.3head \ + timeb.h.3head \ + times.h.3head \ + types.h.3head \ + types32.h.3head \ + ucontext.h.3head \ + uio.h.3head \ + ulimit.h.3head \ + un.h.3head \ + unistd.h.3head \ + utime.h.3head \ + utmpx.h.3head \ + utsname.h.3head \ + values.h.3head \ + wait.h.3head \ + wchar.h.3head \ + wctype.h.3head \ + wordexp.h.3head + +MANSOFILES = acct.3head \ + aio.3head \ + ar.3head \ + archives.3head \ + assert.3head \ + complex.3head \ + cpio.3head \ + dirent.3head \ + errno.3head \ + fcntl.3head \ + fenv.3head \ + float.3head \ + floatingpoint.3head \ + fmtmsg.3head \ + fnmatch.3head \ + ftw.3head \ + glob.3head \ + grp.3head \ + iconv.3head \ + if.3head \ + in.3head \ + inet.3head \ + inttypes.3head \ + ipc.3head \ + iso646.3head \ + langinfo.3head \ + libgen.3head \ + libintl.3head \ + limits.3head \ + locale.3head \ + math.3head \ + mman.3head \ + monetary.3head \ + mqueue.3head \ + msg.3head \ + ndbm.3head \ + netdb.3head \ + nl_types.3head \ + poll.3head \ + pthread.3head \ + pwd.3head \ + regex.3head \ + resource.3head \ + sched.3head \ + search.3head \ + select.3head \ + sem.3head \ + semaphore.3head \ + setjmp.3head \ + shm.3head \ + siginfo.3head \ + signal.3head \ + socket.3head \ + spawn.3head \ + stat.3head \ + statvfs.3head \ + stdbool.3head \ + stddef.3head \ + stdint.3head \ + stdio.3head \ + stdlib.3head \ + string.3head \ + strings.3head \ + stropts.3head \ + syslog.3head \ + tar.3head \ + tcp.3head \ + termios.3head \ + tgmath.3head \ + time.3head \ + timeb.3head \ + times.3head \ + types.3head \ + types32.3head \ + ucontext.3head \ + uio.3head \ + ulimit.3head \ + un.3head \ + unistd.3head \ + utime.3head \ + utmpx.3head \ + utsname.3head \ + values.3head \ + wait.3head \ + wchar.3head \ + wctype.3head \ + wordexp.3head + +MANFILES += $(MANSOFILES) + +acct.3head := SOSRC = man3head/acct.h.3head +aio.3head := SOSRC = man3head/aio.h.3head +ar.3head := SOSRC = man3head/ar.h.3head +archives.3head := SOSRC = man3head/archives.h.3head +assert.3head := SOSRC = man3head/assert.h.3head +complex.3head := SOSRC = man3head/complex.h.3head +cpio.3head := SOSRC = man3head/cpio.h.3head +dirent.3head := SOSRC = man3head/dirent.h.3head +errno.3head := SOSRC = man3head/errno.h.3head +fcntl.3head := SOSRC = man3head/fcntl.h.3head +fenv.3head := SOSRC = man3head/fenv.h.3head +float.3head := SOSRC = man3head/float.h.3head +floatingpoint.3head := SOSRC = man3head/floatingpoint.h.3head +fmtmsg.3head := SOSRC = man3head/fmtmsg.h.3head +fnmatch.3head := SOSRC = man3head/fnmatch.h.3head +ftw.3head := SOSRC = man3head/ftw.h.3head +glob.3head := SOSRC = man3head/glob.h.3head +grp.3head := SOSRC = man3head/grp.h.3head +iconv.3head := SOSRC = man3head/iconv.h.3head +if.3head := SOSRC = man3head/if.h.3head +in.3head := SOSRC = man3head/in.h.3head +inet.3head := SOSRC = man3head/inet.h.3head +inttypes.3head := SOSRC = man3head/inttypes.h.3head +ipc.3head := SOSRC = man3head/ipc.h.3head +iso646.3head := SOSRC = man3head/iso646.h.3head +langinfo.3head := SOSRC = man3head/langinfo.h.3head +libgen.3head := SOSRC = man3head/libgen.h.3head +libintl.3head := SOSRC = man3head/libintl.h.3head +limits.3head := SOSRC = man3head/limits.h.3head +locale.3head := SOSRC = man3head/locale.h.3head +math.3head := SOSRC = man3head/math.h.3head +mman.3head := SOSRC = man3head/mman.h.3head +monetary.3head := SOSRC = man3head/monetary.h.3head +mqueue.3head := SOSRC = man3head/mqueue.h.3head +msg.3head := SOSRC = man3head/msg.h.3head +ndbm.3head := SOSRC = man3head/ndbm.h.3head +netdb.3head := SOSRC = man3head/netdb.h.3head +nl_types.3head := SOSRC = man3head/nl_types.h.3head +poll.3head := SOSRC = man3head/poll.h.3head +pthread.3head := SOSRC = man3head/pthread.h.3head +pwd.3head := SOSRC = man3head/pwd.h.3head +regex.3head := SOSRC = man3head/regex.h.3head +resource.3head := SOSRC = man3head/resource.h.3head +sched.3head := SOSRC = man3head/sched.h.3head +search.3head := SOSRC = man3head/search.h.3head +select.3head := SOSRC = man3head/select.h.3head +sem.3head := SOSRC = man3head/sem.h.3head +semaphore.3head := SOSRC = man3head/semaphore.h.3head +setjmp.3head := SOSRC = man3head/setjmp.h.3head +shm.3head := SOSRC = man3head/shm.h.3head +siginfo.3head := SOSRC = man3head/siginfo.h.3head +signal.3head := SOSRC = man3head/signal.h.3head +socket.3head := SOSRC = man3head/socket.h.3head +spawn.3head := SOSRC = man3head/spawn.h.3head +stat.3head := SOSRC = man3head/stat.h.3head +statvfs.3head := SOSRC = man3head/statvfs.h.3head +stdbool.3head := SOSRC = man3head/stdbool.h.3head +stddef.3head := SOSRC = man3head/stddef.h.3head +stdint.3head := SOSRC = man3head/stdint.h.3head +stdio.3head := SOSRC = man3head/stdio.h.3head +stdlib.3head := SOSRC = man3head/stdlib.h.3head +string.3head := SOSRC = man3head/string.h.3head +strings.3head := SOSRC = man3head/strings.h.3head +stropts.3head := SOSRC = man3head/stropts.h.3head +syslog.3head := SOSRC = man3head/syslog.h.3head +tar.3head := SOSRC = man3head/tar.h.3head +tcp.3head := SOSRC = man3head/tcp.h.3head +termios.3head := SOSRC = man3head/termios.h.3head +tgmath.3head := SOSRC = man3head/tgmath.h.3head +time.3head := SOSRC = man3head/time.h.3head +timeb.3head := SOSRC = man3head/timeb.h.3head +times.3head := SOSRC = man3head/times.h.3head +types.3head := SOSRC = man3head/types.h.3head +types32.3head := SOSRC = man3head/types32.h.3head +ucontext.3head := SOSRC = man3head/ucontext.h.3head +uio.3head := SOSRC = man3head/uio.h.3head +ulimit.3head := SOSRC = man3head/ulimit.h.3head +un.3head := SOSRC = man3head/un.h.3head +unistd.3head := SOSRC = man3head/unistd.h.3head +utime.3head := SOSRC = man3head/utime.h.3head +utmpx.3head := SOSRC = man3head/utmpx.h.3head +utsname.3head := SOSRC = man3head/utsname.h.3head +values.3head := SOSRC = man3head/values.h.3head +wait.3head := SOSRC = man3head/wait.h.3head +wchar.3head := SOSRC = man3head/wchar.h.3head +wctype.3head := SOSRC = man3head/wctype.h.3head +wordexp.3head := SOSRC = man3head/wordexp.h.3head + + +.KEEP_STATE: + +include ../Makefile.man + +install: $(ROOTMANFILES) diff --git a/usr/src/man/man3head/acct.h.3head b/usr/src/man/man3head/acct.h.3head new file mode 100644 index 0000000000..73511b3d22 --- /dev/null +++ b/usr/src/man/man3head/acct.h.3head @@ -0,0 +1,144 @@ +'\" te +.\" Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 1989 AT&T +.\" 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 acct.h 3HEAD "19 May 1994" "SunOS 5.11" "Headers" +.SH NAME +acct.h, acct \- per-process accounting file format +.SH SYNOPSIS +.LP +.nf +#include <sys/types.h> +#include <sys/acct.h> +.fi + +.SH DESCRIPTION +.sp +.LP +Files produced as a result of calling \fBacct\fR(2) have records in the form +defined by <\fBsys/acct.h\fR>, whose contents are: +.sp +.in +2 +.nf +typedef ushort_t comp_t; /* pseudo "floating point" + representation */ + /* 3 bit base-8 exponent in the high */ + /* order bits, and a 13-bit fraction */ + /* in the low order bits. */ + +struct acct +{ + char ac_flag; /* Accounting flag */ + char ac_stat; /* Exit status */ + uid_t ac_uid; /* Accounting user ID */ + gid_t ac_gid; /* Accounting group ID */ + dev_t ac_tty; /* control tty */ + time_t ac_btime; /* Beginning time */ + comp_t ac_utime; /* accounting user time in clock ticks */ + comp_t ac_stime; /* accounting system time in clock ticks */ + comp_t ac_etime; /* accounting total elapsed time in clock + ticks */ + comp_t ac_mem; /* memory usage in clicks (pages) */ + comp_t ac_io; /* chars transferred by read/write */ + comp_t ac_rw; /* number of block reads/writes */ + char ac_comm[8]; /* command name */ +}; + +/* + * Accounting Flags + */ + +#define AFORK 01 /* has executed fork, but no exec */ +#define ASU 02 /* used super-user privileges */ +#define ACCTF 0300 /* record type */ +#define AEXPND 040 /* Expanded Record Type \(mi default */ +.fi +.in -2 + +.sp +.LP +In \fBac_flag\fR, the \fBAFORK\fR flag is turned on by each \fBfork\fR and +turned off by an \fBexec\fR. The \fBac_comm\fR field is inherited from the +parent process and is reset by any \fBexec\fR. Each time the system charges the +process with a clock tick, it also adds to \fBac_mem\fR the current process +size, computed as follows: +.sp +.LP +\fI(data size) + (text size) / (number of in-core processes using text)\fR +.sp +.LP +The value of \fBac_mem\|/\|(ac_stime\|+\|ac_utime)\fR can be viewed as an +approximation to the mean process size, as modified by text sharing. +.sp +.LP +The structure \fBtacct\fR, (which resides with the source files of the +accounting commands), represents a summary of accounting statistics for the +user id \fBta_uid\fR. This structure is used by the accounting commands to +report statistics based on user id. +.sp +.in +2 +.nf +/* + * total accounting (for acct period), also for day + */ +struct tacct { + uid_t ta_uid; /* user id */ + char ta_name[8]; /* login name */ + float ta_cpu[2]; /* cum. cpu time in minutes, */ + /* p/np (prime/non-prime time) */ + float ta_kcore[2]; /* cum. kcore-minutes, p/np */ + float ta_con[2]; /* cum. connect time in minutes, + p/np */ + float ta_du; /* cum. disk usage (blocks)*/ + long ta_pc; /* count of processes */ + unsigned short ta_sc; /* count of login sessions */ + unsigned short ta_dc; /* count of disk samples */ + unsigned short ta_fee; /* fee for special services */ +}; +.fi +.in -2 + +.sp +.LP +The \fBta_cpu\fR, \fBta_kcore\fR, and \fBta_con\fR members contain usage +information pertaining to prime time and non-prime time hours. The first +element in each array represents the time the resource was used during prime +time hours. The second element in each array represents the time the resource +was used during non-prime time hours. Prime time and non-prime time hours may +be set in the \fBholidays\fR file (see \fBholidays\fR(4)). +.sp +.LP +The \fBta_kcore\fR member is a cumulative measure of the amount of memory used +over the accounting period by processes owned by the user with uid +\fBta_uid\fR. The amount shown represents kilobyte segments of memory used, per +minute. +.sp +.LP +The \fBta_con\fR member represents the amount of time the user was logged in to +the system. +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/etc/acct/holidays\fR\fR +.ad +.RS 22n +.rt +prime/non-prime time table +.RE + +.SH SEE ALSO +.sp +.LP +\fBacctcom\fR(1), \fBacct\fR(1M), \fBacctcon\fR(1M), \fBacctmerg\fR(1M), +\fBacctprc\fR(1M), \fBacctsh\fR(1M), \fBprtacct\fR(1M), \fBrunacct\fR(1M), +\fBshutacct\fR(1M), \fBacct\fR(2), \fBexec\fR(2), \fBfork\fR(2) +.SH NOTES +.sp +.LP +The \fBac_mem\fR value for a short-lived command gives little information about +the actual size of the command, because \fBac_mem\fR may be incremented while a +different command (for example, the shell) is being executed by the process. diff --git a/usr/src/man/man3head/aio.h.3head b/usr/src/man/man3head/aio.h.3head new file mode 100644 index 0000000000..9b29ef27b9 --- /dev/null +++ b/usr/src/man/man3head/aio.h.3head @@ -0,0 +1,140 @@ +'\" te +.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 1989 AT&T. +.\" Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 aio.h 3HEAD "5 Feb 2008" "SunOS 5.11" "Headers" +.SH NAME +aio.h, aio \- asynchronous input and output +.SH SYNOPSIS +.LP +.nf +\fB#include <aio.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBaio.h\fR> header defines the \fBaiocb\fR structure which includes the +following members: +.sp +.in +2 +.nf +int aio_fildes file descriptor +off_t aio_offset file offset +volatile void* aio_buf location of buffer +size_t aio_nbytes length of transfer +int aio_reqprio request priority offset +struct sigevent aio_sigevent notification type +int aio_lio_opcode listio operation +.fi +.in -2 + +.sp +.LP +This header also includes the following constants: +.sp +.ne 2 +.mk +.na +\fB\fBAIO_ALLDONE\fR\fR +.ad +.RS 19n +.rt +A return value indicating that none of the requested operations could be +canceled since they are already complete. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBAIO_CANCELED\fR\fR +.ad +.RS 19n +.rt +A return value indicating that all requested operations have been canceled. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBAIO_NOTCANCELED\fR\fR +.ad +.RS 19n +.rt +A return value indicating that some of the requested operations could not be +canceled since they are in progress. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLIO_NOP\fR\fR +.ad +.RS 19n +.rt +A \fBlio_listio\fR(3C) element operation option indicating that no transfer is +requested. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLIO_NOWAIT\fR\fR +.ad +.RS 19n +.rt +A \fBlio_listio()\fR synchronization operation indicating that the calling +thread is to continue execution while the \fBlio_listio()\fR operation is being +performed, and notification is to be given when the operation is complete. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLIO_READ\fR\fR +.ad +.RS 19n +.rt +A \fBlio_listio()\fR element operation option requesting a read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLIO_WAIT\fR\fR +.ad +.RS 19n +.rt +A \fBlio_listio()\fR synchronization operation indicating that the calling +thread is to suspend until the \fBlio_listio()\fR operation is complete. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLIO_WRITE\fR\fR +.ad +.RS 19n +.rt +A \fBlio_listio()\fR element operation option requesting a write. +.RE + +.SH SEE ALSO +.sp +.LP +\fBlseek\fR(2), \fBread\fR(2), \fBwrite\fR(2), \fBfsync\fR(3C), +\fBlibaio\fR(3LIB), \fBlio_listio\fR(3C) diff --git a/usr/src/man/man3head/ar.h.3head b/usr/src/man/man3head/ar.h.3head new file mode 100644 index 0000000000..9b30c495b4 --- /dev/null +++ b/usr/src/man/man3head/ar.h.3head @@ -0,0 +1,219 @@ +'\" te +.\" Copyright 1989 AT&T +.\" 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 ar.h 3HEAD "1 Jul 1998" "SunOS 5.11" "Headers" +.SH NAME +ar.h, ar \- archive file format +.SH SYNOPSIS +.LP +.nf +#include <ar.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The archive command \fBar\fR is used to combine several files into one. +Archives are used mainly as libraries to be searched by the link editor +\fBld\fR. +.sp +.LP +Each archive begins with the archive magic string. +.sp +.in +2 +.nf +#define ARMAG "!<arch>\en" /* magic string */ +#define SARMAG 8 /* length of magic string */ +.fi +.in -2 + +.sp +.LP +Following the archive magic string are the archive file members. Each file +member is preceded by a file member header which is of the following format: +.sp +.in +2 +.nf +#define ARFMAG "`\en" /* header trailer string */ + +struct ar_hdr /* file member header */ +{ + char ar_name[16]; /* '/' terminated file member name */ + char ar_date[12]; /* file member date */ + char ar_uid[6] /* file member user identification */ + char ar_gid[6] /* file member group identification */ + char ar_mode[8] /* file member mode (octal) */ + char ar_size[10]; /* file member size */ + char ar_fmag[2]; /* header trailer string */ +}; +.fi +.in -2 + +.sp +.LP +All information in the file member headers is in printable \fBASCII.\fR The +numeric information contained in the headers is stored as decimal numbers +(except for \fIar_mode\fR which is in octal). Thus, if the archive contains +printable files, the archive itself is printable. +.sp +.LP +If the file member name fits, the \fIar_name\fR field contains the name +directly, and is terminated by a slash (\fB/\fR) and padded with blanks on the +right. If the member's name does not fit, \fIar_name\fR contains a slash +(\fB/\fR) followed by a decimal representation of the name's offset in the +archive string table described below. +.sp +.LP +The \fIar_date\fR field is the modification date of the file at the time of its +insertion into the archive. Common format archives can be moved from system to +system as long as the portable archive command \fBar\fR is used. +.sp +.LP +Each archive file member begins on an even byte boundary; a newline is inserted +between files if necessary. Nevertheless, the size given reflects the actual +size of the file exclusive of padding. +.sp +.LP +Notice there is no provision for empty areas in an archive file. +.sp +.LP +Each archive that contains object files (see \fBa.out\fR(4)) includes an +archive symbol table. This symbol table is used by the link editor \fBld\fR to +determine which archive members must be loaded during the link edit process. +The archive symbol table (if it exists) is always the first file in the archive +(but is never listed) and is automatically created and/or updated by \fBar\fR. +.sp +.LP +The archive symbol table has a zero length name (that is, \fBar_name[0]\fR is +\fB\&'/'\fR), \fBar_name[1]==' '\fR, etc.). All ``words'' in this symbol table +have four bytes, using the machine-independent encoding shown below. All +machines use the encoding described here for the symbol table, even if the +machine's ``natural'' byte order is different. +.sp +.in +2 +.nf + 0 1 2 3 +0x01020304 01 02 03 04 +.fi +.in -2 + +.sp +.LP +The contents of this file are as follows: +.RS +4 +.TP +1. +The number of symbols. Length: 4 bytes. +.RE +.RS +4 +.TP +2. +The array of offsets into the archive file. Length: 4 bytes * ``the number +of symbols''. +.RE +.RS +4 +.TP +3. +The name string table. Length: \fIar_size\fR - 4 bytes * (``the number of +symbols'' + 1). +.RE +.sp +.LP +As an example, the following symbol table defines 4 symbols. The archive member +at file offset 114 defines \fIname\fR. The archive member at file offset 122 +defines \fIobject\fR. The archive member at file offset 426 defines +\fBfunction\fR and the archive member at file offset 434 defines \fIname2\fR. +.SS "Example Symbol Table" +.sp +.in +2 +.nf +Offset +0 +1 +2 +3 + ___________________ + 0 | 4 | 4 offset entries + |___________________| + 4 | 114 | name + |___________________| + 8 | 122 | object + |___________________| +12 | 426 | function + |___________________| +16 | 434 | name2 + |___________________| +20 | n | a | m | e | + |____|____|____|____| +24 | \e0 | o | b | j | + |____|____|____|____| +28 | e | c | t | \e0 | + |____|____|____|____| +32 | f | u | n | c | + |____|____|____|____| +36 | t | i | o | n | + |____|____|____|____| +40 | \e0 | n | a | m | + |____|____|____|____| +44 | e | 2 | \e0 | | + |____|____|____|____| +.fi +.in -2 + +.sp +.LP +The string table contains exactly as many null terminated strings as there are +elements in the offsets array. Each offset from the array is associated with +the corresponding name from the string table (in order). The names in the +string table are all the defined global symbols found in the common object +files in the archive. Each offset is the location of the archive header for the +associated symbol. +.sp +.LP +If some archive member's name is more than 15 bytes long, a special archive +member contains a table of file names, each followed by a slash and a new-line. +This string table member, if present, will precede all ``normal'' archive +members. The special archive symbol table is not a ``normal'' member, and must +be first if it exists. The \fBar_name\fR entry of the string table's member +header holds a zero length name \fBar_name[0]=='/'\fR, followed by one trailing +slash (\fBar_name[1]=='/'\fR), followed by blanks (\fBar_name[2]==' '\fR, +etc.). Offsets into the string table begin at zero. Example \fIar_name\fR +values for short and long file names appear below. +.sp +.in +2 +.nf +Offset +0 +1 +2 +3 +4 +5 +6 +7 +8 +9 + __________________________________________________ + 0 | f | i | l | e | _ | n | a | m | e | _ | + |____|____|____|____|____|____|____|____|____|____| +10 | s | a | m | p | l | e | / | \en | l | o | + |____|____|____|____|____|____|____|____|____|____| +20 | n | g | e | r | f | i | l | e | n | a | + |____|____|____|____|____|____|____|____|____|____| +30 | m | e | x | a | m | p | l | e | / | \en | + |____|____|____|____|____|____|____|____|____|____| +.fi +.in -2 + +.sp +.in +2 +.nf + Member Name ar_name +_______________________________________________________________ +short-name | short-name/ | Not in string table + | | +file_name_sample | /0 | Offset 0 in string table + | | +longerfilenamexample | /18 | Offset 18 in string table +_____________________|______________|___________________________ +.fi +.in -2 + +.SH SEE ALSO +.sp +.LP +\fBar\fR(1), \fBld\fR(1), \fBstrip\fR(1), \fBa.out\fR(4) +.SH NOTES +.sp +.LP +The \fBstrip\fR utility will remove all archive symbol entries from the header. +The archive symbol entries must be restored with the \fB-ts\fR options of the +\fBar\fR command before the archive can be used with the link editor \fBld\fR. diff --git a/usr/src/man/man3head/archives.h.3head b/usr/src/man/man3head/archives.h.3head new file mode 100644 index 0000000000..ef9035f76c --- /dev/null +++ b/usr/src/man/man3head/archives.h.3head @@ -0,0 +1,242 @@ +'\" te +.\" Copyright (C) 2007, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 1989 AT&T +.\" 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 archives.h 3HEAD "22 Oct 2007" "SunOS 5.11" "Headers" +.SH NAME +archives.h, archives \- device header +.SH DESCRIPTION +.sp +.in +2 +.nf +/* Magic numbers */ +#define CMN_ASC 0x070701 /* Cpio Magic Number for -c header */ +#define CMN_BIN 070707 /* Cpio Magic Number for Binary header */ +#define CMN_BBS 0143561 /* Cpio Magic Number for Byte-Swap header */ +#define CMN_CRC 0x070702 /* Cpio Magic Number for CRC header */ +#define CMS_ASC "070701" /* Cpio Magic String for -c header */ +#define CMS_CHR "070707" /* Cpio Magic String for odc header */ +#define CMS_CRC "070702" /* Cpio Magic String for CRC header */ +#define CMS_LEN 6 /* Cpio Magic String length */ +/* Various header and field lengths */ +#define CHRSZ 76 /* -H odc size minus filename field */ +#define ASCSZ 110 /* -c and CRC hdr size minus filename field */ +#define TARSZ 512 /* TAR hdr size */ +#define HNAMLEN 256 /* maximum filename length for binary and + odc headers */ +#define EXPNLEN 1024 /* maximum filename length for -c and + CRC headers */ +#define HTIMLEN 2 /* length of modification time field */ +#define HSIZLEN 2 /* length of file size field */ +/* cpio binary header definition */ +struct hdr_cpio { + short h_magic, /* magic number field */ + h_dev; /* file system of file */ + ushort_t h_ino, /* inode of file */ + h_mode, /* modes of file */ + h_uid, /* uid of file */ + h_gid; /* gid of file */ + short h_nlink, /* number of links to file */ + h_rdev, /* maj/min numbers for special files */ + h_mtime[HTIMLEN], /* modification time of file */ + h_namesize, /* length of filename */ + h_filesize[HSIZLEN]; /* size of file */ + char h_name[HNAMLEN]; /* filename */ +} ; +/* cpio -H odc header format */ +struct c_hdr { + char c_magic[CMS_LEN], + c_dev[6], + c_ino[6], + c_mode[6], + c_uid[6], + c_gid[6], + c_nlink[6], + c_rdev[6], + c_mtime[11], + c_namesz[6], + c_filesz[11], + c_name[HNAMLEN]; +} ; +/* -c and CRC header format */ +struct Exp_cpio_hdr { + char E_magic[CMS_LEN], + E_ino[8], + E_mode[8], + E_uid[8], + E_gid[8], + E_nlink[8], + E_mtime[8], + E_filesize[8], + E_maj[8], + E_min[8], + E_rmaj[8], + E_rmin[8], + E_namesize[8], + E_chksum[8], + E_name[EXPNLEN]; +} ; +/* Tar header structure and format */ +#define TBLOCK 512 /* length of tar header and data blocks */ +#define TNAMLEN 100 /* maximum length for tar file names */ +#define TMODLEN 8 /* length of mode field */ +#define TUIDLEN 8 /* length of uid field */ +#define TGIDLEN 8 /* length of gid field */ +#define TSIZLEN 12 /* length of size field */ +#define TTIMLEN 12 /* length of modification time field */ +#define TCRCLEN 8 /* length of header checksum field */ +/* tar header definition */ +union tblock { + char dummy[TBLOCK]; + struct header { + char t_name[TNAMLEN]; /* name of file */ + char t_mode[TMODLEN]; /* mode of file */ + char t_uid[TUIDLEN]; /* uid of file */ + char t_gid[TGIDLEN]; /* gid of file */ + char t_size[TSIZLEN]; /* size of file in bytes */ + char t_mtime[TTIMLEN]; /* modification time of file */ + char t_chksum[TCRCLEN]; /* checksum of header */ + char t_typeflag; /* flag to indicate type of file */ + char t_linkname[TNAMLEN]; /* file this file is linked with */ + char t_magic[6]; /* magic string always "ustar" */ + char t_version[2]; /* version strings always "00" */ + char t_uname[32]; /* owner of file in ASCII */ + char t_gname[32]; /* group of file in ASCII */ + char t_devmajor[8]; /* major number for special files */ + char t_devminor[8]; /* minor number for special files */ + char t_prefix[155]; /* pathname prefix */ + } tbuf; +} +/* volcopy tape label format and structure */ +#define VMAGLEN 8 +#define VVOLLEN 6 +#define VFILLEN 464 +struct volcopy_label { + char v_magic[VMAGLEN], + v_volume[VVOLLEN], + v_reels, + v_reel; + long v_time, + v_length, + v_dens, + v_reelblks, /* u370 added field */ + v_blksize, /* u370 added field */ + v_nblocks; /* u370 added field */ + char v_fill[VFILLEN]; + long v_offset; /* used with -e and -reel options */ + int v_type; /* does tape have nblocks field? */ +} ; + +/* + * Define archive formats for extended attributes. + * + * Extended attributes are stored in two pieces. + * 1. An attribute header which has information about + * what file the attribute is for and what the attribute + * is named. + * 2. The attribute record itself. Stored as a normal file type + * of entry. + * Both the header and attribute record have special modes/typeflags + * associated with them. + * + * The names of the header in the archive look like: + * /dev/null/attr.hdr + * + * The name of the attribute looks like: + * /dev/null/attr. + * + * This is done so that an archiver that doesn't understand these formats + * can just dispose of the attribute records unless the user chooses to + * rename them via cpio -r or pax -i + * + * The format is composed of a fixed size header followed + * by a variable sized xattr_buf. If the attribute is a hard link + * to another attribute, then another xattr_buf section is included + * for the link. + * + * The xattr_buf is used to define the necessary "pathing" steps + * to get to the extended attribute. This is necessary to support + * a fully recursive attribute model where an attribute may itself + * have an attribute. + * + * The basic layout looks like this. + * +* -------------------------------- + * | | + * | xattr_hdr | + * | | + * -------------------------------- + * -------------------------------- + * | | + * | xattr_buf | + * | | + * -------------------------------- + * -------------------------------- + * | | + * | (optional link info) | + * | | + * -------------------------------- + * -------------------------------- + * | | + * | attribute itself | + * | stored as normal tar | + * | or cpio data with | + * | special mode or | + * | typeflag | + * | | + * -------------------------------- + * + */ +#define XATTR_ARCH_VERS "1.0" + +/* + * extended attribute fixed header + * + * h_version format version. + * h_size size of header + variable sized data sections. + * h_component_len Length of entire pathing section. + * h_link_component_len Length of link component section. Again same + * definition as h_component_len. + */ +struct xattr_hdr { + char h_version[7]; + char h_size[10]; + char h_component_len[10]; /* total length of path component */ + char h_link_component_len[10]; +}; + +/* + * The name is encoded like this: + * filepathNULattrpathNUL[attrpathNULL]... + */ +struct xattr_buf { + char h_namesz[7]; /* length of h_names */ + char h_typeflag; /* actual typeflag of file being archived */ + char h_names[1]; /* filepathNULattrpathNUL... */ +}; + +/* + * Special values for tar archives + */ + +/* + * typeflag for tar archives. + */ + +/* + * Attribute hdr and attribute files have the following typeflag + */ +#define _XATTR_HDRTYPE 'E' + +/* + * For cpio archives the header and attribute have + * _XATTR_CPIO_MODE ORED into the mode field in both + * character and binary versions of the archive format + */ +#define _XATTR_CPIO_MODE 0xB000 +.fi +.in -2 +.sp + diff --git a/usr/src/man/man3head/assert.h.3head b/usr/src/man/man3head/assert.h.3head new file mode 100644 index 0000000000..a3dfe95c03 --- /dev/null +++ b/usr/src/man/man3head/assert.h.3head @@ -0,0 +1,65 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.> +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 assert.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +assert.h, assert \- verify program assertion +.SH SYNOPSIS +.LP +.nf +#include <\fBassert.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBassert.h\fR> header defines the \fBassert()\fR macro. It refers to the +macro \fBNDEBUG\fR which is not defined in the header. If \fBNDEBUG\fR is +defined as a macro name before the inclusion of this header, the \fBassert()\fR +macro is defined simply as: +.sp +.in +2 +.nf +#define assert(ignore)((void) 0) +.fi +.in -2 + +.sp +.LP +Otherwise, the macro behaves as described in \fBassert\fR(3C). +.sp +.LP +The \fBassert()\fR macro is redefined according to the current state of +\fBNDEBUG\fR each time <\fBassert.h\fR> is included. +.sp +.LP +The \fBassert()\fR macro is implemented as a macro, not as a function. If the +macro definition is suppressed in order to access an actual function, the +behavior is undefined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBassert\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/complex.h.3head b/usr/src/man/man3head/complex.h.3head new file mode 100644 index 0000000000..94dfe58491 --- /dev/null +++ b/usr/src/man/man3head/complex.h.3head @@ -0,0 +1,152 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 complex.h 3HEAD "17 Dec 2003" "SunOS 5.11" "Headers" +.SH NAME +complex.h, complex \- complex arithmetic +.SH SYNOPSIS +.LP +.nf +#include <\fBcomplex.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBcomplex.h\fR> header defines the following macros: +.sp +.ne 2 +.mk +.na +\fB\fBcomplex\fR\fR +.ad +.RS 16n +.rt +Expands to \fB_Complex\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_Complex_I\fR\fR +.ad +.RS 16n +.rt +Expands to a constant expression of type const float \fB_Complex\fR, with the +value of the imaginary unit (that is, a number i such that i^2=\(mi1). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBimaginary\fR\fR +.ad +.RS 16n +.rt +Expands to \fB_Imaginary\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_Imaginary_I\fR\fR +.ad +.RS 16n +.rt +Expands to a constant expression of type \fBconst float _Imaginary\fR with the +value of the imaginary unit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI\fR\fR +.ad +.RS 16n +.rt +Expands to either \fB_Imaginary_I\fR or \fB_Complex_I\fR. If \fB_Imaginary_I\fR +is not defined, \fBI\fR expands to \fB_Complex_I\fR. +.RE + +.sp +.LP +An application can undefine and then, if appropriate, redefine the +\fBcomplex\fR, \fBimaginary\fR, and \fBI\fR macros. +.SH USAGE +.sp +.LP +Values are interpreted as radians, not degrees. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBcabs\fR(3M), \fBcacos\fR(3M), \fBcacosh\fR(3M), \fBcarg\fR(3M), +\fBcasin\fR(3M), \fBcasinh\fR(3M), \fBcatan\fR(3M), \fBcatanh\fR(3M), +\fBccos\fR(3M), \fBccosh\fR(3M), \fBcexp\fR(3M), \fBcimag\fR(3M), +\fBclog\fR(3M), \fBconj\fR(3M), \fBcpow\fR(3M), \fBcproj\fR(3M), +\fBcreal\fR(3M), \fBcsin\fR(3M), \fBcsinh\fR(3M), \fBcsqrt\fR(3M), +\fBctan\fR(3M), \fBctanh\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5) +.SH NOTES +.sp +.LP +The choice of \fBI\fR instead of \fBi\fR for the imaginary unit concedes to the +widespread use of the identifier \fBi\fR for other purposes. The application +can use a different identifier, say \fBj\fR, for the imaginary unit by +following the inclusion of the <\fBcomplex.h\fR> header with: +.sp +.in +2 +.nf +#undef I +#define j _Imaginary_I +.fi +.in -2 + +.sp +.LP +An \fBI\fR suffix to designate imaginary constants is not required, as +multiplication by \fBI\fR provides a sufficiently convenient and more generally +useful notation for imaginary terms. The corresponding real type for the +imaginary unit is \fBfloat\fR, so that use of \fBI\fR for algorithmic or +notational convenience does not result in widening types. +.sp +.LP +On systems with imaginary types, the application has the ability to control +whether use of the macro \fBI\fR introduces an imaginary type, by explicitly +defining \fBI\fR to be \fB_Imaginary_I\fR or \fB_Complex_I\fR. +.sp +.LP +Disallowing imaginary types is useful for some applications intended to run on +implementations without support for such types. +.sp +.LP +The macro \fB_Imaginary_I\fR provides a test for whether imaginary types are +supported. The \fBcis()\fR function \fB(cos(x) + I*sin(x))\fR was considered +but rejected because its implementation is easy and straightforward, even +though some implementations could compute sine and cosine more efficiently in +tandem. diff --git a/usr/src/man/man3head/cpio.h.3head b/usr/src/man/man3head/cpio.h.3head new file mode 100644 index 0000000000..754b02c53e --- /dev/null +++ b/usr/src/man/man3head/cpio.h.3head @@ -0,0 +1,86 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 cpio.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +cpio.h, cpio \- cpio archive values +.SH SYNOPSIS +.LP +.nf +#include <\fBcpio.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +Values needed by the \fBc_mode\fR field of the \fBcpio\fR archive format are +described as follows: +.sp + +.sp +.TS +tab(); +cw(1.52i) cw(3.98i) +lw(1.52i) lw(3.98i) +. +NameDescription +_ +C_IRUSRRead by owner +C_IWUSRWrite by owner +C_IXUSRExecute by owner +C_IRGRPRead by group +C_IWGRPWrite by group +C_IXGRPExecute by group +C_IROTHRead by others +C_IWOTHWrite by others +C_IXOTHExecute by others +C_ISUIDSet user ID +C_ISGIDSet group ID +C_ISVTXOn directories, restricted deletion flag +C_ISDIRDirectory +C_ISFIFOFIFO +C_ISREGRegular file +C_ISBLKBlock special +C_ISCHRCharacter special +C_ISCTGReserved +C_ISLNKSymbolic link +C_ISSOCKSocket +.TE + +.sp +.LP +The header defines the symbolic constant: +.sp +.in +2 +.nf +MAGIC "070707" +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBpax\fR(1), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/dirent.h.3head b/usr/src/man/man3head/dirent.h.3head new file mode 100644 index 0000000000..d101d60555 --- /dev/null +++ b/usr/src/man/man3head/dirent.h.3head @@ -0,0 +1,77 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 dirent.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +dirent.h, dirent \- format of directory entries +.SH SYNOPSIS +.LP +.nf +#include <\fBdirent.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The internal format of directories is unspecified. The <\fBdirent.h\fR> header +defines the following type: +.sp +.ne 2 +.mk +.na +\fB\fBDIR\fR\fR +.ad +.RS 7n +.rt +A type representing a directory stream. +.RE + +.sp +.LP +The header also defines the structure \fBdirent\fR, which includes the +following members: +.sp +.in +2 +.nf +ino_t d_ino /* file serial number */ +char d_name[] /* name of entry */ +.fi +.in -2 + +.sp +.LP +The type \fBino_t\fR is defined as described in <\fBsys/types.h\fR>. See +\fBtypes\fR(3HEAD). +.sp +.LP +The character array \fBd_name\fR is of unspecified size, but the number of +bytes preceding the terminating null byte must not exceed {\fBNAME_MAX\fR}. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBclosedir\fR(3C), \fBopendir\fR(3C), \fBreaddir\fR(3C), \fBrewinddir\fR(3C), +\fBseekdir\fR(3C), \fBtelldir\fR(3C), \fBtypes.h\fR(3HEAD), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/errno.h.3head b/usr/src/man/man3head/errno.h.3head new file mode 100644 index 0000000000..cdb731e281 --- /dev/null +++ b/usr/src/man/man3head/errno.h.3head @@ -0,0 +1,50 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 errno.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +errno.h, errno \- system error numbers +.SH SYNOPSIS +.LP +.nf +#include <\fBerrno.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBerrno.h\fR> header provides a declaration for \fBerrno\fR and gives +positive values for the symbolic constants listed on the \fBIntro\fR(2) manual +page. +.SH USAGE +.sp +.LP +Values for \fBerrno\fR are required to be distinct positive values rather than +non-zero values. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBIntro\fR(2), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/fcntl.h.3head b/usr/src/man/man3head/fcntl.h.3head new file mode 100644 index 0000000000..2649db73f4 --- /dev/null +++ b/usr/src/man/man3head/fcntl.h.3head @@ -0,0 +1,728 @@ +'\" te +.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 1989 AT&T +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 fcntl.h 3HEAD "5 Feb 2008" "SunOS 5.11" "Headers" +.SH NAME +fcntl.h, fcntl \- file control options +.SH SYNOPSIS +.LP +.nf +#include <fcntl.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The \fB<fcntl.h>\fR header defines the following requests and arguments for use +by the functions \fBfcntl\fR(2), \fBopen\fR(2), and \fBopenat\fR(2). +.sp +.LP +Values for \fIcmd\fR used by \fBfcntl()\fR (the following values are unique): +.sp +.ne 2 +.mk +.na +\fB\fBF_DUPFD\fR\fR +.ad +.RS 15n +.rt +Duplicate file descriptor. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_DUP2FD\fR\fR +.ad +.RS 15n +.rt +Similar to \fBF_DUPFD\fR, but always returns \fIarg\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_GETFD\fR\fR +.ad +.RS 15n +.rt +Get file descriptor flags. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_SETFD\fR\fR +.ad +.RS 15n +.rt +Set file descriptor flags. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_GETFL\fR\fR +.ad +.RS 15n +.rt +Get file status flags. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_SETFL\fR\fR +.ad +.RS 15n +.rt +Set file status flags. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_GETOWN\fR\fR +.ad +.RS 15n +.rt +Get process or process group \fBID\fR to receive \fBSIGURG\fR signals. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_SETOWN\fR\fR +.ad +.RS 15n +.rt +Set process or process group \fBID\fR to receive \fBSIGURG\fR signals. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_FREESP\fR\fR +.ad +.RS 15n +.rt +Free storage space associated with a section of the ordinary file \fIfildes\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_ALLOCSP\fR\fR +.ad +.RS 15n +.rt +Allocate space for a section of the ordinary file \fIfildes\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_ALLOCSP64\fR\fR +.ad +.RS 15n +.rt +Equivalent to \fBF_ALLOCSP\fR, but takes a \fBstruct flock64\fR argument rather +than a \fBstruct flock\fR argument. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_GETLK\fR\fR +.ad +.RS 15n +.rt +Get record locking information. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_GETLK64\fR\fR +.ad +.RS 15n +.rt +Equivalent to \fBF_GETLK\fR, but takes a \fBstruct flock64\fR argument rather +than a \fBstruct flock\fR argument. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_SETLK\fR\fR +.ad +.RS 15n +.rt +Set record locking information. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_SETLK64\fR\fR +.ad +.RS 15n +.rt +Equivalent to \fBF_SETLK\fR, but takes a \fBstruct flock64\fR argument rather +than a \fBstruct flock\fR argument. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_SETLKW\fR\fR +.ad +.RS 15n +.rt +Set record locking information; wait if blocked. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_SETLKW64\fR\fR +.ad +.RS 15n +.rt +Equivalent to \fBF_SETLKW\fR, but takes a \fBstruct flock64\fR argument rather +than a \fBstruct flock\fR argument. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_SHARE\fR\fR +.ad +.RS 15n +.rt +Set share reservation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_UNSHARE\fR\fR +.ad +.RS 15n +.rt +Remove share reservation. +.RE + +.sp +.LP +File descriptor flags used for \fBfcntl()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBFD_CLOEXEC\fR\fR +.ad +.RS 14n +.rt +Close the file descriptor upon execution of an \fBexec\fR function (see +\fBexec\fR(2)). +.RE + +.sp +.LP +Values for \fBl_type\fR used for record locking with \fBfcntl()\fR (the +following values are unique): +.sp +.ne 2 +.mk +.na +\fB\fBF_RDLCK\fR\fR +.ad +.RS 11n +.rt +Shared or read lock. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_UNLCK\fR\fR +.ad +.RS 11n +.rt +Unlock. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_WRLCK\fR\fR +.ad +.RS 11n +.rt +Exclusive or write lock. +.RE + +.sp +.LP +Values for \fBf_access\fR used for share reservations with \fBfcntl()\fR (the +following values are unique): +.sp +.ne 2 +.mk +.na +\fB\fBF_RDACC\fR\fR +.ad +.RS 11n +.rt +Read-only share reservation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_WRACC\fR\fR +.ad +.RS 11n +.rt +Write-only share reservation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_RWACC\fR\fR +.ad +.RS 11n +.rt +Read and write share reservation. +.RE + +.sp +.LP +Values for \fBf_deny\fR used for share reservations with \fBfcntl()\fR (the +following values are unique): +.sp +.ne 2 +.mk +.na +\fB\fBF_COMPAT\fR\fR +.ad +.RS 12n +.rt +Compatibility mode share reservation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_RDDNY\fR\fR +.ad +.RS 12n +.rt +Deny other read access share reservations. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_WRDNY\fR\fR +.ad +.RS 12n +.rt +Deny other write access share reservations. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_RWDNY\fR\fR +.ad +.RS 12n +.rt +Deny other read or write access share reservations. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_NODNY\fR\fR +.ad +.RS 12n +.rt +Do not deny other read or write access share reservations. +.RE + +.sp +.LP +File creation and assignment flags are used in the \fIoflag\fR argument by +\fBopen()\fR and \fBopenat()\fR. All of these values are bitwise distinct: +.sp +.ne 2 +.mk +.na +\fB\fBO_CREAT\fR\fR +.ad +.RS 12n +.rt +Create file if it does not exist. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_EXCL\fR\fR +.ad +.RS 12n +.rt +Exclusive use flag. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_NOCTTY\fR\fR +.ad +.RS 12n +.rt +Do not assign controlling tty. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_TRUNC\fR\fR +.ad +.RS 12n +.rt +Truncate flag. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_XATTR\fR\fR +.ad +.RS 12n +.rt +When opening a file, this flag affects the way in which relative paths are +resolved by \fBopen()\fR and \fBopenat()\fR. With this flag set, the +\fIpath\fR argument is resolved as an extended attribute reference on either +the current working directory (if open) or of the file referenced by the file +descriptor argument of \fBopenat()\fR. +.RE + +.sp +.LP +File status flags used for \fBfcntl()\fR, \fBopen()\fR, and \fBopen()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBO_APPEND\fR\fR +.ad +.RS 14n +.rt +Set append mode. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_NDELAY\fR\fR +.ad +.RS 14n +.rt +Non-blocking mode. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_NONBLOCK\fR\fR +.ad +.RS 14n +.rt +Non-blocking mode (POSIX; see \fBstandards\fR(5)). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_DSYNC\fR\fR +.ad +.RS 14n +.rt +Write I/O operations on the file descriptor complete as defined by synchronized +I/O data integrity completion. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_RSYNC\fR\fR +.ad +.RS 14n +.rt +Read I/O operations on the file descriptor complete at the same level of +integrity as specified by the \fBO_DSYNC\fR and \fBO_SYNC\fR flags. If both +\fBO_DSYNC\fR and \fBO_RSYNC\fR are set in \fIoflag\fR, all I/O operations on +the file descriptor complete as defined by synchronized I/O data integrity +completion. If both \fBO_SYNC\fR and \fBO_RSYNC\fR are set in \fIoflag\fR, +all I/O operations on the file descriptor complete as defined by synchronized +I/O file integrity completion. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_SYNC\fR\fR +.ad +.RS 14n +.rt +When opening a regular file, this flag affects subsequent writes. If set, each +\fBwrite\fR(2) will wait for both the file data and file status to be +physically updated. Write I/O operations on the file descriptor complete as +defined by synchronized I/O file integrity completion. +.RE + +.sp +.LP +Mask for use with file access modes: +.sp +.ne 2 +.mk +.na +\fB\fBO_ACCMODE\fR\fR +.ad +.RS 13n +.rt +Mask for file access modes. +.RE + +.sp +.LP +File access modes used for \fBfcntl()\fR, \fBopen()\fR, and \fBopenat()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBO_RDONLY\fR\fR +.ad +.RS 12n +.rt +Open for reading only. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_RDWR\fR\fR +.ad +.RS 12n +.rt +Open for reading and writing. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBO_WRONLY\fR\fR +.ad +.RS 12n +.rt +Open for writing only. +.RE + +.sp +.LP +The following constants are used by system calls capable of resolving paths +relative to a provided open file descriptor: +.sp +.ne 2 +.mk +.na +\fB\fBAT_FDCWD\fR\fR +.ad +.RS 23n +.rt +Special value to pass in place of a file descriptor to inform the called +routine that relative path arguments should be resolved from the current +working directory. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBAT_SYMLINK_NOFOLLOW\fR\fR +.ad +.RS 23n +.rt +Flag passed to \fBfstatat\fR(2) and \fBfchownat\fR(2) to change the bahavior of +these functions when they are given a file as an argument that is a symbolic +link. In this case the functions operate on the symbolic link file rather than +the file the link references. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBAT_REMOVEDIR\fR\fR +.ad +.RS 23n +.rt +Flag passed to \fBunlinkat\fR(2) to tell it to assume that its path argument +refers to a directory and to attempt to remove this directory. +.RE + +.sp +.LP +The \fBflock\fR structure describes a file lock. It includes the following +members: +.sp +.in +2 +.nf +short l_type; /* Type of lock */ +short l_whence; /* Flag for starting offset */ +off_t l_start; /* Relative offset in bytes */ +off_t l_len; /* Size; if 0 then until EOF */ +long l_sysid; /* Returned with F_GETLK */ +pid_t l_pid; /* Returned with F_GETLK */ +.fi +.in -2 + +.sp +.LP +The structure \fBfshare\fR describes a file share reservation. It includes the +following members: +.sp +.in +2 +.nf +short f_access; /* Type of reservation */ +short f_deny; /* Type of reservations to deny */ +long f_id; /* Process unique identifier */ +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityCommitted +_ +StandardSee \fBstandards\fR(5). +.TE + +.SH SEE ALSO +.sp +.LP +\fBcreat\fR(2), \fBexec\fR(2), \fBfcntl\fR(2), \fBopen\fR(2), +\fBfdatasync\fR(3C), \fBfsync\fR(3C), \fBfsattr\fR(5), \fBattributes\fR(5), +\fBstandards\fR(5) +.SH NOTES +.sp +.LP +Data is successfully transferred for a write operation to a regular file when +the system ensures that all data written is readable on any subsequent open of +the file (even one that follows a system or power failure) in the absence of a +failure of the physical storage medium. +.sp +.LP +Data is successfully transferred for a read operation when an image of the data +on the physical storage medium is available to the requesting process. +.sp +.LP +Synchronized I/O data integrity completion (see \fBfdatasync\fR(3C)): +.RS +4 +.TP +.ie t \(bu +.el o +For reads, the operation has been completed or diagnosed if unsuccessful. The +read is complete only when an image of the data has been successfully +transferred to the requesting process. If there were any pending write requests +affecting the data to be read at the time that the synchronized read operation +was requested, these write requests will be successfully transferred prior to +reading the data. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +For writes, the operation has been completed or diagnosed if unsuccessful. The +write is complete only when the data specified in the write request is +successfully transferred, and all file system information required to retrieve +the data is successfully transferred. +.RE +.sp +.LP +File attributes that are not necessary for data retrieval (access time, +modification time, status change time) need not be successfully transferred +prior to returning to the calling process. +.sp +.LP +Synchronized I/O file integrity completion (see \fBfsync\fR(3C)): +.RS +4 +.TP +.ie t \(bu +.el o +Identical to a synchronized I/O data integrity completion with the addition +that all file attributes relative to the I/O operation (including access time, +modification time, status change time) will be successfully transferred prior +to returning to the calling process. +.RE diff --git a/usr/src/man/man3head/fenv.h.3head b/usr/src/man/man3head/fenv.h.3head new file mode 100644 index 0000000000..57f9e2538e --- /dev/null +++ b/usr/src/man/man3head/fenv.h.3head @@ -0,0 +1,234 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 fenv.h 3HEAD "15 Dec 2003" "SunOS 5.11" "Headers" +.SH NAME +fenv.h, fenv \- floating-point environment +.SH SYNOPSIS +.LP +.nf +#include <\fBfenv.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBfenv.h\fR> header defines the following data types through +\fBtypedef\fR: +.sp +.ne 2 +.mk +.na +\fB\fBfenv_t\fR\fR +.ad +.RS 13n +.rt +Represents the entire floating-point environment. The floating-point +environment refers collectively to any floating-point status flags and control +modes supported by the implementation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBfexcept_t\fR\fR +.ad +.RS 13n +.rt +Represents the floating-point status flags collectively, including any status +the implementation associates with the flags. A floating-point status flag is a +system variable whose value is set (but never cleared) when a floating-point +exception is raised, which occurs as a side effect of exceptional +floating-point arithmetic to provide auxiliary information. A floating-point +control mode is a system variable whose value can be set by the user to affect +the subsequent behavior of floating-point arithmetic. +.RE + +.sp +.LP +The <\fBfenv.h\fR> header defines the following constants if and only if the +implementation supports the floating-point exception by means of the +floating-point functions \fBfeclearexcept()\fR, \fBfegetexceptflag()\fR, +\fBferaiseexcept()\fR, \fBfesetexceptflag()\fR, and \fBfetestexcept()\fR. Each +expands to an integer constant expression with values such that +bitwise-inclusive ORs of all combinations of the constants result in distinct +values. +.sp +.in +2 +.nf +FE_DIVBYZERO +FE_INEXACT +FE_INVALID +FE_OVERFLOW +FE_UNDERFLOW +.fi +.in -2 + +.sp +.LP +The <\fBfenv.h\fR> header defines the following constant, which is simply the +bitwise-inclusive OR of all floating-point exception constants defined above: +.sp +.in +2 +.nf +FE_ALL_EXCEPT +.fi +.in -2 + +.sp +.LP +The <\fBfenv.h\fR> header defines the following constants. Each expands to an +integer constant expression whose values are distinct non-negative values. +.sp +.in +2 +.nf +FE_DOWNWARD +FE_TONEAREST +FE_TOWARDZERO +FE_UPWARD +.fi +.in -2 + +.sp +.LP +The <\fBfenv.h\fR> header defines the following constant, which represents the +default floating-point environment (that is, the one installed at program +startup) and has type pointer to const-qualified \fBfenv_t\fR. It can be used +as an argument to the functions within the <\fBfenv.h\fR> header that manage +the floating-point environment. +.sp +.in +2 +.nf +FE_DFL_ENV +.fi +.in -2 + +.sp +.LP +The \fBFENV_ACCESS\fR pragma provides a means to inform the implementation when +an application might access the floating-point environment to test +floating-point status flags or run under non-default floating-point control +modes. The pragma occurs either outside external declarations or preceding all +explicit declarations and statements inside a compound statement. When outside +external declarations, the pragma takes effect from its occurrence until +another \fBFENV_ACCESS\fR pragma is encountered, or until the end of the +translation unit. When inside a compound statement, the pragma takes effect +from its occurrence until another \fBFENV_ACCESS\fR pragma is encountered +(including within a nested compound statement), or until the end of the +compound statement; at the end of a compound statement the state for the pragma +is restored to its condition just before the compound statement. If this pragma +is used in any other context, the behavior is undefined. +.sp +.LP +If part of an application tests floating-point status flags, sets +floating-point control modes, or runs under non-default mode settings, but was +translated with the state for the \fBFENV_ ACCESS\fR pragma off, the behavior +is undefined. The default state (on or off) for the pragma is +implementation-defined. (When execution passes from a part of the application +translated with \fBFENV_ACCESS\fR off to a part translated with +\fBFENV_ACCESS\fR on, the state of the floating-point status flags is +unspecified and the floating-point control modes have their default settings.) +.SH USAGE +.sp +.LP +This header is designed to support the floating-point exception status flags +and directed-rounding control modes required by the IEC 60559: 1989 standard, +and other similar floating-point state information. Also, it is designed to +facilitate code portability among all systems. Certain application programming +conventions support the intended model of use for the floating-point +environment: +.RS +4 +.TP +.ie t \(bu +.el o +A function call does not alter its caller's floating-point control modes, clear +its caller's floating-point status flags, or depend on the state of its +caller's floating-point status flags unless the function is so documented. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +A function call is assumed to require default floating-point control modes, +unless its documentation promises otherwise. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +A function call is assumed to have the potential for raising floating-point +exceptions, unless its documentation promises otherwise. +.RE +.sp +.LP +With these conventions, an application can safely assume default floating-point +control modes (or be unaware of them). The responsibilities associated with +accessing the floating-point environment fall on the application that does so +explicitly. +.sp +.LP +Even though the rounding direction macros might expand to constants +corresponding to the values of \fBFLT_ROUNDS\fR, they are not required to do +so. For example: +.sp +.in +2 +.nf +#include <fenv.h> +void f(double x) +{ + #pragma STDC FENV_ACCESS ON + void g(double); + void h(double); + /* ... */ + g(x + 1); + h(x + 1); + /* ... */ +} +.fi +.in -2 + +.sp +.LP +If the function \fIg\fR() might depend on status flags set as a side effect of +the first \fIx\fR+1, or if the second \fIx\fR+1 might depend on control modes +set as a side effect of the call to function \fIg\fR(), then the application +must contain an appropriately placed invocation as follows: +.sp +.in +2 +.nf +#pragma STDC FENV_ACCESS ON +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBfeclearexcept\fR(3M), \fBfegetenv\fR(3M), \fBfegetexceptflag\fR(3M), +\fBfegetround\fR(3M), \fBfeholdexcept\fR(3M), \fBferaiseexcept\fR(3M), +\fBfesetenv\fR(3M), \fBfesetexceptflag\fR(3M), \fBfesetround\fR(3M), +\fBfetestexcept\fR(3M), \fBfeupdateenv\fR(3M), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/float.h.3head b/usr/src/man/man3head/float.h.3head new file mode 100644 index 0000000000..d05bdeb42e --- /dev/null +++ b/usr/src/man/man3head/float.h.3head @@ -0,0 +1,429 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 float.h 3HEAD "17 Dec 2003" "SunOS 5.11" "Headers" +.SH NAME +float.h, float \- floating types +.SH SYNOPSIS +.LP +.nf +#include <\fBfloat.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The characteristics of floating types are defined in terms of a model that +describes a representation of floating-point numbers and values that provide +information about an implementation's floating-point arithmetic. +.sp +.LP +The following parameters are used to define the model for each floating-point +type: +.sp +.ne 2 +.mk +.na +\fB\fIs\fR\fR +.ad +.RS 6n +.rt +sign (\(+-1) +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIb\fR\fR +.ad +.RS 6n +.rt +base or radix of exponent representation (an integer >1) +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIe\fR\fR +.ad +.RS 6n +.rt +exponent (an integer between a minimum e(min) and a maximum e(max)) +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIp\fR\fR +.ad +.RS 6n +.rt +precision (the number of base-\fIb\fR digits in the significand) +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIf\fR(\fIk\fR)\fR +.ad +.RS 6n +.rt +non-negative integers less than \fIb\fR (the significand digits) +.RE + +.sp +.LP +In addition to normalized floating-point numbers (\fIf\fR(1)>0 if +\fIx\fR\(!=0), floating types might be able to contain other kinds of +floating-point numbers, such as subnormal floating-point numbers (x\(!=0, +e=e(min), f(1)=0) and unnormalized floating-point numbers (x\(!=0, e=e(min), +f(1)=0), and values that are not floating-point numbers, such as infinities and +NaNs. A \fBNaN\fR is an encoding signifying Not-a-Number. A \fBquiet NaN\fR +propagates through almost every arithmetic operation without raising a +floating-point exception; a \fBsignaling NaN\fR generally raises a +floating-point exception when occurring as an arithmetic operand. +.sp +.LP +The accuracy of the library functions in \fBmath.h\fR(3HEAD) and +\fBcomplex.h\fR(3HEAD) that return floating-point results is defined on the +\fBlibm\fR(3LIB) manual page. +.sp +.LP +All integer values in the <\fBfloat.h\fR> header, except \fBFLT_ROUNDS\fR, are +constant expressions suitable for use in \fB#if\fR preprocessing directives; +all floating values are constant expressions. All except \fBDECIMAL_DIG\fR, +\fBFLT_EVAL_METHOD\fR, \fBFLT_RADIX\fR, and \fBFLT_ROUNDS\fR have separate +names for all three floating-point types. The floating-point model +representation is provided for all values except \fBFLT_EVAL_METHOD\fR and +\fBFLT_ROUNDS\fR. +.sp +.LP +The rounding mode for floating-point addition is characterized by the value of +\fBFLT_ROUNDS\fR: +.sp +.ne 2 +.mk +.na +\fB\fB-1\fR\fR +.ad +.RS 6n +.rt +Indeterminable. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB0\fR\fR +.ad +.RS 6n +.rt +Toward zero. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB1\fR\fR +.ad +.RS 6n +.rt +To nearest. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB2\fR\fR +.ad +.RS 6n +.rt +Toward positive infinity. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB3\fR\fR +.ad +.RS 6n +.rt +Toward negative infinity. +.RE + +.sp +.LP +The values of operations with floating operands and values subject to the usual +arithmetic conversions and of floating constants are evaluated to a format +whose range and precision might be greater than required by the type. The use +of evaluation formats is characterized by the architecture-dependent value of +\fBFLT_EVAL_METHOD\fR: +.sp +.ne 2 +.mk +.na +\fB\fB-1\fR\fR +.ad +.RS 6n +.rt +Indeterminable. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB0\fR\fR +.ad +.RS 6n +.rt +Evaluate all operations and constants just to the range and precision of the +type. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB1\fR\fR +.ad +.RS 6n +.rt +Evaluate operations and constants of type float and double to the range and +precision of the double type; evaluate long double operations and constants to +the range and precision of the long double type. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB2\fR\fR +.ad +.RS 6n +.rt +Evaluate all operations and constants to the range and precision of the long +double type. +.RE + +.sp +.LP +The values given in the following list are defined as constants. +.RS +4 +.TP +.ie t \(bu +.el o +Radix of exponent representation, \fIb\fR. +.sp +.in +2 +.nf +FLT_RADIX +.fi +.in -2 + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Number of base-\fBFLT_RADIX\fR digits in the floating-point significand, +\fIp\fR. +.sp +.in +2 +.nf +FLT_MANT_DIG +DBL_MANT_DIG +LDBL_MANT_DIG +.fi +.in -2 + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Number of decimal digits, \fIn\fR, such that any floating-point number in the +widest supported floating type with \fIp\fR(max) radix \fIb\fR digits can be +rounded to a floating-point number with \fIn\fR decimal digits and back again +without change to the value. +.sp +.in +2 +.nf +DECIMAL_DIG +.fi +.in -2 + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Number of decimal digits, \fIq\fR, such that any floating-point number with +\fIq\fR decimal digits can be rounded into a floating-point number with \fIp\fR +radix \fIb\fR digits and back again without change to the \fIq\fR decimal +digits. +.sp +.in +2 +.nf +FLT_DIG +DBL_DIG +LDBL_DIG +.fi +.in -2 + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Minimum negative integer such that \fBFLT_RADIX\fR raised to that power minus 1 +is a normalized floating-point number, e(min). +.sp +.in +2 +.nf +FLT_MIN_EXP +DBL_MIN_EXP +LDBL_MIN_EXP +.fi +.in -2 + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Minimum negative integer such that 10 raised to that power is in the range of +normalized floating-point numbers. +.sp +.in +2 +.nf +FLT_MIN_10_EXP +DBL_MIN_10_EXP +LDBL_MIN_10_EXP +.fi +.in -2 + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum integer such that \fBFLT_RADIX\fR raised to that power minus 1 is a +representable finite floating-point number, e(max). +.sp +.in +2 +.nf +FLT_MAX_EXP +DBL_MAX_EXP +LDBL_MAX_EXP +.fi +.in -2 + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum integer such that 10 raised to that power is in the range of +representable finite floating-point numbers. +.sp +.in +2 +.nf +FLT_MAX_10_EXP +DBL_MAX_10_EXP +LDBL_MAX_10_EXP +.fi +.in -2 + +.RE +.sp +.LP +The values given in the following list are defined as constant expressions with +values that are greater than or equal to those shown: +.RS +4 +.TP +.ie t \(bu +.el o +Maximum representable finite floating-point number. +.sp +.in +2 +.nf +FLT_MAX +DBL_MAX +LDBL_MAX +.fi +.in -2 + +.RE +.sp +.LP +The values given in the following list are defined as constant expressions with +implementation-defined (positive) values that are less than or equal to those +shown: +.RS +4 +.TP +.ie t \(bu +.el o +The difference between 1 and the least value greater than 1 that is +representable in the given floating-point type, \fIb\fR^1 -\fI p\fR. +.sp +.in +2 +.nf +FLT_EPSILON +DBL_EPSILON +LDBL_EPSILON +.fi +.in -2 + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Minimum normalized positive floating-point number, \fIb\fR^e(min)^-1. +.sp +.in +2 +.nf +FLT_MIN +DBL_MIN +LDBL_MIN +.fi +.in -2 + +.RE +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBcomplex.h\fR(3HEAD), \fBmath.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/floatingpoint.h.3head b/usr/src/man/man3head/floatingpoint.h.3head new file mode 100644 index 0000000000..cb2871f712 --- /dev/null +++ b/usr/src/man/man3head/floatingpoint.h.3head @@ -0,0 +1,252 @@ +'\" te +.\" Copyright (C) 1988 Sun Microsystems, Inc. - All Rights Reserved. +.\" 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 floatingpoint.h 3HEAD "5 Mar 1993" "SunOS 5.11" "Headers" +.SH NAME +floatingpoint.h, floatingpoint \- IEEE floating point definitions +.SH SYNOPSIS +.LP +.nf +#include <floatingpoint.h> +.fi + +.SH DESCRIPTION +.sp +.LP +This file defines constants, types, and functions used to implement standard +floating point according to ANSI/IEEE Std 754-1985. The functions are +implemented in \fBlibc\fR. The included header file <\fBsys/ieeefp.h\fR> +defines certain types of interest to the kernel. +.SS "IEEE Rounding Modes" +.sp +.ne 2 +.mk +.na +\fB\fBfp_direction_type\fR\fR +.ad +.RS 23n +.rt +The type of the IEEE rounding direction mode. Note: the order of enumeration +varies according to hardware. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBfp_precision_type\fR\fR +.ad +.RS 23n +.rt +The type of the IEEE rounding precision mode, which only applies on systems +that support extended precision such as machines based on the Intel 80387 FPU +or the 80486. \fBSIGFPE\fR handling: +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBsigfpe_code_type\fR\fR +.ad +.RS 23n +.rt +The type of a \fBSIGFPE\fR code. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBsigfpe_handler_type\fR\fR +.ad +.RS 23n +.rt +The type of a user-definable \fBSIGFPE\fR exception handler called to handle a +particular \fBSIGFPE\fR code. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSIGFPE_DEFAULT\fR \fR +.ad +.RS 23n +.rt +A macro indicating the default \fBSIGFPE\fR exception handling, namely to +perform the exception handling specified by the user, if any, and otherwise to +dump core using \fBabort\fR(3C). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSIGFPE_IGNORE\fR \fR +.ad +.RS 23n +.rt +A macro indicating an alternate \fBSIGFPE\fR exception handling, namely to +ignore and continue execution. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSIGFPE_ABORT\fR \fR +.ad +.RS 23n +.rt +A macro indicating an alternate \fBSIGFPE\fR exception handling, namely to +abort with a core dump. +.RE + +.SS "IEEE Exception Handling" +.sp +.ne 2 +.mk +.na +\fB\fBN_IEEE_EXCEPTION\fR \fR +.ad +.RS 27n +.rt +The number of distinct IEEE floating-point exceptions. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBfp_exception_type\fR\fR +.ad +.RS 27n +.rt +The type of the \fBN_IEEE_EXCEPTION\fR exceptions. Each exception is given a +bit number. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBfp_exception_field_type\fR\fR +.ad +.RS 27n +.rt +The type intended to hold at least \fBN_IEEE_EXCEPTION\fR bits corresponding to +the IEEE exceptions numbered by \fBfp_exception_type\fR. Thus \fBfp_inexact\fR +corresponds to the least significant bit and \fBfp_invalid\fR to the fifth +least significant bit. Note: some operations may set more than one exception. +.RE + +.SS "IEEE Formats and Classification" +.sp +.ne 2 +.mk +.na +\fB\fBsingle\fR;\|\fBextended\fR;\|\fBquadruple\fR\fR +.ad +.sp .6 +.RS 4n +Definitions of IEEE formats. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBfp_class_type\fR\fR +.ad +.sp .6 +.RS 4n +An enumeration of the various classes of IEEE values and symbols. +.RE + +.SS "IEEE Base Conversion" +.sp +.LP +The functions described under \fBfloating_to_decimal\fR(3C) and +\fBdecimal_to_floating\fR(3C) satisfy not only the \fBIEEE\fR Standard, but +also the stricter requirements of correct rounding for all arguments. +.sp +.ne 2 +.mk +.na +\fB\fBDECIMAL_STRING_LENGTH\fR \fR +.ad +.RS 26n +.rt +The length of a \fBdecimal_string\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBdecimal_string\fR\fR +.ad +.RS 26n +.rt +The digit buffer in a \fBdecimal_record\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBdecimal_record\fR\fR +.ad +.RS 26n +.rt +The canonical form for representing an unpacked decimal floating-point number. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBdecimal_form\fR\fR +.ad +.RS 26n +.rt +The type used to specify fixed or floating binary to decimal conversion. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBdecimal_mode\fR\fR +.ad +.RS 26n +.rt +A struct that contains specifications for conversion between binary and +decimal. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBdecimal_string_form\fR\fR +.ad +.RS 26n +.rt +An enumeration of possible valid character strings representing floating-point +numbers, infinities, or NaNs. +.RE + +.SH FILES +.sp +.LP +\fB/usr/include/sys/ieeefp.h\fR +.SH SEE ALSO +.sp +.LP +\fBabort\fR(3C), \fBdecimal_to_floating\fR(3C), \fBeconvert\fR(3C), +\fBfloating_to_decimal\fR(3C), \fBsigfpe\fR(3C), \fBstring_to_decimal\fR(3C), +\fBstrtod\fR(3C) diff --git a/usr/src/man/man3head/fmtmsg.h.3head b/usr/src/man/man3head/fmtmsg.h.3head new file mode 100644 index 0000000000..cd29c1ae21 --- /dev/null +++ b/usr/src/man/man3head/fmtmsg.h.3head @@ -0,0 +1,281 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 fmtmsg.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +fmtmsg.h, fmtmsg \- message display structures +.SH SYNOPSIS +.LP +.nf +#include <\fBfmtmsg.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBfmtmsg.h\fR> header defines the following macros, which expand to +constant integer expressions: +.sp +.ne 2 +.mk +.na +\fB\fBMM_HARD\fR\fR +.ad +.RS 14n +.rt +Source of the condition is hardware. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_SOFT\fR\fR +.ad +.RS 14n +.rt +Source of the condition is software. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_FIRM\fR\fR +.ad +.RS 14n +.rt +Source of the condition is firmware. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_APPL\fR\fR +.ad +.RS 14n +.rt +Condition detected by application. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_UTIL\fR\fR +.ad +.RS 14n +.rt +Condition detected by utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_OPSYS\fR\fR +.ad +.RS 14n +.rt +Condition detected by operating system. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_RECOVER\fR\fR +.ad +.RS 14n +.rt +Recoverable error. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_NRECOV\fR\fR +.ad +.RS 14n +.rt +Non-recoverable error. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_HALT\fR\fR +.ad +.RS 14n +.rt +Error causing application to halt. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_ERROR\fR\fR +.ad +.RS 14n +.rt +Application has encountered a non-fatal fault. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_WARNING\fR\fR +.ad +.RS 14n +.rt +Application has detected unusual non-error condition. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_INFO\fR\fR +.ad +.RS 14n +.rt +Informative message. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_NOSEV\fR\fR +.ad +.RS 14n +.rt +No severity level provided for the message. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_PRINT\fR\fR +.ad +.RS 14n +.rt +Display message on standard error. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_CONSOLE\fR\fR +.ad +.RS 14n +.rt +Display message on system console. +.RE + +.sp +.LP +The table below indicates the null values and identifiers for \fBfmtmsg\fR(3C) +arguments. The <\fBfmtmsg.h\fR> header defines the macros in the Identifier +column, which expand to constant expressions that expand to expressions of the +type indicated in the Type column: +.sp + +.sp +.TS +tab(); +lw(1.38i) lw(1.38i) lw(1.38i) lw(1.38i) +lw(1.38i) lw(1.38i) lw(1.38i) lw(1.38i) +. +ArgumentTypeNull-ValueIdentifier +\fIlabel\fR\fBchar*\fR\fB(char*) NULL\fR\fBMM_NULLLBL\fR +\fIseverity\fR\fBint\fR\fB0\fR\fBMM_NULLSEV\fR +\fIclass\fR\fBlong\fR\fB0L\fR\fBMM_NULLMC\fR +\fItext\fR\fBchar*\fR\fB(char*) NULL\fR\fBMM_NULLTXT\fR +\fIaction\fR\fBchar*\fR\fB(char*) NULL\fR\fBMM_NULLACT\fR +\fItag\fR\fBchar*\fR\fB(char*) NULL\fR\fBMM_NULLTAG\fR +.TE + +.sp +.LP +The <\fBfmtmsg.h\fR> header also defines the following macros for use as return +values for \fBfmtmsg()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBMM_OK\fR\fR +.ad +.RS 12n +.rt +The function succeeded. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_NOTOK\fR\fR +.ad +.RS 12n +.rt +The function failed completely. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_NOMSG\fR\fR +.ad +.RS 12n +.rt +The function was unable to generate a message on standard error, but otherwise +succeeded. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMM_NOCON\fR\fR +.ad +.RS 12n +.rt +The function was unable to generate a console message, but otherwise succeeded. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBfmtmsg\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/fnmatch.h.3head b/usr/src/man/man3head/fnmatch.h.3head new file mode 100644 index 0000000000..068fc72402 --- /dev/null +++ b/usr/src/man/man3head/fnmatch.h.3head @@ -0,0 +1,98 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 fnmatch.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +fnmatch.h, fnmatch \- filename-matching types +.SH SYNOPSIS +.LP +.nf +#include <\fBfnmatch.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBfnmatch.h\fR> header defines the following constants: +.sp +.ne 2 +.mk +.na +\fB\fBFNM_NOMATCH\fR\fR +.ad +.RS 16n +.rt +The string does not match the specified pattern. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFNM_PATHNAME\fR\fR +.ad +.RS 16n +.rt +Slash in string only matches slash in pattern. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFNM_PERIOD\fR\fR +.ad +.RS 16n +.rt +Leading period in string must be exactly matched by period in pattern. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFNM_NOESCAPE\fR\fR +.ad +.RS 16n +.rt +Disable backslash escaping. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFNM_NOSYS\fR\fR +.ad +.RS 16n +.rt +Reserved. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBfnmatch\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/ftw.h.3head b/usr/src/man/man3head/ftw.h.3head new file mode 100644 index 0000000000..67a8a82602 --- /dev/null +++ b/usr/src/man/man3head/ftw.h.3head @@ -0,0 +1,192 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 ftw.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +ftw.h, ftw \- file tree traversal +.SH SYNOPSIS +.LP +.nf +#include <\fBftw.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBftw.h\fR> header defines the FTW structure that includes the following +members: +.sp +.in +2 +.nf +int base +int level +.fi +.in -2 + +.sp +.LP +The <\fBftw.h\fR> header defines macros for use as values of the third +argument to the application-supplied function that is passed as the second +argument to \fBftw()\fR and \fBnftw()\fR (see \fBftw\fR(3C)): +.sp +.ne 2 +.mk +.na +\fB\fBFTW_F\fR\fR +.ad +.RS 11n +.rt +file +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFTW_D\fR\fR +.ad +.RS 11n +.rt +directory +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFTW_DNR\fR\fR +.ad +.RS 11n +.rt +directory without read permission +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFTW_DP\fR\fR +.ad +.RS 11n +.rt +directory with subdirectories visited +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFTW_NS\fR\fR +.ad +.RS 11n +.rt +unknown type; \fBstat()\fR failed +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFTW_SL\fR\fR +.ad +.RS 11n +.rt +symbolic link +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFTW_SLN\fR\fR +.ad +.RS 11n +.rt +symbolic link that names a nonexistent file +.RE + +.sp +.LP +The <\fBftw.h\fR> header defines macros for use as values of the fourth +argument to \fBnftw()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBFTW_PHYS\fR\fR +.ad +.RS 13n +.rt +Physical walk, does not follow symbolic links. Otherwise, \fBnftw()\fR follows +links but does not walk down any path that crosses itself. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFTW_MOUNT\fR\fR +.ad +.RS 13n +.rt +The walk does not cross a mount point. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFTW_DEPTH\fR\fR +.ad +.RS 13n +.rt +All subdirectories are visited before the directory itself. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFTW_CHDIR\fR\fR +.ad +.RS 13n +.rt +The walk changes to each direct ory before reading it. +.RE + +.sp +.LP +The <\fBftw.h\fR> header defines the \fBstat\fR structure and the symbolic +names for \fBst_mode\fR and the file type test macros as described in +<\fBsys/stat.h\fR>. +.sp +.LP +Inclusion of the <\fBftw.h\fR> header might also make visible all symbols from +<\fBsys/stat.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBftw\fR(3C), \fBstat.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/glob.h.3head b/usr/src/man/man3head/glob.h.3head new file mode 100644 index 0000000000..4ac9d2d098 --- /dev/null +++ b/usr/src/man/man3head/glob.h.3head @@ -0,0 +1,188 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 glob.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +glob.h, glob \- pathname pattern-matching types +.SH SYNOPSIS +.LP +.nf +#include <\fBglob.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBglob.h\fR> header defines the structures and symbolic constants used by +the \fBglob\fR(3C). +.sp +.LP +The structure type \fBglob_t\fR contains the following members: +.sp +.in +2 +.nf +size_t gl_pathc /* count of paths matched by pattern */ +char **gl_pathv /* pointer to a list of matched + pathnames */ +size_t gl_offs /* lots to reserve at the beginning + of gl_pathv */ +.fi +.in -2 + +.sp +.LP +The following constants are provided as values for the \fBflags\fR argument: +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_APPEND\fR\fR +.ad +.RS 17n +.rt +Append generated pathnames to those previously obtained. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_DOOFFS\fR\fR +.ad +.RS 17n +.rt +Specify how many null pointers to add to the beginning of \fBgl_pathv\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_ERR\fR\fR +.ad +.RS 17n +.rt +Cause \fBglob()\fR to return on error. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_MARK\fR\fR +.ad +.RS 17n +.rt +Each pathname that is a directory that matches pattern has a slash appended. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_NOCHECK\fR\fR +.ad +.RS 17n +.rt +If pattern does not match any pathname, then return a list consisting of only +pattern. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_NOESCAPE\fR\fR +.ad +.RS 17n +.rt +Disable backslash escaping. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_NOSORT\fR\fR +.ad +.RS 17n +.rt +Do not sort the pathnames returned. +.RE + +.sp +.LP +The following constants are defined as error return values: +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_ABORTED\fR\fR +.ad +.RS 16n +.rt +The scan was stopped because \fBGLOB_ERR\fR was set or \fB(*errfunc)()\fR +returned non-zero. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_NOMATCH\fR\fR +.ad +.RS 16n +.rt +The pattern does not match any existing pathname, and \fBGLOB_NOCHECK\fR was +not set in flags. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_NOSPACE\fR\fR +.ad +.RS 16n +.rt +An attempt to allocate memory failed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGLOB_NOSYS\fR\fR +.ad +.RS 16n +.rt +Reserved. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBglob\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/grp.h.3head b/usr/src/man/man3head/grp.h.3head new file mode 100644 index 0000000000..db3d2f6dbf --- /dev/null +++ b/usr/src/man/man3head/grp.h.3head @@ -0,0 +1,59 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 grp.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +grp.h, grp \- group structure +.SH SYNOPSIS +.LP +.nf +#include <\fBgrp.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBgrp.h\fR> header declares the structure \fBgroup\fR, which includes the +following members: +.sp +.in +2 +.nf +char *gr_name /* name of the group */ +gid_t gr_gid /* numerical group ID */ +char **gr_mem /* pointer to a null-terminated array of + character pointers to member names */ +.fi +.in -2 + +.sp +.LP +The \fBgid_t\fR type is defined as described in <\fBsys/types.h\fR> (see +\fBtypes\fR(3HEAD)). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetgrnam\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/iconv.h.3head b/usr/src/man/man3head/iconv.h.3head new file mode 100644 index 0000000000..5ca72442cb --- /dev/null +++ b/usr/src/man/man3head/iconv.h.3head @@ -0,0 +1,55 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 iconv.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +iconv.h, iconv \- codeset conversion facility +.SH SYNOPSIS +.LP +.nf +#include <\fBiconv.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBiconv.h\fR> header defines the following type: +.sp +.ne 2 +.mk +.na +\fB\fBiconv_t\fR\fR +.ad +.RS 11n +.rt +Identifies the conversion from one codeset to another. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBiconv\fR(3C), \fBiconv_close\fR(3C), \fBiconv_open\fR(3C), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/if.h.3head b/usr/src/man/man3head/if.h.3head new file mode 100644 index 0000000000..3d96b4c442 --- /dev/null +++ b/usr/src/man/man3head/if.h.3head @@ -0,0 +1,67 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 if.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +if.h, if \- sockets local interfaces +.SH SYNOPSIS +.LP +.nf +#include <\fBnet/if.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBnet/if.h\fR> header defines the \fBif_nameindex\fR structure, which +includes the following members: +.sp +.in +2 +.nf +unsigned if_index /* numeric index of the interface */ +char *if_name /* null-terminated name of the interface */ +.fi +.in -2 + +.sp +.LP +The <\fBnet/if.h\fR> header defines the following macro for the length of a +buffer containing an interface name (including the terminating null character): +.sp +.ne 2 +.mk +.na +\fB\fBIF_NAMESIZE\fR\fR +.ad +.RS 15n +.rt +interface name length +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBif_nametoindex\fR(3XNET), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/in.h.3head b/usr/src/man/man3head/in.h.3head new file mode 100644 index 0000000000..37f4d54a41 --- /dev/null +++ b/usr/src/man/man3head/in.h.3head @@ -0,0 +1,198 @@ +'\" te +.\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 in.h 3HEAD "30 Aug 2002" "SunOS 5.11" "Headers" +.SH NAME +in.h, in \- Internet Protocol family +.SH SYNOPSIS +.LP +.nf +#include <netinet/in.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBnetinet/in.h\fR> header defines the following types through +\fBtypedef\fR: +.sp +.ne 2 +.mk +.na +\fB\fBin_port_t\fR\fR +.ad +.RS 13n +.rt +An unsigned integral type of exactly 16 bits. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBin_addr_t\fR\fR +.ad +.RS 13n +.rt +An unsigned integral type of exactly 32 bits. The <\fBnetinet/in.h\fR> header +defines the \fBin_addr\fR structure that includes the following member: +.RE + +.sp +.LP +The <\fBnetinet/in.h\fR> header defines the \fBin_addr\fR structure that +includes the following member: +.sp +.in +2 +.nf +in_addr_t s_addr +.fi +.in -2 + +.sp +.LP +The <\fBnetinet/in.h\fR> header defines the type \fBsa_family_t\fR as described +in \fBsocket.h\fR(3HEAD). +.sp +.LP +The <\fBnetinet/in.h\fR> header defines the following macros for use as values +of the \fIlevel\fR argument of \fBgetsockopt()\fR and \fBsetsockopt()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IP\fR \fR +.ad +.RS 21n +.rt +Dummy for \fBIP\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_ICMP\fR \fR +.ad +.RS 21n +.rt +Control message protocol +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_TCP\fR \fR +.ad +.RS 21n +.rt +\fBTCP\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_UDP\fR \fR +.ad +.RS 21n +.rt +User datagram protocol The <\fBnetinet/in.h\fR> header defines the following +macros for use as destination addresses for \fBconnect()\fR, \fBsendmsg()\fR, +and \fBsendto()\fR: +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBINADDR_ANY\fR \fR +.ad +.RS 21n +.rt +Local host address +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBINADDR_BROADCAST\fR \fR +.ad +.RS 21n +.rt +Broadcast address +.RE + +.sp +.LP +The <\fBnetinet/in.h\fR> header defines the \fBsockaddr_in\fR structure that is +used to store addresses for the Internet protocol family. Values of this type +must be cast to \fBstruct sockaddr\fR for use with the socket interfaces. +.SS "Default" +.sp +.LP +For applications that do not require standard-conforming behavior (those that +use the socket interfaces described in section (3SOCKET) of the reference +manual; see \fBIntro\fR(3) and \fBstandards\fR(5)), the <\fBnetinet/in.h\fR> +header defines the \fBsockaddr_in\fR structure that includes the following +members: +.sp +.in +2 +.nf +sa_family_t sin_family +in_port_t sin_port +struct in_addr sin_addr +char sin_zero[8] +.fi +.in -2 + +.SS "Standard conforming" +.sp +.LP +For applications that require standard-conforming behavior (those that use the +socket interfaces described in section (3XNET) of the reference manual; see +\fBIntro\fR(3) and \fBstandards\fR(5)), the <\fBnetinet/in.h\fR> header defines +the \fBsockaddr_in\fR structure that includes the following members: +.sp +.in +2 +.nf +sa_family_t sin_family +in_port_t sin_port +struct in_addr sin_addr +unsigned char sin_zero[8] +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBIntro\fR(3), \fBconnect\fR(3SOCKET), \fBconnect\fR(3XNET), +\fBgetsockopt\fR(3SOCKET), \fBgetsockopt\fR(3XNET), \fBsendmsg\fR(3SOCKET), +\fBsendmsg\fR(3XNET), \fBsendto\fR(3SOCKET), \fBsendto\fR(3XNET), +\fBsetsockopt\fR(3SOCKET), \fBsetsockopt\fR(3XNET), \fBsocket.h\fR(3HEAD), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/inet.h.3head b/usr/src/man/man3head/inet.h.3head new file mode 100644 index 0000000000..7c3c1e3204 --- /dev/null +++ b/usr/src/man/man3head/inet.h.3head @@ -0,0 +1,100 @@ +'\" te +.\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 inet.h 3HEAD "30 Aug 2002" "SunOS 5.11" "Headers" +.SH NAME +inet.h, inet \- definitions for internet operations +.SH SYNOPSIS +.LP +.nf +\fB#include <arpa/inet.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBarpa/inet.h\fR> header defines the type \fBin_port_t\fR, the type +\fBin_addr_t\fR, and the \fBin_addr\fR structure, as described in +\fBin.h\fR(3HEAD). +.sp +.LP +Inclusion of the <\fBarpa/inet.h\fR> header may also make visible all symbols +from \fBin.h\fR(3HEAD). +.sp +.LP +The following are declared as functions, and may also be defined as macros: +.sp +.in +2 +.nf +in_addr_t inet_addr(const char *); +in_addr_t inet_lnaof(struct in_addr); +struct in_addr inet_makeaddr(in_addr_t, in_addr_t); +in_addr_t inet_netof(struct in_addr); +in_addr_t inet_network(const char *); +char *inet_ntoa(struct in_addr); +.fi +.in -2 + +.SS "Default" +.sp +.LP +For applications that do not require standard-conforming behavior (those that +use the socket interfaces described in section 3N of the reference manual; see +\fBIntro\fR(3) and \fBstandards\fR(5)), the following may be declared as +functions, or defined as macros, or both: +.sp +.in +2 +.nf +uint32_t htonl(uint32_t); +uint16_t htons(uint16_t); +uint32_t ntohl(uint32_t); +uint16_t ntohs(uint16_t); +.fi +.in -2 + +.SS "Standard conforming" +.sp +.LP +For applications that require standard-conforming behavior (those that use the +socket interfaces described in section 3XN of the reference manual; see +\fBIntro\fR(3) and \fBstandards\fR(5)), the following may be declared as +functions, or defined as macros, or both: +.sp +.in +2 +.nf +in_addr_t htonl(in_addr_t); +in_port_t htons(in_port_t); +in_addr_t ntohl(in_addr_t); +in_port_t ntohs(in_port_t); +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBIntro\fR(3), \fBhtonl\fR(3SOCKET), \fBhtonl\fR(3XNET), +\fBinet_addr\fR(3SOCKET), \fBinet_addr\fR(3XNET), \fBin.h\fR(3HEAD), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/inttypes.h.3head b/usr/src/man/man3head/inttypes.h.3head new file mode 100644 index 0000000000..26c583ea23 --- /dev/null +++ b/usr/src/man/man3head/inttypes.h.3head @@ -0,0 +1,157 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 inttypes.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +inttypes.h, inttypes \- fixed size integer types +.SH SYNOPSIS +.LP +.nf +#include <\fBinttypes.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBinttypes.h\fR> header includes the <\fBstdint.h\fR> header. +.sp +.LP +The <\fBinttypes.h\fR> header includes a definition of the following type: +.sp +.ne 2 +.mk +.na +\fB\fBimaxdiv_t\fR\fR +.ad +.RS 13n +.rt +structure type that is the type of the value returned by the \fBimaxdiv()\fR +function. +.RE + +.sp +.LP +The following macros are defined. Each expands to a character string literal +containing a conversion specifier, possibly modified by a length modifier, +suitable for use within the format argument of a formatted input/output +function when converting the corresponding integer type. These macros have the +general form of \fBPRI\fR (character string literals for the \fBfprintf()\fR +and \fBfwprintf()\fR family of functions) or \fBSCN\fR (character string +literals for the \fBfscanf()\fR and \fBfwscanf()\fR family of functions), +followed by the conversion specifier, followed by a name corresponding to a +similar type name in <\fBstdint.h\fR>. In these names, \fIN\fR represents the +width of the type as described in <\fBstdint.h\fR>. For example, +\fBPRIdFAST32\fR can be used in a format string to print the value of an +integer of type \fBint_fast32_t\fR. +.sp +.LP +The \fBfprintf()\fR macros for signed integers are: +.sp +.in +2 +.nf +PRId\fIN\fR PRIdLEAST\fIN\fR PRIdFAST\fIN\fR PRIdMAX PRIdPTR +PRIi\fIN\fR PRIiLEAST\fIN\fR PRIiFAST\fIN\fR PRIiMAX PRIiPTR +.fi +.in -2 + +.sp +.LP +The \fBfprintf()\fR macros for unsigned integers are: +.sp +.in +2 +.nf +PRIo\fIN\fR PRIoLEAST\fIN\fR PRIoFAST\fIN\fR PRIoMAX PRIoPTR +PRIu\fIN\fR PRIuLEAST\fIN\fR PRIuFAST\fIN\fR PRIuMAX PRIuPTR +PRIx\fIN\fR PRIxLEAST\fIN\fR PRIxFAST\fIN\fR PRIxMAX PRIxPTR +PRIX\fIN\fR PRIXLEAST\fIN\fR PRIXFAST\fIN\fR PRIXMAX PRIXPTR +.fi +.in -2 + +.sp +.LP +The \fBfscanf()\fR macros for signed integers are: +.sp +.in +2 +.nf +SCNd\fIN\fR SCNdLEAST\fIN\fR SCNdFAST\fIN\fR SCNdMAX SCNdPTR +SCNi\fIN\fR SCNiLEAST\fIN\fR SCNiFAST\fIN\fR SCNiMAX SCNiPTR +.fi +.in -2 + +.sp +.LP +The \fBfscanf()\fR macros for unsigned integers are: +.sp +.in +2 +.nf +SCNo\fIN\fR SCNoLEAST\fIN\fR SCNoFAST\fIN\fR SCNoMAX SCNoPTR +SCNu\fIN\fR SCNuLEAST\fIN\fR SCNuFAST\fIN\fR SCNuMAX SCNuPTR +SCNx\fIN\fR SCNxLEAST\fIN\fR SCNxFAST\fIN\fR SCNxMAX SCNxPTR +.fi +.in -2 + +.sp +.LP +For each type that the implementation provides in <\fBstdint.h\fR>, the +corresponding \fBfprintf()\fR and \fBfwprintf()\fR macros must be defined. The +corresponding \fBfscanf()\fR and \fBfwscanf()\fR macros must be defined as +well, unless the implementation does not have a suitable modifier for the type. +.SH USAGE +.sp +.LP +The purpose of <\fBinttypes.h\fR> is to provide a set of integer types whose +definitions are consistent across machines and independent of operating systems +and other implementation idiosyncrasies. It defines, with a \fBtypedef\fR, +integer types of various sizes. Implementations are free to \fBtypedef\fR them +as ISO C standard integer types or extensions that they support. Consistent use +of this header greatly increases the portability of applications across +platforms. +.SH EXAMPLES +.LP +\fBExample 1 \fRUse of Macro +.sp +.LP +The following code uses one of the macros available through <\fBinttypes.h\fR>. + +.sp +.in +2 +.nf +#include <inttypes.h> +#include <wchar.h> +int main(void) +{ + uintmax_t i = UINTMAX_MAX; // This type always exists. + wprintf("The largest integer value is %020" + PRIxMAX, "\en", i); + return 0; +} +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBimaxdiv\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/ipc.h.3head b/usr/src/man/man3head/ipc.h.3head new file mode 100644 index 0000000000..c00c4f79a0 --- /dev/null +++ b/usr/src/man/man3head/ipc.h.3head @@ -0,0 +1,153 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 ipc.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +ipc.h, ipc \- XSI interprocess communication access structure +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/ipc.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/ipc.h\fR> header is used by three mechanisms for interprocess +communication (IPC): messages, semaphores, and shared memory. All use a common +structure type, \fBipc_perm\fR, to pass information used in determining +permission to perform an IPC operation. +.sp +.LP +The \fBipc_perm\fR structure contains the following members: +.sp +.in +2 +.nf +uid_t uid /* owner's user ID */ +gid_t gid /* owner's group ID */ +uid_t cuid /* creator's user ID */ +gid_t cgid /* creator's group ID */ +mode_t mode /* read/write permission +.fi +.in -2 + +.sp +.LP +The \fBuid_t\fR, \fBgid_t\fR, \fBmode_t\fR, and \fBkey_t\fR types are defined +as described in <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD). +.sp +.LP +Definitions are provided for the constants listed below. +.sp +.LP +Mode bits: +.sp +.ne 2 +.mk +.na +\fB\fBIPC_CREAT\fR\fR +.ad +.RS 14n +.rt +Create entry if key does not exist. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPC_EXCL\fR\fR +.ad +.RS 14n +.rt +Fail if key exists. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPC_NOWAIT\fR\fR +.ad +.RS 14n +.rt +Error if request must wait. +.RE + +.sp +.LP +Keys: +.sp +.ne 2 +.mk +.na +\fB\fBIPC_PRIVATE\fR\fR +.ad +.RS 15n +.rt +Private key. +.RE + +.sp +.LP +Control commands: +.sp +.ne 2 +.mk +.na +\fB\fBIPC_RMID\fR\fR +.ad +.RS 12n +.rt +Remove identifier. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPC_SET\fR\fR +.ad +.RS 12n +.rt +Set options. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPC_STAT\fR\fR +.ad +.RS 12n +.rt +Get options. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBftok\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/iso646.h.3head b/usr/src/man/man3head/iso646.h.3head new file mode 100644 index 0000000000..f9d60c07c5 --- /dev/null +++ b/usr/src/man/man3head/iso646.h.3head @@ -0,0 +1,165 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 iso646.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +iso646.h, iso646 \- alternative spellings +.SH SYNOPSIS +.LP +.nf +#include <\fBiso646.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBiso646.h\fR> header defines the following macros (on the left) that +expand to the corresponding tokens (on the right): +.sp +.ne 2 +.mk +.na +\fB\fBand\fR\fR +.ad +.RS 10n +.rt +\fB&&\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBand_eq\fR\fR +.ad +.RS 10n +.rt +\fB&=\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBbitand\fR\fR +.ad +.RS 10n +.rt +\fB&\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBbitor\fR\fR +.ad +.RS 10n +.rt +\fB|\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBcompl\fR\fR +.ad +.RS 10n +.rt +\fB~\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBnot\fR\fR +.ad +.RS 10n +.rt +\fB!\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBnot_eq\fR\fR +.ad +.RS 10n +.rt +\fB!=\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBor\fR\fR +.ad +.RS 10n +.rt +\fB||\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBor_eq\fR\fR +.ad +.RS 10n +.rt +\fB|=\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBxor\fR\fR +.ad +.RS 10n +.rt +\fB^\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBxor_eq\fR\fR +.ad +.RS 10n +.rt +\fB^=\fR +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/langinfo.h.3head b/usr/src/man/man3head/langinfo.h.3head new file mode 100644 index 0000000000..3b79e1fe21 --- /dev/null +++ b/usr/src/man/man3head/langinfo.h.3head @@ -0,0 +1,229 @@ +'\" te +.\" Copyright 1989 AT&T. Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved. +.\" 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 langinfo.h 3HEAD "30 Aug 2002" "SunOS 5.11" "Headers" +.SH NAME +langinfo.h, langinfo \- language information constants +.SH SYNOPSIS +.LP +.nf +#include <langinfo.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBlanginfo.h\fR> header contains the constants used to identify items of +\fBlanginfo\fR data (see \fBnl_langinfo\fR(3C)). The type of the constant, +\fBnl_item\fR, is defined as described in <\fBnl_types.h\fR>. +.sp +.LP +The following constants are defined. The entries under Category indicate in +which \fBsetlocale\fR(3C) category each item is defined. +.sp + +.sp +.TS +tab(); +cw(1.42i) |cw(1.42i) |cw(2.66i) +lw(1.42i) |lw(1.42i) |lw(2.66i) +. +ConstantCategoryMeaning +_ +\fBCODESET\fR\fBLC_CTYPE\fRcodeset name +_ +\fBD_T_FMT\fR\fBLC_TIME\fRstring for formatting date and time +_ +\fBD_FMT\fR\fBLC_TIME\fRdate format string +_ +\fBT_FMT\fR\fBLC_TIME\fRtime format string +_ +\fBT_FMT_AMPM\fR\fBLC_TIME\fRa.m. or p.m. time format string +_ +\fBAM_STR\fR\fBLC_TIME\fRante-meridiem affix +_ +\fBPM_STR\fR\fBLC_TIME\fRpost-meridiem affix +_ +\fBDAY_1\fR\fBLC_TIME\fRT{ +name of the first day of the week (for example, Sunday) +T} +_ +\fBDAY_2\fR\fBLC_TIME\fRT{ +name of the second day of the week (for example, Monday) +T} +_ +\fBDAY_3\fR\fBLC_TIME\fRT{ +name of the third day of the week (for example, Tuesday) +T} +_ +\fBDAY_4\fR\fBLC_TIME\fRT{ +name of the fourth day of the week (for example, Wednesday) +T} +_ +\fBDAY_5\fR\fBLC_TIME\fRT{ +name of the fifth day of the week (for example, Thursday) +T} +_ +\fBDAY_6\fR\fBLC_TIME\fRT{ +name of the sixth day of the week (for example, Friday) +T} +_ +\fBDAY_7\fR\fBLC_TIME\fRT{ +name of the seventh day of the week (for example, Saturday) +T} +_ +\fBABDAY_1\fR\fBLC_TIME\fRT{ +abbreviated name of the first day of the week +T} +_ +\fBABDAY_2\fR\fBLC_TIME\fRT{ +abbreviated name of the second day of the week +T} +_ +\fBABDAY_3\fR\fBLC_TIME\fRT{ +abbreviated name of the third day of the week +T} +_ +\fBABDAY_4\fR\fBLC_TIME\fRT{ +abbreviated name of the fourth day of the week +T} +_ +\fBABDAY_5\fR\fBLC_TIME\fRT{ +abbreviated name of the fifth day of the week +T} +_ +\fBABDAY_6\fR\fBLC_TIME\fRT{ +abbreviated name of the seventh day of the week +T} +_ +\fBABDAY_7\fR\fBLC_TIME\fRT{ +abbreviated name of the seventh day of the week +T} +_ +\fBMON_1\fR\fBLC_TIME\fRname of the first month of the year +_ +\fBMON_2\fR\fBLC_TIME\fRname of the second month +_ +\fBMON_3\fR\fBLC_TIME\fRname of the third month +_ +\fBMON_4\fR\fBLC_TIME\fRname of the fourth month +_ +\fBMON_5\fR\fBLC_TIME\fRname of the fifth month +_ +\fBMON_6\fR\fBLC_TIME\fRname of the sixth month +_ +\fBMON_7\fR\fBLC_TIME\fRname of the seventh month +_ +\fBMON_8\fR\fBLC_TIME\fRname of the eighth month +_ +\fBMON_9\fR\fBLC_TIME\fRname of the ninth month +_ +\fBMON_10\fR\fBLC_TIME\fRname of the tenth month +_ +\fBMON_11\fR\fBLC_TIME\fRname of the eleventh month +_ +\fBMON_12\fR\fBLC_TIME\fRname of the twelfth month +_ +\fBABMON_1\fR\fBLC_TIME\fRabbreviated name of the first month +_ +\fBABMON_2\fR\fBLC_TIME\fRabbreviated name of the second month +_ +\fBABMON_3\fR\fBLC_TIME\fRabbreviated name of the third month +_ +\fBABMON_4\fR\fBLC_TIME\fRabbreviated name of the fourth month +_ +\fBABMON_5\fR\fBLC_TIME\fRabbreviated name of the fifth month +_ +\fBABMON_6\fR\fBLC_TIME\fRabbreviated name of the sixth month +_ +\fBABMON_7\fR\fBLC_TIME\fRabbreviated name of the seventh month +_ +\fBABMON_8\fR\fBLC_TIME\fRabbreviated name of the eighth month +_ +\fBABMON_9\fR\fBLC_TIME\fRabbreviated name of the ninth month +_ +\fBABMON_10\fR\fBLC_TIME\fRabbreviated name of the tenth month +_ +\fBABMON_11\fR\fBLC_TIME\fRabbreviated name of the eleventh month +_ +\fBABMON_12\fR\fB LC_TIME\fRabbreviated name of the twelfth month +_ +\fBERA\fR\fBLC_TIME\fRera description segments +_ +\fBERA_D_FMT\fR\fBLC_TIME\fRera date format string +_ +\fBERA_D_T_FMT\fR\fBLC_TIME\fRera date and time format string +_ +\fBERA_T_FMT\fR\fBLC_TIME\fRera time format string +_ +\fBALT_DIGITS\fR\fBLC_TIME\fRalternative symbols for digits +_ +\fBRADIXCHAR\fR\fBLC_NUMERIC\fRradix character +_ +\fBTHOUSEP\fR\fBLC_NUMERIC\fRseparator for thousands +_ +\fBYESEXPR\fR\fBLC_MESSAGES\fRaffirmative response expression +_ +\fBNOEXPR\fR\fBLC_MESSAGES\fRnegative response expression +_ +\fBYESSTR\fR\fBLC_MESSAGES\fRaffirmative response for yes/no queries +_ +\fBNOSTR\fR\fBLC_MESSAGES\fRnegative response ro yes/no queries +_ +\fBCRNCYSTR\fR\fBLC_MONETARY\fRT{ +local currency symbol, preceded by '-' if the symbol sould appear before the value, '+' if the symbol should appear after the value, or '.' if the symbol should replace the radix character +T} +.TE + +.sp +.LP +If the locale's values for \fBp_cs_precedes\fR and \fBn_cs_precedes\fR do not +match, the value of \fBnl_langinfo(CRNCYSTR)\fR is unspecified. +.sp +.LP +The <\fBlanginfo.h\fR> header declares the following as a function: +.sp +.in +2 +.nf +char *nl_langinfo(nl_item); +.fi +.in -2 + +.sp +.LP +Inclusion of <\fBlanginfo.h\fR> header may also make visible all symbols from +<\fBnl_types.h\fR>. +.SH USAGE +.sp +.LP +Wherever possible, users are advised to use functions compatible with those in +the ISO C standard to access items of \fBlanginfo\fR data. In particular, the +\fBstrftime\fR(3C) function should be used to access date and time information +defined in category \fBLC_TIME\fR. The \fBlocaleconv\fR(3C) function should be +used to access information corresponding to \fBRADIXCHAR\fR, \fBTHOUSEP\fR, and +\fBCRNCYSTR\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBmkmsgs\fR(1), \fBlocaleconv\fR(3C), \fBnl_langinfo\fR(3C), +\fBnl_types.h\fR(3HEAD), \fBsetlocale\fR(3C), \fBstrftime\fR(3C), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/libgen.h.3head b/usr/src/man/man3head/libgen.h.3head new file mode 100644 index 0000000000..b0c9b46f9a --- /dev/null +++ b/usr/src/man/man3head/libgen.h.3head @@ -0,0 +1,45 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 libgen.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +libgen.h, libgen \- definitions for pattern matching functions +.SH SYNOPSIS +.LP +.nf +#include <\fBlibgen.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBlibgen.h\fR> header lists definitions used for string pattern-matching +and pathname manipulation. See \fBlibgen\fR(3LIB). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBbasename\fR(3C), \fBdirname\fR(3C), \fBlibgen\fR(3LIB), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/libintl.h.3head b/usr/src/man/man3head/libintl.h.3head new file mode 100644 index 0000000000..184324d413 --- /dev/null +++ b/usr/src/man/man3head/libintl.h.3head @@ -0,0 +1,51 @@ +'\" te +.\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved. +.\" 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 libintl.h 3HEAD "20 May 2008" "SunOS 5.11" "Headers" +.SH NAME +libintl.h, libintl \- international messaging +.SH SYNOPSIS +.LP +.nf +#include <libintl.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The \fB<libintl.h>\fR header provides the following macro: +.sp +.ne 2 +.mk +.na +\fB\fBGNU_GETTEXT_SUPPORTED_REVISION\fR(major)\fR +.ad +.sp .6 +.RS 4n +This macro returns the maximum minor revision number supported for the +specified major revision of the GNU MO file format. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityUncommitted +.TE + +.SH SEE ALSO +.sp +.LP +\fBgettext\fR(3C), \fBattributes\fR(5) diff --git a/usr/src/man/man3head/limits.h.3head b/usr/src/man/man3head/limits.h.3head new file mode 100644 index 0000000000..e41ec301e3 --- /dev/null +++ b/usr/src/man/man3head/limits.h.3head @@ -0,0 +1,1810 @@ +'\" te +.\" Copyright 1989 AT&T. Copyright (c) 2004 Sun Microsystems, Inc. All Rights Reserved. +.\" 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 limits.h 3HEAD "8 April 2004" "SunOS 5.11" "Headers" +.SH NAME +limits.h, limits \- implementation-defined constants +.SH SYNOPSIS +.LP +.nf +\fB#include <limits.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBlimits.h\fR> header defines various symbolic names. Different +categories of names are described below. +.sp +.LP +The names represent various limits on resources that the implementation imposes +on applications. Symbolic constant names beginning with _POSIX can be found in +\fBunistd.h\fR(3HEAD). +.sp +.LP +Applications should not assume any particular value for a limit. An application +wishing to avail itself of the full amount of a resource available on an +implementation can make use of the value given in limits.h on that particular +implementation by using the symbolic names listed below. Many of the listed +limits are not invariant, and at runtime, the value of the limit might differ +from those given in this header, for the following reasons: +.RS +4 +.TP +.ie t \(bu +.el o +The limit is pathname-dependent. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +The limit differs between the compile and runtime machines. +.RE +.sp +.LP +For these reasons, an application can use the \fBfpathconf\fR(2), +\fBpathconf\fR(2), and \fBsysconf\fR(3C) functions to determine the actual +value of a limit at runtime. +.SS "Runtime Invariant Values (Possibly Indeterminate)" +.sp +.ne 2 +.mk +.na +\fB\fBAIO_LISTIO_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of I/O operations in a single list I/O call supported by the +implementation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBAIO_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of outstanding asynchronous I/O operations supported by the +implementation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBAIO_PRIO_DELTA_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The maximum amount by which a process can decrease its asynchronous I/O +priority level from its own scheduling priority. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBARG_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum length of argument to the \fBexec\fR(2) functions including environment +data. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBATEXIT_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of functions that can be registered with \fBatexit\fR(3C). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCHILD_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of simultaneous processes per real user ID. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCLK_TCK\fR\fR +.ad +.sp .6 +.RS 4n +Number of clock ticks per second returned by the \fBtimes\fR(2) function. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBDELAYTIMER_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of timer expiration overruns. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBHOST_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum length of a host name (not including the terminating null) as returned +from the \fBgethostname\fR(3C) function. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIOV_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of \fBiovec\fR structures that one process has available for use +with \fBread\fR(2) or \fBwrite\fR(2). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOGIN_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum length of a login name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMQ_OPEN_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The maximum number of open message queue descriptors a process is allowed to +hold. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOGIN_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum length of a login name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMQ_OPEN_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The maximum number of open message queue descriptors a process is allowed to +hold. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMQ_PRIO_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The maximum number of message priorities supported by the implementation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBOPEN_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of files that one process can have open at any one time. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPAGESIZE\fR\fR +.ad +.sp .6 +.RS 4n +Size in bytes of a page. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPAGE_SIZE\fR\fR +.ad +.sp .6 +.RS 4n +Equivalent to \fBPAGESIZE\fR. If either \fBPAGESIZE\fR or \fBPAGE_SIZE\fR is +defined, the other is defined with the same value. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPASS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The maximum number of significant bytes in a password, not including the +terminating null. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPTHREAD_DESTRUCTOR_ITERATIONS\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of attempts made to destroy a thread's thread-specific data +values on thread exit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPTHREAD_KEYS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of data keys that can be created by a process. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPTHREAD_STACK_MIN\fR\fR +.ad +.sp .6 +.RS 4n +Minimum size in bytes of thread stack storage. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPTHREAD_THREADS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of threads that can be created per process. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRE_DUP_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of repeated occurrences of a BRE permitted by the \fBregexec\fR(3C) +and \fBregcomp\fR(3C) functions when using the interval notation +{\e(\fIm\fR,\fIn\fR\e}. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRTSIG_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of realtime signals reserved for application use in this +implementation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSEM_NSEMS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of semaphores that a process can have. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSEM_VALUE_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The maximum value a semaphore can have. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSIGQUEUE_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of queued signals that a process can send and have pending at +the receiver(s) at any time. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSS_REPL_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The maximum number of replenishment operations that may be simultaneously +pending for a particular sporadic server scheduler. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSTREAM_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of streams that one process can have open at one time. If defined, +it has the same value as \fBFOPEN_MAX\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSYMLOOP_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of symbolic links that can be reliably traversed in the +resolution of a pathname in the absence of a loop. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTIMER_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of timers per process supported by the implementation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTRACE_EVENT_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum length of the trace event name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTRACE_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum length of the trace generation version string or of the trace stream +name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTRACE_SYS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of trace streams that may simultaneously exist in the system. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTRACE_USER_EVENT_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of user trace event type identifiers that may simultaneously +exist in a traced process, including the predefined user trace event +\fBPOSIX_TRACE_UNNAMED_USER_EVENT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTTY_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum length of terminal device name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTZNAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of bytes supported for the name of a timezone (not of the TZ +variable). +.RE + +.SS "Pathname Variable Values" +.sp +.LP +The values in the following list can be constants within an implementation or +can vary from one pathname to another. For example, file systems or directories +can have different characteristics. The value supported for a specific pathname +is provided by the \fBpathconf\fR(2) function. +.sp +.ne 2 +.mk +.na +\fB\fBFILESIZEBITS\fR\fR +.ad +.RS 28n +.rt +Minimum number of bits needed to represent, as a signed integer value, the +maximum size of a regular file allowed in the specified directory. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLINK_MAX\fR\fR +.ad +.RS 28n +.rt +Maximum number of links to a single file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMAX_CANON\fR\fR +.ad +.RS 28n +.rt +Maximum number of bytes in a terminal canonical input line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMAX_INPUT\fR\fR +.ad +.RS 28n +.rt +Minimum number of bytes for which space is available in a terminal input queue; +therefore, the maximum number of bytes a conforming application may require to +be typed as input before reading them. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNAME_MAX\fR\fR +.ad +.RS 28n +.rt +Maximum number of bytes in a filename (not including terminating null). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPATH_MAX\fR\fR +.ad +.RS 28n +.rt +Maximum number of bytes in a pathname, including the terminating null +character. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPIPE_BUF\fR\fR +.ad +.RS 28n +.rt +Maximum number of bytes that is guaranteed to be atomic when writing to a pipe. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOSIX_ALLOC_SIZE_MIN\fR\fR +.ad +.RS 28n +.rt +Minimum number of bytes of storage actually allocated for any portion of a +file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOSIX_REC_INCR_XFER_SIZE\fR\fR +.ad +.RS 28n +.rt +Recommended increment for file transfer sizes between the +\fBPOSIX_REC_MIN_XFER_SIZE\fR and \fBPOSIX_REC_MAX_XFER_SIZE\fR values. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOSIX_REC_MAX_XFER_SIZE\fR\fR +.ad +.RS 28n +.rt +Maximum recommended file transfer size. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOSIX_REC_MIN_XFER_SIZE\fR\fR +.ad +.RS 28n +.rt +Minimum recommended file transfer size. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOSIX_REC_XFER_ALIGN\fR\fR +.ad +.RS 28n +.rt +Recommended file transfer buffer alignment. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSYMLINK_MAX\fR\fR +.ad +.RS 28n +.rt +Maximum number of bytes in a symbolic link. +.RE + +.SS "Runtime Increasable Values" +.sp +.LP +The magnitude limitations in the following list are fixed by specific +implementations. An application should assume that the value supplied by +<\fBlimits.h\fR> in a specific implementation is the minimum that pertains +whenever the application is run under that implementation. A specific instance +of a specific implementation can increase the value relative to that supplied +by <\fBlimits.h\fR> for that implementation. The actual value supported by a +specific instance is provided by the \fBsysconf\fR(3C) function. +.sp +.ne 2 +.mk +.na +\fB\fBBC_BASE_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum obase values allowed by the \fBbc\fR(1) utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBBC_DIM_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of elements permitted in an array by the \fBbc\fR utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBBC_SCALE_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum scale value allowed by the \fBbc\fR utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBBC_STRING_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum length of a string constant accepted by the \fBbc\fR utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCHARCLASS_NAME_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of bytes in a character class name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCOLL_WEIGHTS_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of weights that can be assigned to an entry of the +\fBLC_COLLATE\fR order keyword in the locale definition file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBEXPR_NEST_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of expressions that can be nested within parentheses by the +\fBexpr\fR(1) utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBEXPR_NEST_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of expressions that can be nested within parentheses by the +\fBexpr\fR utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLINE_MAX\fR\fR +.ad +.RS 22n +.rt +Unless otherwise noted, the maximum length, in bytes, of a utility's input line +(either standard input or another file), when the utility is described as +processing text files. The length includes room for the trailing <newline>. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNGROUPS_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of simultaneous supplementary group IDs per process. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRE_DUP_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of repeated occurrences of a regular expression permitted when +using the interval notation \e{\fIm\fR,\fIn\fR\e}. +.RE + +.SS "Maximum Values" +.sp +.LP +The symbolic constants in the following list are symbolic names for the most +restrictive value for certain features on an implementation supporting the +POSIX Timers option. +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_CLOCKRES_MIN\fR\fR +.ad +.RS 23n +.rt +The resolution of the \fBCLOCK_REALTIME\fR clock, in nanoseconds. +.RE + +.SS "Minimum Values" +.sp +.LP +The symbolic constants in the following list are symbolic names for the most +restrictive value for certain features on an implementation conforming to +various POSIX and Single Unix Specification requirements. See +\fBstandards\fR(5). +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_AIO_LISTIO_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of I/O operations that can be specified in a list I/O call. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_AIO_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of outstanding asynchronous I/O operations. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_ARG_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum length of argument to the \fBexec\fR(2) functions including environment +data. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_CHILD_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of simultaneous processes per real user ID. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_DELAYTIMER_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of timer expiration overruns. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_HOST_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum length of a host name (not including the terminating null) as returned +from the \fBgethostname\fR(3C) function. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_LINK_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of links to a single file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_LOGIN_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The size of the storage required for a login name, in bytes, including the +terminating null. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_MAX_CANON\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of bytes in a terminal canonical input queue. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_MAX_INPUT\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of bytes allowed in a terminal input queue. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_MQ_OPEN_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of message queues that can be open for a single process. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_MQ_PRIO_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The maximum number of message priorities supported by the implementation. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of bytes in a filename (not including terminating null). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_NGROUPS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of simultaneous supplementary group IDs per process. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_OPEN_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of files that one process can have open at any one time. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_PATH_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of bytes in a pathname. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_PIPE_BUF\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of bytes that is guaranteed to be atomic when writing to a pipe. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_RE_DUP_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of repeated occurrences of a BRE permitted by the \fBregexec()\fR +and \fBregcomp()\fR functions when using the interval notation +{\e(\fIm\fR,\fIn\fR\e} +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_RTSIG_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of realtime signal numbers reserved for application use. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SEM_NSEMS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of semaphores that a process can have. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SEM_VALUE_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The maximum value a semaphore can have. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SIGQUEUE_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of queued signals that a process can send and have pending at the +receiver(s) at any time. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SSIZE_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The value that can be stored in an object of type \fBssize_t\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_STREAM_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of streams that one process can have open at one time. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SS_REPL_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of replenishment operations that can be simultaneously pending for a +particular sporadic server scheduler. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SYMLINK_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of bytes in a symbolic link. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SYMLOOP_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of symbolic links that can be traversed in the resolution of a +pathname in the absence of a loop. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_THREAD_DESTRUCTOR_ITERATIONS\fR\fR +.ad +.sp .6 +.RS 4n +The number of attempts made to destroy a thread's thread-specific data values +on thread exit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_THREAD_KEYS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of data keys per process. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_THREAD_THREADS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of threads per process. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TIMER_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The per-process number of timers. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TRACE_EVENT_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The length in bytes of a trace event name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TRACE_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The length in bytes of a trace generation version string or a trace stream +name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TRACE_SYS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of trace streams that can simultaneously exist in the system. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TRACE_USER_EVENT_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The number of user trace event type identifiers that may simultaneously exist +in a traced process, including the predefined user trace event +\fBPOSIX_TRACE_UNNAMED_USER_EVENT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TTY_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +The size of the storage required for a terminal device name, in bytes, +including the terminating null. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TZNAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of bytes supported for the name of a timezone (not of the TZ +variable). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_BC_BASE_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum obase values allowed by the \fBbc\fR utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_BC_DIM_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of elements permitted in an array by the \fBbc\fR utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_BC_SCALE_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum scale value allowed by the \fBbc\fR utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_BC_STRING_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum length of a string constant accepted by the \fBbc\fR utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_CHARCLASS_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of bytes in a character class name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_COLL_WEIGHTS_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of weights that can be assigned to an entry of the +\fBLC_COLLATE\fR order keyword in the locale definition file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_EXPR_NEST_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of expressions that can be nested within parentheses by the +\fBexpr\fR utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_LINE_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Unless otherwise noted, the maximum length, in bytes, of a utility's input line +(either standard input or another file), when the utility is described as +processing text files. The length includes room for the trailing <newline>. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_RE_DUP_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of repeated occurrences of a regular expression permitted when +using the interval notation \e{\fIm\fR,\fIn\fR\e}. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_IOV_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of \fBiovec\fR structures that one process has available for use +with \fBread\fR(2) or \fBwrite\fR(2). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_NAME_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of bytes in a filename (not including the terminating null). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_PATH_MAX\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of bytes in a pathname. +.RE + +.SS "Numerical Limits" +.sp +.LP +The values in the following lists shall be defined in <\fBlimits.h\fR> and are +constant expressions suitable for use in \fB#if\fR preprocessing directives. +Moreover, except for \fBCHAR_BIT\fR, \fBDBL_DIG\fR, \fBDBL_MAX\fR, +\fBFLT_DIG\fR, \fBFLT_MAX\fR, \fBLONG_BIT\fR, \fBWORD_BIT\fR, and +\fBMB_LEN_MAX\fR, the symbolic names are defined as expressions of the correct +type. +.sp +.LP +If the value of an object of type \fBchar\fR is treated as a signed integer +when used in an expression, the value of \fBCHAR_MIN\fR is the same as that of +\fBSCHAR_MIN\fR and the value of \fBCHAR_MAX\fR is the same as that of +\fBSCHAR_MAX\fR. Otherwise, the value of \fBCHAR_MIN\fR is 0 and the value of +\fBCHAR_MAX\fR is the same as that of \fBUCHAR_MAX\fR. +.sp +.ne 2 +.mk +.na +\fB\fBCHAR_BIT\fR\fR +.ad +.RS 14n +.rt +Number of bits in a type \fBchar\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCHAR_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of type \fBchar\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCHAR_MIN\fR\fR +.ad +.RS 14n +.rt +Minimum value of type \fBchar\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBDBL_DIG\fR\fR +.ad +.RS 14n +.rt +Digits of precision of type \fBdouble\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBDBL_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum decimal value of a \fBdouble\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBDBL_MIN\fR\fR +.ad +.RS 14n +.rt +Minimum decimal value of a \fBdouble\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFLT_DIG\fR\fR +.ad +.RS 14n +.rt +Digits of precision of type \fBfloat\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFLT_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum decimal value of a \fBfloat\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFLT_MIN\fR\fR +.ad +.RS 14n +.rt +Minimum decimal value of a \fBfloat\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBINT_MIN\fR\fR +.ad +.RS 14n +.rt +Minimum value of type \fBint\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBINT_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of an \fBint\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLLONG_MIN\fR\fR +.ad +.RS 14n +.rt +Minimum value of type \fBlong long\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLLONG_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of type \fBlong long\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLONG_BIT\fR\fR +.ad +.RS 14n +.rt +Number of bits in a \fBlong\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLONG_MIN\fR\fR +.ad +.RS 14n +.rt +Minimum value of type \fBlong\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLONG_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of a \fBlong\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMB_LEN_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum number of bytes in a character, for any supported locale. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSCHAR_MIN\fR\fR +.ad +.RS 14n +.rt +Minimum value of type \fBsigned char\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSCHAR_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of type \fBsigned char\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSHRT_MIN\fR\fR +.ad +.RS 14n +.rt +Minimum value of type \fBshort\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSHRT_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of type \fBshort\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSSIZE_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of an object of type \fBssize_t\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTMP_MAX\fR\fR +.ad +.RS 14n +.rt +Minimum number of unique filename generated by \fBtmpnam\fR(3C). Maximum number +of times an application can call \fBtmpnam()\fR reliably. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBUCHAR_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of type \fBunsigned char\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBUINT_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of type \fBunsigned\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBULLONG_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of type unsigned \fBlong long\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBULONG_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value of type \fBunsigned long\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBUSHRT_MAX\fR\fR +.ad +.RS 14n +.rt +Maximum value for a type \fBunsigned short\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWORD_BIT\fR\fR +.ad +.RS 14n +.rt +Number of bits in a word or type \fBint\fR. +.RE + +.SS "Other Invariant Values" +.sp +.LP +The following constants are defined in <\fBlimits.h\fR>. +.sp +.ne 2 +.mk +.na +\fB\fBCHARCLASS_NAME_MAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of bytes in a character class name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOGNAME_MAX\fR\fR +.ad +.RS 22n +.rt +The maximum number of bytes supported in a user's login name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL_ARGMAX\fR\fR +.ad +.RS 22n +.rt +Maximum value of digit in calls to the \fBprintf\fR(3C) and \fBscanf\fR(3C) +functions. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL_LANGMAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of bytes in a \fBLANG\fR name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL_MSGMAX\fR\fR +.ad +.RS 22n +.rt +Maximum message number. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL_NMAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of bytes in an N-to-1 collation mapping. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL_SETMAX\fR\fR +.ad +.RS 22n +.rt +Maximum set number. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL_TEXTMAX\fR\fR +.ad +.RS 22n +.rt +Maximum number of bytes in a message string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNZERO\fR\fR +.ad +.RS 22n +.rt +Default process priority. +.RE + +.SH SEE ALSO +.sp +.LP +\fBfpathconf\fR(2), \fBpathconf\fR(2), \fBsysconf\fR(3C), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/locale.h.3head b/usr/src/man/man3head/locale.h.3head new file mode 100644 index 0000000000..58c58dc343 --- /dev/null +++ b/usr/src/man/man3head/locale.h.3head @@ -0,0 +1,101 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 locale.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +locale.h, locale \- category macros +.SH SYNOPSIS +.LP +.nf +#include <\fBlocale.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBlocale.h\fR> header provides a definition for the \fBlconv\fR +structure, which includes the following members. (See the definition of +\fBLC_MONETARY\fR in \fBlocale\fR(5).) +.sp +.in +2 +.nf +char *currency_symbol +char *decimal_point +char frac_digits +char *grouping +char *int_curr_symbol +char int_frac_digits +char int_n_cs_precedes +char int_n_sep_by_space +char int_n_sign_posn +char int_p_cs_precedes +char int_p_sep_by_space +char int_p_sign_posn +char *mon_decimal_point +char *mon_grouping +char *mon_thousands_sep +char *negative_sign +char n_cs_precedes +char n_sep_by_space +char n_sign_posn +char *positive_sign +char p_cs_precedes +char p_sep_by_space +char p_sign_posn +char *thousands_sep +.fi +.in -2 + +.sp +.LP +The <\fBlocale.h\fR> header defines \fINULL\fR (as defined in <\fBstddef.h\fR>) +and the following as macros: +.sp +.in +2 +.nf +LC_ALL +LC_COLLATE +LC_CTYPE +LC_MESSAGES +LC_MONETARY +LC_NUMERIC +LC_TIME +.fi +.in -2 + +.sp +.LP +The preceding expand to distinct integer constant expressions, for use as the +first argument to the \fBsetlocale()\fR function. See \fBsetlocale\fR(3C). +.sp +.LP +Additional macro definitions, beginning with the characters \fBLC_\fR and an +uppercase letter, can also be specified here. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBsetlocale\fR(3C), \fBlocaleconv\fR(3C), \fBstddef.h\fR(3HEAD), +\fBattributes\fR(5), \fBlocale\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/math.h.3head b/usr/src/man/man3head/math.h.3head new file mode 100644 index 0000000000..d973498393 --- /dev/null +++ b/usr/src/man/man3head/math.h.3head @@ -0,0 +1,415 @@ +'\" te +.\" Copyright 1989 AT&T. Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 math.h 3HEAD "11 Aug 2004" "SunOS 5.11" "Headers" +.SH NAME +math.h, math \- mathematical declarations +.SH SYNOPSIS +.LP +.nf +\fB#include <math.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBmath.h\fR> header includes definitions for the following types: +.sp +.ne 2 +.mk +.na +\fB\fBfloat_t\fR\fR +.ad +.RS 12n +.rt +A real-floating type at least as wide as \fBfloat\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBdouble_t\fR\fR +.ad +.RS 12n +.rt +A real-floating type at least as wide as \fBdouble\fR, and at least as wide as +\fBfloat_t\fR. +.RE + +.sp +.LP +If \fBFLT_EVAL_METHOD\fR equals 0, \fBfloat_t\fR and \fBdouble_t\fR are +\fBfloat\fR and \fBdouble\fR, respectively. If \fBFLT_EVAL_METHOD\fR equals 1, +they are both \fBdouble\fR. If \fBFLT_EVAL_METHOD\fR equals 2, they are both be +\fBlong double\fR. Other values of \fBFLT_EVAL_METHOD\fR are +implementation-defined. +.sp +.LP +The <\fBmath.h\fR> header provides the following constants. The values are of +type \fBdouble\fR and are accurate within the precision of the \fBdouble\fR +type. +.sp +.ne 2 +.mk +.na +\fB\fBM_E\fR\fR +.ad +.RS 14n +.rt +The base of natural logarithms (\fIe\fR). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_LOG2E\fR\fR +.ad +.RS 14n +.rt +The base-2 logarithm of \fIe\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_LOG10E\fR\fR +.ad +.RS 14n +.rt +The base-10 logarithm of \fIe\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_LN2\fR\fR +.ad +.RS 14n +.rt +The natural logarithm of 2. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_LN10\fR\fR +.ad +.RS 14n +.rt +The natural logarithm of 10. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_PI\fR\fR +.ad +.RS 14n +.rt +\c +.if n pi\c +.if t \(*p +\c +, the ratio of the circumference of a circle to its diameter. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_PI_2\fR\fR +.ad +.RS 14n +.rt +\c +.if n pi\c +.if t \(*p +\c +/2. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_PI_4\fR\fR +.ad +.RS 14n +.rt +\c +.if n pi\c +.if t \(*p +\c +/4. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_1_PI\fR\fR +.ad +.RS 14n +.rt +1/\c +.if n pi\c +.if t \(*p +\c +. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_2_PI\fR\fR +.ad +.RS 14n +.rt +2/\c +.if n pi\c +.if t \(*p +\c +. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_2_SQRTPI\fR\fR +.ad +.RS 14n +.rt +2 over the square root of \c +.if n pi\c +.if t \(*p +\c +. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_SQRT2\fR\fR +.ad +.RS 14n +.rt +The positive square root of 2. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBM_SQRT1_2\fR\fR +.ad +.RS 14n +.rt +The positive square root of 1/2. +.RE + +.sp +.LP +The <\fBmath.h\fR> header defines the following symbolic constants: +.sp +.ne 2 +.mk +.na +\fB\fBMAXFLOAT\fR\fR +.ad +.RS 13n +.rt +The maximum value of a non-infinite single-precision floating point number. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBHUGE_VAL\fR\fR +.ad +.RS 13n +.rt +A positive \fBdouble\fR expression, not necessarily representable as a float. +Used as an error value returned by the mathematics library. \fBHUGE_VAL\fR +evaluates to +infinity on systems supporting IEEE Std 754-1985. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBHUGE_VALF\fR\fR +.ad +.RS 13n +.rt +A positive \fBfloat\fR constant expression. Used as an error value returned by +the mathematics library. \fBHUGE_VALF\fR evaluates to +infinity on systems +supporting IEEE Std 754-1985. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBHUGE_VALL\fR\fR +.ad +.RS 13n +.rt +A positive \fBlong double\fR constant expression. Used as an error value +returned by the mathematics library. \fBHUGE_VALL\fR evaluates to +infinity on +systems supporting IEEE Std 754-1985. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBINFINITY\fR\fR +.ad +.RS 13n +.rt +A constant expression of type \fBfloat\fR representing positive or unsigned +infinity, if available; else a positive constant of type \fBfloat\fR that +overflows at translation time. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNAN\fR\fR +.ad +.RS 13n +.rt +A constant expression of type float representing a quiet NaN. This symbolic +constant is only defined if the implementation supports quiet NaNs for the +\fBfloat\fR type. +.RE + +.sp +.LP +The following macros are defined for number classification. They represent the +mutually-exclusive kinds of floating-point values. They expand to integer +constant expressions with distinct values +.sp +.in +2 +.nf +FP_INFINITE +FP_NAN +FP_NORMAL +FP_SUBNORMAL +FP_ZERO +.fi +.in -2 + +.sp +.LP +The following optional macros indicate whether the \fBfma()\fR family of +functions are fast compared with direct code: +.sp +.in +2 +.nf +FP_FAST_FMA +FP_FAST_FMAF +FP_FAST_FMAL +.fi +.in -2 + +.sp +.LP +The \fBFP_FAST_FMA\fR macro is defined to indicate that the \fBfma()\fR +function generally executes about as fast as, or faster than, a multiply and an +add of \fBdouble\fR operands. The other macros have the equivalent meaning for +the \fBfloat\fR and \fBlong double\fR versions. +.sp +.LP +The following macros expand to integer constant expressions whose values are +returned by \fBilogb\fR(\fIx\fR) if \fIx\fR is zero or NaN, respectively. The +value of \fBFP_ILOGB0\fR is either {\fBINT_MIN\fR} or -{\fBINT_MAX\fR}. The +value of \fBFP_ILOGBNAN\fR is either {\fBINT_MAX\fR} or {\fBINT_MIN\fR}. +.sp +.in +2 +.nf +FP_ILOGB0 +FP_ILOGBNAN +.fi +.in -2 + +.sp +.LP +The following macros expand to the integer constants 1 and 2, respectively: +.sp +.in +2 +.nf +MATH_ERRNO +MATH_ERREXCEPT +.fi +.in -2 + +.sp +.LP +The following macro expands to an expression that has type \fBint\fR and the +value \fBMATH_ERREXCEPT\fR: +.sp +.in +2 +.nf +math_errhandling +.fi +.in -2 + +.sp +.LP +The value of the macro \fBmath_errhandling\fR is constant for the duration of +the program. If a macro definition is suppressed or a program defines an +identifier with the name \fBmath_errhandling\fR, the behavior is undefined. +.sp +.LP +The <\fBmath.h\fR> header defines he following external variable: +.sp +.in +2 +.nf +extern int signgam; +.fi +.in -2 + +.sp +.LP +The <\fBmath.h\fR> header defines the structure and constants used by the +\fBmatherr\fR(3M) error-handling mechanisms. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBIntro\fR(3), \fBfenv.h\fR(3HEAD), \fBlibm\fR(3LIB), \fBlimits.h\fR(3HEAD), +\fBmatherr\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/mman.h.3head b/usr/src/man/man3head/mman.h.3head new file mode 100644 index 0000000000..3bf696d7eb --- /dev/null +++ b/usr/src/man/man3head/mman.h.3head @@ -0,0 +1,233 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. +.\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 mman.h 3HEAD "5 Feb 2008" "SunOS 5.11" "Headers" +.SH NAME +mman.h, mman \- memory management declarations +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/mman.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/mman.h\fR> header supports the following options: +.RS +4 +.TP +.ie t \(bu +.el o +the Memory Mapped Files option +.RE +.RS +4 +.TP +.ie t \(bu +.el o +the Shared Memory Objects option +.RE +.RS +4 +.TP +.ie t \(bu +.el o +the Process Memory Locking option +.RE +.RS +4 +.TP +.ie t \(bu +.el o +the Memory Protection option +.RE +.RS +4 +.TP +.ie t \(bu +.el o +the Synchronized Input and Output option +.RE +.sp +.LP +For Memory Mapped Files and Shared Memory Objects options, the following +protection options are defined: +.sp +.ne 2 +.mk +.na +\fB\fBPROT_READ\fR\fR +.ad +.RS 14n +.rt +Page can be read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPROT_WRITE\fR\fR +.ad +.RS 14n +.rt +Page can be written. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPROT_EXEC\fR\fR +.ad +.RS 14n +.rt +Page can be executed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPROT_NONE\fR\fR +.ad +.RS 14n +.rt +Page cannot be accessed. +.RE + +.sp +.LP +The following \fIflag\fR options are defined: +.sp +.ne 2 +.mk +.na +\fB\fBMAP_SHARED\fR\fR +.ad +.RS 15n +.rt +Share changes. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMAP_PRIVATE\fR\fR +.ad +.RS 15n +.rt +Changes are private. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMAP_FIXED\fR\fR +.ad +.RS 15n +.rt +Interpret \fBaddr\fR exactly. +.RE + +.sp +.LP +The flags immediately following are defined for \fBmsync()\fR. See +\fBmsync\fR(3C). +.sp +.ne 2 +.mk +.na +\fB\fBMS_ASYNC\fR\fR +.ad +.RS 17n +.rt +Perform asynchronous writes. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMS_SYNC\fR\fR +.ad +.RS 17n +.rt +Perform synchronous writes. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMS_INVALIDATE\fR\fR +.ad +.RS 17n +.rt +Invalidate mappings. +.RE + +.sp +.LP +The symbolic constants immediately following are defined for the +\fBmlockall()\fR function. See \fBmlockall\fR(3C). +.sp +.ne 2 +.mk +.na +\fB\fBMCL_CURRENT\fR\fR +.ad +.RS 15n +.rt +Lock currently mapped pages. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMCL_FUTURE\fR\fR +.ad +.RS 15n +.rt +Lock pages that become mapped. +.RE + +.sp +.LP +The symbolic constant \fBMAP_FAILED\fR is defined to indicate a failure from +the \fBmmap()\fR function. See \fBmmap\fR(2). +.sp +.LP +The \fBmode_t\fR, \fBoff_t\fR, and \fBsize_t\fR types are be defined as +described in <\fBsys/types.h\fR>. See \fBtypes\fR(3HEAD). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityCommitted +_ +StandardSee \fBstandards\fR(5). +.TE + +.SH SEE ALSO +.sp +.LP +\fBmmap\fR(2), \fBmprotect\fR(2), \fBmunmap\fR(2), \fBmadvise\fR(3C), +\fBmlock\fR(3C), \fBmlockall\fR(3C), \fBmsync\fR(3C), \fBshm_open\fR(3C), +\fBshm_unlink\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/monetary.h.3head b/usr/src/man/man3head/monetary.h.3head new file mode 100644 index 0000000000..8da55272ae --- /dev/null +++ b/usr/src/man/man3head/monetary.h.3head @@ -0,0 +1,66 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 monetary.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +monetary.h, monetary \- monetary types +.SH SYNOPSIS +.LP +.nf +#include <\fBmonetary.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBmonetary.h\fR> header defines the following types: +.sp +.ne 2 +.mk +.na +\fB\fBsize_t\fR\fR +.ad +.RS 11n +.rt +As described in \fBstddef.h\fR(3HEAD). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBssize_t\fR\fR +.ad +.RS 11n +.rt +As described in \fBtypes.h\fR(3HEAD). +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBstddef.h\fR(3HEAD), \fBstrfmon\fR(3C), \fBtypes.h\fR(3HEAD), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/mqueue.h.3head b/usr/src/man/man3head/mqueue.h.3head new file mode 100644 index 0000000000..e49aea0914 --- /dev/null +++ b/usr/src/man/man3head/mqueue.h.3head @@ -0,0 +1,70 @@ +'\" te +.\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 mqueue.h 3HEAD "30 Aug 2002" "SunOS 5.11" "Headers" +.SH NAME +mqueue.h, mqueue \- message queues +.SH SYNOPSIS +.LP +.nf +\fB#include <mqueue.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBmqueue.h\fR> header defines the \fBmqd_t\fR type, which is used for +message queue descriptors. This will not be an array type. A message queue +descriptor may be implemented using a file descriptor, in which case +applications can open up to at least \fBOPEN_MAX\fR file and message queues. +.sp +.LP +The <\fBmqueue.h\fR> header defines the \fBsigevent\fR structure (as described +in <\fBsignal.h\fR>, see \fBsignal.h\fR(3HEAD)) and the \fBmq_attr\fR +structure, which is used in getting and setting the attributes of a message +queue. Attributes are initially set when the message queue is created. A +\fBmq_attr\fR structure has the following members: +.sp +.in +2 +.nf +\fBlong mq_flags message queue flags +long mq_maxmsg maximum number of messages +long mq_msgsize maximum message size +long mq_curmsgs number of messages currently queued\fR +.fi +.in -2 +.sp + +.sp +.LP +Inclusion of the <\fBmqueue.h\fR> header may make visible symbols defined in +the headers <\fBfcntl.h\fR>, <\fBsignal.h\fR>, <\fBsys/types.h\fR>, and +<\fBtime.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBfcntl.h\fR(3HEAD), \fBsignal.h\fR(3HEAD), \fBtime.h\fR(3HEAD), +\fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/msg.h.3head b/usr/src/man/man3head/msg.h.3head new file mode 100644 index 0000000000..923a529bc5 --- /dev/null +++ b/usr/src/man/man3head/msg.h.3head @@ -0,0 +1,110 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 msg.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +msg.h, msg \- message queue structures +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/msg.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/msg.h\fR> header defines the following data types through +\fBtypedef\fR: +.sp +.ne 2 +.mk +.na +\fB\fBmsgqnum_t\fR\fR +.ad +.RS 13n +.rt +used for the number of messages in the message queue +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBmsglen_t\fR\fR +.ad +.RS 13n +.rt +used for the number of bytes allowed in the message queue +.RE + +.sp +.LP +These types are unsigned integer types that are able to store values at least +as large as a type unsigned short. +.sp +.LP +The <\fBsys/msg.h\fR> header defines the following constant as a message +operation flag: +.sp +.ne 2 +.mk +.na +\fB\fBMSG_NOERROR\fR\fR +.ad +.RS 15n +.rt +no error if big message +.RE + +.sp +.LP +The \fBmsqid_ds\fR structure contains the following members: +.sp +.in +2 +.nf +struct ipc_perm msg_perm Operation permission structure. +msgqnum_t msg_qnum Number of messages currently on + queue. +msglen_t msg_qbytes Maximum number of bytes allowed + on queue. +pid_t msg_lspid Process ID of last msgsnd(2). +pid_t msg_lrpid Process ID of last msgrcv(2). +time_t msg_stime Time of last \fBmsgsnd()\fR. +time_t msg_rtime Time of last \fBmsgrcv()\fR. +time_t msg_ctime Time of last change. +.fi +.in -2 + +.sp +.LP +The \fBpid_t\fR, \fBtime_t\fR, \fBkey_t\fR, \fBsize_t\fR, and \fBssize_t\fR +types are defined as described in <\fBsys/types.h\fR>. See \fBtypes\fR(3HEAD). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBmsgctl\fR(2), \fBmsgget\fR(2), \fBmsgrcv\fR(2), \fBmsgsnd\fR(2), +\fBipc.h\fR(3HEAD), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/ndbm.h.3head b/usr/src/man/man3head/ndbm.h.3head new file mode 100644 index 0000000000..e9eb56f6f1 --- /dev/null +++ b/usr/src/man/man3head/ndbm.h.3head @@ -0,0 +1,85 @@ +'\" te +.\" Copyright 1991, 1992, 1994, The X/Open Company Ltd. Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 ndbm.h 3HEAD "30 Aug 2002" "SunOS 5.11" "Headers" +.SH NAME +ndbm.h, ndbm \- definitions for ndbm database operations +.SH SYNOPSIS +.LP +.nf +\fB#include <ndbm.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The \fB<ndbm.h>\fR header defines the \fBdatum\fR type as a structure that +includes at least the following members: +.sp +.in +2 +.nf +void *dptr /* pointer to the application's data */ +size_t dsize /* size of the object pointed to by dptr */ +.fi +.in -2 + +.sp +.LP +The \fBsize_t\fR type is defined through \fBtypedef\fR as described in +<\fBstddef.h\fR>. +.sp +.LP +The <\fBndbm.h\fR> header defines the \fBDBM\fR type through \fBtypedef\fR. +.sp +.LP +The following constants are defined as possible values for the \fIstore_mode\fR +argument to \fBdbm_store()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBDBM_INSERT\fR \fR +.ad +.RS 16n +.rt +Insertion of new entries only. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBDBM_REPLACE\fR \fR +.ad +.RS 16n +.rt +Allow replacing existing entries. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBndbm\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/netdb.h.3head b/usr/src/man/man3head/netdb.h.3head new file mode 100644 index 0000000000..3f26f88b3d --- /dev/null +++ b/usr/src/man/man3head/netdb.h.3head @@ -0,0 +1,148 @@ +'\" te +.\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 netdb.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +netdb.h, netdb \- definitions for network database operations +.SH SYNOPSIS +.LP +.nf +\fB#include <netdb.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBnetdb.h\fR> header defines the type \fBin_port_t\fR and the type +\fBin_addr_t\fR as described in \fBin.h\fR(3HEAD). +.sp +.LP +The <\fBnetdb.h\fR> header defines the \fBhostent\fR structure that includes +the following members: +.sp +.in +2 +.nf +char *h_name /* official name of the host */ +char **h_aliases /* pointer to an array of pointers to + alternative host names, terminated + by a null pointer */ +int h_addrtype /* address type */ +int h_length /* length, in bytes, of the address */ +char **h_addr_list /* pointer to an array of pointers to + network addresses (in network byte + order)for the host, terminated by a + null pointer */ +.fi +.in -2 + +.sp +.LP +The <\fBnetdb.h\fR> header defines the \fBnetent\fR structure that includes the +following members: +.sp +.in +2 +.nf +char *n_name /* official, fully-qualified */ + (including the domain) name + of the network */ +char **n_aliases /* pointer to an array of pointers to + alternative network names, terminated */ + by a null pointer */ +int n_addrtype /* the address type of the network */ +in_addr_t n_net /* the network number, in host byte order */ +.fi +.in -2 + +.sp +.LP +The <\fBnetdb.h\fR> header defines the \fBprotoent\fR structure that includes +the following members: +.sp +.in +2 +.nf +char *p_name /* official name of the protocol */ +char **p_aliases /* pointer to an array of pointers to + alternative protocol names, terminated + by a null pointer */ +int p_proto /* protocol number */ +.fi +.in -2 + +.sp +.LP +The <\fBnetdb.h\fR> header defines the \fBservent\fR structure that includes +the following members: +.sp +.in +2 +.nf +char *s_name /* oficial name of the service */ +char **s_aliases /* pointer to an array of pointers to + alternativeservice names, terminated by + a null pointer */ +int s_port /* port number at which the service + resides, in network byte order */ +char *s_proto /* name of the protocol to use when + contacting the service */ +.fi +.in -2 + +.sp +.LP +The <\fBnetdb.h\fR> header defines the macro \fBIPPORT_RESERVED\fR with the +value of the highest reserved Internet port number. +.sp +.LP +The <\fBnetdb.h\fR> header provides a declaration for \fBh_errno\fR: +.sp +.LP +extern int h_errno; +.sp +.LP +The <\fBnetdb.h\fR> header defines the following macros for use as error values +for \fBgethostbyaddr()\fR and \fBgethostbyname()\fR: +.sp + +.sp +.TS +tab(); +lw(1.71i) lw(3.79i) +lw(1.71i) lw(3.79i) +. +\fBHOST_NOT_FOUND\fR\fBNO_DATA\fR +\fBNO_RECOVERY\fR\fBTRY_AGAIN\fR +.TE + +.sp +.LP +Inclusion of the <\fBnetdb.h\fR> header may also make visible all symbols from +\fBin.h\fR(3HEAD). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBIntro\fR(3), \fBendhostent\fR(3NSL), \fBendhostent\fR(3XNET), +\fBendnetent\fR(3SOCKET), \fBendnetent\fR(3XNET), \fBendprotoent\fR(3SOCKET), +\fBendprotoent\fR(3XNET), \fBendservent\fR(3SOCKET), \fBendservent\fR(3XNET), +\fBin.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/nl_types.h.3head b/usr/src/man/man3head/nl_types.h.3head new file mode 100644 index 0000000000..07d84b1d0a --- /dev/null +++ b/usr/src/man/man3head/nl_types.h.3head @@ -0,0 +1,93 @@ +'\" te +.\" Copyright 1989 AT&T Copyright (c) 1997, Sun Microsystems, Inc. All Rights Reserved +.\" 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 nl_types.h 3HEAD "3 Jul 1990" "SunOS 5.11" "Headers" +.SH NAME +nl_types.h, nl_types \- native language data types +.SH SYNOPSIS +.LP +.nf +\fB#include <nl_types.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +This header contains the following definitions: +.sp +.ne 2 +.mk +.na +\fB\fBnl_catd\fR\fR +.ad +.RS 15n +.rt +Used by the message catalog functions \fBcatopen\fR, \fBcatgets\fR and +\fBcatclose\fR to identify a catalog. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBnl_item\fR\fR +.ad +.RS 15n +.rt +Used by \fBnl_langinfo\fR to identify items of langinfo data. Values for +objects of type \fBnl_item\fR are defined in \fB<langinfo.h>\fR\&. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL_SETD\fR \fR +.ad +.RS 15n +.rt +Used by \fBgencat\fR when no \fB$set\fR directive is specified in a message +text source file. This constant can be used in subsequent calls to +\fBcatgets\fR as the value of the set identifier parameter. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL_MGSMAX\fR \fR +.ad +.RS 15n +.rt +Maximum number of messages per set. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL_SETMAX\fR \fR +.ad +.RS 15n +.rt +Maximum number of sets per catalog. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL_TEXTMAX\fR \fR +.ad +.RS 15n +.rt +Maximum size of a message. +.RE + +.SH SEE ALSO +.sp +.LP +\fBgencat\fR(1), \fBcatgets\fR(3C), \fBcatopen\fR(3C), \fBnl_langinfo\fR(3C), +\fBlanginfo.h\fR(3HEAD) diff --git a/usr/src/man/man3head/poll.h.3head b/usr/src/man/man3head/poll.h.3head new file mode 100644 index 0000000000..847a71eee5 --- /dev/null +++ b/usr/src/man/man3head/poll.h.3head @@ -0,0 +1,218 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 poll.h 3HEAD "9 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +poll.h, poll \- definitions for the \fBpoll()\fR function +.SH SYNOPSIS +.LP +.nf +#include <\fBpoll.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBpoll.h\fR> header defines the \fBpollfd\fR structure, which includes +the following members: +.sp +.ne 2 +.mk +.na +\fB\fBint fd\fR\fR +.ad +.RS 17n +.rt +the following descriptor being polled +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBshort events\fR\fR +.ad +.RS 17n +.rt +the input event flags (see below) +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBshort revents\fR\fR +.ad +.RS 17n +.rt +the output event flags (see below) +.RE + +.sp +.LP +The <\fBpoll.h\fR> header defines the following type through \fBtypedef\fR: +.sp +.ne 2 +.mk +.na +\fB\fBnfds_t\fR\fR +.ad +.RS 10n +.rt +an unsigned integer type used for the number of file descriptors +.RE + +.sp +.LP +The implementation supports one or more programming environments in which the +width of \fBnfds_t\fR is no greater than the width of type long. The names of +these programming environments can be obtained using the \fBconfstr()\fR +function or the \fBgetconf\fR utility. See \fBconfstr\fR(3C) and +\fBgetconf\fR(1). +.sp +.LP +The following symbolic constants are defined, zero or more of which can be +OR'ed together to form the \fBevents\fR or \fBrevents\fR members in the +\fBpollfd\fR structure: +.sp +.ne 2 +.mk +.na +\fB\fBPOLLIN\fR\fR +.ad +.RS 14n +.rt +Data other than high-priority data can be read without blocking. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOLLRDNORM\fR\fR +.ad +.RS 14n +.rt +Normal data can be read without blocking. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOLLRDBAND\fR\fR +.ad +.RS 14n +.rt +Priority data can be read without blocking. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOLLPRI\fR\fR +.ad +.RS 14n +.rt +High priority data can be read without blocking. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOLLOUT\fR\fR +.ad +.RS 14n +.rt +Normal data can be written without blocking. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOLLWRNORM\fR\fR +.ad +.RS 14n +.rt +Equivalent to \fBPOLLOUT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOLLWRBAND\fR\fR +.ad +.RS 14n +.rt +Priority data can be written. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOLLERR\fR\fR +.ad +.RS 14n +.rt +An error has occurred (\fBrevents\fR only). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOLLHUP\fR\fR +.ad +.RS 14n +.rt +Device has been disconnected (\fBrevents\fR only). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPOLLNVAL\fR\fR +.ad +.RS 14n +.rt +Invalid \fBfd\fR member (\fBrevents\fR only). +.RE + +.sp +.LP +The significance and semantics of normal, priority, and high-priority data are +file and device-specific. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetconf\fR(1), \fBpoll\fR(2), \fBconfstr\fR(3C), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/pthread.h.3head b/usr/src/man/man3head/pthread.h.3head new file mode 100644 index 0000000000..58ee3aeab8 --- /dev/null +++ b/usr/src/man/man3head/pthread.h.3head @@ -0,0 +1,118 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. +.\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 pthread.h 3HEAD "11 Nov 2008" "SunOS 5.11" "Headers" +.SH NAME +pthread.h, pthread \- threads +.SH SYNOPSIS +.LP +.nf +#include <\fBpthread.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBpthread.h\fR> header defines the following symbols: +.sp +.in +2 +.nf +PTHREAD_BARRIER_SERIAL_THREAD +PTHREAD_CANCEL_ASYNCHRONOUS +PTHREAD_CANCEL_ENABLE +PTHREAD_CANCEL_DEFERRED +PTHREAD_CANCEL_DISABLE +PTHREAD_CANCELED +PTHREAD_COND_INITIALIZER +PTHREAD_CREATE_DETACHED +PTHREAD_CREATE_JOINABLE +PTHREAD_EXPLICIT_SCHED +PTHREAD_INHERIT_SCHED +PTHREAD_MUTEX_DEFAULT +PTHREAD_MUTEX_ERRORCHECK +PTHREAD_MUTEX_INITIALIZER +PTHREAD_MUTEX_NORMAL +PTHREAD_MUTEX_RECURSIVE +PTHREAD_MUTEX_ROBUST +PTHREAD_MUTEX_STALLED +PTHREAD_ONCE_INIT +PTHREAD_PRIO_INHERIT +PTHREAD_PRIO_NONE +PTHREAD_PRIO_PROTECT +PTHREAD_PROCESS_SHARED +PTHREAD_PROCESS_PRIVATE +PTHREAD_RWLOCK_INITIALIZER +PTHREAD_SCOPE_PROCESS +PTHREAD_SCOPE_SYSTEM +.fi +.in -2 + +.sp +.LP +The types listed below are defined as described in <\fBsys/types.h\fR>. See +\fBtypes.h\fR(3HEAD). +.sp +.in +2 +.nf +pthread_attr_t +pthread_barrier_t +pthread_barrierattr_t +pthread_cond_t +pthread_condattr_t +pthread_key_t +pthread_mutex_t +pthread_mutexattr_t +pthread_once_t +pthread_rwlock_t +pthread_rwlockattr_t +pthread_spinlock_t +pthread_t +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBsched.h\fR(3HEAD), \fBtime.h\fR(3HEAD), \fBtypes.h\fR(3HEAD), +\fBpthread_attr_getguardsize\fR(3C), \fBpthread_attr_init\fR(3C), +\fBpthread_attr_setscope\fR(3C), \fBpthread_cancel\fR(3C), +\fBpthread_cleanup_pop\fR(3C), \fBpthread_cond_init\fR(3C), +\fBpthread_cond_signal\fR(3C), \fBpthread_cond_wait\fR(3C), +\fBpthread_condattr_init\fR(3C), \fBpthread_create\fR(3C), +\fBpthread_detach\fR(3C), \fBpthread_equal\fR(3C), \fBpthread_exit\fR(3C), +\fBpthread_getconcurrency\fR(3C), \fBpthread_getschedparam\fR(3C), +\fBpthread_join\fR(3C), \fBpthread_key_create\fR(3C), +\fBpthread_key_delete\fR(3C), \fBpthread_mutex_consistent\fR(3C), +\fBpthread_mutex_init\fR(3C), \fBpthread_mutex_lock\fR(3C), +\fBpthread_mutex_setprioceiling\fR(3C), \fBpthread_mutexattr_getrobust\fR(3C), +\fBpthread_mutexattr_gettype\fR(3C), \fBpthread_mutexattr_getprotocol\fR(3C), +\fBpthread_mutexattr_init\fR(3C), \fBpthread_once\fR(3C), +\fBpthread_rwlock_init\fR(3C), \fBpthread_rwlock_rdlock\fR(3C), +\fBpthread_rwlock_unlock\fR(3C), \fBpthread_rwlock_wrlock\fR(3C), +\fBpthread_rwlockattr_getpshared\fR(3C), \fBpthread_rwlockattr_init\fR(3C), +\fBpthread_self\fR(3C), \fBpthread_setcancelstate\fR(3C), +\fBpthread_setspecific\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/pwd.h.3head b/usr/src/man/man3head/pwd.h.3head new file mode 100644 index 0000000000..ff625380e5 --- /dev/null +++ b/usr/src/man/man3head/pwd.h.3head @@ -0,0 +1,60 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 pwd.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +pwd.h, pwd \- password structure +.SH SYNOPSIS +.LP +.nf +#include <\fBpwd.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBpwd.h\fR> header provides a definition for \fBstruct passwd\fR, which +includes the following members: +.sp +.in +2 +.nf +char *pw_name user's login name +uid_t pw_uid numerical user ID +gid_t pw_gid numerical group ID +char *pw_dir initial working di rectory +char *pw_shell program to use as shell +.fi +.in -2 + +.sp +.LP +The \fBgid_t\fR and \fBuid_t\fR types are defined as described in +<\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetpwnam\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/regex.h.3head b/usr/src/man/man3head/regex.h.3head new file mode 100644 index 0000000000..aa17bee67d --- /dev/null +++ b/usr/src/man/man3head/regex.h.3head @@ -0,0 +1,310 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 regex.h 3HEAD "9 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +regex.h, regex \- regular expression matching types +.SH SYNOPSIS +.LP +.nf +#include <\fBregex.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBregex.h\fR> header defines the structures and symbolic constants used +by the \fBregcomp()\fR, \fBregexec()\fR, \fBregerror()\fR, and \fBregfree()\fR +functions. See \fBregcomp\fR(3C). +.sp +.LP +The structure type \fBregex_t\fR contains the following member: +.sp +.in +2 +.nf +size_t re_nsub number of parenthesized subexpressions +.fi +.in -2 + +.sp +.LP +The type \fBsize_t\fR is defined as described in <\fBsys/types.h\fR>. See +\fBtypes.h\fR(3HEAD). +.sp +.LP +The type \fBregoff_t\fR is defined as a signed integer type that can hold the +largest value that can be stored in either a type \fBoff_t\fR or type +\fBssize_t\fR. The structure type \fBregmatch_t\fR contains the following +members: +.sp +.in +2 +.nf +regoff_t rm_so byte offset from start of string to start + of substring +regoff_t rm_eo byte offset from start of string of the + first character after the end of substring +.fi +.in -2 + +.sp +.LP +Values for the \fIcflags\fR parameter to the \fBregcomp\fR function are as +follows: +.sp +.ne 2 +.mk +.na +\fB\fBREG_EXTENDED\fR\fR +.ad +.RS 16n +.rt +use extended regular expressions +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_ICASE\fR\fR +.ad +.RS 16n +.rt +ignore case in match +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_NOSUB\fR\fR +.ad +.RS 16n +.rt +report only success or fail in \fBregexec()\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_NEWLINE\fR\fR +.ad +.RS 16n +.rt +change the handling of \fBNEWLINE\fR character +.RE + +.sp +.LP +Values for the \fIeflags\fR parameter to the \fBregexec()\fR function are as +follows: +.sp +.ne 2 +.mk +.na +\fB\fBREG_NOTBOL\fR\fR +.ad +.RS 14n +.rt +The circumflex character (^), when taken as a special character, does not match +the beginning of string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_NOTEOL\fR\fR +.ad +.RS 14n +.rt +The dollar sign ($), when taken as a special character, does not match the end +of string. +.RE + +.sp +.LP +The following constants are defined as error return values: +.sp +.ne 2 +.mk +.na +\fB\fBREG_NOMATCH\fR\fR +.ad +.RS 16n +.rt +\fBregexec()\fR failed to match. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_BADPAT\fR\fR +.ad +.RS 16n +.rt +Invalid regular expression. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_ECOLLATE\fR\fR +.ad +.RS 16n +.rt +Invalid collating element referenced. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_ECTYPE\fR\fR +.ad +.RS 16n +.rt +Invalid character class type referenced. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_EESCAPE\fR\fR +.ad +.RS 16n +.rt +Trailing '\e' in pattern. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_ESUBREG\fR\fR +.ad +.RS 16n +.rt +Number in \\fIdigit\fR invalid or in error. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_EBRACK\fR\fR +.ad +.RS 16n +.rt +"[]" imbalance. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_EPAREN\fR\fR +.ad +.RS 16n +.rt +"\e(\e)" or "()" imbalance. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_EBRACE\fR\fR +.ad +.RS 16n +.rt +"\{\}" imbalance. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_BADBR\fR\fR +.ad +.RS 16n +.rt +Content of "\{\}" invalid: not a number, number too large, more than two +numbers, first larger than second. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_ERANGE\fR\fR +.ad +.RS 16n +.rt +Invalid endpoint in range expression. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_ESPACE\fR\fR +.ad +.RS 16n +.rt +Out of memory. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_BADRPT\fR\fR +.ad +.RS 16n +.rt +\&'?', '*', or '+' not preceded by valid regular expression. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBREG_ENOSYS\fR\fR +.ad +.RS 16n +.rt +Reserved. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBregcomp\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/resource.h.3head b/usr/src/man/man3head/resource.h.3head new file mode 100644 index 0000000000..0e2974bd04 --- /dev/null +++ b/usr/src/man/man3head/resource.h.3head @@ -0,0 +1,272 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 resource.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +resource.h, resource \- definitions for resource operations +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/resource.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/resource.h\fR> header defines the symbolic constants listed below +as possible values of the \fIwhich\fR argument of \fBgetpriority()\fR and +\fBsetpriority()\fR. See \fBgetpriority\fR(3C). +.sp +.ne 2 +.mk +.na +\fB\fBPRIO_PROCESS\fR\fR +.ad +.RS 16n +.rt +identifies the \fIwho\fR argument as a process ID +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPRIO_PGRP\fR\fR +.ad +.RS 16n +.rt +identifies the \fIwho\fR argument as a process group ID +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPRIO_USER\fR\fR +.ad +.RS 16n +.rt +identifies the \fIwho\fR argument as a user ID +.RE + +.sp +.LP +The following type is defined through \fBtypedef\fR: +.sp +.ne 2 +.mk +.na +\fB\fBrlim_t\fR\fR +.ad +.RS 10n +.rt +unsigned integer type used for limit values +.RE + +.sp +.LP +The following symbolic constants are defined: +.sp +.ne 2 +.mk +.na +\fB\fBRLIM_INFINITY\fR\fR +.ad +.RS 18n +.rt +a value of \fBrlim_t\fR indicating no limit +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRLIM_SAVED_MAX\fR\fR +.ad +.RS 18n +.rt +a value of type \fBrlim_t\fR indicating an unrepresentable saved hard limit +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRLIM_SAVED_CUR\fR\fR +.ad +.RS 18n +.rt +a value of type \fBrlim_t\fR indicating an unrepresentable saved soft limit +.RE + +.sp +.LP +The symbolic constants listed below are defined as possible values of the +\fIwho\fR parameter of \fBgetrusage()\fR. See \fBgetrusage\fR(3C). +.sp +.ne 2 +.mk +.na +\fB\fBRUSAGE_SELF\fR\fR +.ad +.RS 19n +.rt +returns information about the current process +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRUSAGE_CHILDREN\fR\fR +.ad +.RS 19n +.rt +returns information about children of the current process +.RE + +.sp +.LP +The <\fBsys/resource.h\fR> header defines the \fBrlimit\fR structure, which +includes the following members: +.sp +.in +2 +.nf +rlim_t rlim_cur /* the current (soft) limit */ +rlim_t rlim_max /* the hard limit */ +.fi +.in -2 + +.sp +.LP +The <\fBsys/resource.h\fR> header defines the \fBrusage\fR structure, which +includes the following members: +.sp +.in +2 +.nf +struct timeval ru_utime /* user time used */ +struct timeval ru_stime /* system time used */ +.fi +.in -2 + +.sp +.LP +The \fBtimeval\fR structure is defined as described in <\fBsys/time.h\fR>. +.sp +.LP +The symbolic constants listed below are defined as possible values for the +\fIresource\fR argument of \fBgetrlimit()\fR and \fBsetrlimit()\fR. See +\fBgetrlimit\fR(2). +.sp +.ne 2 +.mk +.na +\fB\fBRLIMIT_CORE\fR\fR +.ad +.RS 17n +.rt +limit on size of core dump file +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRLIMIT_CPU\fR\fR +.ad +.RS 17n +.rt +limit on CPU time per process +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRLIMIT_DATA\fR\fR +.ad +.RS 17n +.rt +limit on data segment size +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRLIMIT_FSIZE\fR\fR +.ad +.RS 17n +.rt +limit on file size +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRLIMIT_NOFILE\fR\fR +.ad +.RS 17n +.rt +limit on number of open files +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRLIMIT_STACK\fR\fR +.ad +.RS 17n +.rt +limit on stack size +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRLIMIT_AS\fR\fR +.ad +.RS 17n +.rt +limit on address space size +.RE + +.sp +.LP +The \fBid_t\fR type is defined through \fBtypedef\fR as described in +<\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD). +.sp +.LP +Inclusion of the <\fBsys/resource.h\fR> header can also make visible all +symbols from <\fBsys/time.h\fR>. See \fBtime.h\fR(3HEAD). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetrlimit\fR(2), \fBgetpriority\fR(3C), \fBtime.h\fR(3HEAD), +\fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/sched.h.3head b/usr/src/man/man3head/sched.h.3head new file mode 100644 index 0000000000..ce65e7170f --- /dev/null +++ b/usr/src/man/man3head/sched.h.3head @@ -0,0 +1,131 @@ +'\" te +.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 sched.h 3HEAD "1 Apr 2008" "SunOS 5.11" "Headers" +.SH NAME +sched.h, sched \- execution scheduling +.SH SYNOPSIS +.LP +.nf +\fB#include <sched.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsched.h\fR> header defines the \fBsched_param\fR structure, which +contains the scheduling parameters required for implementation of each +supported scheduling policy. This structure contains the following member: +.sp +.in +2 +.nf +int sched_priority process execution scheduling priority +.fi +.in -2 + +.sp +.LP +Each process is controlled by an associated scheduling policy and priority. +Associated with each policy is a priority range. Each policy definition +specifies the minimum priority range for that policy. The priority ranges for +each policy may overlap the priority ranges of other policies. +.sp +.LP +The scheduling policies are indicated by the values of the following symbolic +constants: +.sp +.ne 2 +.mk +.na +\fB\fBSCHED_OTHER\fR\fR +.ad +.RS 15n +.rt +Processes are scheduled according to the traditional Time-Sharing Class (TS) +policy as described in \fBpriocntl\fR(2). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSCHED_FIFO\fR\fR +.ad +.RS 15n +.rt +Processes are scheduled in the Real-Time (RT) scheduling class, according to +the First-In-First-Out (FIFO) policy. Processes scheduled to this policy, if +not preempted by a higher priority or interrupted by a signal, will proceed +until completion. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSCHED_RR\fR\fR +.ad +.RS 15n +.rt +Processes are scheduled in the Real-Time (RT) scheduling class, according to +the Round-Robin (RR) policy. Processes scheduled to this policy, if not +preempted by a higher priority or interrupted by a signal, will execute for a +time period, returned by \fBsched_rr_get_interval\fR(3C) or by the system. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSCHED_IA\fR\fR +.ad +.RS 15n +.rt +Processes are scheduled according to the Inter-Active Class (IA) policy as +described in \fBpriocntl\fR(2). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSCHED_FSS\fR\fR +.ad +.RS 15n +.rt +Processes are scheduled according to the Fair-Share Class (FSS) policy as +described in \fBpriocntl\fR(2). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSCHED_FX\fR\fR +.ad +.RS 15n +.rt +Processes are scheduled according to the Fixed-Priority Class (FX) policy as +described in \fBpriocntl\fR(2). +.RE + +.sp +.LP +The values of these constants are distinct. +.sp +.LP +Inclusion of the \fB<sched.h>\fR header will make visible symbols defined in +the header \fB<time.h>\fR. +.SH SEE ALSO +.sp +.LP +\fBpriocntl\fR(2), \fBsched_get_priority_max\fR(3C), +\fBsched_get_priority_min\fR(3C), \fBsched_rr_get_interval\fR(3C), +\fBtime.h\fR(3HEAD) diff --git a/usr/src/man/man3head/search.h.3head b/usr/src/man/man3head/search.h.3head new file mode 100644 index 0000000000..7e293000a9 --- /dev/null +++ b/usr/src/man/man3head/search.h.3head @@ -0,0 +1,69 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 search.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +search.h, search \- search tables +.SH SYNOPSIS +.LP +.nf +#include <\fBsearch.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsearch.h\fR> header defines the \fBENTRY\fR type for structure +\fBentry\fR, which includes the following members: +.sp +.in +2 +.nf +char *key +void *data +.fi +.in -2 + +.sp +.LP +and defines \fBACTION\fR and \fBVISIT\fR as enumeration data types through type +definitions as follows: +.sp +.in +2 +.nf +enum { FIND, ENTER } ACTION; +enum { preorder, postorder, endorder, leaf } VISIT; +.fi +.in -2 + +.sp +.LP +The \fBsize_t\fR type is defined as described in <\fBsys/types.h\fR>. See +\fBtypes.h\fR(3HEAD). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBhsearch\fR(3C), \fBinsque\fR(3C), \fBlsearch\fR(3C), \fBtsearch\fR(3C), +\fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/select.h.3head b/usr/src/man/man3head/select.h.3head new file mode 100644 index 0000000000..3261dc952b --- /dev/null +++ b/usr/src/man/man3head/select.h.3head @@ -0,0 +1,85 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 select.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +select.h, select \- select types +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/select.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/select.h\fR> header defines the \fBtimeval\fR structure, which +includes the following members: +.sp +.in +2 +.nf +time_t tv_sec /* seconds */ +suseconds_t tv_usec /* microseconds */ +.fi +.in -2 + +.sp +.LP +The \fBtime_t\fR and \fBsuseconds_t\fR types are defined as described in +<\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD). +.sp +.LP +The \fBsigset_t\fR type is defined as described in \fBsignal.h\fR(3HEAD). +.sp +.LP +The \fBtimespec\fR structure is defined as described in <\fBtime.h\fR>. See +\fBtime.h\fR(3HEAD). +.sp +.LP +The <\fBsys/select.h\fR> header defines the \fBfd_set\fR type as a structure. +.sp +.LP +The following is defined as a macro: +.sp +.ne 2 +.mk +.na +\fB\fBFD_SETSIZE\fR\fR +.ad +.RS 14n +.rt +Maximum number of file descriptors in an \fBfd_set\fR structure. +.RE + +.sp +.LP +Inclusion of the <\fBsys/select.h\fR> header can make visible all symbols from +the headers <\fBsignal.h\fR>, <\fBsys/time.h\fR>, and <\fBtime.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBselect\fR(3C), \fBsignal.h\fR(3HEAD), \fBtime.h\fR(3HEAD), +\fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/sem.h.3head b/usr/src/man/man3head/sem.h.3head new file mode 100644 index 0000000000..1bb83bd444 --- /dev/null +++ b/usr/src/man/man3head/sem.h.3head @@ -0,0 +1,188 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 sem.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +sem.h, sem \- semaphore facility +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/sem.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/sem.h\fR> header defines the following constants and structures. +.sp +.LP +Semaphore operation flags: +.sp +.ne 2 +.mk +.na +\fB\fBSEM_UNDO\fR\fR +.ad +.RS 12n +.rt +Set up adjust on exit entry. +.RE + +.sp +.LP +Command definitions for the \fBsemctl()\fR function are provided as listed +below. See \fBsemctl\fR(2). +.sp +.ne 2 +.mk +.na +\fB\fBGETNCNT\fR\fR +.ad +.RS 11n +.rt +Get \fBsemncnt\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGETPID\fR\fR +.ad +.RS 11n +.rt +Get \fBsempid\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGETVAL\fR\fR +.ad +.RS 11n +.rt +Get \fBsemval\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGETALL\fR\fR +.ad +.RS 11n +.rt +Get all cases of \fBsemval\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBGETZCNT\fR\fR +.ad +.RS 11n +.rt +Get \fBsemzcnt\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSETVAL\fR\fR +.ad +.RS 11n +.rt +Set \fBsemval\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSETALL\fR\fR +.ad +.RS 11n +.rt +Set all cases of \fBsemval\fR. +.RE + +.sp +.LP +The \fBsemid_ds\fR structure contains the following members: +.sp +.in +2 +.nf +struct ipc_perm sem_perm /* operation permission structure */ +unsigned short sem_nsems /* number of semaphores in set */ +time_t sem_otime /* last \fBsemop()\fR time */ +time_t sem_ctime /* last time changed by \fBsemctl()\fR */ +.fi +.in -2 + +.sp +.LP +The \fBpid_t\fR, \fBtime_t\fR, \fBkey_t\fR, and \fBsize_t\fR types are defined +as described in <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD). +.sp +.LP +A semaphore is represented by an anonymous structure containing the following +members: +.sp +.in +2 +.nf +unsigned short semval /* semaphore value */ +pid_t sempid /* process ID of last operation */ +unsigned short semncnt /* number of processes waiting for \fBsemval\fR + to become greater than current value */ +unsigned short semzcnt /* number of processes waiting for \fBsemval\fR + to become 0 */ +.fi +.in -2 + +.sp +.LP +The \fBsembuf\fR structure contains the following members: +.sp +.in +2 +.nf +unsigned short sem_num /* semaphore number */ +short sem_op /* semaphore operation */ +short sem_flg /* operation flags */ +.fi +.in -2 + +.sp +.LP +All of the symbols from <\fBsys/ipc.h\fR> are defined when this header is +included. See \fBipc.h\fR(3HEAD). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBsemctl\fR(2), \fBsemget\fR(2), \fBsemop\fR(2), \fBipc.h\fR(3HEAD), +\fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/semaphore.h.3head b/usr/src/man/man3head/semaphore.h.3head new file mode 100644 index 0000000000..b43b8fb6c5 --- /dev/null +++ b/usr/src/man/man3head/semaphore.h.3head @@ -0,0 +1,58 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. +.\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 semaphore.h 3HEAD "5 Feb 2008" "SunOS 5.11" "Headers" +.SH NAME +semaphore.h, semaphore \- semaphores +.SH SYNOPSIS +.LP +.nf +#include <\fBsemaphore.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsemaphore.h\fR> header defines the \fBsem_t\fR type, used in performing +semaphore operations. The semaphore can be implemented using a file descriptor, +in which case applications are able to open up at least a total of +{\fBOPEN_MAX\fR} files and semaphores. The symbol \fBSEM_FAILED\fR is defined +(see \fBsem_open\fR(3C)). +.sp +.LP +Inclusion of the <\fBsemaphore.h\fR> header can make visible symbols defined in +the headers <\fBfcntl.h\fR> and <\fBsys/types.h\fR>. See \fBfcntl.h\fR(3HEAD) +and \fBtypes.h\fR(3HEAD). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityCommitted +_ +StandardSee \fBstandards\fR(5). +.TE + +.SH SEE ALSO +.sp +.LP +\fBfcntl.h\fR(3HEAD), \fBtypes.h\fR(3HEAD), \fBsem_destroy\fR(3C), +\fBsem_getvalue\fR(3C), \fBsem_init\fR(3C), \fBsem_open\fR(3C), +\fBsem_post\fR(3C), \fBsem_timedwait\fR(3C), \fBsem_unlink\fR(3C), +\fBsem_wait\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/setjmp.h.3head b/usr/src/man/man3head/setjmp.h.3head new file mode 100644 index 0000000000..e7ea7a369a --- /dev/null +++ b/usr/src/man/man3head/setjmp.h.3head @@ -0,0 +1,45 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 setjmp.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +setjmp.h, setjmp \- stack environment declarations +.SH SYNOPSIS +.LP +.nf +#include <\fBsetjmp.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsetjmp.h\fR> header defines the array types \fBjmp_buf\fR and +\fBsigjmp_buf\fR. Applications must define the appropriate feature test macro +to enable the visibility of the symbols in this header. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fB_longjmp\fR(3C), \fBsetjmp\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/shm.h.3head b/usr/src/man/man3head/shm.h.3head new file mode 100644 index 0000000000..da33063441 --- /dev/null +++ b/usr/src/man/man3head/shm.h.3head @@ -0,0 +1,121 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 shm.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +shm.h, shm \- shared memory facility +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/shm.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/shm.h\fR> header defines the following symbolic constants: +.sp +.ne 2 +.mk +.na +\fB\fBSHM_RDONLY\fR\fR +.ad +.RS 14n +.rt +attach read-only (else read-write) +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSHM_RND\fR\fR +.ad +.RS 14n +.rt +round attach address to SHMLBA +.RE + +.sp +.LP +The <\fBsys/shm.h\fR> header defines the following symbolic value: +.sp +.ne 2 +.mk +.na +\fB\fBSHMLBA\fR\fR +.ad +.RS 10n +.rt +segment low boundary address multiple +.RE + +.sp +.LP +The following data types are defined through \fBtypedef\fR: +.sp +.ne 2 +.mk +.na +\fB\fBshmatt_t\fR\fR +.ad +.RS 12n +.rt +Unsigned integer used for the number of current attaches that must be able to +store values at least as large as a type unsigned short. +.RE + +.sp +.LP +The \fBshmid_ds\fR structure contains the following members: +.sp +.in +2 +.nf +struct ipc_perm shm_perm /* operation permission structure */ +size_t shm_segsz /* size of segment in bytes */ +pid_t shm_lpid /* process ID of last shared memory + operation */ +pid_t shm_cpid /* process ID of creator */ +shmatt_t shm_nattch /* number of current attaches */ +time_t shm_atime /* time of last \fBshmat()\fR */ +time_t shm_dtime /* time of last \fBshmdt()\fR */ +time_t shm_ctime /* time of last change by \fBshmctl()\fR */ +.fi +.in -2 + +.sp +.LP +The \fBpid_t\fR, \fBtime_t\fR, \fBkey_t\fR, and \fBsize_t\fR types are defined +as described in <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD). +.sp +.LP +In addition, all of the symbols from <\fBsys/ipc.h\fR> are defined when this +header is included. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBshmctl\fR(2), \fBshmget\fR(2), \fBshmop\fR(2), \fBipc.h\fR(3HEAD), +\fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/siginfo.h.3head b/usr/src/man/man3head/siginfo.h.3head new file mode 100644 index 0000000000..d8be5c81fd --- /dev/null +++ b/usr/src/man/man3head/siginfo.h.3head @@ -0,0 +1,294 @@ +'\" te +.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 1989 AT&T +.\" 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 siginfo.h 3HEAD "5 Feb 2008" "SunOS 5.11" "Headers" +.SH NAME +siginfo.h, siginfo \- signal generation information +.SH SYNOPSIS +.LP +.nf +#include <siginfo.h> +.fi + +.SH DESCRIPTION +.sp +.LP +If a process is catching a signal, it might request information that tells why +the system generated that signal. See \fBsigaction\fR(2). If a process is +monitoring its children, it might receive information that tells why a child +changed state. See \fBwaitid\fR(2). In either case, the system returns the +information in a structure of type \fBsiginfo_t\fR, which includes the +following information: +.sp +.in +2 +.nf +int si_signo /* signal number */ +int si_errno /* error number */ +int si_code /* signal code */ +union sigval si_value /* signal value */ +.fi +.in -2 + +.sp +.LP +\fBsi_signo\fR contains the system-generated signal number. For the +\fBwaitid\fR(2) function, \fBsi_signo\fR is always \fBSIGCHLD\fR. +.sp +.LP +If \fBsi_errno\fR is non-zero, it contains an error number associated with +this signal, as defined in \fB<errno.h>\fR\&. +.sp +.LP +\fBsi_code\fR contains a code identifying the cause of the signal. +.sp +.LP +If the value of the \fBsi_code\fR member is \fBSI_NOINFO,\fR only the +\fBsi_signo\fR member of \fBsiginfo_t\fR is meaningful, and the value of all +other members is unspecified. +.SS "User Signals" +.sp +.LP +If the value of \fBsi_code\fR is less than or equal to 0, then the signal was +generated by a user process (see \fBkill\fR(2), \fB_lwp_kill\fR(2), +\fBsigqueue\fR(3C), \fBsigsend\fR(2), \fBabort\fR(3C), and \fBraise\fR(3C)) and +the \fBsiginfo\fR structure contains the following additional information: +.sp +.in +2 +.nf +pid_t si_pid /* sending process ID */ +uid_t si_uid /* sending user ID */ +ctid_t si_ctid /* sending contract ID */ +zoneid_t si_zoneid /* sending zone ID */S +.fi +.in -2 + +.sp +.LP +If the signal was generated by a user process, the following values are defined +for \fBsi_code\fR: +.sp +.ne 2 +.mk +.na +\fB\fBSI_USER\fR \fR +.ad +.RS 15n +.rt +The implementation sets \fBsi_code\fR to \fBSI_USER\fR if the signal was sent +by \fBkill\fR(2), \fBsigsend\fR(2), \fBraise\fR(3C) or \fBabort\fR(3C). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSI_LWP\fR \fR +.ad +.RS 15n +.rt +The signal was sent by \fB_lwp_kill\fR(2). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSI_QUEUE\fR \fR +.ad +.RS 15n +.rt +The signal was sent by \fBsigqueue\fR(3C). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSI_TIMER\fR \fR +.ad +.RS 15n +.rt +The signal was generated by the expiration of a timer created by +\fBtimer_settime\fR(3C). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSI_ASYNCIO\fR \fR +.ad +.RS 15n +.rt +The signal was generated by the completion of an asynchronous \fBI/O\fR +request. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSI_MESGQ\fR \fR +.ad +.RS 15n +.rt +The signal was generated by the arrival of a message on an empty message queue. +See \fBmq_notify\fR(3C). +.RE + +.sp +.LP +\fBsi_value\fR contains the application specified value, which is passed to the +application's signal-catching function at the time of the signal delivery if +\fBsi_code\fR is any of \fBSI_QUEUE\fR, \fBSI_TIMER\fR, \fBSI_ASYNCHIO\fR, or +\fBSI_MESGQ\fR. +.SS "System Signals" +.sp +.LP +Non-user generated signals can arise for a number of reasons. For all of these +cases, \fBsi_code\fR contains a positive value reflecting the reason why the +system generated the signal: +.sp + +.sp +.TS +tab(); +lw(1.24i) lw(1.74i) lw(2.53i) +lw(1.24i) lw(1.74i) lw(2.53i) +. +SignalCodeReason +_ +SIGILLILL_ILLOPCillegal opcode +ILL_ILLOPNillegal operand +ILL_ILLADRillegal addressing mode +ILL_ILLTRPillegal trap +ILL_PRVOPCprivileged opcode +ILL_PRVREGprivileged register +ILL_COPROCco-processor error +ILL_BADSTKinternal stack error +_ +SIGFPEFPE_INTDIVinteger divide by zero +FPE_INTOVFinteger overflow +FPE_FLTDIVfloating point divide by zero +FPE_FLTOVFfloating point overflow +FPE_FLTUNDfloating point underflow +FPE_FLTRESfloating point inexact result +FPE_FLTINVinvalid floating point operation +FPE_FLTSUBsubscript out of range +_ +SIGSEGVSEGV_MAPERRaddress not mapped to object +SEGV_ACCERRinvalid permissions for mapped object +_ +SIGBUSBUS_ADRALNinvalid address alignment +BUS_ADRERRnon-existent physical address +BUS_OBJERRobject specific hardware error +_ +SIGTRAPTRAP_BRKPTprocess breakpoint +TRAP_TRACEprocess trace trap +_ +SIGCHLDCLD_EXITEDchild has exited +CLD_KILLEDchild was killed +CLD_DUMPEDchild terminated abnormally +CLD_TRAPPEDtraced child has trapped +CLD_STOPPEDchild has stopped +CLD_CONTINUEDstopped child had continued +_ +SIGPOLLPOLL_INdata input available +POLL_OUToutput buffers available +POLL_MSGinput message available +POLL_ERRI/O error +POLL_PRIhigh priority input available +POLL_HUPdevice disconnected +.TE + +.sp +.LP +Signals can also be generated from the resource control subsystem. Where these +signals do not already possess kernel-level \fBsiginfo\fR codes, the +\fBsiginfo\fR \fBsi_code\fR will be filled with \fBSI_RCTL\fR to indicate a +kernel-generated signal from an established resource control value. +.sp + +.sp +.TS +tab(); +cw(1.19i) cw(1.65i) cw(2.65i) +lw(1.19i) lw(1.65i) lw(2.65i) +. +SignalCodeReason +_ +SIGXRESSI_RCTLresource-control generated signal +_ +SIGHUP +SIGTERM +.TE + +.sp +.LP +The uncatchable signals \fBSIGSTOP\fR and \fBSIGKILL\fR have undefined +\fBsiginfo\fR codes. +.sp +.LP +Signals sent with a \fBsiginfo\fR code of \fBSI_RCTL\fR contain code-dependent +information for kernel-generated signals: +.sp + +.sp +.TS +tab(); +cw(1.19i) cw(1.65i) cw(2.65i) +lw(1.19i) lw(1.65i) lw(2.65i) +. +Code FieldValue +_ +SI_RCTLhr_time si_entityprocess-model entity of control +.TE + +.sp +.LP +In addition, the following signal-dependent information is available for +kernel-generated signals: +.sp + +.sp +.TS +tab(); +cw(1.19i) cw(1.67i) cw(2.64i) +lw(1.19i) lw(1.67i) lw(2.64i) +. +SignalFieldValue +_ +SIGILLcaddr_t si_addraddress of faulting instruction +_ +SIGFPE +_ +SIGSEGVcaddr_t si_addraddress of faulting memory reference +SIGBUS +_ +SIGCHLDpid_t si_pidchild process ID +int si_statusexit value or signal +_ +SIGPOLLlong si_bandT{ +band event for \fBPOLL_IN\fR, \fBPOLL_OUT\fR, or \fBPOLL_MSG\fR +T} +.TE + +.SH SEE ALSO +.sp +.LP +\fB_lwp_kill\fR(2), \fBkill\fR(2), \fBsetrctl\fR(2), \fBsigaction\fR(2), +\fBsigsend\fR(2), \fBwaitid\fR(2), \fBabort\fR(3C), \fBaio_read\fR(3C), +\fBmq_notify\fR(3C), \fBraise\fR(3C), \fBsignal.h\fR(3HEAD), +\fBsigqueue\fR(3C), \fBtimer_create\fR(3C), \fBtimer_settime\fR(3C) +.SH NOTES +.sp +.LP +For \fBSIGCHLD\fR signals, if \fBsi_code\fR is equal to \fBCLD_EXITED,\fR +then \fBsi_status\fR is equal to the exit value of the process; otherwise, it +is equal to the signal that caused the process to change state. For some +implementations, the exact value of \fBsi_addr\fR might not be available; in +that case, \fBsi_addr\fR is guaranteed to be on the same page as the faulting +instruction or memory reference. diff --git a/usr/src/man/man3head/signal.h.3head b/usr/src/man/man3head/signal.h.3head new file mode 100644 index 0000000000..93f5c3b6a3 --- /dev/null +++ b/usr/src/man/man3head/signal.h.3head @@ -0,0 +1,508 @@ +'\" te +.\" Copyright (c) 1995 IEEE. All Rights Reserved. +.\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 signal.h 3HEAD "5 Feb 2008" "SunOS 5.11" "Headers" +.SH NAME +signal.h, signal \- base signals +.SH SYNOPSIS +.LP +.nf +\fB#include <signal.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +A signal is an asynchronous notification of an event. A signal is said to be +generated for (or sent to) a process when the event associated with that signal +first occurs. Examples of such events include hardware faults, timer expiration +and terminal activity, as well as the invocation of the \fBkill\fR(2) or +\fBsigsend\fR(2) functions. In some circumstances, the same event generates +signals for multiple processes. A process may request a detailed notification +of the source of the signal and the reason why it was generated. See +\fBsiginfo.h\fR(3HEAD). +.sp +.LP +Signals can be generated synchronously or asynchronously. Events directly +caused by the execution of code by a thread, such as a reference to an +unmapped, protected, or bad memory can generate \fBSIGSEGV\fR or \fBSIGBUS\fR; +a floating point exception can generate \fBSIGFPE\fR; and the execution of an +illegal instruction can generate \fBSIGILL\fR. Such events are referred to as +traps; signals generated by traps are said to be synchronously generated. +Synchronously generated signals are initiated by a specific thread and are +delivered to and handled by that thread. +.sp +.LP +Signals may also be generated by calling \fBkill()\fR, \fBsigqueue()\fR, or +\fBsigsend()\fR. Events such as keyboard interrupts generate signals, such as +\fBSIGINT\fR, which are sent to the target process. Such events are referred to +as interrupts; signals generated by interrupts are said to be asynchronously +generated. Asynchronously generated signals are not directed to a particular +thread but are handled by an arbitrary thread that meets either of the +following conditions: +.RS +4 +.TP +.ie t \(bu +.el o +The thread is blocked in a call to \fBsigwait\fR(2) whose argument includes the +type of signal generated. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +The thread has a signal mask that does not include the type of signal +generated. See \fBpthread_sigmask\fR(3C). Each process can specify a system +action to be taken in response to each signal sent to it, called the signal's +disposition. All threads in the process share the disposition. The set of +system signal actions for a process is initialized from that of its parent. +Once an action is installed for a specific signal, it usually remains installed +until another disposition is explicitly requested by a call to either +\fBsigaction()\fR, \fBsignal()\fR or \fBsigset()\fR, or until the process +\fBexecs()\fR. See \fBsigaction\fR(2) and \fBsignal\fR(3C). When a process +execs, all signals whose disposition has been set to catch the signal will be +set to \fBSIG_DFL.\fR Alternatively, a process may request that the system +automatically reset the disposition of a signal to \fBSIG_DFL\fR after it has +been caught. See \fBsigaction\fR(2) and \fBsignal\fR(3C). +.RE +.SS "SIGNAL DELIVERY" +.sp +.LP +A signal is said to be delivered to a process when a thread within the process +takes the appropriate action for the disposition of the signal. Delivery of a +signal can be blocked. There are two methods for handling delivery of a signal +in a multithreaded application. The first method specifies a signal handler +function to execute when the signal is received by the process. See +\fBsigaction\fR(2). The second method uses \fBsigwait\fR(2) to create a thread +to handle the receipt of the signal. The \fBsigaction()\fR function can be used +for both synchronously and asynchronously generated signals. The +\fBsigwait()\fR function will work only for asynchronously generated signals, +as synchronously generated signals are sent to the thread that caused the +event. The \fBsigwait()\fR function is the recommended for use with a +multithreaded application. +.SS "SIGNAL MASK" +.sp +.LP +Each thread has a signal mask that defines the set of signals currently +blocked from delivery to it. The signal mask of the main thread is inherited +from the signal mask of the thread that created it in the parent process. The +selection of the thread within the process that is to take the appropriate +action for the signal is based on the method of signal generation and the +signal masks of the threads in the receiving process. Signals that are +generated by action of a particular thread such as hardware faults are +delivered to the thread that caused the signal. See \fBpthread_sigmask\fR(3C) +or \fBsigprocmask\fR(2). See \fBalarm\fR(2) for current semantics of delivery +of \fBSIGALRM\fR. Signals that are directed to a particular thread are +delivered to the targeted thread. See \fBpthread_kill\fR(3C). If the selected +thread has blocked the signal, it remains pending on the thread until it is +unblocked. For all other types of signal generation (for example, +\fBkill\fR(2), \fBsigsend\fR(2), terminal activity, and other external events +not ascribable to a particular thread) one of the threads that does not have +the signal blocked is selected to process the signal. If all the threads within +the process block the signal, it remains pending on the process until a thread +in the process unblocks it. If the action associated with a signal is set to +ignore the signal then both currently pending and subsequently generated +signals of this type are discarded immediately for this process. +.sp +.LP +The determination of which action is taken in response to a signal is made at +the time the signal is delivered to a thread within the process, allowing for +any changes since the time of generation. This determination is independent +of the means by which the signal was originally generated. +.sp +.LP +The signals currently defined by <\fBsignal.h\fR> are as follows: +.sp + +.sp +.TS +tab(); +cw(1.38i) cw(.49i) cw(.86i) cw(2.78i) +lw(1.38i) lw(.49i) lw(.86i) lw(2.78i) +. +NameValueDefaultEvent +\fBSIGHUP\fR1ExitHangup (see \fBtermio\fR(7I)) +\fBSIGINT\fR2ExitInterrupt (see \fBtermio\fR(7I)) +\fBSIGQUIT\fR3CoreQuit (see \fBtermio\fR(7I)) +\fBSIGILL\fR4CoreIllegal Instruction +\fBSIGTRAP\fR5CoreTrace or Breakpoint Trap +\fBSIGABRT\fR6CoreAbort +\fBSIGEMT\fR7CoreEmulation Trap +\fBSIGFPE\fR8CoreArithmetic Exception +\fBSIGKILL\fR9ExitKilled +\fBSIGBUS\fR10CoreBus Error +\fBSIGSEGV\fR11CoreSegmentation Fault +\fBSIGSYS\fR12CoreBad System Call +\fBSIGPIPE\fR13ExitBroken Pipe +\fBSIGALRM\fR14ExitAlarm Clock +\fBSIGTERM\fR15ExitTerminated +\fBSIGUSR1\fR16ExitUser Signal 1 +\fBSIGUSR2\fR17ExitUser Signal 2 +\fBSIGCHLD\fR18IgnoreChild Status Changed +\fBSIGPWR\fR19IgnorePower Fail or Restart +\fBSIGWINCH\fR20IgnoreWindow Size Change +\fBSIGURG\fR21IgnoreUrgent Socket Condition +\fBSIGPOLL\fR22ExitPollable Event (see \fBstreamio\fR(7I)) +\fBSIGSTOP\fR23StopStopped (signal) +\fBSIGTSTP\fR24StopStopped (user) (see \fBtermio\fR(7I)) +\fBSIGCONT\fR25IgnoreContinued +\fBSIGTTIN\fR26StopStopped (tty input) (see \fBtermio\fR(7I)) +\fBSIGTTOU\fR27StopStopped (tty output) (see \fBtermio\fR(7I)) +\fBSIGVTALRM\fR28ExitVirtual Timer Expired +\fBSIGPROF\fR29ExitProfiling Timer Expired +\fBSIGXCPU\fR30CoreT{ +CPU time limit exceeded (see \fBgetrlimit\fR(2)) +T} +\fBSIGXFSZ\fR31CoreT{ +File size limit exceeded (see \fBgetrlimit\fR(2)) +T} +\fBSIGWAITING\fR32IgnoreReserved +\fBSIGLWP\fR33IgnoreReserved +\fBSIGFREEZE\fR34IgnoreCheck point Freeze +\fBSIGTHAW\fR35IgnoreCheck point Thaw +\fBSIGCANCEL\fR36IgnoreReserved for threading support +\fBSIGLOST\fR37ExitT{ +Resource lost (for example, record-lock lost) +T} +\fBSIGXRES\fR38IgnoreT{ +Resource control exceeded (see \fBsetrctl\fR(2)) +T} +\fBSIGJVM1\fR39IgnoreReserved for Java Virtual Machine 1 +\fBSIGJVM2\fR40IgnoreReserved for Java Virtual Machine 2 +\fBSIGRTMIN\fR\fB*\fRExitFirst real time signal +(\fBSIGRTMIN\fR+1)*ExitSecond real time signal +\fB\|.\|.\|.\fR +(\fBSIGRTMAX\fR-1)*ExitSecond-to-last real time signal +\fBSIGRTMAX\fR\fB*\fRExitLast real time signal +.TE + +.sp +.LP +The symbols \fBSIGRTMIN\fR through \fBSIGRTMAX\fR are evaluated dynamically to +permit future configurability. +.sp +.LP +Applications should not use any of the signals marked "reserved" in the above +table for any purpose, to avoid interfering with their use by the system. +.SS "SIGNAL DISPOSITION" +.sp +.LP +A process using a \fBsignal\fR(3C), \fBsigset\fR(3C) or \fBsigaction\fR(2) +system call can specify one of three dispositions for a signal: take the +default action for the signal, ignore the signal, or catch the signal. +.SS "Default Action: SIG_DFL" +.sp +.LP +A disposition of \fBSIG_DFL\fR specifies the default action. The default +action for each signal is listed in the table above and is selected from the +following: +.sp +.ne 2 +.mk +.na +\fBExit\fR +.ad +.RS 10n +.rt +When it gets the signal, the receiving process is to be terminated with all the +consequences outlined in \fBexit\fR(2). +.RE + +.sp +.ne 2 +.mk +.na +\fBCore\fR +.ad +.RS 10n +.rt +When it gets the signal, the receiving process is to be terminated with all the +consequences outlined in \fBexit\fR(2). In addition, a ``core image'' of the +process is constructed in the current working directory. +.RE + +.sp +.ne 2 +.mk +.na +\fBStop\fR +.ad +.RS 10n +.rt +When it gets the signal, the receiving process is to stop. When a process is +stopped, all the threads within the process also stop executing. +.RE + +.sp +.ne 2 +.mk +.na +\fBIgnore\fR +.ad +.RS 10n +.rt +When it gets the signal, the receiving process is to ignore it. This is +identical to setting the disposition to \fBSIG_IGN\fR. +.RE + +.SS "Ignore Signal: SIG_IGN" +.sp +.LP +A disposition of \fBSIG_IGN\fR specifies that the signal is to be ignored. +Setting a signal action to \fBSIG_IGN\fR for a signal that is pending causes +the pending signal to be discarded, whether or not it is blocked. Any queued +values pending are also discarded, and the resources used to queue them are +released and made available to queue other signals. +.SS "Catch Signal: function address" +.sp +.LP +A disposition that is a function address specifies that, when it gets the +signal, the thread within the process that is selected to process the signal +will execute the signal handler at the specified address. Normally, the signal +handler is passed the signal number as its only argument. If the disposition +was set with the \fBsigaction\fR(2) function, however, additional arguments can +be requested. When the signal handler returns, the receiving process resumes +execution at the point it was interrupted, unless the signal handler makes +other arrangements. If an invalid function address is specified, results are +undefined. +.sp +.LP +If the disposition has been set with the \fBsigset()\fR or \fBsigaction()\fR, +the signal is automatically blocked in the thread while it is executing the +signal catcher. If a \fBlongjmp()\fR is used to leave the signal catcher, then +the signal must be explicitly unblocked by the user. See \fBsetjmp\fR(3C), +\fBsignal\fR(3C) and \fBsigprocmask\fR(2). +.sp +.LP +If execution of the signal handler interrupts a blocked function call, the +handler is executed and the interrupted function call returns \fB\(mi1\fR to +the calling process with \fBerrno\fR set to \fBEINTR\fR. If the +\fBSA_RESTART\fR flag is set, however, certain function calls will be +transparently restarted. +.sp +.LP +Some signal-generating functions, such as high resolution timer expiration, +asynchronous I/O completion, inter-process message arrival, and the +\fBsigqueue\fR(3C) function, support the specification of an application +defined value, either explicitly as a parameter to the function, or in a +\fBsigevent\fR structure parameter. The \fBsigevent\fR structure is defined by +\fB<signal.h>\fR and contains at least the following members: +.sp + +.sp +.TS +tab(); +cw(1.83i) cw(1.83i) cw(1.83i) +lw(1.83i) lw(1.83i) lw(1.83i) +. +TypeNameDescription +_ +\fBint\fR\fBsigev_notify\fRNotification type +\fBint\fR\fBsigev_signo\fRSignal number +_ +\fBunion sigval\fR\fBsigev_value\fRSignal value +_ +\fBvoid(*)(union sigval)\fR\fBsigev_notify_function\fRNotification function +_ +\fB(pthread_attr_t *)\fR\fBsigev_notify_attributes\fRNotification attributes +.TE + +.sp +.LP +The \fBsigval\fR union is defined by \fB<signal.h>\fRand contains at least the +following members: +.sp + +.sp +.TS +tab(); +cw(1.83i) cw(1.83i) cw(1.83i) +lw(1.83i) lw(1.83i) lw(1.83i) +. +TypeNameDescription +_ +\fBint\fR\fBsival_int\fRInteger signal value +\fBvoid *\fR\fBsival_ptr\fRPointer signal value +.TE + +.sp +.LP +The \fBsigev_notify\fR member specifies the notification mechanism to use when +an asynchronous event occurs. The \fBsigev_notify\fR member may be defined with +the following values: +.sp +.ne 2 +.mk +.na +\fB\fBSIGEV_NONE\fR\fR +.ad +.RS 16n +.rt +No asynchronous notification is delivered when the event of interest occurs. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSIGEV_SIGNAL\fR\fR +.ad +.RS 16n +.rt +A queued signal, with its value equal to \fBsigev_signo\fR, is generated when +the event of interest occurs. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSIGEV_THREAD\fR\fR +.ad +.RS 16n +.rt +The \fBsigev_notify_function\fR is called, with \fBsigev_value\fR as its +argument, to perform notification when the asynchronous event occurs. The +function is executed in an environment as if it were the start routine for a +newly created thread with thread attributes \fBsigev_notify_attributes\fR. If +\fBsigev_notify_attributes\fR is \fINULL\fR, the thread runs as a detached +thread with default attributes. Otherwise, the thread runs with the specified +attributes, but as a detached thread regardless. The thread runs with all +blockable signals blocked. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSIGEV_PORT\fR\fR +.ad +.RS 16n +.rt +An asynchronous notification is delivered to an event port when the event of +interest occurs. The \fBsigev_value.sival_ptr\fR member points to a +\fBport_notify_t\fR structure defined in <\fBport.h\fR> (see +\fBport_associate\fR(3C)). The event port identifier as well as an +application-defined cookie are part of the \fBport_notify_t\fR structure. +.RE + +.sp +.LP +The \fBsigev_signo\fR member contains the application-defined value to be +passed to the signal-catching function (for notification type +\fBSIGEV_SIGNAL\fR) at the time of the signal delivery as the \fBsi_value\fR +member of the \fBsiginfo_t\fR structure, or as the argument to the notification +function (for notification type \fBSIGEV_THREAD\fR) that is called when the +asynchronous event occurs. For notification type \fBSIGEV_PORT\fR, +\fBsigev_value.sival_ptr\fR points to a \fBport_notify_t\fR structure that +specifies the port and an application-defined cookie. +.sp +.LP +The \fBsigev_value\fR member references the application defined value to be +passed to the signal-catching function at the time of the signal delivery as +the \fBsi_value\fR member of the \fBsiginfo_t\fR structure. +.sp +.LP +The \fBsival_int\fR member is used when the application defined value is of +type \fBint\fR, and the \fBsival_ptr\fR member is used when the application +defined value is a pointer. +.sp +.LP +When a signal is generated by \fBsigqueue\fR(3C) or any signal\(migenerating +function which supports the specification of an application defined value, the +signal is marked pending and, if the \fBSA_SIGINFO\fR flag is set for that +signal, the signal is queued to the process along with the application +specified signal value. Multiple occurrences of signals so generated are queued +in FIFO order. If the \fBSA_SIGINFO\fR flag is not set for that signal, later +occurrences of that signal's generation, when a signal is already queued, are +silently discarded. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityCommitted +_ +StandardSee \fBstandards\fR(5). +.TE + +.SH SEE ALSO +.sp +.LP +\fBlockd\fR(1M), \fBIntro\fR(2), \fBalarm\fR(2), \fBexit\fR(2), \fBfcntl\fR(2), +\fBgetrlimit\fR(2), \fBioctl\fR(2), \fBkill\fR(2), \fBpause\fR(2), +\fBsetrctl\fR(2), \fBsigaction\fR(2), \fBsigaltstack\fR(2), +\fBsigprocmask\fR(2), \fBsigsend\fR(2), \fBsigsuspend\fR(2), \fBsigwait\fR(2), +\fBport_associate\fR(3C), \fBpthread_create\fR(3C), \fBpthread_kill\fR(3C), +\fBpthread_sigmask\fR(3C), \fBsetjmp\fR(3C), \fBsiginfo.h\fR(3HEAD), +\fBsignal\fR(3C), \fBsigqueue\fR(3C), \fBsigsetops\fR(3C), +\fBucontext.h\fR(3HEAD), \fBwait\fR(3C), \fBattributes\fR(5), +\fBstandards\fR(5) +.SH NOTES +.sp +.LP +The dispositions of the \fBSIGKILL\fR and \fBSIGSTOP\fR signals cannot be +altered from their default values. The system generates an error if this is +attempted. +.sp +.LP +The \fBSIGKILL\fR, \fBSIGSTOP\fR, and \fBSIGCANCEL\fR signals cannot be +blocked. The system silently enforces this restriction. +.sp +.LP +The \fBSIGCANCEL\fR signal cannot be directed to an individual thread using +\fBpthread_kill\fR(3C), but it can be sent to a process using \fBkill\fR(2), +\fBsigsend\fR(2), or \fBsigqueue\fR(3C). +.sp +.LP +Whenever a process receives a \fBSIGSTOP\fR, \fBSIGTSTP\fR, \fBSIGTTIN\fR, or +\fBSIGTTOU\fR signal, regardless of its disposition, any pending \fBSIGCONT\fR +signal are discarded. +.sp +.LP +Whenever a process receives a \fBSIGCONT\fR signal, regardless of its +disposition, any pending \fBSIGSTOP\fR, \fBSIGTSTP\fR, \fBSIGTTIN\fR, and +\fBSIGTTOU\fR signals is discarded. In addition, if the process was stopped, it +is continued. +.sp +.LP +\fBSIGPOLL\fR is issued when a file descriptor corresponding to a STREAMS file +has a "selectable" event pending. See \fBIntro\fR(2). A process must +specifically request that this signal be sent using the \fBI_SETSIG\fR +\fBioctl\fR call. Otherwise, the process will never receive \fBSIGPOLL\fR. +.sp +.LP +If the disposition of the \fBSIGCHLD\fR signal has been set with \fBsignal()\fR +or \fBsigset()\fR, or with \fBsigaction()\fR and the \fBSA_NOCLDSTOP\fR flag +has been specified, it will only be sent to the calling process when its +children exit; otherwise, it will also be sent when the calling process's +children are stopped or continued due to job control. +.sp +.LP +The name \fBSIGCLD\fR is also defined in this header and identifies the same +signal as \fBSIGCHLD\fR. \fBSIGCLD\fR is provided for backward compatibility, +new applications should use \fBSIGCHLD\fR. +.sp +.LP +The disposition of signals that are inherited as \fBSIG_IGN\fR should not be +changed. +.sp +.LP +Signals which are generated synchronously should not be masked. If such a +signal is blocked and delivered, the receiving process is killed. diff --git a/usr/src/man/man3head/socket.h.3head b/usr/src/man/man3head/socket.h.3head new file mode 100644 index 0000000000..03693c7dc8 --- /dev/null +++ b/usr/src/man/man3head/socket.h.3head @@ -0,0 +1,832 @@ +'\" te +.\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved. +.\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text +.\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical +.\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 socket.h 3HEAD "28 Jan 2009" "SunOS 5.11" "Headers" +.SH NAME +socket.h, socket \- Internet Protocol family +.SH SYNOPSIS +.LP +.nf +\fB#include <sys/socket.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The \fB<sys/socket.h>\fR header defines the unsigned integral type +\fBsa_family_t\fR through \fBtypedef\fR. +.sp +.LP +The \fB<sys/socket.h>\fR header defines the \fBsockaddr\fR structure that +includes the following members: +.sp +.in +2 +.nf +sa_family_t sa_family /* address family */ +char sa_data[] /* socket address (variable-length + data) */ +.fi +.in -2 + +.SS "\fBlibxnet\fR Interfaces" +.sp +.LP +The \fB<sys/socket.h>\fR header defines the \fBmsghdr\fR structure for +\fBlibxnet\fR interfaces that includes the following members: +.sp +.in +2 +.nf +void *msg_name /* optional address */ +socklen_t msg_namelen /* size of address */ +struct iovec *msg_iov /* scatter/gather array */ +int msg_iovlen /* members in msg_iov */ +void *msg_control /* ancillary data, see below */ +socklen_t msg_controllen /* ancillary data buffer len */ +int msg_flags /* flags on received message */ +.fi +.in -2 + +.sp +.LP +The \fB<sys/socket.h>\fR header defines the \fBcmsghdr\fR structure for +\fBlibxnet\fR that includes the following members: +.sp +.in +2 +.nf +socklen_t cmsg_len /* data byte count, including hdr */ +int cmsg_level /* originating protocol */ +int cmsg_type /* protocol-specific type */ +.fi +.in -2 + +.sp +.LP +Ancillary data consists of a sequence of pairs, each consisting of a +\fBcmsghdr\fR structure followed by a data array. The data array contains the +ancillary data message, and the \fBcmsghdr\fR structure contains descriptive +information that allows an application to correctly parse the data. +.sp +.LP +The values for \fBcmsg_level\fR will be legal values for the level argument to +the \fBgetsockopt()\fR and \fBsetsockopt()\fR functions. The \fBSCM_RIGHTS\fR +type is supported for level \fBSOL_SOCKET\fR. +.sp +.LP +Ancillary data is also possible at the socket level. The \fB<sys/socket.h>\fR +header defines the following macros for use as the \fBcmsg_type\fR values when +\fBcmsg_level\fR is \fBSOL_SOCKET\fR. +.sp +.ne 2 +.mk +.na +\fB\fBSCM_RIGHTS\fR\fR +.ad +.RS 14n +.rt +Indicates that the data array contains the access rights to be sent or +received. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSCM_UCRED\fR\fR +.ad +.RS 14n +.rt +Indicates that the data array contains a \fBucred_t\fR to be received. The +\fBucred_t\fR is the credential of the sending process at the time the message +was sent. This is a Sun-specific, Evolving interface. See \fBucred_get\fR(3C). +.RE + +.sp +.LP +The IPv4 data formats generally use the same values for data passed back in +\fBcmsghdr\fR as for \fBsetsockopt()\fR to enable the feature. The IPv4 data +formats are listed below with the associated payload for each. +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IP\fR\fR +.ad +.br +.na +\fB\fBIP_RECVDSTADDR\fR\fR +.ad +.sp .6 +.RS 4n +\fBipaddr_t\fR, IP address +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IP\fR\fR +.ad +.br +.na +\fB\fBIP_RECVOPTS\fR\fR +.ad +.sp .6 +.RS 4n +variable-length IP options, up to 40 bytes +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IP\fR\fR +.ad +.br +.na +\fB\fBIP_RECVIF\fR\fR +.ad +.sp .6 +.RS 4n +\fBuint_t\fR, \fBifIndex\fR number +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IP\fR\fR +.ad +.br +.na +\fB\fBIP_RECVSLLA\fR\fR +.ad +.sp .6 +.RS 4n +\fBstruct sockaddr_dl\fR, link layer address +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IP\fR\fR +.ad +.br +.na +\fB\fBIP_RECVTTL\fR\fR +.ad +.sp .6 +.RS 4n +\fBuint8_t\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSOL_SOCKET\fR\fR +.ad +.br +.na +\fB\fBSO_RECVUCRED\fR\fR +.ad +.sp .6 +.RS 4n +\fBucred_t\fR \(em \fBcmsghdr.cmsg_type\fR is \fBSCM_UCRED\fR, not +\fBSO_RECVUCRED\fR +.RE + +.sp +.LP +The IPv6 data formats use different values for enabling the option and for +passing the value back to the application. The IPv6 data formats are listed +below with the associated payload for each. +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IPV6\fR\fR +.ad +.br +.na +\fB\fBIPV6_RECVPKTINFO\fR\fR +.ad +.sp .6 +.RS 4n +\fBin_pktinfo\fR, \fBcmsg_type\fR \fBIPV6_PKTINFO\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IPV6\fR\fR +.ad +.br +.na +\fB\fBIPV6_RECVTCLASS\fR\fR +.ad +.sp .6 +.RS 4n +\fBuint_t\fR, \fBcmsg_type\fR \fBIPV6_TCLASS\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IPV6\fR\fR +.ad +.br +.na +\fB\fBIPV6_RECVPATHMTU\fR\fR +.ad +.sp .6 +.RS 4n +\fBip6_mtuinfo\fR, \fBcmsg_type\fR \fBIPV6_PATHMTU\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IPV6\fR\fR +.ad +.br +.na +\fB\fBIPV6_RECVHOPLIMIT\fR\fR +.ad +.sp .6 +.RS 4n +\fBuint_t\fR, \fBcmsg_type\fR \fBIPV6_HOPLIMIT\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IPV6\fR\fR +.ad +.br +.na +\fB\fBIPV6_RECVHOPOPTS\fR\fR +.ad +.sp .6 +.RS 4n +variable-length IPv6 options, \fBcmsg_type\fR \fBIPV6_HOPOPTS\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IPV6\fR\fR +.ad +.br +.na +\fB\fBIPV6_RECVDSTOPTS\fR\fR +.ad +.sp .6 +.RS 4n +variable-length IPv6 options, \fBcmsg_type\fR \fBIPV6_DSTOPTS\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IPV6\fR\fR +.ad +.br +.na +\fB\fBIPV6_RECVRTHDR\fR\fR +.ad +.sp .6 +.RS 4n +variable-length IPv6 options, \fBcmsg_type\fR \fBIPV6_RTHDR\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IPV6\fR\fR +.ad +.br +.na +\fB\fBIPV6_RECVRTHDRDSTOPTS\fR\fR +.ad +.sp .6 +.RS 4n +variable-length IPv6 options, \fBcmsg_type\fR \fBIPV6_DSTOPTS\fR +.RE + +.sp +.LP +The \fB<sys/socket.h>\fR header defines the following macros to gain access to +the data arrays in the ancillary data associated with a message header: +.sp +.ne 2 +.mk +.na +\fB\fBCMSG_DATA(\fR\fIcmsg\fR)\fR +.ad +.sp .6 +.RS 4n +If the argument is a pointer to a \fBcmsghdr\fR structure, this macro returns +an unsigned character pointer to the data array associated with the +\fBcmsghdr\fR structure. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCMSG_NXTHDR(\fR\fImhdr\fR, \fIcmsg\fR)\fR +.ad +.sp .6 +.RS 4n +If the first argument is a pointer to a \fBmsghdr\fR structure and the second +argument is a pointer to a \fBcmsghdr\fR structure in the ancillary data, +pointed to by the \fBmsg_control\fR field of that \fBmsghdr\fR structure, this +macro returns a pointer to the next \fBcmsghdr\fR structure, or a null pointer +if this structure is the last \fBcmsghdr\fR in the ancillary data. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCMSG_FIRSTHDR(\fR\fImhdr\fR)\fR +.ad +.sp .6 +.RS 4n +If the argument is a pointer to a \fBmsghdr\fR structure, this macro returns a +pointer to the first \fBcmsghdr\fR structure in the ancillary data associated +with this \fBmsghdr\fR structure, or a null pointer if there is no ancillary +data associated with the \fBmsghdr\fR structure. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCMSG_SPACE\fR(\fIlen\fR)\fR +.ad +.sp .6 +.RS 4n +Given the length of an ancillary data object, \fBCMSG_SPACE()\fR returns the +space required by the object and its \fBcmsghdr\fR structure, including any +padding needed to satisfy alignment requirements. This macro can be used, for +example, to allocate space dynamically for the ancillary data. This macro +should not be used to initialize the \fBcmsg_len\fR member of a \fBcmsghdr\fR +structure. Use the \fBCMSG_LEN()\fR macro instead. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCMSG_LEN\fR(\fIlen\fR)\fR +.ad +.sp .6 +.RS 4n +Given the length of an ancillary data object, \fBCMSG_LEN()\fR returns the +value to store in the cmsg_len member of the \fBcmsghdr\fR structure, taking +into account any padding needed to satisfy alignment requirements. +.RE + +.sp +.LP +The \fB<sys/socket.h>\fR header defines the \fBlinger\fR structure that +includes the following members: +.sp +.in +2 +.nf +int l_onoff /* indicates whether linger option is enabled */ +int l_linger /* linger time, in seconds */ +.fi +.in -2 + +.sp +.LP +The \fB<sys/socket.h>\fR header defines the following macros: +.sp +.ne 2 +.mk +.na +\fB\fBSOCK_DGRAM\fR\fR +.ad +.RS 18n +.rt +Datagram socket +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSOCK_STREAM\fR\fR +.ad +.RS 18n +.rt +Byte-stream socket +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSOCK_SEQPACKET\fR\fR +.ad +.RS 18n +.rt +Sequenced-packet socket +.RE + +.sp +.LP +The \fB<sys/socket.h>\fR header defines the following macros for use as the +\fIlevel\fR argument of \fBsetsockopt()\fR and \fBgetsockopt()\fR. +.sp +.ne 2 +.mk +.na +\fB\fBSOL_SOCKET\fR\fR +.ad +.RS 14n +.rt +Options to be accessed at the socket level, not the protocol level. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSOL_ROUTE\fR\fR +.ad +.RS 14n +.rt +Options to be accessed at the routing socket level, not the protocol level. +.RE + +.sp +.LP +The \fB<sys/socket.h>\fR header defines the following macros for use as the +\fIoption_name\fR argument of \fBgetsockopt()\fR or \fBsetsockopt()\fR calls: +.sp +.ne 2 +.mk +.na +\fB\fBSO_DEBUG\fR\fR +.ad +.RS 17n +.rt +Debugging information is being recorded. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_ACCEPTCONN\fR\fR +.ad +.RS 17n +.rt +Socket is accepting connections. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_BROADCAST\fR\fR +.ad +.RS 17n +.rt +Transmission of broadcast messages is supported. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_REUSEADDR\fR\fR +.ad +.RS 17n +.rt +Reuse of local addresses is supported. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_KEEPALIVE\fR\fR +.ad +.RS 17n +.rt +Connections are kept alive with periodic messages. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_LINGER\fR\fR +.ad +.RS 17n +.rt +Socket lingers on close. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_OOBINLINE\fR\fR +.ad +.RS 17n +.rt +Out-of-band data is transmitted in line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_SNDBUF\fR\fR +.ad +.RS 17n +.rt +Send buffer size. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_RCVBUF\fR\fR +.ad +.RS 17n +.rt +Receive buffer size. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_ERROR\fR\fR +.ad +.RS 17n +.rt +Socket error status. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_TYPE\fR\fR +.ad +.RS 17n +.rt +Socket type. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_RECVUCRED\fR\fR +.ad +.RS 17n +.rt +Request the reception of user credential ancillary data. This is a +Sun-specific, Evolving interface. See \fBucred_get\fR(3C). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_MAC_EXEMPT\fR\fR +.ad +.RS 17n +.rt +Mandatory Access Control (\fBMAC\fR) exemption for unlabeled peers. This option +is available only if the system is configured with Trusted Extensions. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSO_ALLZONES\fR\fR +.ad +.RS 17n +.rt +Bypass zone boundaries (privileged). +.RE + +.sp +.LP +The \fB<sys/socket.h>\fR header defines the following macros for use as the +valid values for the \fBmsg_flags\fR field in the \fBmsghdr\fR structure, or +the flags parameter in \fBrecvfrom()\fR, \fBrecvmsg()\fR, \fBsendto()\fR, or +\fBsendmsg()\fR calls: +.sp +.ne 2 +.mk +.na +\fB\fBMSG_CTRUNC\fR\fR +.ad +.RS 15n +.rt +Control data truncated. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMSG_EOR\fR\fR +.ad +.RS 15n +.rt +Terminates a record (if supported by the protocol). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMSG_OOB\fR\fR +.ad +.RS 15n +.rt +Out-of-band data. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMSG_PEEK\fR\fR +.ad +.RS 15n +.rt +Leave received data in queue. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMSG_TRUNC\fR\fR +.ad +.RS 15n +.rt +Normal data truncated. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMSG_WAITALL\fR\fR +.ad +.RS 15n +.rt +Wait for complete message. +.RE + +.sp +.LP +The \fB<sys/socket.h>\fR header defines the following macros: +.sp +.ne 2 +.mk +.na +\fB\fBAF_UNIX\fR\fR +.ad +.RS 11n +.rt +UNIX domain sockets +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBAF_INET\fR\fR +.ad +.RS 11n +.rt +Internet domain sockets +.RE + +.sp +.LP +The \fB<sys/socket.h>\fR header defines the following macros: +.sp +.ne 2 +.mk +.na +\fB\fBSHUT_RD\fR\fR +.ad +.RS 13n +.rt +Disables further receive operations. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSHUT_WR\fR\fR +.ad +.RS 13n +.rt +Disables further send operations. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSHUT_RDWR\fR\fR +.ad +.RS 13n +.rt +Disables further send and receive operations. +.RE + +.SS "\fBlibsocket\fR Interfaces" +.sp +.LP +The \fB<sys/socket.h>\fR header defines the \fBmsghdr\fR structure for +\fBlibsocket\fR interfaces that includes the following members: +.sp +.in +2 +.nf +void *msg_name /* optional address */ +socklen_t msg_namelen /* size of address */ +struct iovec *msg_iov /* scatter/gather array */ +int msg_iovlen /* # elements in msg_iov */ +caddr_t msg_accrights /* access rights sent/received */ +.fi +.in -2 + +.sp +.LP +The \fImsg_name\fR and \fImsg_namelen\fR parameters specify the destination +address when the socket is unconnected The \fImsg_name\fR can be specified as a +\fINULL\fR pointer if no names are desired or required. The \fImsg_iov\fR and +\fImsg_iovlen\fR parameters describe the scatter-gather locations, as described +in \fBread\fR(2). The \fImsg_accrights\fR parameter specifies the buffer in +which access rights sent along with the message are received. The +\fImsg_accrightslen\fR specifies the length of the buffer. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBaccept\fR(3SOCKET), \fBaccept\fR(3XNET), \fBbind\fR(3SOCKET), +\fBbind\fR(3XNET), \fBconnect\fR(3SOCKET), \fBconnect\fR(3XNET), +\fBgetpeername\fR(3SOCKET), \fBgetpeername\fR(3XNET), \fBgetpeerucred\fR(3C), +\fBgetsockname\fR(3SOCKET), \fBgetsockname\fR(3XNET), +\fBgetsockopt\fR(3SOCKET), \fBgetsockopt\fR(3XNET), \fBlibsocket\fR(3LIB), +\fBlisten\fR(3SOCKET), \fBlisten\fR(3XNET), \fBrecv\fR(3SOCKET), +\fBrecv\fR(3XNET), \fBrecvfrom\fR(3SOCKET), \fBrecvfrom\fR(3XNET), +\fBrecvmsg\fR(3SOCKET), \fBrecvmsg\fR(3XNET), \fBsend\fR(3SOCKET), +\fBsend\fR(3XNET), \fBsendmsg\fR(3SOCKET), \fBsendmsg\fR(3XNET), +\fBsendto\fR(3SOCKET), \fBsendto\fR(3XNET), \fBsetsockopt\fR(3SOCKET), +\fBsetsockopt\fR(3XNET), \fBshutdown\fR(3SOCKET), \fBshutdown\fR(3XNET), +\fBsocket\fR(3SOCKET), \fBsocket\fR(3XNET), \fBsocketpair\fR(3SOCKET), +\fBsocketpair\fR(3XNET), \fBucred_get\fR(3C), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/spawn.h.3head b/usr/src/man/man3head/spawn.h.3head new file mode 100644 index 0000000000..b941bdfd1e --- /dev/null +++ b/usr/src/man/man3head/spawn.h.3head @@ -0,0 +1,66 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 spawn.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +spawn.h, spawn \- spawn +.SH SYNOPSIS +.LP +.nf +#include <\fBspawn.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBspawn.h\fR> header defines the \fBposix_spawnattr_t\fR and +\fBposix_spawn_file_actions_t\fR types used in performing spawn operations. +.sp +.LP +The <\fBspawn.h\fR> header defines the flags that can be set in a +\fBposix_spawnattr_t\fR object using the \fBposix_spawnattr_setflags()\fR +function: +.sp +.in +2 +.nf +POSIX_SPAWN_RESETIDS +POSIX_SPAWN_SETPGROUP +POSIX_SPAWN_SETSCHEDPARAM +POSIX_SPAWN_SETSCHEDULER +POSIX_SPAWN_SETSIGDEF +POSIX_SPAWN_SETSIGMASK +.fi +.in -2 + +.sp +.LP +Inclusion of the <\fBspawn.h\fR> header can make visible symbols defined in the +<\fBsched.h\fR>, <\fBsignal.h\fR>, and <\fBsys/types.h\fR> headers. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBsched.h\fR(3HEAD), \fBsemaphore.h\fR(3HEAD), \fBsignal.h\fR(3HEAD), +\fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/stat.h.3head b/usr/src/man/man3head/stat.h.3head new file mode 100644 index 0000000000..deadaf3a9e --- /dev/null +++ b/usr/src/man/man3head/stat.h.3head @@ -0,0 +1,122 @@ +'\" te +.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 1989 AT&T +.\" 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 stat.h 3HEAD "1 Sep 2009" "SunOS 5.11" "Headers" +.SH NAME +stat.h, stat \- data returned by stat system call +.SH SYNOPSIS +.LP +.nf +#include <sys/types.h> +#include <sys/stat.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The system calls \fBstat()\fR, \fBlstat()\fR and \fBfstat()\fR return data in a +\fBstat\fR structure, which is defined in <\fBstat.h\fR>. +.sp +.LP +The constants used in the \fBst_mode\fR field are also defined in this file: +.sp + +.sp +.TS +tab(); +lw(.81i) lw(1.38i) lw(3.32i) +lw(.81i) lw(1.38i) lw(3.32i) +. +#defineS_IFMT/* type of file */ +#defineS_IAMB/* access mode bits */ +#defineS_IFIFO/* fifo */ +#defineS_IFCHR/* character special */ +#defineS_IFDIR/* directory */ +#defineS_IFNAM/* \fBXENIX\fR special named file */ +#defineS_INSEM/* \fBXENIX\fR semaphore subtype of \fBIFNAM\fR */ +#defineS_INSHD/* \fBXENIX\fR shared data subtype of \fBIFNAM\fR */ +#defineS_IFBLK/* block special */ +#defineS_IFREG/* regular */ +#defineS_IFLNK/* symbolic link */ +#defineS_IFSOCK/* socket */ +#defineS_IFDOOR/* door */ +#defineS_ISUID/* set user id on execution */ +#defineS_ISGID/* set group id on execution */ +#defineS_ISVTX/* save swapped text even after use */ +#defineS_IREAD/* read permission, owner */ +#defineS_IWRITE/* write permission, owner */ +#defineS_IEXEC/* execute/search permission, owner */ +#defineS_ENFMT/* record locking enforcement flag */ +#defineS_IRWXU/* read, write, execute: owner */ +#defineS_IRUSR/* read permission: owner */ +#defineS_IWUSR/* write permission: owner */ +#defineS_IXUSR/* execute permission: owner */ +#defineS_IRWXG/* read, write, execute: group */ +#defineS_IRGRP/* read permission: group */ +#defineS_IWGRP/* write permission: group */ +#defineS_IXGRP/* execute permission: group */ +#defineS_IRWXO/* read, write, execute: other */ +#defineS_IROTH/* read permission: other */ +#defineS_IWOTH/* write permission: other */ +#defineS_IXOTH/* execute permission: other */ +.TE + +.sp +.LP +The following macros are for POSIX conformance (see \fBstandards\fR(5)): +.sp + +.sp +.TS +tab(); +lw(.78i) lw(1.43i) lw(3.29i) +lw(.78i) lw(1.43i) lw(3.29i) +. +#defineS_ISBLK(mode)block special file +#defineS_ISCHR(mode)character special file +#defineS_ISDIR(mode)directory file +#defineS_ISFIFO(mode)pipe or fifo file +#defineS_ISREG(mode)regular file +#defineS_ISSOCK(mode)socket file +.TE + +.sp +.LP +The following symbolic constants are defined as distinct integer values outside +of the range [0, 999 999 999], for use with the \fBfutimens()\fR and +\fButimensat()\fR functions: +.sp +.in +2 +.nf +#define UTIME_NOW use the current time +@define UTIME_OMIT no time change +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityCommitted +_ +StandardSee \fBstandards\fR(5). +.TE + +.SH SEE ALSO +.sp +.LP +\fBfutimens\fR(2), \fBstat\fR(2), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/statvfs.h.3head b/usr/src/man/man3head/statvfs.h.3head new file mode 100644 index 0000000000..aa89546fe3 --- /dev/null +++ b/usr/src/man/man3head/statvfs.h.3head @@ -0,0 +1,97 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 statvfs.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +statvfs.h, statvfs \- VFS File System information structure +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/statvfs.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/statvfs.h\fR> header defines the \fBstatvfs\fR structure, which +includes the following members: +.sp +.in +2 +.nf +unsigned long f_bsize /* file system block + size */ +unsigned long f_frsize /* fundamental file system block + size */ +fsblkcnt_t f_blocks /* total number of blocks on file + system in units of \fBf_frsize\fR */ +fsblkcnt_t f_bfree /* total number of free blocks */ +fsblkcnt_t f_bavail /* number of free blocks available + to non-privileged process */ +fsfilcnt_t f_files /* total number of file serial + numbers */ +fsfilcnt_t f_ffree /* total number of free file serial + numbers */ +fsfilcnt_t f_favail /* number of file serial numbers + available to non-privileged +unsigned long f_fsid /* process file system ID */ +unsigned long f_flag /* bit mask of \fBf_flag\fR values */ +unsigned long f_namemax /* maximum filename length */ +.fi +.in -2 + +.sp +.LP +The \fBfsblkcnt_t\fR and \fBfsfilcnt_t\fR types are defined as described in +<\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD). +.sp +.LP +The following flags for the \fBf_flag\fR member are defined: +.sp +.ne 2 +.mk +.na +\fB\fBST_RDONLY\fR\fR +.ad +.RS 13n +.rt +read-only file system +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBST_NOSUID\fR\fR +.ad +.RS 13n +.rt +does not support \fBsetuid()\fR/\fBsetgid()\fR semantics +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBstatvfs\fR(2), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/stdbool.h.3head b/usr/src/man/man3head/stdbool.h.3head new file mode 100644 index 0000000000..c62bc6d64c --- /dev/null +++ b/usr/src/man/man3head/stdbool.h.3head @@ -0,0 +1,91 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 stdbool.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +stdbool.h, stdbool \- boolean type and values +.SH SYNOPSIS +.LP +.nf +#include <\fBstdbool.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBstdbool.h\fR> header defines the following macros: +.sp +.ne 2 +.mk +.na +\fB\fBbool\fR\fR +.ad +.sp .6 +.RS 4n +expands to \fB_Bool\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBtrue\fR\fR +.ad +.sp .6 +.RS 4n +expands to the integer constant 1 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBfalse\fR\fR +.ad +.sp .6 +.RS 4n +expands to the integer constant 0 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB__bool_true_false_are_defined\fR\fR +.ad +.sp .6 +.RS 4n +expands to the integer constant 1 +.RE + +.sp +.LP +An application can undefine and then possibly redefine the macros \fBbool\fR, +\fBtrue\fR, and \fBfalse\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/stddef.h.3head b/usr/src/man/man3head/stddef.h.3head new file mode 100644 index 0000000000..80cd81cc7a --- /dev/null +++ b/usr/src/man/man3head/stddef.h.3head @@ -0,0 +1,115 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 stddef.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +stddef.h, stddef \- standard type definitions +.SH SYNOPSIS +.LP +.nf +#include <\fBstddef.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBstddef.h\fR> header defines the following macros: +.sp +.ne 2 +.mk +.na +\fB\fBNULL\fR\fR +.ad +.sp .6 +.RS 4n +Null pointer constant. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBoffsetof(type, member-designator)\fR\fR +.ad +.sp .6 +.RS 4n +Integer constant expression of type \fBsize_t\fR, the value of which is the +offset in bytes to the structure member (\fBmember-designator\fR), from the +beginning of its structure (\fBtype\fR). +.RE + +.sp +.LP +The <\fBstddef.h\fR> header defines the following types: +.sp +.ne 2 +.mk +.na +\fB\fBptrdiff_t\fR\fR +.ad +.RS 13n +.rt +Signed integer type of the result of subtracting two pointers. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBwchar_t\fR\fR +.ad +.RS 13n +.rt +Integer type whose range of values can represent distinct wide-character codes +for all members of the largest character set specified among the locales +supported by the compilation environment: the null character has the code value +0 and each member of the portable character set has a code value equal to its +value when used as the lone character in an integer character constant. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBsize_t\fR\fR +.ad +.RS 13n +.rt +Unsigned integer type of the result of the \fBsizeof\fR operator. +.RE + +.sp +.LP +The implementation supports one or more programming environments in which the +widths of \fBptrdiff_t\fR, \fBsize_t\fR, and \fBwchar_t\fR are no greater than +the width of type \fBlong\fR. The names of these programming environments can +be obtained using the \fBconfstr\fR(3C) function or the \fBgetconf\fR(1) +utility. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetconf\fR(1), \fBconfstr\fR(3C), \fBtypes.h\fR(3HEAD), +\fBwchar.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/stdint.h.3head b/usr/src/man/man3head/stdint.h.3head new file mode 100644 index 0000000000..71faf8bd57 --- /dev/null +++ b/usr/src/man/man3head/stdint.h.3head @@ -0,0 +1,965 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 stdint.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +stdint.h, stdint \- integer types +.SH SYNOPSIS +.LP +.nf +#include <\fBstdint.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBstdint.h\fR> header declares sets of integer types having specified +widths, and defines corresponding sets of macros. It also defines macros that +specify limits of integer types corresponding to types defined in other +standard headers. +.sp +.LP +The ``width'' of an integer type is the number of bits used to store its value +in a pure binary system; the actual type can use more bits than that (for +example, a 28-bit type could be stored in 32 bits of actual storage). An N-bit +signed type has values in the range -2^N-1 or 1-2^N-1 to 2^N-1-1, while an +N-bit unsigned type has values in the range 0 to 2^N-1. +.sp +.LP +Types are defined in the following categories: +.RS +4 +.TP +.ie t \(bu +.el o +integer types having certain exact widths +.RE +.RS +4 +.TP +.ie t \(bu +.el o +integer types having at least certain specified widths +.RE +.RS +4 +.TP +.ie t \(bu +.el o +fastest integer types having at least certain specified widths +.RE +.RS +4 +.TP +.ie t \(bu +.el o +integer types wide enough to hold pointers to objects +.RE +.RS +4 +.TP +.ie t \(bu +.el o +integer types having greatest width +.RE +.sp +.LP +Some of these types may denote the same type. +.sp +.LP +Corresponding macros specify limits of the declared types and construct +suitable constants. +.sp +.LP +For each type described herein that the implementation provides, the +<\fBstdint.h\fR> header declares that \fBtypedef\fR name and defines the +associated macros. Conversely, for each type described herein that the +implementation does not provide, the <\fBstdint.h\fR> header does not declare +that \fBtypedef\fR name, nor does it define the associated macros. An +implementation provides those types described as required, but need not provide +any of the others (described as optional). +.SS "Integer Types" +.sp +.LP +When \fBtypedef\fR names differing only in the absence or presence of the +initial \fBu\fR are defined, they denote corresponding signed and unsigned +types as described in the ISO/IEC 9899: 1999 standard, Section 6.2.5; an +implementation providing one of these corresponding types must also provide the +other. +.sp +.LP +In the following descriptions, the symbol \fIN\fR represents an unsigned +decimal integer with no leading zeros (for example, 8 or 24, but not 04 or +048). +.sp +.ne 2 +.mk +.na +\fBExact-width integer types\fR +.ad +.sp .6 +.RS 4n +The \fBtypedef\fR name \fBint\fIN\fR_t\fR designates a signed integer type with +width \fIN\fR, no padding bits, and a two's-complement representation. Thus, +\fBint8_t\fR denotes a signed integer type with a width of exactly 8 bits. +.sp +The typedef name \fBuint\fIN\fR_t\fR designates an unsigned integer type with +width \fIN\fR. Thus, \fBuint24_t\fR denotes an unsigned integer type with a +width of exactly 24 bits. +.sp +The following types are required: +.sp +.in +2 +.nf +int8_t +int16_t +int32_t +uint8_t +uint16_t +uint32_t +.fi +.in -2 + +If an implementation provides integer types with width 64 that meet these +requirements, then the following types are required: +.sp +.in +2 +.nf +int64_t +uint64_t +.fi +.in -2 + +In particular, this is the case if any of the following are true: +.RS +4 +.TP +.ie t \(bu +.el o +The implementation supports the \fB_POSIX_V6_ILP32_OFFBIG\fR programming +environment and the application is being built in the \fB_POSI +X_V6_ILP32_OFFBIG\fR programming environment (see the Shell and Utilities +volume of IEEE Std 1003.1-200x, c99, Programming Environments). +.RE +.RS +4 +.TP +.ie t \(bu +.el o +The implementation supports the \fB_POSIX_V6_LP64_OFF64\fR programming +environment and the application is being built in the \fB_POSIX_ +V6_LP64_OFF64\fR programming environment. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +The implementation supports the \fB_POSIX_V6_LPBIG_OFFBIG\fR programming +environment and the application is being built in the +\fB_POSIX_V6_LPBIG_OFFBIG\fR programming environment. +.RE +All other types of this form are optional. +.RE + +.sp +.ne 2 +.mk +.na +\fBMinimum-width integer types\fR +.ad +.sp .6 +.RS 4n +The \fBtypedef\fR name \fBint_least\fIN\fR_t\fR designates a signed integer +type with a width of at least \fIN\fR, such that no signed integer type with +lesser size has at least the specified width. Thus, \fBint_least32 _t\fR +denotes a signed integer type with a width of at least 32 bits. +.sp +The \fBtypedef\fR name \fBuint_least\fIN\fR_t\fR designates an unsigned integer +type with a width of at least \fIN\fR, such that no unsigned integer type with +lesser size has at least the specified width. Thus, \fBuint_ least16_t\fR +denotes an unsigned integer type with a width of at least 16 bits. +.sp +The following types are required: +.sp +.in +2 +.nf +int_least8_t +int_least16_t +int_least32_t +int_least64_t +uint_least8_t +uint_least16_t +uint_least32_t +uint_least64_t +.fi +.in -2 + +All other types of this form are optional. +.RE + +.sp +.ne 2 +.mk +.na +\fBFastest minimum-width integer types\fR +.ad +.sp .6 +.RS 4n +Each of the following types designates an integer type that is usually fastest +to operate with among all integer types that have at least the specified width. +.sp +The designated type is not guaranteed to be fastest for all purposes; if the +implementation has no clear grounds for choosing one type over another, it will +simply pick some integer type satisfying the signedness and width requirements. +.sp +The \fBtypedef\fR name \fBint_fast\fIN\fR_t\fR designates the fastest signed +integer type with a width of at least \fIN\fR. The \fBtypedef\fR name +\fBuint_fast\fIN\fR_ t\fR designates the fastest unsigned integer type with a +width of at least \fIN\fR. +.sp +The following types are required: +.sp +.in +2 +.nf +int_fast8_t +int_fast16_t +int_fast32_t +int_fast64_t +uint_fast8_t +uint_fast16_t +uint_fast32_t +uint_fast64_t +.fi +.in -2 + +All other types of this form are optional. +.RE + +.sp +.ne 2 +.mk +.na +\fBInteger types capable of holding object pointers\fR +.ad +.sp .6 +.RS 4n +.sp +.ne 2 +.mk +.na +\fB\fBintptr_t\fR\fR +.ad +.RS 13n +.rt +Designates a signed integer type with the property that any valid pointer to +void can be converted to this type, then converted back to a pointer to void, +and the result will compare equal to the original pointer. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBuintptr_t\fR\fR +.ad +.RS 13n +.rt +Designates an unsigned integer type with the property that any valid pointer to +void can be converted to this type, then converted back to a pointer to void, +and the result will compare equal to the original pointer. +.RE + +On standard-conforming systems, the \fBintptr_t\fR and \fBuintptr_t\fR types +are required; otherwise, they are optional. +.RE + +.sp +.ne 2 +.mk +.na +\fBGreatest-width integer types\fR +.ad +.sp .6 +.RS 4n +.sp +.ne 2 +.mk +.na +\fB\fBintmax_t\fR\fR +.ad +.RS 13n +.rt +Designates a signed integer type capable of representing any value of any +signed integer type. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBuintmax_t\fR\fR +.ad +.RS 13n +.rt +Designates an unsigned integer type capable of representing any value of any +unsigned integer type. +.RE + +These types are required. +.sp +Applications can test for optional types by using the corresponding limit macro +from \fBLimits of Specified-Width Integer Types\fR. +.RE + +.SS "Limits of Specified-Width Integer Types" +.sp +.LP +The following macros specify the minimum and maximum limits of the types +declared in the <\fBstdint.h\fR> header. Each macro name corresponds to a +similar type name in \fBInteger Types\fR. +.sp +.LP +Each instance of any defined macro is replaced by a constant expression +suitable for use in \fB#if\fR preprocessing directives. This expression has the +same type as would an expression that is an object of the corresponding type +converted according to the integer promotions. Its implementation-defined value +is equal to or greater in magnitude (absolute value) than the corresponding +value given below, with the same sign, except where stated to be exactly the +given value. +.sp +.ne 2 +.mk +.na +\fBLimits of exact-width integer types\fR +.ad +.sp .6 +.RS 4n +.RS +4 +.TP +.ie t \(bu +.el o +Minimum values of exact-width signed integer types: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBINTN_MIN\fR}\fR +.ad +.RS 14n +.rt +Exactly -(2^N-1) +.RE + +.RE + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum values of exact-width signed integer types: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBINTN_MAX\fR}\fR +.ad +.RS 14n +.rt +Exactly 2^N-1 -1 +.RE + +.RE + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum values of exact-width unsigned integer types: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBUINTN_MAX\fR}\fR +.ad +.RS 15n +.rt +Exactly 2^N -1 +.RE + +.RE + +.RE +.RE + +.sp +.ne 2 +.mk +.na +\fBLimits of minimum-width integer types\fR +.ad +.sp .6 +.RS 4n +.RS +4 +.TP +.ie t \(bu +.el o +Minimum values of minimum-width signed integer types: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBINT_LEAST\fIN\fR_MIN\fR}\fR +.ad +.RS 20n +.rt +-(2^N-1 -1) +.RE + +.RE + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum values of minimum-width signed integer types: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBINT_LEAST\fIN\fR_MAX\fR}\fR +.ad +.RS 20n +.rt +2^N-1 -1 +.RE + +.RE + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum values of minimum-width unsigned integer types: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBUINT_LEAST\fIN\fR_MAX\fR}\fR +.ad +.RS 21n +.rt +2^N -1 +.RE + +.RE + +.RE +.RE + +.sp +.ne 2 +.mk +.na +\fBLimits of fastest minimum-width integer types\fR +.ad +.sp .6 +.RS 4n +.RS +4 +.TP +.ie t \(bu +.el o +Minimum values of fastest minimum-width signed integer types: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBINT_FAST\fIN\fR_MIN\fR}\fR +.ad +.RS 19n +.rt +-(2^N-1 -1) +.RE + +.RE + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum values of fastest minimum-width signed integer types: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBINT_FAST\fIN\fR_MAX\fR}\fR +.ad +.RS 19n +.rt +2^N-1 -1 +.RE + +.RE + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum values of fastest minimum-width unsigned integer types: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBUINT_FAST\fIN\fR_MAX\fR}\fR +.ad +.RS 20n +.rt +2^N-1 -1 +.RE + +.RE + +.RE +.RE + +.sp +.ne 2 +.mk +.na +\fBLimits of integer types capable of holding object pointers\fR +.ad +.sp .6 +.RS 4n +.RS +4 +.TP +.ie t \(bu +.el o +Minimum value of pointer-holding signed integer type: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBINTPTR_MIN\fR}\fR +.ad +.RS 16n +.rt +-(2^15 -1) +.RE + +.RE + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum value of pointer-holding signed integer type: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBINTPTR_MAX\fR}\fR +.ad +.RS 16n +.rt +2^15 -1 +.RE + +.RE + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Minimum value of pointer-holding signed integer type: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBUINTPTR_MAX\fR}\fR +.ad +.RS 17n +.rt +2^16 -1 +.RE + +.RE + +.RE +.RE + +.sp +.ne 2 +.mk +.na +\fBLimits of greatest-width integer types\fR +.ad +.sp .6 +.RS 4n +.RS +4 +.TP +.ie t \(bu +.el o +Minimum value of greatest-width signed integer type: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBINTMAX_MIN\fR}\fR +.ad +.RS 16n +.rt +-(2^63 -1) +.RE + +.RE + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum value of greatest-width signed integer type: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBINTMAX_MIN\fR}\fR +.ad +.RS 16n +.rt +2^63 -1 +.RE + +.RE + +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Maximum value of greatest-width unsigned integer type: +.RS + +.sp +.ne 2 +.mk +.na +\fB{\fBUINTMAX_MIN\fR}\fR +.ad +.RS 17n +.rt +2^64 -1 +.RE + +.RE + +.sp +.in +2 +.nf + +.fi +.in -2 + +.RE +.RE + +.SS "Limits of Other Integer Types" +.sp +.LP +The following macros specify the minimum and maximum limits of integer types +corresponding to types defined in other standard headers. +.sp +.LP +Each instance of these macros is replaced by a constant expression suitable for +use in \fB#if\fR preprocessing directives. This expression has the same type as +would an expression that is an object of the corresponding type converted +according to the integer promotions. Its implementation-defined value is equal +to or greater in magnitude (absolute value) than the corresponding value given +below, with the same sign. +.sp +.ne 2 +.mk +.na +\fBLimits of \fBptrdiff_t\fR:\fR +.ad +.RS 27n +.rt +.sp +.ne 2 +.mk +.na +\fB{\fBPTRDIFF_MIN\fR}\fR +.ad +.RS 17n +.rt +-65535 +.RE + +.sp +.ne 2 +.mk +.na +\fB{\fBPTRDIFF_MAX\fR}\fR +.ad +.RS 17n +.rt ++65535 +.RE + +.RE + +.sp +.ne 2 +.mk +.na +\fBLimits of \fBsig_atomic_t\fR:\fR +.ad +.RS 27n +.rt +.sp +.ne 2 +.mk +.na +\fB{\fBSIG_ATOMIC_MIN\fR}\fR +.ad +.RS 20n +.rt +See below. +.RE + +.sp +.ne 2 +.mk +.na +\fB{\fBSIG_ATOMIC_MAX\fR}\fR +.ad +.RS 20n +.rt +See below. +.RE + +.RE + +.sp +.ne 2 +.mk +.na +\fBLimits of \fBsize_t\fR:\fR +.ad +.RS 27n +.rt +.sp +.ne 2 +.mk +.na +\fB{\fBSIZE_MAX\fR}\fR +.ad +.RS 14n +.rt +65535 +.RE + +.RE + +.sp +.ne 2 +.mk +.na +\fBLimits of \fBwchar_t\fR:\fR +.ad +.RS 27n +.rt +.sp +.ne 2 +.mk +.na +\fB{\fBWCHAR_MIN\fR}\fR +.ad +.RS 15n +.rt +See below. +.RE + +.sp +.ne 2 +.mk +.na +\fB{\fBWCHAR_MAX\fR}\fR +.ad +.RS 15n +.rt +See below. +.RE + +.RE + +.sp +.ne 2 +.mk +.na +\fBLimits of \fBwint_t\fR:\fR +.ad +.RS 27n +.rt +.sp +.ne 2 +.mk +.na +\fB{\fBWINT_MIN\fR}\fR +.ad +.RS 14n +.rt +See below. +.RE + +.sp +.ne 2 +.mk +.na +\fB{\fBWINT_MAX\fR}\fR +.ad +.RS 14n +.rt +See below. +.RE + +.RE + +.sp +.LP +If \fBsig_atomic_t\fR (see the <\fBsignal.h\fR> header) is defined as a signed +integer type, the value of {\fBSIG_ATOMIC_MIN\fR} is no greater than -127 and +the value of {\fBSIG_ATOMIC_MAX\fR} is no less than 127. Otherwise, +\fBsig_atomic_t\fR is defined as an unsigned integer type, the value of +{\fBSIG_ATOMIC_MIN}\fR is 0, and the value of {\fBSIG_ATOMIC_MAX\fR} is no less +than 255. +.sp +.LP +If \fBwchar_t\fR (see the <\fBstddef.h\fR> header) is defined as a signed +integer type, the value of {\fBWCHAR_MIN\fR} is no greater than -127 and the +value of {\fBWCHAR_MAX\fR} is no less than 127. Otherwise, \fBwchar_t\fR is +defined as an unsigned integer type, and the value of {\fBWCHAR_MIN\fR} is 0 +and the value of {\fBWCHAR_MAX\fR} is no less than 255. +.sp +.LP +If \fBwint_t\fR (see the <\fBwchar.h\fR> header) is defined as a signed integer +type, the value of {\fBWINT_MIN\fR} is no greater than -32767 and the value of +{\fBWINT_MAX\fR} is no less than 32767. Otherwise, \fBwint_t\fR is defined as +an unsigned integer type, and the value of {\fBWINT_MIN\fR} is 0 and the value +of {\fBWINT_MAX\fR} is no less than 65535. +.SS "Macros for Integer Constant Expressions" +.sp +.LP +The following macros expand to integer constant expressions suitable for +initializing objects that have integer types corresponding to types defined in +the <\fBstdint.h\fR> header. Each macro name corresponds to a similar type name +listed under minimum-width integer types and greatest-width integer types. +.sp +.LP +Each invocation of one of these macros expands to an integer constant +expression suitable for use in \fB#if\fR preprocessing directives. The type of +the expression has the same type as would an expression that is an object of +the corresponding type converted according to the integer promotions. The value +of the expression is that of the argument. The argument in any instance of +these macros is a decimal, octal, or hexadecimal constant with a value that +does not exceed the limits for the corresponding type. +.sp +.ne 2 +.mk +.na +\fBMacros for minimum-width integer constant expressions\fR +.ad +.sp .6 +.RS 4n +The macro \fBINTN_C(\fIvalue\fR)\fR expands to an integer constant expression +corresponding to the type \fBint_least\fIN\fR_t\fR. The macro +\fBUINTN_C(\fIvalue\fR)\fR expands to an integer constant expression +corresponding to the type \fBuint_least\fIN\fR_t\fR. For example, if +\fBuint_least64_t\fR is a name for the type unsigned long long, then +\fBUINT64_C(0x123)\fR might expand to the integer constant \fB0x123ULL\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fBMacros for greatest-width integer constant expressions\fR +.ad +.sp .6 +.RS 4n +The following macro expands to an integer constant expression having the value +specified by its argument and the type \fBintmax_t\fR: +.sp +.in +2 +.nf +INTMAX_C(\fIvalue\fR) +.fi +.in -2 + +The following macro expands to an integer constant expression having the value +specified by its argument and the type \fBuintmax_t\fR: +.sp +.in +2 +.nf +UINTMAX_C(\fIvalue\fR) +.fi +.in -2 + +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBinttypes.h\fR(3HEAD), \fBsignal.h\fR(3HEAD), \fBstddef.h\fR(3HEAD), +\fBwchar.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/stdio.h.3head b/usr/src/man/man3head/stdio.h.3head new file mode 100644 index 0000000000..27e7e20aa1 --- /dev/null +++ b/usr/src/man/man3head/stdio.h.3head @@ -0,0 +1,321 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 stdio.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +stdio.h, stdio \- standard buffered input/output +.SH SYNOPSIS +.LP +.nf +#include <\fBstdio.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBstdio.h\fR> header defines the following macros as positive integer +constant expressions: +.sp +.ne 2 +.mk +.na +\fB\fBBUFSIZ\fR\fR +.ad +.RS 13n +.rt +size of <\fBstdio.h\fR> buffers +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_IOFBF\fR\fR +.ad +.RS 13n +.rt +input/output fully buffered +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_IOLBF\fR\fR +.ad +.RS 13n +.rt +input/output line buffered +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_IONBF\fR\fR +.ad +.RS 13n +.rt +input/output unbuffered +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBL_ctermid\fR\fR +.ad +.RS 13n +.rt +maximum size of character array to hold \fBctermid()\fR output +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBL_tmpnam\fR\fR +.ad +.RS 13n +.rt +maximum size of character array to hold \fBtmpnam()\fR output +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSEEK_CUR\fR\fR +.ad +.RS 13n +.rt +seek relative to current position +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSEEK_END\fR\fR +.ad +.RS 13n +.rt +seek relative to end-of-file +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSEEK_SET\fR\fR +.ad +.RS 13n +.rt +seek relative to start-of-file +.RE + +.sp +.LP +The following macros are defined as positive integer constant expressions that +denote implementation limits: +.sp +.ne 2 +.mk +.na +\fB{\fBFILENAME_MAX\fR}\fR +.ad +.RS 18n +.rt +Maximum size in bytes of the longest filename string that the implementation +guarantees can be opened. +.RE + +.sp +.ne 2 +.mk +.na +\fB{\fBFOPEN_MAX\fR}\fR +.ad +.RS 18n +.rt +Number of streams that the implementation guarantees can be open +simultaneously. The value is at least eight. +.RE + +.sp +.ne 2 +.mk +.na +\fB{\fBTMP_MAX\fR}\fR +.ad +.RS 18n +.rt +Minimum number of unique filenames generated by \fBtmpnam()\fR. Maximum number +of times an application can call \fBtmpnam()\fR reliably. The value of +{\fBTMP_MAX\fR} is at least 25. On XSI-conformant systems, the value of +{\fBTMP_MAX\fR} is at least 10000. +.RE + +.sp +.LP +The following macro name is defined as a negative integer constant expression: +.sp +.ne 2 +.mk +.na +\fB\fBEOF\fR\fR +.ad +.RS 7n +.rt +end-of-file return value +.RE + +.sp +.LP +The following macro name is defined as a null pointer constant: +.sp +.ne 2 +.mk +.na +\fB\fBNULL\fR\fR +.ad +.RS 8n +.rt +null pointer +.RE + +.sp +.LP +The following macro name is defined as a string constant: +.sp +.ne 2 +.mk +.na +\fB\fBP_tmpdir\fR\fR +.ad +.RS 12n +.rt +default directory prefix for \fBtempnam()\fR +.RE + +.sp +.LP +The following is defined as expressions of type "pointer to \fBFILE\fR" point +to the \fBFILE\fR objects associated, respectively, with the standard error, +input, and output streams: +.sp +.ne 2 +.mk +.na +\fB\fBstderr\fR\fR +.ad +.RS 10n +.rt +standard error output stream +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBstdin\fR\fR +.ad +.RS 10n +.rt +standard input stream +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBstdout\fR\fR +.ad +.RS 10n +.rt +standard output stream +.RE + +.sp +.LP +The following data types are defined through \fBtypedef\fR: +.sp +.ne 2 +.mk +.na +\fB\fBFILE\fR\fR +.ad +.RS 11n +.rt +structure containing information about a file +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBfpos_t\fR\fR +.ad +.RS 11n +.rt +non-array type containing all information needed to specify uniquely every +position within a file +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBva_list\fR\fR +.ad +.RS 11n +.rt +as described in <\fBstdarg.h\fR> +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBsize_t\fR\fR +.ad +.RS 11n +.rt +as described in <\fBstddef.h\fR> +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBrename\fR(2), \fBctermid\fR(3C), \fBfclose\fR(3C), \fBfdopen\fR(3C), +\fBfflush\fR(3C), \fBfgetc\fR(3C), \fBfgetpos\fR(3C), \fBfgets\fR(3C), +\fBflockfile\fR(3C), \fBfopen\fR(3C), \fBfputc\fR(3C), \fBfputs\fR(3C), +\fBfputwc\fR(3C), \fBfread\fR(3C), \fBfreopen\fR(3C), \fBfseek\fR(3C), +\fBfsetpos\fR(3C), \fBftell\fR(3C), \fBfwrite\fR(3C), \fBgetwchar\fR(3C), +\fBgetopt\fR(3C), \fBperror\fR(3C), \fBpopen\fR(3C), \fBprintf\fR(3C), +\fBremove\fR(3C), \fBrewind\fR(3C), \fBscanf\fR(3C), \fBsetbuf\fR(3C), +\fBstdio\fR(3C), \fBsystem\fR(3C), \fBtmpfile\fR(3C), \fBtmpnam\fR(3C), +\fBungetc\fR(3C), \fBvprintf\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/stdlib.h.3head b/usr/src/man/man3head/stdlib.h.3head new file mode 100644 index 0000000000..a23b3d3a55 --- /dev/null +++ b/usr/src/man/man3head/stdlib.h.3head @@ -0,0 +1,190 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 stdlib.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +stdlib.h, stdlib \- standard library definitions +.SH SYNOPSIS +.LP +.nf +#include <\fBstdlib.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBstdlib.h\fR> header defines the following macros: +.sp +.ne 2 +.mk +.na +\fB\fBEXIT_FAILURE\fR\fR +.ad +.RS 16n +.rt +Unsuccessful termination for \fBexit()\fR; evaluates to a non-zero value. See +\fBexit\fR(3C). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBEXIT_SUCCESS\fR\fR +.ad +.RS 16n +.rt +Successful termination for \fBexit()\fR; evaluates to 0. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNULL\fR\fR +.ad +.RS 16n +.rt +Null pointer. +.RE + +.sp +.ne 2 +.mk +.na +\fB{\fBRAND_MAX\fR}\fR +.ad +.RS 16n +.rt +Maximum value returned by \fBrand()\fR; at least 32767. See \fBrand\fR(3C). +.RE + +.sp +.ne 2 +.mk +.na +\fB{\fBMB_CUR_MAX\fR}\fR +.ad +.RS 16n +.rt +Integer expression whose value is the maximum number of bytes in a character +specified by the current locale. +.RE + +.sp +.LP +The following data types are defined through \fBtypedef\fR: +.sp +.ne 2 +.mk +.na +\fB\fBdiv_t\fR\fR +.ad +.RS 11n +.rt +structure type returned by the \fBdiv()\fR function +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBldiv_t\fR\fR +.ad +.RS 11n +.rt +structure type returned by the \fBldiv()\fR function +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBlldiv_t\fR\fR +.ad +.RS 11n +.rt +structure type returned by the \fBlldiv()\fR function +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBsize_t\fR\fR +.ad +.RS 11n +.rt +as described in <\fBstddef.h\fR> +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBwchar_t\fR\fR +.ad +.RS 11n +.rt +as described in <\fBstddef.h\fR> +.RE + +.sp +.LP +See \fBdiv\fR(3C), which covers \fBdiv()\fR, \fBldiv()\fR, and \fBlldiv()\fR, +and \fBstddef.h\fR(3HEAD). +.sp +.LP +In addition, the symbolic names and macros listed below are defined as in +<\fBsys/wait.h\fR>, for use in decoding the return value from \fBsystem()\fR. +See \fBwait.h\fR(3HEAD) and \fBsystem\fR(3C). +.sp +.in +2 +.nf +WNOHANG +WUNTRACED +WEXITSTATUS +WIFEXITED +WIFSIGNALED +WIFSTOPPED +WSTOPSIG +WTERMSIG +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBa64l\fR(3C), \fBabort\fR(3C), \fBabs\fR(3C), \fBatexit\fR(3C), +\fBbsearch\fR(3C), \fBdiv\fR(3C), \fBdrand48\fR(3C), \fBexit\fR(3C), +\fBgetenv\fR(3C), \fBgetsubopt\fR(3C), \fBgrantpt\fR(3C), \fBmalloc\fR(3C), +\fBmblen\fR(3C), \fBmbstowcs\fR(3C), \fBmbtowc\fR(3C), \fBmkstemp\fR(3C), +\fBptsname\fR(3C), \fBputenv\fR(3C), \fBqsort\fR(3C), \fBrandom\fR(3C), +\fBrealpath\fR(3C), \fBstrtod\fR(3C), \fBstrtol\fR(3C), \fBstrtoul\fR(3C), +\fBunlockpt\fR(3C), \fBwcstombs\fR(3C), \fBwctomb\fR(3C), +\fBlimits.h\fR(3HEAD), \fBmath.h\fR(3HEAD), \fBstddef.h\fR(3HEAD), +\fBtypes.h\fR(3HEAD), \fBwait.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/string.h.3head b/usr/src/man/man3head/string.h.3head new file mode 100644 index 0000000000..0d4de034f2 --- /dev/null +++ b/usr/src/man/man3head/string.h.3head @@ -0,0 +1,67 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 string.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +string.h, string \- string operations +.SH SYNOPSIS +.LP +.nf +#include <\fBstring.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBstring.h\fR> header defines the following: +.sp +.ne 2 +.mk +.na +\fB\fBNULL\fR\fR +.ad +.RS 10n +.rt +null pointer constant +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBsize_t\fR\fR +.ad +.RS 10n +.rt +as described in <\fBstddef.h\fR> +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBmemory\fR(3C), \fBstrcoll\fR(3C), \fBstring\fR(3C), \fBstrxfrm\fR(3C), +\fBstddef.h\fR(3HEAD), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/strings.h.3head b/usr/src/man/man3head/strings.h.3head new file mode 100644 index 0000000000..193a1dcaf4 --- /dev/null +++ b/usr/src/man/man3head/strings.h.3head @@ -0,0 +1,45 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 strings.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +strings.h, strings \- string operations +.SH SYNOPSIS +.LP +.nf +#include <\fBstrings.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBsize_t\fR type specified in <\fBstrings.h\fR> is defined through +\fBtypedef\fR as described in <\fBstddef.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBffs\fR(3C), \fBstring\fR(3C), \fBstddef.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/stropts.h.3head b/usr/src/man/man3head/stropts.h.3head new file mode 100644 index 0000000000..55d3114739 --- /dev/null +++ b/usr/src/man/man3head/stropts.h.3head @@ -0,0 +1,867 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 stropts.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +stropts.h, stropts \- STREAMS interface (STREAMS) +.SH SYNOPSIS +.LP +.nf +#include <\fBstropts.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBstropts.h\fR> header defines the \fBbandinfo\fR structure, which +includes the following members: +.sp +.in +2 +.nf +unsigned char bi_pri /* priority band */ +int bi_flag /* flushing type */ +.fi +.in -2 + +.sp +.LP +The <\fBstropts.h\fR> header defines the \fBstrpeek\fR structure that includes +the following members: +.sp +.in +2 +.nf +struct strbuf ctlbuf /* control portion of the message */ +struct strbuf databuf /* data portion of the message */ +t_uscalar_t flags /* RS_HIPRI or 0 */ +.fi +.in -2 + +.sp +.LP +The <\fBstropts.h\fR> header defines the \fBstrbuf\fR structure that includes +the following members: +.sp +.in +2 +.nf +int maxlen /* maximum buffer length */ +int len /* length of data */ +char *buf /* pointer to buffer */ +.fi +.in -2 + +.sp +.LP +The <\fBstropts.h\fR> header defines the \fBstrfdinsert\fR structure that +includes the following members: +.sp +.in +2 +.nf +struct strbuf ctlbuf /* control portion of the message */ +struct strbuf databuf /* data portion of the message */ +t_uscalar_t flags /* RS_HIPRI or 0 */ +int fildes /* file descriptor of the other stream */ +int offset /* relative location of the stored value */ +.fi +.in -2 + +.sp +.LP +The <\fBstropts.h\fR> header defines the \fBstrioctl\fR structure that includes +the following members: +.sp +.in +2 +.nf +int ic_cmd /* ioctl() command */ +int ic_timout /* timeout for response */ +int ic_len /* length of data */ +char *ic_dp /* pointer to buffer */ +.fi +.in -2 + +.sp +.LP +The <\fBstropts.h\fR> header defines the \fBstrrecvfd\fR structure that +includes the following members: +.sp +.in +2 +.nf +int fda /* received file descriptor */ +uid_t uid /* UID of sender */ +gid_t gid /* GID of sender */ +.fi +.in -2 + +.sp +.LP +The \fBuid_t\fR and \fBgid_t\fR types are defined through \fBtypedef\fR as +described in <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD). +.sp +.LP +The <\fBstropts.h\fR> header defines the \fBt_scalar_t\fR and \fBt_uscalar_t\fR +types, respectively, as signed and unsigned opaque types of equal length of at +least 32 bits. +.sp +.LP +The <\fBstropts.h\fR> header defines the \fBstr_list\fR structure that includes +the following members: +.sp +.in +2 +.nf +int sl_nmods /* number of STREAMS module names */ +struct str_mlist *sl_modlist /* STREAMS module names */ +.fi +.in -2 + +.sp +.LP +The <\fBstropts.h\fR> header defines the \fBstr_mlist\fR structure that +includes the following member: +.sp +.ne 2 +.mk +.na +\fB\fBchar l_name[FMNAMESZ+1]\fR\fR +.ad +.RS 27n +.rt +a STREAMS module name +.RE + +.sp +.LP +The following macros are defined for use as the request argument to +\fBioctl()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBI_PUSH\fR\fR +.ad +.RS 15n +.rt +Push a STREAMS module. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_POP\fR\fR +.ad +.RS 15n +.rt +Pop a STREAMS module. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_LOOK\fR\fR +.ad +.RS 15n +.rt +Get the top module name. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_FLUSH\fR\fR +.ad +.RS 15n +.rt +Flush a stream. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_FLUSHBAND\fR\fR +.ad +.RS 15n +.rt +Flush one band of a stream. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_SETSIG\fR\fR +.ad +.RS 15n +.rt +Ask for notification signals. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_GETSIG\fR\fR +.ad +.RS 15n +.rt +Retrieve current notification signals. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_FIND\fR\fR +.ad +.RS 15n +.rt +Look for a STREAMS module. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_PEEK\fR\fR +.ad +.RS 15n +.rt +Peek at the top message on a stream. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_SRDOPT\fR\fR +.ad +.RS 15n +.rt +Set the read mode. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_GRDOPT\fR\fR +.ad +.RS 15n +.rt +Get the read mode. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_NREAD\fR\fR +.ad +.RS 15n +.rt +Size the top message. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_FDINSERT\fR\fR +.ad +.RS 15n +.rt +Send implementation-defined information about another stream. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_STR\fR\fR +.ad +.RS 15n +.rt +Send a STREAMS \fBioctl()\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_SWROPT\fR\fR +.ad +.RS 15n +.rt +Set the write mode. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_GWROPT\fR\fR +.ad +.RS 15n +.rt +Get the write mode. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_SENDFD\fR\fR +.ad +.RS 15n +.rt +Pass a file descriptor through a STREAMS pipe. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_RECVFD\fR\fR +.ad +.RS 15n +.rt +Get a file descriptor sent via I_SENDFD. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_LIST\fR\fR +.ad +.RS 15n +.rt +Get all the module names on a stream. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_ATMARK\fR\fR +.ad +.RS 15n +.rt +Is the top message ``marked''? +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_CKBAND\fR\fR +.ad +.RS 15n +.rt +See if any messages exist in a band. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_GETBAND\fR\fR +.ad +.RS 15n +.rt +Get the band of the top message on a stream. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_CANPUT\fR\fR +.ad +.RS 15n +.rt +Is a band writable? +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_SETCLTIME\fR\fR +.ad +.RS 15n +.rt +Set close time delay. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_GETCLTIME\fR\fR +.ad +.RS 15n +.rt +Get close time delay. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_LINK\fR\fR +.ad +.RS 15n +.rt +Connect two streams. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_UNLINK\fR\fR +.ad +.RS 15n +.rt +Disconnect two streams. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_PLINK\fR\fR +.ad +.RS 15n +.rt +Persistently connect two streams. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBI_PUNLINK\fR\fR +.ad +.RS 15n +.rt +Dismantle a persistent STREAMS link. +.RE + +.sp +.LP +The following macro is defined for use with \fBI_LOOK\fR: +.sp +.ne 2 +.mk +.na +\fB\fBFMNAMESZ\fR\fR +.ad +.RS 12n +.rt +minimum size in bytes of the buffer referred to by the \fBarg\fR argument +.RE + +.sp +.LP +The following macros are defined for use with \fBI_FLUSH\fR: +.sp +.ne 2 +.mk +.na +\fB\fBFLUSHR\fR\fR +.ad +.RS 11n +.rt +flush read queues +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFLUSHW\fR\fR +.ad +.RS 11n +.rt +flush write queues +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFLUSHRW\fR\fR +.ad +.RS 11n +.rt +flush read and write queues +.RE + +.sp +.LP +The following macros are defined for use with \fBI_SETSIG\fR: +.sp +.ne 2 +.mk +.na +\fB\fBS_RDNORM\fR\fR +.ad +.RS 13n +.rt +A normal (priority band set to 0) message has arrived at the head of a stream +head read queue. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBS_RDBAND\fR\fR +.ad +.RS 13n +.rt +A message with a non-zero priority band has arrived at the head of a stream +head read queue. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBS_INPUT\fR\fR +.ad +.RS 13n +.rt +A message, other than a high-priority message, has arrived at the head of a +stream head read queue. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBS_HIPRI\fR\fR +.ad +.RS 13n +.rt +A high-priority message is present on a stream head read queue. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBS_OUTPUT\fR\fR +.ad +.RS 13n +.rt +The write queue for normal data (priority band 0) just below the stream head is +no longer full. This notifies the process that there is room on the queue for +sending (or writing) normal data downstream. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBS_WRNORM\fR\fR +.ad +.RS 13n +.rt +Equivalent to \fBS_OUTPUT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBS_WRBAND\fR\fR +.ad +.RS 13n +.rt +The write queue for a non-zero priority band just below the stream head is no +longer full. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBS_MSG\fR\fR +.ad +.RS 13n +.rt +A STREAMS signal message that contains the \fBSIGPOLL\fR signal reaches the +front of the stream head read queue. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBS_ERROR\fR\fR +.ad +.RS 13n +.rt +Notification of an error condition reaches the stream head. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBS_HANGUP\fR\fR +.ad +.RS 13n +.rt +Notification of a hangup reaches 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. +.RE + +.sp +.LP +The following macro is defined for use with \fBI_PEEK\fR: +.sp +.ne 2 +.mk +.na +\fB\fBRS_HIPRI\fR\fR +.ad +.RS 12n +.rt +Only look for high-priority messages. +.RE + +.sp +.LP +The following macros are defined for use with \fBI_SRDOPT\fR: +.sp +.ne 2 +.mk +.na +\fB\fBRNORM\fR\fR +.ad +.RS 13n +.rt +Byte-stream mode, the default. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRMSGD\fR\fR +.ad +.RS 13n +.rt +Message-discard mode. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRMSGN\fR\fR +.ad +.RS 13n +.rt +Message-non-discard mode. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRPROTNORM\fR\fR +.ad +.RS 13n +.rt +Fail \fBread()\fR with \fB[EBADMSG]\fR if a message containing a control part +is at the front of the stream head read queue. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRPROTDAT\fR\fR +.ad +.RS 13n +.rt +Deliver the control part of a message as data when a process issues a +\fBread()\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBRPROTDIS\fR\fR +.ad +.RS 13n +.rt +Discard the control part of a message, delivering any data part, when a process +issues a \fBread()\fR +.RE + +.sp +.LP +The following macro is defined for use with \fBI_SWOPT\fR: +.sp +.ne 2 +.mk +.na +\fB\fBSNDZERO\fR\fR +.ad +.RS 11n +.rt +Send a zero-length message downstream when a \fBwrite()\fR of 0 bytes occurs. +.RE + +.sp +.LP +The following macros are defined for use with \fBI_ATMARK\fR: +.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 + +.sp +.LP +The following macro is defined for use with \fBI_UNLINK\fR: +.sp +.ne 2 +.mk +.na +\fB\fBMUXID_ALL\fR\fR +.ad +.RS 13n +.rt +Unlink all stream linked to the stream associated with \fBfildes\fR. +.RE + +.sp +.LP +The following macros are defined for \fBgetmsg()\fR, \fBgetpmsg()\fR, +\fBputmsg()\fR, and \fBputpmsg()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBMSG_ANY\fR\fR +.ad +.RS 13n +.rt +Receive any message. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMSG_BAND\fR\fR +.ad +.RS 13n +.rt +Receive message from specified band. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMSG_HIPRI\fR\fR +.ad +.RS 13n +.rt +Send/receive high-priority message. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMORECTL\fR\fR +.ad +.RS 13n +.rt +More control information is left in message. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMOREDATA\fR\fR +.ad +.RS 13n +.rt +More data is left in message. +.RE + +.sp +.LP +The <\fBstropts.h\fR> header can make visible all of the symbols from +<\fBunistd.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBclose\fR(2), \fBfcntl\fR(2), \fBgetmsg\fR(2), \fBioctl\fR(2), \fBopen\fR(2), +\fBpipe\fR(2), \fBpoll\fR(2), \fBputmsg\fR(2), \fBread\fR(2), \fBwrite\fR(2), +\fBsignal\fR(3C), \fBtypes.h\fR(3HEAD), \fBunistd.h\fR(3HEAD), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/syslog.h.3head b/usr/src/man/man3head/syslog.h.3head new file mode 100644 index 0000000000..c2600eb9aa --- /dev/null +++ b/usr/src/man/man3head/syslog.h.3head @@ -0,0 +1,399 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 syslog.h 3HEAD "10 Sep 2003" "SunOS 5.11" "Headers" +.SH NAME +syslog.h, syslog \- definitions for system error logging +.SH SYNOPSIS +.LP +.nf +#include <\fBsyslog.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsyslog.h\fR> header defines the following symbolic constants, zero or +more of which can be OR'ed together to form the \fBlogopt\fR option of +\fBopenlog()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBLOG_PID\fR\fR +.ad +.RS 14n +.rt +Log the process ID with each message. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_CONS\fR\fR +.ad +.RS 14n +.rt +Log to the system console on error. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_NDELAY\fR\fR +.ad +.RS 14n +.rt +Connect to syslog daemon immediately. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_ODELAY\fR\fR +.ad +.RS 14n +.rt +Delay open until \fBsyslog()\fR is called. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_NOWAIT\fR\fR +.ad +.RS 14n +.rt +Do not wait for child processes. +.RE + +.sp +.LP +The following symbolic constants are defined as possible values of the +\fIfacility\fR argument to \fBopenlog()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBLOG_KERN\fR\fR +.ad +.RS 14n +.rt +reserved for message generated by the system +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_USER\fR\fR +.ad +.RS 14n +.rt +message generated by a process +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_MAIL\fR\fR +.ad +.RS 14n +.rt +reserved for message generated by mail system +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_NEWS\fR\fR +.ad +.RS 14n +.rt +reserved for message generated by news system +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_UUCP\fR\fR +.ad +.RS 14n +.rt +reserved for message generated by UUCP system +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_DAEMON\fR\fR +.ad +.RS 14n +.rt +reserved for message generated by system daemon +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_AUTH\fR\fR +.ad +.RS 14n +.rt +reserved for message generated by authorization daemon +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_CRON\fR\fR +.ad +.RS 14n +.rt +reserved for message generated by clock daemon +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_LPR\fR\fR +.ad +.RS 14n +.rt +reserved for message generated by printer system +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_LOCAL0\fR\fR +.ad +.RS 14n +.rt +reserved for local use +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_LOCAL1\fR\fR +.ad +.RS 14n +.rt +reserved for local use +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_LOCAL2\fR\fR +.ad +.RS 14n +.rt +reserved for local use +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_LOCAL3\fR\fR +.ad +.RS 14n +.rt +reserved for local use +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_LOCAL4\fR\fR +.ad +.RS 14n +.rt +reserved for local use +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_LOCAL5\fR\fR +.ad +.RS 14n +.rt +reserved for local use +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_LOCAL6\fR\fR +.ad +.RS 14n +.rt +reserved for local use +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_LOCAL7\fR\fR +.ad +.RS 14n +.rt +reserved for local use +.RE + +.sp +.LP +The following is declared as a macro for constructing the \fImaskpri\fR +argument to \fBsetlogmask()\fR. The following macro expands to an expression of +type \fBint\fR when the argument \fIpri\fR is an expre ssion of type \fBint\fR: +.sp +.ne 2 +.mk +.na +\fB\fBLOG_MASK(\fR\fIpri\fR\fB)\fR\fR +.ad +.RS 17n +.rt +a mask for priority \fIpri\fR +.RE + +.sp +.LP +The following constants are defined as possible values for the \fIpriority\fR +argument of \fBsyslog()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBLOG_EMERG\fR\fR +.ad +.RS 15n +.rt +A panic condition was reported to all processes. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_ALERT\fR\fR +.ad +.RS 15n +.rt +A condition that should be corrected immediately. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_CRIT\fR\fR +.ad +.RS 15n +.rt +A critical condition. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_ERR\fR\fR +.ad +.RS 15n +.rt +An error message. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_WARNING\fR\fR +.ad +.RS 15n +.rt +A warning message. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_NOTICE\fR\fR +.ad +.RS 15n +.rt +A condition requiring special handling. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_INFO\fR\fR +.ad +.RS 15n +.rt +A general information message. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOG_DEBUG\fR\fR +.ad +.RS 15n +.rt +A message useful for debugging programs. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBsyslog\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/tar.h.3head b/usr/src/man/man3head/tar.h.3head new file mode 100644 index 0000000000..0e633ced08 --- /dev/null +++ b/usr/src/man/man3head/tar.h.3head @@ -0,0 +1,161 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. +.\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 tar.h 3HEAD "14 Mar 2006" "SunOS 5.11" "Headers" +.SH NAME +tar.h, tar \- extended tar definitions +.SH SYNOPSIS +.LP +.nf +#include <\fBtar.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBtar.h\fR> header defines header block definitions as follows. +.sp +.LP +General definitions: +.sp + +.sp +.TS +tab(); +cw(1.59i) cw(1.59i) cw(2.32i) +lw(1.59i) lw(1.59i) lw(2.32i) +. +NameValueDescription +_ +\fBTMAGIC\fR"ustar"ustar plus null byte +\fBTMAGLEN\fR6length of the above +\fBTVERSION\fR"00"00 without a null byte +\fBTVERSLEN\fR2length of the above +.TE + +.sp +.LP +\fBTypeflag\fR field definitions: +.sp + +.sp +.TS +tab(); +cw(1.57i) cw(1.63i) cw(2.3i) +lw(1.57i) lw(1.63i) lw(2.3i) +. +NameValueDescription +_ +\fBREGTYPE\fR\&'0'regular file +\fBAREGTYPE\fR\&'\e0'regular file +\fBLNKTYPE\fR\&'1'link +\fBSYMTYPE\fR\&'2'symbolic link +\fBCHRTYPE\fR\&'3'character special +\fBBLKTYPE\fR\&'4'block special +\fBDIRTYPE\fR\&'5'directory +\fBFIFOTYPE\fR\&'6'FIFO special +\fBCONTTYPE\fR\&'7'reserved +.TE + +.sp +.LP +\fBMode\fR field bit definitions (octal): +.sp + +.sp +.TS +tab(); +cw(1.63i) cw(1.63i) cw(2.24i) +lw(1.63i) lw(1.63i) lw(2.24i) +. +NameValueDescription +_ +\fBTSUID\fR04000set UID on execution +\fBTSGID\fR02000set GID on execution +\fBTSVTX\fR01000on directories, restricted deletion flag +\fBTUREAD\fR00400read by owner +\fBTUWRITE\fR00200write by owner special +\fBTUEXEC\fR00100execute/search by owner +\fBTGREAD\fR00040read by group +\fBTGWRITE\fR00020write by group +\fBTGEXEC\fR00010execute/search by group +\fBTOREAD\fR00004read by other +\fBTOWRITE\fR00002write by other +\fBTOEXEC\fR00001execute/search by other +.TE + +.sp +.LP +Types used in ancillary files: +.sp + +.sp +.TS +tab(); +cw(1.85i) cw(1.29i) cw(2.36i) +lw(1.85i) lw(1.29i) lw(2.36i) +. +NameValueDescription +\fBACL_HDR\fR\&'A'Access Control List +\fBLBL_TYPE\fR\&'L'Trusted Extensions file label +\fBDIR_TYPE\fR\&'D'Trusted Extensions directory label +.TE + +.sp +.LP +Attribute types used in Trusted Solaris ancillary files that are interpreted by +Trusted Extensions for backward compatibility: +.sp + +.sp +.TS +tab(); +cw(1.85i) cw(1.29i) cw(2.36i) +lw(1.85i) lw(1.29i) lw(2.36i) +. +NameValueDescription +\fBSLD_TYPE\fR\&'S'Single-level directory component +\fBPATH_TYPE\fR\&'P'Path component +\fBMLD_TYPE\fR\&'M'Multi-level directory component +\fBFILE_TYPE\fR\&'F'Must handle files differently +\fBAPRIV_TYPE\fR\&'P'Allowed privileges data type in file +\fBFPRIV_TYPE\fR\&'p'Forced privileges data type in file +\fBCOMP_TYPE\fR\&'C'Path components, use for MLD +\fBATTR_FLAG_TYPE\fR\&'F'File attribute flag bytes data type +\fBLK_COMP_TYPE\fR\&'K'Link data path component +.TE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilitySee below. +.TE + +.sp +.LP +The general definitions, the \fBtypeflag\fR field definitions, and the +\fBmode\fR field bit definitions are Standard. The types used in ancillary +files and the attribute types used in Trusted Solaris ancillary files are +Evolving. +.SH SEE ALSO +.sp +.LP +\fBpax\fR(1), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/tcp.h.3head b/usr/src/man/man3head/tcp.h.3head new file mode 100644 index 0000000000..1d2cf360dc --- /dev/null +++ b/usr/src/man/man3head/tcp.h.3head @@ -0,0 +1,61 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 tcp.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +tcp.h, tcp \- definitions for the Internet Transmission Control Protocol (TCP) +.SH SYNOPSIS +.LP +.nf +#include <\fBnetinet/tcp.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBnetinet/tcp.h\fR> header defines the following macro for use as a +socket option at the \fBIPPROTO_TCP\fR level: +.sp +.ne 2 +.mk +.na +\fB\fBTCP_NODELAY\fR\fR +.ad +.RS 15n +.rt +Avoid coalescing of small segments. +.RE + +.sp +.LP +The macro is defined in the header. The implementation need not allow the value +of the option to be set with \fBsetsockopt()\fR or retrieved with +\fBgetsockopt()\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetsockopt\fR(3XNET), \fBsocket.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/termios.h.3head b/usr/src/man/man3head/termios.h.3head new file mode 100644 index 0000000000..95e9754a96 --- /dev/null +++ b/usr/src/man/man3head/termios.h.3head @@ -0,0 +1,1142 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 termios.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +termios.h, termios \- define values for termios +.SH SYNOPSIS +.LP +.nf +#include <\fBtermios.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBtermios.h\fR> header contains the definitions used by the terminal I/O +interfaces. See \fBtermios\fR(3C) and \fBtermio\fR(7I) for an overview of the +terminal interface. +.SS "The termios Structure" +.sp +.LP +The following data types are defined through \fBtypedef\fR: +.sp +.ne 2 +.mk +.na +\fB\fBcc_t\fR\fR +.ad +.RS 12n +.rt +used for terminal special characters +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBspeed_t\fR\fR +.ad +.RS 12n +.rt +used for terminal baud rates +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBtcflag_t\fR\fR +.ad +.RS 12n +.rt +used for terminal modes +.RE + +.sp +.LP +The above types are all unsigned integer types. +.sp +.LP +The implementation supports one or more programming environments in which the +widths of \fBcc_t\fR, \fBspeed_t\fR, and \fBtcflag_t\fR are no greater than the +width of type \fBlong\fR. The names of these programming environments can be +obtained using the \fBconfstr\fR(3C) function or the \fBgetconf\fR(1) utility. +.sp +.LP +The \fBtermios\fR structure is defined and includes the following members: +.sp +.in +2 +.nf +tcflag_t c_iflag /* input modes */ +tcflag_t c_oflag /* output modes */ +tcflag_t c_cflag /* control modes */ +tcflag_t c_lflag /* local modes */ +cc_t c_cc[NCCS] /* control characters */ +.fi +.in -2 + +.sp +.LP +A definition is provided for: +.sp +.ne 2 +.mk +.na +\fB\fBNCCS\fR\fR +.ad +.RS 8n +.rt +size of the array \fBc_cc\fR for control characters +.RE + +.sp +.LP +The following subscript names for the array \fBc_cc\fR are defined: +.sp + +.sp +.TS +tab(); +cw(1.47i) cw(1.87i) cw(2.15i) +lw(1.47i) lw(1.87i) lw(2.15i) +. +Subscript UsageCanonical ModeSubscript UsageNon-Canonical ModeDescription +_ +\fBVEOF\fREOF character +\fBVEOL\fREOL character +\fBVERASE\fRERASE character +\fBVINTR\fR\fBVINTR\fRINTR character +\fBVKILL\fRKILL character +\fBVMIN\fRMIN value +\fBVQUIT\fR\fBVQUIT\fRQUIT character +\fBVSTART\fR\fBVSTART\fRSTART character +\fBVSTOP\fR\fBVSTOP\fRSTOP character +\fBVSUSP\fR\fBVSUSP\fRSUSP character +\fBVTIME\fRTIME value +.TE + +.sp +.LP +The subscript values are unique, except that the \fBVMIN\fR and \fBVTIME\fR +subscripts can have the same values as the \fBVEOF\fR and \fBVEOL\fR +subscripts, respectively. +.sp +.LP +The header file provides the flags described below. +.SS "Input Modes" +.sp +.LP +The \fBc_iflag\fR field describes the basic terminal input control: +.sp +.ne 2 +.mk +.na +\fB\fBBRKINT\fR\fR +.ad +.RS 10n +.rt +Signal interrupt on break. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBICRNL\fR\fR +.ad +.RS 10n +.rt +Map CR to NL on input. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIGNBRK\fR\fR +.ad +.RS 10n +.rt +Ignore break condition. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIGNCR\fR\fR +.ad +.RS 10n +.rt +Ignore CR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIGNPAR\fR\fR +.ad +.RS 10n +.rt +Ignore characters with parity errors. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBINLCR\fR\fR +.ad +.RS 10n +.rt +Map NL to CR on input. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBINPCK\fR\fR +.ad +.RS 10n +.rt +Enable input parity check. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBISTRIP\fR\fR +.ad +.RS 10n +.rt +Strip character. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIXANY\fR\fR +.ad +.RS 10n +.rt +Enable any character to restart output. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIXOFF\fR\fR +.ad +.RS 10n +.rt +Enable start/stop input control. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIXON\fR\fR +.ad +.RS 10n +.rt +Enable start/stop output control. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPARMRK\fR\fR +.ad +.RS 10n +.rt +Mark parity errors. +.RE + +.SS "Output Modes" +.sp +.LP +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\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 CR output at column 0. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBONLRET\fR\fR +.ad +.RS 10n +.rt +NL performs CR 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\fBNLDLY\fR\fR +.ad +.RS 10n +.rt +Select newline delays: +.sp +.ne 2 +.mk +.na +\fB\fBNL0\fR\fR +.ad +.RS 7n +.rt +newline type 0 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNL1\fR\fR +.ad +.RS 7n +.rt +newline type 1 +.RE + +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCRDLY\fR\fR +.ad +.RS 10n +.rt +Select carriage-return delays: +.sp +.ne 2 +.mk +.na +\fB\fBCR0\fR\fR +.ad +.RS 7n +.rt +carriage-return delay type 0 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCR1\fR\fR +.ad +.RS 7n +.rt +carriage-return delay type 1 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCR2\fR\fR +.ad +.RS 7n +.rt +carriage-return delay type 2 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCR3\fR\fR +.ad +.RS 7n +.rt +carriage-return delay type 3 +.RE + +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTABDLY\fR\fR +.ad +.RS 10n +.rt +Select horizontal-tab delays: +.sp +.ne 2 +.mk +.na +\fB\fBTAB0\fR\fR +.ad +.RS 8n +.rt +horizontal-tab delay type 0 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTAB1\fR\fR +.ad +.RS 8n +.rt +horizontal-tab delay type 1 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTAB2\fR\fR +.ad +.RS 8n +.rt +horizontal-tab delay type 2 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTAB3\fR\fR +.ad +.RS 8n +.rt +expand tabs to spaces +.RE + +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBBSDLY\fR\fR +.ad +.RS 10n +.rt +Select backspace delays: +.sp +.ne 2 +.mk +.na +\fB\fBBS0\fR\fR +.ad +.RS 7n +.rt +backspace-delay type 0 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBBS1\fR\fR +.ad +.RS 7n +.rt +backspace-delay type 1 +.RE + +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBVTDLY\fR\fR +.ad +.RS 10n +.rt +Select vertical-tab delays: +.sp +.ne 2 +.mk +.na +\fB\fBVT0\fR\fR +.ad +.RS 7n +.rt +vertical-tab delay type 0 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBVT1\fR\fR +.ad +.RS 7n +.rt +vertical-tab delay type 1 +.RE + +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFFDLY\fR\fR +.ad +.RS 10n +.rt +Select form-feed delays: +.sp +.ne 2 +.mk +.na +\fB\fBFF0\fR\fR +.ad +.RS 7n +.rt +form-feed delay type 0 +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFF1\fR\fR +.ad +.RS 7n +.rt +form-feed delay type 1 +.RE + +.RE + +.SS "Baud Rate Selection" +.sp +.LP +The input and output baud rates are stored in the \fBtermios\fR structure. +These are the valid values for objects of type \fBspeed_ t\fR. The following +values are defined, but not all baud rates need be supported by the underlying +hardware. +.sp +.ne 2 +.mk +.na +\fB\fBB0\fR\fR +.ad +.RS 10n +.rt +Hang up +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB50\fR\fR +.ad +.RS 10n +.rt +50 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB75\fR\fR +.ad +.RS 10n +.rt +75 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB110\fR\fR +.ad +.RS 10n +.rt +110 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB134\fR\fR +.ad +.RS 10n +.rt +134.5 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB150\fR\fR +.ad +.RS 10n +.rt +150 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB200\fR\fR +.ad +.RS 10n +.rt +200 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB300\fR\fR +.ad +.RS 10n +.rt +300 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB600\fR\fR +.ad +.RS 10n +.rt +600 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB1200\fR\fR +.ad +.RS 10n +.rt +1 200 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB1800\fR\fR +.ad +.RS 10n +.rt +1 800 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB2400\fR\fR +.ad +.RS 10n +.rt +2 400 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB4800\fR\fR +.ad +.RS 10n +.rt +4 800 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB9600\fR\fR +.ad +.RS 10n +.rt +9 600 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB19200\fR\fR +.ad +.RS 10n +.rt +19 200 baud +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBB38400\fR\fR +.ad +.RS 10n +.rt +38 400 baud +.RE + +.SS "Control Modes" +.sp +.LP +The \fBc_cflag\fR field describes the hardware control of the terminal; not all +values specified are required to be supported by the underlying hardware: +.sp +.ne 2 +.mk +.na +\fB\fBCSIZE\fR\fR +.ad +.RS 10n +.rt +Character size: +.sp +.ne 2 +.mk +.na +\fB\fBCS5\fR\fR +.ad +.RS 7n +.rt +5 bits +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCS6\fR\fR +.ad +.RS 7n +.rt +6 bits +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCS7\fR\fR +.ad +.RS 7n +.rt +7 bits +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCS8\fR\fR +.ad +.RS 7n +.rt +8 bits +.RE + +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCSTOPB\fR\fR +.ad +.RS 10n +.rt +Send two stop bits, else one. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCREAD\fR\fR +.ad +.RS 10n +.rt +Enable receiver. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPARENB\fR\fR +.ad +.RS 10n +.rt +Parity enable. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPARODD\fR\fR +.ad +.RS 10n +.rt +Odd parity, else even. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBHUPCL\fR\fR +.ad +.RS 10n +.rt +Hang up on last close. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCLOCAL\fR\fR +.ad +.RS 10n +.rt +Ignore modem status lines. +.RE + +.sp +.LP +The implementation supports the functionality associated with the symbols +\fBCS7\fR, \fBCS8\fR, \fBCSTOPB\fR, \fBPARODD\fR, and \fBPARENB\fR. +.SS "Local Modes" +.sp +.LP +The \fBc_lflag\fR field of the argument structure is used to control various +terminal functions: +.sp +.ne 2 +.mk +.na +\fB\fBECHO\fR\fR +.ad +.RS 10n +.rt +Enable echo. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBECHOE\fR\fR +.ad +.RS 10n +.rt +Echo erase character as error-correcting backspace. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBECHOK\fR\fR +.ad +.RS 10n +.rt +Echo KILL. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBECHONL\fR\fR +.ad +.RS 10n +.rt +Echo NL. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBICANON\fR\fR +.ad +.RS 10n +.rt +Canonical input (erase and kill processing). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIEXTEN\fR\fR +.ad +.RS 10n +.rt +Enable extended input character processing. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBISIG\fR\fR +.ad +.RS 10n +.rt +Enable signals. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNOFLSH\fR\fR +.ad +.RS 10n +.rt +Disable flush after interrupt or quit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTOSTOP\fR\fR +.ad +.RS 10n +.rt +Send \fBSIGTTOU\fR for background output. +.RE + +.SS "Attribute Selection" +.sp +.LP +The following symbolic constants for use with \fBtcsetattr()\fR are defined: +.sp +.ne 2 +.mk +.na +\fB\fBTCSANOW\fR\fR +.ad +.RS 13n +.rt +Change attributes immediately. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTCSADRAIN\fR\fR +.ad +.RS 13n +.rt +Change attributes when output has drained. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTCSAFLUSH\fR\fR +.ad +.RS 13n +.rt +Change attributes when output has drained; also flush pending input. +.RE + +.SS "Line Control" +.sp +.LP +The following symbolic constants for use with \fBtcflush()\fR are defined: +.sp +.ne 2 +.mk +.na +\fB\fBTCIFLUSH\fR\fR +.ad +.RS 13n +.rt +Flush pending input. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTCIOFLUSH\fR\fR +.ad +.RS 13n +.rt +Flush both pending input and untransmitted output. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTCOFLUSH\fR\fR +.ad +.RS 13n +.rt +Flush untransmitted output. +.RE + +.sp +.LP +The following symbolic constants for use with \fBtcflow()\fR are defined: +.sp +.ne 2 +.mk +.na +\fB\fBTCIOFF\fR\fR +.ad +.RS 10n +.rt +Transmit a \fBSTOP\fR character, intended to suspend input data. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTCION\fR\fR +.ad +.RS 10n +.rt +Transmit a \fBSTART\fR character, intended to restart input data. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTCOOFF\fR\fR +.ad +.RS 10n +.rt +Suspend output. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTCOON\fR\fR +.ad +.RS 10n +.rt +Restart output. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetconf\fR(1), \fBcfgetispeed\fR(3C), \fBcfsetispeed\fR(3C), +\fBconfstr\fR(3C), \fBtcdrain\fR(3C), \fBtcflow\fR(3C), \fBtcflush\fR(3C), +\fBtcgetattr\fR(3C), \fBtcgetsid\fR(3C), \fBtcsendbreak\fR(3C), +\fBtcsetattr\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/tgmath.h.3head b/usr/src/man/man3head/tgmath.h.3head new file mode 100644 index 0000000000..3046b1d235 --- /dev/null +++ b/usr/src/man/man3head/tgmath.h.3head @@ -0,0 +1,222 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 tgmath.h 3HEAD "17 Dec 2003" "SunOS 5.11" "Headers" +.SH NAME +tgmath.h, tgmath \- type-generic macros +.SH SYNOPSIS +.LP +.nf +#include <\fBtgmath.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBtgmath.h\fR> header includes the headers <\fBmath.h\fR> and +<\fBcomplex.h\fR> and defines several type-generic macros. +.sp +.LP +Of the functions contained within the <\fBmath.h\fR> and <\fBcomplex.h\fR> +headers without an \fBf\fR (float) or \fBl\fR (\fBlong double\fR) suffix, +several have one or more parameters whose corresponding real type is +\fBdouble\fR. For each such function except \fBmodf\fR(3M), there is a +corresponding type-generic macro. The parameters whose corresponding real type +is \fBdouble\fR in the function synopsis are generic parameters. Use of the +macro invokes a function whose corresponding real type and type domain are +determined by the arguments for the generic parameters. +.sp +.LP +Use of the macro invokes a function whose generic parameters have the +corresponding real type determined as follows: +.RS +4 +.TP +.ie t \(bu +.el o +First, if any argument for generic parameters has type \fBlong double\fR, the +type determined is \fBlong double\fR. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Otherwise, if any argument for generic parameters has type \fBdouble\fR or is +of integer type, the type determined is \fBdouble\fR. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Otherwise, the type determined is \fBfloat\fR. +.RE +.sp +.LP +For each unsuffixed function in the <\fBmath.h\fR> header for which there is a +function in the <\fBcomplex.h\fR> header with the same name except for a +\fBc\fR prefix, the corresponding type-generic macro (for both functions) has +the same name as the function in the <\fBmath.h\fR> header. The corresponding +type-generic macro for \fBfabs()\fR and \fBcabs()\fR is \fBfabs()\fR. +.sp + +.sp +.TS +tab(); +cw(1.83i) cw(1.83i) cw(1.83i) +lw(1.83i) lw(1.83i) lw(1.83i) +. +<\fBmath.h\fR> Function<\fBcomplex.h\fR> FunctionType-Generic Macro +_ +\fBacos()\fR\fBcacos()\fR\fBacos()\fR +\fBasin()\fR\fBcasin()\fR\fBasin()\fR +\fBatan()\fR\fBcatan()\fR\fBatan()\fR +\fBacosh()\fR\fBcacosh()\fR\fBacosh()\fR +\fBasinh()\fR\fBcasinh()\fR\fBasinh()\fR +\fBatanh()\fR\fBcatanh()\fR\fBatanh()\fR +\fBcos()\fR\fBccos()\fR\fBcos()\fR +\fBsin()\fR\fBcsin()\fR\fBsin()\fR +\fBtan()\fR\fBctan()\fR\fBtan()\fR +\fBcosh()\fR\fBccosh()\fR\fBcosh()\fR +\fBsinh()\fR\fBcsinh()\fR\fBsinh()\fR +\fBtanh()\fR\fBctanh()\fR\fBtanh()\fR +\fBexp()\fR\fBcexp()\fR\fBexp()\fR +\fBlog()\fR\fBclog()\fR\fBlog()\fR +\fBpow()\fR\fBcpow()\fR\fBpow()\fR +\fBsqrt()\fR\fBcsqrt()\fR\fBsqrt()\fR +\fBfabs()\fR\fBcfabs()\fR\fBfabs()\fR +.TE + +.sp +.LP +If at least one argument for a generic parameter is complex, then use of the +macro invokes a complex function; otherwise, use of the macro invokes a real +function. +.sp +.LP +For each unsuffixed function in the <\fBmath.h\fR> header without a +\fBc\fR-prefixed counterpart in the <\fBcomplex.h\fR> header, the corresponding +type-generic macro has the same name as the function. These type-generic macros +are: +.sp +.in +2 +.nf +atan2() fma() llround() remainder() +cbrt() fmax() log10() remquo() +ceil() fmin() log1p() rint() +copysign() fmod() log2() round() +erf() frexp() logb() scalbn() +erfc() hypot() lrint() scalbln() +exp2() ilogb() lround() tgamma() +expm1() ldexp() nearbyint() trunc() +fdim() lgamma() nextafter() +floor() llrint() nexttoward() +.fi +.in -2 + +.sp +.LP +If all arguments for generic parameters are real, then use of the macro invokes +a real function; otherwise, use of the macro results in undefined behavior. +.sp +.LP +For each unsuffixed function in the <\fBcomplex.h\fR> header that is not a +\fBc\fR-prefixed counterpart to a function in the <\fBmath.h\fR> header, the +corresponding type-generic macro has the same name as the function. These +type-generic macros are: +.sp +.in +2 +.nf +carg() +cimag() +conj() +cproj() +creal() +.fi +.in -2 + +.sp +.LP +Use of the macro with any real or complex argument invokes a complex function. +.SH USAGE +.sp +.LP +Functions invoked by use of type-generic macros are invoked with the +declarations listed below. +.sp +.in +2 +.nf +#include <tgmath.h> +int n; +float f; +double d; +long double ld; +float complex fc; +double complex dc; +long double complex ldc; +.fi +.in -2 + +.sp +.LP +The following are the type-generic macros that invoke the functions that are +invoked with the preceding declarations. +.sp + +.sp +.TS +tab(); +cw(2.75i) cw(2.75i) +lw(2.75i) lw(2.75i) +. +MacroUse Invokes +_ +exp(n)exp(n), the function +acosh(f)acoshf(f) +sin(d)sin(d), the function +atan(ld)atanl(ld) +log(fc)clogf(fc) +sqrt(dc)csqrt(dc) +pow(ldc,f)cpowl(ldc, f) +remainder(n,n)remainder(n, n), the function +nextafter(d,f)nextafter(d, f), the function +nexttoward(f,ld)nexttowardf(f, ld) +copysign(n,ld)copysignl(n, ld) +ceil(fc)undefined behavior +rint(dc)undefined behavior +fmax(ldc,ld)undefined behavior +carg(n)carg(n), the function +cproj(f)cprojf(f) +creal(d)creal(d), the function +cimag(ld)cimagl(ld) +cabs(fc)cabsf(fc) +carg(dc)carg(dc), the function +cproj(ldc)cprojl(ldc) +.TE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBmodf\fR(3M), \fBcomplex.h\fR(3HEAD), \fBmath.h\fR(3HEAD), \fBcabs\fR(3M), +\fBfabs\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/time.h.3head b/usr/src/man/man3head/time.h.3head new file mode 100644 index 0000000000..1c2c428b90 --- /dev/null +++ b/usr/src/man/man3head/time.h.3head @@ -0,0 +1,227 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. +.\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 time.h 3HEAD "5 Feb 2008" "SunOS 5.11" "Headers" +.SH NAME +time.h, time \- time types +.SH SYNOPSIS +.LP +.nf +#include <\fBtime.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBtime.h\fR> header declares the structure \fBtm\fR, which includes the +following members: +.sp +.in +2 +.nf +int tm_sec /* seconds [0,60] */ +int tm_min /* minutes [0,59] */ +int tm_hour /* hour [0,23] */ +int tm_mday /* day of month [1,31] */ +int tm_mon /* month of year [0,11] */ +int tm_year /* years since 1900 */ +int tm_wday /* day of week [0,6] (Sunday =0) */ +int tm_yday /* day of year [0,365] */ +int tm_isdst /* daylight savings flag */ +.fi +.in -2 + +.sp +.LP +The value of \fBtm_isdst\fR is positive if Daylight Saving Time is in effect, 0 +if Daylight Saving Time is not in effect, and negative if the information is +not available. +.sp +.LP +The <\fBtime.h\fR> header defines the following symbolic names: +.sp +.ne 2 +.mk +.na +\fB\fBNULL\fR\fR +.ad +.RS 28n +.rt +Null pointer constant. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCLOCKS_PER_SEC\fR\fR +.ad +.RS 28n +.rt +A number used to convert the value returned by the \fBclock()\fR function into +seconds. See \fBclock\fR(3C). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCLOCK_PROCESS_CPUTIME_ID\fR\fR +.ad +.RS 28n +.rt +The identifier of the CPU-time clock associated with the process making a +\fBclock()\fR or \fBtimer*()\fR function call. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCLOCK_THREAD_CPUTIME_ID\fR\fR +.ad +.RS 28n +.rt +The identifier of the CPU-time clock associated with the thread making a +\fBclock()\fR or \fBtimer*()\fR function call. +.RE + +.sp +.LP +The <\fBtime.h\fR> header declares the \fBtimespec\fR structure, which has the +following members: +.sp +.in +2 +.nf +time_t tv_sec /* seconds */ +long tv_nsec /* nanoseconds */ +.fi +.in -2 + +.sp +.LP +The <\fBtime.h\fR> header declares the \fBitimerspec\fR structure, which has +the following members: +.sp +.in +2 +.nf +struct timespec it_interval /* timer period */ +struct timespec it_value /* timer expiration */ +.fi +.in -2 + +.sp +.LP +The following manifest constants are defined: +.sp +.ne 2 +.mk +.na +\fB\fBCLOCK_REALTIME\fR\fR +.ad +.RS 19n +.rt +The identifier of the system-wide realtime clock. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTIMER_ABSTIME\fR\fR +.ad +.RS 19n +.rt +Flag indicating time is absolute. For functions taking timer objects, this +refers to the clock associated with the timer. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBCLOCK_MONOTONIC\fR\fR +.ad +.RS 19n +.rt +The identifier for the system-wide monotonic clock, which is defined as a clock +whose value cannot be set with \fBclock_settime()\fR and that cannot have +backward clock jumps. The maximum possible clock jump is +implementation-defined. See \fBclock_settime\fR(3C). +.RE + +.sp +.LP +The \fBclock_t\fR, \fBsize_t\fR, \fBtime_t\fR, \fBclockid_t\fR, and +\fBtimer_t\fR types are defined as described in <\fBsys/types.h\fR>. See +\fBtypes.h\fR(3HEAD). +.sp +.LP +Although the value of \fBCLOCKS_PER_SEC\fR is required to be 1 million on all +standard-conforming systems, it can be variable on other systems, and it should +not be assumed that \fBCLOCKS_PER_SEC\fR is a compile-time constant. +.sp +.LP +The <\fBtime.h\fR> header provides a declaration for \fBgetdate_err\fR. +.sp +.LP +The following are declared as variables: +.sp +.in +2 +.nf +extern int daylight; +extern long timezone; +extern char *tzname[]; +.fi +.in -2 + +.sp +.LP +Inclusion of the <\fBtime.h\fR> header can make visible all symbols from the +<\fBsignal.h\fR> header. +.SH USAGE +.sp +.LP +The range [0,60] for \fBtm_sec\fR allows for the occasional leap second. +.sp +.LP +\fBtm_year\fR is a signed value; therefore, years before 1900 can be +represented. +.sp +.LP +To obtain the number of clock ticks per second returned by the \fBtimes()\fR +function, applications should call \fBsysconf(_SC_CLK_TCK)\fR. See +\fBtimes\fR(2) and \fBsysconf\fR(3C). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityCommitted +_ +StandardSee \fBstandards\fR(5). +.TE + +.SH SEE ALSO +.sp +.LP +\fBtime\fR(2), \fButime\fR(2), \fBclock\fR(3C), \fBctime\fR(3C), +\fBdifftime\fR(3C), \fBgetdate\fR(3C), \fBmktime\fR(3C), \fBstrftime\fR(3C), +\fBstrptime\fR(3C), \fBtypes.h\fR(3HEAD), \fBclock_settime\fR(3C), +\fBnanosleep\fR(3C), \fBtimer_create\fR(3C), \fBtimer_delete\fR(3C), +\fBtimer_settime\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/timeb.h.3head b/usr/src/man/man3head/timeb.h.3head new file mode 100644 index 0000000000..016cca3aad --- /dev/null +++ b/usr/src/man/man3head/timeb.h.3head @@ -0,0 +1,58 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 timeb.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +timeb.h, timeb \- additional definitions for date and time +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/timeb.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/timeb.h\fR> header defines the \fBtimeb\fR structure, which +includes the following members: +.sp +.in +2 +.nf +time_t time /* the seconds portion of the current time */ +unsigned short millitm /* the milliseconds portion of the current time */ +short timezone /* the local timezone in minutes west of Greenwich */ +short dstflag /* TRUE if Daylight Savings Time is in effect */ +.fi +.in -2 + +.sp +.LP +The \fBtime_t\fR type is defined as described in <\fBsys/types.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBtime.h\fR(3HEAD), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/times.h.3head b/usr/src/man/man3head/times.h.3head new file mode 100644 index 0000000000..8a3d516f7c --- /dev/null +++ b/usr/src/man/man3head/times.h.3head @@ -0,0 +1,59 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 times.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +times.h, times \- file access and modification times structure +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/times.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/times.h\fR> header defines the structure \fBtms\fR, which is +returned by \fBtimes()\fR and includes the following members: +.sp +.in +2 +.nf +clock_t tms_utime /* user CPU time */ +clock_t tms_stime /* system CPU time */ +clock_t tms_cutime /* user CPU time of terminated + child processes */ +clock_t tms_cstime /* system CPU time of terminated + child processes */ +.fi +.in -2 + +.sp +.LP +The clock_t type is defined as described in <\fBsys/types.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBtimes\fR(2), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/types.h.3head b/usr/src/man/man3head/types.h.3head new file mode 100644 index 0000000000..ae2492fa3b --- /dev/null +++ b/usr/src/man/man3head/types.h.3head @@ -0,0 +1,296 @@ +'\" te +.\" Copyright 1989 AT&T. Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" 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 types.h 3HEAD "6 Oct 2004" "SunOS 5.11" "Headers" +.SH NAME +types.h, types \- primitive system data types +.SH SYNOPSIS +.LP +.nf +\fB#include <sys/types.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The data types defined in <\fBsys/types.h\fR> are as follows: +.SS "32-bit Solaris" +.sp +.LP +The data types listed below are defined in <\fBsys/types.h\fR> for 32-bit +Solaris. +.sp +.in +2 +.nf +typedef struct { int r[1]; } *physadr; +typedef long clock_t; +typedef long daddr_t; +typedef char * caddr_t; +typedef unsigned char unchar; +typedef unsigned short ushort; +typedef unsigned int uint; +typedef unsigned long ulong_t; +typedef unsigned long ino_t; +typedef long uid_t; +typedef long gid_t; +typedef ulong_t nlink_t; +typedef ulong_t mode_t; +typedef short cnt_t; +typedef long time_t; +typedef int label_t[10]; +typedef ulong_t dev_t; +typedef long off_t; +typedef long pid_t; +typedef long paddr_t; +typedef int key_t; +typedef unsigned char use_t; +typedef short sysid_t; +typedef short index_t; +typedef short lock_t; +typedef unsigned int size_t; +typedef long clock_t; +typedef long pid_t; +.fi +.in -2 + +.SS "64-bit Solaris" +.sp +.LP +The data types listed below are defined in <\fBsys/types.h\fR> for 64-bit +Solaris. +.sp +.in +2 +.nf +typedef long blkcnt_t +typedef long clock_t +typedef long daddr_t +typedef ulong_t dev_t +typedef ulong_t fsblkcnt_t +typedef ulong_t fsfilcnt_t +typedef int gid_t +typedef int id_t +typedef long ino_t +typedef int key_t +typedef uint_t major_t +typedef uint_t minor_t +typedef uint_t mode_t +typedef uint_t nlink_t +typedef int pid_t +typedef ptrdiff_t intptr_t +typedef ulong_t rlim_t +typedef ulong_t size_t +typedef uint_t speed_t +typedef long ssize_t +typedef long suseconds_t +typedef uint_t tcflag_t +typedef long time_t +typedef int uid_t +typedef int wchar_t +.fi +.in -2 + +.SS "Preprocessor Symbols" +.sp +.LP +For 32-bit programs, pointers and the C data types \fBint\fR and \fBlong\fR are +all 32-bit quantities. For 64-bit programs, pointers and the C data type +\fBlong\fR are defined as 64-bit quantities. +.sp +.LP +The preprocessor symbol \fB_ILP32\fR, made visible by the inclusion of +<\fBsys/types.h\fR>, can be used with the preprocessor \fB#ifdef\fR construct +to define sections of code that will be compiled only as part of a 32-bit +version of a given C program. +.sp +.LP +The preprocessor symbol \fB_LP64\fR can be used in the same way to define +sections of code that will be compiled only as part of a 64-bit version of a +given C program. See EXAMPLES. +.sp +.LP +This header incorporates definitions of other preprocessor symbols that can be +useful when keeping code portable between different instruction set +architectures. +.sp +.ne 2 +.mk +.na +\fB\fB_LITTLE_ENDIAN\fR\fR +.ad +.br +.na +\fB\fB_BIG_ENDIAN\fR\fR +.ad +.RS 27n +.rt +The natural byte order of the processor. A pointer to an \fBint\fR points to +the least/most significant byte of that \fBint\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_STACK_GROWS_UPWARD\fR\fR +.ad +.br +.na +\fB\fB_STACK_GROWS_DOWNWARD\fR\fR +.ad +.RS 27n +.rt +The processor specific direction of stack growth. A push onto the stack +increases/decreases the stack pointer, so it stores data at successively +higher/lower addresses. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_CHAR_IS_UNSIGNED\fR\fR +.ad +.br +.na +\fB\fB_CHAR_IS_SIGNED\fR\fR +.ad +.RS 27n +.rt +The C Compiler implements objects of type \fBchar\fR as \fBunsigned\fR or +\fBsigned\fR respectively. This is really an implementation choice of the +compiler, but it is specified in the ABI and tends to be uniform across +compilers for an instruction set architecture. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_CHAR_ALIGNMENT\fR\fR +.ad +.br +.na +\fB\fB_SHORT_ALIGNMENT\fR\fR +.ad +.br +.na +\fB\fB_INT_ALIGNMENT\fR\fR +.ad +.br +.na +\fB\fB_LONG_ALIGNMENT\fR\fR +.ad +.br +.na +\fB\fB_LONG_LONG_ALIGNMENT\fR\fR +.ad +.br +.na +\fB\fB_DOUBLE_ALIGNMENT\fR\fR +.ad +.br +.na +\fB\fB_LONG_DOUBLE_ALIGNMENT\fR\fR +.ad +.br +.na +\fB\fB_POINTER_ALIGNMENT\fR\fR +.ad +.br +.na +\fB\fB_FLOAT_ALIGNMENT\fR\fR +.ad +.RS 27n +.rt +The ABI defines alignment requirements of each of the primitive object types. +Some, if not all, might be hardware requirements as well. The values are +expressed in bytes. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_MAX_ALIGNMENT\fR\fR +.ad +.RS 27n +.rt +The most stringent alignment requirement as specified by the ABI. Equal to the +maximum of all the above _\fIXXX\fR_\fBALIGNMENT\fR values. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_LONG_LONG_ALIGNMENT_32\fR\fR +.ad +.RS 27n +.rt +The 32-bit ABI supported by a 64-bit kernel may have different alignment +requirements for primitive object types. The value of this identifier is +expressed in bytes. +.RE + +.SH USAGE +.sp +.LP +The \fBdaddr_t\fR type is used for disk addresses except in an inode on disk. +Times are encoded in seconds since 00:00:00 UTC, January 1, 1970. The major and +minor parts of a device code specify kind and unit number of a device and are +installation-dependent. Offsets are measured in bytes from the beginning of a +file. +.sp +.LP +The \fBlabel_t[\|]\fR types are used to save the processor state while another +process is running. +.SH EXAMPLES +.LP +\fBExample 1 \fRUse of preprocessor symbol \fB_LP64\fR. +.sp +.LP +In the following example, the preprocessor symbol \fB_LP64\fR defines sections +of code that will be compiled only as part of a 64-bit version of the given C +program. + +.sp +.in +2 +.nf +#include <sys/types.h> +\&... + +#ifdef _LP64 + printf("The data model is LP64 in this environment\en"); +#else +#ifdef _ILP32 + printf("The data model is ILP32 in this environment\en"); +#else +#error "Unknown data model!" +#endif +#endif +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStable +.TE + +.SH SEE ALSO +.sp +.LP +\fBtypes32.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/types32.h.3head b/usr/src/man/man3head/types32.h.3head new file mode 100644 index 0000000000..4bb52d2d44 --- /dev/null +++ b/usr/src/man/man3head/types32.h.3head @@ -0,0 +1,52 @@ +'\" te +.\" Copyright 1989 AT&T Copyright (c) 1997, Sun Microsystems, Inc. All Rights Reserved +.\" 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 types32.h 3HEAD "30 Oct 1997" "SunOS 5.11" "Headers" +.SH NAME +types32.h, types32 \- fixed-width data types +.SH SYNOPSIS +.LP +.nf +\fB#include <sys/types32.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The following fixed-width data types defined in \fB<sys/types32.h>\fR +correspond to the sign and sizes of types in the 32-bit environment that can be +used for compatibility and interoperability purposes in either the 32-bit or +64-bit environment. +.sp + +.sp +.TS +tab(); +lw(1.83i) lw(1.83i) lw(1.83i) +lw(1.83i) lw(1.83i) lw(1.83i) +. +\fBtypedef\fR\fBint32_t\fR\fBblkcnt32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBcaddr32_t\fR +\fBtypedef\fR\fBint32_t\fR\fBclock32_t\fR +\fBtypedef\fR\fBint32_t\fR\fBdaddr32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBdev32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBfsblkcnt32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBfsfilcnt32_t\fR +\fBtypedef\fR\fBint32_t\fR\fBgid32_t\fR +\fBtypedef\fR\fBint32_t\fR\fBid32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBino32_t\fR +\fBtypedef\fR\fBint32_t\fR\fBkey32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBmajor32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBminor32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBmode32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBnlink32_t\fR +\fBtypedef\fR\fBint32_t\fR\fBpid32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBrlim32_t\fR +\fBtypedef\fR\fBuint32_t\fR\fBsize32_t\fR +\fBtypedef\fR\fBint32_t\fR\fBssize32_t\fR +\fBtypedef\fR\fBtime32_t\fR\fBint32_t\fR +\fBtypedef\fR\fBuid32_t\fR\fBint32_t\fR +.TE + diff --git a/usr/src/man/man3head/ucontext.h.3head b/usr/src/man/man3head/ucontext.h.3head new file mode 100644 index 0000000000..bbe03a4cc2 --- /dev/null +++ b/usr/src/man/man3head/ucontext.h.3head @@ -0,0 +1,70 @@ +'\" te +.\" Copyright 1989 AT&T Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved +.\" 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 ucontext.h 3HEAD "30 Aug 2002" "SunOS 5.11" "Headers" +.SH NAME +ucontext.h, ucontext \- user context +.SH SYNOPSIS +.LP +.nf +#include <\fBucontext.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBucontext.h\fR> header defines the \fBucontext_t\fR type as a structure +that includes at least the following members: +.sp +.in +2 +.nf +ucontext_t uc_link +sigset_t uc_sigmask +stack_t uc_stack +mcontext_t uc_mcontext +.fi +.in -2 + +.sp +.LP +The \fBuc_link\fR member is a pointer to the context that to be resumed when +this context returns. If \fBuc_link\fR is equal to 0, this context is the main +context and the process exits when this context returns. +.sp +.LP +The \fBuc_sigmask\fR member defines the set of signals that are blocked when +this context is active. See \fBsigprocmask\fR(2). +.sp +.LP +The \fBuc_stack\fR member defines the stack used by this context. See +\fBsigaltstack\fR(2). +.sp +.LP +The \fBuc_mcontext\fR member contains the saved set of machine registers and +any implementation-specific context data. Portable applications should not +modify or access \fBuc_mcontext\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetcontext\fR(2), \fBsigaction\fR(2), \fBsigaltstack\fR(2), +\fBsigprocmask\fR(2), \fBmakecontext\fR(3C), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/uio.h.3head b/usr/src/man/man3head/uio.h.3head new file mode 100644 index 0000000000..3c98adcf4d --- /dev/null +++ b/usr/src/man/man3head/uio.h.3head @@ -0,0 +1,69 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 uio.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +uio.h, uio \- definitions for vector I/O operations +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/uio.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/uio.h\fR> header defines the \fBiovec\fR structure, which includes +the following members: +.sp +.in +2 +.nf +void *iov_base /* base address of a memory region + for input or output */ +size_t iov_len /* size of the memory pointed to by + iov_base */ +.fi +.in -2 + +.sp +.LP +The <\fBsys/uio.h\fR> header uses the \fBiovec\fR structure for scatter/gather +I/O. +.sp +.LP +The \fBssize_t\fR and \fBsize_t\fR types are defined as described in +<\fBsys/types.h\fR>. +.SH USAGE +.sp +.LP +The symbol {\fBIOV_MAX\fR} defined in <\fBlimits.h\fR> should always be used to +learn about the limits on the number of scatter/gather elements that can be +processed in one call, instead of assuming a fixed value. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBread\fR(2), \fBwrite\fR(2), \fBlimits.h\fR(3HEAD), \fBtypes.h\fR(3HEAD), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/ulimit.h.3head b/usr/src/man/man3head/ulimit.h.3head new file mode 100644 index 0000000000..a376a87394 --- /dev/null +++ b/usr/src/man/man3head/ulimit.h.3head @@ -0,0 +1,66 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 ulimit.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +ulimit.h, ulimit \- ulimit commands +.SH SYNOPSIS +.LP +.nf +#include <\fBulimit.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBulimit.h\fR> header defines the following symbolic constants used by +the \fBulimit()\fR function. +.sp +.ne 2 +.mk +.na +\fB\fBUL_GETFSIZE\fR\fR +.ad +.RS 15n +.rt +Get maximum file size. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBUL_SETFSIZE\fR\fR +.ad +.RS 15n +.rt +Set maximum file size. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBulimit\fR(2), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/un.h.3head b/usr/src/man/man3head/un.h.3head new file mode 100644 index 0000000000..09f8dbac7e --- /dev/null +++ b/usr/src/man/man3head/un.h.3head @@ -0,0 +1,63 @@ +'\" te +.\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 un.h 3HEAD "30 Aug 2002" "SunOS 5.11" "Headers" +.SH NAME +un.h, un \- definitions for UNIX-domain sockets +.SH SYNOPSIS +.LP +.nf +#include <sys/un.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/un.h\fR> header defines the \fBsockaddr_un\fR structure that +includes the following members: +.sp +.in +2 +.nf +sa_family_t sun_family /* address family */ +char sun_path[] /* socket pathname */ +.fi +.in -2 + +.sp +.LP +The \fBsockaddr_un\fR structure is used to store addresses for UNIX domain +sockets. Values of this type must be cast to \fBstruct sockaddr\fR for use with +the socket interfaces. +.sp +.LP +The <\fBsys/un.h\fR> header defines the type \fBsa_family_t\fR as described in +\fBsocket.h\fR(3HEAD). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBbind\fR(3SOCKET), \fBbind\fR(3XNET), \fBsocket.h\fR(3HEAD), +\fBsocket\fR(3SOCKET), \fBsocket\fR(3XNET), \fBsocketpair\fR(3SOCKET), +\fBsocketpair\fR(3XNET), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/unistd.h.3head b/usr/src/man/man3head/unistd.h.3head new file mode 100644 index 0000000000..6dd58ffa84 --- /dev/null +++ b/usr/src/man/man3head/unistd.h.3head @@ -0,0 +1,1348 @@ +'\" te +.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 1989 AT&T +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text +.\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical +.\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 unistd.h 3HEAD "1 Sep 2009" "SunOS 5.11" "Headers" +.SH NAME +unistd.h, unistd \- standard symbolic constants and types +.SH SYNOPSIS +.LP +.nf +#include <unistd.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBunistd.h\fR> header defines the symbolic constants and structures which +are not already defined or declared in some other header. The contents of this +header are shown below. +.SS "Version Test Macros" +.sp +.LP +The following symbolic constants are defined (with fixed values): +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_VERSION\fR\fR +.ad +.RS 22n +.rt +Integer value indicating version of the POSIX standard (C language binding). +See \fBstandards\fR(5). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_VERSION\fR\fR +.ad +.RS 22n +.rt +Integer value indicating version of the POSIX.2 standard (Commands). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_C_VERSION\fR\fR +.ad +.RS 22n +.rt +Integer value indicating version of the POSIX.2 standard (C language binding). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_VERSION\fR\fR +.ad +.RS 22n +.rt +Integer value indicating version of the XPG to which system conforms. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_XCU_VERSION\fR\fR +.ad +.RS 22n +.rt +Integer value indicating the version of the XCU specification to which the +implementation conforms. If this constant is not defined, use the +\fBsysconf\fR(3C) function to determine which features are supported. This +constant is not defined for the SUSv3 environment. +.RE + +.SS "Mandatory Symbolic Constants" +.sp +.LP +The following symbolic constants, if defined in <\fBunistd.h\fR>, have a value +of -1, 0, or greater, unless otherwise specified below. If these are undefined, +the \fBfpathconf\fR(2), \fBpathconf\fR(2), or \fBsysconf\fR(3C) functions can +be used to determine whether the option is provided for a particular invocation +of the application. +.sp +.LP +If a symbolic constant is defined with the value -1, the option is not +supported. Headers, data types, and function interfaces required only for the +option need not be supplied. An application that attempts to use anything +associated only with the option is considered to be requiring an extension. +.sp +.LP +If a symbolic constant is defined with a value greater than zero, the option is +always supported when the application is executed. All headers, data types, and +functions are present and operate as specified. +.sp +.LP +If a symbolic constant is defined with the value zero, all headers, data types, +and functions are present. The application can check at runtime to see whether +the option is supported by calling \fBfpathconf()\fR, \fBpathconf()\fR, or +\fBsysconf()\fR with the indicated \fIname\fR parameter. +.sp +.LP +Unless explicitly specified otherwise, the behavior of functions associated +with an unsupported option is unspecified, and an application that uses such +functions without first checking \fBfpathconf()\fR, \fBpathconf()\fR, or +\fBsysconf()\fR is considered to be requiring an extension. +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_ADVISORY_INFO\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Advisory Information option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_ASYNCHRONOUS_IO\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Asynchronous Input and Output option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_BARRIERS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Barriers option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_CLOCK_SELECTION\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Clock Selection option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_CPUTIME\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Process CPU-Time Clocks option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_FSYNC\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the File Synchronisation option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_IPV6\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the IPv6 option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_JOB_CONTROL\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports job control. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_MAPPED_FILES\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Memory Mapped Files option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_MEMLOCK\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Process Memory Locking option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_MEMLOCK_RANGE\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Range Memory Locking option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_MEMORY_PROTECTION\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Memory Protection option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_MESSAGE_PASSING\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Message Passing option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_MONOTONIC_CLOCK\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Monotonic Clock option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_PRIORITY_SCHEDULING\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Process Scheduling option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_RAW_SOCKETS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Raw Sockets option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_READER_WRITER_LOCKS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Read-Write Locks option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_REALTIME_SIGNALS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Realtime Signals Extension option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_REGEXP\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Regular Expression Handling option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SAVED_IDS\fR\fR +.ad +.sp .6 +.RS 4n +The exec functions (see \fBexec\fR(2)) save the effective user and group. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SEMAPHORES\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Semaphores option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SHARED_MEMORY_OBJECTS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Shared Memory Objects option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SHELL\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the POSIX shell. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SPAWN\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Spawn option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SPIN_LOCKS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Spin Locks option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SPORADIC_SERVER\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Process Sporadic Server option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SYNCHRONIZED_IO\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Synchronized Input and Output option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_THREAD_ATTR_STACKADDR\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the thread stack address attribute option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_THREAD_ATTR_STACKSIZE\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the thread stack size attribute option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_THREAD_CPUTIME\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Thread CPU-Time Clocks option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_THREAD_PROCESS_SHARED\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the process-shared synchronization option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_THREAD_SAFE_FUNCTIONS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the thread-safe functions option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_THREAD_SPORADIC_SERVER\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Thread Sporadic Server option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_THREADS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the threads option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TIMERS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Timers option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TIMEOUTS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Timeouts option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TRACE\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Trace option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TRACE_EVENT_FILTER\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Trace Event Filter option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TRACE_INHERIT\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Trace Inherit option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TRACE_LOG\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Trace Log option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_TYPED_MEMORY_OBJECTS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Typed Memory Objects option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_V6_ILP32_OFF32\fR\fR +.ad +.sp .6 +.RS 4n +Implementation provides a C-language compilation environment with 32-bit +\fBint\fR, \fBlong\fR, and \fBpointer\fR types and an \fBoff_t\fR type using at +least 64 bits. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_V6_ILP32_OFFBIG\fR\fR +.ad +.sp .6 +.RS 4n +Implementation provides a C-language compilation environment with 32-bit +\fBint\fR, long\fB\fR, and \fBpointer\fR types and an \fBoff_t\fR type using at +least 64 bits. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_V6_LP64_OFF64\fR\fR +.ad +.sp .6 +.RS 4n +Implementation provides a C-language compilation environment with 32-bit +\fBint\fR and 64-bit \fBlong\fR, \fBpointer\fR, and \fBoff_t\fR types. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_V6_LPBIG_OFFBIG\fR\fR +.ad +.sp .6 +.RS 4n +Implementation provides a C-language compilation environment with an \fBint\fR +type using at least 32 bits and \fBlong\fR, \fBpointer\fR, and \fBoff_t\fR +types using at least 64 bits. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_XOPEN_STREAMS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the XSI STREAMS Option Group. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_C_BIND\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the C Language Binding option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_C_DEV\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the C Language Development Utilities option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_CHAR_TERM\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports at least one terminal type. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_LOCALEDEF\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the creation of locales by the \fBlocaledef\fR(1) +utility. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_PBS\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Batch Environment Services and Utilities option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_PBS_ACCOUNTING\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Batch Accounting option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_PBS_CHECKPOINT\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Batch Checkpoint/Restart option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_PBS_LOCATE\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Locate Batch Job Request option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_PBS_MESSAGE\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Batch Job Message Request option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_PBS_TRACK\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Track Batch Job Request option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_SW_DEV\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Software Development Utilities option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX2_UPE\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the User Portability Utilities option. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XBS5_ILP32_OFF32\fR\fR +.ad +.sp .6 +.RS 4n +Implementation provides a C-language compilation environment with 32-bit +\fBint\fR, \fBlong\fR, \fBpointer\fR and \fBoff_t\fR types. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XBS5_ILP32_OFFBIG\fR\fR +.ad +.sp .6 +.RS 4n +Implementation provides a C-language compilation environment with 32-bit +\fBint\fR, \fBlong\fR and \fBpointer\fR types and an \fBoff_t\fR type using at +least 64 bits. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XBS5_LP64_OFF64\fR\fR +.ad +.sp .6 +.RS 4n +Implementation provides a C-language compilation environment with 32-bit +\fBint\fR and 64-bit \fBlong\fR, \fBpointer\fR and \fBoff_t\fR types. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XBS5_LPBIG_OFFBIG\fR\fR +.ad +.sp .6 +.RS 4n +Implementation provides a C-language compilation environment with an \fBint\fR +type using at least 32 bits and \fBlong\fR, \fBpointer\fR and \fBoff_t\fR types +using at least 64 bits. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_ENH_I18N\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Issue 4, Version 2 Enhanced Internationalization +Feature Group. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_LEGACY\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Legacy Feature Group. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_REALTIME\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the X/Open Realtime Feature Group. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_SHM\fR\fR +.ad +.sp .6 +.RS 4n +Implementation supports the Issue 4, Version 2 Shared Memory Feature Group. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_UNIX\fR\fR +.ad +.sp .6 +.RS 4n +X/Open CAE Specification, January 1997, System Interfaces and Headers, Issue 5 +(ISBN: 1-85912-181-0, C606). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_XPG3\fR\fR +.ad +.sp .6 +.RS 4n +X/Open Specification, February 1992, System Interfaces and Headers, Issue 3 +(ISBN: 1-872630-37-5, C212); this specification was formerly X/Open Portability +Guide, Issue 3, Volume 2, January 1989, XSI System Interface and Headers (ISBN: +0-13-685843-0, XO/XPG/89/003). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_XOPEN_XPG4\fR\fR +.ad +.sp .6 +.RS 4n +X/Open CAE Specification, July 1992, System Interfaces and Headers, Issue 4 +(ISBN: 1-872630-47-2, C202). +.RE + +.SS "Execution-time Symbolic Constants" +.sp +.LP +If any of the following constants are not defined in the header +\fB<unistd.h>\fR, the value varies depending on the file to which it is +applied. +.sp +.LP +If any of the following constants are defined to have value \(mi1 in the header +\fB<unistd.h>\fR, the implementation will not provide the option on any file; +if any are defined to have a value other than \(mi1 in the header +\fB<unistd.h>\fR, the implementation will provide the option on all applicable +files. +.sp +.LP +All of the following constants, whether defined in \fB<unistd.h>\fR or not, can +be queried with respect to a specific file using the \fBpathconf()\fR or +\fBfpathconf()\fR functions. +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_ASYNC_IO\fR\fR +.ad +.RS 19n +.rt +Asynchronous input or output operations can be performed for the associated +file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_PRIO_IO\fR\fR +.ad +.RS 19n +.rt +Prioritized input or output operations can be performed for the associated +file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB_POSIX_SYNC_IO\fR\fR +.ad +.RS 19n +.rt +Synchronized input or output operations can be performed for the associated +file. +.RE + +.SS "Constants for Functions" +.sp +.LP +The following constant is defined: +.sp +.ne 2 +.mk +.na +\fB\fINULL\fR\fR +.ad +.RS 8n +.rt +Null pointer. +.RE + +.sp +.LP +The following symbolic constants are defined for the \fBaccess\fR(2) function: +.sp +.ne 2 +.mk +.na +\fB\fBR_OK\fR\fR +.ad +.RS 8n +.rt +Test for read permission. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBW_OK\fR\fR +.ad +.RS 8n +.rt +Test for write permission. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBX_OK\fR\fR +.ad +.RS 8n +.rt +Test for execute (search) permission. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_OK\fR\fR +.ad +.RS 8n +.rt +Test for existence of file. +.RE + +.sp +.LP +The constants \fBF_OK\fR, \fBR_OK\fR, \fBW_OK\fR, and \fBX_OK\fR, and the +expressions \fBR_OK\||\|W_OK\fR, \fBR_OK\||\|X_OK\fR, and +\fBR_OK\||\|W_OK\||\|X_OK\fR all have distinct values. +.sp +.LP +The following symbolic constants are defined for the \fBlockf\fR(3C) function: +.sp +.ne 2 +.mk +.na +\fB\fBF_ULOCK\fR\fR +.ad +.RS 11n +.rt +Unlock a previously locked region. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_LOCK\fR\fR +.ad +.RS 11n +.rt +Lock a region for exclusive use. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_TLOCK\fR\fR +.ad +.RS 11n +.rt +Test and lock a region for exclusive use. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBF_TEST\fR\fR +.ad +.RS 11n +.rt +Test a region for other processes locks. +.RE + +.sp +.LP +The following symbolic constants are defined for the \fBlseek\fR(2) and +\fBfcntl\fR(2) functions (they have distinct values): +.sp +.ne 2 +.mk +.na +\fB\fBSEEK_SET\fR\fR +.ad +.RS 12n +.rt +Set file offset to \fIoffset\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSEEK_CUR\fR\fR +.ad +.RS 12n +.rt +Set file offset to current plus \fIoffset\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSEEK_END\fR\fR +.ad +.RS 12n +.rt +Set file offset to EOF plus \fIoffset\fR. +.RE + +.sp +.LP +The following symbolic constants are defined for the \fBconfstr\fR(3C) function +for both SPARC and x86: +.sp + +.sp +.TS +tab(); +lw(2.75i) lw(2.75i) +lw(2.75i) lw(2.75i) +. +\fB_CS_LFS64_CFLAGS\fR\fB_CS_LFS64_LDFLAGS\fR +\fB_CS_LFS64_LIBS\fR\fB_CS_LFS64_LINTFLAGS\fR +\fB_CS_LFS_CFLAGS\fR\fB_CS_LFS_LDFLAGS\fR +\fB_CS_LFS_LIBS\fR\fB_CS_LFS_LINTFLAGS\fR +\fB_CS_PATH\fR\fB_CS_POSIX_V6_ILP32_OFF32_CFLAGS\fR +\fB_CS_POSIX_V6_ILP32_OFF32_LDFLAGS\fR\fB_CS_POSIX_V6_ILP32_OFF32_LIBS\fR +\fB_CS_POSIX_V6_ILP32_OFF32_LINTFLAGS\fR\fB_CS_POSIX_V6_ILP32_OFFBIG_CFLAGS\fR +\fB_CS_POSIX_V6_ILP32_OFFBIG_LDFLAGS\fR\fB_CS_POSIX_V6_ILP32_OFFBIG_LIBS\fR +\fB_CS_POSIX_V6_ILP32_OFFBIG_LINTFLAGS\fR\fB_CS_POSIX_V6_WIDTH_RESTRICTED_ENV\fR +\fB_CS_XBS5_ILP32_OFF32_CFLAGS\fR\fB_CS_XBS5_ILP32_OFF32_LDFLAGS\fR +\fB_CS_XBS5_ILP32_OFF32_LIBS\fR\fB_CS_XBS5_ILP32_OFF32_LINTFLAGS\fR +\fB_CS_XBS5_ILP32_OFFBIG_CFLAGS\fR\fB_CS_XBS5_ILP32_OFFBIG_LDFLAGS\fR +\fB_CS_XBS5_ILP32_OFFBIG_LIBS\fR\fB_CS_XBS5_ILP32_OFFBIG_LINTFLAGS\fR +.TE + +.sp +.LP +The followwing symbolic constants are defined for the \fBconfstr()\fR function +for SPARC only: +.sp + +.sp +.TS +tab(); +lw(2.75i) lw(2.75i) +lw(2.75i) lw(2.75i) +. +\fB_CS_POSIX_V6_LP64_OFF64_CFLAGS\fR\fB_CS_POSIX_V6_LP64_OFF64_LDFLAGS\fR +\fB_CS_POSIX_V6_LP64_OFF64_LIBS\fR\fB_CS_POSIX_V6_LP64_OFF64_LINTFLAGS\fR +\fB_CS_POSIX_V6_LPBIG_OFFBIG_CFLAGS\fR\fB_CS_POSIX_V6_LPBIG_OFFBIG_LDFLAGS\fR +\fB_CS_POSIX_V6_LPBIG_OFFBIG_LIBS\fR\fB_CS_POSIX_V6_LPBIG_OFFBIG_LINTFLAGS\fR +\fB_CS_XBS5_LP64_OFF64_CFLAGS\fR\fB_CS_XBS5_LP64_OFF64_LDFLAGS\fR +\fB_CS_XBS5_LP64_OFF64_LIBS\fR\fB_CS_XBS5_LP64_OFF64_LINTFLAGS\fR +\fB_CS_XBS5_LPBIG_OFFBIG_CFLAGS\fR\fB_CS_XBS5_LPBIG_OFFBIG_LDFLAGS\fR +\fB_CS_XBS5_LPBIG_OFFBIG_LIBS\fR\fB_CS_XBS5_LPBIG_OFFBIG_LINTFLAGS\fR +.TE + +.sp +.LP +The following symbolic constants are defined for the \fBsysconf\fR(3C) +function: +.sp + +.sp +.TS +tab(); +lw(2.75i) lw(2.75i) +lw(2.75i) lw(2.75i) +. +\fB_SC_2_C_BIND\fR\fB_SC_2_C_DEV\fR +\fB_SC_2_C_VERSION\fR\fB_SC_2_FORT_DEV\fR +\fB_SC_2_FORT_RUN\fR\fB_SC_2_LOCALEDEF\fR +\fB_SC_2_PBS\fR\fB_SC_2_PBS_ACCOUNTING\fR +\fB_SC_2_PBS_CHECKPOINT\fR\fB_SC_2_PBS_LOCATE\fR +\fB_SC_2_PBS_MESSAGE\fR\fB_SC_2_PBS_TRACK\fR +\fB_SC_2_SW_DEV\fR\fB_SC_2_UPE\fR +\fB_SC_2_VERSION\fR\fB_SC_ADVISORY_INFO\fR +\fB_SC_AIO_LISTIO_MAX\fR\fB_SC_AIO_MAX\fR +\fB_SC_AIO_PRIO_DELTA_MAX\fR\fB_SC_ARG_MAX\fR +\fB_SC_ASYNCHRONOUS_IO\fR\fB_SC_ATEXIT_MAX\fR +\fB_SC_AVPHYS_PAGES\fR\fB_SC_BARRIERS\fR +\fB_SC_BC_BASE_MAX\fR\fB_SC_BC_DIM_MAX\fR +\fB_SC_BC_SCALE_MAX\fR\fB_SC_BC_STRING_MAX\fR +\fB_SC_CHILD_MAX\fR\fB_SC_CLK_TCK\fR +\fB_SC_CLOCK_SELECTION\fR\fB_SC_COLL_WEIGHTS_MAX\fR +\fB_SC_CPUTIME\fR\fB_SC_DELAYTIMER_MAX\fR +\fB_SC_EXPR_NEST_MAX\fR\fB_SC_FSYNC\fR +\fB_SC_GETGR_R_SIZE_MAX\fR\fB_SC_GETPW_R_SIZE_MAX\fR +\fB_SC_HOST_NAME_MAX\fR\fB_SC_IOV_MAX\fR +\fB_SC_IPV6\fR\fB_SC_JOB_CONTROL\fR +\fB_SC_LINE_MAX\fR\fB_SC_LOGIN_NAME_MAX\fR +\fB_SC_LOGNAME_MAX\fR\fB_SC_MAPPED_FILES\fR +\fB_SC_MEMLOCK\fR\fB_SC_MEMLOCK_RANGE\fR +\fB_SC_MEMORY_PROTECTION\fR\fB_SC_MESSAGE_PASSING\fR +\fB_SC_MONOTONIC_CLOCK\fR\fB_SC_MQ_OPEN_MAX\fR +\fB_SC_MQ_PRIO_MAX\fR\fB_SC_NGROUPS_MAX\fR +\fB_SC_NPROCESSORS_CONF\fR\fB_SC_NPROCESSORS_ONLN\fR +\fB_SC_OPEN_MAX\fR\fB_SC_PAGESIZE\fR +\fB_SC_PAGE_SIZE\fR\fB_SC_PASS_MAX\fR +\fB_SC_PHYS_PAGES\fR\fB_SC_PRIORITIZED_IO\fR +\fB_SC_PRIORITY_SCHEDULING\fR\fB_SC_RAW_SOCKETS\fR +\fB_SC_READER_WRITER_LOCKS\fR\fB_SC_REALTIME_SIGNALS\fR +\fB_SC_REGEXP\fR\fB_SC_RE_DUP_MAX\fR +\fB_SC_RTSIG_MAX\fR\fB_SC_SAVED_IDS\fR +\fB_SC_SEMAPHORES\fR\fB_SC_SEM_NSEMS_MAX\fR +\fB_SC_SEM_VALUE_MAX\fR\fB_SC_SHARED_MEMORY_OBJECTS\fR +\fB_SC_SHELL\fR\fB_SC_SIGQUEUE_MAX\fR +\fB_SC_SPAWN\fR\fB_SC_SPIN_LOCKS\fR +\fB_SC_SPORADIC_SERVER\fR\fB_SC_SS_REPL_MAX\fR +\fB_SC_STREAM_MAX\fR\fB_SC_SYMLOOP_MAX\fR +\fB_SC_SYNCHRONIZED_IO\fR\fB_SC_THREAD_ATTR_STACKADDR\fR +\fB_SC_THREAD_ATTR_STACKSIZE\fR\fB_SC_THREAD_CPUTIME\fR +\fB_SC_THREAD_DESTRUCTOR_ITERATIONS\fR\fB_SC_THREAD_KEYS_MAX\fR +\fB_SC_THREAD_PRIO_INHERIT\fR\fB_SC_THREAD_PRIO_PROTECT\fR +\fB_SC_THREAD_PRIORITY_SCHEDULING\fR\fB_SC_THREAD_PROCESS_SHARED\fR +\fB_SC_THREAD_SPORADIC_SERVER\fR\fB_SC_THREADS\fR +\fB_SC_THREAD_SAFE_FUNCTIONS\fR\fB_SC_THREAD_STACK_MIN\fR +\fB_SC_THREAD_THREADS_MAX\fR\fB_SC_TIMEOUTS\fR +\fB_SC_TIMER_MAX\fR\fB_SC_TIMERS\fR +\fB_SC_TRACE\fR\fB_SC_TRACE_EVENT_FILTER\fR +\fB_SC_TRACE_EVENT_NAME_MAX\fR\fB_SC_TRACE_INHERIT\fR +\fB_SC_TRACE_LOG\fR\fB_SC_TRACE_NAME_MAX\fR +\fB_SC_TRACE_SYS_MAX\fR\fB_SC_TRACE_USER_EVENT_MAX\fR +\fB_SC_TTY_NAME_MAX\fR\fB_SC_TYPED_MEMORY_OBJECTS\fR +\fB_SC_TZNAME_MAX\fR\fB_SC_V6_ILP32_OFF32\fR +\fB_SC_V6_ILP32_OFFBIG\fR\fB_SC_V6_LP64_OFF64\fR +\fB_SC_V6_LPBIG_OFFBIG\fR\fB_SC_VERSION\fR +\fB_SC_XBS5_ILP32_OFF32\fR\fB_SC_XBS5_ILP32_OFFBIG\fR +\fB_SC_XBS5_LP64_OFF64\fR\fB_SC_XBS5_LPBIG_OFFBIG\fR +\fB_SC_XOPEN_CRYPT\fR\fB_SC_XOPEN_ENH_I18N\fR +\fB_SC_XOPEN_SHM\fR\fB_SC_XOPEN_STREAMS\fR +\fB_SC_XOPEN_UNIX\fR\fB_SC_XOPEN_VERSION\fR +\fB_SC_XOPEN_XCU_VERSION\fR +.TE + +.sp +.LP +The constants \fB_SC_PAGESIZE\fR and \fB_SC_PAGE_SIZE\fR can be defined to have +the same value. +.sp +.LP +The following symbolic constants are defined for the \fBfpathconf\fR(2) +function: +.sp + +.sp +.TS +tab(); +lw(2.75i) lw(2.75i) +lw(2.75i) lw(2.75i) +. +\fB_PC_2_SYMLINKS\fR\fB_PC_ALLOC_SIZE_MIN\fR +\fB_PC_ASYNC_IO\fR\fB_PC_CHOWN_RESTRICTED\fR +\fB_PC_FILESIZEBITS\fR\fB_PC_LINK_MAX\fR +\fB_PC_MAX_CANON\fR\fB_PC_MAX_INPUT\fR +\fB_PC_NAME_MAX\fR\fB_PC_NO_TRUNC\fR +\fB_PC_PATH_MAX\fR\fB_PC_PIPE_BUF\fR +\fB_PC_PRIO_IO\fR\fB_PC_REC_INCR_XFER_SIZE\fR +\fB_PC_REC_MAX_XFER_SIZE\fR\fB_PC_REC_MIN_XFER_SIZE\fR +\fB_PC_REC_XFER_ALIGN\fR\fB_PC_SYMLINK_MAX\fR +\fB_PC_SYNC_IO\fR\fB_PC_TIMESTAMP_RESOLUTION\fR +\fB_PC_VDISABLE\fR\fB_PC_XATTR_ENABLED\fR +\fB_PC_XATTR_EXISTS\fR +.TE + +.sp +.LP +The following symbolic constants are defined for file streams: +.sp +.ne 2 +.mk +.na +\fB\fBSTDIN_FILENO\fR\fR +.ad +.RS 17n +.rt +File number (\fB0\fR) of \fBstdin\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSTDOUT_FILENO\fR\fR +.ad +.RS 17n +.rt +File number (\fB1\fR) of \fBstout\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSTDERR_FILENO\fR\fR +.ad +.RS 17n +.rt +File number (\fB2\fR) of \fBstderr\fR. +.RE + +.sp +.LP +The following pathnames are defined: +.sp +.ne 2 +.mk +.na +\fB\fBGF_PATH\fR\fR +.ad +.RS 11n +.rt +Pathname of the group file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBPF_PATH\fR\fR +.ad +.RS 11n +.rt +Pathname of the passwd file. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityCommitted +_ +StandardSee \fBstandards\fR(5). +.TE + +.SH SEE ALSO +.sp +.LP +\fBaccess\fR(2), \fBexec\fR(2), \fBfcntl\fR(2), \fBfpathconf\fR(2), +\fBlseek\fR(2), \fBconfstr\fR(3C), \fBlockf\fR(3C), \fBsysconf\fR(3C), +\fBtermios\fR(3C), \fBgroup\fR(4), \fBpasswd\fR(4), \fBattributes\fR(5), +\fBstandards\fR(5), \fBtermio\fR(7I) diff --git a/usr/src/man/man3head/utime.h.3head b/usr/src/man/man3head/utime.h.3head new file mode 100644 index 0000000000..d76fc90bc7 --- /dev/null +++ b/usr/src/man/man3head/utime.h.3head @@ -0,0 +1,58 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 utime.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +utime.h, utime \- access and modification times structure +.SH SYNOPSIS +.LP +.nf +#include <\fButime.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fButime.h\fR> header declares the structure \fButimbuf\fR, which includes +the following members: +.sp +.in +2 +.nf +time_t actime /* access time */ +time_t modtime /* modification time */ +.fi +.in -2 + +.sp +.LP +The times are measured in seconds since the Epoch. +.sp +.LP +The type \fBtime_t\fR is defined as described in <\fBsys/types.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fButime\fR(2), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/utmpx.h.3head b/usr/src/man/man3head/utmpx.h.3head new file mode 100644 index 0000000000..60622e878c --- /dev/null +++ b/usr/src/man/man3head/utmpx.h.3head @@ -0,0 +1,192 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. +.\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 utmpx.h 3HEAD "16 Apr 2007" "SunOS 5.11" "Headers" +.SH NAME +utmpx.h, utmpx \- user accounting database definitions +.SH SYNOPSIS +.LP +.nf +#include <utmpx.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The \fB<utmpx.h>\fR header defines the \fButmpx\fR structure, which includes +the following members: +.sp +.in +2 +.nf +char ut_user[]; /* user login name */ +char ut_id[]; /* unspecified initialization */ + /* process identifier */ +char ut_line[]; /* device name */ +pid_t ut_pid; /* process ID */ +short ut_type; /* type of entry */ +.fi +.in -2 + +.sp +.LP +for X/Open compilation environments: +.sp +.in +2 +.nf +struct ut_exit_status ut_exit; /* process termination/exit status*/ +.fi +.in -2 + +.sp +.LP +for all other compilation environments: +.sp +.in +2 +.nf +struct exit_status ut_exit; /* process termination/exit status*/ +.fi +.in -2 + +.sp +.in +2 +.nf +struct timeval ut_tv; /* time entry was made */ +int ut_session; /* session ID, used for windowing */ +short ut_syslen; /* significant length of ut_host */ + /* including terminating null */ +char ut_host[]; /* remote host name */ +.fi +.in -2 + +.sp +.LP +The \fBpid_t\fR type is defined through \fBtypedef\fR as described in +\fB<sys/types.h>\fR. +.sp +.LP +The \fBtimeval\fR structure is defined as described in \fB<sys/time.h>\fR. +.sp +.LP +Inclusion of the \fB<utmpx.h>\fR header can also make visible all symbols from +\fB<sys/time.h>\fR. +.sp +.LP +The following symbolic constants are defined as possible values for the +\fBut_type\fR member of the \fButmpx\fR structure: +.sp +.ne 2 +.mk +.na +\fB\fBEMPTY\fR\fR +.ad +.RS 17n +.rt +No valid user accounting information. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBBOOT_TIME\fR\fR +.ad +.RS 17n +.rt +Identifies time of system boot. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBOLD_TIME\fR\fR +.ad +.RS 17n +.rt +Identifies time when system clock changed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNEW_TIME\fR\fR +.ad +.RS 17n +.rt +Identifies time after system clock changed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBUSER_PROCESS\fR\fR +.ad +.RS 17n +.rt +Identifies a process. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBINIT_PROCESS\fR\fR +.ad +.RS 17n +.rt +Identifies a process spawned by the \fBinit\fR process. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBLOGIN_PROCESS\fR\fR +.ad +.RS 17n +.rt +Identifies the session leader of a logged-in user. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBDEAD_PROCESS\fR\fR +.ad +.RS 17n +.rt +Identifies a session leader who has exited. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBendutxent\fR(3C), \fBtime.h\fR(3HEAD), \fBtypes.h\fR(3HEAD), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/utsname.h.3head b/usr/src/man/man3head/utsname.h.3head new file mode 100644 index 0000000000..ce3ecf8824 --- /dev/null +++ b/usr/src/man/man3head/utsname.h.3head @@ -0,0 +1,65 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 utsname.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +utsname.h, utsname \- system name structure +.SH SYNOPSIS +.LP +.nf +#include <\fBsys/utsname.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBsys/utsname.h\fR> header defines the structure \fButsname\fR, which +includes the following members: +.sp +.in +2 +.nf +char sysname[] /* name of this implementation of the + operating system */ +char nodename[] /* name of this node within an + implementation-defined communications + network */ +char release[] /* current release level of this + implementation */ +char version[] /* current version level of this + release */ +char machine[] /* name of the hardware type on which + the system is running */ +.fi +.in -2 + +.sp +.LP +The character arrays are of unspecified size, but the data stored in them is +terminated by a null byte. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBuname\fR(2), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/values.h.3head b/usr/src/man/man3head/values.h.3head new file mode 100644 index 0000000000..fc8b819c51 --- /dev/null +++ b/usr/src/man/man3head/values.h.3head @@ -0,0 +1,176 @@ +'\" te +.\" Copyright 1989 AT&T +.\" 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 values.h 3HEAD "2 Mar 1993" "SunOS 5.11" "Headers" +.SH NAME +values.h, values \- machine-dependent values +.SH SYNOPSIS +.LP +.nf +\fB#include <values.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +This file contains a set of manifest constants, conditionally defined for +particular processor architectures. +.sp +.LP +The model assumed for integers is binary representation (one's or two's +complement), where the sign is represented by the value of the high-order bit. +.sp +.ne 2 +.mk +.na +\fB\fBBITS(\fR\fBtype\fR)\fR +.ad +.RS 27n +.rt +The number of bits in a specified type (for example, \fBint\fR). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBHIBITS\fR\fR +.ad +.RS 27n +.rt +The value of a short integer with only the high-order bit set. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBHIBITL\fR\fR +.ad +.RS 27n +.rt +The value of a long integer with only the high-order bit set. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBHIBITI\fR\fR +.ad +.RS 27n +.rt +The value of a regular integer with only the high-order bit set. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMAXSHORT\fR\fR +.ad +.RS 27n +.rt +The maximum value of a signed short integer. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMAXLONG\fR\fR +.ad +.RS 27n +.rt +The maximum value of a signed long integer. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMAXINT\fR\fR +.ad +.RS 27n +.rt +The maximum value of a signed regular integer. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMAXFLOAT\fR, \fBLN_MAXFLOAT\fR\fR +.ad +.RS 27n +.rt +The maximum value of a single-precision floating-point number, and its natural +logarithm. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMAXDOUBLE\fR, \fBLN_MAXDOUBLE\fR\fR +.ad +.RS 27n +.rt +The maximum value of a double-precision floating-point number, and its natural +logarithm. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMINFLOAT\fR, \fBLN_MINFLOAT\fR\fR +.ad +.RS 27n +.rt +The minimum positive value of a single-precision floating-point number, and its +natural logarithm. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMINDOUBLE\fR, \fBLN_MINDOUBLE\fR\fR +.ad +.RS 27n +.rt +The minimum positive value of a double-precision floating-point number, and its +natural logarithm. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFSIGNIF\fR\fR +.ad +.RS 27n +.rt +The number of significant bits in the mantissa of a single-precision +floating-point number. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBDSIGNIF\fR\fR +.ad +.RS 27n +.rt +The number of significant bits in the mantissa of a double-precision +floating-point number. +.RE + +.SH SEE ALSO +.sp +.LP +\fBIntro\fR(3) \fBmath.h\fR(3HEAD) diff --git a/usr/src/man/man3head/wait.h.3head b/usr/src/man/man3head/wait.h.3head new file mode 100644 index 0000000000..5a00446109 --- /dev/null +++ b/usr/src/man/man3head/wait.h.3head @@ -0,0 +1,260 @@ +'\" te +.\" Copyright 1989 AT&T. Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 wait.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +wait.h, wait \- wait status +.SH SYNOPSIS +.LP +.nf +\fB#include <sys/wait.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +When a process waits for status from its children using either the +\fBwait\fR(3C) or \fBwaitpid\fR(3C) function, the status returned can be +evaluated with the following macros, defined in <\fBsys/wait.h\fR>. These +macros evaluate to integral expressions. The \fIstat\fR argument to these +macros is the integer value returned from \fBwait()\fR or \fBwaitpid()\fR. +.sp +.ne 2 +.mk +.na +\fB\fBWCOREDUMP\fR(\fIstat\fR)\fR +.ad +.RS 22n +.rt +If the value of \fBWIFSIGNALED\fR (\fIstat\fR) is non-zero, this macro +evaluates to a non-zero value if a core image of the terminated child was +created. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWEXITSTATUS\fR(\fIstat\fR)\fR +.ad +.RS 22n +.rt +If the value of \fBWIFEXITED(\fR\fIstat\fR\fB)\fR is non-zero, this macro +evaluates to the exit code that the child process passed to \fB_exit()\fR (see +\fBexit\fR(2)) or \fBexit\fR(3C), or the value that the child process returned +from \fBmain\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWIFCONTINUED\fR(\fIstat\fR)\fR +.ad +.RS 22n +.rt +Evaluates to a non-zero value if status was returned for a child process that +has continued. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWIFEXITED\fR(\fIstat\fR)\fR +.ad +.RS 22n +.rt +Evaluates to a non-zero value if status was returned for a child process that +terminated normally. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWIFSIGNALED\fR(\fIstat\fR)\fR +.ad +.RS 22n +.rt +Evaluates to a non-zero value if status was returned for a child process that +terminated due to the receipt of a signal. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWIFSTOPPED\fR(\fIstat\fR)\fR +.ad +.RS 22n +.rt +Evaluates to a non-zero value if status was returned for a child process that +is currently stopped. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWSTOPSIG\fR(\fIstat\fR)\fR +.ad +.RS 22n +.rt +If the value of \fBWIFSTOPPED(\fR\fIstat\fR\fB)\fR is non-zero, this macro +evaluates to the number of the signal that caused the child process to stop. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWTERMSIG\fR(\fIstat\fR)\fR +.ad +.RS 22n +.rt +If the value of \fBWIFSIGNALED\fR(\fIstat\fR) is non-zero, this macro +evaluates to the number of the signal that caused the termination of the child +process. +.RE + +.sp +.LP +The <\fBsys/wait.h\fR> header defines the symbolic constants listed below for +use with \fBwaitpid\fR(3C). +.sp +.ne 2 +.mk +.na +\fB\fBWNOHANG\fR\fR +.ad +.RS 13n +.rt +Do not hang if no status is available; return immediately. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWUNTRACED\fR\fR +.ad +.RS 13n +.rt +Report status of stopped child process. +.RE + +.sp +.LP +The symbolic constants listed below are defined as possible values for the +\fIoptions\fR argument to \fBwaitid\fR(2). +.sp +.ne 2 +.mk +.na +\fB\fBWEXITED\fR\fR +.ad +.RS 14n +.rt +Wait for processes that have exited. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWSTOPPED\fR\fR +.ad +.RS 14n +.rt +Status is returned for any child that has stopped upon receipt of a signal. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWCONTINUED\fR\fR +.ad +.RS 14n +.rt +Status is returned for any child that was stopped and has been continued. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWNOHANG\fR\fR +.ad +.RS 14n +.rt +Return immediately if there are no children to wait for. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWNOWAIT\fR\fR +.ad +.RS 14n +.rt +Keep the process whose status is returned in \fBinfop\fR in a waitable state. +.RE + +.sp +.LP +The type \fBidtype_t\fR is defined as an enumeration type whose possible values +include the following: +.sp +.in +2 +.nf +P_ALL +P_PID +P_PGID +.fi +.in -2 + +.sp +.LP +The \fBid_t\fR and \fBpid_t\fR types are defined as described in +<\fBsys/types.h\fR>. +.sp +.LP +The \fBsiginfo_t\fR type is defined as described in <\fBsignal.h\fR>. +.sp +.LP +The \fBrusage\fR structure is defined as described in <\fBsys/resource.h\fR>. +.sp +.LP +Inclusion of the <\fBsys/wait.h\fR> header can also make visible all symbols +from <\fBsignal.h\fR> and <\fBsys/resource.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBexit\fR(2), \fBwaitid\fR(2), \fBexit\fR(3C), \fBwait\fR(3C), +\fBwaitpid\fR(3C),\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3head/wchar.h.3head b/usr/src/man/man3head/wchar.h.3head new file mode 100644 index 0000000000..ce0afd5604 --- /dev/null +++ b/usr/src/man/man3head/wchar.h.3head @@ -0,0 +1,202 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 wchar.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +wchar.h, wchar \- wide-character handling +.SH SYNOPSIS +.LP +.nf +#include <\fBwchar.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBwchar.h\fR> header defines the following types: +.sp +.ne 2 +.mk +.na +\fB\fBwchar_t\fR\fR +.ad +.RS 13n +.rt +As described in <\fBstddef.h\fR>. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBwint_t\fR\fR +.ad +.RS 13n +.rt +An integer type capable of storing any valid value of \fBwchar_t\fR or +\fBWEOF\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBwctype_t\fR\fR +.ad +.RS 13n +.rt +A scalar type of a data object that can hold values which represent +locale-specific character classification. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBmbstate_t\fR\fR +.ad +.RS 13n +.rt +An object type other than an array type that can hold the conversion state +information necessary to convert between sequences of (possibly multi-byte) +characters and wide characters. If a codeset is being used such that an +\fBmbstate_t\fR needs to preserve more than two levels of reserved state, the +results are unspecified. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFILE\fR\fR +.ad +.RS 13n +.rt +As described in <\fBstdio.h\fR>. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBsize_t\fR\fR +.ad +.RS 13n +.rt +As described in <\fBstddef.h\fR>. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBva_list\fR\fR +.ad +.RS 13n +.rt +As described in <\fBstdarg.h\fR>. +.RE + +.sp +.LP +The implementation supports one or more programming environments in which the +width of \fBwint_t\fR is no greater than the width of type \fBlong\fR. The +names of these programming environments can be obtained using the +\fBconfstr\fR(3C) function or the \fBgetconf\fR(1) utility. +.sp +.LP +The <\fBwchar.h\fR> header defines the following macros: +.sp +.ne 2 +.mk +.na +\fB\fBWCHAR_MAX\fR\fR +.ad +.RS 13n +.rt +The maximum value representable by an object of type \fBwchar_t\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWCHAR_MIN\fR\fR +.ad +.RS 13n +.rt +The minimum value representable by an object of type \fBwchar_t\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWEOF\fR\fR +.ad +.RS 13n +.rt +Constant expression of type \fBwint_t\fR that is returned by several WP +functions to indicate end-of-file. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBNULL\fR\fR +.ad +.RS 13n +.rt +As described in <\fBstddef.h\fR>. +.RE + +.sp +.LP +The tag \fBtm\fR is declared as naming an incomplete structure type, the +contents of which are described in the header <\fBtime.h\fR>. +.sp +.LP +Inclusion of the <\fBwchar.h\fR> header can make visible all symbols from the +headers <\fBctype.h\fR>, <\fBstring.h\fR>, <\fBstdarg.h\fR>, <\fBstddef.h\fR>, +<\fBstdio.h\fR>, <\fBstdlib.h\fR>, and <\fBtime.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetconf\fR(1), \fBbtowc\fR(3C), \fBconfstr\fR(3C), \fBfgetwc\fR(3C), +\fBgetws\fR(3C), \fBfputwc\fR(3C), \fBfputws\fR(3C), \fBfwide\fR(3C), +\fBfwprintf\fR(3C), \fBfwscanf\fR(3C), \fBgetwc\fR(3C), \fBgetwchar\fR(3C), +\fBiswalpha\fR(3C), \fBiswctype\fR(3C), \fBmbsinit\fR(3C), \fBmbrlen\fR(3C), +\fBmbrtowc\fR(3C), \fBmbsrtowcs\fR(3C), \fBtowlower\fR(3C), \fBtowupper\fR(3C), +\fBungetwc\fR(3C), \fBvfwprintf\fR(3C), \fBwcrtomb\fR(3C), \fBwcsrtombs\fR(3C), +\fBwcstring\fR(3C), \fBwcsstr\fR(3C), \fBwcstod\fR(3C), \fBwcscoll\fR(3C), +\fBwcsftime\fR(3C), \fBwcstol\fR(3C), \fBwcstoul\fR(3C), \fBwcswidth\fR(3C), +\fBwcsxfrm\fR(3C), \fBwctob\fR(3C), \fBwctype\fR(3C), \fBwcwidth\fR(3C), +\fBwmemchr\fR(3C), \fBwmemcmp\fR(3C), \fBwmemcpy\fR(3C), \fBwmemmove\fR(3C), +\fBwmemset\fR(3C), \fBstdarg\fR(3EXT), \fBstddef.h\fR(3HEAD), +\fBstdio.h\fR(3HEAD), \fBstdlib.h\fR(3HEAD), \fBstring.h\fR(3HEAD), +\fBtime.h\fR(3HEAD), \fBwctype.h\fR(3HEAD), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/wctype.h.3head b/usr/src/man/man3head/wctype.h.3head new file mode 100644 index 0000000000..bfa86c0c08 --- /dev/null +++ b/usr/src/man/man3head/wctype.h.3head @@ -0,0 +1,112 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 wctype.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +wctype.h, wctype \- wide-character classification and mapping utilities +.SH SYNOPSIS +.LP +.nf +#include <\fBwctype.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBwctype.h\fR> header defines the following types: +.sp +.ne 2 +.mk +.na +\fB\fBwint_t\fR\fR +.ad +.RS 13n +.rt +As described in <\fBwchar.h\fR>. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBwctrans_t\fR\fR +.ad +.RS 13n +.rt +A scalar type that can hold values that represent locale-specific character +mappings. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBwctype_t\fR\fR +.ad +.RS 13n +.rt +As described in <\fBwchar.h\fR>. +.RE + +.sp +.LP +The <\fBwctype.h\fR> header defines the following macro name: +.sp +.ne 2 +.mk +.na +\fB\fBWEOF\fR\fR +.ad +.RS 8n +.rt +Constant expression of type \fBwint_t\fR that is returned by several MSE +functions to indicate end-of-file. +.RE + +.sp +.LP +For all functions described in this header that accept an argument of type +\fBwint_t\fR, the value is representable as a \fBwchar _t\fR or equals the +value of \fBWEOF\fR. If this argument has any other value, the behavior is +undefined. +.sp +.LP +The behavior of these functions is affected by the \fBLC_CTYPE\fR category of +the current locale. +.sp +.LP +Inclusion of the <\fBwctype.h\fR> header can make visible all symbols from the +headers <\fBctype.h\fR>, <\fBstdarg.h\fR>, <\fBstddef.h\fR>, <\fBstdio.h\fR>, +<\fBstdlib.h\fR>, <\fBstring.h\fR>, <\fBtime.h\fR>, and <\fBwchar.h\fR>. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBiswalpha\fR(3C), \fBiswctype\fR(3C), \fBlocale.h\fR(3HEAD), +\fBsetlocale\fR(3C), \fBstdarg\fR(3EXT), \fBstddef.h\fR(3HEAD), +\fBstdio.h\fR(3HEAD), \fBstdlib.h\fR(3HEAD), \fBstring.h\fR(3HEAD), +\fBtime.h\fR(3HEAD), \fBtowctrans\fR(3C), \fBtowlower\fR(3C), +\fBtowupper\fR(3C), \fBwctrans\fR(3C), \fBwctype\fR(3C), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3head/wordexp.h.3head b/usr/src/man/man3head/wordexp.h.3head new file mode 100644 index 0000000000..479464394e --- /dev/null +++ b/usr/src/man/man3head/wordexp.h.3head @@ -0,0 +1,215 @@ +'\" te +.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" 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 wordexp.h 3HEAD "10 Sep 2004" "SunOS 5.11" "Headers" +.SH NAME +wordexp.h, wordexp \- word-expansion types +.SH SYNOPSIS +.LP +.nf +#include <\fBwordexp.h\fR> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBwordexp.h\fR> header defines the structures and symbolic constants used +by the \fBwordexp()\fR and \fBwordfree()\fR functions. See \fBwordexp\fR(3C). +.sp +.LP +The structure type \fBwordexp_t\fR contains the following members: +.sp +.in +2 +.nf +size_t we_wordc /* count of words matched by words */ +char **we_wordv /* pointer to list of expanded words */ +size_t we_offs /* slots to reserve at the beginning + of we_wordv */ +.fi +.in -2 + +.sp +.LP +The \fIflags\fR argument to the \fBwordexp()\fR function is the +bitwise-inclusive OR of the following flags: +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_APPEND\fR\fR +.ad +.RS 16n +.rt +Append words to those previously generated. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_DOOFFS\fR\fR +.ad +.RS 16n +.rt +Number of null pointers to prepend to \fBwe_wordv\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_NOCMD\fR\fR +.ad +.RS 16n +.rt +Fail if command substitution is requested. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_REUSE\fR\fR +.ad +.RS 16n +.rt +The \fBpwordexp\fR argument was passed to a previous successful call to +\fBwordexp()\fR, and has not been passed to \fBwordfree()\fR. The result is the +same as if the application had called \fBwordfree()\fR and then called +\fBwordexp()\fR without \fBWRDE_REUSE\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_SHOWERR\fR\fR +.ad +.RS 16n +.rt +Do not redirect \fBstderr\fR to \fB/dev/null\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_UNDEF\fR\fR +.ad +.RS 16n +.rt +Report error on an attempt to expand an undefined shell variable. +.RE + +.sp +.LP +The following constants are defined as error return values: +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_BADCHAR\fR\fR +.ad +.RS 16n +.rt +One of the unquoted +characters\(em<newline>, '|', '&', ';', '<', '>', '(', ')', '{', '}'\(emappears in words in an inappropriate context. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_BADVAL\fR\fR +.ad +.RS 16n +.rt +Reference to undefined shell variable when \fBWRDE_UNDEF\fR is set in +\fIflags\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_CMDSUB\fR\fR +.ad +.RS 16n +.rt +Command substitution requested when \fBWRDE_NOCMD\fR was set in \fIflags\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_NOSPACE\fR\fR +.ad +.RS 16n +.rt +Attempt to allocate memory failed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_NOSYS\fR\fR +.ad +.RS 16n +.rt +Reserved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWRDE_SYNTAX\fR\fR +.ad +.RS 16n +.rt +Shell syntax error, such as unbalanced parentheses or unterminated string. +.RE + +.sp +.LP +The <\fBwordexp.h\fR> header defines the following type: +.sp +.ne 2 +.mk +.na +\fB\fBsize_t\fR\fR +.ad +.RS 10n +.rt +As described in <\fBstddef.h\fR>. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBwordexp\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) |