From 832e33c5ec020e2e24e85f8945ed0ab21fb2ff52 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Mon, 3 Aug 1998 18:30:21 +0000 Subject: Added many new chapters --- doc/new_chapters/Makefile | 69 ++++- doc/new_chapters/adminiface.t | 53 ++++ doc/new_chapters/cancel.t | 141 +++++++++ doc/new_chapters/confspace.t | 295 +++++++++++++++++++ doc/new_chapters/cspecific.t | 493 +++++++++++++++++++++++++++++++ doc/new_chapters/device.t | 295 +++++++++++++++++++ doc/new_chapters/dumpcontrol.t | 53 ++++ doc/new_chapters/eventlog.t | 295 +++++++++++++++++++ doc/new_chapters/files.t | 603 ++++++++++++++++++++++++++++++++++++++ doc/new_chapters/gen_section | 82 +++++- doc/new_chapters/io.t | 427 +++++++++++++++++++++++++++ doc/new_chapters/memorymgmt.t | 251 ++++++++++++++++ doc/new_chapters/message.t | 207 +++++++++++++ doc/new_chapters/posix_users.texi | 40 ++- doc/new_chapters/procenv.t | 44 +++ doc/new_chapters/process.t | 22 ++ doc/new_chapters/semaphores.t | 229 +++++++++++++++ doc/new_chapters/systemdb.t | 207 +++++++++++++ 18 files changed, 3791 insertions(+), 15 deletions(-) create mode 100644 doc/new_chapters/adminiface.t create mode 100644 doc/new_chapters/cancel.t create mode 100644 doc/new_chapters/confspace.t create mode 100644 doc/new_chapters/cspecific.t create mode 100644 doc/new_chapters/device.t create mode 100644 doc/new_chapters/dumpcontrol.t create mode 100644 doc/new_chapters/eventlog.t create mode 100644 doc/new_chapters/files.t create mode 100644 doc/new_chapters/io.t create mode 100644 doc/new_chapters/memorymgmt.t create mode 100644 doc/new_chapters/message.t create mode 100644 doc/new_chapters/semaphores.t create mode 100644 doc/new_chapters/systemdb.t (limited to 'doc') diff --git a/doc/new_chapters/Makefile b/doc/new_chapters/Makefile index db38619f98..1af988db26 100644 --- a/doc/new_chapters/Makefile +++ b/doc/new_chapters/Makefile @@ -18,9 +18,12 @@ dirs: COMMON_FILES=../common/cpright.texi -GENERATED_FILES= process.texi procenv.texi files.texi clock.texi \ - cond.texi key.texi mutex.texi \ - sched.texi signal.texi thread.texi +GENERATED_FILES= \ + adminiface.texi base.texi cancel.texi clock.texi cond.texi confspace.texi \ + cspecific.texi device.texi dumpcontrol.texi eventlog.texi files.texi \ + io.texi key.texi memorymgmt.texi message.texi mutex.texi procenv.texi \ + process.texi sched.texi semaphores.texi signal.texi systemdb.texi \ + thread.texi FILES= posix_users.texi preface.texi \ $(COMMON_FILES) $(GENERATED_FILES) @@ -107,3 +110,63 @@ sched.texi: sched.t Makefile -u "Top" \ -n "" ${*}.t +io.texi: io.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +device.texi: device.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +cspecific.texi: cspecific.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +semaphores.texi: semaphores.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +memorymgmt.texi: memorymgmt.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +message.texi: message.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +cancel.texi: cancel.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +eventlog.texi: eventlog.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +dumpcontrol.texi: dumpcontrol.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +confspace.texi: confspace.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +adminiface.texi: adminiface.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + +systemdb.texi: systemdb.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + diff --git a/doc/new_chapters/adminiface.t b/doc/new_chapters/adminiface.t new file mode 100644 index 0000000000..e1600ece14 --- /dev/null +++ b/doc/new_chapters/adminiface.t @@ -0,0 +1,53 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Administration Interface Manager + +@section Introduction + +The +administration interface manager is ... + +The directives provided by the administration interface manager are: + +@itemize @bullet +@item @code{admin_shutdown} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the administration interface manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection admin_shutdown - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int admin_shutdown( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/cancel.t b/doc/new_chapters/cancel.t new file mode 100644 index 0000000000..be7397968e --- /dev/null +++ b/doc/new_chapters/cancel.t @@ -0,0 +1,141 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Thread Cancellation Manager + +@section Introduction + +The +thread cancellation manager is ... + +The directives provided by the thread cancellation manager are: + +@itemize @bullet +@item @code{pthread_cancel} - +@item @code{pthread_setcancelstate} - +@item @code{pthread_setcanceltype} - +@item @code{pthread_testcancel} - +@item @code{pthread_cleanup_push} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the thread cancellation manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection pthread_cancel - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int pthread_cancel( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection pthread_setcancelstate - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int pthread_setcancelstate( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection pthread_setcanceltype - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int pthread_setcanceltype( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection pthread_testcancel - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int pthread_testcancel( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection pthread_cleanup_push - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int pthread_cleanup_push( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/confspace.t b/doc/new_chapters/confspace.t new file mode 100644 index 0000000000..51261411f0 --- /dev/null +++ b/doc/new_chapters/confspace.t @@ -0,0 +1,295 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Configuration Space Manager + +@section Introduction + +The +configuration space manager is ... + +The directives provided by the configuration space manager are: + +@itemize @bullet +@item @code{cfg_mount} - +@item @code{cfg_unmount} - +@item @code{cfg_mknod} - +@item @code{cfg_get} - +@item @code{cfg_set} - +@item @code{cfg_link} - +@item @code{cfg_unlink} - +@item @code{cfg_open} - +@item @code{cfg_read} - +@item @code{cfg_children} - +@item @code{cfg_mark} - +@item @code{cfg_close} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the configuration space manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection cfg_mount - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_mount( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_unmount - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_unmount( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_mknod - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_mknod( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_get - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_get( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_set - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_set( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_link - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_link( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_unlink - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_unlink( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_open - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_open( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_read - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_read( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_children - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_children( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_mark - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_mark( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfg_close - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfg_close( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/cspecific.t b/doc/new_chapters/cspecific.t new file mode 100644 index 0000000000..20e2547882 --- /dev/null +++ b/doc/new_chapters/cspecific.t @@ -0,0 +1,493 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Language-Specific Services for the C Programming Language Manager + +@section Introduction + +The +language-specific services for the C programming language manager is ... + +The directives provided by the language-specific services for the C programming language manager are: + +@itemize @bullet +@item @code{setlocale} - +@item @code{fileno} - +@item @code{fdopen} - +@item @code{flcokfile} - +@item @code{ftrylockfile} - +@item @code{funlockfile} - +@item @code{getc_unlocked} - +@item @code{getchar_unlocked} - +@item @code{putc_unlocked} - +@item @code{putchar_unlocked} - +@item @code{setjmp} - +@item @code{longjmp} - +@item @code{sigsetjmp} - +@item @code{siglongjmp} - +@item @code{tzset} - +@item @code{strtok_r} - +@item @code{asctime_r} - +@item @code{ctime_r} - +@item @code{gmtime_r} - +@item @code{localtime_r} - +@item @code{rand_r} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the language-specific services for the C programming language manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection setlocale - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int setlocale( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection fileno - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int fileno( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection fdopen - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int fdopen( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection flcokfile - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int flcokfile( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection ftrylockfile - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int ftrylockfile( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection funlockfile - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int funlockfile( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection getc_unlocked - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getc_unlocked( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection getchar_unlocked - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getchar_unlocked( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection putc_unlocked - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int putc_unlocked( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection putchar_unlocked - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int putchar_unlocked( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection setjmp - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int setjmp( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection longjmp - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int longjmp( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection sigsetjmp - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int sigsetjmp( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection siglongjmp - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int siglongjmp( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection tzset - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int tzset( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection strtok_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int strtok_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection asctime_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int asctime_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection ctime_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int ctime_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection gmtime_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int gmtime_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection localtime_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int localtime_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection rand_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int rand_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/device.t b/doc/new_chapters/device.t new file mode 100644 index 0000000000..633b6fe99d --- /dev/null +++ b/doc/new_chapters/device.t @@ -0,0 +1,295 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Device- and Class- Specific Functions Manager + +@section Introduction + +The +device- and class- specific functions manager is ... + +The directives provided by the device- and class- specific functions manager are: + +@itemize @bullet +@item @code{cfgetispeed} - +@item @code{cfgetospeed} - +@item @code{cfsetispeed} - +@item @code{cfsetospeed} - +@item @code{tcgetattr} - +@item @code{tcsetattr} - +@item @code{tcsendbreak} - +@item @code{tcdrain} - +@item @code{tcflush} - +@item @code{tcflow} - +@item @code{tcgetpgrp} - +@item @code{tcsetpgrp} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the device- and class- specific functions manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection cfgetispeed - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfgetispeed( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfgetospeed - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfgetospeed( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfsetispeed - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfsetispeed( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection cfsetospeed - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int cfsetospeed( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection tcgetattr - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int tcgetattr( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection tcsetattr - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int tcsetattr( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection tcsendbreak - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int tcsendbreak( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection tcdrain - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int tcdrain( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection tcflush - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int tcflush( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection tcflow - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int tcflow( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection tcgetpgrp - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int tcgetpgrp( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection tcsetpgrp - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int tcsetpgrp( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/dumpcontrol.t b/doc/new_chapters/dumpcontrol.t new file mode 100644 index 0000000000..1b5012cae7 --- /dev/null +++ b/doc/new_chapters/dumpcontrol.t @@ -0,0 +1,53 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Process Dump Control Manager + +@section Introduction + +The +process dump control manager is ... + +The directives provided by the process dump control manager are: + +@itemize @bullet +@item @code{dump_setpath} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the process dump control manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection dump_setpath - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int dump_setpath( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/eventlog.t b/doc/new_chapters/eventlog.t new file mode 100644 index 0000000000..c28c16bfb5 --- /dev/null +++ b/doc/new_chapters/eventlog.t @@ -0,0 +1,295 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Event Logging Manager + +@section Introduction + +The +event logging manager is ... + +The directives provided by the event logging manager are: + +@itemize @bullet +@item @code{log_write} - +@item @code{log_open} - +@item @code{log_read} - +@item @code{log_notify} - +@item @code{log_close} - +@item @code{log_seek} - +@item @code{log_severity_before} - +@item @code{log_facilityemptyset} - +@item @code{log_facilityfillset} - +@item @code{log_facilityaddset} - +@item @code{log_facilitydelset} - +@item @code{log_facilityismember} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the event logging manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection log_write - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_write( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_open - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_open( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_read - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_read( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_notify - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_notify( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_close - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_close( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_seek - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_seek( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_severity_before - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_severity_before( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_facilityemptyset - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_facilityemptyset( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_facilityfillset - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_facilityfillset( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_facilityaddset - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_facilityaddset( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_facilitydelset - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_facilitydelset( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection log_facilityismember - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_facilityismember( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/files.t b/doc/new_chapters/files.t new file mode 100644 index 0000000000..c297c30364 --- /dev/null +++ b/doc/new_chapters/files.t @@ -0,0 +1,603 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Files and Directories Manager + +@section Introduction + +The +files and directories manager is ... + +The directives provided by the files and directories manager are: + +@itemize @bullet +@item @code{opendir} - +@item @code{readdir} - +@item @code{readdir_r} - +@item @code{rewinddir} - +@item @code{closedir} - +@item @code{chdir} - +@item @code{getcwd} - +@item @code{open} - +@item @code{creat} - +@item @code{umask} - +@item @code{link} - +@item @code{mkdir} - +@item @code{mkfifo} - +@item @code{unlink} - +@item @code{rmdir} - +@item @code{rename} - +@item @code{stat} - +@item @code{fstat} - +@item @code{access} - +@item @code{chmod} - +@item @code{fchmod} - +@item @code{chown} - +@item @code{utime} - +@item @code{ftrunctate} - +@item @code{pathconf} - +@item @code{fpathconf} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the files and directories manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection opendir - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int opendir( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection readdir - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int readdir( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection readdir_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int readdir_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection rewinddir - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int rewinddir( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection closedir - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int closedir( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection chdir - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int chdir( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection getcwd - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getcwd( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection open - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int open( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection creat - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int creat( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection umask - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int umask( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection link - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int link( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mkdir - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mkdir( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mkfifo - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mkfifo( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection unlink - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int unlink( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection rmdir - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int rmdir( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection rename - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int rename( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection stat - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int stat( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection fstat - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int fstat( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection access - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int access( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection chmod - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int chmod( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection fchmod - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int fchmod( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection chown - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int chown( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection utime - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int utime( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection ftrunctate - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int ftrunctate( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection pathconf - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int pathconf( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection fpathconf - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int fpathconf( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/gen_section b/doc/new_chapters/gen_section index c8836c7bfc..b71770d187 100644 --- a/doc/new_chapters/gen_section +++ b/doc/new_chapters/gen_section @@ -4,20 +4,20 @@ # Set this based on which chapter you want to generate a template for. -chapter="files" +chapter=$1 case ${chapter} in process) CHAPTER_CAPS="Process Creation and Execution" CHAPTER_LOWER="process creation and execution" - ROUTINES="execl execv execle execve execlp execvp pthread_atfork \ + ROUTINES="fork execl execv execle execve execlp execvp pthread_atfork \ wait waitpid _exit" ;; procenv) CHAPTER_CAPS="Process Environment" CHAPTER_LOWER="process environment" - ROUTINES="getpid getppid getgid getegid setuid setgid getgroups \ - getlogin getlogin_r getpgrp setsid setpgid uname times \ + ROUTINES="getpid getppid getuid geteuid getgid getegid setuid setgid \ + getgroups getlogin getlogin_r getpgrp setsid setpgid uname times \ getenv ctermid ttyname ttyname_r isatty sysconf " ;; files) @@ -28,6 +28,80 @@ case ${chapter} in rmdir rename stat fstat access chmod fchmod chown \ utime ftrunctate pathconf fpathconf" ;; + io) + CHAPTER_CAPS="Input and Output Primitives" + CHAPTER_LOWER="input and output primitives" + ROUTINES="pipe dup dup2 close read write fcntl lseek fsynch fdatasynch \ + aio_read aio_write lio_listio aio_error aio_return aio_cancel \ + aio_suspend aio_fsync" + ;; + device) + CHAPTER_CAPS="Device- and Class- Specific Functions" + CHAPTER_LOWER="device- and class- specific functions" + ROUTINES="cfgetispeed cfgetospeed cfsetispeed cfsetospeed tcgetattr \ + tcsetattr tcsendbreak tcdrain tcflush tcflow tcgetpgrp tcsetpgrp" + ;; + cspecific) + CHAPTER_CAPS="Language-Specific Services for the C Programming Language" + CHAPTER_LOWER="language-specific services for the C programming language" + ROUTINES="setlocale fileno fdopen flcokfile ftrylockfile funlockfile \ + getc_unlocked getchar_unlocked putc_unlocked putchar_unlocked \ + setjmp longjmp sigsetjmp siglongjmp tzset strtok_r asctime_r \ + ctime_r gmtime_r localtime_r rand_r" + ;; + systemdb) + CHAPTER_CAPS="System Databases" + CHAPTER_LOWER="system databases" + ROUTINES="getgrgid getgrgid_r getgrnam getgrnam_r getpwuid getpwuid_r \ + getpwnam getpwnam_r" + ;; + semaphores) + CHAPTER_CAPS="Semaphores" + CHAPTER_LOWER="semaphore" + ROUTINES="sem_init sem_destroy sem_open sem_close sem_unlink sem_wait \ + sem_trywait sem_post sem_getvalue" + ;; + memorymgmt) + CHAPTER_CAPS="Memory Management" + CHAPTER_LOWER="memory management" + ROUTINES="mlockall munlockall mlock munlock mmap munmap mprotect \ + msync shm_open shm_unlink" + ;; + message) + CHAPTER_CAPS="Message Passing" + CHAPTER_LOWER="message passing" + ROUTINES="mq_open mq_close mq_unlink mq_send mq_receive mq_notify \ + mq_setattr mq_getattr" + ;; + cancel) + CHAPTER_CAPS="Thread Cancellation" + CHAPTER_LOWER="thread cancellation" + ROUTINES="pthread_cancel pthread_setcancelstate pthread_setcanceltype \ + pthread_testcancel pthread_cleanup_push" + ;; + eventlog) + CHAPTER_CAPS="Event Logging" + CHAPTER_LOWER="event logging" + ROUTINES="log_write log_open log_read log_notify log_close log_seek \ + log_severity_before log_facilityemptyset log_facilityfillset \ + log_facilityaddset log_facilitydelset log_facilityismember" + ;; + dumpcontrol) + CHAPTER_CAPS="Process Dump Control" + CHAPTER_LOWER="process dump control" + ROUTINES="dump_setpath" + ;; + confspace) + CHAPTER_CAPS="Configuration Space" + CHAPTER_LOWER="configuration space" + ROUTINES="cfg_mount cfg_unmount cfg_mknod cfg_get cfg_set cfg_link \ + cfg_unlink cfg_open cfg_read cfg_children cfg_mark cfg_close" + ;; + adminiface) + CHAPTER_CAPS="Administration Interface" + CHAPTER_LOWER="administration interface" + ROUTINES="admin_shutdown" + ;; *) echo "Unknown chapter name" exit 1 diff --git a/doc/new_chapters/io.t b/doc/new_chapters/io.t new file mode 100644 index 0000000000..463760f849 --- /dev/null +++ b/doc/new_chapters/io.t @@ -0,0 +1,427 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Input and Output Primitives Manager + +@section Introduction + +The +input and output primitives manager is ... + +The directives provided by the input and output primitives manager are: + +@itemize @bullet +@item @code{pipe} - +@item @code{dup} - +@item @code{dup2} - +@item @code{close} - +@item @code{read} - +@item @code{write} - +@item @code{fcntl} - +@item @code{lseek} - +@item @code{fsynch} - +@item @code{fdatasynch} - +@item @code{aio_read} - +@item @code{aio_write} - +@item @code{lio_listio} - +@item @code{aio_error} - +@item @code{aio_return} - +@item @code{aio_cancel} - +@item @code{aio_suspend} - +@item @code{aio_fsync} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the input and output primitives manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection pipe - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int pipe( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection dup - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int dup( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection dup2 - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int dup2( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection close - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int close( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection read - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int read( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection write - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int write( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection fcntl - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int fcntl( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection lseek - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int lseek( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection fsynch - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int fsynch( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection fdatasynch - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int fdatasynch( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection aio_read - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int aio_read( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection aio_write - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int aio_write( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection lio_listio - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int lio_listio( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection aio_error - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int aio_error( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection aio_return - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int aio_return( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection aio_cancel - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int aio_cancel( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection aio_suspend - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int aio_suspend( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection aio_fsync - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int aio_fsync( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/memorymgmt.t b/doc/new_chapters/memorymgmt.t new file mode 100644 index 0000000000..c4966552bb --- /dev/null +++ b/doc/new_chapters/memorymgmt.t @@ -0,0 +1,251 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Memory Management Manager + +@section Introduction + +The +memory management manager is ... + +The directives provided by the memory management manager are: + +@itemize @bullet +@item @code{mlockall} - +@item @code{munlockall} - +@item @code{mlock} - +@item @code{munlock} - +@item @code{mmap} - +@item @code{munmap} - +@item @code{mprotect} - +@item @code{msync} - +@item @code{shm_open} - +@item @code{shm_unlink} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the memory management manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection mlockall - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mlockall( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection munlockall - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int munlockall( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mlock - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mlock( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection munlock - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int munlock( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mmap - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mmap( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection munmap - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int munmap( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mprotect - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mprotect( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection msync - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int msync( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection shm_open - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int shm_open( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection shm_unlink - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int shm_unlink( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/message.t b/doc/new_chapters/message.t new file mode 100644 index 0000000000..2aef8397ad --- /dev/null +++ b/doc/new_chapters/message.t @@ -0,0 +1,207 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Message Passing Manager + +@section Introduction + +The +message passing manager is ... + +The directives provided by the message passing manager are: + +@itemize @bullet +@item @code{mq_open} - +@item @code{mq_close} - +@item @code{mq_unlink} - +@item @code{mq_send} - +@item @code{mq_receive} - +@item @code{mq_notify} - +@item @code{mq_setattr} - +@item @code{mq_getattr} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the message passing manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection mq_open - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mq_open( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mq_close - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mq_close( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mq_unlink - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mq_unlink( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mq_send - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mq_send( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mq_receive - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mq_receive( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mq_notify - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mq_notify( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mq_setattr - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mq_setattr( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection mq_getattr - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int mq_getattr( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/posix_users.texi b/doc/new_chapters/posix_users.texi index 615949abfe..3fe66ed75c 100644 --- a/doc/new_chapters/posix_users.texi +++ b/doc/new_chapters/posix_users.texi @@ -86,15 +86,27 @@ END-INFO-DIR-ENTRY @include preface.texi @include process.texi +@include signal.texi @include procenv.texi @include files.texi -@include thread.texi -@include signal.texi +@include io.texi +@include device.texi +@include cspecific.texi +@include systemdb.texi +@include semaphores.texi @include mutex.texi @include cond.texi -@include key.texi -@include clock.texi +@include memorymgmt.texi @include sched.texi +@include clock.texi +@include message.texi +@include thread.texi +@include key.texi +@include cancel.texi +@include eventlog.texi +@include dumpcontrol.texi +@include confspace.texi +@include adminiface.texi @ifinfo @node Top, Preface, (dir), (dir) @top posix_users_new @@ -104,15 +116,27 @@ This is the online version of the RTEMS POSIX API User's Guide @menu * Preface:: * Process Creation and Execution Manager:: +* Signal Manager:: * Process Environment Manager:: * Files and Directories Manager:: -* Thread Manager:: -* Signal Manager:: +* Input and Output Primitives Manager:: +* Device- and Class- Specific Functions Manager:: +* Language-Specific Services for the C Programming Language Manager:: +* System Databases Manager:: +* Semaphores Manager:: * Mutex Manager:: * Condition Variable Manager:: -* Key Manager:: -* Clock Manager:: +* Memory Management Manager:: * Scheduler Manager:: +* Clock Manager:: +* Message Passing Manager:: +* Thread Manager:: +* Key Manager:: +* Thread Cancellation Manager:: +* Event Logging Manager:: +* Process Dump Control Manager:: +* Configuration Space Manager:: +* Administration Interface Manager:: * Command and Variable Index:: * Concept Index:: @end menu diff --git a/doc/new_chapters/procenv.t b/doc/new_chapters/procenv.t index 2ae48f8de2..4d3adbbd2b 100644 --- a/doc/new_chapters/procenv.t +++ b/doc/new_chapters/procenv.t @@ -18,6 +18,8 @@ The directives provided by the process environment manager are: @itemize @bullet @item @code{getpid} - @item @code{getppid} - +@item @code{getuid} - +@item @code{geteuid} - @item @code{getgid} - @item @code{getegid} - @item @code{setuid} - @@ -91,6 +93,48 @@ int getppid( @subheading NOTES: +@page +@subsection getuid - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getuid( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection geteuid - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int geteuid( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + @page @subsection getgid - XXX diff --git a/doc/new_chapters/process.t b/doc/new_chapters/process.t index ef148ae613..39c2a4c09a 100644 --- a/doc/new_chapters/process.t +++ b/doc/new_chapters/process.t @@ -16,6 +16,7 @@ process creation and execution manager is ... The directives provided by the process creation and execution manager are: @itemize @bullet +@item @code{fork} - @item @code{execl} - @item @code{execv} - @item @code{execle} - @@ -39,6 +40,27 @@ A subsection is dedicated to each of this manager's directives and describes the calling sequence, related constants, usage, and status codes. +@page +@subsection fork - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int fork( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + @page @subsection execl - XXX diff --git a/doc/new_chapters/semaphores.t b/doc/new_chapters/semaphores.t new file mode 100644 index 0000000000..a383bde355 --- /dev/null +++ b/doc/new_chapters/semaphores.t @@ -0,0 +1,229 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Semaphores Manager + +@section Introduction + +The +semaphore manager is ... + +The directives provided by the semaphore manager are: + +@itemize @bullet +@item @code{sem_init} - +@item @code{sem_destroy} - +@item @code{sem_open} - +@item @code{sem_close} - +@item @code{sem_unlink} - +@item @code{sem_wait} - +@item @code{sem_trywait} - +@item @code{sem_post} - +@item @code{sem_getvalue} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the semaphore manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection sem_init - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int sem_init( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection sem_destroy - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int sem_destroy( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection sem_open - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int sem_open( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection sem_close - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int sem_close( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection sem_unlink - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int sem_unlink( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection sem_wait - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int sem_wait( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection sem_trywait - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int sem_trywait( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection sem_post - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int sem_post( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection sem_getvalue - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int sem_getvalue( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + diff --git a/doc/new_chapters/systemdb.t b/doc/new_chapters/systemdb.t new file mode 100644 index 0000000000..7277473749 --- /dev/null +++ b/doc/new_chapters/systemdb.t @@ -0,0 +1,207 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter System Databases Manager + +@section Introduction + +The +system databases manager is ... + +The directives provided by the system databases manager are: + +@itemize @bullet +@item @code{getgrgid} - +@item @code{getgrgid_r} - +@item @code{getgrnam} - +@item @code{getgrnam_r} - +@item @code{getpwuid} - +@item @code{getpwuid_r} - +@item @code{getpwnam} - +@item @code{getpwnam_r} - +@end itemize + +@section Background + +@section Operations + +@section Directives + +This section details the system databases manager's directives. +A subsection is dedicated to each of this manager's directives +and describes the calling sequence, related constants, usage, +and status codes. + +@page +@subsection getgrgid - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getgrgid( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection getgrgid_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getgrgid_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection getgrnam - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getgrnam( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection getgrnam_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getgrnam_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection getpwuid - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getpwuid( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection getpwuid_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getpwuid_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection getpwnam - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getpwnam( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + +@page +@subsection getpwnam_r - XXX + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int getpwnam_r( +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@subheading DESCRIPTION: + +@subheading NOTES: + -- cgit v1.2.3