Linux Standard Base Specification 2.0

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

Portions of the text are copyrighted by the following parties:

  • The Regents of the University of California

  • Free Software Foundation

  • Ian F. Darwin

  • Paul Vixie

  • BSDI (now Wind River)

  • Andrew G Morgan

  • Jean-loup Gailly and Mark Adler

  • Massachusetts Institute of Technology

These excerpts are being used in accordance with their respective licenses.

Linux is a trademark of Linus Torvalds.

UNIX a registered trademark of the Open Group in the United States and other countries.

LSB is a trademark of the Free Standards Group in the USA and other countries.

AMD is a trademark of Advanced Micro Devices, Inc.

Intel and Itanium are registered trademarks and Intel386 is a trademarks of Intel Corporation.

OpenGL is a registered trademark of Silicon Graphics, Inc.


Table of Contents
Foreword
Introduction
I. Introductory Elements
1. Scope
General
Module Specific Scope
2. Normative References
3. Requirements
Relevant Libraries
LSB Implementation Conformance
LSB Application Conformance
4. Definitions
5. Terminology
II. Base Libraries
6. Libraries
Program Interpreter
Interfaces for libc
Data Definitions for libc
Interface Definitions for libc
Interfaces for libm
Data Definitions for libm
Interfaces for libpthread
Data Definitions for libpthread
Interface Definitions for libpthread
Interfaces for libgcc_s
Data Definitions for libgcc_s
Interfaces for libdl
Data Definitions for libdl
Interface Definitions for libdl
Interfaces for libcrypt
Interfaces for libpam
Data Definitions for libpam
Interface Definitions for libpam
III. Utility Libraries
7. Libraries
Interfaces for libz
Data Definitions for libz
Interfaces for libncurses
Data Definitions for libncurses
Interfaces for libutil
Interface Definitions for libutil
IV. Commands and Utilities
8. Commands and Utilities
Commands and Utilities
Command Behavior
V. Execution Environment
9. File System Hierarchy
/dev
10. Additional Recommendations
Minimal granted Directory and File permissions
Recommendations for applications on ownership and permissions
11. Additional Behaviors
Mandatory Optional Behaviors
12. Localization
Regular Expressions
Filename Globbing
VI. System Initialization
13. System Initialization
Cron Jobs
Init Script Actions
Comment Conventions for Init Scripts
Installation and Removal of init.d Files
Run Levels
Facility Names
Script Names
Init Script Functions
VII. Users & Groups
14. Users & Groups
User and Group Database
User & Group Names
UID Ranges
Rationale
List of Tables
2-1. Normative References
3-1. Standard Library Names
3-2. Standard Library Names defined in the Architecture Specific Supplement
6-1. libc Definition
6-2. libc - RPC Function Interfaces
6-3. libc - System Calls Function Interfaces
6-4. libc - Standard I/O Function Interfaces
6-5. libc - Standard I/O Data Interfaces
6-6. libc - Signal Handling Function Interfaces
6-7. libc - Signal Handling Data Interfaces
6-8. libc - Localization Functions Function Interfaces
6-9. libc - Localization Functions Data Interfaces
6-10. libc - Socket Interface Function Interfaces
6-11. libc - Socket Interface Deprecated Function Interfaces
6-12. libc - Wide Characters Function Interfaces
6-13. libc - String Functions Function Interfaces
6-14. libc - IPC Functions Function Interfaces
6-15. libc - Regular Expressions Function Interfaces
6-16. libc - Regular Expressions Deprecated Function Interfaces
6-17. libc - Regular Expressions Deprecated Data Interfaces
6-18. libc - Character Type Functions Function Interfaces
6-19. libc - Time Manipulation Function Interfaces
6-20. libc - Time Manipulation Deprecated Function Interfaces
6-21. libc - Time Manipulation Data Interfaces
6-22. libc - Terminal Interface Functions Function Interfaces
6-23. libc - System Database Interface Function Interfaces
6-24. libc - Language Support Function Interfaces
6-25. libc - Large File Support Function Interfaces
6-26. libc - Standard Library Function Interfaces
6-27. libc - Standard Library Data Interfaces
6-28. libm Definition
6-29. libm - Math Function Interfaces
6-30. libm - Math Data Interfaces
6-31. libpthread Definition
6-32. libpthread - Posix Threads Function Interfaces
6-33. libgcc_s Definition
6-34. libdl Definition
6-35. libdl - Dynamic Loader Function Interfaces
6-36. libcrypt Definition
6-37. libcrypt - Encryption Function Interfaces
6-38. libpam Definition
6-39. libpam - Pluggable Authentication API Function Interfaces
7-1. libz Definition
7-2. libz - Compression Library Function Interfaces
7-3. libncurses Definition
7-4. libncurses - Curses Function Interfaces
7-5. libncurses - Curses Data Interfaces
7-6. libutil Definition
7-7. libutil - Utility Functions Function Interfaces
8-1. Commands and Utilities
14-1. Required User & Group Names
14-2. Optional User & Group Names

Foreword

This is version 2.0 of the Linux Standard Base Specification. An implementation of this version of the specification may not claim to be an implementation of the Linux Standard Base unless it has successfully completed the compliance process as defined by the Free Standards Group.


Introduction

The LSB defines a binary interface for application programs that are compiled and packaged for LSB-conforming implementations on many different hardware architectures. Since a binary specification shall include information specific to the computer processor architecture for which it is intended, it is not possible for a single document to specify the interface for all possible LSB-conforming implementations. Therefore, the LSB is a family of specifications, rather than a single one.

This document should be used in conjunction with the documents it references. This document enumerates the system components it includes, but descriptions of those components may be included entirely or partly in this document, partly in other documents, or entirely in other reference documents. For example, the section that describes system service routines includes a list of the system routines supported in this interface, formal declarations of the data structures they use that are visible to applications, and a pointer to the underlying referenced specification for information about the syntax and semantics of each call. Only those routines not described in standards referenced by this document, or extensions to those standards, are described in the detail. Information referenced in this way is as much a part of this document as is the information explicitly included here.

I. Introductory Elements


Chapter 1. Scope

General

The Linux Standard Base (LSB) defines a system interface for compiled applications and a minimal environment for support of installation scripts. Its purpose is to enable a uniform industry standard environment for high-volume applications conforming to the LSB.

These specifications are composed of two basic parts: A common specification ("LSB-generic") describing those parts of the interface that remain constant across all implementations of the LSB, and an architecture-specific specification ("LSB-arch") describing the parts of the interface that vary by processor architecture. Together, the LSB-generic and the architecture-specific supplement for a single hardware architecture provide a complete interface specification for compiled application programs on systems that share a common hardware architecture.

The LSB-generic document shall be used in conjunction with an architecture-specific supplement. Whenever a section of the LSB-generic specification shall be supplemented by architecture-specific information, the LSB-generic document includes a reference to the architecture supplement. Architecture supplements may also contain additional information that is not referenced in the LSB-generic document.

The LSB contains both a set of Application Program Interfaces (APIs) and Application Binary Interfaces (ABIs). APIs may appear in the source code of portable applications, while the compiled binary of that application may use the larger set of ABIs. A conforming implementation shall provide all of the ABIs listed here. The compilation system may replace (e.g. by macro definition) certain APIs with calls to one or more of the underlying binary interfaces, and may insert calls to binary interfaces as needed.

The LSB is primarily a binary interface definition. Not all of the source level APIs available to applications may be contained in this specification.


Module Specific Scope

This is the Core module of the Linux Standards Base (LSB). This module provides the fundemental system interfaces, libraries, and runtime environment upon which all conforming applications and libraries depend.

Interfaces described in this module are mandatory except where explicitly listed otherwise. Core interfaces may be supplemented by other modules; all modules are built upon the core.


Chapter 2. Normative References

The specifications listed below are referenced in whole or in part by the Linux Standard Base. In this specification, where only a particular section of one of these references is identified, then the normative reference is to that section alone, and the rest of the referenced document is informative.

Table 2-1. Normative References

System V Application Binary Interface - DRAFT - 17 December 2003http://www.caldera.com/developers/gabi/2003-12-17/contents.html
DWARF Debugging Information Format, Revision 2.0.0 (July 27, 1993)http://www.eagercon.com/dwarf/dwarf-2.0.0.pdf
Filesystem Hierarchy Standard (FHS) 2.3http://www.pathname.com/fhs/
IEEE Standard 754 for Binary Floating-Point Arithmetichttp://www.ieee.org/
System V Application Binary Interface, Edition 4.1http://www.caldera.com/developers/devspecs/gabi41.pdf
ISO/IEC 9899: 1999, Programming Languages --C
Linux Assigned Names And Numbers Authorityhttp://www.lanana.org/
Large File Supporthttp://www.UNIX-systems.org/version2/whatsnew/lfs20mar.html
LI18NUX 2000 Globalization Specification, Version 1.0 with Amendment 4http://www.li18nux.org/docs/html/LI18NUX-2000-amd4.htm
Linux Standard Basehttp://www.linuxbase.org/spec/
OSF-RFC 86.0http://www.opengroup.org/tech/rfc/mirror-rfc/rfc86.0.txt
RFC 1833: Binding Protocols for ONC RPC Version 2http://www.ietf.org/rfc/rfc1833.txt
RFC 1952: GZIP file format specification version 4.3http://www.ietf.org/rfc/rfc1952.txt
RFC 2440: OpenPGP Message Formathttp://www.ietf.org/rfc/rfc2440.txt
CAE Specification, May 1996, X/Open Curses, Issue 4, Version 2 (ISBN: 1-85912-171-3, C610), plus Corrigendum U018http://www.opengroup.org/publications/catalog/un.htm
The Single UNIX® Specification(SUS) Version 2, Commands and Utilities (XCU), Issue 5 (ISBN: 1-85912-191-8, C604)http://www.opengroup.org/publications/catalog/un.htm
CAE Specification, January 1997, System Interfaces and Headers (XSH),Issue 5 (ISBN: 1-85912-181-0, C606)http://www.opengroup.org/publications/catalog/un.htm
ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3http://www.unix.org/version3/
System V Interface Definition, Issue 3 (ISBN 0201566524)
System V Interface Definition,Fourth Edition
zlib 1.2 Manualhttp://www.gzip.org/zlib/

Chapter 3. Requirements

Relevant Libraries

The libraries listed in Table 3-1 shall be available on a Linux Standard Base system, with the specified runtime names. The libraries listed in Table 3-2 are architecture specific, but shall be available on all LSB conforming systems. This list may be supplemented or amended by the architecture-specific specification.

Table 3-1. Standard Library Names

LibraryRuntime Name
libdllibdl.so.2
libcryptlibcrypt.so.1
libzlibz.so.1
libncurseslibncurses.so.5
libutillibutil.so.1
libpthreadlibpthread.so.0
libpamlibpam.so.0
libgcc_slibgcc_s.so.1

Table 3-2. Standard Library Names defined in the Architecture Specific Supplement

LibraryRuntime Name
libmSee archLSB
libcSee archLSB
proginterpSee archLSB

These libraries will be in an implementation-defined directory which the dynamic linker shall search by default.


LSB Implementation Conformance

An implementation shall satisfy the following requirements:

  • The implementation shall implement fully the architecture described in the hardware manual for the target processor architecture.

  • The implementation shall be capable of executing compiled applications having the format and using the system interfaces described in this document.

  • The implementation shall provide libraries containing the interfaces specified by this document, and shall provide a dynamic linking mechanism that allows these interfaces to be attached to applications at runtime. All the interfaces shall behave as specified in this document.

  • The map of virtual memory provided by the implementation shall conform to the requirements of this document.

  • The implementation's low-level behavior with respect to function call linkage, system traps, signals, and other such activities shall conform to the formats described in this document.

  • The implementation shall provide all of the mandatory interfaces in their entirety.

  • The implementation may provide one or more of the optional interfaces. Each optional interface that is provided shall be provided in its entirety. The product documentation shall state which optional interfaces are provided.

  • The implementation shall provide all files and utilities specified as part of this document in the format defined here and in other referenced documents. All commands and utilities shall behave as required by this document. The implementation shall also provide all mandatory components of an application's runtime environment that are included or referenced in this document.

  • The implementation, when provided with standard data formats and values at a named interface, shall provide the behavior defined for those values and data formats at that interface. However, a conforming implementation may consist of components which are separately packaged and/or sold. For example, a vendor of a conforming implementation might sell the hardware, operating system, and windowing system as separately packaged items.

  • The implementation may provide additional interfaces with different names. It may also provide additional behavior corresponding to data values outside the standard ranges, for standard named interfaces.


LSB Application Conformance

An application shall satisfy the following requirements:

  • Its executable files are either shell scripts or object files in the format defined for the Object File Format system interface.

  • Its object files participate in dynamic linking as defined in the Program Loading and Linking System interface.

  • It employs only the instructions, traps, and other low-level facilities defined in the Low-Level System interface as being for use by applications.

  • If it requires any optional interface defined in this document in order to be installed or to execute successfully, the requirement for that optional interface is stated in the application's documentation.

  • It does not use any interface or data format that is not required to be provided by a conforming implementation, unless:

    • If such an interface or data format is supplied by another application through direct invocation of that application during execution, that application is in turn an LSB conforming application.

    • The use of that interface or data format, as well as its source, is identified in the documentation of the application.

  • It shall not use any values for a named interface that are reserved for vendor extensions.

A strictly conforming application does not require or use any interface, facility, or implementation-defined extension that is not defined in this document in order to be installed or to execute successfully.


Chapter 4. Definitions

For the purposes of this document, the following definitions, as specified in the ISO/IEC Directives, Part 2, 2001, 4th Edition, apply:

can

be able to; there is a possibility of; it is possible to

cannot

be unable to; there is no possibilty of; it is not possible to

may

is permitted; is allowed; is permissible

need not

it is not required that; no...is required

shall

is to; is required to; it is required that; has to; only...is permitted; it is necessary

shall not

is not allowed [permitted] [acceptable] [permissible]; is required to be not; is required that...be not; is not to be

should

it is recommended that; ought to

should not

it is not recommended that; ought not to


Chapter 5. Terminology

For the purposes of this document, the following terms apply:

archLSB

The architectural part of the LSB Specification which describes the specific parts of the interface that are platform specific. The archLSB is complementary to the gLSB.

Binary Standard

The total set of interfaces that are available to be used in the compiled binary code of a conforming application.

gLSB

The common part of the LSB Specification that describes those parts of the interface that remain constant across all hardware implementations of the LSB.

implementation-defined

Describes a value or behavior that is not defined by this document but is selected by an implementor. The value or behavior may vary among implementations that conform to this document. An application should not rely on the existence of the value or behavior. An application that relies on such a value or behavior cannot be assured to be portable across conforming implementations. The implementor shall document such a value or behavior so that it can be used correctly by an application.

Shell Script

A file that is read by an interpreter (e.g., awk). The first line of the shell script includes a reference to its interpreter binary.

Source Standard

The set of interfaces that are available to be used in the source code of a conforming application.

undefined

Describes the nature of a value or behavior not defined by this document which results from use of an invalid program construct or invalid data input. The value or behavior may vary among implementations that conform to this document. An application should not rely on the existence or validity of the value or behavior. An application that relies on any particular value or behavior cannot be assured to be portable across conforming implementations.

unspecified

Describes the nature of a value or behavior not specified by this document which results from use of a valid program construct or valid data input. The value or behavior may vary among implementations that conform to this document. An application should not rely on the existence or validity of the value or behavior. An application that relies on any particular value or behavior cannot be assured to be portable across conforming implementations.

II. Base Libraries

Table of Contents
6. Libraries

Chapter 6. Libraries

An LSB-conforming implementation shall support some base libraries which provide interfaces for accessing the operating system, processor and other hardware in the system.


Program Interpreter

The Program Interpreter is specified in the appropriate architecture-specific LSB specification.


Interfaces for libc

Table 6-1 defines the library name and shared object name for the libc library

Table 6-1. libc Definition

Library:libc
SONAME:See archLSB.

The behavior of the interfaces in this library is specified by the following specifications:

Large File Support
Linux Standard Base
CAE Specification, January 1997, System Interfaces and Headers (XSH),Issue 5 (ISBN: 1-85912-181-0, C606)
ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3
System V Interface Definition, Issue 3 (ISBN 0201566524)
System V Interface Definition,Fourth Edition


RPC


Interfaces for RPC

An LSB conforming implementation shall provide the generic functions for RPC specified in Table 6-2, with the full functionality as described in the referenced underlying specification.

Table 6-2. libc - RPC Function Interfaces

authnone_create [1]pmap_unset [2]svcerr_weakauth [3]xdr_float [3]xdr_u_char [3]
clnt_create [1]setdomainname [2]svctcp_create [2]xdr_free [3]xdr_u_int [2]
clnt_pcreateerror [1]svc_getreqset [3]svcudp_create [2]xdr_int [3]xdr_u_long [3]
clnt_perrno [1]svc_register [2]xdr_accepted_reply [3]xdr_long [3]xdr_u_short [3]
clnt_perror [1]svc_run [2]xdr_array [3]xdr_opaque [3]xdr_union [3]
clnt_spcreateerror [1]svc_sendreply [2]xdr_bool [3]xdr_opaque_auth [3]xdr_vector [3]
clnt_sperrno [1]svcerr_auth [3]xdr_bytes [3]xdr_pointer [3]xdr_void [3]
clnt_sperror [1]svcerr_decode [3]xdr_callhdr [3]xdr_reference [3]xdr_wrapstring [3]
getdomainname [2]svcerr_noproc [3]xdr_callmsg [3]xdr_rejected_reply [3]xdrmem_create [3]
key_decryptsession [3]svcerr_noprog [3]xdr_char [3]xdr_replymsg [3]xdrrec_create [3]
pmap_getport [2]svcerr_progvers [3]xdr_double [3]xdr_short [3]xdrrec_eof [3]
pmap_set [2]svcerr_systemerr [3]xdr_enum [3]xdr_string [3] 

Referenced Specification(s)


System Calls


Interfaces for System Calls

An LSB conforming implementation shall provide the generic functions for System Calls specified in Table 6-3, with the full functionality as described in the referenced underlying specification.

Table 6-3. libc - System Calls Function Interfaces

__fxstat [1]fchmod [2]getwd [2]read [2]setrlimit [2]
__getpgid [1]fchown [2]initgroups [1]readdir [2]setrlimit64 [3]
__lxstat [1]fcntl [1]ioctl [1]readdir_r [2]setsid [2]
__xmknod [1]fdatasync [2]kill [1]readlink [2]setuid [2]
__xstat [1]flock [1]killpg [2]readv [2]sleep [2]
access [2]fork [2]lchown [2]rename [2]statvfs [2]
acct [1]fstatvfs [2]link [2]rmdir [2]stime [1]
alarm [2]fsync [2]lockf [2]sbrk [4]symlink [2]
brk [4]ftime [2]lseek [2]sched_get_priority_max [2]sync [2]
chdir [2]ftruncate [2]mkdir [2]sched_get_priority_min [2]sysconf [2]
chmod [2]getcontext [2]mkfifo [2]sched_getparam [2]time [2]
chown [2]getegid [2]mlock [2]sched_getscheduler [2]times [2]
chroot [4]geteuid [2]mlockall [2]sched_rr_get_interval [2]truncate [2]
clock [2]getgid [2]mmap [2]sched_setparam [2]ulimit [2]
close [2]getgroups [2]mprotect [2]sched_setscheduler [2]umask [2]
closedir [2]getitimer [2]msync [2]sched_yield [2]uname [2]
creat [1]getloadavg [1]munlock [2]select [2]unlink [1]
dup [2]getpagesize [4]munlockall [2]setcontext [2]utime [2]
dup2 [2]getpgid [2]munmap [2]setegid [2]utimes [2]
execl [2]getpgrp [2]nanosleep [2]seteuid [2]vfork [2]
execle [2]getpid [2]nice [2]setgid [2]wait [2]
execlp [2]getppid [2]open [1]setitimer [2]wait3 [1]
execv [2]getpriority [2]opendir [2]setpgid [2]wait4 [1]
execve [2]getrlimit [2]pathconf [2]setpgrp [2]waitpid [1]
execvp [2]getrusage [2]pause [2]setpriority [2]write [2]
exit [2]getsid [2]pipe [2]setregid [2]writev [2]
fchdir [2]getuid [2]poll [2]setreuid [2] 

Referenced Specification(s)


Standard I/O


Interfaces for Standard I/O

An LSB conforming implementation shall provide the generic functions for Standard I/O specified in Table 6-4, with the full functionality as described in the referenced underlying specification.

Table 6-4. libc - Standard I/O Function Interfaces

_IO_feof [1]fgetpos [2]fsetpos [2]putchar [2]sscanf [2]
_IO_getc [1]fgets [2]ftell [2]putchar_unlocked [2]telldir [2]
_IO_putc [1]fgetwc_unlocked [1]ftello [2]puts [2]tempnam [2]
_IO_puts [1]fileno [2]fwrite [2]putw [3]ungetc [2]
asprintf [1]flockfile [2]getc [2]remove [2]vasprintf [1]
clearerr [2]fopen [1]getc_unlocked [2]rewind [2]vdprintf [1]
ctermid [2]fprintf [2]getchar [2]rewinddir [2]vfprintf [2]
fclose [2]fputc [2]getchar_unlocked [2]scanf [2]vprintf [2]
fdopen [2]fputs [2]getw [3]seekdir [2]vsnprintf [2]
feof [2]fread [2]pclose [2]setbuf [2]vsprintf [2]
ferror [2]freopen [1]popen [2]setbuffer [1] 
fflush [2]fscanf [2]printf [2]setvbuf [2] 
fflush_unlocked [1]fseek [2]putc [2]snprintf [2] 
fgetc [2]fseeko [2]putc_unlocked [2]sprintf [2] 

Referenced Specification(s)

An LSB conforming implementation shall provide the generic data interfaces for Standard I/O specified in Table 6-5, with the full functionality as described in the referenced underlying specification.

Table 6-5. libc - Standard I/O Data Interfaces

stderr [1]stdin [1]stdout [1]  

Referenced Specification(s)


Signal Handling


Interfaces for Signal Handling

An LSB conforming implementation shall provide the generic functions for Signal Handling specified in Table 6-6, with the full functionality as described in the referenced underlying specification.

Table 6-6. libc - Signal Handling Function Interfaces

__libc_current_sigrtmax [1]sigaddset [2]sighold [2]sigpause [2]sigsuspend [2]
__libc_current_sigrtmin [1]sigaltstack [2]sigignore [2]sigpending [2]sigtimedwait [2]
__sigsetjmp [1]sigandset [1]siginterrupt [2]sigprocmask [2]sigwait [2]
__sysv_signal [1]sigblock [1]sigisemptyset [1]sigqueue [2]sigwaitinfo [2]
bsd_signal [2]sigdelset [2]sigismember [2]sigrelse [2] 
psignal [1]sigemptyset [2]siglongjmp [2]sigreturn [1] 
raise [2]sigfillset [2]signal [2]sigset [2] 
sigaction [2]siggetmask [1]sigorset [1]sigstack [3] 

Referenced Specification(s)

An LSB conforming implementation shall provide the generic data interfaces for Signal Handling specified in Table 6-7, with the full functionality as described in the referenced underlying specification.

Table 6-7. libc - Signal Handling Data Interfaces

_sys_siglist [1]    

Referenced Specification(s)


Localization Functions


Interfaces for Localization Functions

An LSB conforming implementation shall provide the generic functions for Localization Functions specified in Table 6-8, with the full functionality as described in the referenced underlying specification.

Table 6-8. libc - Localization Functions Function Interfaces

bind_textdomain_codeset [1]catopen [2]dngettext [1]iconv_open [2]setlocale [2]
bindtextdomain [1]dcgettext [1]gettext [1]localeconv [2]textdomain [1]
catclose [2]dcngettext [1]iconv [2]ngettext [1] 
catgets [2]dgettext [1]iconv_close [2]nl_langinfo [2] 

Referenced Specification(s)

An LSB conforming implementation shall provide the generic data interfaces for Localization Functions specified in Table 6-9, with the full functionality as described in the referenced underlying specification.

Table 6-9. libc - Localization Functions Data Interfaces

_nl_msg_cat_cntr [1]    

Referenced Specification(s)


Socket Interface


Interfaces for Socket Interface

An LSB conforming implementation shall provide the generic functions for Socket Interface specified in Table 6-10, with the full functionality as described in the referenced underlying specification.

Table 6-10. libc - Socket Interface Function Interfaces

__h_errno_location [1]gethostid [2]listen [2]sendmsg [2]socketpair [2]
accept [2]gethostname [2]recv [2]sendto [2] 
bind [2]getpeername [2]recvfrom [2]setsockopt [1] 
bindresvport [1]getsockname [2]recvmsg [2]shutdown [2] 
connect [2]getsockopt [2]send [2]socket [2] 

Referenced Specification(s)

An LSB conforming implementation shall provide the generic deprecated functions for Socket Interface specified in Table 6-11, with the full functionality as described in the referenced underlying specification.

Note

These interfaces are deprecated, and applications should avoid using them. These interfaces may be withdrawn in future releases of this specification.

Table 6-11. libc - Socket Interface Deprecated Function Interfaces

gethostbyname_r [1]    

Referenced Specification(s)


Wide Characters


Interfaces for Wide Characters

An LSB conforming implementation shall provide the generic functions for Wide Characters specified in Table 6-12, with the full functionality as described in the referenced underlying specification.

Table 6-12. libc - Wide Characters Function Interfaces

__wcstod_internal [1]mbsinit [2]vwscanf [2]wcsnlen [1]wcstoumax [2]
__wcstof_internal [1]mbsnrtowcs [1]wcpcpy [1]wcsnrtombs [1]wcstouq [1]
__wcstol_internal [1]mbsrtowcs [2]wcpncpy [1]wcspbrk [2]wcswcs [2]
__wcstold_internal [1]mbstowcs [2]wcrtomb [2]wcsrchr [2]wcswidth [2]
__wcstoul_internal [1]mbtowc [2]wcscasecmp [1]wcsrtombs [2]wcsxfrm [2]
btowc [2]putwc [2]wcscat [2]wcsspn [2]wctob [2]
fgetwc [2]putwchar [2]wcschr [2]wcsstr [2]wctomb [2]
fgetws [2]swprintf [2]wcscmp [2]wcstod [2]wctrans [2]
fputwc [2]swscanf [2]wcscoll [2]wcstof [2]wctype [2]
fputws [2]towctrans [2]wcscpy [2]wcstoimax [2]wcwidth [2]
fwide [2]towlower [2]wcscspn [2]wcstok [2]wmemchr [2]
fwprintf [2]towupper [2]wcsdup [1]wcstol [2]wmemcmp [2]
fwscanf [2]ungetwc [2]wcsftime [2]wcstold [2]wmemcpy [2]
getwc [2]vfwprintf [2]wcslen [2]wcstoll [2]wmemmove [2]
getwchar [2]vfwscanf [2]wcsncasecmp [1]wcstombs [2]wmemset [2]
mblen [2]vswprintf [2]wcsncat [2]wcstoq [1]wprintf [2]
mbrlen [2]vswscanf [2]wcsncmp [2]wcstoul [2]wscanf [2]
mbrtowc [2]vwprintf [2]wcsncpy [2]wcstoull [2] 

Referenced Specification(s)


String Functions


Interfaces for String Functions

An LSB conforming implementation shall provide the generic functions for String Functions specified in Table 6-13, with the full functionality as described in the referenced underlying specification.

Table 6-13. libc - String Functions Function Interfaces

__mempcpy [1]bzero [2]strcasestr [1]strncasecmp [2]strtoimax [2]
__rawmemchr [1]ffs [2]strcat [2]strncat [2]strtok [2]
__stpcpy [1]index [2]strchr [2]strncmp [2]strtok_r [1]
__strdup [1]memccpy [2]strcmp [2]strncpy [2]strtold [2]
__strtod_internal [1]memchr [2]strcoll [2]strndup [1]strtoll [2]
__strtof_internal [1]memcmp [2]strcpy [2]strnlen [1]strtoq [1]
__strtok_r [1]memcpy [2]strcspn [2]strpbrk [2]strtoull [2]
__strtol_internal [1]memmove [2]strdup [2]strptime [1]strtoumax [2]
__strtold_internal [1]memrchr [1]strerror [2]strrchr [2]strtouq [1]
__strtoll_internal [1]memset [2]strerror_r [1]strsep [1]strverscmp [1]
__strtoul_internal [1]rindex [2]strfmon [2]strsignal [1]strxfrm [2]
__strtoull_internal [1]stpcpy [1]strfry [1]strspn [2]swab [2]
bcmp [2]stpncpy [1]strftime [2]strstr [2] 
bcopy [2]strcasecmp [2]strlen [2]strtof [2] 

Referenced Specification(s)


IPC Functions


Interfaces for IPC Functions

An LSB conforming implementation shall provide the generic functions for IPC Functions specified in Table 6-14, with the full functionality as described in the referenced underlying specification.

Table 6-14. libc - IPC Functions Function Interfaces

ftok [1]msgrcv [1]semget [1]shmctl [1] 
msgctl [1]msgsnd [1]semop [1]shmdt [1] 
msgget [1]semctl [1]shmat [1]shmget [1] 

Referenced Specification(s)


Regular Expressions


Interfaces for Regular Expressions

An LSB conforming implementation shall provide the generic functions for Regular Expressions specified in Table 6-15, with the full functionality as described in the referenced underlying specification.

Table 6-15. libc - Regular Expressions Function Interfaces

regcomp [1]regerror [1]regexec [1]regfree [1] 

Referenced Specification(s)

An LSB conforming implementation shall provide the generic deprecated functions for Regular Expressions specified in Table 6-16, with the full functionality as described in the referenced underlying specification.

Note

These interfaces are deprecated, and applications should avoid using them. These interfaces may be withdrawn in future releases of this specification.

Table 6-16. libc - Regular Expressions Deprecated Function Interfaces

advance [1]re_comp [1]re_exec [1]step [1] 

Referenced Specification(s)

An LSB conforming implementation shall provide the generic deprecated data interfaces for Regular Expressions specified in Table 6-17, with the full functionality as described in the referenced underlying specification.

Note

These interfaces are deprecated, and applications should avoid using them. These interfaces may be withdrawn in future releases of this specification.

Table 6-17. libc - Regular Expressions Deprecated Data Interfaces

loc1 [1]loc2 [1]locs [1]  

Referenced Specification(s)


Character Type Functions


Interfaces for Character Type Functions

An LSB conforming implementation shall provide the generic functions for Character Type Functions specified in Table 6-18, with the full functionality as described in the referenced underlying specification.

Table 6-18. libc - Character Type Functions Function Interfaces

__ctype_b_loc(GLIBC_2.3) [1]isalpha [2]ispunct [2]iswctype [1]iswupper [2]
__ctype_get_mb_cur_max [1]isascii [2]isspace [2]iswdigit [2]iswxdigit [2]
__ctype_tolower_loc(GLIBC_2.3) [1]iscntrl [2]isupper [2]iswgraph [2]isxdigit [2]
__ctype_toupper_loc(GLIBC_2.3) [1]isdigit [2]iswalnum [2]iswlower [2]toascii [2]
_tolower [2]isgraph [2]iswalpha [2]iswprint [2]tolower [2]
_toupper [2]islower [2]iswblank [2]iswpunct [2]toupper [2]
isalnum [2]isprint [2]iswcntrl [2]iswspace [2] 

Referenced Specification(s)


Time Manipulation


Interfaces for Time Manipulation

An LSB conforming implementation shall provide the generic functions for Time Manipulation specified in Table 6-19, with the full functionality as described in the referenced underlying specification.

Table 6-19. libc - Time Manipulation Function Interfaces

adjtime [1]ctime [2]gmtime [2]localtime_r [2]ualarm [2]
asctime [2]ctime_r [2]gmtime_r [2]mktime [2] 
asctime_r [2]difftime [2]localtime [2]tzset [2] 

Referenced Specification(s)

An LSB conforming implementation shall provide the generic deprecated functions for Time Manipulation specified in Table 6-20, with the full functionality as described in the referenced underlying specification.

Note

These interfaces are deprecated, and applications should avoid using them. These interfaces may be withdrawn in future releases of this specification.

Table 6-20. libc - Time Manipulation Deprecated Function Interfaces

adjtimex [1]    

Referenced Specification(s)

An LSB conforming implementation shall provide the generic data interfaces for Time Manipulation specified in Table 6-21, with the full functionality as described in the referenced underlying specification.

Table 6-21. libc - Time Manipulation Data Interfaces

__daylight [1]__tzname [1]timezone [2]  
__timezone [1]daylight [2]tzname [2]  

Referenced Specification(s)


Terminal Interface Functions


Interfaces for Terminal Interface Functions

An LSB conforming implementation shall provide the generic functions for Terminal Interface Functions specified in Table 6-22, with the full functionality as described in the referenced underlying specification.

Table 6-22. libc - Terminal Interface Functions Function Interfaces

cfgetispeed [1]cfsetispeed [1]tcdrain [1]tcgetattr [1]tcsendbreak [1]
cfgetospeed [1]cfsetospeed [1]tcflow [1]tcgetpgrp [1]tcsetattr [1]
cfmakeraw [2]cfsetspeed [2]tcflush [1]tcgetsid [1]tcsetpgrp [1]

Referenced Specification(s)


System Database Interface


Interfaces for System Database Interface

An LSB conforming implementation shall provide the generic functions for System Database Interface specified in Table 6-23, with the full functionality as described in the referenced underlying specification.

Table 6-23. libc - System Database Interface Function Interfaces

endgrent [1]getgrgid [1]getprotobynumber [1]getservbyport [1]setgrent [1]
endnetent [1]getgrgid_r [1]getprotoent [1]getservent [1]setgroups [2]
endprotoent [1]getgrnam [1]getpwent [1]getutent [2]setnetent [1]
endpwent [1]getgrnam_r [1]getpwnam [1]getutent_r [2]setprotoent [1]
endservent [1]gethostbyaddr [1]getpwnam_r [1]getutxent [1]setpwent [1]
endutent [3]gethostbyname [1]getpwuid [1]getutxid [1]setservent [1]
endutxent [1]getnetbyaddr [1]getpwuid_r [1]getutxline [1]setutent [2]
getgrent [1]getprotobyname [1]getservbyname [1]pututxline [1]setutxent [1]

Referenced Specification(s)


Language Support


Interfaces for Language Support

An LSB conforming implementation shall provide the generic functions for Language Support specified in Table 6-24, with the full functionality as described in the referenced underlying specification.

Table 6-24. libc - Language Support Function Interfaces

__libc_start_main [1]__register_atfork(GLIBC_2.3.2) [1]_obstack_begin [1]_obstack_newchunk [1]obstack_free [1]

Referenced Specification(s)


Large File Support


Interfaces for Large File Support

An LSB conforming implementation shall provide the generic functions for Large File Support specified in Table 6-25, with the full functionality as described in the referenced underlying specification.

Table 6-25. libc - Large File Support Function Interfaces

__fxstat64 [1]fopen64 [2]ftello64 [2]lseek64 [2]readdir64 [2]
__lxstat64 [1]freopen64 [2]ftruncate64 [2]mkstemp64 [2]statvfs64 [2]
__xstat64 [1]fseeko64 [2]ftw64 [2]mmap64 [2]tmpfile64 [2]
creat64 [2]fsetpos64 [2]getrlimit64 [2]nftw64 [2]truncate64 [2]
fgetpos64 [2]fstatvfs64 [2]lockf64 [2]open64 [2] 

Referenced Specification(s)


Standard Library


Interfaces for Standard Library

An LSB conforming implementation shall provide the generic functions for Standard Library specified in Table 6-26, with the full functionality as described in the referenced underlying specification.

Table 6-26. libc - Standard Library Function Interfaces

_Exit [1]dirname [1]glob [1]lsearch [1]srand [1]
__assert_fail [2]div [1]glob64 [2]makecontext [1]srand48 [1]
__cxa_atexit [2]drand48 [1]globfree [1]malloc [1]srandom [1]
__errno_location [2]ecvt [1]globfree64 [2]memmem [2]strtod [1]
__fpending [2]erand48 [1]grantpt [1]mkstemp [1]strtol [1]
__getpagesize [2]err [2]hcreate [1]mktemp [1]strtoul [1]
__isinf [2]error [2]hdestroy [1]mrand48 [1]swapcontext [1]
__isinff [2]errx [2]hsearch [1]nftw [1]syslog [1]
__isinfl [2]fcvt [1]htonl [1]nrand48 [1]system [2]
__isnan [2]fmtmsg [1]htons [1]ntohl [1]tdelete [1]
__isnanf [2]fnmatch [1]imaxabs [1]ntohs [1]tfind [1]
__isnanl [2]fpathconf [1]imaxdiv [1]openlog [1]tmpfile [1]
__sysconf [2]free [1]inet_addr [1]perror [1]tmpnam [1]
_exit [1]freeaddrinfo [1]inet_ntoa [1]posix_memalign [1]tsearch [1]
_longjmp [1]ftrylockfile [1]inet_ntop [1]ptsname [1]ttyname [1]
_setjmp [1]ftw [1]inet_pton [1]putenv [1]ttyname_r [1]
a64l [1]funlockfile [1]initstate [1]qsort [1]twalk [1]
abort [1]gai_strerror [1]insque [1]rand [1]unlockpt [1]
abs [1]gcvt [1]isatty [1]rand_r [1]unsetenv [1]
atof [1]getaddrinfo [1]isblank [1]random [1]usleep [1]
atoi [1]getcwd [1]jrand48 [1]random_r [2]verrx [2]
atol [1]getdate [1]l64a [1]realloc [1]vfscanf [1]
atoll [1]getenv [1]labs [1]realpath [1]vscanf [1]
basename [1]getlogin [1]lcong48 [1]remque [1]vsscanf [1]
bsearch [1]getnameinfo [1]ldiv [1]seed48 [1]vsyslog [2]
calloc [1]getopt [2]lfind [1]setenv [1]warn [2]
closelog [1]getopt_long [2]llabs [1]sethostid [2]warnx [2]
confstr [1]getopt_long_only [2]lldiv [1]sethostname [2]wordexp [1]
cuserid [3]getsubopt [1]longjmp [1]setlogmask [1]wordfree [1]
daemon [2]gettimeofday [1]lrand48 [1]setstate [1] 

Referenced Specification(s)

An LSB conforming implementation shall provide the generic data interfaces for Standard Library specified in Table 6-27, with the full functionality as described in the referenced underlying specification.

Table 6-27. libc - Standard Library Data Interfaces

__environ [1]_sys_errlist [1]getdate_err [2]opterr [1]optopt [1]
_environ [1]environ [2]optarg [2]optind [1] 

Referenced Specification(s)


Data Definitions for libc

This section defines global identifiers and their values that are associated with interfaces contained in libc. These definitions are organized into groups that correspond to system headers. This convention is used as a convenience for the reader, and does not imply the existence of these headers, or their content.

These definitions are intended to supplement those provided in the referenced underlying specifications.

This specification uses ISO/IEC 9899 C Language as the reference programming language, and data definitions are specified in ISO C format. The C language is used here as a convenient notation. Using a C language description of these data objects does not preclude their use by other programming languages.


assert.h

The assert.h header shall define the assert macro. It refers to the macro NDEBUG, which is not defined in this header. If NDEBUG is defined before the inclusion of this header, the assert macro shall be defined as described below, otherwise the macro shall behave as described in assert in ISO/IEC 9945 POSIX.


#define assert(expr)	((void)0)

ctype.h


enum
{
  _ISupper, _ISlower, _ISalpha, _ISdigit, _ISxdigit, _ISspace, _ISprint,
    _ISgraph, _ISblank, _IScntrl, _ISpunct, _ISalnum
}
 ;

dirent.h


typedef struct __dirstream DIR;

struct dirent
{
  long d_ino;
  off_t d_off;
  unsigned short d_reclen;
  unsigned char d_type;
  char d_name[256];
}
 ;
struct dirent64
{
  uint64_t d_ino;
  int64_t d_off;
  unsigned short d_reclen;
  unsigned char d_type;
  char d_name[256];
}
 ;

errno.h


#define errno	(*__errno_location())

#define EPERM	1
#define ECHILD	10
#define ENETDOWN	100
#define ENETUNREACH	101
#define ENETRESET	102
#define ECONNABORTED	103
#define ECONNRESET	104
#define ENOBUFS	105
#define EISCONN	106
#define ENOTCONN	107
#define ESHUTDOWN	108
#define ETOOMANYREFS	109
#define EAGAIN	11
#define ETIMEDOUT	110
#define ECONNREFUSED	111
#define EHOSTDOWN	112
#define EHOSTUNREACH	113
#define EALREADY	114
#define EINPROGRESS	115
#define ESTALE	116
#define EUCLEAN	117
#define ENOTNAM	118
#define ENAVAIL	119
#define ENOMEM	12
#define EISNAM	120
#define EREMOTEIO	121
#define EDQUOT	122
#define ENOMEDIUM	123
#define EMEDIUMTYPE	124
#define ECANCELED	125
#define EACCES	13
#define EFAULT	14
#define ENOTBLK	15
#define EBUSY	16
#define EEXIST	17
#define EXDEV	18
#define ENODEV	19
#define ENOENT	2
#define ENOTDIR	20
#define EISDIR	21
#define EINVAL	22
#define ENFILE	23
#define EMFILE	24
#define ENOTTY	25
#define ETXTBSY	26
#define EFBIG	27
#define ENOSPC	28
#define ESPIPE	29
#define ESRCH	3
#define EROFS	30
#define EMLINK	31
#define EPIPE	32
#define EDOM	33
#define ERANGE	34
#define EDEADLK	35
#define ENAMETOOLONG	36
#define ENOLCK	37
#define ENOSYS	38
#define ENOTEMPTY	39
#define EINTR	4
#define ELOOP	40
#define ENOMSG	42
#define EIDRM	43
#define ECHRNG	44
#define EL2NSYNC	45
#define EL3HLT	46
#define EL3RST	47
#define ELNRNG	48
#define EUNATCH	49
#define EIO	5
#define ENOANO	55
#define EBADRQC	56
#define EBADSLT	57
#define EBFONT	59
#define ENXIO	6
#define ENOSTR	60
#define ENODATA	61
#define ETIME	62
#define ENOSR	63
#define ENONET	64
#define ENOPKG	65
#define EREMOTE	66
#define ENOLINK	67
#define EADV	68
#define ESRMNT	69
#define E2BIG	7
#define ECOMM	70
#define EPROTO	71
#define EMULTIHOP	72
#define EDOTDOT	73
#define EBADMSG	74
#define EOVERFLOW	75
#define ENOTUNIQ	76
#define EBADFD	77
#define EREMCHG	78
#define ELIBACC	79
#define ENOEXEC	8
#define ELIBBAD	80
#define ELIBSCN	81
#define ELIBMAX	82
#define ELIBEXEC	83
#define EILSEQ	84
#define ERESTART	85
#define ESTRPIPE	86
#define EUSERS	87
#define ENOTSOCK	88
#define EDESTADDRREQ	89
#define EBADF	9
#define EMSGSIZE	90
#define EPROTOTYPE	91
#define ENOPROTOOPT	92
#define EPROTONOSUPPORT	93
#define ESOCKTNOSUPPORT	94
#define EOPNOTSUPP	95
#define EPFNOSUPPORT	96
#define EAFNOSUPPORT	97
#define EADDRINUSE	98
#define EADDRNOTAVAIL	99
#define EWOULDBLOCK	EAGAIN
#define ENOTSUP	EOPNOTSUPP

fcntl.h


#define O_RDONLY	00
#define O_ACCMODE	0003
#define O_WRONLY	01
#define O_CREAT	0100
#define O_TRUNC	01000
#define O_SYNC	010000
#define O_RDWR	02
#define O_EXCL	0200
#define O_APPEND	02000
#define O_ASYNC	020000
#define O_NOCTTY	0400
#define O_NDELAY	04000
#define O_NONBLOCK	04000
#define FD_CLOEXEC	1

struct flock
{
  short l_type;
  short l_whence;
  off_t l_start;
  off_t l_len;
  pid_t l_pid;
}
 ;
struct flock64
{
  short l_type;
  short l_whence;
  loff_t l_start;
  loff_t l_len;
  pid_t l_pid;
}
 ;

#define F_DUPFD	0
#define F_RDLCK	0
#define F_GETFD	1
#define F_WRLCK	1
#define F_SETFD	2
#define F_UNLCK	2
#define F_GETFL	3
#define F_SETFL	4
#define F_GETLK	5
#define F_SETLK	6
#define F_SETLKW	7
#define F_SETOWN	8
#define F_GETOWN	9

fmtmsg.h


#define MM_HARD	1
#define MM_NRECOV	128
#define MM_UTIL	16
#define MM_SOFT	2
#define MM_OPSYS	32
#define MM_FIRM	4
#define MM_RECOVER	64
#define MM_APPL	8

#define MM_NOSEV	0
#define MM_HALT	1
#define MM_ERROR	2

#define MM_NULLLBL	((char *) 0)

fnmatch.h


#define FNM_PATHNAME	(1<<0)
#define FNM_NOESCAPE	(1<<1)
#define FNM_PERIOD	(1<<2)
#define FNM_NOMATCH	1

ftw.h


#define FTW_D	FTW_D
#define FTW_DNR	FTW_DNR
#define FTW_DP	FTW_DP
#define FTW_F	FTW_F
#define FTW_NS	FTW_NS
#define FTW_SL	FTW_SL
#define FTW_SLN	FTW_SLN

enum
{
  FTW_F, FTW_D, FTW_DNR, FTW_NS, FTW_SL, FTW_DP, FTW_SLN
}
 ;

enum
{
  FTW_PHYS, FTW_MOUNT, FTW_CHDIR, FTW_DEPTH
}
 ;

struct FTW
{
  int base;
  int level;
}
 ;

typedef int (*__ftw_func_t) (char *__filename, struct stat * __status,
			     int __flag);
typedef int (*__ftw64_func_t) (char *__filename, struct stat64 * __status,
			       int __flag);
typedef int (*__nftw_func_t) (char *__filename, struct stat * __status,
			      int __flag, struct FTW * __info);
typedef int (*__nftw64_func_t) (char *__filename, struct stat64 * __status,
				int __flag, struct FTW * __info);

getopt.h


#define no_argument	0
#define required_argument	1
#define optional_argument	2

struct option
{
  char *name;
  int has_arg;
  int *flag;
  int val;
}
 ;

glob.h


#define GLOB_ERR	(1<<0)
#define GLOB_MARK	(1<<1)
#define GLOB_BRACE	(1<<10)
#define GLOB_NOMAGIC	(1<<11)
#define GLOB_TILDE	(1<<12)
#define GLOB_ONLYDIR	(1<<13)
#define GLOB_TILDE_CHECK	(1<<14)
#define GLOB_NOSORT	(1<<2)
#define GLOB_DOOFFS	(1<<3)
#define GLOB_NOCHECK	(1<<4)
#define GLOB_APPEND	(1<<5)
#define GLOB_NOESCAPE	(1<<6)
#define GLOB_PERIOD	(1<<7)
#define GLOB_MAGCHAR	(1<<8)
#define GLOB_ALTDIRFUNC	(1<<9)

#define GLOB_NOSPACE	1
#define GLOB_ABORTED	2
#define GLOB_NOMATCH	3
#define GLOB_NOSYS	4

typedef struct
{
  size_t gl_pathc;
  char **gl_pathv;
  size_t gl_offs;
  int gl_flags;
  void (*gl_closedir) (void *);
  struct dirent *(*gl_readdir) (void *);
  void *(*gl_opendir) (const char *);
  int (*gl_lstat) (const char *, struct stat *);
  int (*gl_stat) (const char *, struct stat *);
}
glob_t;

typedef struct
{
  size_t gl_pathc;
  char **gl_pathv;
  size_t gl_offs;
  int gl_flags;
  void (*gl_closedir) (void *);
  struct dirent64 *(*gl_readdir64) (void *);
  void *(*gl_opendir) (const char *);
  int (*gl_lstat) (const char *, struct stat *);
  int (*gl_stat) (const char *, struct stat *);
}
glob64_t;

grp.h


struct group
{
  char *gr_name;
  char *gr_passwd;
  gid_t gr_gid;
  char **gr_mem;
}
 ;

iconv.h


typedef void *iconv_t;

inttypes.h


typedef lldiv_t imaxdiv_t;
typedef unsigned char uint8_t;
typedef unsigned short uint16_t;
typedef unsigned int uint32_t;

langinfo.h


#define ABDAY_1	0x20000
#define ABDAY_2	0x20001
#define ABDAY_3	0x20002
#define ABDAY_4	0x20003
#define ABDAY_5	0x20004
#define ABDAY_6	0x20005
#define ABDAY_7	0x20006

#define DAY_1	0x20007
#define DAY_2	0x20008
#define DAY_3	0x20009
#define DAY_4	0x2000A
#define DAY_5	0x2000B
#define DAY_6	0x2000C
#define DAY_7	0x2000D

#define ABMON_1	0x2000E
#define ABMON_2	0x2000F
#define ABMON_3	0x20010
#define ABMON_4	0x20011
#define ABMON_5	0x20012
#define ABMON_6	0x20013
#define ABMON_7	0x20014
#define ABMON_8	0x20015
#define ABMON_9	0x20016
#define ABMON_10	0x20017
#define ABMON_11	0x20018
#define ABMON_12	0x20019

#define MON_1	0x2001A
#define MON_2	0x2001B
#define MON_3	0x2001C
#define MON_4	0x2001D
#define MON_5	0x2001E
#define MON_6	0x2001F
#define MON_7	0x20020
#define MON_8	0x20021
#define MON_9	0x20022
#define MON_10	0x20023
#define MON_11	0x20024
#define MON_12	0x20025

#define AM_STR	0x20026
#define PM_STR	0x20027

#define D_T_FMT	0x20028
#define D_FMT	0x20029
#define T_FMT	0x2002A
#define T_FMT_AMPM	0x2002B

#define ERA	0x2002C
#define ERA_D_FMT	0x2002E
#define ALT_DIGITS	0x2002F
#define ERA_D_T_FMT	0x20030
#define ERA_T_FMT	0x20031

#define CODESET	14

#define CRNCYSTR	0x4000F

#define RADIXCHAR	0x10000
#define THOUSEP	0x10001
#define YESEXPR	0x50000
#define NOEXPR	0x50001
#define YESSTR	0x50002
#define NOSTR	0x50003

limits.h


#define LLONG_MIN	(-LLONG_MAX-1LL)
#define ULLONG_MAX	18446744073709551615ULL
#define OPEN_MAX	256
#define PATH_MAX	4096
#define LLONG_MAX	9223372036854775807LL
#define SSIZE_MAX	LONG_MAX

#define MB_LEN_MAX	16

#define SCHAR_MIN	(-128)
#define SCHAR_MAX	127
#define UCHAR_MAX	255
#define CHAR_BIT	8

#define SHRT_MIN	(-32768)
#define SHRT_MAX	32767
#define USHRT_MAX	65535

#define INT_MIN	(-INT_MAX-1)
#define INT_MAX	2147483647
#define __INT_MAX__	2147483647
#define UINT_MAX	4294967295U

#define LONG_MIN	(-LONG_MAX-1L)

locale.h


#define LC_CTYPE	0
#define LC_NUMERIC	1
#define LC_TELEPHONE	10
#define LC_MEASUREMENT	11
#define LC_IDENTIFICATION	12
#define LC_TIME	2
#define LC_COLLATE	3
#define LC_MONETARY	4
#define LC_MESSAGES	5
#define LC_ALL	6
#define LC_PAPER	7
#define LC_NAME	8
#define LC_ADDRESS	9

struct lconv
{
  char *decimal_point;
  char *thousands_sep;
  char *grouping;
  char *int_curr_symbol;
  char *currency_symbol;
  char *mon_decimal_point;
  char *mon_thousands_sep;
  char *mon_grouping;
  char *positive_sign;
  char *negative_sign;
  char int_frac_digits;
  char frac_digits;
  char p_cs_precedes;
  char p_sep_by_space;
  char n_cs_precedes;
  char n_sep_by_space;
  char p_sign_posn;
  char n_sign_posn;
  char int_p_cs_precedes;
  char int_p_sep_by_space;
  char int_n_cs_precedes;
  char int_n_sep_by_space;
  char int_p_sign_posn;
  char int_n_sign_posn;
}
 ;

typedef struct __locale_struct
{
  struct locale_data *__locales[13];
  const unsigned short *__ctype_b;
  const int *__ctype_tolower;
  const int *__ctype_toupper;
  const char *__names[13];
}
 *__locale_t;

net/if.h


#define IF_NAMESIZE	16

#define IFF_UP	0x01
#define IFF_BROADCAST	0x02
#define IFF_DEBUG	0x04
#define IFF_LOOPBACK	0x08
#define IFF_POINTOPOINT	0x10
#define IFF_PROMISC	0x100
#define IFF_MULTICAST	0x1000
#define IFF_NOTRAILERS	0x20
#define IFF_RUNNING	0x40
#define IFF_NOARP	0x80

struct ifaddr
{
  struct sockaddr ifa_addr;
  union
  {
    struct sockaddr ifu_broadaddr;
    struct sockaddr ifu_dstaddr;
  }
  ifa_ifu;
  void *ifa_ifp;
  void *ifa_next;
}
 ;
#define IFNAMSIZ	IF_NAMESIZE

struct ifreq
{
  union
  {
    char ifrn_name[IFNAMSIZ];
  }
  ifr_ifrn;
  union
  {
    struct sockaddr ifru_addr;
    struct sockaddr ifru_dstaddr;
    struct sockaddr ifru_broadaddr;
    struct sockaddr ifru_netmask;
    struct sockaddr ifru_hwaddr;
    short ifru_flags;
    int ifru_ivalue;
    int ifru_mtu;
    char ifru_slave[IFNAMSIZ];
    char ifru_newname[IFNAMSIZ];
    caddr_t ifru_data;
    struct ifmap ifru_map;
  }
  ifr_ifru;
}
 ;

struct ifconf
{
  int ifc_len;
  union
  {
    caddr_t ifcu_buf;
    struct ifreq *ifcu_req;
  }
  ifc_ifcu;
}
 ;

netdb.h


#define h_errno	(*__h_errno_location ())
#define NETDB_INTERNAL	-1
#define NETDB_SUCCESS	0
#define HOST_NOT_FOUND	1
#define IPPORT_RESERVED	1024
#define NI_MAXHOST	1025
#define TRY_AGAIN	2
#define NO_RECOVERY	3
#define NI_MAXSERV	32
#define NO_DATA	4
#define h_addr	h_addr_list[0]
#define NO_ADDRESS	NO_DATA

struct servent
{
  char *s_name;
  char **s_aliases;
  int s_port;
  char *s_proto;
}
 ;
struct hostent
{
  char *h_name;
  char **h_aliases;
  int h_addrtype;
  int h_length;
  char **h_addr_list;
}
 ;
struct protoent
{
  char *p_name;
  char **p_aliases;
  int p_proto;
}
 ;
struct netent
{
  char *n_name;
  char **n_aliases;
  int n_addrtype;
  unsigned int n_net;
}
 ;
#define AI_PASSIVE	0x0001
#define AI_CANONNAME	0x0002
#define AI_NUMERICHOST	0x0004

struct addrinfo
{
  int ai_flags;
  int ai_family;
  int ai_socktype;
  int ai_protocol;
  socklen_t ai_addrlen;
  struct sockaddr *ai_addr;
  char *ai_canonname;
  struct addrinfo *ai_next;
}
 ;
#define NI_NUMERICHOST	1
#define NI_DGRAM	16
#define NI_NUMERICSERV	2
#define NI_NOFQDN	4
#define NI_NAMEREQD	8

#define EAI_BADFLAGS	-1
#define EAI_MEMORY	-10
#define EAI_SYSTEM	-11
#define EAI_NONAME	-2
#define EAI_AGAIN	-3
#define EAI_FAIL	-4
#define EAI_NODATA	-5
#define EAI_FAMILY	-6
#define EAI_SOCKTYPE	-7
#define EAI_SERVICE	-8
#define EAI_ADDRFAMILY	-9

netinet/in.h


#define IPPROTO_IP	0
#define IPPROTO_ICMP	1
#define IPPROTO_UDP	17
#define IPPROTO_IGMP	2
#define IPPROTO_RAW	255
#define IPPROTO_IPV6	41
#define IPPROTO_ICMPV6	58
#define IPPROTO_TCP	6

typedef uint16_t in_port_t;

struct in_addr
{
  uint32_t s_addr;
}
 ;
typedef uint32_t in_addr_t;
#define INADDR_NONE	((in_addr_t) 0xffffffff)
#define INADDR_BROADCAST	(0xffffffff)
#define INADDR_ANY	0

struct in6_addr
{
  union
  {
    uint8_t u6_addr8[16];
    uint16_t u6_addr16[8];
    uint32_t u6_addr32[4];
  }
  in6_u;
}
 ;
#define IN6ADDR_ANY_INIT	{ { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 } } }
#define IN6ADDR_LOOPBACK_INIT	{ { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1 } } }

#define INET_ADDRSTRLEN	16

struct sockaddr_in
{
  sa_family_t sin_family;
  unsigned short sin_port;
  struct in_addr sin_addr;
  unsigned char sin_zero[8];
}
 ;
#define INET6_ADDRSTRLEN	46

struct sockaddr_in6
{
  unsigned short sin6_family;
  uint16_t sin6_port;
  uint32_t sin6_flowinfo;
  struct in6_addr sin6_addr;
  uint32_t sin6_scope_id;
}
 ;
#define SOL_IP	0
#define IP_TOS	1
#define IPV6_UNICAST_HOPS	16
#define IPV6_MULTICAST_IF	17
#define IPV6_MULTICAST_HOPS	18
#define IPV6_MULTICAST_LOOP	19
#define IPV6_JOIN_GROUP	20
#define IPV6_LEAVE_GROUP	21
#define IPV6_V6ONLY	26
#define IP_MULTICAST_IF	32
#define IP_MULTICAST_TTL	33
#define IP_MULTICAST_LOOP	34
#define IP_ADD_MEMBERSHIP	35
#define IP_DROP_MEMBERSHIP	36

struct ipv6_mreq
{
  struct in6_addr ipv6mr_multiaddr;
  int ipv6mr_interface;
}
 ;
struct ip_mreq
{
  struct in_addr imr_multiaddr;
  struct in_addr imr_interface;
}
 ;

netinet/tcp.h


#define TCP_NODELAY	1
#define SOL_TCP	6

netinet/udp.h


#define SOL_UDP	17

nl_types.h


#define NL_CAT_LOCALE	1
#define NL_SETD	1

typedef void *nl_catd;

typedef int nl_item;

pty.h


struct winsize
{
  unsigned short ws_row;
  unsigned short ws_col;
  unsigned short ws_xpixel;
  unsigned short ws_ypixel;
}
 ;

pwd.h


struct passwd
{
  char *pw_name;
  char *pw_passwd;
  uid_t pw_uid;
  gid_t pw_gid;
  char *pw_gecos;
  char *pw_dir;
  char *pw_shell;
}
 ;

regex.h


#define RE_BACKSLASH_ESCAPE_IN_LISTS	((unsigned long int)1)
#define RE_BK_PLUS_QM	(RE_BACKSLASH_ESCAPE_IN_LISTS<<1)
#define RE_SYNTAX_AWK	(RE_BACKSLASH_ESCAPE_IN_LISTS|RE_DOT_NOT_NULL|RE_NO_BK_PARENS| RE_NO_BK_REFS| RE_NO_BK_VBAR| RE_NO_EMPTY_RANGES| RE_DOT_NEWLINE| RE_CONTEXT_INDEP_ANCHORS| RE_UNMATCHED_RIGHT_PAREN_ORD | RE_NO_GNU_OPS)
#define RE_CHAR_CLASSES	(RE_BK_PLUS_QM<<1)
#define RE_SYNTAX_GREP	(RE_BK_PLUS_QM|RE_CHAR_CLASSES|RE_HAT_LISTS_NOT_NEWLINE|RE_INTERVALS|RE_NEWLINE_ALT)
#define RE_CONTEXT_INDEP_ANCHORS	(RE_CHAR_CLASSES<<1)
#define RE_SYNTAX_EGREP	(RE_CHAR_CLASSES|RE_CONTEXT_INDEP_ANCHORS| RE_CONTEXT_INDEP_OPS|RE_HAT_LISTS_NOT_NEWLINE|RE_NEWLINE_ALT|RE_NO_BK_PARENS|RE_NO_BK_VBAR)
#define _RE_SYNTAX_POSIX_COMMON	(RE_CHAR_CLASSES|RE_DOT_NEWLINE|RE_DOT_NOT_NULL|RE_INTERVALS|RE_NO_EMPTY_RANGES)
#define RE_CONTEXT_INDEP_OPS	(RE_CONTEXT_INDEP_ANCHORS<<1)
#define RE_CONTEXT_INVALID_OPS	(RE_CONTEXT_INDEP_OPS<<1)
#define RE_DOT_NEWLINE	(RE_CONTEXT_INVALID_OPS<<1)
#define RE_INVALID_INTERVAL_ORD	(RE_DEBUG<<1)
#define RE_DOT_NOT_NULL	(RE_DOT_NEWLINE<<1)
#define RE_HAT_LISTS_NOT_NEWLINE	(RE_DOT_NOT_NULL<<1)
#define RE_INTERVALS	(RE_HAT_LISTS_NOT_NEWLINE<<1)
#define RE_LIMITED_OPS	(RE_INTERVALS<<1)
#define RE_NEWLINE_ALT	(RE_LIMITED_OPS<<1)
#define RE_NO_BK_BRACES	(RE_NEWLINE_ALT<<1)
#define RE_NO_BK_PARENS	(RE_NO_BK_BRACES<<1)
#define RE_NO_BK_REFS	(RE_NO_BK_PARENS<<1)
#define RE_NO_BK_VBAR	(RE_NO_BK_REFS<<1)
#define RE_NO_EMPTY_RANGES	(RE_NO_BK_VBAR<<1)
#define RE_UNMATCHED_RIGHT_PAREN_ORD	(RE_NO_EMPTY_RANGES<<1)
#define RE_DEBUG	(RE_NO_GNU_OPS<<1)
#define RE_NO_GNU_OPS	(RE_NO_POSIX_BACKTRACKING<<1)
#define RE_SYNTAX_POSIX_EGREP	(RE_SYNTAX_EGREP|RE_INTERVALS|RE_NO_BK_BRACES|RE_INVALID_INTERVAL_ORD)
#define RE_SYNTAX_POSIX_AWK	(RE_SYNTAX_POSIX_EXTENDED|RE_BACKSLASH_ESCAPE_IN_LISTS|RE_INTERVALS|RE_NO_GNU_OPS)
#define RE_NO_POSIX_BACKTRACKING	(RE_UNMATCHED_RIGHT_PAREN_ORD<<1)
#define RE_SYNTAX_POSIX_BASIC	(_RE_SYNTAX_POSIX_COMMON|RE_BK_PLUS_QM)
#define RE_SYNTAX_POSIX_EXTENDED	(_RE_SYNTAX_POSIX_COMMON|RE_CONTEXT_INDEP_ANCHORS|RE_CONTEXT_INDEP_OPS|RE_NO_BK_BRACES|RE_NO_BK_PARENS|RE_NO_BK_VBAR|RE_CONTEXT_INVALID_OPS|RE_UNMATCHED_RIGHT_PAREN_ORD)
#define RE_SYNTAX_POSIX_MINIMAL_EXTENDED	(_RE_SYNTAX_POSIX_COMMON|RE_CONTEXT_INDEP_ANCHORS|RE_CONTEXT_INVALID_OPS|RE_NO_BK_BRACES|RE_NO_BK_PARENS|RE_NO_BK_REFS|RE_NO_BK_VBAR|RE_UNMATCHED_RIGHT_PAREN_ORD)
#define RE_SYNTAX_POSIX_MINIMAL_BASIC	(_RE_SYNTAX_POSIX_COMMON|RE_LIMITED_OPS)
#define RE_SYNTAX_ED	RE_SYNTAX_POSIX_BASIC
#define RE_SYNTAX_SED	RE_SYNTAX_POSIX_BASIC

typedef unsigned long reg_syntax_t;

typedef struct re_pattern_buffer
{
  unsigned char *buffer;
  unsigned long allocated;
  unsigned long used;
  reg_syntax_t syntax;
  char *fastmap;
  char *translate;
  size_t re_nsub;
  unsigned int can_be_null:1;
  unsigned int regs_allocated:2;
  unsigned int fastmap_accurate:1;
  unsigned int no_sub:1;
  unsigned int not_bol:1;
  unsigned int not_eol:1;
  unsigned int newline_anchor:1;
}
regex_t;
typedef int regoff_t;
typedef struct
{
  regoff_t rm_so;
  regoff_t rm_eo;
}
regmatch_t;
#define REG_NOTEOL	(1<<1)
#define REG_ICASE	(REG_EXTENDED<<1)
#define REG_NEWLINE	(REG_ICASE<<1)
#define REG_NOSUB	(REG_NEWLINE<<1)
#define REG_NOMATCH	-1
#define REG_EXTENDED	1
#define REG_NOTBOL	1

rpc/auth.h


enum auth_stat
{
  AUTH_OK, AUTH_BADCRED = 1, AUTH_REJECTEDCRED = 2, AUTH_BADVERF =
    3, AUTH_REJECTEDVERF = 4, AUTH_TOOWEAK = 5, AUTH_INVALIDRESP =
    6, AUTH_FAILED = 7
}
 ;

union des_block
{
  struct
  {
    u_int32_t high;
    u_int32_t low;
  }
  key;
  char c[8];
}
 ;

struct opaque_auth
{
  enum_t oa_flavor;
  caddr_t oa_base;
  u_int oa_length;
}
 ;

typedef struct AUTH
{
  struct opaque_auth ah_cred;
  struct opaque_auth ah_verf;
  union des_block ah_key;
  struct auth_ops *ah_ops;
  caddr_t ah_private;
}
AUTH;

struct auth_ops
{
  void (*ah_nextverf) (struct AUTH *);
  int (*ah_marshal) (struct AUTH *, XDR *);
  int (*ah_validate) (struct AUTH *, struct opaque_auth *);
  int (*ah_refresh) (struct AUTH *);
  void (*ah_destroy) (struct AUTH *);
}
 ;

rpc/clnt.h


#define clnt_control(cl,rq,in)	((*(cl)->cl_ops->cl_control)(cl,rq,in))
#define clnt_abort(rh)	((*(rh)->cl_ops->cl_abort)(rh))
#define clnt_call(rh, proc, xargs, argsp, xres, resp, secs)	((*(rh)->cl_ops->cl_call)(rh, proc, xargs, argsp, xres, resp, secs))
#define clnt_destroy(rh)	((*(rh)->cl_ops->cl_destroy)(rh))
#define clnt_freeres(rh,xres,resp)	((*(rh)->cl_ops->cl_freeres)(rh,xres,resp))
#define clnt_geterr(rh,errp)	((*(rh)->cl_ops->cl_geterr)(rh, errp))
#define NULLPROC	((u_long)0)
#define CLSET_TIMEOUT	1
#define CLGET_XID	10
#define CLSET_XID	11
#define CLGET_VERS	12
#define CLSET_VERS	13
#define CLGET_PROG	14
#define CLSET_PROG	15
#define CLGET_TIMEOUT	2
#define CLGET_SERVER_ADDR	3
#define CLSET_RETRY_TIMEOUT	4
#define CLGET_RETRY_TIMEOUT	5
#define CLGET_FD	6
#define CLGET_SVC_ADDR	7
#define CLSET_FD_CLOSE	8
#define CLSET_FD_NCLOSE	9

enum clnt_stat
{
  RPC_SUCCESS, RPC_CANTENCODEARGS = 1, RPC_CANTDECODERES = 2, RPC_CANTSEND =
    3, RPC_CANTRECV = 4, RPC_TIMEDOUT = 5, RPC_VERSMISMATCH =
    6, RPC_AUTHERROR = 7, RPC_PROGUNAVAIL = 8, RPC_PROGVERSMISMATCH =
    9, RPC_PROCUNAVAIL = 10, RPC_CANTDECODEARGS = 11, RPC_SYSTEMERROR =
    12, RPC_NOBROADCAST = 21, RPC_UNKNOWNHOST = 13, RPC_UNKNOWNPROTO =
    17, RPC_UNKNOWNADDR = 19, RPC_RPCBFAILURE = 14, RPC_PROGNOTREGISTERED =
    15, RPC_N2AXLATEFAILURE = 22, RPC_FAILED = 16, RPC_INTR =
    18, RPC_TLIERROR = 20, RPC_UDERROR = 23, RPC_INPROGRESS =
    24, RPC_STALERACHANDLE = 25
}
 ;
struct rpc_err
{
  enum clnt_stat re_status;
  union
  {
    int RE_errno;
    enum auth_stat RE_why;
    struct
    {
      u_long low;
      u_long high;
    }
    RE_vers;
    struct
    {
      long s1;
      long s2;
    }
    RE_lb;
  }
  ru;
}
 ;

typedef struct CLIENT
{
  struct AUTH *cl_auth;
  struct clnt_ops *cl_ops;
  caddr_t cl_private;
}
CLIENT;

struct clnt_ops
{
  enum clnt_stat (*cl_call) (struct CLIENT *, u_long, xdrproc_t, caddr_t,
			     xdrproc_t, caddr_t, struct timeval);
  void (*cl_abort) (void);
  void (*cl_geterr) (struct CLIENT *, struct rpc_err *);
    bool_t (*cl_freeres) (struct CLIENT *, xdrproc_t, caddr_t);
  void (*cl_destroy) (struct CLIENT *);
    bool_t (*cl_control) (struct CLIENT *, int, char *);
}
 ;

rpc/rpc_msg.h


enum msg_type
{
  CALL, REPLY = 1
}
 ;
enum reply_stat
{
  MSG_ACCEPTED, MSG_DENIED = 1
}
 ;
enum accept_stat
{
  SUCCESS, PROG_UNAVAIL = 1, PROG_MISMATCH = 2, PROC_UNAVAIL =
    3, GARBAGE_ARGS = 4, SYSTEM_ERR = 5
}
 ;
enum reject_stat
{
  RPC_MISMATCH, AUTH_ERROR = 1
}
 ;

struct accepted_reply
{
  struct opaque_auth ar_verf;
  enum accept_stat ar_stat;
  union
  {
    struct
    {
      unsigned long low;
      unsigned long high;
    }
    AR_versions;
    struct
    {
      caddr_t where;
      xdrproc_t proc;
    }
    AR_results;
  }
  ru;
}
 ;

struct rejected_reply
{
  enum reject_stat rj_stat;
  union
  {
    struct
    {
      unsigned long low;
      unsigned long high;
    }
    RJ_versions;
    enum auth_stat RJ_why;
  }
  ru;
}
 ;

struct reply_body
{
  enum reply_stat rp_stat;
  union
  {
    struct accepted_reply RP_ar;
    struct rejected_reply RP_dr;
  }
  ru;
}
 ;

struct call_body
{
  unsigned long cb_rpcvers;
  unsigned long cb_prog;
  unsigned long cb_vers;
  unsigned long cb_proc;
  struct opaque_auth cb_cred;
  struct opaque_auth cb_verf;
}
 ;

struct rpc_msg
{
  unsigned long rm_xid;
  enum msg_type rm_direction;
  union
  {
    struct call_body RM_cmb;
    struct reply_body RM_rmb;
  }
  ru;
}
 ;

rpc/svc.h


#define svc_freeargs(xprt,xargs, argsp)	(*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
#define svc_getargs(xprt,xargs, argsp)	(*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
#define RPC_ANYSOCK	-1

typedef struct SVCXPRT
{
  int xp_sock;
  u_short xp_port;
  struct xp_ops *xp_ops;
  int xp_addrlen;
  struct sockaddr_in xp_raddr;
  struct opaque_auth xp_verf;
  caddr_t xp_p1;
  caddr_t xp_p2;
  char xp_pad[256];
}
SVCXPRT;

struct svc_req
{
  rpcprog_t rq_prog;
  rpcvers_t rq_vers;
  rpcproc_t rq_proc;
  struct opaque_auth rq_cred;
  caddr_t rq_clntcred;
  SVCXPRT *rq_xprt;
}
 ;

typedef void (*__dispatch_fn_t) (struct svc_req *, SVCXPRT *);

struct xp_ops
{
  bool_t (*xp_recv) (SVCXPRT * __xprt, struct rpc_msg * __msg);
  enum xprt_stat (*xp_stat) (SVCXPRT * __xprt);
    bool_t (*xp_getargs) (SVCXPRT * __xprt, xdrproc_t __xdr_args,
			  caddr_t args_ptr);
    bool_t (*xp_reply) (SVCXPRT * __xprt, struct rpc_msg * __msg);
    bool_t (*xp_freeargs) (SVCXPRT * __xprt, xdrproc_t __xdr_args,
			   caddr_t args_ptr);
  void (*xp_destroy) (SVCXPRT * __xprt);
}
 ;

rpc/types.h


typedef int bool_t;
typedef int enum_t;
typedef unsigned long rpcprog_t;
typedef unsigned long rpcvers_t;
typedef unsigned long rpcproc_t;
typedef unsigned long rpcprot_t;

rpc/xdr.h


enum xdr_op
{
  XDR_ENCODE, XDR_DECODE, XDR_FREE
}
 ;
typedef struct XDR
{
  enum xdr_op x_op;
  struct xdr_ops *x_ops;
  caddr_t x_public;
  caddr_t x_private;
  caddr_t x_base;
  int x_handy;
}
XDR;

struct xdr_ops
{
  bool_t (*x_getlong) (XDR * __xdrs, long *__lp);
  bool_t (*x_putlong) (XDR * __xdrs, long *__lp);
  bool_t (*x_getbytes) (XDR * __xdrs, caddr_t __addr, u_int __len);
  bool_t (*x_putbytes) (XDR * __xdrs, char *__addr, u_int __len);
  u_int (*x_getpostn) (XDR * __xdrs);
  bool_t (*x_setpostn) (XDR * __xdrs, u_int __pos);
  int32_t *(*x_inline) (XDR * __xdrs, int __len);
  void (*x_destroy) (XDR * __xdrs);
    bool_t (*x_getint32) (XDR * __xdrs, int32_t * __ip);
    bool_t (*x_putint32) (XDR * __xdrs, int32_t * __ip);
}
 ;

typedef bool_t (*xdrproc_t) (XDR *, void *, ...);

struct xdr_discrim
{
  int value;
  xdrproc_t proc;
}
 ;

sched.h


#define SCHED_OTHER	0
#define SCHED_FIFO	1
#define SCHED_RR	2

struct sched_param
{
  int sched_priority;
}
 ;

search.h


typedef struct entry
{
  char *key;
  void *data;
}
ENTRY;
typedef enum
{
  FIND, ENTER
}
ACTION;
typedef enum
{
  preorder, postorder, endorder, leaf
}
VISIT;

typedef void (*__action_fn_t) (void *__nodep, VISIT __value, int __level);

setjmp.h


#define setjmp(env)	_setjmp(env)
#define sigsetjmp(a,b)	__sigsetjmp(a,b)

struct __jmp_buf_tag
{
  __jmp_buf __jmpbuf;
  int __mask_was_saved;
  sigset_t __saved_mask;
}
 ;

typedef struct __jmp_buf_tag jmp_buf[1];
typedef jmp_buf sigjmp_buf;

signal.h


#define SIGRTMAX	(__libc_current_sigrtmax ())
#define SIGRTMIN	(__libc_current_sigrtmin ())
#define SIG_BLOCK	0
#define SIG_UNBLOCK	1
#define SIG_SETMASK	2
#define NSIG	65

typedef int sig_atomic_t;
struct sigstack
{
  void *ss_sp;
  int ss_onstack;
}
 ;

typedef void (*sighandler_t) (int);
#define SIG_HOLD	((sighandler_t) 2)
#define SIG_ERR	((sighandler_t)-1)
#define SIG_DFL	((sighandler_t)0)
#define SIG_IGN	((sighandler_t)1)

#define SIGHUP	1
#define SIGUSR1	10
#define SIGSEGV	11
#define SIGUSR2	12
#define SIGPIPE	13
#define SIGALRM	14
#define SIGTERM	15
#define SIGSTKFLT	16
#define SIGCHLD	17
#define SIGCONT	18
#define SIGSTOP	19
#define SIGINT	2
#define SIGTSTP	20
#define SIGTTIN	21
#define SIGTTOU	22
#define SIGURG	23
#define SIGXCPU	24
#define SIGXFSZ	25
#define SIGVTALRM	26
#define SIGPROF	27
#define SIGWINCH	28
#define SIGIO	29
#define SIGQUIT	3
#define SIGPWR	30
#define SIGSYS	31
#define SIGUNUSED	31
#define SIGILL	4
#define SIGTRAP	5
#define SIGABRT	6
#define SIGIOT	6
#define SIGBUS	7
#define SIGFPE	8
#define SIGKILL	9
#define SIGCLD	SIGCHLD
#define SIGPOLL	SIGIO

#define SV_ONSTACK	(1<<0)
#define SV_INTERRUPT	(1<<1)
#define SV_RESETHAND	(1<<2)

typedef union sigval
{
  int sival_int;
  void *sival_ptr;
}
sigval_t;
#define SIGEV_SIGNAL	0
#define SIGEV_NONE	1
#define SIGEV_THREAD	2

typedef struct sigevent
{
  sigval_t sigev_value;
  int sigev_signo;
  int sigev_notify;
  union
  {
    int _pad[SIGEV_PAD_SIZE];
    struct
    {
      void (*sigev_thread_func) (sigval_t);
      void *_attribute;
    }
    _sigev_thread;
  }
  _sigev_un;
}
sigevent_t;
#define si_pid	_sifields._kill._pid
#define si_uid	_sifields._kill._uid
#define si_value	_sifields._rt._sigval
#define si_int	_sifields._rt._sigval.sival_int
#define si_ptr	_sifields._rt._sigval.sival_ptr
#define si_status	_sifields._sigchld._status
#define si_stime	_sifields._sigchld._stime
#define si_utime	_sifields._sigchld._utime
#define si_addr	_sifields._sigfault._addr
#define si_band	_sifields._sigpoll._band
#define si_fd	_sifields._sigpoll._fd
#define si_timer1	_sifields._timer._timer1
#define si_timer2	_sifields._timer._timer2

typedef struct siginfo
{
  int si_signo;
  int si_errno;
  int si_code;
  union
  {
    int _pad[SI_PAD_SIZE];
    struct
    {
      pid_t _pid;
      uid_t _uid;
    }
    _kill;
    struct
    {
      unsigned int _timer1;
      unsigned int _timer2;
    }
    _timer;
    struct
    {
      pid_t _pid;
      uid_t _uid;
      sigval_t _sigval;
    }
    _rt;
    struct
    {
      pid_t _pid;
      uid_t _uid;
      int _status;
      clock_t _utime;
      clock_t _stime;
    }
    _sigchld;
    struct
    {
      void *_addr;
    }
    _sigfault;
    struct
    {
      int _band;
      int _fd;
    }
    _sigpoll;
  }
  _sifields;
}
siginfo_t;
#define SI_QUEUE	-1
#define SI_TIMER	-2
#define SI_MESGQ	-3
#define SI_ASYNCIO	-4
#define SI_SIGIO	-5
#define SI_TKILL	-6
#define SI_ASYNCNL	-60
#define SI_USER	0
#define SI_KERNEL	0x80

#define ILL_ILLOPC	1
#define ILL_ILLOPN	2
#define ILL_ILLADR	3
#define ILL_ILLTRP	4
#define ILL_PRVOPC	5
#define ILL_PRVREG	6
#define ILL_COPROC	7
#define ILL_BADSTK	8

#define FPE_INTDIV	1
#define FPE_INTOVF	2
#define FPE_FLTDIV	3
#define FPE_FLTOVF	4
#define FPE_FLTUND	5
#define FPE_FLTRES	6
#define FPE_FLTINV	7
#define FPE_FLTSUB	8

#define SEGV_MAPERR	1
#define SEGV_ACCERR	2

#define BUS_ADRALN	1
#define BUS_ADRERR	2
#define BUS_OBJERR	3

#define TRAP_BRKPT	1
#define TRAP_TRACE	2

#define CLD_EXITED	1
#define CLD_KILLED	2
#define CLD_DUMPED	3
#define CLD_TRAPPED	4
#define CLD_STOPPED	5
#define CLD_CONTINUED	6

#define POLL_IN	1
#define POLL_OUT	2
#define POLL_MSG	3
#define POLL_ERR	4
#define POLL_PRI	5
#define POLL_HUP	6

typedef struct
{
  unsigned long sig[_SIGSET_NWORDS];
}
sigset_t;
#define SA_NOCLDSTOP	0x00000001
#define SA_NOCLDWAIT	0x00000002
#define SA_SIGINFO	0x00000004
#define SA_ONSTACK	0x08000000
#define SA_RESTART	0x10000000
#define SA_INTERRUPT	0x20000000
#define SA_NODEFER	0x40000000
#define SA_RESETHAND	0x80000000
#define SA_NOMASK	SA_NODEFER
#define SA_ONESHOT	SA_RESETHAND

typedef struct sigaltstack
{
  void *ss_sp;
  int ss_flags;
  size_t ss_size;
}
stack_t;
#define SS_ONSTACK	1
#define SS_DISABLE	2

stddef.h


#define offsetof(TYPE,MEMBER)	((size_t)& ((TYPE*)0)->MEMBER)
#define NULL	(0L)

typedef int wchar_t;

stdio.h


#define EOF	(-1)
#define P_tmpdir	"/tmp"
#define FOPEN_MAX	16
#define L_tmpnam	20
#define FILENAME_MAX	4096
#define BUFSIZ	8192
#define L_ctermid	9
#define L_cuserid	9

typedef struct
{
  off_t __pos;
  mbstate_t __state;
}
fpos_t;
typedef struct
{
  off64_t __pos;
  mbstate_t __state;
}
fpos64_t;

typedef struct _IO_FILE FILE;
#define _IOFBF	0
#define _IOLBF	1
#define _IONBF	2

stdlib.h


#define MB_CUR_MAX	(__ctype_get_mb_cur_max())
#define EXIT_SUCCESS	0
#define EXIT_FAILURE	1
#define RAND_MAX	2147483647

typedef int (*__compar_fn_t) (const void *, const void *);
struct random_data
{
  int32_t *fptr;
  int32_t *rptr;
  int32_t *state;
  int rand_type;
  int rand_deg;
  int rand_sep;
  int32_t *end_ptr;
}
 ;

typedef struct
{
  int quot;
  int rem;
}
div_t;

typedef struct
{
  long quot;
  long rem;
}
ldiv_t;

typedef struct
{
  long long quot;
  long long rem;
}
lldiv_t;

sys/file.h


#define LOCK_SH	1
#define LOCK_EX	2
#define LOCK_NB	4
#define LOCK_UN	8

sys/ipc.h


#define IPC_PRIVATE	((key_t)0)
#define IPC_RMID	0
#define IPC_CREAT	00001000
#define IPC_EXCL	00002000
#define IPC_NOWAIT	00004000
#define IPC_SET	1
#define IPC_STAT	2

sys/mman.h


#define MAP_FAILED	((void*)-1)
#define PROT_NONE	0x0
#define MAP_SHARED	0x01
#define MAP_PRIVATE	0x02
#define PROT_READ	0x1
#define MAP_FIXED	0x10
#define PROT_WRITE	0x2
#define MAP_ANONYMOUS	0x20
#define PROT_EXEC	0x4
#define MS_ASYNC	1
#define MS_INVALIDATE	2
#define MS_SYNC	4
#define MAP_ANON	MAP_ANONYMOUS

sys/msg.h


#define MSG_NOERROR	010000

sys/param.h


#define NOFILE	256
#define MAXPATHLEN	4096

sys/poll.h


#define POLLIN	0x0001
#define POLLPRI	0x0002
#define POLLOUT	0x0004
#define POLLERR	0x0008
#define POLLHUP	0x0010
#define POLLNVAL	0x0020

struct pollfd
{
  int fd;
  short events;
  short revents;
}
 ;
typedef unsigned long nfds_t;

sys/resource.h


#define RUSAGE_CHILDREN	(-1)
#define RUSAGE_BOTH	(-2)
#define RLIM_INFINITY	(~0UL)
#define RLIM_SAVED_CUR	-1
#define RLIM_SAVED_MAX	-1
#define RLIMIT_CPU	0
#define RUSAGE_SELF	0
#define RLIMIT_FSIZE	1
#define RLIMIT_DATA	2
#define RLIMIT_STACK	3
#define RLIMIT_CORE	4
#define RLIMIT_NOFILE	7
#define RLIMIT_AS	9

typedef unsigned long rlim_t;
typedef unsigned long long rlim64_t;
typedef int __rlimit_resource_t;

struct rlimit
{
  rlim_t rlim_cur;
  rlim_t rlim_max;
}
 ;
struct rlimit64
{
  rlim64_t rlim_cur;
  rlim64_t rlim_max;
}
 ;

struct rusage
{
  struct timeval ru_utime;
  struct timeval ru_stime;
  long ru_maxrss;
  long ru_ixrss;
  long ru_idrss;
  long ru_isrss;
  long ru_minflt;
  long ru_majflt;
  long ru_nswap;
  long ru_inblock;
  long ru_oublock;
  long ru_msgsnd;
  long ru_msgrcv;
  long ru_nsignals;
  long ru_nvcsw;
  long ru_nivcsw;
}
 ;

enum __priority_which
{
  PRIO_PROCESS, PRIO_PGRP = 1, PRIO_USER = 2
}
 ;
#define PRIO_PGRP	PRIO_PGRP
#define PRIO_PROCESS	PRIO_PROCESS
#define PRIO_USER	PRIO_USER

typedef enum __priority_which __priority_which_t;

sys/sem.h


#define SEM_UNDO	0x1000
#define GETPID	11
#define GETVAL	12
#define GETALL	13
#define GETNCNT	14
#define GETZCNT	15
#define SETVAL	16
#define SETALL	17

struct sembuf
{
  short sem_num;
  short sem_op;
  short sem_flg;
}
 ;

sys/shm.h


#define SHM_RDONLY	010000
#define SHM_W	0200
#define SHM_RND	020000
#define SHM_R	0400
#define SHM_REMAP	040000
#define SHM_LOCK	11
#define SHM_UNLOCK	12

sys/socket.h


#define SHUT_RD	0
#define MSG_WAITALL	0x100
#define MSG_TRUNC	0x20
#define MSG_EOR	0x80
#define SIOCGIFCONF	0x8912
#define SIOCGIFFLAGS	0x8913
#define SIOCGIFADDR	0x8915
#define SIOCGIFNETMASK	0x891b
#define MSG_OOB	1
#define SHUT_WR	1
#define MSG_PEEK	2
#define SHUT_RDWR	2
#define MSG_DONTROUTE	4
#define MSG_CTRUNC	8
#define PF_UNSPEC	AF_UNSPEC

struct linger
{
  int l_onoff;
  int l_linger;
}
 ;
struct cmsghdr
{
  size_t cmsg_len;
  int cmsg_level;
  int cmsg_type;
}
 ;
struct iovec
{
  void *iov_base;
  size_t iov_len;
}
 ;

typedef unsigned short sa_family_t;
typedef unsigned int socklen_t;

struct sockaddr
{
  sa_family_t sa_family;
  char sa_data[14];
}
 ;
struct sockaddr_storage
{
  sa_family_t ss_family;
  __ss_aligntype __ss_align;
  char __ss_padding[(128 - (2 * sizeof (__ss_aligntype)))];
}
 ;

struct msghdr
{
  void *msg_name;
  int msg_namelen;
  struct iovec *msg_iov;
  size_t msg_iovlen;
  void *msg_control;
  size_t msg_controllen;
  unsigned int msg_flags;
}
 ;
#define AF_UNSPEC	0
#define AF_UNIX	1
#define AF_INET6	10
#define AF_INET	2

#define PF_INET	AF_INET
#define PF_INET6	AF_INET6
#define PF_UNIX	AF_UNIX

#define SOCK_STREAM	1
#define SOCK_PACKET	10
#define SOCK_DGRAM	2
#define SOCK_RAW	3
#define SOCK_RDM	4
#define SOCK_SEQPACKET	5

#define SOL_SOCKET	1
#define SO_DEBUG	1
#define SO_OOBINLINE	10
#define SO_NO_CHECK	11
#define SO_PRIORITY	12
#define SO_LINGER	13
#define SO_REUSEADDR	2
#define SOL_RAW	255
#define SO_TYPE	3
#define SO_ERROR	4
#define SO_DONTROUTE	5
#define SO_BROADCAST	6
#define SO_SNDBUF	7
#define SO_RCVBUF	8
#define SO_KEEPALIVE	9

sys/stat.h


#define S_ISBLK(m)	(((m)& S_IFMT)==S_IFBLK)
#define S_ISCHR(m)	(((m)& S_IFMT)==S_IFCHR)
#define S_ISDIR(m)	(((m)& S_IFMT)==S_IFDIR)
#define S_ISFIFO(m)	(((m)& S_IFMT)==S_IFIFO)
#define S_ISLNK(m)	(((m)& S_IFMT)==S_IFLNK)
#define S_ISREG(m)	(((m)& S_IFMT)==S_IFREG)
#define S_ISSOCK(m)	(((m)& S_IFMT)==S_IFSOCK)
#define S_TYPEISMQ(buf)	((buf)->st_mode - (buf)->st_mode)
#define S_TYPEISSEM(buf)	((buf)->st_mode - (buf)->st_mode)
#define S_TYPEISSHM(buf)	((buf)->st_mode - (buf)->st_mode)
#define S_IRWXU	(S_IREAD|S_IWRITE|S_IEXEC)
#define S_IROTH	(S_IRGRP>>3)
#define S_IRGRP	(S_IRUSR>>3)
#define S_IRWXO	(S_IRWXG>>3)
#define S_IRWXG	(S_IRWXU>>3)
#define S_IWOTH	(S_IWGRP>>3)
#define S_IWGRP	(S_IWUSR>>3)
#define S_IXOTH	(S_IXGRP>>3)
#define S_IXGRP	(S_IXUSR>>3)
#define S_ISVTX	01000
#define S_IXUSR	0x0040
#define S_IWUSR	0x0080
#define S_IRUSR	0x0100
#define S_ISGID	0x0400
#define S_ISUID	0x0800
#define S_IFIFO	0x1000
#define S_IFCHR	0x2000
#define S_IFDIR	0x4000
#define S_IFBLK	0x6000
#define S_IFREG	0x8000
#define S_IFLNK	0xa000
#define S_IFSOCK	0xc000
#define S_IFMT	0xf000
#define st_atime	st_atim.tv_sec
#define st_ctime	st_ctim.tv_sec
#define st_mtime	st_mtim.tv_sec
#define S_IREAD	S_IRUSR
#define S_IWRITE	S_IWUSR
#define S_IEXEC	S_IXUSR

sys/time.h


#define ITIMER_REAL	0
#define ITIMER_VIRTUAL	1
#define ITIMER_PROF	2

struct timezone
{
  int tz_minuteswest;
  int tz_dsttime;
}
 ;

typedef int __itimer_which_t;

struct timespec
{
  time_t tv_sec;
  long tv_nsec;
}
 ;

struct timeval
{
  time_t tv_sec;
  suseconds_t tv_usec;
}
 ;

struct itimerval
{
  struct timeval it_interval;
  struct timeval it_value;
}
 ;

sys/timeb.h


struct timeb
{
  time_t time;
  unsigned short millitm;
  short timezone;
  short dstflag;
}
 ;

sys/times.h


struct tms
{
  clock_t tms_utime;
  clock_t tms_stime;
  clock_t tms_cutime;
  clock_t tms_cstime;
}
 ;

sys/types.h


#define FD_ISSET(d,set)	((set)->fds_bits[((d)/(8*sizeof(long)))]& (1<<((d)%(8*sizeof(long)))))
#define FD_CLR(d,set)	((set)->fds_bits[((d)/(8*sizeof(long)))]& =~(1<<((d)%(8*sizeof(long)))))
#define FD_SET(d,set)	((set)->fds_bits[((d)/(8*sizeof(long)))]|=(1<<((d)%(8*sizeof(long)))))
#define FALSE	0
#define TRUE	1
#define FD_SETSIZE	1024
#define FD_ZERO(fdsetp)	bzero(fdsetp, sizeof(*(fdsetp)))

typedef signed char int8_t;
typedef short int16_t;
typedef int int32_t;
typedef unsigned char u_int8_t;
typedef unsigned short u_int16_t;
typedef unsigned int u_int32_t;
typedef unsigned int uid_t;
typedef int pid_t;
typedef unsigned long off_t;
typedef int key_t;
typedef long suseconds_t;
typedef unsigned int u_int;
typedef struct
{
  int __val[2];
}
fsid_t;
typedef unsigned int useconds_t;
typedef unsigned long blksize_t;
typedef long fd_mask;
typedef int timer_t;
typedef int clockid_t;

typedef unsigned int id_t;

typedef unsigned long long ino64_t;
typedef long long loff_t;
typedef unsigned long blkcnt_t;
typedef unsigned long fsblkcnt_t;
typedef unsigned long fsfilcnt_t;
typedef unsigned long long blkcnt64_t;
typedef unsigned long long fsblkcnt64_t;
typedef unsigned long long fsfilcnt64_t;
typedef unsigned char u_char;
typedef unsigned short u_short;
typedef unsigned long u_long;

typedef unsigned long ino_t;
typedef unsigned int gid_t;
typedef unsigned long long dev_t;
typedef unsigned int mode_t;
typedef unsigned long nlink_t;
typedef char *caddr_t;

typedef struct
{
  unsigned long fds_bits[__FDSET_LONGS];
}
fd_set;

typedef long clock_t;
typedef long time_t;

sys/un.h


#define UNIX_PATH_MAX	108

struct sockaddr_un
{
  sa_family_t sun_family;
  char sun_path[UNIX_PATH_MAX];
}
 ;

sys/utsname.h


#define SYS_NMLN	65

struct utsname
{
  char sysname[65];
  char nodename[65];
  char release[65];
  char version[65];
  char machine[65];
  char domainname[65];
}
 ;

sys/wait.h


#define WIFSIGNALED(status)	(!WIFSTOPPED(status) & & !WIFEXITED(status))
#define WIFSTOPPED(status)	(((status) &  0xff) == 0x7f)
#define WEXITSTATUS(status)	(((status) &  0xff00) >> 8)
#define WTERMSIG(status)	((status) &  0x7f)
#define WCOREDUMP(status)	((status) &  0x80)
#define WIFEXITED(status)	(WTERMSIG(status) == 0)
#define WNOHANG	0x00000001
#define WUNTRACED	0x00000002
#define WCOREFLAG	0x80
#define WSTOPSIG(status)	WEXITSTATUS(status)

typedef enum
{
  P_ALL, P_PID, P_PGID
}
idtype_t;

syslog.h


#define LOG_EMERG	0
#define LOG_PRIMASK	0x07
#define LOG_ALERT	1
#define LOG_CRIT	2
#define LOG_ERR	3
#define LOG_WARNING	4
#define LOG_NOTICE	5
#define LOG_INFO	6
#define LOG_DEBUG	7

#define LOG_KERN	(0<<3)
#define LOG_AUTHPRIV	(10<<3)
#define LOG_FTP	(11<<3)
#define LOG_USER	(1<<3)
#define LOG_MAIL	(2<<3)
#define LOG_DAEMON	(3<<3)
#define LOG_AUTH	(4<<3)
#define LOG_SYSLOG	(5<<3)
#define LOG_LPR	(6<<3)
#define LOG_NEWS	(7<<3)
#define LOG_UUCP	(8<<3)
#define LOG_CRON	(9<<3)
#define LOG_FACMASK	0x03f8

#define LOG_LOCAL0	(16<<3)
#define LOG_LOCAL1	(17<<3)
#define LOG_LOCAL2	(18<<3)
#define LOG_LOCAL3	(19<<3)
#define LOG_LOCAL4	(20<<3)
#define LOG_LOCAL5	(21<<3)
#define LOG_LOCAL6	(22<<3)
#define LOG_LOCAL7	(23<<3)

#define LOG_UPTO(pri)	((1 << ((pri)+1)) - 1)
#define LOG_MASK(pri)	(1 << (pri))

#define LOG_PID	0x01
#define LOG_CONS	0x02
#define LOG_ODELAY	0x04
#define LOG_NDELAY	0x08
#define LOG_NOWAIT	0x10
#define LOG_PERROR	0x20

termios.h


#define TCIFLUSH	0
#define TCOOFF	0
#define TCSANOW	0
#define BS0	0000000
#define CR0	0000000
#define FF0	0000000
#define NL0	0000000
#define TAB0	0000000
#define VT0	0000000
#define OPOST	0000001
#define OCRNL	0000010
#define ONOCR	0000020
#define ONLRET	0000040
#define OFILL	0000100
#define OFDEL	0000200
#define NL1	0000400
#define TCOFLUSH	1
#define TCOON	1
#define TCSADRAIN	1
#define TCIOFF	2
#define TCIOFLUSH	2
#define TCSAFLUSH	2
#define TCION	3

typedef unsigned int speed_t;
typedef unsigned char cc_t;
typedef unsigned int tcflag_t;
#define NCCS	32

struct termios
{
  tcflag_t c_iflag;
  tcflag_t c_oflag;
  tcflag_t c_cflag;
  tcflag_t c_lflag;
  cc_t c_line;
  cc_t c_cc[NCCS];
  speed_t c_ispeed;
  speed_t c_ospeed;
}
 ;
#define VINTR	0
#define VQUIT	1
#define VLNEXT	15
#define VERASE	2
#define VKILL	3
#define VEOF	4

#define IGNBRK	0000001
#define BRKINT	0000002
#define IGNPAR	0000004
#define PARMRK	0000010
#define INPCK	0000020
#define ISTRIP	0000040
#define INLCR	0000100
#define IGNCR	0000200
#define ICRNL	0000400
#define IXANY	0004000
#define IMAXBEL	0020000

#define CS5	0000000

#define ECHO	0000010

#define B0	0000000
#define B50	0000001
#define B75	0000002
#define B110	0000003
#define B134	0000004
#define B150	0000005
#define B200	0000006
#define B300	0000007
#define B600	0000010
#define B1200	0000011
#define B1800	0000012
#define B2400	0000013
#define B4800	0000014
#define B9600	0000015
#define B19200	0000016
#define B38400	0000017

time.h


#define CLK_TCK	((clock_t)__sysconf(2))
#define CLOCK_REALTIME	0
#define TIMER_ABSTIME	1
#define CLOCKS_PER_SEC	1000000l

struct tm
{
  int tm_sec;
  int tm_min;
  int tm_hour;
  int tm_mday;
  int tm_mon;
  int tm_year;
  int tm_wday;
  int tm_yday;
  int tm_isdst;
  long tm_gmtoff;
  char *tm_zone;
}
 ;
struct itimerspec
{
  struct timespec it_interval;
  struct timespec it_value;
}
 ;

ulimit.h


#define UL_GETFSIZE	1
#define UL_SETFSIZE	2

unistd.h


#define SEEK_SET	0
#define STDIN_FILENO	0
#define SEEK_CUR	1
#define STDOUT_FILENO	1
#define SEEK_END	2
#define STDERR_FILENO	2

typedef long long off64_t;
#define F_OK	0
#define X_OK	1
#define W_OK	2
#define R_OK	4

#define _POSIX_VDISABLE	'\0'
#define _POSIX_CHOWN_RESTRICTED	1
#define _POSIX_JOB_CONTROL	1
#define _POSIX_NO_TRUNC	1
#define _POSIX_SHELL	1
#define _POSIX_FSYNC	200112
#define _POSIX_MAPPED_FILES	200112
#define _POSIX_MEMLOCK	200112
#define _POSIX_MEMLOCK_RANGE	200112
#define _POSIX_MEMORY_PROTECTION	200112
#define _POSIX_SEMAPHORES	200112
#define _POSIX_SHARED_MEMORY_OBJECTS	200112
#define _POSIX_TIMERS	200112
#define _POSIX2_C_BIND	200112L
#define _POSIX2_VERSION	200112L
#define _POSIX_THREADS	200112L
#define _POSIX_VERSION	200112L

#define _PC_LINK_MAX	0
#define _PC_MAX_CANON	1
#define _PC_ASYNC_IO	10
#define _PC_PRIO_IO	11
#define _PC_FILESIZEBITS	13
#define _PC_REC_INCR_XFER_SIZE	14
#define _PC_REC_MIN_XFER_SIZE	16
#define _PC_REC_XFER_ALIGN	17
#define _PC_ALLOC_SIZE_MIN	18
#define _PC_MAX_INPUT	2
#define _PC_2_SYMLINKS	20
#define _PC_NAME_MAX	3
#define _PC_PATH_MAX	4
#define _PC_PIPE_BUF	5
#define _PC_CHOWN_RESTRICTED	6
#define _PC_NO_TRUNC	7
#define _PC_VDISABLE	8
#define _PC_SYNC_IO	9

#define _SC_ARG_MAX	0
#define _SC_CHILD_MAX	1
#define _SC_PRIORITY_SCHEDULING	10
#define _SC_TIMERS	11
#define _SC_ASYNCHRONOUS_IO	12
#define _SC_XBS5_ILP32_OFF32	125
#define _SC_XBS5_ILP32_OFFBIG	126
#define _SC_XBS5_LP64_OFF64	127
#define _SC_XBS5_LPBIG_OFFBIG	128
#define _SC_XOPEN_LEGACY	129
#define _SC_PRIORITIZED_IO	13
#define _SC_XOPEN_REALTIME	130
#define _SC_XOPEN_REALTIME_THREADS	131
#define _SC_ADVISORY_INFO	132
#define _SC_BARRIERS	133
#define _SC_CLOCK_SELECTION	137
#define _SC_CPUTIME	138
#define _SC_THREAD_CPUTIME	139
#define _SC_SYNCHRONIZED_IO	14
#define _SC_MONOTONIC_CLOCK	149
#define _SC_FSYNC	15
#define _SC_READER_WRITER_LOCKS	153
#define _SC_SPIN_LOCKS	154
#define _SC_REGEXP	155
#define _SC_SHELL	157
#define _SC_SPAWN	159
#define _SC_MAPPED_FILES	16
#define _SC_SPORADIC_SERVER	160
#define _SC_THREAD_SPORADIC_SERVER	161
#define _SC_TIMEOUTS	164
#define _SC_TYPED_MEMORY_OBJECTS	165
#define _SC_2_PBS_ACCOUNTING	169
#define _SC_MEMLOCK	17
#define _SC_2_PBS_LOCATE	170
#define _SC_2_PBS_MESSAGE	171
#define _SC_2_PBS_TRACK	172
#define _SC_SYMLOOP_MAX	173
#define _SC_2_PBS_CHECKPOINT	175
#define _SC_V6_ILP32_OFF32	176
#define _SC_V6_ILP32_OFFBIG	177
#define _SC_V6_LP64_OFF64	178
#define _SC_V6_LPBIG_OFFBIG	179
#define _SC_MEMLOCK_RANGE	18
#define _SC_HOST_NAME_MAX	180
#define _SC_TRACE	181
#define _SC_TRACE_EVENT_FILTER	182
#define _SC_TRACE_INHERIT	183
#define _SC_TRACE_LOG	184
#define _SC_MEMORY_PROTECTION	19
#define _SC_CLK_TCK	2
#define _SC_MESSAGE_PASSING	20
#define _SC_SEMAPHORES	21
#define _SC_SHARED_MEMORY_OBJECTS	22
#define _SC_AIO_LISTIO_MAX	23
#define _SC_AIO_MAX	24
#define _SC_AIO_PRIO_DELTA_MAX	25
#define _SC_DELAYTIMER_MAX	26
#define _SC_MQ_OPEN_MAX	27
#define _SC_MQ_PRIO_MAX	28
#define _SC_VERSION	29
#define _SC_NGROUPS_MAX	3
#define _SC_PAGESIZE	30
#define _SC_PAGE_SIZE	30
#define _SC_RTSIG_MAX	31
#define _SC_SEM_NSEMS_MAX	32
#define _SC_SEM_VALUE_MAX	33
#define _SC_SIGQUEUE_MAX	34
#define _SC_TIMER_MAX	35
#define _SC_BC_BASE_MAX	36
#define _SC_BC_DIM_MAX	37
#define _SC_BC_SCALE_MAX	38
#define _SC_BC_STRING_MAX	39
#define _SC_OPEN_MAX	4
#define _SC_COLL_WEIGHTS_MAX	40
#define _SC_EXPR_NEST_MAX	42
#define _SC_LINE_MAX	43
#define _SC_RE_DUP_MAX	44
#define _SC_2_VERSION	46
#define _SC_2_C_BIND	47
#define _SC_2_C_DEV	48
#define _SC_2_FORT_DEV	49
#define _SC_STREAM_MAX	5
#define _SC_2_FORT_RUN	50
#define _SC_2_SW_DEV	51
#define _SC_2_LOCALEDEF	52
#define _SC_TZNAME_MAX	6
#define _SC_IOV_MAX	60
#define _SC_THREADS	67
#define _SC_THREAD_SAFE_FUNCTIONS	68
#define _SC_GETGR_R_SIZE_MAX	69
#define _SC_JOB_CONTROL	7
#define _SC_GETPW_R_SIZE_MAX	70
#define _SC_LOGIN_NAME_MAX	71
#define _SC_TTY_NAME_MAX	72
#define _SC_THREAD_DESTRUCTOR_ITERATIONS	73
#define _SC_THREAD_KEYS_MAX	74
#define _SC_THREAD_STACK_MIN	75
#define _SC_THREAD_THREADS_MAX	76
#define _SC_THREAD_ATTR_STACKADDR	77
#define _SC_THREAD_ATTR_STACKSIZE	78
#define _SC_THREAD_PRIORITY_SCHEDULING	79
#define _SC_SAVED_IDS	8
#define _SC_THREAD_PRIO_INHERIT	80
#define _SC_THREAD_PRIO_PROTECT	81
#define _SC_THREAD_PROCESS_SHARED	82
#define _SC_ATEXIT_MAX	87
#define _SC_PASS_MAX	88
#define _SC_XOPEN_VERSION	89
#define _SC_REALTIME_SIGNALS	9
#define _SC_XOPEN_UNIX	91
#define _SC_XOPEN_CRYPT	92
#define _SC_XOPEN_ENH_I18N	93
#define _SC_XOPEN_SHM	94
#define _SC_2_CHAR_TERM	95
#define _SC_2_C_VERSION	96
#define _SC_2_UPE	97

#define _CS_PATH	0
#define _POSIX_REGEXP	1
#define _CS_XBS5_ILP32_OFF32_CFLAGS	1100
#define _CS_XBS5_ILP32_OFF32_LDFLAGS	1101
#define _CS_XBS5_ILP32_OFF32_LIBS	1102
#define _CS_XBS5_ILP32_OFF32_LINTFLAGS	1103
#define _CS_XBS5_ILP32_OFFBIG_CFLAGS	1104
#define _CS_XBS5_ILP32_OFFBIG_LDFLAGS	1105
#define _CS_XBS5_ILP32_OFFBIG_LIBS	1106
#define _CS_XBS5_ILP32_OFFBIG_LINTFLAGS	1107
#define _CS_XBS5_LP64_OFF64_CFLAGS	1108
#define _CS_XBS5_LP64_OFF64_LDFLAGS	1109
#define _CS_XBS5_LP64_OFF64_LIBS	1110
#define _CS_XBS5_LP64_OFF64_LINTFLAGS	1111
#define _CS_XBS5_LPBIG_OFFBIG_CFLAGS	1112
#define _CS_XBS5_LPBIG_OFFBIG_LDFLAGS	1113
#define _CS_XBS5_LPBIG_OFFBIG_LIBS	1114
#define _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS	1115

#define _XOPEN_REALTIME	1
#define _XOPEN_XPG4	1
#define _XOPEN_XCU_VERSION	4
#define _XOPEN_VERSION	500

#define F_ULOCK	0
#define F_LOCK	1
#define F_TLOCK	2
#define F_TEST	3

utime.h


struct utimbuf
{
  time_t actime;
  time_t modtime;
}
 ;

utmp.h


#define UT_HOSTSIZE	256
#define UT_LINESIZE	32
#define UT_NAMESIZE	32

struct exit_status
{
  short e_termination;
  short e_exit;
}
 ;

#define EMPTY	0
#define RUN_LVL	1
#define BOOT_TIME	2
#define NEW_TIME	3
#define OLD_TIME	4
#define INIT_PROCESS	5
#define LOGIN_PROCESS	6
#define USER_PROCESS	7
#define DEAD_PROCESS	8
#define ACCOUNTING	9

wchar.h


#define WEOF	(0xffffffffu)
#define WCHAR_MAX	0x7FFFFFFF
#define WCHAR_MIN	0x80000000

wctype.h


typedef unsigned long wctype_t;
typedef unsigned int wint_t;
typedef const int32_t *wctrans_t;
typedef struct
{
  int count;
  wint_t value;
}
__mbstate_t;

typedef __mbstate_t mbstate_t;

wordexp.h


enum
{
  WRDE_DOOFFS, WRDE_APPEND, WRDE_NOCMD, WRDE_REUSE, WRDE_SHOWERR, WRDE_UNDEF,
    __WRDE_FLAGS
}
 ;

typedef struct
{
  int we_wordc;
  char **we_wordv;
  int we_offs;
}
wordexp_t;

enum
{
  WRDE_NOSYS, WRDE_NOSPACE, WRDE_BADCHAR, WRDE_BADVAL, WRDE_CMDSUB,
    WRDE_SYNTAX
}
 ;

Interface Definitions for libc

Table of Contents
_IO_feof -- alias for feof
_IO_getc -- alias for getc
_IO_putc -- alias for putc
_IO_puts -- alias for puts
__assert_fail -- abort the program after false assertion
__ctype_b_loc -- accessor function for __ctype_b array for ctype functions
__ctype_get_mb_cur_max -- maximum length of a multibyte character in the current locale
__ctype_tolower_loc -- accessor function for __ctype_b_tolower array for ctype tolower() function
__ctype_toupper_loc -- accessor function for __ctype_b_toupper array for ctype toupper() function
__cxa_atexit -- register a function to be called by exit or when a shared library is unloaded
__daylight -- global variable containing daylight
__environ -- alias for environ - user environment
__errno_location -- address of errno variable
__fpending -- returns in bytes the amount of output pending on a stream
__getpagesize -- alias for getpagesize - get current page size
__getpgid -- get the process group id
__h_errno_location -- address of h_errno variable
__isinf -- test for infinity
__isinff -- test for infinity
__isinfl -- test for infinity
__isnan -- test for infinity
__isnanf -- test for infinity
__isnanl -- test for infinity
__libc_current_sigrtmax -- return number of available real-time signal with lowest priority
__libc_current_sigrtmin -- return number of available real-time signal with highest priority
__libc_start_main -- initialization routine
__lxstat -- inline wrapper around call to lxstat
__mempcpy -- copy given number of bytes of source to destination
__rawmemchr -- scan memory
__register_atfork -- alias for register_atfork
__sigsetjmp -- save stack context for non-local goto
__stpcpy -- copy a string returning a pointer to its end
__strdup -- alias for strdup
__strtod_internal -- underlying function for strtod
__strtof_internal -- underlying function for strtof
__strtok_r -- alias for strtok_r
__strtol_internal -- alias for strtol
__strtold_internal -- underlying function for strtold
__strtoll_internal -- underlying function for strtoll
__strtoul_internal -- underlying function for strtoul
__strtoull_internal -- underlying function for strtoull
__sysconf -- get configuration information at runtime
__sysv_signal -- signal handling
__timezone -- global variable containing timezone
__tzname -- global variable containing the timezone
__wcstod_internal -- underlying function for wcstod
__wcstof_internal -- underlying function for wcstof
__wcstol_internal -- underlying function for wcstol
__wcstold_internal -- underlying function for wcstold
__wcstoul_internal -- underlying function for wcstoul
__xmknod -- make block or character special file
__xstat -- provide inode information
__xstat64 -- provide inode information
_environ -- alias for environ - user environment
_nl_msg_cat_cntr -- new catalog load counter
_obstack_begin -- initialize an obstack for use
_obstack_newchunk -- allocate a new current chunk of memory for the obstack
_sys_errlist -- array containing the "C" locale strings used by strerror()
_sys_siglist -- array containing the names of the signal names
acct -- switch process accounting on or off
adjtime -- correct the time to allow synchronization of the system clock
adjtimex -- tune kernel clock (DEPRECATED)
asprintf -- write formatted output to a string dynamically allocated with malloc and store the address of the string
bind_textdomain_codeset -- specify encoding for message retrieval from message catalog for domain DOMAINNAME
bindresvport -- bind socket to privileged IP port
bindtextdomain -- specify the locale of a message catalog
cfmakeraw -- get and set terminal attributes
cfsetspeed -- set terminal input and output data rate
creat -- open a file
daemon -- run in the background
dcgettext -- perform lookup in message catalog for the current LC_MESSAGES locale
dcngettext -- perform lookup in message catalog for the current LC_MESSAGES locale
dgettext -- perform lookup in message catalog for the current LC_MESSAGES locale
dngettext -- perform lookup in message catalog for the current LC_MESSAGES locale
err -- display formatted error messages
error -- print error message
errx -- format error messages
fcntl -- file control
fflush_unlocked -- non thread safe fflush
fgetwc_unlocked -- non thread safe fgetwc
flock -- apply or remove an advisory lock on an open file
fopen -- open a file
freopen -- open a file
getdomainname -- get NIS domain name.
gethostbyname_r -- find network host database entry matching host name (DEPRECATED)
getloadavg -- get system load averages
getopt -- parse command line options
getopt_long -- parse command line options
getopt_long_only -- parse command line options
gettext -- perform lookup in message catalog for the current LC_MESSAGES locale
getutent -- access utmp file entries
getutent_r -- access utmp file entries
glob64 -- find pathnames matching a pattern (Large File Support)
globfree64 -- free memory from glob64() (Large File Support)
initgroups -- initialize the supplementary group access list
ioctl -- control device
sockio -- socket ioctl commands
iswctype -- wide character classification
kill -- send a signal
mbsnrtowcs -- convert a multibyte string to a wide character string
memmem -- locate a substring
memrchr -- scan memory for a character
ngettext -- perform lookup in message catalog for the current LC_MESSAGES locale
obstack_free -- free an object in the obstack
open -- open a file
opterr -- external variable used in getopt()
optind -- external variable used in getopt()
optopt -- external variable used in getopt()
pmap_getport -- Returns the port number on which a service is waiting for.
pmap_set -- Establishes mapping to machine's portmap service.
pmap_unset --  Destroys all mapping between the triple and ports.
psignal -- print signal message
random_r -- generate random number
setbuffer -- stream buffering operation
setdomainname -- set NIS domain name.
setgroups -- set list of supplementary group IDs
sethostid -- set the unique identifier of the current host
sethostname -- set host name
setsockopt -- set options on sockets
setutent -- access utmp file entries
sigandset -- build a new signal set by combining the two input sets using logical AND
sigblock -- manipulate the signal mask
siggetmask -- manipulate the signal mask
sigisemptyset -- check for empty signal set
sigorset -- build a new signal set by combining the two input sets using logical or
sigreturn -- return from signal handler and cleanup stack frame
stime -- set time
stpcpy -- copy a string returning a pointer to its end
stpncpy -- copy a fixed-size string, returning a pointer to its end
strcasestr -- locate a substring - ignores the case of both strings
strerror_r -- reentrant version of strerror
strfry -- randomize a string
strndup -- return a malloc'd copy of at most the specified number of bytes of a string
strnlen -- determine the length of a fixed-size string
strptime -- parse a time string
strsep -- extract token from string
strsignal -- return string describing signal
strtok_r -- extract tokens from strings
strtoq -- convert string value to a long or quad_t integer
strtouq -- convert a string to an uquad_t
strverscmp -- compare strings holding name and indices/version numbers
svc_register -- Associates program and versnum with the service dispatch procedure, dispatch.
svc_run -- Waits for RPC requests to arrive and calls service procedure.
svc_sendreply -- called by RPC service's dispatch routine
svctcp_create -- Creates a TCP/IP-based RPC service transport.
svcudp_create --  Creates a UDP-based RPC service transport.
system -- execute a shell command
textdomain -- set the current default message catalog
unlink -- remove a directory entry
vasprintf -- write formatted output to a string dynamically allocated with malloc and store the address of the string
vdprintf -- write formatted output to a file descriptor
verrx -- display formatted error messages
vsyslog -- log to system log
wait3 -- wait for child process
wait4 -- wait for process termination, BSD style
waitpid -- wait for child process
warn -- formatted error messages
warnx -- formatted error messages
wcpcpy -- copy a wide character string, returning a pointer to its end
wcpncpy -- copy a fixed-size string of wide characters, returning a pointer to its end
wcscasecmp -- compare two wide-character strings, ignoring case
wcsdup -- duplicate a wide-character string
wcsncasecmp -- compare two fixed-size wide-character strings, ignoring case
wcsnlen -- determine the length of a fixed-size wide-character string
wcsnrtombs -- convert a wide character string to a multi-byte string
wcstoq -- convert initial portion of wide string NPTR to long int representation
wcstouq -- convert initial portion of wide string NPTR to unsigned long long int representation
xdr_u_int -- library routines for external data representation

The following interfaces are included in libc and are defined by this specification. Unless otherwise noted, these interfaces shall be included in the source standard.

Other interfaces listed above for libc shall behave as described in the referenced base document.

_IO_feof

Name

_IO_feof -- alias for feof

Synopsis

int _IO_feof(_IO_FILE *__fp);

Description

_IO_feof tests the end-of-file indicator for the stream pointed to by __fp, returning a non-zero value if it is set.

_IO_feof is not in the source standard; it is only in the binary standard.

_IO_getc

Name

_IO_getc -- alias for getc

Synopsis

int _IO_getc(_IO_FILE *__fp);

Description

_IO_getc reads the next character from __fp and returns it as an unsigned char cast to an int, or EOF on end-of-file or error.

_IO_getc is not in the source standard; it is only in the binary standard.

_IO_putc

Name

_IO_putc -- alias for putc

Synopsis

int _IO_putc(int __c, _IO_FILE *__fp);

Description

_IO_putc writes the character __c, cast to an unsigned char, to __fp.

_IO_putc is not in the source standard; it is only in the binary standard.

_IO_puts

Name

_IO_puts -- alias for puts

Synopsis

int _IO_puts(const char *__c);

Description

_IO_puts writes the string __s and a trailing newline to stdout.

_IO_puts is not in the source standard; it is only in the binary standard.

__assert_fail

Name

__assert_fail -- abort the program after false assertion

Synopsis

void __assert_fail(const char *assertion, const char *file, unsigned int line, const char *function);

Description

__assert_fail receives a string containing the expression assertion, the filename file, and the line number line, and prints a message on the standard error stream. For example:

a.c:10: foobar: Assertion a == b failed.

__assert_fail then aborts program execution via a call to abort. The exact form of the message is up to the implementation.

If function is NULL, then omit information about the function.

assertion, file, and line shall be non-NULL.

__assert_fail is not in the source standard; it is only in the binary standard.

__ctype_b_loc

Name

__ctype_b_loc -- accessor function for __ctype_b array for ctype functions

Synopsis

#include <ctype.h>

extern const unsigned short int **ctype_b_loc(void);

Description

__ctype_b_loc() returns the address of the array to be used by the ctype functions. This array is locale aware, and is local to the current thread if the application is multithreaded.

__ctype_get_mb_cur_max

Name

__ctype_get_mb_cur_max -- maximum length of a multibyte character in the current locale

Synopsis

size_t __ctype_get_mb_cur_max(void);

Description

__ctype_get_mb_cur_max returns the maximum length of a multibyte character in the current locale.

__ctype_get_mb_cur_max is not in the source standard; it is only in the binary standard.

__ctype_tolower_loc

Name

__ctype_tolower_loc -- accessor function for __ctype_b_tolower array for ctype tolower() function

Synopsis

#include <ctype.h>

int32_t **__ctype_tolower_loc(void);

Description

__ctype_tolower_loc() returns the address of the array to be used by the tolower function. This array is locale aware, and is local to the current thread if the application is multithreaded.

__ctype_toupper_loc

Name

__ctype_toupper_loc -- accessor function for __ctype_b_toupper array for ctype toupper() function

Synopsis

#include <ctype.h>

int32_t **__ctype_toupper_loc(void);

Description

__ctype_toupper_loc() returns the address of the array to be used by the toupper function. This array is locale aware, and is local to the current thread if the application is multithreaded.

__cxa_atexit

Name

__cxa_atexit -- register a function to be called by exit or when a shared library is unloaded

Synopsis

int __cxa_atexit(void (*func) (void *), void *arg, void *d);

Description

__cxa_atexit registers a function to be called by exit or when a shared library is unloaded. This function is only called from code generated by the C++ compiler.

__cxa_atexit has the same specification as atexit.

__cxa_atexit is not in the source standard; it is only in the binary standard.

__daylight

Name

 -- global variable containing daylight

Synopsis

int __daylight;

__environ

Name

__environ -- alias for environ - user environment

Synopsis

extern char **__environ;

Description

__environ is an alias for environ - user environment.

__environ has the same specification as environ.

__environ is not in the source standard; it is only in the binary standard.

__errno_location

Name

__errno_location -- address of errno variable

Synopsis

int *__errno_location(void);

Description

__errno_location is not in the source standard; it is only in the binary standard.

__fpending

Name

__fpending -- returns in bytes the amount of output pending on a stream

Synopsis

#include <stdio_ext.h>

size_t __fpending(FILE *stream);

Description

__fpending returns the amount of output in bytes pending on a stream.

__fpending is not in the source standard; it is only in the binary standard.

__getpagesize

Name

__getpagesize -- alias for getpagesize - get current page size

Synopsis

extern int __getpagesize(void);

Description

__getpagesize is an alias for getpagesize - get current page size.

__getpagesize has the same specification as getpagesize.

__getpagesize is not in the source standard; it is only in the binary standard.

__getpgid

Name

__getpgid -- get the process group id

Synopsis

pid_t __getpgid(pid_t pid);

Description

__getpgid has the same specification as getpgid.

__getpgid is not in the source standard; it is only in the binary standard.

__h_errno_location

Name

__h_errno_location -- address of h_errno variable

Synopsis

int *__h_errno_location(void);

Description

__h_errno_location returns the address of the h_errno variable, where h_errno is as specified in the Single Unix Specification.

__h_errno_location is not in the source standard; it is only in the binary standard. Note that h_errno itself is only in the source standard; it is not in the binary standard.

__isinf

Name

__isinf -- test for infinity

Synopsis

int __isinf(double arg);

Description

__isinf has the same specification as isinf in the Single UNIX Specification, Version 3, except that the argument type for __isinf is known to be double.

__isinf is not in the source standard; it is only in the binary standard.

__isinff

Name

__isinff -- test for infinity

Synopsis

int __isinff(float arg);

Description

__isinff has the same specification as isinf in the Single UNIX Specification, Version 3, except that the argument type for __isinff is known to be float.

__isinff is not in the source standard; it is only in the binary standard.

__isinfl

Name

__isinfl -- test for infinity

Synopsis

int __isinfl(long double arg);

Description

__isinfl has the same specification as isinf in the Single UNIX Specification, Version 3, except that the argument type for __isinfl is known to be long double.

__isinfl is not in the source standard; it is only in the binary standard.

__isnan

Name

__isnan -- test for infinity

Synopsis

int __isnan(double arg);

Description

__isnan has the same specification as isnan in the Single UNIX Specification, Version 3, except that the argument type for __isnan is known to be double.

__isnan is not in the source standard; it is only in the binary standard.

__isnanf

Name

__isnanf -- test for infinity

Synopsis

int __isnanf(float arg);

Description

__isnanf has the same specification as isnan in the Single UNIX Specification, Version 3, except that the argument type for __isnanf is known to be float.

__isnanf is not in the source standard; it is only in the binary standard.

__isnanl

Name

__isnanl -- test for infinity

Synopsis

int __isnanl(long double arg);

Description

__isnanl has the same specification as isnan in the Single UNIX Specification, Version 3, except that the argument type for __isnanl is known to be long double.

__isnanl is not in the source standard; it is only in the binary standard.

__libc_current_sigrtmax

Name

__libc_current_sigrtmax -- return number of available real-time signal with lowest priority

Synopsis

int __libc_current_sigrtmax(void);

Description

__libc_current_sigrtmax returns the number of an available real-time signal with the lowest priority.

__libc_current_sigrtmax is not in the source standard; it is only in the binary standard.

__libc_current_sigrtmin

Name

__libc_current_sigrtmin -- return number of available real-time signal with highest priority

Synopsis

int __libc_current_sigrtmin(void);

Description

__libc_current_sigrtmin returns the number of an available real-time signal with the highest priority.

__libc_current_sigrtmin is not in the source standard; it is only in the binary standard.

__libc_start_main

Name

__libc_start_main -- initialization routine

Synopsis

BP_SYM __libc_start_main(int (*main) (int, char**, char**), int argc, char *__unbounded *__unbounded ubp_av, void (*init) (void), void (*fini) (void), void (*rtld_fini) (void), void (*__unbounded stack_end));

Description

__libc_start_main initializes glibc.

__libc_start_main is not in the source standard; it is only in the binary standard.

__lxstat

Name

__lxstat -- inline wrapper around call to lxstat

Synopsis

#include <ctype.h>

int __lxstat(int version, char *__path, (struct stat *__statbuf));

Description

__lxstat is an inline wrapper around call to lxstat.

__lxstat is not in the source standard; it is only in the binary standard.

__mempcpy

Name

__mempcpy -- copy given number of bytes of source to destination

Synopsis

#include <string.h>

extern ptr_t __mempcpy(ptr_t restrict dest, const ptr_t restrict src, size_t n);

Description

__mempcpy copies n bytes of source to destination, returning pointer to bytes after the last written byte.

__mempcpy is not in the source standard; it is only in the binary standard.

__rawmemchr

Name

__rawmemchr -- scan memory

Synopsis

#include <string.h>

extern ptr_t __rawmemchr(const ptr_t s, int c);

Description

__rawmemchr searches in s for c.

__rawmemchr is a weak alias to rawmemchr. It is similar to memchr, but it has no length limit.

__rawmemchr is not in the source standard; it is only in the binary standard.

__register_atfork

Name

__register_atfork -- alias for register_atfork

Synopsis

int __register_atfork(void (*prepare)(), void (*parent)(), void (*child)(), void *__dso_handle);

Description

__register_atfork implements pthread_atfork as specified in ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3. The additional parameter __dso_handle allows a shared object to pass in it's handle so that functions registered by __register_atfork can be unregistered by the runtime when the shared object is unloaded.

__sigsetjmp

Name

__sigsetjmp -- save stack context for non-local goto

Synopsis

int __sigsetjmp(jmp_buf env, int savemask);

Description

__sigsetjmp has the same behavior as sigsetjmp as specified by the Single UNIX Specification, Version 2.

__sigsetjmp is not in the source standard; it is only in the binary standard.

__stpcpy

Name

__stpcpy -- copy a string returning a pointer to its end

Synopsis

#include <string.h>

char *__stpcpy(char *dest, const char *src);

Description

__stpcpy copies the string src (including the terminating /0 character) to the array dest. The strings may not overlap, and dest must be large enough to receive the copy.

Return Value

__stpcpy returns a pointer to the end of the string dest (that is, the address of the terminating NULL character) rather than the beginning.

__stpcpy has the same specification as stpcpy.

__stpcpy is not in the source standard; it is only in the binary standard.

__strdup

Name

__strdup -- alias for strdup

Synopsis

char *__strdup(const char string);

Description

__strdup has the same specification as strdup.

__strdup is not in the source standard; it is only in the binary standard.

__strtod_internal

Name

__strtod_internal -- underlying function for strtod

Synopsis

double __strtod_internal(const char *__nptr, char **__endptr, int __group);

Description

__group shall be 0 or the behavior of __strtod_internal is undefined.

__strtod_internal(__nptr, __endptr, 0) has the same specification as strtod(__nptr, __endptr).

__strtod_internal is not in the source standard; it is only in the binary standard.

__strtof_internal

Name

__strtof_internal -- underlying function for strtof

Synopsis

float __strtof_internal(const char *__nptr, char **__endptr, int __group);

Description

__group shall be 0 or the behavior of __strtof_internal is undefined.

__strtof_internal(__nptr, __endptr, 0) has the same specification as strtof(__nptr, __endptr).

__strtof_internal is not in the source standard; it is only in the binary standard.

__strtok_r

Name

__strtok_r -- alias for strtok_r

Synopsis

char *__strtok_r(char *__restrict s, __const char *__restrict delim, char **__restrict save_ptr);

Description

__strtok_r has the same specification as strtok_r.

__strtok_r is not in the source standard; it is only in the binary standard.

__strtol_internal

Name

__strtol_internal -- alias for strtol

Synopsis

long int __strtol_internal(const char *__nptr, char **__endptr, int __base, int __group);

Description

__group shall be 0 or the behavior of __strtol_internal is undefined.

__strtol_internal(__nptr, __endptr, __base, 0) has the same specification as strtol(__nptr, __endptr, __base).

__strtol_internal is not in the source standard; it is only in the binary standard.

__strtold_internal

Name

__strtold_internal -- underlying function for strtold

Synopsis

long double __strtold_internal(const char *__nptr, char **__endptr, int __group);

Description

__group shall be 0 or the behavior of __strtold_internal is undefined.

__strtold_internal(__nptr, __endptr, 0) has the same specification as strtold(__nptr, __endptr).

__strtold_internal is not in the source standard; it is only in the binary standard.

__strtoll_internal

Name

__strtoll_internal -- underlying function for strtoll

Synopsis

long long __strtoll_internal(const char *__nptr, char **__endptr, int __base, int __group);

Description

__group shall be 0 or the behavior of __strtoll_internal is undefined.

__strtoll_internal(__nptr, __endptr, __base, 0) has the same specification as strtoll(__nptr, __endptr, __base).

__strtoll_internal is not in the source standard; it is only in the binary standard.

__strtoul_internal

Name

__strtoul_internal -- underlying function for strtoul

Synopsis

unsigned long int __strtoul_internal(const char *__nptr, char **__endptr, int __base, int __group);

Description

__group shall be 0 or the behavior of __strtoul_internal is undefined.

__strtoul_internal(__nptr, __endptr, __base, 0) has the same specification as strtoul(__nptr, __endptr, __base).

__strtoul_internal is not in the source standard; it is only in the binary standard.

__strtoull_internal

Name

__strtoull_internal -- underlying function for strtoull

Synopsis

unsigned long long __strtoull_internal(const char *__nptr, char **__endptr, int __base, int __group);

Description

__group shall be 0 or the behavior of __strtoull_internal is undefined.

__strtoull_internal(__nptr, __endptr, __base, 0) has the same specification as strtoull(__nptr, __endptr, __base).

__strtoull_internal is not in the source standard; it is only in the binary standard.

__sysconf

Name

__sysconf -- get configuration information at runtime

Synopsis

#include <unistd.h>

long __sysconf(int name);

Description

__sysconf gets configuration information at runtime.

__sysconf is weak alias to sysconf.

__sysconf has the same specification as sysconf.

__sysconf is not in the source standard; it is only in the binary standard.

__sysv_signal

Name

__sysv_signal -- signal handling

Synopsis

__sighandler_t __sysv_signal(int sig, __sighandler_t handler);

Description

__sysv_signal has the same behavior as signal as specified by X/Open.

__sysv_signal is not in the source standard; it is only in the binary standard.

__timezone

Name

 -- global variable containing timezone

Synopsis

long int __timezone;

Description

__timezone has the same specification as timezone in the Single UNIX Specification.

__tzname

Name

 -- global variable containing the timezone

Synopsis

char *__tzname[2];

Description

__tzname has the same specification as tzname in the Single UNIX Specification.

Note that the array size of 2 is explicit in the Single UNIX Specification, Version 3, but not in the Single UNIX Specification, Version 2.

__wcstod_internal

Name

__wcstod_internal -- underlying function for wcstod

Synopsis

double __wcstod_internal(const wchar_t *nptr, wchar_t **endptr, int group);

Description

group shall be 0 or the behavior of __wcstod_internal is undefined.

__wcstod_internal(nptr, endptr, 0) has the same specification as wcstod(nptr, endptr).

__wcstod_internal is not in the source standard; it is only in the binary standard.

__wcstof_internal

Name

__wcstof_internal -- underlying function for wcstof

Synopsis

float __wcstof_internal(const wchar_t *nptr, wchar_t **endptr, int group);

Description

group shall be 0 or the behavior of __wcstof_internal is undefined.

__wcstof_internal(nptr, endptr, 0) has the same specification as wcstof(nptr, endptr).

__wcstof_internal is not in the source standard; it is only in the binary standard.

__wcstol_internal

Name

__wcstol_internal -- underlying function for wcstol

Synopsis

long __wcstol_internal(const wchar_t *nptr, wchar_t **endptr, int base, int group);

Description

group shall be 0 or the behavior of __wcstol_internal is undefined.

__wcstol_internal(nptr, endptr, base, 0) has the same specification as wcstol(nptr, endptr, base).

__wcstol_internal is not in the source standard; it is only in the binary standard.

__wcstold_internal

Name

__wcstold_internal -- underlying function for wcstold

Synopsis

long double __wcstold_internal(const wchar_t *nptr, wchar_t **endptr, int group);

Description

group shall be 0 or the behavior of __wcstold_internal is undefined.

__wcstold_internal(nptr, endptr, 0) has the same specification as wcstold(nptr, endptr).

__wcstold_internal is not in the source standard; it is only in the binary standard.

__wcstoul_internal

Name

__wcstoul_internal -- underlying function for wcstoul

Synopsis

unsigned long __wcstoul_internal(const wchar_t *restrict nptr, wchar_t **restrict endptr, int base, int group);

Description

group shall be 0 or the behavior of __wcstoul_internal is undefined.

__wcstoul_internal(nptr, endptr, base, 0) has the same specification as wcstoul(nptr, endptr, base).

__wcstoul_internal is not in the source standard; it is only in the binary standard.

__xmknod

Name

__xmknod -- make block or character special file

Synopsis

int __xmknod(int ver, __const char *path, __mode_t mode, __dev_t *dev);

Description

ver shall be 1 or the behavior of __xmknod is undefined.

__xmknod(1, path, mode, dev) has the same specification as mknod(path, mode, dev).

Note that the format of dev_t is not the same as the argument that the kernel syscall uses.

__xmknod is not in the source standard; it is only in the binary standard.

__xstat

Name

__xstat -- provide inode information

Synopsis

#include <sys/stat.h>
#include <unistd.h>

int __xstat(int __ver, const char *__filename, (struct stat *__stat_buf));

int __lxstat(int __ver, const char *__filename, (struct stat *__stat_buf));

int __fxstat(int __ver, int __filedesc, (struct stat *__stat_buf));

Description

__ver shall be 3 or the behavior of these functions is undefined.

__filename is as specified in POSIX.

__filedesc is as specified in POSIX.

__stat_buf is as specified in POSIX.

__xstat(3, __filename, __stat_buf) has the same specification as stat(__filename, __stat_buf) as specified by POSIX.

__lxstat(3, __filename, __stat_buf) has the same specification as lstat(__filename, __stat_buf) as specified by POSIX.

__fxstat(3, __filedesc, __stat_buf) has the same specification as fstat(__filedesc, __stat_buf) as specified by POSIX.

Note that the struct stat used by these functions is not the one that the kernel uses.

__xstat, __lxstat, and __fxstat are not in the source standard; they are only in the binary standard.

stat, lstat, and fstat are not in the binary standard; they are only in the source standard.

__xstat64

Name

__xstat64 -- provide inode information

Synopsis

#define _LARGEFILE_SOURCE 1
#include <sys/stat.h>
#include <unistd.h>

int __xstat64(int __ver, const char *__filename, (struct stat64 *__stat_buf));

int __lxstat64(int __ver, const char *__filename, (struct stat64 *__stat_buf));

int __fxstat64(int __ver, int __filedesc, (struct stat64 *__stat_buf));

Description

__ver shall be 3 or the behavior of these functions is undefined.

__filename is as specified by the Large File Summit.

__filedesc is as specified by the Large File Summit.

__stat_buf is as specified by the Large File Summit.

__xstat64(3, __filename, __stat_buf) has the same specification as stat64(__filename, __stat_buf) as specified by the Large File Summit.

__lxstat64(3, __filename, __stat_buf) has the same specification as lstat64(__filename, __stat_buf) as specified by the Large File Summit.

__fxstat64(3, __filedesc, __stat_buf) has the same specification as fstat64(__filedesc, __stat_buf) as specified by the Large File Summit.

__xstat64, __lxstat64, and __fxstat64 are not in the source standard; they are only in the binary standard.

stat64, lstat64, and fstat64 are not in the binary standard; they are only in the source standard.

_environ

Name

_environ -- alias for environ - user environment

Synopsis

extern char **_environ;

Description

_environ is an alias for environ - user environment.

_nl_msg_cat_cntr

Name

_nl_msg_cat_cntr -- new catalog load counter

Synopsis

#include <libintl.h>

extern int _nl_msg_cat_cntr;

Description

_nl_msg_cat_cntr is incremented each time a new catalong is loaded. It is a variable defined in loadmsgcat.c and is used by Message catalogs for internationalization.

_obstack_begin

Name

_obstack_begin -- initialize an obstack for use

Synopsis

#include <obstack.h>

extern int _obstack_begin(struct obstack *, int, int, void *(*) (long), void (*) (void *));

Description

_obstack_begin initializes an obstack for use.

_obstack_newchunk

Name

_obstack_newchunk -- allocate a new current chunk of memory for the obstack

Synopsis

#include <obstack.h>

extern void _obstack_newchunk(struct obstack *, int);

Description

_obstack_newchunk allocates a new current chunk of memory for the obstack.

_sys_errlist

Name

_sys_errlist -- array containing the "C" locale strings used by strerror()

Synopsis

#include <stdio.h>

extern const char *const _sys_errlist[];

Description

_sys_errlist is an array containing the "C" locale strings used by strerror. This normally should not be used directly. strerror provides all of the needed functionality.

_sys_siglist

Name

_sys_siglist -- array containing the names of the signal names

Synopsis

#include <signal.h>

extern const char *const _sys_siglist[NSIG];

Description

_sys_siglist is an array containing the names of the signal names.

_sys_siglist exists only for compatibility; use strsignal instead. (See string.h).

acct

Name

acct -- switch process accounting on or off

Synopsis

#include <dirent.h>

int acct(const char *filename);

Description

When filename is the name of an existing file, acct turns accounting on and appends a record to filename for each terminating process. When filename is NULL, acct turns accounting off.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

Errors

ENOSYS

BSD process accounting has not been enabled when the operating system kernel was compiled. The kernel configuration parameter controlling this feature is CONFIG_BSD_PROCESS_ACCT.

ENOMEM

Out of memory.

EPERM

The calling process has no permission to enable process accounting.

EACCES

filename is not a regular file.

EIO

Error writing to the filename.

EUSERS

There are no more free file structures or we run out of memory.

adjtime

Name

adjtime -- correct the time to allow synchronization of the system clock

Synopsis

#include <time.h>

int adjtime((const struct timeval *delta), (struct timeval *olddelta));

Description

adjtime makes small adjustments to the system time as returned by gettimeofday(2), advancing or retarding it by the time specified by the timeval delta. If delta is negative, the clock is slowed down by incrementing it more slowly than normal until the correction is complete. If delta is positive, a larger increment than normal is used. The skew used to perform the correction is generally a fraction of one percent. Thus, the time is always a monotonically increasing function. A time correction from an earlier call to adjtime may not be finished when adjtime is called again. If olddelta is non-NULL, the structure pointed to will contain, upon return, the number of microseconds still to be corrected from the earlier call.

adjtime may be used by time servers that synchronize the clocks of computers in a local area network. Such time servers would slow down the clocks of some machines and speed up the clocks of others to bring them to the average network time.

The adjtime is restricted to the super-user.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

Errors

EFAULT

An argument points outside the process's allocated address space.

EPERM

The process's effective user ID is not that of the super-user.

adjtimex

Name

adjtimex -- tune kernel clock (DEPRECATED)

Synopsis

#include <sys/timex.h>

int adjtimex((struct timex *buf));

Description

The adjtimex function is deprecated from the LSB and is expected to disappear from a future version of the LSB. [1]

Linux uses David L. Mills' clock adjustment algorithm (see RFC 1305). adjtimex reads and optionally sets adjustment parameters for this algorithm. adjtimex takes a pointer to a timex structure, updates kernel parameters from field values, and returns the same structure with current kernel values. This structure is declared as follows:
  struct timex {
            int  modes;          /* mode selector */
            long offset;         /* time offset (usec) */
            long freq;           /* frequency offset (scaled ppm) */
            long maxerror;       /* maximum error (usec) */
            long esterror;       /* estimated error (usec) */
            int  status;         /* clock command/status */
            long constant;       /* pll time constant */
            long precision;      /* clock precision (usec) (read only) */
            long tolerance;      /* clock frequency tolerance (ppm)
                                          (read only) */
            struct timeval time; /* current time (read only) */
            long tick;           /* usecs between clock ticks */
  };

modes determines which parameters, if any, to set. modes may contain a bitwise-or combination of zero or more of the following bits:
  #define ADJ_OFFSET            0x0001  /* time offset */
  #define ADJ_FREQUENCY         0x0002  /* frequency offset */
  #define ADJ_MAXERROR          0x0004  /* maximum time error */
  #define ADJ_ESTERROR          0x0008  /* estimated time error */
  #define ADJ_STATUS            0x0010  /* clock status */
  #define ADJ_TIMECONST         0x0020  /* pll time constant */
  #define ADJ_TICK              0x4000  /* tick value */
  #define ADJ_OFFSET_SINGLESHOT 0x8001  /* old-fashioned adjtime */

Ordinary users are restricted to a 0 value for modes. Only the superuser may set any parameters.

Return Value

On success, adjtimex returns the clock state:
  #define TIME_OK   0  /* clock synchronized */
  #define TIME_INS  1  /* insert leap second */
  #define TIME_DEL  2  /* delete leap second */
  #define TIME_OOP  3  /* leap second in progress */
  #define TIME_WAIT 4  /* leap second has occurred */
  #define TIME_BAD  5  /* clock not synchronized */

On error, the global variable errno is set to -1.

Errors

EFAULT

buf does not point to writable memory.

EPERM

buf.mode is nonzero and the user is not super-user.

EINVAL

An attempt is made to set buf.offset to a value outside of the range -131071 to +131071, or to set buf.status to a value other than those listed above, or to set buf.tick to a value outside of the range 900000/HZ to 1100000/HZ, where HZ is the system timer interrupt frequency.

asprintf

Name

asprintf -- write formatted output to a string dynamically allocated with malloc and store the address of the string

Synopsis

#include <stdio.h>

extern int asprintf(char **restrict ptr, const char *restrict format ...);

Description

asprintf has the same behavior as sprintf, but calls malloc to dynamically allocate space for the output, and then puts the output string in that space.

asprintf stores the address of the string in ptr.

bind_textdomain_codeset

Name

bind_textdomain_codeset -- specify encoding for message retrieval from message catalog for domain DOMAINNAME

Synopsis

#include <libintl.h>

extern char *bind_textdomain_codeset(const char *domainname, const char *codeset);

Description

The bind_textdomain_codeset function can be used to specify the output codeset for message catalogs for domain domainname. The codeset argument shall be a valid codeset name which can be used tor the iconv_open() funtion, or a null pointer. If the codeset argument is the null pointer, then function returns the currently selected codeset for the domain with the name domainname. It returns null pointer if no codeset has yet been selected

The bind_textdomain_codeset function can be used several times. If used multiple times, with the same domainname argument, the later call overrrides the settings made by the earlier one.

The bind_textdomain_codeset function returns a pointer to a string containing the name of the selected codeset. The string is allocated internally in the function and shall not be changed by the user.

Parameters

domainname

The domainname argument is applied to the currenlty active LC_MESSAGE locale. It is equivalent in syntax and meaning to the domainname argument to textdomain(), except that the selection of the domain is valid only for the duration of the call.

Return

Returns the currently selected codeset name. It returns null pointer if no codeset has yet been selected.

Errors

The function is not required to set the external errno variable.

See Also

gettext, dgettext, ngettext, dngettext, dcgettext, dcngettext, textdomain, bindtextdomain, bind_textdomain_codeset

bindresvport

Name

bindresvport -- bind socket to privileged IP port

Synopsis

#include <sys/types.h>
#include <rpc.rpc.h>

int bindresvport(int sd, struct sockaddr_in *sin);

Description

bindresvport binds a socket to a privileged IP port. This function can be used only by root.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

Errors

EPFNOSUPPORT

Address of sin did not match address family of sd.

bindtextdomain

Name

bindtextdomain -- specify the locale of a message catalog

Synopsis

#include <libintl.h>

extern char *bindtextdomain(const char *domainname, const char *dirname);

Description

bindtextdomain specifies that the domainname message catalog can be found in the dirname directory hierarchy, rather than in the system locale data base.

bindtextdomain applies domainname to the currently active LC_MESSAGE locale. This usage is equivalent in syntax and meaning to the textdomain function's application of domainname, except that the selection of the domain in bind_textdomain_codeset is valid only for the duration of the call.

dirname can be an absolute or relative pathname.

On success, bindtextdomain returns the directory pathname currently bound to the domain. On failure, a NULL pointer is returned.

See Also

gettext, dgettext, ngettext, dngettext, dcgettext, dcngettext, textdomain, bindtextdomain, bind_textdomain_codeset

cfmakeraw

Name

cfmakeraw -- get and set terminal attributes

Synopsis

#include <termios.h>

void cfmakeraw(struct termios *termios_p);

Description

The cfmakeraw() function shall set the attributes of the termios structure referenced by termios_p as follows:
  termios_p->c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
                          |INLCR|IGNCR|ICRNL|IXON);

  termios_p->c_oflag &= ~OPOST;

  termios_p->c_lflag &= ~(ECHO|ECHONL|ICANON|ISIG|IEXTEN);

  termios_p->c_cflag &= ~(CSIZE|PARENB);

  termios_p->c_cflag |= CS8;

termios_p shall point to a termios structure that contains the following members:
  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 chars */

cfsetspeed

Name

cfsetspeed -- set terminal input and output data rate

Synopsis

#include <termios.h>

int cfsetspeed(struct termios *t, speedt speed);

Description

cfsetspeed sets the baud rate values in the termios structure. The effects of the function on the terminal as described below do not become effective, nor are all errors detected, until the tcsetattr function is called. Certain values for baud rates set in termios and passed to tcsetattr have special meanings.

Getting and Setting the Baud Rate

Input and output baud rates are found in the termios structure. The unsigned integer speed_t is typdef'd in the include file termios.h. The value of the integer corresponds directly to the baud rate being represented; however, the following symbolic values are defined.
  #define B0      0
  #define B50     50
  #define B75     75
  #define B110    110
  #define B134    134
  #define B150    150
  #define B200    200
  #define B300    300
  #define B600    600
  #define B1200   1200
  #define B1800   1800
  #define B2400   2400
  #define B4800   4800
  #define B9600   9600
  #define B19200  19200
  #define B38400  38400
  #ifndef _POSIX_SOURCE
  #define EXTA    19200
  #define EXTB    38400
  #endif  /*_POSIX_SOURCE */

cfsetspeed sets both the input and output baud rates in the termios structure referenced by t to speed.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

Errors

EINVAL

Invalid speed argument

creat

Name

creat -- open a file

Description

creat is as specified in the Single UNIX Specification, but with differences as listed below.

May return ENODEV in place of ENXIO

Where the Single UNIX Specification specifies an ENXIO return, the implementation may return either ENXIO or ENODEV. Implementations are encouarged to return ENXIO. [2]

daemon

Name

daemon -- run in the background

Synopsis

#include <unistd.h>

int daemon(int nochdir, int noclose);

Description

daemon allows programs to detach from the controlling terminal and run in the background as system daemons. Unless nochdir is nonzero, daemon changes the current working directory to the root (`/'). Unless noclose is non-zero, daemon will redirect standard input, standard output and standard error to /dev/null.

Return Value

On error, -1 is returned, and the global variable errno is set to any of the errors specified for the library functions fork(2) and setsid(2).

dcgettext

Name

dcgettext -- perform lookup in message catalog for the current LC_MESSAGES locale

Synopsis

#include <libintl.h>
#include <locale.h>

extern char *dcgettext(const char *domainname, const char *msgid, int category);

Description

dcgettext is a domain specified version of gettext.

Parameters

domainname

dcgettext applies domainname to the currently active LC_MESSAGE locale. This usage is equivalent in syntax and meaning to the textdomain function's application of domainname, except that the selection of the domain in dcgettext is valid only for the duration of the call.

msgid

a NULL-terminated string to be matched in the catalogue with respect to a specific domain and the current locale.

category

category is used for retrieving messages string for other than LC_MESSAGES category. Available value for category are LC_CTYPE, LC_COLLATE, LC_MESSAGES, LC_MONETARY,LC_NUMERIC, and LC_TIME.

dcgettext(domainname, msgid, LC_MESSAGES) has the same specification as dgettext(domainname, msgid). Note that LC_ALL shall not be used.

Return Value

On success, the translated NULL-terminated string is returned. On error, msgid is returned.

Errors

dcgettext will not modify the errno global variable.

See Also

gettext, dgettext, ngettext, dngettext, dcgettext, dcngettext, textdomain, bindtextdomain, bind_textdomain_codeset

dcngettext

Name

dcngettext -- perform lookup in message catalog for the current LC_MESSAGES locale

Synopsis

#include <libintl.h>
#include <locale.h>

extern char *dcngettext(const char *domainname, const char *msgid1, const char *msgid2, unsigned long int n, int category);

Description

dcngettext is a plural version of dcgettext. (See dcgettext for more information.)

Parameters

domainname

dcngettext applies domainname to the currently active LC_MESSAGE locale. This usage is equivalent in syntax and meaning to the textdomain function's application of domainname, except that the selection of the domain in dcngettext is valid only for the duration of the call.

msgid1

a NULL-terminated string to be matched in the catalogue with respect to a specific domain and the current locale. If the value of n is 1 and no message catalogs containing a translation for msgid1 are found, msgid1 is returned.

msgid2

a NULL-terminated string to be returned if the value of n is not 1 and no message catalogs are found.

n

determines which plural form is returned, in a language and message catalog dependent way.

category

category is used for retrieving messages string for other than LC_MESSAGES category. Available value for category are LC_CTYPE, LC_COLLATE, LC_MESSAGES, LC_MONETARY,LC_NUMERIC, and LC_TIME.

dcngettext(domainname, msgid1, msgid2, n, LC_MESSAGES) has the same specification as dngettext(domainname, msgid1, msgid2, n). Note that LC_ALL shall not be used.

Return Value

On success of a msgid1 query, the translated NULL-terminated string is returned. On error, the original msgid1 or msgid2 is returned, according to n.

Errors

dcngettext will not modify the errno global variable.

See Also

gettext, dgettext, ngettext, dngettext, dcgettext, dcngettext, textdomain, bindtextdomain, bind_textdomain_codeset

dgettext

Name

dgettext -- perform lookup in message catalog for the current LC_MESSAGES locale

Synopsis

#include <libintl.h>

extern char *dgettext(const char *domainname, const char *msgid);

Description

dgettext is a domain specified version of gettext.

Parameters

domainname

dgettext applies domainname to the currently active LC_MESSAGE locale. This usage is equivalent in syntax and meaning to the textdomain function's application of domainname, except that the selection of the domain in dgettext is valid only for the duration of the call.

msgid

a NULL-terminated string to be matched in the catalogue with respect to a specific domain and the current locale.

Return Value

On success of a msgid query, the translated NULL-terminated string is returned. On error, the original msgid is returned. The length of the string returned is undetermined until dgettext is called.

Errors

dgettext will not modify the errno global variable.

See Also

gettext, dgettext, ngettext, dngettext, dcgettext, dcngettext, textdomain, bindtextdomain, bind_textdomain_codeset

dngettext

Name

dngettext -- perform lookup in message catalog for the current LC_MESSAGES locale

Synopsis

#include <libintl.h>

extern char *dngettext(const char *domainname, const char *msgid1, const char *msgid2, unsigned long int n);

Description

dngettext is a plural version of dgettext. (See dgettext for more information.)

Parameters

domainname

dngettext applies domainname to the currently active LC_MESSAGE locale. This usage is equivalent in syntax and meaning to the textdomain function's application of domainname, except that the selection of the domain in dngettext is valid only for the duration of the call.

msgid1

a NULL-terminated string to be matched in the catalogue with respect to a specific domain and the current locale. If the value of n is 1 and no message catalogs containing a translation for msgid1 are found, msgid1 is returned.

msgid2

a NULL-terminated string to be returned if the value of n is not 1 and no message catalogs are found.

n

determines which plural form is returned, in a language and message catalog dependent way.

Return Value

On success of a msgid1 query, the translated NULL-terminated string is returned. On error, the original msgid1 or msgid2 is returned, according to n.

Errors

dcngettext will not modify the errno global variable.

See Also

gettext, dgettext, ngettext, dngettext, dcgettext, dcngettext, textdomain, bindtextdomain, bind_textdomain_codeset

err

Name

err -- display formatted error messages

Synopsis

#include <err.h>

void err(int eval, const char *fmt ...);

Description

err displays a formatted error message on the standard error output. The last component of the program name, a colon character, and a space are output. If fmt is non-NULL, the formatted error message, a colon character, and a space are output. The error message string affiliated with the current value of the global variable errno is output. The output is followed by a newline character.

err does not return, but exits with the value of eval.

error

Name

error -- print error message

Synopsis

void error(int exitstatus, int errnum, const char *format ...);

Description

error prints a message to standard error.

error builds the message from the following elements in their specified order:

  1. the program name. If the application has provided a function named error_print_progname, error calls this to supply the program name; otherwise, error uses the content of the global variable program_name.

  2. the colon and space characters, then the result of using the printf-style format and the optional arguments.

  3. if errnum is nonzero, error adds the colon and space characters, then the result of strerror(errnum).

  4. a newline.

If exitstatus is nonzero, error calls exit(exitstatus).

errx

Name

errx -- format error messages

Synopsis

#include <err.h>

void errx(int eval, const char *fmt ...);

Description

errx displays a formatted error message on the standard error output. The last component of the program name, a colon character, and a space are output. If fmt is non-NULL, the formatted error message, a colon character, and a space are output. The output is followed by a newline character.

errx does not return, but exits with the value of eval.

fcntl

Name

fcntl -- file control

Description

fcntl is as specified in the Single UNIX Specification, Version 3, but with differences as listed below.

Implementation may set O_LARGEFILE

According to the Single UNIX Specification, only an application sets fcntl flags, for example O_LARGEFILE. However, this specification also allows implementations to set O_LARGEFILE in a case in which the default behavior matches the O_LARGEFILE behavior. [3] Or in other words, calling fcntl with the F_GETFL command may return O_LARGEFILE as well as flags explicitly set by the application.

fflush_unlocked

Name

fflush_unlocked -- non thread safe fflush

Description

fflush_unlocked is the same as fflush except that it need not be thread safe. That is, it may only be invoked in the ways which are legal for getc_unlocked.

fgetwc_unlocked

Name

fgetwc_unlocked -- non thread safe fgetwc

Description

fgetwc_unlocked is the same as fgetwc except that it need not be thread safe. That is, it may only be invoked in the ways which are legal for getc_unlocked.

flock

Name

flock -- apply or remove an advisory lock on an open file

Synopsis

int flock(int fd, int operation);

Description

flock applies or removes an advisory lock on the open file fd. Valid operation types are:

LOCK_SH

Shared lock. More than one process may hold a shared lock for a given file at a given time.

LOCK_EX

Exclusive lock. Only one process may hold an exclusive lock for a given file at a given time.

LOCK_UN

Unlock.

LOCK_NB

Don't block when locking. May be specified (by oring) along with one of the other operations.

A single file may not simultaneously have both shared and exclusive locks.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

Errors

EWOULDBLOCK

The file is locked and the LOCK_NB flag was selected.

fopen

Name

fopen -- open a file

Description

fopen is as specified in the Single UNIX Specification, but with differences as listed below.

May return ENODEV in place of ENXIO

Where the Single UNIX Specification specifies an ENXIO return, the implementation may return either ENXIO or ENODEV. Implementations are encouarged to return ENXIO. [4]

freopen

Name

freopen -- open a file

Description

freopen is as specified in the Single UNIX Specification, but with differences as listed below.

May return ENODEV in place of ENXIO

Where the Single UNIX Specification specifies an ENXIO return, the implementation may return either ENXIO or ENODEV. Implementations are encouarged to return ENXIO. [5]

getdomainname

Name

getdomainname -- get NIS domain name.

Synopsis

#include <unistd.h>

extern int getdomainname(char *name, size_t namelen);

Description

If NIS is in use, provide the NIS domain name. Note that this is not the same as the domain name which provides the domain portion of a fully qualified domain name (for example, in DNS). If NIS is not in use, provide the string "(none)".

If the string which is provided is strictly less than namelen characters in length, getdomainname places it in the array pointed to by name followed by a terminating null character. If not, getdomainname may either truncate it to namelen characters and place it in name (without a terminating null character), or may fail with EINVAL.

Return Value

getdomainname returns 0 if successful; -1 if not (in which case errno is set to indicate the error).

gethostbyname_r

Name

gethostbyname_r -- find network host database entry matching host name (DEPRECATED)

Synopsis

extern int gethostbyname_r(__const char *__restrict __name, (struct hostent *__restrict __result_buf), char *__restrict __buf, size_t __buflen, (struct hostent **__restrict __result), int *__restrict __h_errnop);

Description

The gethostbyname_r function is deprecated; applications should call getaddrinfo instead.

gethostbyname_r is a reentrant version of gethostbyname that searches the network host database for a host name match.

getloadavg

Name

getloadavg -- get system load averages

Synopsis

#include <stdlib.h>

int getloadavg(double loadavg[], int nelem);

Description

getloadavg returns the number of processes in the system run queue averaged over various periods of time. Up to nelem samples are retrieved and assigned to successive elements of loadavg[]. The system imposes a maximum of 3 samples, representing averages over the last 1, 5, and 15 minutes, respectively.

getopt

Name

getopt -- parse command line options

Synopsis

int getopt(int argc, char * const argv[], const char *opstring);

extern char *optarg;
extern int optind, opterr, optopt;

Description

getopt parses command line arguments. GNU and POSIX specifications for this function vary in the following areas. LSB systems shall implement the GNU behaviors described below.

Option Characteristics

GNU specifies that:

  • an element of argv that starts with "-" (and is not exactly "-" or "--") is an option element.

  • characters of an option element, aside from the initial "-", are option characters.

POSIX specifies that:

  • applications using getopt shall obey the following syntax guidelines:

    • option name is a single alphanumeric character from the portable character set

    • option is preceded by the "-" delimiter character

    • options without option-arguments should be accepted when grouped behind one "-" delimiter

    • each option and option-argument is a separate argument

    • option-arguments are not optional

    • all options should precede operands on the command line

    • the argument "--" is accepted as a delimiter indicating the end of options and the consideration of subsequent arguments, if any, as operands

  • historical implementations of getopt support other characters as options as an allowed extension, but applications that use extensions are not maximally portable.

  • support for multi-byte option characters is only possible when such characters can be represented as type int.

  • applications that call any utility with a first operand starting with "-" should usually specify "--" to mark the end of the options. Standard utilities that do not support this guideline indicate that fact in the OPTIONS section of the utility description.

Extensions

GNU specifies that:

  • if a character is followed by two colons, the option takes an optional arg; if there is text in the current argv element, it is returned in optarg, otherwise optarg is set to 0.

  • if optstring contains W followed by a ;, then -W foo is treated as the long option --foo. (Not available with libraries before GNU libc 2.)

POSIX specifies that:

  • the -W option is reserved for implementation extensions.

Return Values

GNU specifies the following getopt return values:

  • the next option character is returned, if found successfully.

  • ":" is returned if a parameter is missing for one of the options.

  • "?" is returned if an unknown option character is encountered.

  • -1 is returned for the end of the option list.

POSIX specifies the following getopt return values:

  • the next option character is returned, if found successfully.

  • ":" is returned if a parameter is missing for one of the options and the first character of opstring is ":".

  • "?" is returned if an unknown option character not in optstring is encountered, or if getopt detects a missing argument and the first character of optstring is not ":".

  • -1 is returned for the end of the option list.

Environment Variables

GNU specifies that:

  • if the variable POSIXLY_CORRECT is set, option processing stops as soon as a non-option argument is encountered.

  • if POSIXLY_CORRECT is set, GNU getopt conforms to ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3.

  • the variable _[PID]_GNU_nonoption_argv_flags_ was used by bash 2.0 to communicate to GNU libc which arguments resulted from wildcard expansion and so should not be considered as options. This behavior was removed in bash version 2.01, but the support remains in GNU libc.

getopt_long

Name

getopt_long -- parse command line options

Synopsis

#define _GNU_SOURCE
#include <getopt.h>

int getopt_long(int argc, char * const argv[], const char *opstring, (const struct option *longopts), int *longindex);

Description

getopt_long works like getopt except that it also accepts long options, started out by two dashes. Long option names may be abbreviated if the abbreviation is unique or is an exact match for some defined option. A long option may take a parameter, of the form --arg=param or --arg param.

longopts is a pointer to the first element of an array of struct option declared in getopt.h as:
  struct option {
             const char *name;
             int *flag;
             int has_arg;
             int val;
  };

Return Value

getopt_long returns the option character if the option was found successfully, or ":" if there was a missing parameter for one of the options, or "?" for an unknown option character, or -1 for the end of the option list.

getopt_long also returns the option character when a short option is recognized. For a long option, they return val if flag is NULL, and 0 otherwise. Error and -1 returns are the same as for getopt, plus "?" for an ambiguous match or an extraneous parameter.

getopt_long_only

Name

getopt_long_only -- parse command line options

Synopsis

#define _GNU_SOURCE
#include <getopt.h>

int getopt_long_only(int argc, char * const argv[], const char *opstring, (const struct option *longopts), int *longindex);

Description

getopt_long_only is like getopt_long, but "-" as well as "--" can indicate a long option. If an option that starts with "-" (not "--") doesn't match a long option, but does match a short option, it is parsed as a short option instead.

Return Value

getopt_long_only returns the option character if the option was found successfully, or ":" if there was a missing parameter for one of the options, or "?" for an unknown option character, or -1 for the end of the option list.

getopt_long_only also returns the option character when a short option is recognized. For a long option, they return val if flag is NULL, and 0 otherwise. Error and -1 returns are the same as for getopt, plus "?" for an ambiguous match or an extraneous parameter.

gettext

Name

gettext -- perform lookup in message catalog for the current LC_MESSAGES locale

Synopsis

#include <libintl.h>

extern char *gettext(const char *msgid);

Description

gettext attempts to retrieve a target string based on the specified key from msgid within the context of a specific domain and the current locale.

The LANGUAGE environment variable is examined first to determine the message catalogs to be used. LANGUAGE is a list of locale names separated by ":" character. If LANGUAGE is defined, each locale name is tried in the specified order and if a message catalog containing the requested message is found, the message is returned. If LANGUAGE is defined but failed to locate a message catalog, the msgid string is returned. If LANGUAGE is not defined, the LC_ALL, LC_xxx, and LANG environment variables are examined to locate the message catalog, following the convention used by the setlocale function.

The pathname used to locate the message catalog is dirname/locale/category/domainname.mo, where dirname is the directory specified by the bindtextdomain function, locale is a locale name determined by the definition of environment variables, and category is LC_MESSAGES.

If the LC_MESSAGES locale category of the current locale is the standard C locale or the standard POSIX locale, gettext returns msgid without looking in any message catalog.

Parameters

msgid

A NULL-terminated string to be matched in the catalogue with respect to a specific domain and the current locale.

Return Value

If the function query above succeeds with msgid, then a translated NULL-terminated string is returned. If the search fails, then the original msgid is returned. The length of the string returned is undetermined until the function is called.

Errors

gettext does not modify the global variable errno.

See Also

gettext, dgettext, ngettext, dngettext, dcgettext, dcngettext, textdomain, bindtextdomain, bind_textdomain_codeset

getutent

Name

getutent -- access utmp file entries

Synopsis

#include <utmp.h>

struct utmp *getutent(void);

Description

getutent reads a line from the current file position in the utmp file. It returns a pointer to a structure containing the fields of the line.

Return Value

getutent returns a pointer to a static struct utmp.

Errors

On error, (struct utmp*)0 is returned.

Files

/var/run/utmp database of currently logged-in users

/var/log/wtmp database of past user logins

getutent_r

Name

getutent_r -- access utmp file entries

Synopsis

extern int getutent_r((struct utmp *__buffer), (struct utmp **__result));

Description

getutent_r is a reentrant version of the getutent utmp file handler.

glob64

Name

glob64 -- find pathnames matching a pattern (Large File Support)

Synopsis

#include <glob.h>

int glob64(const char *pattern, int flags, int (*errfunc) (const char *, int), glob64_t *pglob);

Description

glob64 searches for all the pathnames matching pattern according to the rules used by the shell. (See glob(7).) No tilde expansion or parameter substitution is done; if you want these, use wordexp(3).

The results of a glob64 call are stored in the structure pointed to by pglob, which is a glob64_t declared in glob.h and includes the following elements defined by POSIX.2 (more may be present as an extension):

glob64 is a 64-bit version of glob.

Return Value

On success, 0 is returned. Other possible returns are:

GLOB_NOSPACE

out of memory

GLOB_ABORTED

read error

GLOB_NOMATCH

no match found

globfree64

Name

globfree64 -- free memory from glob64() (Large File Support)

Synopsis

#include <glob.h>

void globfree64(glob64_t *pglob);

Description

globfree64 frees the dynamically allocated storage from an earlier call to glob64.

globfree64 is a 64-bit version of globfree.

initgroups

Name

initgroups -- initialize the supplementary group access list

Synopsis

#include <grp.h>
#include <sys/types.h>

int initgroups(const char *user, gid_t group);

Description

initgroups initializes the group access list by reading the group database and using all groups of which user is a member. The additional group group is also added to the list.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

Errors

EPERM

The calling process does not have sufficient privileges.

ENOMEM

Insufficient memory to allocate group information structure.

ioctl

Name

ioctl -- control device

Synopsis

#include <sys/ioctl.h>

int ioctl (int d , int request , ... );

Description

The ioctl() function shall manipulate the underlying device parameters of special files. d shall be an open file descriptor referring to a special file. The ioctl() function shall take three parameters; the type and value of the third parameter is dependent on the device and request.

An application may not call ioctl except for situations explicitly stated in this specification.

Return Value

On success, 0 is returned. An ioctl may use the return value as an output parameter and return a non-negative value on success. On error, -1 is returned and the global variable errno is set appropriately.

Errors

EBADF

d is not a valid descriptor.

EFAULT

The third parameter references an inaccessible memory area.

ENOTTY

d is not associated with a character special device.

ENOTTY

The specified request does not apply to the kind of object that d references.

EINVAL

request or the third parameter is not valid.

sockio

Name

sockio -- socket ioctl commands

Synopsis

#include <sys/socket.h>
#include <net/if.h>
#include <netinet/in.h>

int ioctl(int sockfd, int request, char *argp);

Description

Socket ioctl commands are a subset of the ioctl calls, which can perform a variety of functions on sockets. sockfd shall contain the value of a file descriptor that was created with the socket or accept calls.

Socket ioctl commands apply to the underlying network interfaces, and affect the entire system, not just the file descriptor used to issue the ioctl.

The following ioctls are provided:

SIOCGIFCONF

Gets the interface configuration list for the system. [6] argp is a pointer to a ifconf structure. Before calling, the caller shall allocate the ifc_ifcu.ifcu_req field to point to an array of ifreq structures, and set if_len to the size of this allocated array (in bytes). Upon return, if_len will contain the amount of the array which was actually used (again, in bytes). If it is the same as the length upon calling, the caller should assume that the array was too small and try again with a larger array.

On success, SIOCGIFCONF can return any nonnegative value. [7]

SIOCGIFFLAGS

Gets the interface flags for the indicated interface. argp is a pointer to a ifreq structure. Before calling, the caller should fill in the ifr_name field with the interface name, and upon return, the ifr_ifru.ifru_flags field is set with the interface flags.

SIOCGIFADDR

Gets the interface address list for the system. argp is a pointer to a ifreq structure. Before calling, the caller should fill in the ifr_name field with the interface name, and upon return, the ifr_ifru.ifru_addr field is set with the interface address.

SIOCGIFNETMASK

Gets the network mask for the indicated interface. argp is a pointer to a ifreq structure. Before calling, the caller should fill in the ifr_name field with the interface name, and upon return, the ifr_ifru.ifru_netmask field is set with the network mask.

FIONREAD

Returns the amount of queued unread data in the receive buffer. Argument is a pointer to an integer where the result is to be placed.

The sockaddr structure is as specified in the Single UNIX Specification.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

Errors

EBADF

sockfd is not a valid descriptor.

EFAULT

argp references an inaccessible memory area.

ENOTTY

sockfd is not associated with a character special device.

ENOTTY

The specified request does not apply to the kind of object that the descriptor sockfd references.

EINVAL

request and argp are not valid.

ENOTCONN

The operation is only defined on a connected socket, but the socket wasn't connected.

iswctype

Name

iswctype -- wide character classification

Synopsis

#include <wctype.h>

int iswctype(wint_t wc, wctype_t desc);

Description

iswctype tests wc to determine if it is a wide character whose property is designated by the character class desc.

desc shall be a character property descriptor returned by the wctype function.

Return Value

If wc belongs to the character class desc, a nonzero value is returned. Otherwise, 0 is returned.

Note that if wc is WEOF, 0 is returned.

Notes

The behavior of iswctype depends on the LC_CTYPE category of the current locale.

kill

Name

kill -- send a signal

Synopsis

int kill(pid_t pid, int sig);

Description

kill is as specified in the Single UNIX Specification, Version 2, but with differences as listed below.

Process ID -1 doesn't affect calling process

If pid is specified as -1, sig shall not be sent to the calling process. [8] Other than this, the rules in the Single UNIX Specification, Version 2 apply.

mbsnrtowcs

Name

mbsnrtowcs -- convert a multibyte string to a wide character string

Synopsis

#include <wchar.h>

size_t mbsnrtowcs(wchar_t *dest, const char **src, size_t nms, size_t len, mbstate_t *ps);

Description

mbsnrtowcs is like mbsrtowcs, except that the number of bytes to be converted, starting at src, is limited to nms.

If dest is not a NULL pointer, mbsnrtowcs converts at most nms bytes from the multibyte string src to a wide-character string starting at dest. At most, len wide characters are written to dest. The state ps is updated.

The conversion is effectively performed by repeatedly calling:
 
mbrtowc(dest, *src, n, ps)
where n is some positive number, as long as this call succeeds, and then incrementing dest by one and src by the number of bytes consumed.

The conversion can stop for three reasons:

  • An invalid multibyte sequence has been encountered. In this case src is left pointing to the invalid multibyte sequence, (size_t)(-1) is returned, and errno is set to EILSEQ.

  • The nms limit forces a stop, or len non-L'\0' wide characters have been stored at dest. In this case, src is left pointing to the next multibyte sequence to be converted, and the number of wide characters written to dest is returned.

  • The multibyte string has been completely converted, including the terminating '\0' (which has the side effect of bringing back ps to the initial state). In this case, src is set to NULL, and the number of wide characters written to dest, excluding the terminating L'\0' character, is returned.

If dest is NULL, len is ignored, and the conversion proceeds as above, except that the converted wide characters are not written out to memory, and that no destination length limit exists.

In both of the above cases, if ps is a NULL pointer, a static anonymous state only known to mbsnrtowcs is used instead.

The programmer shall ensure that there is room for at least len wide characters at dest.

Return Value

mbsnrtowcs returns the number of wide characters that make up the converted part of the wide character string, not including the terminating null wide character. If an invalid multibyte sequence was encountered, (size_t)(-1) is returned, and the global variable errno is set to EILSEQ.

Notes

The behavior of mbsnrtowcs depends on the LC_CTYPE category of the current locale.

Passing NULL as ps is not multi-thread safe.

memmem

Name

memmem -- locate a substring

Synopsis

#define _GNU_SOURCE
#include <string.h>

void *memmem(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen);

Description

memmem finds the start of the first occurrence of the substring needle of length needlelen in the memory area haystack of length haystacklen.

Return Value

memmem returns a pointer to the beginning of the substring, or NULL if the substring is not found.

Notes

memmem was broken in Linux libraries up to and including libc 5.0.9; there the needle and haystack arguments were interchanged, and a pointer to the end of the first occurrence of needle was returned. Since libc 5.0.9 is still widely used, this is a dangerous function to use.

Both old and new libc's have the bug that if needle is empty, haystack-1 is returned (instead of haystack). And glibc 2.0 makes it worse, returning a pointer to the last byte of haystack. This is fixed in glibc 2.1.

memrchr

Name

memrchr -- scan memory for a character

Synopsis

#include <string.h>

void *memrchr(const void *s, int c, size_t n);

Description

memrchr returns a pointer to the last occurrence of c in the first n characters of the string represented by s.

ngettext

Name

ngettext -- perform lookup in message catalog for the current LC_MESSAGES locale

Synopsis

#include <libintl.h>

extern char *ngettext(const char *msgid1, const char *msgid2, unsigned long int n);

Description

ngettext is the plural version of gettext, which searches for the message string using the msgid1 arguments as the key, using the argument n to determine the plural form. If no message catalogs containing a translation for msgid1 are found, msgid1 is returned if n == 1, otherwise, msgid2 is returned. (See gettext for more details.)

Parameters

msgid1

A NULL-terminated string to be matched in the catalogue with respect to a specific domain and the current locale. If no message catalogs are found, msgid1 is returned if n == 1.

msgid2

A NULL-terminated string to be returned if no message catalogs are found and n != 1.

n

Determines in which plural form a message string is returned, in a language and message catalog dependent way.

Return

If the function query above succeeds with msgid1, then a translated NULL-terminated string is returned. If the search fails, then the original msgid1 or msgid2 is returned, according to n.

Errors

ngettext will not modify the errno global variable.

See Also

gettext, dgettext, ngettext, dngettext, dcgettext, dcngettext, textdomain, bindtextdomain, bind_textdomain_codeset

obstack_free

Name

obstack_free -- free an object in the obstack

Synopsis

#include <obstack.h>

void obstack_free((struct obstack *obstack), void *block);

Description

obstack_free frees an object in the obstack.

open

Name

open -- open a file

Description

open is as specified in ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3, but with differences as listed below.

May return ENODEV in place of ENXIO

Where ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3 specifies an ENXIO return, a conforming implementation may return either ENXIO or ENODEV. Implementations are encouarged to return ENXIO. [9]

opterr

Name

opterr -- external variable used in getopt()

Synopsis

extern int opterr;

Description

opterr is used as a flag to suppress an error message generated by getopt. When opterr is set to 0, it suppresses the error message generated by getopt when that function does not recognize an option character.

optind

Name

optind -- external variable used in getopt()

Synopsis

extern int optind;

Description

optind holds the current index of the array argr[], which contains the command line options being parsed by getopt.

optopt

Name

optopt -- external variable used in getopt()

Synopsis

extern int optopt;

Description

optopt holds the unknown option character when that option character is not recognized by getopt.

pmap_getport

Name

pmap_getport -- Returns the port number on which a service is waiting for.

Synopsis

#include <pmap_clnt.h>

extern u_short *pmap_getport(struct sockaddr_in *address, __const u_long program, __const u_long *version, u_int protocol);

Description

pmap_getport returns the port number on which a service is waiting for. pmap_getport is called given the RPC program number program, version, and the transport protocol set to either IPPROTO_UDP or IPPROTO_TCP. The pre-allocated socket address is a returned parameter.

Return Value

pmap_getport returns 0 if the mapping does not exist or if contact to the remote portmap service failed. If the remote portmap service could not be reached, the status is left in the global variable rpc_createerr.

pmap_set

Name

pmap_set -- Establishes mapping to machine's portmap service.

Synopsis

#include <rpc/pmap_clnt.h>

*pmap_set(__const u_long program, __const u_long version, int protocol, u_short port);

Description

pmap_set establishes a mapping between the triple [program,version,protocol] and port on the machine's portmap service. The value of protocol is most likely IPPROTO_UDP or IPPROTO_TCP. Automatically done by svc_register.

Return Value

pmap_set returns 1 if it suceeds, 0 otherwise.

pmap_unset

Name

pmap_unset --  Destroys all mapping between the triple and ports.

Synopsis


#include <rpc/rpc.h>

void pmap_unset(u_long prognum, u_long versnum);

Description

As a user interface to the portmap service, pmap_unset destroys all mapping between the triple [prognum,versnum, *] and ports on the machine's portmap service.

Return Value

pmap_unset returns 1 if it succeeds, zero otherwise.

psignal

Name

psignal -- print signal message

Synopsis

#include <signal.h>

void psignal(int sig, const char *s);

extern const char *const sys_siglist[]

Description

psignal displays a message on stderr consisting of the string s, a colon, a space, and a string describing the signal number sig. If sig is invalid, the message displayed will indicate an unknown signal.

The array sys_siglist holds the signal description strings indexed by signal number.

Return Value

psignal returns no value.

random_r

Name

random_r -- generate random number

Synopsis

extern int random_r((struct random_data *__restrict __buf), int32_t *__restrict __result);

Description

random_r is a reentrant version of random, which generates a pseudorandom number.

setbuffer

Name

setbuffer -- stream buffering operation

Synopsis

#include <stdio.h>

void setbuffer(FILE *stream, char *buf, size_t size);

Description

setbuffer is an alias for the call to setvbuf. It works the same, except that the size of the buffer in setbuffer is up to the caller, rather than being determined by the default BUFSIZ.

setdomainname

Name

setdomainname -- set NIS domain name.

Synopsis

#include <unistd.h>

extern int setdomainname(char *name, size_t namelen);

Description

If NIS is in use, set the NIS domain name. Note that this is not the same as the domain name which provides the domain portion of a fully qualified domain name (for example, in DNS). If NIS is not in use, this function may set the domain name anyway, or it may fail.

This call shall fail unless the caller has appropriate privileges.

namelen shall be the length of the string pointed to by name.

Return Value

setdomainname returns 0 if successful; -1 if not (in which case errno is set to indicate the error).

setgroups

Name

setgroups -- set list of supplementary group IDs

Synopsis

#include <grp.h>

int setgroups(size_t size, const gid_t *list);

Description

setgroups sets the supplementary groups for the process. Only the super-user may use this function.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

Errors

EFAULT

list has an invalid address.

EPERM

The user is not the super-user.

EINVA

size is greater than NGROUPS (32 for Linux 2.0.32).

sethostid

Name

sethostid -- set the unique identifier of the current host

Synopsis

#include <unistd.h>

int sethostid(long int hostid);

Description

sethostid sets a unique 32-bit identifier for the current machine. The 32-bit identifier is intended to be unique among all UNIX systems in existence. This normally resembles the Internet address for the local machine as returned by gethostbyname(3), and thus usually never needs to be set.

The sethostid call is restricted to the superuser.

hostid is stored in the file /etc/hostid.

Return Value

gethostid returns the 32-bit identifier for the current host as set by sethostid(2).

Files

/etc/hostid

sethostname

Name

sethostname -- set host name

Synopsis

#include <unistd.h>

int sethostname(const char *name, size_t len);

Description

sethostname changes the host name of the current processor.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

Errors

EINVAL

len is negative or larger than the maximum allowed size.

EPERM

the caller was not the superuser.

EFAULT

name is an invalid address.

Notes

The Single UNIX Specification, Version 2 guarantees that:

Host names are limited to 255 bytes.

setsockopt

Name

setsockopt -- set options on sockets

Synopsis

#include <sys/socket.h>
#include <netinet/in.h>

int setsockopt(int sockfd, int level, int optname, void *optval, socklen_t optlen);

Description

In addition to the setsockopt options specified in SUSv3, setsockopt also supports the options specified here.

The following setsockopt operations are provided for level IPPROTO_IP:

IP_MULTICAST_TTL

Set or reads the time-to-live value of outgoing multicast packets for this socket. optval is a pointer to an integer which contains the new TTL value.

IP_MULTICAST_LOOP

Sets a boolean flag indicating whether multicast packets originating locally should be looped back to the local sockets. optval is a pointer to an integer which contains the new flag value.

IP_ADD_MEMBERSHIP

Join a multicast group. optval is a pointer to a ip_mreq structure. Before calling, the caller should fill in the imr_multiaddr field with the multicast group address and the imr_address field with the address of the local interface. If imr_address is set to INADDR_ANY, then an appropriate interface is chosen by the system.

IP_DROP_MEMBERSHIP

Leave a multicast group. optval is a pointer to a ip_mreq structure containing the same values as were used with IP_ADD_MEMBERSHIP.

IP_MULTICAST_IF

Set the local device for a multicast socket. optval is a pointer to a ip_mreq structure initialized in the same manner as with IP_ADD_MEMBERSHIP.

The ip_mreq structure contains two struct in_addr fields: imr_multiaddr and imr_address.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

setutent

Name

setutent -- access utmp file entries

Synopsis

#include <utmp.h>

void setutent(void);

Description

setutent rewinds the file pointer to the beginning of the utmp file. It is generally a Good Idea to call it before any of the other functions.

Errors

On error, (struct utmp*)0 will be returned.

Files

/var/run/utmp database of currently logged-in users /var/log/wtmp database of past user logins

sigandset

Name

sigandset -- build a new signal set by combining the two input sets using logical AND

Synopsis

#include <signal.h>

extern int sigandset(sigset_t *set, const sigset_t *left, const sigset_t *right);

Description

sigandset is a signal function that builds a new signal set by combining the two input sets using logical AND.

sigblock

Name

sigblock -- manipulate the signal mask

Synopsis

#include <signal.h>

int sigblock(int mask);

Description

sigblock is made obsolete by sigprocmask(2).

sigblock adds the signals specified in mask to the set of signals currently being blocked from delivery.

Notes

Prototype for sigblock is only available if _BSD_SOURCE is defined before the inclusion of any system.

siggetmask

Name

siggetmask -- manipulate the signal mask

Synopsis

#include <signal.h>

int siggetmask(void);

Description

siggetmask is made obsolete by sigprocmask(2).

siggetmask returns the current set of masked signals.

Notes

Prototype for siggetmask is only available if _BSD_SOURCE is defined before the inclusion of any system header file.

sigisemptyset

Name

sigisemptyset -- check for empty signal set

Synopsis

#include <signal.h>

extern int sigisemptyset(const sigset_t *set);

Description

sigisemptyset checks for empty signal set. It returns a non-empty value if set is not empty.

sigorset

Name

sigorset -- build a new signal set by combining the two input sets using logical or

Synopsis

#include <signal.h>

extern int sigorset(sigset_t *set, const sigset_t *left, const sigset_t *right);

Description

sigorset is a signal function that builds a new signal set by combining the two input sets using logical or.

sigreturn

Name

sigreturn -- return from signal handler and cleanup stack frame

Synopsis

int sigreturn(unsigned long __unused);

Description

When the Linux kernel creates the stack frame for a signal handler, a call to sigreturn is inserted into the stack frame so that the the signal handler will call sigreturn upon return. This inserted call to sigreturn cleans up the stack so that the process can restart from where it was interrupted by the signal.

Return Value

sigreturn never returns.

Warning

sigreturn is used by the kernel to implement signal handlers. It should never be called directly. Better yet, the specific use of __unused varies depending on the architecture.

Files

/usr/src/linux/arch/i386/kernel/signal.c

/usr/src/linux/arch/alpha/kernel/entry.s

stime

Name

stime -- set time

Synopsis

#define _SVID_SOURCE  /* glibc needs this */
#include <time.h>

int stime(time_t *t);

Description

stime sets the system's idea of the time and date. Time, pointed to by t, is measured in seconds from 00:00:00 GMT January 1, 1970. stime may only be executed by the super user.

Return Value

On success, 0 is returned. On error, -1 is returned and the global variable errno is set appropriately.

Errors

EPERM

The caller is not the super-user.

Notes

Under glibc2, time.h only provides a prototype when _SVID_SOURCE is defined.

stpcpy

Name

stpcpy -- copy a string returning a pointer to its end

Synopsis

#include <string.h>

char *stpcpy(char *dest, const char *src);

Description

stpcpy copies the string pointed to by src (including the terminating '\0' character) to the array pointed to by dest. The strings may not overlap, and the destination string dest shall be large enough to receive the copy.

Return Value

stpcpy returns a pointer to the end of the string dest (that is, the address of the terminating '\0' character) rather than the beginning.

Example

This program uses stpcpy to concatenate foo and bar to produce foobar, which it then prints.
  #include <string.h>

  int
  main (void)
  {
    char *to = buffer;
    to = stpcpy (to, "foo");
    to = stpcpy (to, "bar");
    printf ("%s\n", buffer);
  }

stpncpy

Name

stpncpy -- copy a fixed-size string, returning a pointer to its end

Synopsis

#include <string.h>

char *stpncpy(char *dest, const char *src, size_t n);

Description

stpncpy copies at most n characters from the string pointed to by src, including the terminating \0 character, to the array pointed to by dest. Exactly n characters are written at dest. If the length strlen(src) is smaller than n, the remaining characters in dest are filled with \0 characters. If the length strlen(src) is greater than or equal to n, dest will not be \0 terminated.

The strings may not overlap.

The programmer shall ensure that there is room for at least n characters at dest.

Return Value

stpncpy returns a pointer to the terminating NULL in dest, or, if dest is not NULL-terminated, dest + n.

strcasestr

Name

strcasestr -- locate a substring - ignores the case of both strings

Synopsis

#include <string.h>

char *strcasestr(const char *haystack, const char *needle);

Description

strcasestr is similar to strstr, but ignores the case of both strings.

strerror_r

Name

strerror_r -- reentrant version of strerror

Synopsis

#include <string.h>

extern char *strerror_r(int errnum, char *buf, size_t buflen);

Description

strerror_r is a reentrant version of strerror. strerror_r returns a pointer to an error message corresponding to error number errnum. The returned pointer may point within the buffer buf (at most buflen bytes). [10]

strfry

Name

strfry -- randomize a string

Synopsis

#include <string.h>

char *strfry(char *string);

Description

strfry randomizes the contents of string by using rand(3) to randomly swap characters in the string. The result is an anagram of string.

Return Value

strfry returns a pointer to the randomized string.

strndup

Name

strndup -- return a malloc'd copy of at most the specified number of bytes of a string

Synopsis

#include <string.h>

extern char *strndup(const char *string, size_t n);

Description

strndup returns a malloc'd copy of at most n bytes of string. The resultant string is terminated even if no NULL terminator appears before STRING[N].

strnlen

Name

strnlen -- determine the length of a fixed-size string

Synopsis

#include <string.h>

size_t strnlen(const char *s, size_t maxlen);

Description

strnlen returns the number of characters in the string s, not including the terminating \0 character, but at most maxlen. In doing this, strnlen looks only at the first maxlen characters at s and never beyond s + maxlen.

Return Value

strnlen returns strlen(s), if that is less than maxlen, or maxlen if there is no \0 character among the first maxlen characters pointed to by s.

strptime

Name

strptime -- parse a time string

Description

strptime is as specified in the Single UNIX Specification, Version 2 with differences as listed below.

Number of leading zeroes limited

The Single UNIX Specification, Version 2 specifies fields for which "leading zeros are permitted but not required"; however, applications shall not expect to be able to supply more leading zeroes for these fields than would be implied by the range of the field. Implementations may choose to either match an input with excess leading zeroes, or treat this as a non-matching input. For example, %j has a range of 001 to 366, so 0, 00, 000, 001, and 045 are acceptable inputs, but inputs such as 0000, 0366 and the like are not.

Rationale

glibc developers consider it appropriate behavior to forbid excess leading zeroes. When trying to parse a given input against several format strings, forbidding excess leading zeroes could be helpful. For example, if one matches 0011-12-26 against %m-%d-%Y and then against %Y-%m-%d, it seems useful for the first match to fail, as it would be perverse to parse that date as November 12, year 26. The second pattern parses it as December 26, year 11.

The Single UNIX Specification is not explicit that an unlimited number of leading zeroes are required, although it may imply this. The LSB explicitly allows implementations to have either behavior. Future versions of this standard may require implementations to forbid excess leading zeroes.

strsep

Name

strsep -- extract token from string

Synopsis

#include <string.h>

char *strsep(char **stringp, const char *delim);

Description

If stringp is NULL, strsep returns NULL and does nothing else.

If stringp is non-NULL, strsep finds the first token in the stringp, where tokens are delimited by symbols in the string delim. This token is terminated with a \0 character (by overwriting the delimiter) and stringp is updated to point past the token. In case no delimiter was found, the token is taken to be the entire string stringp, and stringp is made NULL.

Return Value

strsep returns a pointer to the token, that is, it returns the original value of stringp.

Notes

strsep was introduced as a replacement for strtok, since the latter cannot handle empty fields. However, strtok conforms to ANSI-C and hence is more portable.

Bugs

strsep suffers from the same problems as strtok. In particular, strsep modifies the original string. Avoid it.

strsignal

Name

strsignal -- return string describing signal

Synopsis

#define _GNU_SOURCE
#include <string.h>

char *strsignal(int sig);

extern const char * const sys_siglist[];

Description

strsignal returns a string describing the signal number sig. The string can only be used until the next call to strsignal.

The array sys_siglist holds the signal description strings indexed by signal number. strsignal should be used if possible instead of this array.

Return Value

strsignal returns the appropriate description string, or an unknown signal message if the signal number is invalid. On some systems (but not on Linux), a NULL pointer may be returned instead for an invalid signal number.

strtok_r

Name

strtok_r -- extract tokens from strings

Synopsis

#include <string.h>

char *strtok_r(char *s, const char *delim, char **ptrptr);

Description

strtok_r parses the string s into tokens. [11] The first call to strtok_r should have s as its first argument. Subsequent calls should have the first argument set to NULL. Each call returns a pointer to the next token, or NULL when no more tokens are found.

If a token ends with a delimiter, this delimiting character is overwritten with a \0 and a pointer to the next character is saved for the next call to strtok_r. The delimiter string delim may be different for each call.

ptrptr is a user allocated char* pointer. It shall be the same while parsing the same string.

Bugs

Never use this function. Note that:

  • It modifies its first argument.

  • The identity of the delimiting character is lost.

  • It cannot be used on constant strings.

Return Value

strtok_r returns a pointer to the next token, or NULL if there are no more tokens.

strtoq

Name

strtoq -- convert string value to a long or quad_t integer

Synopsis

#include <sys/types.h>
#include <stdlib.h>
#include <limits.h>

quadt strtoq(const char *nptr, char **endptr, int base);

Description

strtoq converts the string nptr to a quadt value. The conversion is done according to the given base, which shall be between 2 and 36 inclusive, or be the special value 0.

nptr may begin with an arbitrary amount of white space (as determined by isspace(3)), followed by a single optional + or - sign character. If base is 0 or 16, the string may then include a 0x prefix, and the number will be read in base 16; otherwise, a 0 base is taken as 10 (decimal), unless the next character is 0, in which case it is taken as 8 (octal).

The remainder of the string is converted to a long value in the obvious manner, stopping at the first character which is not a valid digit in the given base. (In bases above 10, the letter A in either upper or lower case represents 10, B represents 11, and so forth, with Z representing 35.)

Return Value

strtoq returns the result of the conversion, unless the value would underflow or overflow. If an underflow occurs, strtoq returns QUAD_MIN. If an overflow occurs, strtoq returns QUAD_MAX. In both cases, the global variable errno is set to ERANGE.

Errors

ERANGE

The given string was out of range; the value converted has been clamped.

strtouq

Name

strtouq -- convert a string to an uquad_t

Synopsis

#include <sys/types.h>
#include <stdlib.h>
#include <limits.h>

uquadt strtouq(const char *nptr, char **endptr, int base);

Description

strtouq converts the string nptr to a uquadt value. The conversion is done according to the given base, which shall be between 2 and 36 inclusive, or be the special value 0.

nptr may begin with an arbitrary amount of white space (as determined by isspace(3)), followed by a single optional + or - sign character. If base is 0 or 16, the string may then include a 0x prefix, and the number will be read in base 16; otherwise, a 0 base is taken as 10 (decimal), unless the next character is 0, in which case it is taken as 8 (octal).

The remainder of the string is converted to an unsigned long value in the obvious manner, stopping at the end of the string or at the first character that does not produce a valid digit in the given base. (In bases above 10, the letter A in either upper or lower case represents 10, B represents 11, and so forth, with Z representing 35.)

Return Value

On success, strtouq returns either the result of the conversion or, if there was a leading minus sign, the negation of the result of the conversion, unless the original (non-negated) value would overflow. In the case of an overflow the function returns UQUAD_MAX and the global variable errno is set to ERANGE.

Errors

ERANGE

The given string was out of range; the value converted has been clamped.

strverscmp

Name

strverscmp -- compare strings holding name and indices/version numbers

Synopsis

#include <string.h>

extern int strverscmp(const char *s1, const char *s2);

Description

strverscmp compares s1 and s2 as strings holding name and indices/version numbers.

svc_register

Name

svc_register -- Associates program and versnum with the service dispatch procedure, dispatch.

Synopsis

#include <rpc/rpc.h>

void svc_register(SVCXPRT *xprt, u_long prognum, u_long versnum, void (*dispatch)(), u_long protocol);

Description

Associates prognum and versnum with the service dispatch procedure, dispatch. If protocol is zero, the service is not registered with the portmap service. If protocol is non-zero, then a mapping of the triple [prognum, versnum,protocol] to xprt->xp_port is established with the local portmap service (generally protocol is zero, IPPROTO_UDP or IPPROTO_TCP). The procedure dispatch has the following form:

dispatch(request, xprt) struct svc_req *request; SVCXPRT *xprt;

Return Value

svc_register returns 1 if it succeeds, and zero otherwise.

svc_run

Name

svc_run -- Waits for RPC requests to arrive and calls service procedure.

Synopsis

#include <rpc/svc.h>

svc_run();

Description

The svc_run routine never returns. It waits for RPC requests to arrive, and calls the appropriate service procedure using svc_getreq when one arrives. This procedure is usually waiting for a select system call to return.

svc_sendreply

Name

svc_sendreply -- called by RPC service's dispatch routine

Synopsis

svc_sendreply(SVCXPRT *xprt, xdrproc_t outproc, char out);

Description

Called by an RPC service's dispatch routine to send the results of a remote procedure call. The parameter xprt is the request's associated transport handle; outproc is the XDR routine which is used to encode the results; and out is the address of the results. This routine returns one if it succeeds, zero other-wise.

svctcp_create

Name

svctcp_create -- Creates a TCP/IP-based RPC service transport.

Synopsis

#include <rpc/rpc.h>

SVCXPRT *svctcp_create(int sock, u_int send_buf_size, u_int recv_buf_size);

Description

svctcp_create cretes a TCP/IP-based RPC service transport, to which it returns a pointer. The transport is associated with the socket sock, which may be RPC_ANYSOCK, in which case a new socket is created. If the socket is not bound to a local TCP port, ten this routine binds it to an arbitrary port. Upon completion, xprt->xp_sock is the transport's socket descriptor, and xprt->xp_port is the transport's port number. Since TCP-based RPC uses buffered I/O, users may specify the size of buffers; values of zero choose suitable defaults.

Return Value

svctcp_create returns NULL if it fails, or a pointer to the RPC service transport otherwise.

svcudp_create

Name

svcudp_create --  Creates a UDP-based RPC service transport.

Synopsis

SVCXPRT *

svcudp_create(int sock);

Description

This call is equivalent to svcudp_bufcreate (sock, SZ, SZ) for some default size SZ.

system

Name

system -- execute a shell command

Synopsis

#include <stdlib.h>

int system(const char *string);

Description

system executes a command specified in string by calling /bin/sh -c string, and returns after the command has been completed. During execution of the command, SIGCHLD will be blocked, and SIGINT and SIGQUIT will be ignored.

Return Value

The value 127 returned if the execve call for /bin/sh fails, -1 if there was another error and the return code of the command otherwise.

If the value of string is NULL, system returns a nonzero value if the shell is available, and zero if not.

system does not affect the wait status of any other children.

Notes

The fact that system ignores interrupts is often not what a program wants. The Single UNIX Specification describes some of the consequences; an additional consequence is that a program calling system from a loop cannot be reliably interrupted. Many programs will want to use the exec(3) family of functions instead.

Do not use system from a program with suid or sgid privileges, because strange values for some environment variables might be used to subvert system integrity. Use the exec(3) family of functions instead, but not execlp(3) or execvp(3). system will not, in fact, work properly from programs with suid or sgid privileges on systems on which /bin/sh is bash version 2, since bash 2 drops privileges on startup. (Debian uses a modified bash which does not do this when invoked as sh.)

The check for the availability of /bin/sh is not actually performed; it is always assumed to be available. ISO C specifies the check, but POSIX.2 specifies that the return shall always be nonzero, since a system without the shell is not conforming, and it is this that is implemented.

It is possible for the shell command to return 127, so that code is not a sure indication that the execve call failed; check the global variable errno to make sure.

textdomain

Name

textdomain -- set the current default message catalog

Synopsis

#include <libintl.h>

extern char *textdomain(const char *domainname);

Description

textdomain sets the current default message catalog to domainname, which remains valid across subsequent calls to setlocale, and gettext.

Return

On success, textdomain returns the currently selected domain. On error, a NULL pointer is returned.

If domainname is NULL, textdomain returns the current default.

If domainname is "", reset to the default of "messages".

Errors

ENOMEM

The function may have failed if there was "insufficent memory available."

unlink

Name

unlink -- remove a directory entry

Synopsis

int unlink(const char *path);

Description

unlink is as specified in the ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3, but with differences as listed below.

See also Additional behaviors: unlink/link on directory>.

May return EISDIR on directories

If path specifies a directory, the implementation may return EISDIR instead of EPERM as specified by ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3. [12]

vasprintf

Name

vasprintf -- write formatted output to a string dynamically allocated with malloc and store the address of the string

Synopsis

#include <stdio.h>

extern int vasprintf(char **restrict ptr, const char *restrict f, G_va_list arg);

Description

vasprintf writes formatted output to a string dynamically allocated with malloc, and stores the address of the string in ptr.

vdprintf

Name

vdprintf -- write formatted output to a file descriptor

Synopsis

#include <stdio.h>

extern int vdprintf(int fd, const char *restrict fmt, G_va_list arg);

Description

vdprintf writes formatted output to a file descriptor.

verrx

Name

verrx -- display formatted error messages

Synopsis

#include <err.h>

void verrx(int eval, const char *fmt, valist args);

Description

verrx displays a formatted error message on the standard error output. The last component of the program name, a colon character, and a space are output. If fmt is not NULL, the formatted error message, a colon, and a space are output. The output is followed by a newline character.

verrx does not return, but exits with the value of eval.

vsyslog

Name

vsyslog -- log to system log

Synopsis

void vsyslog(int priority, char *message, va_list arglist);

Description

vsyslog is identical to syslog as specified in the Single UNIX Specification, except that arglist (as defined by stdarg.h) replaces the variable number of arguments.

The caller is responsible for running va_end after calling vsyslog.

wait3

Name

wait3 -- wait for child process

Description

wait3 is as specified in the Single UNIX Specification, Version 2, but with differences as listed below.

Notes

Implementations need not support the functionality of WCONTINUED or WIFCONTINUED.

wait4

Name

wait4 -- wait for process termination, BSD style

Synopsis

#include <sys/types.h>
#include <sys/resource.h>
#include <sys/wait.h>

pid_t wait4(pid_t pid, int *status, int options, (struct rusage *rusage));

Description

wait4 suspends execution of the current process until a child (as specified by pid) has exited, or until a signal is delivered whose action is to terminate the current process or to call a signal handling function. If a child (as requested by pid) has already exited by the time of the call (a so-called "zombie" process), the function returns immediately. Any system resources used by the child are freed.

The value of pid can be one of:

< -1

wait for any child process whose process group ID is equal to the absolute value of pid.

-1

wait for any child process; this is equivalent to calling wait3.

0

wait for any child process whose process group ID is equal to that of the calling process.

> 0

wait for the child whose process ID is equal to the value of pid.

The value of options is a bitwise or of zero or more of the following constants:

WNOHANG

return immediately if no child is there to be waited for.

WUNTRACED

return for children that are stopped, and whose status has not been reported.

If status is not NULL, wait4 stores status information in the location status. This status can be evaluated with the following macros: [13]

WIFEXITED(status)

is nonzero if the child exited normally.

WEXITSTATUS(status)

evaluates to the least significant eight bits of the return code of the child that terminated, which may have been set as the argument to a call to exit or as the argument for a return statement in the main program. This macro can only be evaluated if WIFEXITED returned nonzero.

WIFSIGNALED(status)

returns true if the child process exited because of a signal that was not caught.

WTERMSIG(status)

returns the number of the signal that caused the child process to terminate. This macro can only be evaluated if WIFSIGNALED returned nonzero.

WIFSTOPPED(status)

returns true if the child process that caused the return is currently stopped; this is only possible if the call was done using WUNTRACED.

WSTOPSIG(status)

returns the number of the signal that caused the child to stop. This macro can only be evaluated if WIFSTOPPED returned nonzero.

If rusage is not NULL, the struct rusage (as defined in sys/resource.h) that it points to will be filled with accounting information. (See getrusage(2) for details.

Return Value

On success, the process ID of the child that exited is returned. On error, -1 is returned (in particular, when no unwaited-for child processes of the specified kind exist), or 0 if WNOHANG was used and no child was available yet. In the latter two cases, the global variable errno is set appropriately.

Errors

ECHILD

No unwaited-for child process as specified does exist.

ERESTARTSYS

A WNOHANG was not set and an unblocked signal or a SIGCHILD was caught. This error is returned by the system call. The library interface is not allowed to return ERESTARTSYS, but will return EINTR.

waitpid

Name

waitpid -- wait for child process

Description

waitpid is as specified in the Single UNIX Specification, but with differences as listed below.

Need not support WCONTINUED

Implementations need not support the functionality of WCONTINUED or WIFCONTINUED.

warn

Name

warn -- formatted error messages

Synopsis

#include <err.h>

void warn(const char *fmt ...);

Description

warn displays a formatted error message on the standard error output. The last component of the program name, a colon character, and a space are output. If fmt is not NULL, the formatted error message, a colon, and space are output. The error message string affiliated with the current value of the global variable errno is output. The output is followed by a newline character.

warnx

Name

warnx -- formatted error messages

Synopsis

#include <err.h>

void warnx(const char *fmt ...);

Description

warnx displays a formatted error message on the standard error output. The last component of the program name, a colon character, and a space are output. If fmt is not NULL, the formatted error message, a colon, and space are output. The output is followed by a newline character.

wcpcpy

Name

wcpcpy -- copy a wide character string, returning a pointer to its end

Synopsis

#include <wchar.h>

wchar_t *wcpcpy(wchar_t *dest, const wchar_t *src);

Description

wcpcpy is the wide-character equivalent of stpcpy. It copies the wide character string src, including the terminating L'\0' character, to the array dest.

The strings may not overlap.

The programmer shall ensure that there is room for at least wcslen(src)+1 wide characters at dest.

Return Value

wcpcpy returns a pointer to the end of the wide-character string dest, that is, a pointer to the terminating L'\0' character.

wcpncpy

Name

wcpncpy -- copy a fixed-size string of wide characters, returning a pointer to its end

Synopsis

#include <wchar.h>

wchar_t *wcpncpy(wchar_t *dest, const wchar_t *src, size_t n);

Description

wcpncpy is the wide-character equivalent of stpncpy. It copies at most n wide characters from the wide-character string src, including the terminating L'\0' character, to the array dest. Exactly n wide characters are written at dest. If the length wcslen(src) is smaller than n, the remaining wide characters in the array dest are filled with L'\0' characters. If the length wcslen(src) is greater than or equal to n, the string dest will not be L'\0' terminated.

The strings may not overlap.

The programmer shall ensure that there is room for at least n wide characters at dest.

Return Value

wcpncpy returns a pointer to the wide character one past the last non-null wide character written.

wcscasecmp

Name

wcscasecmp -- compare two wide-character strings, ignoring case

Synopsis

#include <wchar.h>

int wcscasecmp(const wchar_t *s1, const wchar_t *s2);

Description

wcscasecmp is the wide-character equivalent of strcasecmp. It compares the wide-character string s1 and the wide-character string s2, ignoring case differences (towupper, towlower).

Return Value

wcscasecmp returns 0 if the wide-character strings s1 and s2 are equal except for case distinctions. It returns a positive integer if s1 is greater than s2, ignoring case. It returns a negative integer if s1 is smaller than s2, ignoring case.

Notes

The behavior of wcscasecmp depends upon the LC_CTYPE category of the current locale.

wcsdup

Name

wcsdup -- duplicate a wide-character string

Synopsis

#include <wchar.h>

wchar_t *wcsdup(const wchar_t *s);

Description

wcsdup is the wide-character equivalent of strdup. It allocates and returns a new wide-character string whose initial contents is a duplicate of the wide-character string s.

Memory for the new wide-character string is obtained with malloc(3), and can be freed with free(3).

Return Value

wcsdup returns a pointer to the new wide-character string, or NULL if sufficient memory was not available.

wcsncasecmp

Name

wcsncasecmp -- compare two fixed-size wide-character strings, ignoring case

Synopsis

#include <wchar.h>

int wcsncasecmp(const wchar_t *s1, const wchar_t *s2, size_t n);

Description

wcsncasecmp is the wide-character equivalent of strncasecmp. It compares the wide-character string s1 and the wide-character string s2, but at most n wide characters from each string, ignoring case differences (towupper, towlower).

Return Value

wcscasecmp returns 0 if the wide-character strings s1 and s2, truncated to at most length n, are equal except for case distinctions. It returns a positive integer if truncated s1 is greater than truncated s2, ignoring case. It returns a negative integer if truncated s1 is smaller than truncated s2, ignoring case.

Notes

The behavior of wcsncasecmp depends upon the LC_CTYPE category of the current locale.

wcsnlen

Name

wcsnlen -- determine the length of a fixed-size wide-character string

Synopsis

#include <wchar.h>

size_t wcsnlen(const wchar_t *s, size_t maxlen);

Description

wcsnlen is the wide-character equivalent of strnlen. It returns the number of wide-characters in the string s, not including the terminating L'\0' character, but at most maxlen. In doing this, wcsnlen looks only at the first maxlen wide-characters at s and never beyond s + maxlen.

Return Value

wcsnlen returns wcslen(s) if that is less than maxlen, or maxlen if there is no L'\0' character among the first maxlen wide characters pointed to by s.

Notes

The behavior of wcsncasecmp depends on the LC_CTYPE category of the current locale.

wcsnrtombs

Name

wcsnrtombs -- convert a wide character string to a multi-byte string

Synopsis

#include <wchar.h>

size_t wcsnrtombs(char *dest, const wchar_t **src, size_t nwc, size_t len, mbstate_t *ps);

Description

wcsnrtombs is like wcsrtombs, except that the number of wide characters to be converted, starting at src, is limited to nwc.

If dest is not a NULL pointer, wcsnrtombs converts at most nwc wide characters from the wide-character string src to a multibyte string starting at dest. At most len bytes are written to dest. The state ps is updated.

The conversion is effectively performed by repeatedly calling:
wcrtomb(dest, *src, ps)
as long as this call succeeds, and then incrementing dest by the number of bytes written and src by 1.

The conversion can stop for three reasons:

  • A wide character has been encountered that cannot be represented as a multibyte sequence (according to the current locale). In this case src is left pointing to the invalid wide character, (size_t)(-1) is returned, and errno is set to EILSEQ.

  • nws wide characters have been converted without encountering a L'\0', or the length limit forces a stop. In this case, src is left pointing to the next wide character to be converted, and the number bytes written to dest is returned.

  • The wide-character string has been completely converted, including the terminating L'\0' (which has the side effect of bringing back ps to the initial state). In this case, src is set to NULL, and the number of bytes written to dest, excluding the terminating L'\0' byte, is returned.

If dest is NULL, len is ignored, and the conversion proceeds as above, except that the converted bytes are not written out to memory, and that no destination length limit exists.

In both of the above cases, if ps is a NULL pointer, a static anonymous state only known to wcsnrtombs is used instead.

The programmer shall ensure that there is room for at least len bytes at dest.

Return Value

wcsnrtombs returns the number of bytes that make up the converted part of multibyte sequence, not including the terminating L'\0' byte. If a wide character was encountered which could not be converted, (size_t)(-1) is returned, and the global variable errno set to EILSEQ.

Notes

The behavior of wcsnrtombs depends on the LC_CTYPE category of the current locale.

Passing NULL as ps is not multi-thread safe.

wcstoq

Name

wcstoq -- convert initial portion of wide string NPTR to long int representation

Synopsis

#include <wchar.h>

extern long long int wcstoq(const wchar_t *restrict nptr, wchar_t **restrict endptr, int base);

Description

wcstoq converts the initial portion of the wide string nptr to long int representation.

wcstouq

Name

wcstouq -- convert initial portion of wide string NPTR to unsigned long long int representation

Synopsis

#include <wchar.h>

extern unsigned long long int wcstouq(const wchar_t *restrict nptr, wchar_t **restrict endptr, int base);

Description

wcstouq converts the initial portion of the wide string nptr to unsigned long long int representation.

xdr_u_int

Name

xdr_u_int -- library routines for external data representation

Synopsis

int xdr_u_int(XDR * xdrs, unsigned int * up);

Description

xdr_u_int is a filter primitive that translates between C unsigned integers and their external representations.

Return Value

On success, 1 is returned. On error, 0 is returned.


Interfaces for libm

Table 6-28 defines the library name and shared object name for the libm library

Table 6-28. libm Definition

Library:libm
SONAME:See archLSB.

The behavior of the interfaces in this library is specified by the following specifications:

ISO/IEC 9899: 1999, Programming Languages --C
CAE Specification, January 1997, System Interfaces and Headers (XSH),Issue 5 (ISBN: 1-85912-181-0, C606)
ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3


Math


Interfaces for Math

An LSB conforming implementation shall provide the generic functions for Math specified in Table 6-29, with the full functionality as described in the referenced underlying specification.

Table 6-29. libm - Math Function Interfaces

acos [1]cexp [1]expf [1]jnf [2]remquof [1]
acosf [1]cexpf [1]expl [1]jnl [2]remquol [1]
acosh [1]cexpl [1]expm1 [1]ldexp [1]rint [1]
acoshf [1]cimag [1]fabs [1]ldexpf [1]rintf [1]
acoshl [1]cimagf [1]fabsf [1]ldexpl [1]rintl [1]
acosl [1]cimagl [1]fabsl [1]lgamma [1]round [1]
asin [1]clog [1]fdim [1]lgamma_r [2]roundf [1]
asinf [1]clog10 [2]fdimf [1]lgammaf [1]roundl [1]
asinh [1]clog10f [2]fdiml [1]lgammaf_r [2]scalb [1]
asinhf [1]clog10l [2]feclearexcept [1]lgammal [1]scalbf [2]
asinhl [1]clogf [1]fegetenv [1]lgammal_r [2]scalbl [2]
asinl [1]clogl [1]fegetexceptflag [1]llrint [1]scalbln [1]
atan [1]conj [1]fegetround [1]llrintf [1]scalblnf [1]
atan2 [1]conjf [1]feholdexcept [1]llrintl [1]scalblnl [1]
atan2f [1]conjl [1]feraiseexcept [1]llround [1]scalbn [1]
atan2l [1]copysign [1]fesetenv [1]llroundf [1]scalbnf [1]
atanf [1]copysignf [1]fesetexceptflag [1]llroundl [1]scalbnl [1]
atanh [1]copysignl [1]fesetround [1]log [1]significand [2]
atanhf [1]cos [1]fetestexcept [1]log10 [1]significandf [2]
atanhl [1]cosf [1]feupdateenv [1]log10f [1]significandl [2]
atanl [1]cosh [1]finite [3]log10l [1]sin [1]
cabs [1]coshf [1]finitef [2]log1p [1]sincos [2]
cabsf [1]coshl [1]finitel [2]logb [1]sincosf [2]
cabsl [1]cosl [1]floor [1]logf [1]sincosl [2]
cacos [1]cpow [1]floorf [1]logl [1]sinf [1]
cacosf [1]cpowf [1]floorl [1]lrint [1]sinh [1]
cacosh [1]cpowl [1]fma [1]lrintf [1]sinhf [1]
cacoshf [1]cproj [1]fmaf [1]lrintl [1]sinhl [1]
cacoshl [1]cprojf [1]fmal [1]lround [1]sinl [1]
cacosl [1]cprojl [1]fmax [1]lroundf [1]sqrt [1]
carg [1]creal [1]fmaxf [1]lroundl [1]sqrtf [1]
cargf [1]crealf [1]fmaxl [1]matherr [2]sqrtl [1]
cargl [1]creall [1]fmin [1]modf [1]tan [1]
casin [1]csin [1]fminf [1]modff [1]tanf [1]
casinf [1]csinf [1]fminl [1]modfl [1]tanh [1]
casinh [1]csinh [1]fmod [1]nan [1]tanhf [1]
casinhf [1]csinhf [1]fmodf [1]nanf [1]tanhl [1]
casinhl [1]csinhl [1]fmodl [1]nanl [1]tanl [1]
casinl [1]csinl [1]frexp [1]nearbyint [1]tgamma [1]
catan [1]csqrt [1]frexpf [1]nearbyintf [1]tgammaf [1]
catanf [1]csqrtf [1]frexpl [1]nearbyintl [1]tgammal [1]
catanh [1]csqrtl [1]gamma [3]nextafter [1]trunc [1]
catanhf [1]ctan [1]gammaf [2]nextafterf [1]truncf [1]
catanhl [1]ctanf [1]gammal [2]nextafterl [1]truncl [1]
catanl [1]ctanh [1]hypot [1]nexttoward [1]y0 [1]
cbrt [1]ctanhf [1]hypotf [1]nexttowardf [1]y0f [2]
cbrtf [1]ctanhl [1]hypotl [1]nexttowardl [1]y0l [2]
cbrtl [1]ctanl [1]ilogb [1]pow [1]y1 [1]
ccos [1]dremf [2]ilogbf [1]pow10 [2]y1f [2]
ccosf [1]dreml [2]ilogbl [1]pow10f [2]y1l [2]
ccosh [1]erf [1]j0 [1]pow10l [2]yn [1]
ccoshf [1]erfc [1]j0f [2]powf [1]ynf [2]
ccoshl [1]erfcf [1]j0l [2]powl [1]ynl [2]
ccosl [1]erfcl [1]j1 [1]remainder [1] 
ceil [1]erff [1]j1f [2]remainderf [1] 
ceilf [1]erfl [1]j1l [2]remainderl [1] 
ceill [1]exp [1]jn [1]remquo [1] 

Referenced Specification(s)

An LSB conforming implementation shall provide the generic data interfaces for Math specified in Table 6-30, with the full functionality as described in the referenced underlying specification.

Table 6-30. libm - Math Data Interfaces

signgam [1]    

Referenced Specification(s)


Data Definitions for libm

This section defines global identifiers and their values that are associated with interfaces contained in libm. These definitions are organized into groups that correspond to system headers. This convention is used as a convenience for the reader, and does not imply the existence of these headers, or their content.

These definitions are intended to supplement those provided in the referenced underlying specifications.

This specification uses ISO/IEC 9899 C Language as the reference programming language, and data definitions are specified in ISO C format. The C language is used here as a convenient notation. Using a C language description of these data objects does not preclude their use by other programming languages.


complex.h


#define complex	_Complex

math.h


#define DOMAIN	1
#define SING	2

struct exception
{
  int type;
  char *name;
  double arg1;
  double arg2;
  double retval;
}
 ;
#define isinf(x)	(sizeof (x) == sizeof (float) ? __isinff (x): sizeof (x) == sizeof (double) ? __isinf (x) : __isinfl (x))
#define isnan(x)	(sizeof (x) == sizeof (float) ? __isnanf (x)  : sizeof (x) == sizeof (double) ? __isnan (x) : __isnanl (x))

#define HUGE_VAL	0x1.0p2047
#define HUGE_VALF	0x1.0p255f
#define HUGE_VALL	0x1.0p32767L

#define NAN	((float)0x7fc00000UL)
#define M_1_PI	0.31830988618379067154
#define M_LOG10E	0.43429448190325182765
#define M_2_PI	0.63661977236758134308
#define M_LN2	0.69314718055994530942
#define M_SQRT1_2	0.70710678118654752440
#define M_PI_4	0.78539816339744830962
#define M_2_SQRTPI	1.12837916709551257390
#define M_SQRT2	1.41421356237309504880
#define M_LOG2E	1.4426950408889634074
#define M_PI_2	1.57079632679489661923
#define M_LN10	2.30258509299404568402
#define M_E	2.7182818284590452354
#define M_PI	3.14159265358979323846
#define INFINITY	HUGE_VALF

#define MATH_ERRNO	1
#define MATH_ERREXCEPT	2

Interfaces for libpthread

Table 6-31 defines the library name and shared object name for the libpthread library

Table 6-31. libpthread Definition

Library:libpthread
SONAME:libpthread.so.0

The behavior of the interfaces in this library is specified by the following specifications:

Large File Support
Linux Standard Base
ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3


Realtime Threads


Interfaces for Realtime Threads

No external functions are defined for libpthread - Realtime Threads


Advanced Realtime Threads


Interfaces for Advanced Realtime Threads

No external functions are defined for libpthread - Advanced Realtime Threads


Posix Threads


Interfaces for Posix Threads

An LSB conforming implementation shall provide the generic functions for Posix Threads specified in Table 6-32, with the full functionality as described in the referenced underlying specification.

Table 6-32. libpthread - Posix Threads Function Interfaces

_pthread_cleanup_pop [1]pthread_cancel [2]pthread_join [2]pthread_rwlock_destroy [2]pthread_setconcurrency [2]
_pthread_cleanup_push [1]pthread_cond_broadcast [2]pthread_key_create [2]pthread_rwlock_init [2]pthread_setspecific [2]
pread [2]pthread_cond_destroy [2]pthread_key_delete [2]pthread_rwlock_rdlock [2]pthread_sigmask [2]
pread64 [3]pthread_cond_init [2]pthread_kill [2]pthread_rwlock_timedrdlock [2]pthread_testcancel [2]
pthread_attr_destroy [2]pthread_cond_signal [2]pthread_mutex_destroy [2]pthread_rwlock_timedwrlock [2]pwrite [2]
pthread_attr_getdetachstate [2]pthread_cond_timedwait [2]pthread_mutex_init [2]pthread_rwlock_tryrdlock [2]pwrite64 [3]
pthread_attr_getguardsize [2]pthread_cond_wait [2]pthread_mutex_lock [2]pthread_rwlock_trywrlock [2]sem_close [2]
pthread_attr_getschedparam [2]pthread_condattr_destroy [2]pthread_mutex_trylock [2]pthread_rwlock_unlock [2]sem_destroy [2]
pthread_attr_getstackaddr [2]pthread_condattr_getpshared [2]pthread_mutex_unlock [2]pthread_rwlock_wrlock [2]sem_getvalue [2]
pthread_attr_getstacksize [2]pthread_condattr_init [2]pthread_mutexattr_destroy [2]pthread_rwlockattr_destroy [2]sem_init [2]
pthread_attr_init [2]pthread_condattr_setpshared [2]pthread_mutexattr_getpshared [2]pthread_rwlockattr_getpshared [2]sem_open [2]
pthread_attr_setdetachstate [2]pthread_create [2]pthread_mutexattr_gettype [2]pthread_rwlockattr_init [2]sem_post [2]
pthread_attr_setguardsize [2]pthread_detach [2]pthread_mutexattr_init [2]pthread_rwlockattr_setpshared [2]sem_timedwait [2]
pthread_attr_setschedparam [2]pthread_equal [2]pthread_mutexattr_setpshared [2]pthread_self [2]sem_trywait [2]
pthread_attr_setstackaddr [2]pthread_exit [2]pthread_mutexattr_settype [2]pthread_setcancelstate [2]sem_unlink [2]
pthread_attr_setstacksize [2]pthread_getspecific [2]pthread_once [2]pthread_setcanceltype [2]sem_wait [2]

Referenced Specification(s)


Data Definitions for libpthread

This section defines global identifiers and their values that are associated with interfaces contained in libpthread. These definitions are organized into groups that correspond to system headers. This convention is used as a convenience for the reader, and does not imply the existence of these headers, or their content.

These definitions are intended to supplement those provided in the referenced underlying specifications.

This specification uses ISO/IEC 9899 C Language as the reference programming language, and data definitions are specified in ISO C format. The C language is used here as a convenient notation. Using a C language description of these data objects does not preclude their use by other programming languages.


pthread.h


#define PTHREAD_MUTEX_DEFAULT	1
#define PTHREAD_MUTEX_NORMAL	1
#define PTHREAD_MUTEX_TIMED_NP	1
#define PTHREAD_MUTEX_RECURSIVE	2
#define PTHREAD_RWLOCK_DEFAULT_NP	2
#define PTHREAD_MUTEX_ERRORCHECK	3
#define pthread_cleanup_pop(execute)	_pthread_cleanup_pop(& _buffer,(execute));}
#define __LOCK_INITIALIZER	{ 0, 0 }
#define PTHREAD_RWLOCK_INITIALIZER	{ __LOCK_INITIALIZER, 0, NULL, NULL, NULL,PTHREAD_RWLOCK_DEFAULT_NP, PTHREAD_PROCESS_PRIVATE }
#define PTHREAD_MUTEX_INITIALIZER	{0,0,0,PTHREAD_MUTEX_TIMED_NP,__LOCK_INITIALIZER}
#define pthread_cleanup_push(routine,arg)	{struct _pthread_cleanup_buffer _buffer;_pthread_cleanup_push(& _buffer,(routine),(arg));
#define PTHREAD_COND_INITIALIZER	{__LOCK_INITIALIZER,0}

struct _pthread_cleanup_buffer
{
  void (*__routine) (void *);
  void *__arg;
  int __canceltype;
  struct _pthread_cleanup_buffer *__prev;
}
 ;
typedef unsigned int pthread_key_t;
typedef int pthread_once_t;
typedef long long __pthread_cond_align_t;

typedef unsigned long pthread_t;
struct _pthread_fastlock
{
  long __status;
  int __spinlock;
}
 ;

typedef struct _pthread_descr_struct *_pthread_descr;

typedef struct
{
  int __m_reserved;
  int __m_count;
  _pthread_descr __m_owner;
  int __m_kind;
  struct _pthread_fastlock __m_lock;
}
pthread_mutex_t;
typedef struct
{
  int __mutexkind;
}
pthread_mutexattr_t;

typedef struct
{
  int __detachstate;
  int __schedpolicy;
  struct sched_param __schedparam;
  int __inheritsched;
  int __scope;
  size_t __guardsize;
  int __stackaddr_set;
  void *__stackaddr;
  unsigned long __stacksize;
}
pthread_attr_t;

typedef struct
{
  struct _pthread_fastlock __c_lock;
  _pthread_descr __c_waiting;
  char __padding[48 - sizeof (struct _pthread_fastlock) -
		 sizeof (_pthread_descr) - sizeof (__pthread_cond_align_t)];
  __pthread_cond_align_t __align;
}
pthread_cond_t;
typedef struct
{
  int __dummy;
}
pthread_condattr_t;

typedef struct _pthread_rwlock_t
{
  struct _pthread_fastlock __rw_lock;
  int __rw_readers;
  _pthread_descr __rw_writer;
  _pthread_descr __rw_read_waiting;
  _pthread_descr __rw_write_waiting;
  int __rw_kind;
  int __rw_pshared;
}
pthread_rwlock_t;
typedef struct
{
  int __lockkind;
  int __pshared;
}
pthread_rwlockattr_t;

#define PTHREAD_CREATE_JOINABLE	0
#define PTHREAD_INHERIT_SCHED	0
#define PTHREAD_ONCE_INIT	0
#define PTHREAD_PROCESS_PRIVATE	0
#define PTHREAD_CREATE_DETACHED	1
#define PTHREAD_EXPLICIT_SCHED	1
#define PTHREAD_PROCESS_SHARED	1

#define PTHREAD_CANCELED	((void*)-1)
#define PTHREAD_CANCEL_DEFERRED	0
#define PTHREAD_CANCEL_ENABLE	0
#define PTHREAD_CANCEL_ASYNCHRONOUS	1
#define PTHREAD_CANCEL_DISABLE	1

semaphore.h


typedef struct
{
  struct _pthread_fastlock __sem_lock;
  int __sem_value;
  _pthread_descr __sem_waiting;
}
sem_t;
#define SEM_FAILED	((sem_t*)0)

#define SEM_VALUE_MAX	((int)((~0u)>>1))

Interface Definitions for libpthread

Table of Contents
_pthread_cleanup_pop -- establish cancellation handlers
_pthread_cleanup_push -- establish cancellation handlers

The following interfaces are included in libpthread and are defined by this specification. Unless otherwise noted, these interfaces shall be included in the source standard.

Other interfaces listed above for libpthread shall behave as described in the referenced base document.

_pthread_cleanup_pop

Name

_pthread_cleanup_pop -- establish cancellation handlers

Synopsis

#include <pthread.h>

extern void _pthread_cleanup_pop(struct _pthread_cleanup_buffer *, int);

Description

Macro pthread_cleanup_pop defines the ABI _pthread_cleanup_pop is as specified in the Single UNIX Specification, Version 3.

_pthread_cleanup_push

Name

_pthread_cleanup_push -- establish cancellation handlers

Synopsis

#include <pthread.h>

extern void _pthread_cleanup_push(struct _pthread_cleanup_buffer *, void (*) (void *), void *);

Description

Macro pthread_cleanup_push defines the ABI _pthread_cleanup_push is as specified in the Single UNIX Specification, Version 3.


Interfaces for libgcc_s

Table 6-33 defines the library name and shared object name for the libgcc_s library

Table 6-33. libgcc_s Definition

Library:libgcc_s
SONAME:libgcc_s.so.1


Unwind Library


Interfaces for Unwind Library

No external functions are defined for libgcc_s - Unwind Library


Data Definitions for libgcc_s

This section defines global identifiers and their values that are associated with interfaces contained in libgcc_s. These definitions are organized into groups that correspond to system headers. This convention is used as a convenience for the reader, and does not imply the existence of these headers, or their content.

These definitions are intended to supplement those provided in the referenced underlying specifications.

This specification uses ISO/IEC 9899 C Language as the reference programming language, and data definitions are specified in ISO C format. The C language is used here as a convenient notation. Using a C language description of these data objects does not preclude their use by other programming languages.


unwind.h


struct dwarf_eh_base
{
  void *tbase;
  void *dbase;
  void *func;
}
 ;
struct _Unwind_Context;

typedef unsigned int _Unwind_Ptr;
typedef unsigned int _Unwind_Word;

typedef enum
{
  _URC_NO_REASON, _URC_FOREIGN_EXCEPTION_CAUGHT = 1, _URC_FATAL_PHASE2_ERROR =
    2, _URC_FATAL_PHASE1_ERROR = 3, _URC_NORMAL_STOP = 4, _URC_END_OF_STACK =
    5, _URC_HANDLER_FOUND = 6, _URC_INSTALL_CONTEXT =
    7, _URC_CONTINUE_UNWIND = 8
}
_Unwind_Reason_Code;

struct _Unwind_Exception
{
  _Unwind_Exception_Class;
  _Unwind_Exception_Cleanup_Fn;
  _Unwind_Word;
  _Unwind_Word;
}
 ;
#define _UA_SEARCH_PHASE	1
#define _UA_END_OF_STACK	16
#define _UA_CLEANUP_PHASE	2
#define _UA_HANDLER_FRAME	4
#define _UA_FORCE_UNWIND	8

Interfaces for libdl

Table 6-34 defines the library name and shared object name for the libdl library

Table 6-34. libdl Definition

Library:libdl
SONAME:libdl.so.2

The behavior of the interfaces in this library is specified by the following specifications:

Linux Standard Base
ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3


Dynamic Loader


Interfaces for Dynamic Loader

An LSB conforming implementation shall provide the generic functions for Dynamic Loader specified in Table 6-35, with the full functionality as described in the referenced underlying specification.

Table 6-35. libdl - Dynamic Loader Function Interfaces

dladdr [1]dlclose [2]dlerror [2]dlopen [1]dlsym [1]

Referenced Specification(s)


Data Definitions for libdl

This section defines global identifiers and their values that are associated with interfaces contained in libdl. These definitions are organized into groups that correspond to system headers. This convention is used as a convenience for the reader, and does not imply the existence of these headers, or their content.

These definitions are intended to supplement those provided in the referenced underlying specifications.

This specification uses ISO/IEC 9899 C Language as the reference programming language, and data definitions are specified in ISO C format. The C language is used here as a convenient notation. Using a C language description of these data objects does not preclude their use by other programming languages.


dlfcn.h


#define RTLD_NEXT	((void *) -1l)
#define RTLD_LOCAL	0
#define RTLD_LAZY	0x00001
#define RTLD_NOW	0x00002
#define RTLD_GLOBAL	0x00100

typedef struct
{
  char *dli_fname;
  void *dli_fbase;
  char *dli_sname;
  void *dli_saddr;
}
Dl_info;

Interface Definitions for libdl

Table of Contents
dladdr -- library routine for dynamic linking of object files
dlopen -- open dynamic object
dlsym -- obtain the address of a symbol from a dlopen object

The following interfaces are included in libdl and are defined by this specification. Unless otherwise noted, these interfaces shall be included in the source standard.

Other interfaces listed above for libdl shall behave as described in the referenced base document.

dladdr

Name

dladdr -- library routine for dynamic linking of object files

Synopsis

#include <dlfcn.h>

typedef struct {
             const char  *dli_fname;
             void        *dli_fbase;
             const char  *dli_sname;
             void        *dli_saddr;
} Dl_info;

int dladdr(void *address, Dl_info *dlip);

Description

dladdr implements the System V dynamic linking routines.

Return Value

dladdr is the inverse of dlsym. If address is successfully located inside a module, dladdr returns a nonzero value, otherwise, it returns a 0. On success, dladdr fills in the fields of dlip as follows:

dli_fname

the pathname of the module

dli_fbase

the base address of the module

dli_sname

the name of the highest addressed symbol whose address precedes the given address

dli_saddr

the address of that symbol

Shared objects shall be linked using the -shared option to the linker ld(1). The linker flag -rpath may be used to add a directory to the default search path for shared objects and shared libraries. The linker flag -E or the C compiler flag -rdynamic should be used to cause the application to export its symbols to the shared objects.

Environment

LD_LIBRARY_PATH

directory search-path for object files

dlopen

Name

dlopen -- open dynamic object

Synopsis

#include <dlfcn.h>

void * dlopen(const char *filename, int flag);

Description

dlopen shall behave as specified in ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3, but with additional behaviors listed below.

If the file argument does not contain a slash character, then the system shall look for a library of that name in at least the following directories, and use the first one which is found:

  • The directories specified by the DT_RPATH dynamic entry.

  • The directories specified in the LD_LIBRARY_PATH environment variable (which is a colon separated list of pathnames). This step shall be skipped for setuid and setgid executables.

  • A set of directories sufficient to contain the libraries specified in this standard. [14]

dlsym

Name

dlsym -- obtain the address of a symbol from a dlopen object

Description

dlsym is as specified in the ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3, but with differences as listed below.

The special purpose value for handle RTLD_NEXT

The value RTLD_NEXT, which is reserved for future use shall be available, with the behavior as described in ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3.


Interfaces for libcrypt

Table 6-36 defines the library name and shared object name for the libcrypt library

Table 6-36. libcrypt Definition

Library:libcrypt
SONAME:libcrypt.so.1

The behavior of the interfaces in this library is specified by the following specifications:

ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3


Encryption


Interfaces for Encryption

An LSB conforming implementation shall provide the generic functions for Encryption specified in Table 6-37, with the full functionality as described in the referenced underlying specification.

Table 6-37. libcrypt - Encryption Function Interfaces

crypt [1]encrypt [1]setkey [1]  

Referenced Specification(s)


Interfaces for libpam

Table 6-38 defines the library name and shared object name for the libpam library

Table 6-38. libpam Definition

Library:libpam
SONAME:libpam.so.0

A single service name, other, shall always be present. The behavior of this service shall be determined by the system administrator. Additional service names may also exist. [15]

The behavior of the interfaces in this library is specified by the following specifications:

Linux Standard Base


Pluggable Authentication API


Interfaces for Pluggable Authentication API

An LSB conforming implementation shall provide the generic functions for Pluggable Authentication API specified in Table 6-39, with the full functionality as described in the referenced underlying specification.

Table 6-39. libpam - Pluggable Authentication API Function Interfaces

pam_acct_mgmt [1]pam_close_session [1]pam_get_item [1]pam_set_item [1]pam_strerror [1]
pam_authenticate [1]pam_end [1]pam_getenvlist [1]pam_setcred [1] 
pam_chauthtok [1]pam_fail_delay [1]pam_open_session [1]pam_start [1] 

Referenced Specification(s)


Data Definitions for libpam

This section defines global identifiers and their values that are associated with interfaces contained in libpam. These definitions are organized into groups that correspond to system headers. This convention is used as a convenience for the reader, and does not imply the existence of these headers, or their content.

These definitions are intended to supplement those provided in the referenced underlying specifications.

This specification uses ISO/IEC 9899 C Language as the reference programming language, and data definitions are specified in ISO C format. The C language is used here as a convenient notation. Using a C language description of these data objects does not preclude their use by other programming languages.


security/pam_appl.h


typedef struct pam_handle pam_handle_t;
struct pam_message
{
  int msg_style;
  const char *msg;
}
 ;
struct pam_response
{
  char *resp;
  int resp_retcode;
}
 ;

struct pam_conv
{
  int (*conv) (int num_msg, const struct pam_message * *msg,
	       struct pam_response * *resp, void *appdata_ptr);
  void *appdata_ptr;
}
 ;
#define PAM_PROMPT_ECHO_OFF	1
#define PAM_PROMPT_ECHO_ON	2
#define PAM_ERROR_MSG	3
#define PAM_TEXT_INFO	4

#define PAM_SERVICE	1
#define PAM_USER	2
#define PAM_TTY	3
#define PAM_RHOST	4
#define PAM_CONV	5
#define PAM_RUSER	8
#define PAM_USER_PROMPT	9

#define PAM_SUCCESS	0
#define PAM_OPEN_ERR	1
#define PAM_USER_UNKNOWN	10
#define PAM_MAXTRIES	11
#define PAM_NEW_AUTHTOK_REQD	12
#define PAM_ACCT_EXPIRED	13
#define PAM_SESSION_ERR	14
#define PAM_CRED_UNAVAIL	15
#define PAM_CRED_EXPIRED	16
#define PAM_CRED_ERR	17
#define PAM_CONV_ERR	19
#define PAM_SYMBOL_ERR	2
#define PAM_AUTHTOK_ERR	20
#define PAM_AUTHTOK_RECOVER_ERR	21
#define PAM_AUTHTOK_LOCK_BUSY	22
#define PAM_AUTHTOK_DISABLE_AGING	23
#define PAM_TRY_AGAIN	24
#define PAM_ABORT	26
#define PAM_AUTHTOK_EXPIRED	27
#define PAM_BAD_ITEM	29
#define PAM_SERVICE_ERR	3
#define PAM_SYSTEM_ERR	4
#define PAM_BUF_ERR	5
#define PAM_PERM_DENIED	6
#define PAM_AUTH_ERR	7
#define PAM_CRED_INSUFFICIENT	8
#define PAM_AUTHINFO_UNAVAIL	9

#define PAM_DISALLOW_NULL_AUTHTOK	0x0001U
#define PAM_ESTABLISH_CRED	0x0002U
#define PAM_DELETE_CRED	0x0004U
#define PAM_REINITIALIZE_CRED	0x0008U
#define PAM_REFRESH_CRED	0x0010U
#define PAM_CHANGE_EXPIRED_AUTHTOK	0x0020U
#define PAM_SILENT	0x8000U

Interface Definitions for libpam

Table of Contents
pam_acct_mgmt -- establish the status of a user's account
pam_authenticate -- authenticate the user
pam_chauthtok -- change the authentication token for a given user
pam_close_session -- indicate that an authenticated session has ended
pam_end -- terminate the use of the PAM library
pam_fail_delay -- specify delay time to use on authentication error
pam_get_item -- obtain the value of the indicated item.
pam_getenvlist -- returns a pointer to the complete PAM environment.
pam_open_session -- used to indicate that an authenticated session has been initiated
pam_set_item -- (re)set the value of an item.
pam_setcred -- set the module-specific credentials of the user
pam_start -- initialize the PAM library
pam_strerror -- returns a string describing the PAM error

The following interfaces are included in libpam and are defined by this specification. Unless otherwise noted, these interfaces shall be included in the source standard.

Other interfaces listed above for libpam shall behave as described in the referenced base document.

pam_acct_mgmt

Name

pam_acct_mgmt -- establish the status of a user's account

Synopsis

#include <security/pam_appl.h>

extern int pam_acct_mgmt(pam_handle_t *pamh, int flags);

Description

pam_acct_mgmt establishes the account's usability and the user's accessibility to the system. It is typically called after the user has been authenticated.

flags may be specified as any valid flag (namely, one of those applicable to the flags argument of pam_authenticate). Additionally, the value of flags may be logically or'd with PAM_SILENT.

Return Value

PAM_SUCCESS

Success.

PAM_NEW_AUTHTOK_REQD

User is valid, but user's authentication token has expired. The correct response to this return-value is to require that the user satisfy the pam_chauthtok function before obtaining service. It may not be possible for an application to do this. In such a case, the user should be denied access until the account password is updated.

PAM_ACCT_EXPIRED

User is no longer permitted access to the system.

PAM_AUTH_ERR

Authentication error.

PAM_PERM_DENIED

User is not permitted to gain access at this time.

PAM_USER_UNKNOWN

User is not known to a module's account management component.

Errors

May be translated to text with pam_strerror.

pam_authenticate

Name

pam_authenticate -- authenticate the user

Synopsis

#include <security/pam_appl.h>

extern int pam_authenticate(pam_handle_t *pamh, int flags);

Description

pam_authenticate serves as an interface to the authentication mechanisms of the loaded modules.

flags is an optional parameter that may be specified by the following value:

PAM_DISALLOW_NULL_AUTHTOK

Instruct the authentication modules to return PAM_AUTH_ERR if the user does not have a registered authorization token.

Additionally, the value of flags may be logically or'd with PAM_SILENT.

The process may need to be privileged in order to successfully call this function.

Return Value

PAM_SUCCESS

Success.

PAM_AUTH_ERR

User was not authenticated or process did not have sufficient privileges to perform authentication.

PAM_CRED_INSUFFICIENT

Application does not have sufficient credentials to authenticate the user.

PAM_AUTHINFO_UNAVAIL

Modules were not able to access the authentication information. This might be due to a network or hardware failure, etc.

PAM_USER_UNKNOWN

Supplied username is not known to the authentication service.

PAM_MAXTRIES

One or more authentication modules has reached its limit of tries authenticating the user. Do not try again.

PAM_ABORT

One or more authentication modules failed to load.

Errors

May be translated to text with pam_strerror.

pam_chauthtok

Name

pam_chauthtok -- change the authentication token for a given user

Synopsis

#include <security/pam_appl.h>

extern int pam_chauthtok(pam_handle_t *pamh, const int flags);

Description

pam_chauthtok is used to change the authentication token for a given user as indicated by the state associated with the handle pamh.

flags is an optional parameter that may be specified by the following value:

PAM_CHANGE_EXPIRED_AUTHTOK

User's authentication token should only be changed if it has expired.

Additionally, the value of flags may be logically or'd with PAM_SILENT.

RETURN VALUE

PAM_SUCCESS

Success.

PAM_AUTHTOK_ERR

A module was unable to obtain the new authentication token.

PAM_AUTHTOK_RECOVER_ERR

A module was unable to obtain the old authentication token.

PAM_AUTHTOK_LOCK_BUSY

One or more modules were unable to change the authentication token since it is currently locked.

PAM_AUTHTOK_DISABLE_AGING

Authentication token aging has been disabled for at least one of the modules.

PAM_PERM_DENIED

Permission denied.

PAM_TRY_AGAIN

Not all modules were in a position to update the authentication token(s). In such a case, none of the user's authentication tokens are updated.

PAM_USER_UNKNOWN

User is not known to the authentication token changing service.

ERRORS

May be translated to text with pam_strerror.

pam_close_session

Name

pam_close_session -- indicate that an authenticated session has ended

Synopsis

#include <security/pam_appl.h>

extern int pam_close_session(pam_handle_t *pamh, int flags);

Description

pam_close_session is used to indicate that an authenticated session has ended. It is used to inform the module that the user is exiting a session. It should be possible for the PAM library to open a session and close the same session from different applications.

flags may have the value PAM_SILENT to indicate that no output should be generated as a result of this function call.

Return Value

PAM_SUCCESS

Success.

PAM_SESSION_ERR

One of the required loaded modules was unable to close a session for the user.

Errors

May be translated to text with pam_strerror.

pam_end

Name

pam_end -- terminate the use of the PAM library

Synopsis

#include <security/pam_appl.h>

extern int pam_end(pam_handle_t *pamh, int pam_status);

Description

pam_end terminates use of the PAM library. On success, the contents of *pamh are no longer valid, and all memory associated with it is invalid.

Normally, pam_status is passed the value PAM_SUCCESS, but in the event of an unsuccessful service application, the appropriate PAM error return value should be used.

Return Value

PAM_SUCCESS

Success.

Errors

May be translated to text with pam_strerror.

pam_fail_delay

Name

pam_fail_delay -- specify delay time to use on authentication error

Synopsis

#include <security/pam_appl.h>

extern int pam_fail_delay(pam_handle_t *pamh, unsigned int micro_sec);

Description

pam_fail_delay specifies the minimum delay for the PAM library to use when an authentication error occurs. The actual delay can vary by as much at 25%. If this function is called multiple times, the longest time specified by any of the call will be used.

The delay is invoked if an authentication error occurs during the pam_authenticate or pam_chauthtok function calls.

Independent of the success of pam_authenticate or pam_chauthtok, the delay time is reset to its default value of 0 when the PAM library returns control to the application from these two functions.

Return Value

PAM_SUCCESS

Success.

Errors

May be translated to text with pam_strerror.

pam_get_item

Name

pam_get_item -- obtain the value of the indicated item.

Synopsis

#include <security/pam_appl.h>

extern int pam_get_item(const pam_handle_t *pamh, int item_type, const void **item);

Description

pam_get_item obtains the value of the indicated item_type. The possible values of item_type are the same as listed for pam_set_item.

On success, item contains a pointer to the value of the corresponding item. Note that this is a pointer to the actual data and should not be free'd or over-written.

Return Value

PAM_SUCCESS

Success.

PAM_PERM_DENIED

Application passed a NULL pointer for item.

PAM_BAD_ITEM

Application attempted to get an undefined item.

Errors

May be translated to text with pam_strerror.

pam_getenvlist

Name

pam_getenvlist -- returns a pointer to the complete PAM environment.

Synopsis

#include <security/pam_appl.h>

extern char * const *pam_getenvlist(pam_handle_t *pamh);

Description

pam_getenvlist returns a pointer to the complete PAM environment. This pointer points to an array of pointers to NUL-terminated strings and must be terminated by a NULL pointer. Each string has the form "name=value".

The PAM library module allocates memory for the returned value and the associated strings. The calling application is responsible for freeing this memory.

Return Value

pam_getenvlist returns an array of string pointers containing the PAM environment. On error, NULL is returned.

pam_open_session

Name

pam_open_session -- used to indicate that an authenticated session has been initiated

Synopsis

#include <security/pam_appl.h>

extern int pam_open_session(pam_handle_t *pamh, int flags);

Description

pam_handle_t is used to indicate that an authenticated session has begun. It is used to inform the module that the user is currently in a session. It should be possible for the PAM library to open a session and close the same session from different applications.

flags may have the value PAM_SILENT to indicate that no output be generated as a rsult of this function call.

Return Value

PAM_SUCCESS

Success.

PAM_SESSION_ERR

One of the loaded modules was unable to open a session for the user.

ERRORS

May be translated to text with pam_strerror.

pam_set_item

Name

pam_set_item -- (re)set the value of an item.

Synopsis

#include <security/pam_appl.h>

extern int pam_set_item(pam_handle_t *pamh, int item_type, const void *item);

Description

pam_set_item (re)sets the value of one of the following item_types:

PAM_SERVICE

service name

PAM_USER

user name

PAM_TTY

terminal name

The value for a device file should include the /dev/ prefix. The value for graphical, X-based, applications should be the $DISPLAY variable.

PAM_RHOST

remote host name

PAM_CONV

conversation structure

PAM_RUSER

remote user name

PAM_USER_PROMPT

string to be used when prompting for a user's name

The default value for this string is Please enter username: .

For all item_types other than PAM_CONV, item is a pointer to a NULL-terminated character string. In the case of PAM_CONV, item points to an initialized pam_conv structure.

Return Value

PAM_SUCCESS

Success.

PAM_PERM_DENIED

An attempt was made to replace the conversation structure with a NULL value.

PAM_BUF_ERR

Function ran out of memory making a copy of the item.

PAM_BAD_ITEM

Application attempted to set an undefined item.

Errors

May be translated to text with pam_strerror.

pam_setcred

Name

pam_setcred -- set the module-specific credentials of the user

Synopsis

#include <security/pam_appl.h>

extern int pam_setcred(pam_handle_t *pamh, int flags);

Description

pam_setcred sets the module-specific credentials of the user. It is usually called after the user has been authenticated, after the account management function has been called and after a session has been opened for the user.

flags maybe specified from among the following values:

PAM_ESTABLISH_CRED

set credentials for the authentication service

PAM_DELETE_CRED

delete credentials associated with the authentication service

PAM_REINITIALIZE_CRED

reinitialize the user credentials

PAM_REFRESH_CRED

extend lifetime of the user credentials

Additionally, the value of flags may be logically or'd with PAM_SILENT.

Return Value

PAM_SUCCESS

Success.

PAM_CRED_UNAVAIL

Module cannot retrieve the user's credentials.

PAM_CRED_EXPIRED

User's credentials have expired.

PAM_USER_UNKNOWN

User is not known to an authentication module.

PAM_CRED_ERR

Module was unable to set the credentials of the user.

Errors

May be translated to text with pam_strerror.

pam_start

Name

pam_start -- initialize the PAM library

Synopsis

#include <security/pam_appl.h>

extern int pam_start(const char *service_name, const char *user, const (struct pam_conv *pam_conversation), pam_handle_t **pamh);

Description

pam_start is used to initialize the PAM library. It must be called prior to any other usage of the PAM library. On success, *pamh becomes a handle that provides continuity for successive calls to the PAM library. pam_start expects arguments as follows: the service_name of the program, the username of the individual to be authenticated, a pointer to an application-supplied pam_conv structure, and a pointer to a pam_handle_t pointer.

An application must provide the conversation function used for direct communication between a loaded module and the application. The application also typically provides a means for the module to prompt the user for a password, etc.

The structure, pam_conv, is defined to be,
  struct pam_conv {
               int (*conv) (int num_msg,
                            const struct pam_message * *msg,
                            struct pam_response * *resp,
                            void *appdata_ptr);
               void *appdata_ptr;
  };
It is initialized by the application before it is passed to the library. The contents of this structure are attached to the *pamh handle. The point of this argument is to provide a mechanism for any loaded module to interact directly with the application program; this is why it is called a conversation structure.

When a module calls the referenced conv function, appdata_ptr is set to the second element of this structure.

The other arguments of a call to conv concern the information exchanged by module and application. num_msg holds the length of the array of pointers passed via msg. On success, the pointer resp points to an array of num_msg pam_response structures, holding the application-supplied text. Note that resp is a struct pam_response array and not an array of pointers.

Return Value

PAM_SUCCESS

Success.

PAM_BUF_ERR

Memory allocation error.

PAM_ABORT

Internal failure.

ERRORS

May be translated to text with pam_strerror.

pam_strerror

Name

pam_strerror -- returns a string describing the PAM error

Synopsis

#include <security/pam_appl.h>

extern const char * pam_strerror(pam_handle_t *pamh, int errnum);

Description

pam_strerror returns a string describing the PAM error associated with errnum.

Return Value

On success, this function returns a description of the indicated error. The application should not free or modify this string. This returned string will not be translated.

III. Utility Libraries

Table of Contents
7. Libraries

Chapter 7. Libraries

An LSB-conforming implementation may also support some utility libraries which are built on top of the interfaces provided by the base libraries. These libraries implement common functionality, and hide additional system dependent information such as file formats and device names.


Interfaces for libz

Table 7-1 defines the library name and shared object name for the libz library

Table 7-1. libz Definition

Library:libz
SONAME:libz.so.1

The behavior of the interfaces in this library is specified by the following specifications:

zlib 1.2 Manual


Compression Library


Interfaces for Compression Library

An LSB conforming implementation shall provide the generic functions for Compression Library specified in Table 7-2, with the full functionality as described in the referenced underlying specification.

Table 7-2. libz - Compression Library Function Interfaces

adler32 [1]deflateInit_ [1]gzerror [1]gzread [1]inflateInit2_ [1]
compress [1]deflateParams [1]gzflush [1]gzrewind [1]inflateInit_ [1]
compress2 [1]deflateReset [1]gzgetc [1]gzseek [1]inflateReset [1]
crc32 [1]deflateSetDictionary [1]gzgets [1]gzsetparams [1]inflateSetDictionary [1]
deflate [1]get_crc_table [1]gzopen [1]gztell [1]inflateSync [1]
deflateCopy [1]gzclose [1]gzprintf [1]gzwrite [1]inflateSyncPoint [1]
deflateEnd [1]gzdopen [1]gzputc [1]inflate [1]uncompress [1]
deflateInit2_ [1]gzeof [1]gzputs [1]inflateEnd [1]zError [1]

Referenced Specification(s)


Data Definitions for libz

This section defines global identifiers and their values that are associated with interfaces contained in libz. These definitions are organized into groups that correspond to system headers. This convention is used as a convenience for the reader, and does not imply the existence of these headers, or their content.

These definitions are intended to supplement those provided in the referenced underlying specifications.

This specification uses ISO/IEC 9899 C Language as the reference programming language, and data definitions are specified in ISO C format. The C language is used here as a convenient notation. Using a C language description of these data objects does not preclude their use by other programming languages.


zlib.h


#define Z_NULL	0
#define MAX_WBITS	15
#define MAX_MEM_LEVEL	9
#define deflateInit2(strm,level,method,windowBits,memLevel,strategy)	deflateInit2_((strm),(level),(method),(windowBits),(memLevel),(strategy),ZLIB_VERSION,sizeof(z_stream))
#define deflateInit(strm,level)	deflateInit_((strm), (level),       ZLIB_VERSION, sizeof(z_stream))
#define inflateInit2(strm,windowBits)	inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
#define inflateInit(strm)	inflateInit_((strm),                ZLIB_VERSION, sizeof(z_stream))

typedef int intf;

typedef void *voidpf;
typedef unsigned int uInt;
typedef unsigned long uLong;
typedef uLong uLongf;
typedef void *voidp;
typedef unsigned char Byte;
typedef off_t z_off_t;
typedef void *const voidpc;

typedef voidpf (*alloc_func) (voidpf opaque, uInt items, uInt size);
typedef void (*free_func) (voidpf opaque, voidpf address);
struct internal_state
{
  int dummy;
}
 ;
typedef Byte Bytef;
typedef uInt uIntf;

typedef struct z_stream_s
{
  Bytef *next_in;
  uInt avail_in;
  uLong total_in;
  Bytef *next_out;
  uInt avail_out;
  uLong total_out;
  char *msg;
  struct internal_state *state;
  alloc_func zalloc;
  free_func zfree;
  voidpf opaque;
  int data_type;
  uLong adler;
  uLong reserved;
}
z_stream;

typedef z_stream *z_streamp;
typedef voidp gzFile;
#define Z_NO_FLUSH	0
#define Z_PARTIAL_FLUSH	1
#define Z_SYNC_FLUSH	2
#define Z_FULL_FLUSH	3
#define Z_FINISH	4

#define Z_ERRNO	(-1)
#define Z_STREAM_ERROR	(-2)
#define Z_DATA_ERROR	(-3)
#define Z_MEM_ERROR	(-4)
#define Z_BUF_ERROR	(-5)
#define Z_OK	0
#define Z_STREAM_END	1
#define Z_NEED_DICT	2

#define Z_DEFAULT_COMPRESSION	(-1)
#define Z_NO_COMPRESSION	0
#define Z_BEST_SPEED	1
#define Z_BEST_COMPRESSION	9

#define Z_DEFAULT_STRATEGY	0
#define Z_FILTERED	1
#define Z_HUFFMAN_ONLY	2

#define Z_BINARY	0
#define Z_ASCII	1
#define Z_UNKNOWN	2

#define Z_DEFLATED	8

Interfaces for libncurses

Table 7-3 defines the library name and shared object name for the libncurses library

Table 7-3. libncurses Definition

Library:libncurses
SONAME:libncurses.so.5

The behavior of the interfaces in this library is specified by the following specifications:

CAE Specification, May 1996, X/Open Curses, Issue 4, Version 2 (ISBN: 1-85912-171-3, C610), plus Corrigendum U018


Curses


Interfaces for Curses

An LSB conforming implementation shall provide the generic functions for Curses specified in Table 7-4, with the full functionality as described in the referenced underlying specification.

Table 7-4. libncurses - Curses Function Interfaces

addch [1]has_ic [1]mvwaddchnstr [1]scr_init [1]vwscanw [1]
addchnstr [1]has_il [1]mvwaddchstr [1]scr_restore [1]waddch [1]
addchstr [1]hline [1]mvwaddnstr [1]scr_set [1]waddchnstr [1]
addnstr [1]idcok [1]mvwaddstr [1]scrl [1]waddchstr [1]
addstr [1]idlok [1]mvwchgat [1]scroll [1]waddnstr [1]
attr_get [1]immedok [1]mvwdelch [1]scrollok [1]waddstr [1]
attr_off [1]inch [1]mvwgetch [1]set_curterm [1]wattr_get [1]
attr_on [1]inchnstr [1]mvwgetnstr [1]set_term [1]wattr_off [1]
attr_set [1]inchstr [1]mvwgetstr [1]setscrreg [1]wattr_on [1]
attroff [1]init_color [1]mvwhline [1]setupterm [1]wattr_set [1]
attron [1]init_pair [1]mvwin [1]slk_attr_set [1]wattroff [1]
attrset [1]initscr [1]mvwinch [1]slk_attroff [1]wattron [1]
baudrate [1]innstr [1]mvwinchnstr [1]slk_attron [1]wattrset [1]
beep [1]insch [1]mvwinchstr [1]slk_attrset [1]wbkgd [1]
bkgd [1]insdelln [1]mvwinnstr [1]slk_clear [1]wbkgdset [1]
bkgdset [1]insertln [1]mvwinsch [1]slk_color [1]wborder [1]
border [1]insnstr [1]mvwinsnstr [1]slk_init [1]wchgat [1]
box [1]insstr [1]mvwinsstr [1]slk_label [1]wclear [1]
can_change_color [1]instr [1]mvwinstr [1]slk_noutrefresh [1]wclrtobot [1]
cbreak [1]intrflush [1]mvwprintw [1]slk_refresh [1]wclrtoeol [1]
chgat [1]is_linetouched [1]mvwscanw [1]slk_restore [1]wcolor_set [1]
clear [1]is_wintouched [1]mvwvline [1]slk_set [1]wcursyncup [1]
clearok [1]isendwin [1]napms [1]slk_touch [1]wdelch [1]
clrtobot [1]keyname [1]newpad [1]standend [1]wdeleteln [1]
clrtoeol [1]keypad [1]newterm [1]standout [1]wechochar [1]
color_content [1]killchar [1]newwin [1]start_color [1]werase [1]
color_set [1]leaveok [1]nl [1]subpad [1]wgetch [1]
copywin [1]longname [1]nocbreak [1]subwin [1]wgetnstr [1]
curs_set [1]meta [1]nodelay [1]syncok [1]wgetstr [1]
def_prog_mode [1]move [1]noecho [1]termattrs [1]whline [1]
def_shell_mode [1]mvaddch [1]nonl [1]termname [1]winch [1]
del_curterm [1]mvaddchnstr [1]noqiflush [1]tgetent [1]winchnstr [1]
delay_output [1]mvaddchstr [1]noraw [1]tgetflag [1]winchstr [1]
delch [1]mvaddnstr [1]notimeout [1]tgetnum [1]winnstr [1]
deleteln [1]mvaddstr [1]overlay [1]tgetstr [1]winsch [1]
delscreen [1]mvchgat [1]overwrite [1]tgoto [1]winsdelln [1]
delwin [1]mvcur [1]pair_content [1]tigetflag [1]winsertln [1]
derwin [1]mvdelch [1]pechochar [1]tigetnum [1]winsnstr [1]
doupdate [1]mvderwin [1]pnoutrefresh [1]tigetstr [1]winsstr [1]
dupwin [1]mvgetch [1]prefresh [1]timeout [1]winstr [1]
echo [1]mvgetnstr [1]printw [1]touchline [1]wmove [1]
echochar [1]mvgetstr [1]putp [1]touchwin [1]wnoutrefresh [1]
endwin [1]mvhline [1]putwin [1]tparm [1]wprintw [1]
erase [1]mvinch [1]qiflush [1]tputs [1]wredrawln [1]
erasechar [1]mvinchnstr [1]raw [1]typeahead [1]wrefresh [1]
filter [1]mvinchstr [1]redrawwin [1]unctrl [1]wscanw [1]
flash [1]mvinnstr [1]refresh [1]ungetch [1]wscrl [1]
flushinp [1]mvinsch [1]reset_prog_mode [1]untouchwin [1]wsetscrreg [1]
getbkgd [1]mvinsnstr [1]reset_shell_mode [1]use_env [1]wstandend [1]
getch [1]mvinsstr [1]resetty [1]vidattr [1]wstandout [1]
getnstr [1]mvinstr [1]restartterm [1]vidputs [1]wsyncdown [1]
getstr [1]mvprintw [1]ripoffline [1]vline [1]wsyncup [1]
getwin [1]mvscanw [1]savetty [1]vw_printw [1]wtimeout [1]
halfdelay [1]mvvline [1]scanw [1]vw_scanw [1]wtouchln [1]
has_colors [1]mvwaddch [1]scr_dump [1]vwprintw [1]wvline [1]

Referenced Specification(s)

An LSB conforming implementation shall provide the generic data interfaces for Curses specified in Table 7-5, with the full functionality as described in the referenced underlying specification.

Table 7-5. libncurses - Curses Data Interfaces

COLORS [1]COLS [1]acs_map [1]curscr [1] 
COLOR_PAIRS [1]LINES [1]cur_term [1]stdscr [1] 

Referenced Specification(s)


Data Definitions for libncurses

This section defines global identifiers and their values that are associated with interfaces contained in libncurses. These definitions are organized into groups that correspond to system headers. This convention is used as a convenience for the reader, and does not imply the existence of these headers, or their content.

These definitions are intended to supplement those provided in the referenced underlying specifications.

This specification uses ISO/IEC 9899 C Language as the reference programming language, and data definitions are specified in ISO C format. The C language is used here as a convenient notation. Using a C language description of these data objects does not preclude their use by other programming languages.


curses.h


#define ERR	(-1)
#define OK	(0)
#define ACS_RARROW	(acs_map['+'])
#define ACS_LARROW	(acs_map[','])
#define ACS_UARROW	(acs_map['-'])
#define ACS_DARROW	(acs_map['.'])
#define ACS_BLOCK	(acs_map['0'])
#define ACS_CKBOARD	(acs_map['a'])
#define ACS_DEGREE	(acs_map['f'])
#define ACS_PLMINUS	(acs_map['g'])
#define ACS_BOARD	(acs_map['h'])
#define ACS_LANTERN	(acs_map['i'])
#define ACS_LRCORNER	(acs_map['j'])
#define ACS_URCORNER	(acs_map['k'])
#define ACS_ULCORNER	(acs_map['l'])
#define ACS_LLCORNER	(acs_map['m'])
#define ACS_PLUS	(acs_map['n'])
#define ACS_S1	(acs_map['o'])
#define ACS_HLINE	(acs_map['q'])
#define ACS_S9	(acs_map['s'])
#define ACS_LTEE	(acs_map['t'])
#define ACS_RTEE	(acs_map['u'])
#define ACS_BTEE	(acs_map['v'])
#define ACS_TTEE	(acs_map['w'])
#define ACS_VLINE	(acs_map['x'])
#define ACS_DIAMOND	(acs_map['`'])
#define ACS_BULLET	(acs_map['~'])
#define getmaxyx(win,y,x)	(y=(win)?((win)->_maxy+1):ERR,x=(win)?((win)->_maxx+1):ERR)
#define getbegyx(win,y,x)	(y=(win)?(win)->_begy:ERR,x=(win)?(win)->_begx:ERR)
#define getyx(win,y,x)	(y=(win)?(win)->_cury:ERR,x=(win)?(win)->_curx:ERR)
#define getparyx(win,y,x)	(y=(win)?(win)->_pary:ERR,x=(win)?(win)->_parx:ERR)

#define WA_ALTCHARSET	A_ALTCHARSET
#define WA_ATTRIBUTES	A_ATTRIBUTES
#define WA_BLINK	A_BLINK
#define WA_BOLD	A_BOLD
#define WA_DIM	A_DIM
#define WA_HORIZONTAL	A_HORIZONTAL
#define WA_INVIS	A_INVIS
#define WA_LEFT	A_LEFT
#define WA_LOW	A_LOW
#define WA_NORMAL	A_NORMAL
#define WA_PROTECT	A_PROTECT
#define WA_REVERSE	A_REVERSE
#define WA_RIGHT	A_RIGHT
#define WA_STANDOUT	A_STANDOUT
#define WA_TOP	A_TOP
#define WA_UNDERLINE	A_UNDERLINE
#define WA_VERTICAL	A_VERTICAL
#define A_REVERSE	NCURSES_BITS(1UL,10)

#define COLOR_BLACK	0
#define COLOR_RED	1
#define COLOR_GREEN	2
#define COLOR_YELLOW	3
#define COLOR_BLUE	4
#define COLOR_MAGENTA	5
#define COLOR_CYAN	6
#define COLOR_WHITE	7

#define _SUBWIN	0x01
#define _ENDLINE	0x02
#define _FULLWIN	0x04
#define _ISPAD	0x10
#define _HASMOVED	0x20

typedef unsigned char bool;

typedef unsigned long chtype;
typedef struct screen SCREEN;
typedef struct _win_st WINDOW;
typedef chtype attr_t;
typedef struct
{
  attr_t attr;
  wchar_t chars[5];
}
cchar_t;
struct pdat
{
  short _pad_y;
  short _pad_x;
  short _pad_top;
  short _pad_left;
  short _pad_bottom;
  short _pad_right;
}
 ;

struct _win_st
{
  short _cury;
  short _curx;
  short _maxy;
  short _maxx;
  short _begy;
  short _begx;
  short _flags;
  attr_t _attrs;
  chtype _bkgd;
  bool _notimeout;
  bool _clear;
  bool _leaveok;
  bool _scroll;
  bool _idlok;
  bool _idcok;
  bool _immed;
  bool _sync;
  bool _use_keypad;
  int _delay;
  struct ldat *_line;
  short _regtop;
  short _regbottom;
  int _parx;
  int _pary;
  WINDOW *_parent;
  struct pdat _pad;
  short _yoffset;
  cchar_t _bkgrnd;
}
 ;
#define KEY_CODE_YES	0400
#define KEY_BREAK	0401
#define KEY_MIN	0401
#define KEY_DOWN	0402
#define KEY_UP	0403
#define KEY_LEFT	0404
#define KEY_RIGHT	0405
#define KEY_HOME	0406
#define KEY_BACKSPACE	0407
#define KEY_F0	0410
#define KEY_DL	0510
#define KEY_IL	0511
#define KEY_DC	0512
#define KEY_IC	0513
#define KEY_EIC	0514
#define KEY_CLEAR	0515
#define KEY_EOS	0516
#define KEY_EOL	0517
#define KEY_SF	0520
#define KEY_SR	0521
#define KEY_NPAGE	0522
#define KEY_PPAGE	0523
#define KEY_STAB	0524
#define KEY_CTAB	0525
#define KEY_CATAB	0526
#define KEY_ENTER	0527
#define KEY_SRESET	0530
#define KEY_RESET	0531
#define KEY_PRINT	0532
#define KEY_LL	0533
#define KEY_A1	0534
#define KEY_A3	0535
#define KEY_B2	0536
#define KEY_C1	0537
#define KEY_C3	0540
#define KEY_BTAB	0541
#define KEY_BEG	0542
#define KEY_CANCEL	0543
#define KEY_CLOSE	0544
#define KEY_COMMAND	0545
#define KEY_COPY	0546
#define KEY_CREATE	0547
#define KEY_END	0550
#define KEY_EXIT	0551
#define KEY_FIND	0552
#define KEY_HELP	0553
#define KEY_MARK	0554
#define KEY_MESSAGE	0555
#define KEY_MOVE	0556
#define KEY_NEXT	0557
#define KEY_OPEN	0560
#define KEY_OPTIONS	0561
#define KEY_PREVIOUS	0562
#define KEY_REDO	0563
#define KEY_REFERENCE	0564
#define KEY_REFRESH	0565
#define KEY_REPLACE	0566
#define KEY_RESTART	0567
#define KEY_RESUME	0570
#define KEY_SAVE	0571
#define KEY_SBEG	0572
#define KEY_SCANCEL	0573
#define KEY_SCOMMAND	0574
#define KEY_SCOPY	0575
#define KEY_SCREATE	0576
#define KEY_SDC	0577
#define KEY_SDL	0600
#define KEY_SELECT	0601
#define KEY_SEND	0602
#define KEY_SEOL	0603
#define KEY_SEXIT	0604
#define KEY_SFIND	0605
#define KEY_SHELP	0606
#define KEY_SHOME	0607
#define KEY_SIC	0610
#define KEY_SLEFT	0611
#define KEY_SMESSAGE	0612
#define KEY_SMOVE	0613
#define KEY_SNEXT	0614
#define KEY_SOPTIONS	0615
#define KEY_SPREVIOUS	0616
#define KEY_SPRINT	0617
#define KEY_SREDO	0620
#define KEY_SREPLACE	0621
#define KEY_SRIGHT	0622
#define KEY_SRSUME	0623
#define KEY_SSAVE	0624
#define KEY_SSUSPEND	0625
#define KEY_SUNDO	0626
#define KEY_SUSPEND	0627
#define KEY_UNDO	0630
#define KEY_MOUSE	0631
#define KEY_RESIZE	0632
#define KEY_MAX	0777

#define PAIR_NUMBER(a)	(((a)& A_COLOR)>>8)
#define NCURSES_BITS(mask,shift)	((mask)<<((shift)+8))
#define A_CHARTEXT	(NCURSES_BITS(1UL,0)-1UL)
#define A_NORMAL	0L
#define NCURSES_ATTR_SHIFT	8
#define A_COLOR	NCURSES_BITS(((1UL)<<8)-1UL,0)
#define A_BLINK	NCURSES_BITS(1UL,11)
#define A_DIM	NCURSES_BITS(1UL,12)
#define A_BOLD	NCURSES_BITS(1UL,13)
#define A_ALTCHARSET	NCURSES_BITS(1UL,14)
#define A_INVIS	NCURSES_BITS(1UL,15)
#define A_PROTECT	NCURSES_BITS(1UL,16)
#define A_HORIZONTAL	NCURSES_BITS(1UL,17)
#define A_LEFT	NCURSES_BITS(1UL,18)
#define A_LOW	NCURSES_BITS(1UL,19)
#define A_RIGHT	NCURSES_BITS(1UL,20)
#define A_TOP	NCURSES_BITS(1UL,21)
#define A_VERTICAL	NCURSES_BITS(1UL,22)
#define A_STANDOUT	NCURSES_BITS(1UL,8)
#define A_UNDERLINE	NCURSES_BITS(1UL,9)
#define COLOR_PAIR(n)	NCURSES_BITS(n,0)
#define A_ATTRIBUTES	NCURSES_BITS(~(1UL-1UL),0)

Interfaces for libutil

Table 7-6 defines the library name and shared object name for the libutil library

Table 7-6. libutil Definition

Library:libutil
SONAME:libutil.so.1

The behavior of the interfaces in this library is specified by the following specifications:

Linux Standard Base


Utility Functions


Interfaces for Utility Functions

An LSB conforming implementation shall provide the generic functions for Utility Functions specified in Table 7-7, with the full functionality as described in the referenced underlying specification.

Table 7-7. libutil - Utility Functions Function Interfaces

forkpty [1]login_tty [1]logwtmp [1]  
login [1]logout [1]openpty [1]  

Referenced Specification(s)


Interface Definitions for libutil

Table of Contents
forkpty -- find and open an available pseudo-tty
login -- login utility function
login_tty -- find and open an available pseudo-tty
logout -- logout utility function
logwtmp -- append an entry to the wtmp file
openpty -- find and open an available pseudo-tty

The following interfaces are included in libutil and are defined by this specification. Unless otherwise noted, these interfaces shall be included in the source standard.

Other interfaces listed above for libutil shall behave as described in the referenced base document.

forkpty

Name

forkpty -- find and open an available pseudo-tty

Synopsis

int forkpty(int *amaster, 
	char *name,
	struct termios *termp,
	struct winsize *winp);

Description

The forkpty() function joins openpty(), fork(), and login_tty() to create a new process operating on a pseudo-tty. The file descriptor of the master side of the pseudo-tty is returned in amaster, and null or the filename of the slave in name. If non-null, the termp and winp parameters will determine the terminal attributes and window size of the slave side of the pseudo-tty.

Return Value

On success of the child process, zero is returned. When the parent process receives the PID of its child process, pid is returned. On error, -1 is returned, and errno is set appropriately.

login

Name

login -- login utility function

Synopsis

void login(struct utmp *ut);

Description

The login() function updates the /var/run/utmp and /var/log/wtmp files with user information contained in ut.

login_tty

Name

login_tty -- find and open an available pseudo-tty

Synopsis

int login_tty(int fdr);

Description

login_tty() sets up for a login on the tty referenced by the file descriptor fdr. This function creates a new session, makes the tty for the current process the controlling terminal, sets the standard input, output, and error streams of the current process, and closes fdr.

Return Value

On success, zero is returned. On error, -1 is returned, and errno is set appropriately.

logout

Name

logout -- logout utility function

Synopsis

int logout(const char *line);

Description

Given the device line, the logout() function removes the entry from the corresponding /var/run/utmp system file.

Return Value

Zero is returned if there was no entry to remove. A non-zero return value indicates success.

logwtmp

Name

logwtmp -- append an entry to the wtmp file

Synopsis

#include <utmp.h>

void logwtmp(const char *line, const char *name, const char *host);

Description

logwtmp() constructs an utmp structure using line, name, host, current time and current process id. Then it calls updwtmp() to append the structure to the utmp file.

Availability

Both functions are available under glibc2, but not under libc5. However, logwtmp occurs in the old libbsd.

Files

/var/log/wtmp database of past user logins

openpty

Name

openpty -- find and open an available pseudo-tty

Synopsis

int openpty(int *amaster, 
	int *aslave, 
	char *name,
	struct termios *termp,
	struct winsize *winp);

Description

The openpty() function finds an available pseudo-tty and returns file descriptors for the amaster and aslave. The filename of the slave is returned in name, otherwise a null. The terminal parameters of the slave will be set to the values in termp, otherwise a null. The window size of the slave will be set to the values in winp, otherwise a null.

Return Value

On success, zero is returned. On error, -1 is returned, and errno is set appropriately.

Errors

ENOENT

There are no available ttys.

IV. Commands and Utilities

Table of Contents
8. Commands and Utilities

Chapter 8. Commands and Utilities

Commands and Utilities

If any operand (except one which follows --) starts with a hyphen the behavior is unspecified. [16]

The following table lists the Commands and Utilities. Unless otherwise specified the command or utility is described in the Single UNIX Specification (SUS). When an interface is not defined in the Single UNIX Specification, then the next prevailing standard is referenced (ie., POSIX, SVID).

The behavior of the interfaces described in this section are specified by the following standards.

Linux Standard Base [17]
ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3 [18]

Table 8-1. Commands and Utilities

[ [18]ar [17]at [17]awk [17]basename [18]
batch [17]bc [17]cat [18]chfn [17]chgrp [17]
chmod [18]chown [17]chsh [17]cksum [18]cmp [18]
col [17]comm [18]cp [18]cpio [17]crontab [17]
csplit [18]cut [17]date [18]dd [18]df [17]
diff [18]dirname [18]dmesg [17]du [17]echo [17]
egrep [17]env [18]expand [18]expr [18]false [18]
fgrep [17]file [17]find [17]fold [18]fuser [17]
gencat [18]getconf [18]gettext [17]grep [17]groupadd [17]
groupdel [17]groupmod [17]groups [17]gunzip [17]gzip [17]
head [18]hostname [17]iconv [18]id [18]install [17]
install_initd [17]ipcrm [17]ipcs [17]join [18]kill [18]
killall [17]ln [18]locale [18]localedef [18]logname [18]
lpr [17]ls [17]lsb_release [17]m4 [17]make [18]
man [18]md5sum [17]mkdir [18]mkfifo [18]mknod [17]
mktemp [17]more [17]mount [17]msgfmt [17]mv [18]
newgrp [17]nice [18]nl [18]nohup [18]od [17]
passwd [17]paste [18]patch [17]pathchk [18]pidof [17]
pr [18]printf [18]ps [18]pwd [18]remove_initd [17]
renice [17]rm [18]rmdir [18]sed [17]sendmail [17]
sh [18]shutdown [17]sleep [18]sort [18]split [18]
strip [18]stty [18]su [17]sync [17]tail [18]
tar [17]tee [18]test [18]time [18]touch [18]
tr [18]true [18]tsort [18]tty [18]umount [17]
uname [18]unexpand [18]uniq [18]useradd [17]userdel [17]
usermod [17]wc [18]xargs [17]  

Command Behavior

Table of Contents
ar -- create and maintain library archives (LSB DEPRECATED)
at -- examine or delete jobs for later execution
awk -- pattern scanning and processing language
batch -- execute commands when the system load permits
bc -- An arbitrary precision calculator language
chfn -- change user name and information
chgrp -- change file group
chown -- change file owner and group
chsh -- change login shell
col -- filter reverse line feeds from input
cpio -- copy file archives in and out
crontab -- maintain crontab files for individual users
cut -- split a file into sections determined by context lines
df -- report filesystem disk space usage
dmesg -- print or control the kernel ring buffer
du -- estimate file space usage
echo -- display a line of text
egrep -- search a file with an ERE pattern
fgrep -- search a file with a fixed pattern
file -- determine file type
find -- search for files in a directory hierarchy
fuser -- identify processes using files or sockets
gettext -- retrieve text string from message database
grep -- print lines matching a pattern
groupadd -- create a new group
groupdel -- delete a group
groupmod -- modify a group
groups -- display a group
gunzip -- uncompress files
gzip -- compress or expand files
hostname -- show the system's host name
install -- copy files and set attributes
install_initd -- install an init.d file
ipcrm -- provide information on ipc facilities
ipcs -- provide information on ipc facilities
killall -- kill processes by name
lpr -- off line print
ls -- list directory contents
lsb_release -- print distribution specific information
m4 -- macro processor
md5sum -- generates or checks MD5 message digests
mknod -- make block or character special files
mktemp -- make temporary file name (unique)
more -- file perusal filter for crt viewing
mount -- mount a file system
msgfmt -- create a message object from a message file
newgrp -- change group ID
od -- dump files in octal and other formats
passwd -- change user password
patch -- apply a diff file to an original
pidof -- find the process ID of a running program
remove_initd -- clean up boot script system modifications introduced by install_initd
renice -- alter priority of running processes
sed -- stream editor
sendmail -- an electronic mail transport agent
shutdown -- bring the system down
su -- change user ID or become super-user
sync -- flush filesystem buffers
tar -- file archiver
umount -- unmount file systems
useradd -- create a new user or update default new user information
userdel -- delete a user account and related files
usermod -- modify a user account
xargs -- build and execute command lines from standard input

This section contains descriptions for commands and utilities whose specified behavior in the LSB contradicts or extends the standards referenced. It also contains commands and utilities only required by the LSB and not specified by other standards.

ar

Name

ar -- create and maintain library archives (LSB DEPRECATED)

Description

ar is deprecated from the LSB and is expected to disappear from a future version of the LSB. [19]

ar is as specified in the Single UNIX Specification but with differences as listed below.

Differences

-T, -C

need not be accepted.

-l

has unspecified behavior.

-q

has unspecified behavior; using -r is suggested.

at

Name

at -- examine or delete jobs for later execution

Description

at is as specified in the Single UNIX Specification but with differences as listed below.

Differences

-d

is functionally equivalent to the -r option specified in the Single UNIX Specification.

-r

need not be supported, but the '-d' option is equivalent.

-t time

need not be supported.

Files

The files at.allow and at.deny reside in /etc rather than /usr/lib/cron.

awk

Name

awk -- pattern scanning and processing language

Description

awk is as specified in the Single UNIX Specification but with differences as listed below.

Differences

Certain aspects of internationalized regular expressions are optional; see Internationalization and Regular Expressions>.

batch

Name

batch -- execute commands when the system load permits

Description

The specification for batch is as specified in the Single UNIX Specification but with the following differences as listed below.

Files

The files at.allow and at.deny reside in /etc rather than /usr/lib/cron.

bc

Name

bc -- An arbitrary precision calculator language

Description

bc is as specified in the Single UNIX Specification but with differences as listed below.

Differences

-s, --standard

processes exactly the POSIX bc language.

-w, --warn

gives warnings for extensions to POSIX bc.

chfn

Name

chfn -- change user name and information

Synopsis

chfn [-f full_name] [-h home-phone] [user]

Description

chfn changes user fullname and other information for a user's account. This information is typically printed by finger and similar programs. A normal user may only change the fields for their own account, the super user may change the fields for any account.

The only restrictions placed on the contents of the fields is that no control characters may be present, nor any of comma, colon, or equal sign.

If none of the options are selected, chfn operates in an interactive fashion. The prompts and expected input in interactive mode are unspecified and should not be relied upon.

As it is possible for the system to be configured to restrict which fields a non-privileged user is permitted to change, applications should be written to gracefully handle these situations.

Standard Options

-f full_name

sets the user's full name.

-h home-phone

sets the user's home phone number.

[20]

chgrp

Name

chgrp -- change file group

Description

chgrp is as specified in the Single UNIX Specification but with differences as listed below.

Differences

The -L, -H, and -P options need not be supported.

chown

Name

chown -- change file owner and group

Description

chown is as specified in the Single UNIX Specification but with differences as listed below.

Differences

The -L, -H, and -P options need not be supported.

chsh

Name

chsh -- change login shell

Synopsis

chsh [-s login_shell] [user]

Description

chsh changes the user login shell. This determines the name of the user's initial login command. A normal user may only change the login shell for their own account, the super user may change the login shell for any account.

The only restrictions placed on the login shell is that the command name shall be listed in /etc/shells, unless the invoker is the super-user, and then any value may be added. Accounts which are restricted (in an implementation-defined manner) may not change their login shell.

If the -s option is not selected, chsh operates in an interactive mode. The prompts and expected input in this mode are implementation-defined.

Standard Options

-s login_shell

sets the login shell.

col

Name

col -- filter reverse line feeds from input

Description

col is as specified in the The Single UNIX® Specification(SUS) Version 2, Commands and Utilities (XCU), Issue 5 (ISBN: 1-85912-191-8, C604) with the difference that the -p option has unspecified behavior.

Although col is shown as legacy in the Single UNIX Specification, Version 2, it is not (yet) deprecated in the LSB.

cpio

Name

cpio -- copy file archives in and out

Description

cpio is as specified in the Single UNIX Specification but with differences as listed below.

Differences

Certain aspects of internationalized filename globbing are optional; see Internationalization and Filename Globbing>.

crontab

Name

crontab -- maintain crontab files for individual users

Synopsis

crontab [ -u user ] file
crontab [ -u user ] { -l | -r | -e }

Description

crontab is as specified in the Single UNIX Specification but with differences as listed below.

Files

The files cron.allow and cron.deny reside in /etc rather than /usr/lib/cron.

cut

Name

cut -- split a file into sections determined by context lines

Description

cut is as specified in the Single UNIX Specification but with differences as listed below.

Differences

-n

has unspecified behavior.

df

Name

df -- report filesystem disk space usage

Description

df is as specified in the Single UNIX Specification but with the following differences.

If the -k option is not specified, disk space is shown in unspecified units. Applications should specify -k.

If an argument is the absolute file name of a disk device node containing a mounted filesystem, df shows the space available on that filesystem rather than on the filesystem containing the device node (which is always the root filesystem).

dmesg

Name

dmesg -- print or control the kernel ring buffer

Synopsis

dmesg [ -c ] [ -n level ] [ -s bufsize ]

Description

dmesg examines or controls the kernel ring buffer.

Standard Options

-c

clears the ring buffer contents after printing.

-n level

sets the level at which logging of messages is done to the console.

-s bufsize

uses a buffer of bufsize to query the kernel ring buffer. This is 8196 by default (this matches the default kernel syslog buffer size in 2.0.33 and 2.1.103). If you have set the kernel buffer to larger than the default then this option can be used to view the entire buffer.

du

Name

du -- estimate file space usage

Description

du is as specified in the Single UNIX Specification but with differences as listed below.

Differences

If the -k option is not specified, disk space is shown in unspecified units. Applications should specify -k.

echo

Name

echo -- display a line of text

Synopsis

echo [STRING]... 

Description

The echo command is as specified in the Single UNIX Specification but with the following differences.

Unlike the behavior specified in the Single UNIX Specification, whether echo supports options is implementation defined. The behavior of echo if any arguments contain backslashes is also implementation defined. Applications shall not run echo with a first argument starting with a hyphen, or with any arguments containing backslashes; they shall use printf in those cases. [21]

egrep

Name

egrep -- search a file with an ERE pattern

Description

egrep is equivalent to grep -E. For further details, see the specification for grep.

fgrep

Name

fgrep -- search a file with a fixed pattern

Description

fgrep is equivalent to grep -F. For further details, see the specification for grep.

file

Name

file -- determine file type

Description

file is as specified in the Single UNIX Specification but with differences as listed below.

Differences

The -M, -h, -d, and -i options need not be supported.

find

Name

find -- search for files in a directory hierarchy

Description

find is as specified in the Single UNIX Specification but with additional options as specified below.

Differences

Certain aspects of internationalized filename globbing are optional; see Internationalization and Filename Globbing>.

fuser

Name

fuser -- identify processes using files or sockets

Description

fuser is as specified in the Single UNIX Specification but with differences as listed below.

Differences

-c

has unspecified behavior.

-f

has unspecified behavior.

gettext

Name

gettext -- retrieve text string from message database

Synopsis

gettext [ options ] [ textdomain ] msgid

gettext -s [ options ] msgid ...

Description

The gettext utility retrieves a translated text string corresponding to string msgid from a message object generated with msgfmt utility.

The message object name is derived from the optional argument textdomain if present, otherwise from the TEXTDOMAIN environment. If no domain is specified, or if a corresponding string cannot be found, gettext prints msgid.

Ordinarily gettext looks for its message object in dirname/lang/LC_MESSAGES where dirname is the implementation-defined default directory and lang is the locale name. If present, the TEXTDOMAINDIR environment variable replaces the dirname.

This utility interprets C escape sequences such as \t for tab. Use \\ to print a backslash. To produce a message on a line of its own, either put a \n at the end of msgid, or use this command in conjunction with printf utility.

When used with the -s option the utility behaves like the echo utility. But it does not simply copy its arguments to standard output. Instead those messages found in the selected catalog are translated.

Options

-d domainname, --domain=domainname

Retrieve translated messages from domainname.

-e

Enable expansion of some escape sequences.

-n

Suppress trailing newline.

Operands

The following operands are supported:

textdomain

A domain name used to retrieve the messages.

msgid

A key to retrieve the localized message.

Environment Variables

LANGUAGE

Specifies one or more locale names. See gettext message handling functions for more information.

LANG

Specifies locale name.

LC_MESSAGES

Specifies messaging locale, and if present overrides LANG for messages.

TEXTDOMAIN

Specifies the text domain name, which is identical to the message object filename without .mo suffix.

TEXTDOMAINDIR

Specifies the pathname to the message database, and if present replaces the implementation-defined default directory.

Exit Status

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

grep

Name

grep -- print lines matching a pattern

Description

grep is as specified in the Single UNIX Specification but with differences as listed below.

LSB Differences

Certain aspects of internationalized regular expressions are optional; see Internationalization and Regular Expressions>.

groupadd

Name

groupadd -- create a new group

Synopsis

groupadd [-g gid [-o]] group

Options

-g gid [-o]

specifies the numerical value of the group's ID. This value shall be unique, unless the -o option is used. The value shall be non-negative.

groupdel

Name

groupdel -- delete a group

Synopsis

groupdel group

Description

groupdel modifies the system account files, deleting all entries that refer to group. The named group shall exist.

groupmod

Name

groupmod -- modify a group

Synopsis

groupmod [-g gid [-o]] [-n group_name ] group

Options

-g gid [-o]

specifies the numerical value of the group's ID. This value shall be unique, unless the -o option is used. The value shall be non-negative. Any files which the old group ID is the file group ID shall have the file group ID changed manually.

-n groupname

changes the name of the group from group to group_name.

groups

Name

groups -- display a group

Synopsis

groups [user]

Description

groups displays the current group ID names or values. If the value does not have a corresponding entry in the group database, the value will be displayed as the numerical group value. The optional user parameter will display the groups for the named user.

gunzip

Name

gunzip -- uncompress files

Description

gunzip is equivalent to gzip -d. See the specification for gzip for further details.

gzip

Name

gzip -- compress or expand files

Synopsis

gzip [ -acdfhlLnNrtvV19 ] [-S suffix] [ name ...  ]

Description

gzip tries to reduce the size of the named files. Whenever possible, each file is replaced by one with the extension .gz, while keeping the same ownership modes, access and modification times. If no files are specified, or if a file name is "-", the standard input is compressed to the standard output. gzip will only attempt to compress regular files. In particular, it will ignore symbolic links.

When compressing, gzip uses the deflate algorithm specified in RFC1951 and stores the result in a file using the gzip file format specified in RFC1952.

Options

-a, --ascii

does nothing on Linux systems.

-c, --stdout, --to-stdout

writes output on standard output; keeps original files unchanged. If there are several input files, the output consists of a sequence of independently compressed members. To obtain better compression, concatenate all input files before compressing them.

-d, --decompress, --uncompress

decompresses.

-f, --force

forces compression or decompression even if the file has multiple links or the corresponding file already exists, or if the compressed data is read from or written to a terminal. If the input data is not in a format recognized by gzip, and if the option --stdout is also given, copy the input data without change to the standard ouput: let gzip behave as cat. If -f is not given, and when not running in the background, gzip prompts to verify whether an existing file should be overwritten.

-l, --list

lists the compressed size, uncompressed size, ration and uncompressed name for each compressed file. Gives the uncompressed size as -1 for files not in gzip format. Additionally displays method, crc and timestamp for the uncompress file when used in combination with --verbose.

The compression methods currently supported are deflate, compress, lzh (SCO compress -H) and pack. The crc is given as ffffffff for a file not in gzip format.

With --name, the uncompressed name, date and time are those stored within the compress file, if present.

With --verbose, the size totals and compression ratio for all files is also displayed, unless some sizes are unknown. With --quiet, the title and totals lines are not displayed.

-L, --license

displays the gzip license and quit.

-n, --no-name

does not save the original file name and time stamp by default when compressing. (The original name is always saved if the name had to be truncated.) When decompressing, do not restore the original file name if present (remove only the gzip suffix from the compressed file name) and do not restore the original time stamp if present (copy it from the compressed file). This option is the default when decompressing.

-N, --name

always saves the original file name and time stamp when compressing; this is the default. When decompressing, restore the original file name and time stamp if present. This option is useful on systems which have a limit on file name length or when the time stamp has been lost after a file transfer.

-q, --quiet

suppresses all warnings.

-r, --recursive

travels the directory structure recursively. If any of the file names specified on the command line are directories, gzip will descend into the directory and compress all the files it finds there (or decompress them in the case of gunzip).

-S .suf, --sufix .suf

uses suffix .suf instead of .gz.

-t, --test

checks the compressed file integrity.

-v, --verbose

displays the name and percentage reduction for each file compressed or decompressed.

-#, --fast, --best

regulates the speed of compression using the specified digit #, where -1 or --fast indicates the fastest compression method (less compression) and -9 or --best indicates the slowest compression method (best compression). The default compression level is -6 (that is, biased towards high compression at expense of speed).

LSB Deprecated Options

The behaviors specified in this section are expected to disappear from a future version of the LSB; applications should only use the non-LSB-deprecated behaviors.

-V, --version

displays the version number and compilation options, then quits.

hostname

Name

hostname -- show the system's host name

Synopsis

hostname [-v] [-a] [--alias] [-d] [--domain] [-f] [--fqdn]
[-i] [--ip-address] [--long] [-s]  [--short]  [-y]  [--yp]
[--nis]

hostname [-v] [-F filename] [--file filename] [hostname]

hostname [-v] [-h] [--help] [-V] [--version]

Description

hostname is used to either set or display the current host or domain name of the system. This name is used by many of the networking programs to identify the machine. The domain name is also used by NIS/YP.

When called without any arguments, the program displays the name of the system as returned by the gethostname(2) function.

When called with one argument or with the --file option, the commands set the host name or the NIS/YP domain name. Note, that only the super-user can change the names.

Options

-a, --alias

displays the alias name of the host (if used).

-d, --domain

displays the name of the DNS domain.

-F, --file filename

reads the host name from the specified file. Comments (lines starting with a #) are ignored.

-f, --fqdn, --long

displays the FQDN (Fully Qualified Domain Name).

-i, --ip-address

displays the IP address(es) of the host.

-s, --short

displays the short host name. This is the host name cut at the first dot.

-v, --verbose

tells what's going on.

-y, --yp, --nis

displays the NIS domain name. If a parameter is given (or --file name) then root can also set a new NIS domain.

LSB Deprecated Options

The behaviors specified in this section are expected to disappear from a future version of the LSB; applications should only use the non-LSB-deprecated behaviors.

-V, --version

prints version information on standard output and exits successfully.

install

Name

install -- copy files and set attributes

Synopsis

install [OPTION]... SOURCE DEST           (1st format)
install [OPTION]... SOURCE... DIRECTORY   (2nd format)
install -d [OPTION]... DIRECTORY...       (3rd format)

Description

In the first two formats, copy SOURCE to DEST or multiple SOURCE(s) to the existing DIRECTORY, while setting permission modes and owner/group. In the third format, create all components of the given DIRECTORY(ies).

Standard Options

--backup[=CONTROL]

makes a backup of each existing destination file.

-b

is like --backup, but does not accept an argument.

-d, --directory

treats all arguments as directory names; creates all components of the specified directories.

-D

creates all leading components of DEST except the last, then copies SOURCE to DEST; useful in the 1st format.

-g, --group=GROUP

sets group ownership, instead of process' current group.

-m, --mode=MODE

sets permission mode (as in chmod), instead of rwxr-xr-x.

-o, --owner=OWNER

sets ownership (super-user only).

-p, --preserve-timestamps

applies access/modification times of SOURCE files to corresponding destination files.

-s, --strip

strips symbol tables, only for 1st and 2nd formats.

-S, --suffix=SUFFIX

overrides the usual backup suffix.

--verbose

prints the name of each directory as it is created.

install_initd

Name

install_initd -- install an init.d file

Synopsis

/usr/lib/lsb/install_initd initd_file

Description

install_initd installs an init.d file that has been copied to the /etc/init.d location or symlink. In the postinstall script of a package, the program /usr/lib/lsb/install_initd configures a distribution's boot script system to call the init.d file of the package at an appropriate time. See also the Section called Installation and Removal of init.d Files in Chapter 13.

ipcrm

Name

ipcrm -- provide information on ipc facilities

Synopsis

ipcrm [ shm | msg | sem ] id...

Description

ipcrm removes the resource(s) specified by id.

ipcs

Name

ipcs -- provide information on ipc facilities

Synopsis

ipcs [ -smq ] [ -tcp ]

Description

ipcs provides information on the ipc facilities for which the calling process has read access.

Resource display options

-m

shared memory segments.

-q

message queues.

-s

semaphore arrays.

Output format options

-t

time.

-p

pid.

-c

creator.

Application Usage

In some implementations of ipcs the -a option will print all information available. In other implementations the -a option will print all resource types. Therefore, applications shall not use the -a option.

Some implements of ipcs implement more output formats than are specified here. These options are not consistent between differing implementations of ipcs. Therefore, only the -t -c and -p option flags may be used. At least one of the -t -c and -p options shall be specified.

killall

Name

killall -- kill processes by name

Synopsis

killall [-egiqvw] [-signal] name ...
killall -l
killall -V

Description

killall sends a signal to all processes running any of the specified commands. If no signal name is specified, SIGTERM is sent.

Signals can be specified either by name (e.g. -HUP) or by number (e.g. -1). Signal 0 (check if a process exists) can only be specified by number.

If the command name contains a slash (/), processes executing that particular file will be selected for killing, independent of their name.

killall returns a non-zero return code if no process has been killed for any of the listed commands. If at least one process has been killed for each command, killall returns zero.

A killall process never kills itself (but may kill other killall processes).

Standard Options

-e

requires an exact match for very long names. If a command name is longer than 15 characters, the full name may be unavailable (i.e. it is swapped out). In this case, killall will kill everything that matches within the first 15 characters. With -e, such entries are skipped. killall prints a message for each skipped entry if -v is specified in addition to -e.

-g

kills the process group to which the process belongs. The kill signal is only sent once per group, even if multiple processes belonging to the same process group were found.

-i

asks interactively for confirmation before killing.

-l

lists all known signal names.

-q

does not complain if no processes were killed.

-v

reports if the signal was successfully sent.

LSB Deprecated Options

The behaviors specified in this section are expected to disappear from a future version of the LSB; applications should only use the non-LSB-deprecated behaviors.

-V

displays version information.

lpr

Name

lpr -- off line print

Synopsis

lpr [-l] [-p] [-Pprinter] [-h] [-s] [-#copies] [-J name]
    [-T title] [name ...]

Description

lpr uses a spooling daemon to print the named files when facilities become available. If no names appear, the standard input is assumed.

Standard Options

-l

identifies binary data that is not to be filtered but sent as raw input to printer.

-p

formats with "pr" before sending to printer.

-Pprinter

sends output to the printer named printer instead of the default printer.

-h

suppresses header page.

-s

uses symbolic links.

-#copies

specifies copies as the number of copies to print.

-J name

specifies name as the job name for the header page.

-T title

specifies title as the title used for "pr".

ls

Name

ls -- list directory contents

Description

ls is as specified in the Single UNIX Specification, but with differences listed below.

Differences

-p

in addition to the Single UNIX Specification behavior of printing a slash for a directory, ls -p may display other characters for other file types.

Certain aspects of internationalized filename globbing are optional; see Internationalization and Filename Globbing>.

lsb_release

Name

lsb_release -- print distribution specific information

Synopsis

lsb_release [OPTION]...

Description

The lsb_release command prints certain LSB (Linux Standard Base) and Distribution information.

With no option, same as -v.

Options

-v, --version

displays version of LSB against which distribution is compliant. The version is expressed as a colon seperated list of LSB module descriptions. LSB module descriptions are dash seperated tuples containing the module name, version, and architecture name. The output is a single line of text of the following format:

LSB Version:\t<ListAsDescribedAbove>

-i, --id

displays string id of distributor. The output is a single line of text of the following format:

Distributor ID:\t<DistributorID>

-d, --description

displays single line text description of distribution. The output is of the following format:

Description:\t<Description>

-r, --release

displays release number of distribution. The output is a single line of text of the following format:

Release:\t<Release>

-c, --codename

displays codename according to distribution release. The output is a single line of text of the following format.

Codename:\t<Codename>

-a, --all

displays all of the above information.

-s, --short

displays all of the above information in short output format.

-h, --help

displays a human-readable help message.

Examples

The following command will list the LSB Profiles which are currently supported on this platform.

example% lsb_release -v
LSB Version: core-2.0-ia32:graphics-2.0-ia32

m4

Name

m4 -- macro processor

Description

m4 is as specified in the Single UNIX Specification but with extensions as listed below.

Extensions

-P

forces a m4_ prefix to all builtins.

-I directory

Add directory to the end of the search path for includes.

md5sum

Name

md5sum -- generates or checks MD5 message digests

Synopsis

md5sum [-b] [-c [file]] | [file...]

Description

For each file, write to standard output a line containing the MD5 checksum of that file, followed by one or more blank characters, followed by the name of the file. The MD5 checksum shall be calculated according to RFC1321 and output as 32 hexadecimal digits (as RFC1321 does).

If no file names are specified as operands, read from standard input and use "-" as the file name in the output.

Options

-b

uses binary mode.

-c [file]

checks md5sum of all files listed in file against the checksum listed in the same file. The actual format of that file is the same as output of md5sum. That is, each line in the file describes a file.

mknod

Name

mknod -- make block or character special files

Synopsis

mknod [OPTION]... NAME TYPE [MAJOR MINOR]

Description

Create the special file NAME of the given TYPE.

MAJOR MINOR are forbidden for TYPE p, mandatory otherwise. TYPE may be:

b

creates a block (buffered) special file.

c, u

creates a character (unbuffered) special file.

p

creates a FIFO.

Standard Options

-m, --mode=MODE

sets permission mode (as in chmod), not a=rw - umask.

--version

outputs version information and exits.

mktemp

Name

mktemp -- make temporary file name (unique)

Synopsis

mktemp [-q] [-u] template

Description

mktemp takes the given file name template and overwrites a portion of it to create a file name. This file name is unique and suitable for use by the application.

Options

-q

fails silently if an error occurs. This is useful if a script does not want error output to go to standard error.

-u

operates in `unsafe' mode. The temp file will be unlinked before mktemp exits. This is slightly better than mktemp(3) but still introduces a race condition. Use of this option is not encouraged.

more

Name

more -- file perusal filter for crt viewing

Description

more is as specified in the Single UNIX Specification but with differences as listed below.

Differences

The more command need not respect the LINES and COLUMNS environment variables.

The more command need not support the following interactive commands:

g
G
u
control u
control f
newline
j
k
r
R
m
' (return to mark)
/!
?
N
:e
:t
control g
ZZ

-num

specifies an integer which is the screen size (in lines).

-e

has unspecified behavior.

-i

has unspecified behavior.

-n

has unspecified behavior.

-p

Either (1) clear the whole screen and then display the text (instead of the usual scrolling behavior), or (2) provide the behavior specified by the Single UNIX Specification. In the latter case, the syntax is "-p command".

-t

has unspecified behavior.

+num

starts at line number num.

+/string

specifies a string that will be searched for before each file is displayed.

Rationale

The +num and +/string options are deprecated in the Single UNIX Specification, Version 2; however we shall continue to specify them because util-linux-2.11f does not support the replacement (-p command). The +command option as found in the Single UNIX Specification is more general than what we specify, but util-linux-2.11f appears to only support the more specific +num and +/string forms.

mount

Name

mount -- mount a file system

Synopsis

mount [-hV]
mount -a [-fFnrsvw] [-t vfstype]
mount [-fnrsvw] [-o options [,...]] device | dir
mount [-fnrsvw] [-t vfstype] [-o options] device dir

Description

Files are named in a big tree, the file hierarchy, rooted at /. These files can be spread out over several devices. mount serves to attach the file system found on some device to the big file tree. Conversely, umount(8) will detach it again.

Standard Options

-v

invokes verbose mode.

-a

mounts all filesystems (of the given types) mentioned in fstab.

-F

combines with -a. to fork off a new incarnation of mount for each device. This will do the mounts on different devices or different NFS servers in parallel.

-f

causes everything to be done except for the actual system call; if it's not obvious, this `fakes' mounting the file system.

-n

mounts without writing in /etc/mtab. This is necessary for example when /etc is on a read-only file system.

-s

tolerates sloppy mount options rather than failing. This will ignore mount options not supported by a filesystem type. Not all filesystems support this option.

-r

mounts the file system read-only. A synonym is -o ro.

-w

mounts the file system read/write. (default) A synonym is -o rw.

-L label

mounts the partition that has the specified label.

-U uuid

mounts the partition that has the specified uuid. These two options require the file /proc/partitions to exist.

-t vfstype

indicates a file system type of vfstype.

More than one type may be specified in a comma separated list. The list of file system types can be prefixed with no to specify the file system types on which no action should be taken.

-o

options are specified with a -o flag followed by a comma-separated string of options. Some of these options are only useful when they appear in the /etc/fstab file. The following options apply to any file system that is being mounted:

async

does all I/O to the file system asynchronously.

atime

updates inode access time for each access. (default)

auto

is mountable with -a.

defaults

uses default options: rw, suid, dev, exec, auto, nouser, and async.

dev

interprets character or block special devices on the file system.

exec

permits execution of binaries.

noatime

does not update inode access times on this file system.

noauto

is only explicitly mountable.

nodev

does not interpret character or block special devices on the file system.

noexec

does not allow execution of any binaries on the mounted file system.

nosuid

does not allow set-user-identifier or set-group-identifier bits to take effect.

nouser

forbids an ordinary (i.e., non-root) user to mount the file system. (default)

remount

attempts to remount an already-mounted file system. This is commonly used to change the mount flags for a file system, especially to make a read-only file system writable.

ro

mounts the file system read-only.

rw

mounts the file system read-write.

suid

allows set-user-identifier or set-group-identifier bits to take effect.

sync

does all I/O to the file system synchronously.

user

allows an ordinary user to mount the file system. This option implies the options noexec, nosuid, and nodev (unless overridden by subsequent options, as in the option line user,exec,dev,suid).

LSB Deprecated Options

The behaviors specified in this section are expected to disappear from a future version of the LSB; applications should only use the non-LSB-deprecated behaviors.

-V

outputs version.

msgfmt

Name

msgfmt -- create a message object from a message file

Synopsis

msgfmt [ options ] filename.po ...

Description

msgfmt creates message object files from portable object files (filename.po), without changing the portable object files.

The .po file contains messages displayed to users by system utilities or by application programs. .po files can be edited, and the messages in them can be rewritten in any language supported by the system.

If input file is -, standard input is read.

The xgettext utility can be used to create .po files from script or programs.

msgfmt interprets data as characters according to the current setting of the LC_CTYPE locale category.

Options

-D directory, --directory=directory

Add directory to list for input files search.

-f, --use-fuzzy

Use fuzzy entries in output. If this option is not specified, fuzzy entries are not included into the output.

-o output-file, --output-file=output-file

Specify output file name as output-file. If multiple domains or duplicate msgids in the .po file are present, the behavior is unspecified. If output-file is -, output is written to standard output.

--strict

Direct the utility to work strictly following the UniForum/Sun implementation. Currently this only affects the naming of the output file. If this option is not given the name of the output file is the same as the domain name. If the strict UniForum mode is enabled the suffix .mo is added to the file name if it is not already present.

-v, --verbose

Detect and diagnose input file anomalies which might represent translation errors. The msgid and msgstr strings are studied and compared. It is considered abnormal that one string starts or ends with a newline while the other does not.

Also, if the string represents a format string used in a printf-like function both strings should have the same number of % format specifiers, with matching types. If the flag c-format or possible-c-format appears in the special comment #, for this entry a check is performed. For example, the check will diagnose using %.*s against %s, or %d against %s, or %d against %x. It can even handle positional parameters.

Operands

The filename.po operands are treated as portable object files. The format of portable object files is defined in EXTENDED DESCRIPTION.

Standard Input

The standard input is not used unless a filename.po operand is specified as "-".

Environment Variables

LANGUAGE

Specifies one or more locale names. See gettext message handling functions for more information.

LANG

Specifies locale name.

LC_ALL

Specifies locale name for all categories. If defined, overrides LANG, LC_CTYPE and LC_MESSAGES.

LC_CTYPE

Specifies locale name for character handling.

LC_MESSAGES

Specifies messaging locale, and if present overrides LANG for messages.

Standard Output

The standard output is not used unless the option-argument of the -o option is specified as -.

Extended Description

The format of portable object files (.po files) is defined as follows. Each .po file contains one or more lines, with each line containing either a comment or a statement. Comments start the line with a hash mark (#) and end with the newline character. All comments and empty lines are ignored. The format of a statement is:

directive value

Each directive starts at the beginning of the line and is separated from value by white space (such as one or more space or tab characters). value consists of one or more quoted strings separated by white space. If two or more strings are specified as value, they are normalized into single string using the string normalization syntax the same as the ISO C language. Use any of the following types of directives:

domain domainname

msgid message_identifier

msgid_plural untranslated_string_plural

msgstr message_string

msgstr[n] message_string

The behavior of the domain directive is affected by the options used. See OPTIONS for the behavior when the -o option is specified. If the -o option is not specified, the behavior of the domain directive is as follows: (1) All msgids from the beginning of each .po file to the first domain directive are put into a default message object file, messages (or messages.mo if --strict option is specified). (2) When msgfmt encounters a domain domainname directive in the .po file, all following msgids until the next domain directive are put into the message object file domainname (or domainname.mo if --strict option is specified). (3) Duplicate msgids are defined in the scope of each domain. That is, a msgid is considered a duplicate only if the identical msgid exists in the same domain. (4) All duplicate msgids are ignored.

The msgid directive specifies the value of a message identifier associated with the directive that follows it. The msgid_plural directive specifies the plural form message specified to the plural message handling functions ngettext(), dngettext() or dcngettext(). The message_identifier string identifies a target string to be used at retrieval time. Each statement containing a msgid directive shall be followed by a statement containing a msgstr directive or msgstr[n] directives.

The msgstr directive specifies the target string associated with the message_identifier string declared in the immediately preceding msgid directive.

The msgstr[n] (where n = 0, 1, 2, ...) directive specifies the target string to be used with plural form handling functions ngettext(), dngettext() and dcngettext().

Message strings can contain the escape sequences \n for newline, \t for tab, \v for vertical tab, \b for backspace, \r for carriage return, \f for formfeed, \\ for backslash, \" for double quote, \ddd for octal bit pattern, and \xHH for hexadecimal bit pattern.

Comments should be in one of the following formats:

# translator-comments

#. automatic-comments

#: reference...

#, flag

The comments that starts with #. and #: are automatically generated by xgettext utility. The #: comments indicate the location of the msgid string in the source files in filename:line format. The #. comments are generated when -c option of the xgettext utility is specified. These comments are informative only and silently ignored by the msgfmt utility.

The #, comments requires one or more flags separated by comma (,) character. The following flags can be specified:

fuzzy

This flag can be generated by the msgmerge utility or can be inserted by the translator. It shows that the msgstr string might not be a correct translation (anymore). Only the translator can judge if the translation requires further modification, or is acceptable as is. Once satisfied with the translation, the translator then removes this fuzzy flag. The msgmerge programs inserts this when it combined the msgid and msgstr entries after fuzzy search only.

If this flag is specified, the msgfmt utility will not generate the entry for the immediately following msgid in the output message catalog.

c-format, no-c-format

The flags are automatically added by the xgettext utility and they should not be added manually. The c-format flag indicates that the msgid string is used as format string by printf-like functions. In case the c-format flag is given for a string the msgfmt utility does some more tests to check to validity of the translation.

The msgid entry with empty string ("") is called the header entry and treated specially. If the message string for the header entry contains nplurals=value, the value indicates the number of plural forms. For example, if nplurals=4, there are 4 plural forms. If nplurals is defined, there should be plural=expression in the same line, separated by a semicolon (;) character. The expression is a C language expression to determine which version of msgstr[n] to be used based on the value of n, the last argument of ngettext(), dngettext() or dcngettext(). For example:

nplurals=2; plural=n == 1 ? 0 : 1

indicates that there are 2 plural forms in the language; msgstr[0] is used if n == 1, otherwise msgstr[1] is used. Another example:

nplurals=3; plural=n==1 ? 0 : n==2 ? 1 : 2

indicates that there are 3 plural forms in the language; msgstr[0] is used if n == 1, msgstr[1] is used if n == 2, otherwise msgstr[2] is used.

If the header entry contains charset=codeset string, the codeset is used to indicate the codeset to be used to encode the message strings. If the output string's codeset is different from the message string's codeset, codeset conversion from the message strings's codeset to the output string's codeset will be performed upon the call of gettext(), dgettext(), dcgettext(), ngettext(), dngettext(), and dcngettext(). The output string's codeset is determined by the current locale's codeset (the return value of nl_langinfo(CODESET)) by default, and can be changed by the call of bind_textdomain_codeset().

Exit Status

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

Application Usage

Neither msgfmt nor any gettext() routine imposes a limit on the total length of a message. Installing message catalogs under the C locale is pointless, since they are ignored for the sake of efficiency.

Examples

Example 1: Examples of creating message objects from message files.

In this example module1.po and module2.po are portable message objects files.

example% cat module1.po

# default domain "messages"

msgid "msg 1"

msgstr "msg 1 translation"

#

domain "help_domain"

msgid "help 2"

msgstr "help 2 translation"

#

domain "error_domain"

msgid "error 3"

msgstr "error 3 translation"

example% cat module2.po

# default domain "messages"

msgid "mesg 4"

msgstr "mesg 4 translation"

#

domain "error_domain"

msgid "error 5"

msgstr "error 5 translation"

#

domain "window_domain"

msgid "window 6"

msgstr "window 6 translation"

The following command will produce the output files, messages, help_domain, and error_domain.

example% msgfmt module1.po

The following command will produce the output files, messages, help_domain, error_domain, and window_domain.

example% msgfmt module1.po module2.po

The following example will produce the output file hello.mo.

example% msgfmt -o hello.mo module1.po module2.po

newgrp

Name

newgrp -- change group ID

Synopsis

newgrp [-] [group]

Description

newgrp changes the current group ID during a login session. If the optional - flag is given, the user's environment will be reinitialized as though the user had logged in, otherwise the current environment, including current working directory, remains unchanged.

od

Name

od -- dump files in octal and other formats

Description

od is as specified in the Single UNIX Specification but with extensions as listed below.

Extensions

-w, --width[=BYTES]

outputs BYTES bytes per output line.

--traditional

accepts arguments in pre-POSIX form.

Pre-POSIX Specifications

The LSB supports option intermixtures with the following pre-POSIX specifications:

-a

is equivalent to -t a, selects named characters.

-f

is equivalent to -t fF, selects floats.

-h

is equivalent to -t x2, selects hexadecimal shorts.

-i

is equivalent to -t d2, selects decimal shorts.

-l

is equivalent to -t d4, selects decimal longs.

passwd

Name

passwd -- change user password

Synopsis

passwd [-x max] [-n min] [-w warn] [-i inact] name
passwd {-l|-u} name

Description

passwd changes passwords for user and group accounts. A normal user may only change the password for their own account, the super user may change the password for any account. passwd also changes password expiry dates and intervals. Applications may not assume the format of prompts and anticipated input for user interaction, because they are unspecified.

Options

-x max

sets the maximum number of days a password remains valid.

-n min

sets the minimum number of days before a password may be changed.

-w warn

sets the number of days warning the user will receive before their password will expire.

-i inactive

disables an account after the password has been expired for the given number of days.

-l

disables an account by changing the password to a value which matches no possible encrypted value.

-u

re-enables an account by changing the password back to its previous value.

patch

Name

patch -- apply a diff file to an original

Description

patch is as specified in the Single UNIX Specification but with extensions as listed below.

Extensions

--binary

reads and write all files in binary mode, except for standard output and /dev/tty. This option has no effect on POSIX-compliant systems.

-u, --unified

interprets the patch file as a unified context diff.

pidof

Name

pidof -- find the process ID of a running program

Synopsis

pidof [-s] [-x] [-o omitpid..] program [program..]

Description

Return the process ID of a process which is running the program named on the command line.[22]

Options

-s

instructs the program to only return one pid.

-x

causes the program to also return process id's of shells running the named scripts.

-o

omits processes with specified process id.

remove_initd

Name

remove_initd -- clean up boot script system modifications introduced by install_initd

Synopsis

/usr/lib/lsb/remove_initd initd_file

Description

remove_initd processes the removal of the modifications made to a distribution's boot script system by the install_initd program. This cleanup is performed in the preuninstall script of a package; however, the package manager is still responsible for removing the /etc/init.d file. See also the Section called Installation and Removal of init.d Files in Chapter 13.

renice

Name

renice -- alter priority of running processes

Description

renice is as specified in the Single UNIX Specification but with differences as listed below.

Differences

-n increment

has unspecified behavior.

sed

Name

sed -- stream editor

Description

sed is as specified in the Single UNIX Specification but with differences as listed below.

LSB Differences

Certain aspects of internationalized regular expressions are optional; see Internationalization and Regular Expressions>.

sendmail

Name

sendmail -- an electronic mail transport agent

Synopsis

sendmail [flags] [address ...]

Description

To deliver electronic mail (email), applications shall support the interface provided by /usr/sbin/sendmail (described here). This interface shall be the default delivery method for applications.

This program sends an email message to one or more recipients, routing the message as necessary. This program is not intended as a user interface routine.

With no flags, sendmail reads its standard input up to an end-of-file or a line consisting only of a single dot and sends a copy of the message found there to all of the addresses listed. It determines the network(s) to use based on the syntax and contents of the addresses.

It is recommended that applications use as few flags as necessary, none if possible.

Some agents allow aliasing on the local system to be prevented by preceding the address with a backslash.

The format of messages shall be as defined in RFC 2822.

Options

-bm

reads mail from standard input and delivers to the recipient addresses. This is the default mode of operation.

-bp

lists information about messages currently in the input mail queue.

-bs

uses the SMTP protocol as described in RFC 2821; reads SMTP commands on standard input and writes SMTP responses on standard output.

Note that RFC 2821 specifies \r\n (CR-LF) be used at the end of each line, but pipes almost always use \n (LF) instead. To deal with this, agents will accept both \r\n and \n at the end of each line. When accepting \r\n, the \r before the \n is silently discarded.

-F fullname

explicitly sets the full name of the sender for incoming mail unless the message already contains a From: message header.

If the user running sendmail is not sufficiently trusted, then the actual sender may be indicated in the message, depending on the behavior of the agent.

-f name

explicitly sets the envelope sender address for incoming mail. If there is no From: header, the address specified in the From: header will also be set.

If the user running sendmail is not sufficiently trusted, then the actual sender will be indicated in the message.

-i

ignores dots alone on lines by themselves in incoming messages. If -bs is also used, the behavior is unspecified.

-odb

delivers any mail in background, if supported; otherwise ignored.

-odf

delivers any mail in foreground, if supported; otherwise ignored.

-oem or -em

mails errors back to the sender. (default)

-oep or -ep

writes errors to the standard error output.

-oeq or -eq

does not send notification of errors to the sender. This only works for mail delivered locally.

-oi

is equivalent to -i.

-om

indicates that the sender of a message should receive a copy of the message if the sender appears in an alias expansion. Ignored if aliases are not supported.

-t

reads the message to obtain recipients from the To:, Cc:, and Bcc: headers in the message instead of from the command arguments. If a Bcc: header is present, it is removed from the message unless there is no To: or Cc: header, in which case a Bcc: header with no data is created, in accordance with RFC 2822.

If there are any arguments, they specify addresses to which the message is not to be delivered. That is, the argument addresses are removed from the recipients list obtained from the headers. Note: some agents implement this behavior in reverse, adding addresses instead of removing them. Others may disallow addresses in argument list. Therefore, applications should not put addresses in the argument list if -t is used.

This option is sometimes ignored when not in -bm mode (the default).

Exit status

0

successful completion on all addresses. This does not indicate successful delivery.

>0

there was an error.

Notes/Rationale

This page is believed to reflect functionality provided by smail, exim and other implementations, not just the sendmail implementation.

shutdown

Name

shutdown -- bring the system down

Synopsis

/sbin/shutdown [-t sec] [-arkhcfF] time [warning-message]

Description

shutdown brings the system down in a secure way. All logged-in users are notified that the system is going down, and login(1) is blocked. It is possible to shut the system down immediately or after a specified delay. All processes are first notified that the system is going down by the signal SIGTERM. If neither the -h or the -r argument is used, then the default behavior is to take the system to runlevel one where administrative tasks can be run.

Standard Options

-a

uses /etc/shutdown.allow.

-t sec

tells init(8) to wait sec seconds between sending processes the warning and the kill signal, before changing to another runlevel.

-k

doesn't really shutdown; only sends the warning messages to everybody.

-r

reboots after shutdown.

-h

halts after shutdown. Powering off after halting is unspecified.

-f

skips fsck on reboot.

-F

forces fsck on reboot.

-c

cancels an already running shutdown. With this option, it is of course not possible to give the time argument, but you can enter a explanatory message on the command line that will be sent to all users.

time

specifies when to shut down.

The time argument can have different formats. First, it can be an absolute time in the format hh:mm, in which hh is the hour (1 or 2 digits) and mm is the minute of the hour (in two digits). Second, it can be in the format +m, in which m is the number of minutes to wait. The word now is an alias for +0.

If shutdown is called with a delay, it creates the advisory file /etc/nologin which causes programs such as login(1) to not allow new user logins. shutdown only removes this file if it is stopped before it can signal init (i.e. it is cancelled or something goes wrong). Otherwise it is the responsibility of the system shutdown or startup scripts to remove this file so that users can login.

warning-message

specifies message to send all users.

su

Name

su -- change user ID or become super-user

Synopsis

su [OPTS] [-] [username [ARGS]]

Description

su is used to become another user during a login session. Invoked without a username, su defaults to becoming the super user. The optional argument - may be used to provide an environment similar to what the user would expect had the user logged in directly.

The user will be prompted for a password, if appropriate. Invalid passwords will produce an error message. All attempts, both valid and invalid, are logged to detect abuses of the system. Applications may not assume the format of prompts and anticipated input for user interaction, because they are unspecified.

An optional command can be executed. This is done by the shell specified in /etc/passwd for the target user unless the -s or -m options are used. Any arguments supplied after the username will be passed to the invoked shell (shell shall support the -c command line option in order for a command to be passed to it).

The current environment is passed to the new shell. The value of $PATH is reset to /bin:/usr/bin for normal users, or /sbin:/bin:/usr/sbin:/usr/bin for the super user. This may be changed with the ENV_PATH and ENV_SUPATH definitions in /etc/login.defs. When using the -m or -p options, the user's environment is not changed.

A subsystem login is indicated by the presense of a "*" as the first character of the login shell. The given home directory will be used as the root of a new filesystem which the user is actually logged into.

Standard Options

-

makes this a login shell.

-c, --comand=command

passes command to the invoked shell. It is passed directly to the invoked shell (using the shell's -c option), so its syntax is whatever that shell can accept.

-m, -p, --preserve-environment

does not reset environment variables, and keeps the same shell if it is present in /etc/shells.

-s, --shell=shell

uses shell instead of the default in /etc/passwd. The shell specified shall be present in /etc/shells.

sync

Name

sync -- flush filesystem buffers

Synopsis

sync

Description

Force changed blocks to disk, update the super block.

tar

Name

tar -- file archiver

Description

tar is as specified in the Single UNIX Specification, Version 2, but with differences as listed below.

Differences

Certain aspects of internationalized filename globbing are optional; see Internationalization and Filename Globbing>.

-h

doesn't dump symlinks; dumps the files they point to.

-z

filters the archive through gzip.

umount

Name

umount -- unmount file systems

Synopsis

umount [-hV]
umount -a [-nrv] [-t vfstype]
umount [-nrv] device | dir [...]

Description

umount detaches the file system(s) mentioned from the file hierarchy. A file system is specified by giving the directory where it has been mounted.

Standard Options

-v

invokes verbose mode.

-n

unmounts without writing in /etc/mtab.

-r

tries to remount read-only if unmounting fails.

-a

unmounts all of the file systems described in /etc/mtab except for the proc filesystem.

-t vfstype

indicates that the actions should only be taken on file systems of the specified type. More than one type may be specified in a comma separated list. The list of file system types can be prefixed with no to specify the file system types on which no action should be taken.

-f

forces unmount (in case of an unreachable NFS system).

LSB Deprecated Options

The behaviors specified in this section are expected to disappear from a future version of the LSB; applications should only use the non-LSB-deprecated behaviors.

-V

print version and exits.

useradd

Name

useradd -- create a new user or update default new user information

Synopsis

useradd [-c comment] [-d home_dir]
        [-g initial_group] [-G group[,...]]
        [-m [-k skeleton_dir]] [-p passwd] [-r]
        [-s shell] [-u uid [ -o]] login

useradd -D [-g default_group] [-b default_home]
           [-s default_shell]

Description

When invoked without the -D option, useradd creates a new user account using the values specified on the command line and the default values from the system. The new user account will be entered into the system files as needed, the home directory will be created, and initial files copied, depending on the command line options.

When invoked with the -D option, useradd will either display the current default values, or update the default values from the command line. If no options are specified, useradd displays the current default values.

Standard Options

-c comment

specifies the new user's password file comment field value.

-d home_dir

creates the new user using home_dir as the value for the user's login directory. The default is to append the login name to default_home and use that as the login directory name.

-g initial_group

specifies the group name or number of the user's initial login group. The group name shall exist. A group number shall refer to an already existing group. If -g is not specified, the implementation will follow the normal user default for that system. This may create a new group or choose a default group that normal users are placed in. Applications which require control of the groups into which a user is placed should specify -g.

-G group,[...]

specifies a list of supplementary groups which the user is also a member of. Each group is separated from the next by a comma, with no intervening whitespace. The groups are subject to the same restrictions as the group given with the -g option. The default is for the user to belong only to the initial group.

-m [-k skeleton_dir]

specifies the user's home directory will be created if it does not exist. The files contained in skeleton_dir will be copied to the home directory if the -k option is used, otherwise the files contained in /etc/skel will be used instead. Any directories contained in skeleton_dir or /etc/skel will be created in the user's home directory as well. The -k option is only valid in conjunction with the -m option. The default is to not create the directory and to not copy any files.

-p passwd

is the encrypted password, as returned by crypt(3). The default is to disable the account.

-r

creates a system account, that is, a user with a UID in the range reserved for system account users. If there is not a UID free in the reserved range the command will fail.

-s shell

specifies the name of the user's login shell. The default is to leave this field blank, which causes the system to select the default login shell.

-u uid [-o]

specifies the numerical value of the user's ID. This value shall be unique, unless the -o option is used. The value shall be non-negative. The default is the smallest ID value greater than 499 which is not yet used.

Change Default Options

-b default_home

specifies the initial path prefix for a new user's home directory. The user's name will be affixed to the end of default_home to create the new directory name if the -d option is not used when creating a new account.

-g default_group

specifies the group name or ID for a new user's initial group. The named group shall exist, and a numerical group ID shall have an existing entry.

-s default_shell

specifies the name of the new user's login shell. The named program will be used for all future new user accounts.

-c comment

specifies the new user's password file comment field value.

Application Usage

The -D option will typically be used by system administration packages. Most applications should not change defaults which will affect other applications and users.

userdel

Name

userdel -- delete a user account and related files

Synopsis

userdel [-r] login

Description

Delete the user account named login. If there is also a group named login, this command may delete the group as well, or may leave it alone.

Options

-r

removes files in the user's home directory along with the home directory itself. Files located in other file system will have to be searched for and deleted manually.

usermod

Name

usermod -- modify a user account

Synopsis

usermod [-c comment] [-d home_dir [ -m]]
        [-g initial_group] [-G group[,...]]
        [-l login_name] [-p passwd]
        [-s shell] [-u uid [ -o]] login

Options

-c comment

specifies the new value of the user's password file comment field.

-d home_dir

specifies the user's new login directory. If the -m option is given the contents of the current home directory will be moved to the new home directory, which is created if it does not already exist.

-g initial_group

specifies the group name or number of the user's new initial login group. The group name shall exist. A group number shall refer to an already existing group.

-G group,[...]

specifies a list of supplementary groups which the user is also a member of. Each group is separated from the next by a comma, with no intervening whitespace. The groups are subject to the same restrictions as the group given with the -g option. If the user is currently a member of a group which is not listed, the user will be removed from the group.

-l login_name

changes the name of the user from login to login_name. Nothing else is changed. In particular, the user's home directory name should probably be changed to reflect the new login name.

-p passwd

is the encrypted password, as returned by crypt(3).

-s shell

specifies the name of the user's new login shell. Setting this field to blank causes the system to select the default login shell.

-u uid [-o]

specifies the numerical value of the user's ID. This value shall be unique, unless the -o option is used. The value shall be non-negative. Any files which the user owns and which are located in the directory tree rooted at the user's home directory will have the file user ID changed automatically. Files outside of the user's home directory shall be altered manually.

xargs

Name

xargs -- build and execute command lines from standard input

Description

xargs is as specified in the Single UNIX Specification but with differences as listed below.

Differences

-E

has unspecified behavior.

-I

has unspecified behavior.

-L

has unspecified behavior.

V. Execution Environment


Chapter 9. File System Hierarchy

An LSB conforming implementation shall adhere to the Filesystem Hierarchy Standard (FHS) 2.3

An LSB conforming application shall follow the FHS.

The FHS allows many components or subsystems to be optional. An application shall check for the existence of an optional component before using it, and should behave in a reasonable manner if the optional component is not present.

The FHS requirement to locate the operating system kernel in either / or /boot does not apply if the operating system kernel does not exist as a file in the filesystem.

The FHS specifies certain behaviors for a variety of commands if they are present (for example, ping or python). However, LSB applications shall not rely on any commands beyond those specified by the LSB. The mere existence of a command may not be used as an indication that the command behaves in any particular way.

The following directories or links need not be present: /etc/X11 /usr/bin/X11 /usr/lib/X11 /proc


/dev

The following shall exist under /dev. Other devices may also exist in /dev. Device names may exist as symbolic links to other device nodes located in /dev or subdirectories of /dev. There is no requirement concerning major/minor number values.

/dev/null

An infinite data source and data sink. Data written to this device shall be discarded. Reads from this device shall always return end-of-file (EOF).

/dev/zero

This device is a source of zeroed out data. All data written to this device shall be discarded. A read from this device shall always return the requested number of bytes, each initialized to the value '\0'.

/dev/tty

In each process, a synonym for the controlling terminal associated with the process group of that process, if any. All reads and writes to this device shall behave as if the actual controlling terminal device had been opened.


Chapter 10. Additional Recommendations

Minimal granted Directory and File permissions

In this Chapter "System" means an "LSB conforming implementation" and "application" means an "LSB conforming (third party vendor) application".

The system shall grant to the application read and execute permissions needed to use all system interfaces (ABIs) mentioned in the LSB document and included standards.


Recommendations for applications on ownership and permissions

Directory Write Permissions

The application should not depend on having directory write permission outside /tmp, /var/tmp, invoking user's home directory and /var/opt/package, (where package is the name of the application package).

The application should not depend on owning these directories.

For these directories the application should be able to work with directory write permissions restricted by the "sticky bit". (Which prevents the application from removing files owned by another user. This is classically done with /tmp, to prevent accidental deletion of "foreign" files.)


File Write Permissions

The application should not depend on file write permission on files not owned by the user it runs under with the exception of its personal inbox /var/mail/username


File Read and execute Permissions

The application should not depend on having read permission to every file and directory.


Suid and Sgid Permissions

The application should not depend on the suid/sgid permissions of a file not packaged with the application. Instead, the distribution is responsible for assuming that all system commands have the required permissions and work correctly.

Rationale: Let us make security officers happy. Let's give them the freedom to take sgid/suid perms away, as long as they do not break the system's functionality.


Privileged users

"Normal" applications should not depend on running as a privileged user.

Special applications that have a reason to run under a privileged user, should outline these reasons clearly in their documentation, if they are not obvious as in the case of a backup/restore program. Users of the application should be informed, that "this application demands security privileges, which could interfere with system security".

The application should not contain binary-only software that requires being run as root, as this makes security auditing harder or even impossible.


Changing permissions

The application should not change permissions of files and directories that do not belong to its own package. To do so without a warning notice in the documentation is regarded as unfriendly act.


Removable Media (Cdrom, Floppy, etc.)

Applications that expect to be runnable from removable media should not depend on logging in as a privileged user, and should be prepared to deal with a restrictive environment. Examples of such restrictions could be default mount options that disable set-user/group-ID attributes, disabling block or character-special files on the medium, or remapping the user/group IDs of files away from 0. [23]


Installable applications

If the installation of an application requires the execution of programs with superuser privileges, such programs should also be supplied in a human-readable form.

Without this, the local system administrator would have to blindly trust a piece of software, particularly with respect to its security.


Chapter 11. Additional Behaviors

Mandatory Optional Behaviors

This section specifies behaviors in which there is optional behavior in one of the standards on which the LSB relies, and where the LSB requires a specific behavior. [24]

LSB conforming implementations shall support the following options defined within the ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3:

_POSIX_FSYNC
_POSIX_MAPPED_FILES
_POSIX_MEMLOCK
_POSIX_MEMLOCK_RANGE
_POSIX_MEMORY_PROTECTION
_POSIX_PRIORITY_SCHEDULING
_POSIX_REALTIME_SIGNALS
_POSIX_THREAD_ATTR_STACKADDR
_POSIX_THREAD_ATTR_STACKSIZE
_POSIX_THREAD_PROCESS_SHARED
_POSIX_THREAD_SAFE_FUNCTIONS
_POSIX_THREADS
_XOPEN_UNIX

The opendir() function shall consume a file descriptor in the same fashion as open, and therefore may fail with EMFILE or ENFILE.

The START and STOP termios characters shall be changeable, as described as optional behavior in the "General Terminal Interface" section of the ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3.

The access() function function shall fail with errno set to EINVAL if the amode argument contains bits other than those set by the bitwise inclusive OR of R_OK, W_OK, X_OK and F_OK.

The link() function shall require access to the existing file in order to succeed, as described as optional behavior in the ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3.

Calling unlink() on a directory shall fail. Calling link() specifying a directory as the first argument shall fail. See also unlink. [25]


Special Requirements

LSB conforming systems shall enforce certain special additional restrictions above and beyond those required by ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3. [26]

The fcntl() function shall treat the "cmd" value -1 as invalid.

The "whence" value -1 shall be an invalid value for the lseek(), fseek() and fcntl() functions.

The value "-5" shall be an invalid signal number.

If the sigaddset() or sigdelset() functions are passed an invalid signal number, they shall return with EINVAL. Implementations are only required to enforce this requirement for signal numbers which are specified to be invalid by this specification (such as the -5 mentioned above).

The mode value "-1" to the access() function shall be treated as invalid.

A value of -1 shall be an invalid "_PC_..." value for pathconf().

A value of -1 shall be an invalid "_SC..." value for sysconf().

The nl_item value "-1" shall be invalid for nl_langinfo.

The value -1 shall be an invalid "_CS_..." value for confstr().

The value "z" shall be an invalid mode argument to popen().


Chapter 12. Localization

Applications may either install a message catalog in the MO format as specified by the info page in version 0.10.40 of the gettext source package, or the application may execute the msgfmt command during it's installation to compile the message catalog. In either case, the resulting output shall be located in the package's private area under /opt, and the application may use bindtextdomain() to specify this location.

Implementations shall support the POSIX and C locales as specified in the Single UNIX Specification.


Regular Expressions

Utilities that process regular expressions shall support Basic Regular Expressions and Extended Regular Expressions as specified in the Single UNIX Specification, with the following exceptions:

Range expression (such as [a-z]) can be based on code point order instead of collating element order.

Equivalence class expression (such as [=a=]) and multi-character collating element expression (such as [.ch.]) are optional.

Handling of a multi-character collating element is optional.

This affects at least the following utilities: grep (grep>) (including egrep), sed (sed>), and awk (awk>).


Filename Globbing

Utilities that perform filename globbing (also known as Pattern Matching Notation) shall do it as specified in the Single UNIX Specification, with the following exceptions:

Range expression (such as [a-z]) can be based on code point order instead of collating element order.

Equivalence class expression (such as [=a=]) and multi-character collating element expression (such as [.ch.]) are optional.

Handling of a multi-character collating element is optional.

This affects at least the following utilities: cpio (cpio>), find (find>), ls (ls>) and tar (tar>).

VI. System Initialization

Table of Contents
13. System Initialization

Chapter 13. System Initialization

Cron Jobs

Packages may not touch the configuration file /etc/crontab, nor may they modify the files in /var/spool/cron/crontabs.

If a package wants to install a job that has to be executed via cron, it shall place a file in one of the following directories:

/etc/cron.daily
/etc/cron.weekly
/etc/cron.monthly

As these directory names say, the files within them are executed on a daily, weekly, or monthly basis, respectively. See below for the rules concerning the names of these files.

If a certain job has to be executed more frequently than daily, the package shall install a file /etc/cron.d/cron-name tagged as configuration file. This file uses the same syntax as /etc/crontab and is processed by cron automatically.

It is recommended that files installed in any of these directories be scripts (shell scripts, Perl scripts, etc.) so that they may be modified by the local system administrator. In addition, they shall be registered as configuration file.

The scripts in these directories have to check, if all necessary programs are installed before they try to execute them. Otherwise, problems will arise when a package was removed (but not purged), since the configuration files are kept on the system in this situation.

To avoid namespace conflicts in the /etc/cron.* directories, the filenames used by LSB-compliant packages in /etc/cron.daily, /etc/cron.weekly, /etc/cron.monthly, or /etc/cron.d shall come from a managed namespace. These filenames may be assigned using one of the following methods:

  • Assigned namespace. This namespace consists of names which only use the character set [a-z0-9]. In order to avoid conflicts these cron script names shall be reserved through the Linux Assigned Names and Numbers Authority (LANANA). Information about the LANANA may be found at www.lanana.org.

    Commonly used names shall be reserved in advance; developers for projects should be encouraged reserve names from LANA, so that each distribution can use the same name, and to avoid conflicts with other projects.

  • Hierarchical namespace. This namespace consists of scripts names which look like this: [hier1]-[hier2]-...-[name], where name is again taken the character set [a-z0-9], and where there may be one or more [hier-n] components. [hier1] may either be an LSB provider name assigned by the LANANA, or it may be owners' DNS name in lower case, with at least one '.'. I.e., "debian.org", "staroffice.sun.com", etc. The LSB provider name assigned by LANANA shall only consist of the ASCII characters [a-z0-9].

  • Reserved namespace. This namespace consists of script names which begin with the character '_', and is reserved for distribution use only. This namespace should be used for core packages only, and in general use of this namespace is highly discouraged.


Init Script Actions

Init files provided by LSB applications shall accept one argument, saying what to do:

startstart the service
stopstop the service
restartstop and restart the service if the service is already running, otherwise start the service
try-restartrestart the service if the service is already running
reloadcause the configuration of the service to be reloaded without actually stopping and restarting the service
force-reloadcause the configuration to be reloaded if the service supports this, otherwise restart the service if it is running
statusprint the current status of the service

The start, stop, restart, force-reload, and status commands shall be supported by all init files; the reload and the try-restart options are optional. Other init script actions may be defined by the init script.

Init files shall ensure that they will behave sensibly if invoked with start when the service is already running, or with stop when it isn't, and that they don't kill unfortunately-named user processes. The best way to achieve this is to use the init-script functions provided by /lib/lsb/init-functions.

If a service reloads its configuration automatically (as in the case of cron, for example), the reload option of the init file shall behave as if the configuration has been reloaded successfully. The restart, try-restart, reload and force-reload action may be atomic; i.e. if a service is known not be operational after a restart or reload, the script may return an error without any further action.

These executable files shall not fail obscurely when the configuration files remain but the package has been removed, as the default in [the packaging system] is to leave configuration files on the system after the package has been removed. Only when it is executed with the [purge] option will [the packaging system] remove configuration files. Therefore, you should include a test statement at the top of the file, like this:
test -f program-executed-later-in-file || exit 5
or take the equivalent action if the init file is not a shell script.

If the status command is given, the init script will return the following exit status codes.

0program is running or service is OK
1program is dead and /var/run pid file exists
2program is dead and /var/lock lock file exists
3program is not running
4program or service status is unknown
5-99reserved for future LSB use
100-149reserved for distribution use
150-199reserved for application use
200-254reserved

In the case of init script commands other than "status" (i.e., "start", "stop", "restart", "try-restart", "reload", and "force-reload"), the init script shall return an exit status of zero if the action described by the argument has been successful. Otherwise, the exit status shall be non-zero, as defined below. In addition to straightforward success, the following situations are also to be considered successful:

  • restarting a service (instead of reloading it) with the "force-reload" argument

  • running "start" on a service already running

  • running "stop" on a service already stopped or not running

  • running "restart" on a service already stopped or not running

  • running "try-restart" on a service already stopped or not running

In case of an error, while processing any init script action except for "status", the init script shall print an error message and return one of the following non-zero exit status codes.

1generic or unspecified error (current practice)
2invalid or excess argument(s)
3unimplemented feature (for example, "reload")
4user had insufficient privilege
5program is not installed
6program is not configured
7program is not running
8-99reserved for future LSB use
100-149reserved for distribution use
150-199reserved for application use
200-254reserved

Error and status messages should be printed with the logging functions such as log_failure_msg and so on. Scripts may write to standard error or standard output, but implementations need not present text written to standard error/output to the user or do anything else with it.

Since init files may be run manually by a system administrator with non-standard environment variable values for PATH, USER, LOGNAME, etc. init files shall not depend on the values of these environment variables. They should set them to some known/default values if they are needed.


Comment Conventions for Init Scripts

LSB applications which need to execute script(s) at bootup and/or shutdown may provide one or more init.d files. These files are installed by the install_initd program described below, which copies it into a standard directory and makes whatever other adjustments (creation of symlinks, creation of entries in a database, etc.) are necessary so that the script can be run at boot-time. [27]

In the init.d file, information about the shell script shall be delimited by the lines "### BEGIN INIT INFO" and "### END INIT INFO". These delimiter lines may containg trailing whitespace, which shall be ignored. Inside this block there shall be lines of the form "# {keyword}: [arg1] [arg2] ...". (All lines inside this block start with a hash ('#') character in the first column, so that shell treats them as comments.) There shall be exactly one space character between "#" and the keyword.[28] The following keywords, with their arguments are defined in this specification:

	# Provides: boot_facility_1 [ boot_facility_2 ...]
	# Required-Start: boot_facility_1 [ boot_facility_2 ...]
	# Required-Stop: boot_facility_1 [ boot_facility_2 ...]
	# Should-Start: boot_facility_1 [ boot_facility_2 ...]
	# Should-Stop: boot_facility_1 [ boot_facility_2 ...]
	# Default-Start: run_level_1 [ run_level_2 ...]
	# Default-Stop: run_level_1 [ run_level_2 ...]
	# Short-Description: short_description
	# Description: multiline_description

Additional keywords may be defined in future LSB specifications. Distributions may define local extensions by using the prefix "X-[distribution name]" --- for example, "X-RedHat-foobardecl", or "X-Debian-xyzzydecl".

An init.d shell script may declare using the "Required-Start: " header that it shall not be run until certain boot facilities are provided. This information is used by the installation tool or the boot-time boot-script execution facility to assure that init scripts are run in the correct order. When an init script is run with a "start" argument, the boot facility or facilities specified in the "Provides" header shall be considered present, and hence init scripts which require those boot facilities would then be eligble to be run. When an init script is run with a "stop" argument, the boot facilities specified in the "Provides" header are considered no longer present. There are naming conventions for boot facilities and system facilities, as described in a following section.

Similarly, the "Required-Stop:" header defines which facilities shall still be available during the shutdown of that service. Hence, the init script system should avoid stopping shell scripts which provide those facilities until this shell script is stopped.

The "Should-Start:" header defines which facilities if present should be started before this service. This allows for weak dependencies which do not cause the service to fail if a facility is not available. But may cause reduced functionality of the service. Compliant applications should not rely on the existence of this feature.

The "Should-Stop:" header defines which facilities should be still available during the shutdown of that service.

The "Default-Start" and "Default-Stop" headers define which run levels should by default run the script with a start or stop argument, respectively, to start or stop the services controlled by the init script. [29]

The "Short-Description" and "Description" header fields are used to provide text which describes the actions of the init script. The "short_description" shall be a relatively short, pithy description of the init script, where as the "multiline_description" can be a much longer piece of text that may span mulitple lines. In a multiline description, each continuation line shall begin with a '#' followed by tab character or a '#' followed by at least two space characters. The multiline description is terminated by the first line that does not match this criteria.

The comment conventions described in this session are only required for use by LSB-compliant applications; system init scripts as provided by LSB-compliant run-time environments are not required to use the scheme outlined here.


Installation and Removal of init.d Files

An init.d file is installed in /etc/init.d (which may be a symlink to another location). This can be done by the package installer. See Script Names>. During the package's postinstall script, the program "/usr/lib/lsb/install_initd" configures the distribution's boot script system to call the package's init.d file at the appropriate time. [30]

The install_initd program takes a single argument, the pathname to the /etc/init.d file. For example:

	/usr/lib/lsb/install_initd /etc/init.d/example.com-coffeed

The install_initd program shall return an exit status of zero if the init.d file has been successfully installed or if the the init.d file was already installed. If the required boot facilities cannot be fulfilled an exit status of one shall be returned and the init.d file shall not be installed.

When a software package is removed, the package's preuninstall script shall call /usr/lib/lsb/remove_initd and pass the pathname to the /etc/init.d file. The package manager is still responsible for removing the /etc/init.d file; the remove_initd program is provided in case the distribution needs to clean up any other modifications in the distribution's boot script system that might have been made by the install_initd program. For example:

	/usr/lib/lsb/remove_initd /etc/init.d/example.com-coffeed

The remove_initd program shall return an exit status of zero if the init.d file has been successfully removed or if the the init.d file is not installed. If another init.d file which depends on a boot facility provided by this init.d file is installed, an exit status of one shall be returned and the init.d file shall remained installed.

There should be a tool available to the user (e.g., RedHat's chkconfig) which can be used by the system administrator to easily manipulate at which init levels a particular init.d script is started or stopped. This specification currently does not specify such an interface, however.


Run Levels

The following run levels are specified for use by the "Default-Start:" and "Default-Stop:" specifiers as defined by the section Comment Conventions for Init Scripts>. Many LSB run-time environments commonly use these run level definitions, and in the absence of other considerations, providers of run-time environments are strongly encouraged to follow this convention to provide consistency for system administrators who need to work with multiple distributions. However, it is not required that LSB-compliant run-time environments use these run levels; the distribution-provided install_initd script may map the run levels specified below to whatever distribution-specified run levels are most appropriate.

0halt
1single user mode
2multiuser with no network services exported
3normal/full multiuser
4reserved for local use, default is normal/full multiuser
5multiuser with xdm or equivalent
6reboot


Facility Names

Boot facilities are used to indicate dependencies in init scripts, as defined in a previous section. Facility names that begin with a dollar sign ('$') are system facility names, defined by the LSB, and SHALL be provided by distributions. [31] LSB applications shall not provide facilities that begin with a dollar sign. This document defines the following facility names:

$local_fsall local filesystems are mounted
$networklow level networking (ethernet card; may imply PCMCIA running)
$nameddaemons which may provide hostname resolution (if present) are running[32]
$portmapdaemons providing SunRPC/ONCRPC portmapping service[33] (if present) are running
$remote_fsall remote filesystems are mounted[34].
$syslogsystem logger is operational
$timethe system time has been set [35]

Other (non-system) facilities may be defined by other LSB applications. These facilities shall be named using the same conventions defined for naming init.d script names. Commonly, the facility provided by an LSB application init.d script will have the same name as the name assigned to the init.d script.


Script Names

Since the init.d scripts shall live in a single directory, they shall come from a single namespace. Three means of assigning names from this namespace are available:

  • Assigned namespace. This namespace consists of names which only use the character set [a-z0-9]. This space is desirable for scripts which system administrators may often wish to run manually: e.g., "/etc/init.d/named restart" In order to avoid conflicts these init.d names shall be reserved through the Linux Assigned Names and Numbers Authority (LANANA). Information about the LANANA may be found at www.lanana.org.

    Commonly used names shall be reserved in advance; developers for projects should be encouraged to reserve names from LANANA, so that each distribution can use the same name, and to avoid conflicts with other projects.

  • Hierarchical namespace. This namespace consists of scripts names which look like this: [hier1]-[hier2]-...-[name], where name is again taken the character set [a-z0-9], and where there may be one or more [hier-n] components. [hier1] may either be an LSB provider name assigned by the LANANA, or it may be owners' DNS name in lower case, with at least one '.' (e.g., "debian.org", "staroffice.sun.com"). The LSB provider name assigned by LANANA shall only consist of the ASCII characters [a-z0-9].

  • Reserved namespace. This namespace consists of script names which begin with the character '_', and is reserved for distribution use only. This namespace should be used for core packages only, and in general use of this namespace is highly discouraged.

In general, if a package or some system function is likely to be used on multiple systems, the package developers or the distribution SHOULD get a registered name through LANANA, and distributions should strive to use the same name whenever possible. For applications which may not be "core" or may not be commonly installed, the hierarchical namespace may be more appropriate. An advantage to the hierarchical namespace is that there is no need to consult with the LANANA before obtaining an assigned name.

Short names are highly desirable, since many system administrators like to use them to manually start and stop services. Given this, they should be standardized on a per-package basis. This is the rationale behind having a LANANA organization to assign these names. The LANANA may be called upon to handle other namespace issues, such as package/prerequisites naming (which is essential to making prerequisites to work correctly).


Init Script Functions

Each LSB-compliant init.d script shall source the file /lib/lsb/init-functions. This file shall cause the following shell script commands to be defined. This can be done either by adding a directory to the PATH variable which defines these commands, or by defining sh aliases. While the distribution-provided aliases may choose to use shell extensions (at the distribution's option), the LSB init.d files themselves should only depend in shell features as defined by the LSB.

The start_daemon, killproc and pidofproc functions shall use this algorithm for determining the status and the pid(s) of the specified program. They shall read the pidfile specified or otherwise /var/run/basename.pid and use the pid(s) herein when determining whether a program is running. The method used to determine the status is implementation defined, but should allow for non-binary programs. [36] Compliant implementations may use other mechanisms besides those based on pidfiles, unless the -p pidfile option has been used. Compliant applications should not rely on such mechanisms and should always use a pidfile. When a program is stopped, it should delete its pidfile. Multiple pid(s) shall be separated by a single space in the pidfile and in the output of pidofproc.

start_daemon [-f] [-n nicelevel] [-p pidfile] pathname [args]This runs the specified program as a daemon. start_daemon shall check if the program is already running using the algorithm given above. If so, it shall not start another copy of the daemon unless the -f option is given. The -n option specifies a nice level. See nice(1). start_daemon should return the LSB defined exit status codes. It shall return 0 if the program has been successfully started or is running and not 0 otherwise.
killproc [-p pidfile] pathname [signal]This stops the specified program. The program is found using the algorithm given above. If a signal is specified, using the -signal_name or -signal_number syntaxes as specified by the kill command, the program is sent that signal. Otherwise, a SIGTERM followed by a SIGKILL after some number of seconds shall be sent. If a program has been terminated, the pidfile should be removed if the terminated process has not already done so. Compliant applications may use the basename instead of the pathname. killproc should return the LSB defined exit status codes. If called without a signal, it shall return 0 if the program has been stopped or is not running and not 0 otherwise. If a signal is given, it shall return 0 only if the program is running.
pidofproc [-p pidfile] pathnameThis function returns one or more pid(s) for a particular daemon using the algorithm given above. Only pids of running processes should be returned. Compliant applications may use the basename instead of the pathname. pidofproc should return the LSB defined exit status codes for "status". It shall return 0 if the program is running and not 0 otherwise.
log_success_msg "message"This requests the distribution to print a success message. The message should be relatively short; no more than 60 characters is highly desirable.
log_failure_msg "message"This requests the distribution to print a failure message. The message should be relatively short; no more than 60 characters is highly desirable.
log_warning_msg "message"This requests the distribution to print a warning message. The message should be relatively short; no more than 60 characters is highly desirable.

VII. Users & Groups

Table of Contents
14. Users & Groups

Chapter 14. Users & Groups

A "user name" is a string that is used to identify a user. A "login name" is a user name that is associated with a system login. A "user id" is a non negative integer, which can be contained in an object of type uid_t, that is used to identify a system user.

When the identity of a user is associated with a process, a user ID value is referred to as a real user ID, or an effective user ID. [POSIX 1003.1-1996]

A "group name" is a string that is used to identify a set of users. A "group id" is a non negative integer, which can be contained in a object of type gid_t, that is used to identify a group of system users. Each system user is a member of at least one group. When the identity of a group is associated with a process, a group ID value is referred to as a real group ID, or an effective group ID. [POSIX 1003.1-1996]


User and Group Database

The format of the User and Group databases is not specified. Programs may only read these databases using the provided API. Changes to these databases should be made using the provided commands.


User & Group Names

Below is a table of required mnemonic user and group names. This specification makes no attempt to numerically assign uid or gid numbers. The exception is the uid and gid for "root" which are equal to 0.

Table 14-1. Required User & Group Names

UserGroupComments
rootrootAdministrative user with no restrictions
binbinLegacy UID/GID[a]
daemondaemonLegacy UID/GID[b]
Notes:
a. The 'bin' UID/GID is included for compatibility with legacy applications. New applications should no longer use the 'bin' UID/GID.
b. The 'daemon' UID/GID was used as an unprivileged UID/GID for daemons to execute under in order to limit their access to the system. Generally daemons should now run under individual UID/GIDs in order to further partition daemons from one another.

Below is a table of optional mnemonic user and group names. This specification makes no attempt to numerically assign uid or gid numbers. If the username exists on a system, then they should be in the suggested corresponding group. These user and group names are for use by distributions, not by applications.

Table 14-2. Optional User & Group Names

UserGroupComments
admadmAdministrative special privileges
lplpPrinter special privileges
syncsyncLogin to sync the system
shutdownshutdownLogin to shutdown the system
halthaltLogin to halt the system
mailmailMail special privileges
newsnewsNews special privileges
uucpuucpUUCP special privileges
operatorrootOperator special privileges
manmanMan special privileges
nobodynobodyUsed by NFS

The differences in numeric values of the uids and gids between systems on a network can be reconciled via NIS, rdist(1), rsync(1), or ugidd(8). Only a minimum working set of "user names" and their corresponding "user groups" are required. Applications cannot assume non system user or group names will be defined.

Applications cannot assume any policy for the default umask or the default directory permissions a user may have. Applications should enforce user only file permissions on private files such as mailboxes. The location of the users home directory is also not defined by policy other than the recommendations of the FHS and shall be obtained by the *pwnam(3) calls.


UID Ranges

The system UIDs from 0 to 99 should be statically allocated by the system, and not created by applications.

The system UIDs from 100 to 499 should be reserved for dynamically allocation by system administrators and post install scripts using useradd(1).


Rationale

The purpose of specifying optional users and groups is to reduce the potential for name conflicts between applications and distributions.

Notes

[1]

The LSB generally does not include interfaces unlikely to be used by software applications.

[2]

As of spring 2004, we don't know of any Linux kernel patches to switch to ENXIO, but we believe that such a kernel patch would be accepted if submitted.

[3]

For example, if off_t is 64 bits.

[4]

As of spring 2004, we don't know of any Linux kernel patches to switch to ENXIO, but we believe that such a kernel patch would be accepted if submitted.

[5]

As of spring 2004, we don't know of any Linux kernel patches to switch to ENXIO, but we believe that such a kernel patch would be accepted if submitted.

[6]

SIOCGIFCONF is similar to the if_nameindex family found in the Single UNIX Specification, Version 3 or the getifaddrs family found in BSD.

[7]

Historical UNIX systems disagree on the meaning of the return value.

[8]

This was a deliberate Linus decision after an unpopular experiment in including the calling process in the 2.5.1 kernel. See "What does it mean to signal everybody?", Linux Weekly News, 20 December 2001, http://lwn.net/2001/1220/kernel.php3

[9]

As of spring 2004, we don't know of any Linux kernel patches to switch to ENXIO, but we believe that such a kernel patch would be accepted if submitted.

[10]

Note the optional use of the buffer, unlike the strerror_r found in the Single UNIX Specification, Version 3, in which the message is always copied into the supplied buffer. The return types also differ.

[11]

A token is a nonempty string of characters not occurring in the string delim, followed by \0 or by a character occurring in delim.

[12]

The Linux kernel has deliberately chosen EISDIR for this case and does not expect to change (Al Viro, personal communication).

[13]

These macros take the stat buffer (an int) as an argument -- not a pointer to the buffer!

[14]

Traditionally, /lib and /usr/lib. This case would also cover cases in which the system used the mechanism of /etc/ld.so.conf and /etc/ld.so.cache to provide access.

Example: An application which is not linked against libm may choose to dlopen libm.

[15]

Future versions of this specification might define additional service names.

[16]

Thus, applications should place options before operands, or use --, as needed. This text is needed because GNU option parsing differs from POSIX. For example, ls . -a in GNU ls means to list the current directory, showing all files (that is, "." is an operand and -a is an option). In POSIX, "." and -a are both operands, and the command means to list the current directory, and also the file named -a. Suggesting that applications rely on the setting of the POSIXLY_CORRECT environment variable, or try to set it, seems worse than just asking the applictions to invoke commands in ways which work with either the POSIX or GNU behaviors.

[17]

Linux Standard Base

[18]

ISO/IEC 9945:2003 Portable Operating System(POSIX)and The Single UNIX® Specification(SUS) V3

[19]

The LSB generally does not include software development utilities nor does it specify .o and .a file formats.

[20]

The following two options are expected to be added in a future version of the LSB:

-o office

sets the user's office room number.

-p office-phone

sets the user's office phone number.

Note that some implementations contain a "-o other" option which specifies an additional field called "other". Traditionally, this field is not subject to the constraints about legitimate characters in fields. Also, one traditionally shall have appropriate privileges to change the other field. At this point there is no consensus about whether it is desirable to specify the other field; applications may wish to avoid using it.

The "-w work_phone" field found in some implementations should be replaced by the "-p office_phone" field. The "-r room_number" field found in some implementations is the equivalent of the "-o office" option mentioned above; which one of these two options to specify will depend on implementation experience and the decision regarding the other field.

The intention is for chfn to match the behavior of finger; some historical implementations have been broken in the sense that finger and chfn do not agree on what the fields are.

[21]

The behavior specified here is similar to that specified by the Single UNIX Specification version 3 without the XSI option. However, the LSB forbids all options and the latter forbids only -n.

[22]

Need further investigation on the behavior of various implementations concerning whether program is a full pathname, the basename only, the program as named by argv[0], or what.

[23]

Rationale: System vendors and local system administrators want to run applications from removable media, but want the possibility to control what the application can do.

[24]

The LSB does not require the kernel to be Linux; the set of mandated options reflects current existing practice, but may be modified in future releases.

[25]

Linux allows rename() on a directory without having write access, but the LSB does not require this.

[26]

These additional restrictions are required in order to support the testing and certification programs associated with the LSB. In each case, these are values that defined macros must not have; conforming applications that use these values shall trigger a failure in the interface that is otherwise described as a "may fail".

[27]

This specification does not require, but is designed to allow, the development of a system which runs boot scripts in parallel. Hence, enforced-serialization of scripts is avoided unless it is explicitly necessary.

[28]

More than one space, or a tab character, indicates the continuation line.

[29]

For example, if you want a service to run in runlevels 3, 4, and 5 (only), specify "Default-Start: 3 4 5" and "Default-Stop: 0 1 2 6".

[30]

For example, install_initd might create symbolic links in /etc/rc2.d and other such directories which point to the files in /etc/init.d (or it might update a database, or some other mechanism). The init.d files themselves should already be in /etc/init.d before running install_initd.

[31]

The dollar sign does not indicate variable expansion as in many Linux utilities. Starting a facility name with a dollar sign is merely a way of dividing the namespace between the system and applications.

[32]

For example, daemons to query DNS, NIS+, or LDAP

[33]

as defined in RFC 1833

[34]

In some LSB run-time environments, filesystems such as /usr may be remote. Many applications that require $local_fs will probably require also require $remote_fs

[35]

i.e., using a network-based time program such as ntp or rdate, or via the hardware Real Time Clock

[36]

This note is only informative. Commonly used methods check either for the existence of the /proc/pid directory or use /proc/pid/exe and /proc/pid/cmdline. Relying only on /proc/pid/exe is discouraged since this results in a not-running status for daemons that are written in a script language.