Major update/merge of POSIX manual.

doc/posix_users/base.texi

@@ -1,98 +0,0 @@
-@c
-@c  COPYRIGHT (c) 1988-1998.
-@c  On-Line Applications Research Corporation (OAR).
-@c  All rights reserved.
-@c
-@c  $Id$
-@c
-
-@ifinfo
-@node Mutex Manager, Mutex Manager Introduction, Preface, Top
-@end ifinfo
-@chapter Mutex Manager
-@ifinfo
-@menu
-* Mutex Manager Introduction::
-* Mutex Manager Background::
-* Mutex Manager Operations::
-* Mutex Manager Directives::
-@end menu
-@end ifinfo
-
-@ifinfo
-@node Mutex Manager Introduction, Mutex Manager Background, Mutex Manager, Mutex Manager
-@end ifinfo
-@section Introduction
-
-The mutex manager ...
-
-The directives provided by the mutex manager are:
-
-@itemize @bullet
-@item @code{sigaddset} - 
-@item @code{sigdelset} - 
-@item @code{sigfillset} - 
-@item @code{sigismember} - 
-@item @code{sigemptyset} - 
-@item @code{sigaction} - 
-@item @code{pthread_kill} - 
-@item @code{pthread_sigmask} - 
-@item @code{kill} - 
-@item @code{sigwait} - 
-@end itemize
-
-@ifinfo
-@node Mutex Manager Background, Mutex Manager Operations, Mutex Manager Introduction, Mutex Manager
-@end ifinfo
-@section Background
-
-@ifinfo
-@node Mutex Manager Operations, Mutex Manager Directives, Mutex Manager Background, Mutex Manager
-@end ifinfo
-@section Operations
-
-@ifinfo
-@node Mutex Manager Directives, sigaddset, Mutex Manager Operations, Mutex Manager
-@end ifinfo
-@section Directives
-@ifinfo
-@menu
-* sigaddset::
-* sigdelset::
-* sigfillset::
-* sigismember::
-* sigemptyset::
-* sigaction::
-* pthread_kill::
-* pthread_sigmask::
-* kill::
-* sigwait::
-@end menu
-@end ifinfo
-
-This section details the mutex 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
-@ifinfo
-@node sigaddset, sigdelset, Mutex Manager Directives, Mutex Manager Directives
-@end ifinfo
-@subsection sigaddset
-
-@subheading CALLING SEQUENCE:
-
-@example
-int sigaddset(
-  sigset_t   *set,
-  int         signo
-);
-@end example
-
-@subheading STATUS CODES:
-
-@subheading DESCRIPTION:
-
-@subheading NOTES:
-

doc/posix_users/clock.t

@@ -6,22 +6,8 @@
 @c  $Id$
 @c
 
-@ifinfo
-@node Clock Manager, Clock Manager Introduction, pthread_getspecific, Top
-@end ifinfo
 @chapter Clock Manager
-@ifinfo
-@menu
-* Clock Manager Introduction::
-* Clock Manager Background::
-* Clock Manager Operations::
-* Clock Manager Directives::
-@end menu
-@end ifinfo
 
-@ifinfo
-@node Clock Manager Introduction, Clock Manager Background, Clock Manager, Clock Manager
-@end ifinfo
 @section Introduction
 
 The clock manager ...
@@ -32,45 +18,28 @@ The directives provided by the clock manager are:
 @item @code{clock_gettime} - 
 @item @code{clock_settime} -
 @item @code{clock_getres} -
+@item @code{sleep} - Delay Process Execution
 @item @code{nanosleep} -
-@item @code{time} -
+@item @code{gettimeofday} - Get the Time of Day
+@item @code{time} - Get time in seconds
 @end itemize
 
-@ifinfo
-@node Clock Manager Background, Clock Manager Operations, Clock Manager Introduction, Clock Manager
-@end ifinfo
 @section Background
 
-@ifinfo
-@node Clock Manager Operations, Clock Manager Directives, Clock Manager Background, Clock Manager
-@end ifinfo
+There is currently no text in this section.
+
 @section Operations
 
-@ifinfo
-@node Clock Manager Directives, clock_gettime, Clock Manager Operations, Clock Manager
-@end ifinfo
+There is currently no text in this section.
+
 @section Directives
-@ifinfo
-@menu
-* clock_gettime::
-* clock_settime::
-* clock_getres::
-* sleep::
-* nanosleep::
-* time::
-@end menu
-@end ifinfo
 
 This section details the clock 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
-@ifinfo
-@node clock_gettime, clock_settime, Clock Manager Directives, Clock Manager Directives
-@end ifinfo
-@subsection clock_gettime
+@subsection clock_gettime -
 
 @subheading CALLING SEQUENCE:
 
@@ -99,11 +68,10 @@ The clock_id specified is invalid.
 
 @subheading NOTES:
 
+NONE
+
 @page
-@ifinfo
-@node clock_settime, clock_getres, clock_gettime, Clock Manager Directives
-@end ifinfo
-@subsection clock_settime
+@subsection clock_settime -
  
 @subheading CALLING SEQUENCE:
  
@@ -135,12 +103,11 @@ The contents of the tp structure are invalid.
 @subheading DESCRIPTION:
  
 @subheading NOTES:
+
+NONE
  
 @page
-@ifinfo
-@node clock_getres, sleep, clock_settime, Clock Manager Directives
-@end ifinfo
-@subsection clock_getres
+@subsection clock_getres -
  
 @subheading CALLING SEQUENCE:
  
@@ -173,10 +140,7 @@ The clock_id specified is invalid.
 If res is NULL, then the resolution is not returned.
 
 @page
-@ifinfo
-@node sleep, nanosleep, clock_getres, Clock Manager Directives
-@end ifinfo
-@subsection sleep
+@subsection sleep - Delay Process Execution
  
 @subheading CALLING SEQUENCE:
  
@@ -194,15 +158,15 @@ This routine returns the number of unslept seconds.
 
 @subheading DESCRIPTION:
  
+The @code{sleep()} function delays the calling thread by the specified
+number of @code{seconds}.
+
 @subheading NOTES:
 
 This call is interruptible by a signal.
  
 @page
-@ifinfo
-@node nanosleep, time, sleep, Clock Manager Directives
-@end ifinfo
-@subsection nanosleep
+@subsection nanosleep -
  
 @subheading CALLING SEQUENCE:
  
@@ -239,10 +203,48 @@ field.
 This call is interruptible by a signal.
 
 @page
-@ifinfo
-@node time, Scheduler Manager, nanosleep, Clock Manager Directives
-@end ifinfo
-@subsection nanosleep
+@subsection gettimeofday - Get the Time of Day
+
+@subheading CALLING SEQUENCE:
+
+@example
+#include <sys/time.h>
+#include <unistd.h>
+
+int gettimeofday(
+  struct timeval  *tp,
+  struct timezone *tzp
+);
+@end example
+
+@subheading STATUS CODES:
+
+On error, this routine returns -1 and sets @code{errno} as appropriate.
+
+@table @b
+@item EPERM
+@code{settimeofdat} is called by someone other than the superuser.
+
+@item EINVAL
+Timezone (or something else) is invalid.
+
+@item EFAULT
+One of @code{tv} or @code{tz} pointed outside your accessible address 
+space
+
+@end table
+
+@subheading DESCRIPTION:
+
+This routine returns the current time of day in the @code{tp} structure.
+
+@subheading NOTES:
+
+Currently, the timezone information is not supported.  The @code{tzp}
+argument is ignored.
+
+@page
+@subsection time - Get time in seconds
  
 @subheading CALLING SEQUENCE:
  
@@ -259,6 +261,14 @@ int time(
 This routine returns the number of seconds since the Epoch.
 
 @subheading DESCRIPTION:
+
+@code{time} returns the time since 00:00:00 GMT, January 1, 1970, 
+measured in seconds
+
+If @code{tloc} in non null, the return value is also stored in the 
+memory pointed to by @code{t}.
  
 @subheading NOTES:
+
+NONE
  

doc/posix_users/cond.t

@@ -6,22 +6,8 @@
 @c  $Id$
 @c
 
-@ifinfo
-@node Condition Variable Manager, Condition Variable Manager Introduction, pthread_mutex_getprioceiling, Top
-@end ifinfo
 @chapter Condition Variable Manager
-@ifinfo
-@menu
-* Condition Variable Manager Introduction::
-* Condition Variable Manager Background::
-* Condition Variable Manager Operations::
-* Condition Variable Manager Directives::
-@end menu
-@end ifinfo
 
-@ifinfo
-@node Condition Variable Manager Introduction, Condition Variable Manager Background, Condition Variable Manager, Condition Variable Manager
-@end ifinfo
 @section Introduction
 
 The condition variable manager ...
@@ -41,34 +27,15 @@ The directives provided by the condition variable manager are:
 @item @code{pthread_cond_timedwait} - 
 @end itemize
 
-@ifinfo
-@node Condition Variable Manager Background, Condition Variable Manager Operations, Condition Variable Manager Introduction, Condition Variable Manager
-@end ifinfo
 @section Background
 
-@ifinfo
-@node Condition Variable Manager Operations, Condition Variable Manager Directives, Condition Variable Manager Background, Condition Variable Manager
-@end ifinfo
+There is currently no text in this section.
+
 @section Operations
 
-@ifinfo
-@node Condition Variable Manager Directives, pthread_condattr_init, Condition Variable Manager Operations, Condition Variable Manager
-@end ifinfo
+There is currently no text in this section.
+
 @section Directives
-@ifinfo
-@menu
-* pthread_condattr_init::
-* pthread_condattr_destroy::
-* pthread_condattr_setpshared::
-* pthread_condattr_getpshared::
-* pthread_cond_init::
-* pthread_cond_destroy::
-* pthread_cond_signal::
-* pthread_cond_broadcast::
-* pthread_cond_wait::
-* pthread_cond_timedwait::
-@end menu
-@end ifinfo
 
 This section details the condition variable manager's directives.
 A subsection is dedicated to each of this manager's directives
@@ -76,9 +43,6 @@ and describes the calling sequence, related constants, usage,
 and status codes.
 
 @page
-@ifinfo
-@node pthread_condattr_init, pthread_condattr_destroy, Condition Variable Manager Directives, Condition Variable Manager Directives
-@end ifinfo
 @subsection pthread_condattr_init
 
 @subheading CALLING SEQUENCE:
@@ -104,9 +68,6 @@ attributes object.
 @subheading NOTES:
 
 @page
-@ifinfo
-@node pthread_condattr_destroy, pthread_condattr_setpshared, pthread_condattr_init, Condition Variable Manager Directives
-@end ifinfo
 @subsection pthread_condattr_destroy
 
 @subheading CALLING SEQUENCE:
@@ -131,9 +92,6 @@ The attribute object specified is invalid.
 @subheading NOTES:
 
 @page
-@ifinfo
-@node pthread_condattr_setpshared, pthread_condattr_getpshared, pthread_condattr_destroy, Condition Variable Manager Directives
-@end ifinfo
 @subsection pthread_condattr_setpshared
 
 @subheading CALLING SEQUENCE:
@@ -160,9 +118,6 @@ Invalid argument passed.
 @subheading NOTES:
 
 @page
-@ifinfo
-@node pthread_condattr_getpshared, pthread_cond_init, pthread_condattr_setpshared, Condition Variable Manager Directives
-@end ifinfo
 @subsection pthread_condattr_getpshared
 
 @subheading CALLING SEQUENCE:
@@ -190,9 +145,6 @@ Invalid argument passed.
 
 
 @page
-@ifinfo
-@node pthread_cond_init, pthread_cond_destroy, pthread_condattr_getpshared, Condition Variable Manager Directives
-@end ifinfo
 @subsection pthread_cond_init
 
 @subheading CALLING SEQUENCE:
@@ -228,9 +180,6 @@ The specified attribute value is invalid.
 @subheading NOTES:
 
 @page
-@ifinfo
-@node pthread_cond_destroy, pthread_cond_signal, pthread_cond_init, Condition Variable Manager Directives
-@end ifinfo
 @subsection pthread_cond_destroy
 
 @subheading CALLING SEQUENCE:
@@ -258,9 +207,6 @@ The specified condition variable is currently in use.
 @subheading NOTES:
 
 @page
-@ifinfo
-@node pthread_cond_signal, pthread_cond_broadcast, pthread_cond_destroy, Condition Variable Manager Directives
-@end ifinfo
 @subsection pthread_cond_signal
 
 @subheading CALLING SEQUENCE:
@@ -288,9 +234,6 @@ This routine should not be invoked from a handler from an asynchronous signal
 handler or an interrupt service routine.
 
 @page
-@ifinfo
-@node pthread_cond_broadcast, pthread_cond_wait, pthread_cond_signal, Condition Variable Manager Directives
-@end ifinfo
 @subsection pthread_cond_broadcast
 
 @subheading CALLING SEQUENCE:
@@ -318,9 +261,6 @@ This routine should not be invoked from a handler from an asynchronous signal
 handler or an interrupt service routine.
 
 @page
-@ifinfo
-@node pthread_cond_wait, pthread_cond_timedwait, pthread_cond_broadcast, Condition Variable Manager Directives
-@end ifinfo
 @subsection pthread_cond_wait
 
 @subheading CALLING SEQUENCE:
@@ -349,9 +289,6 @@ the mutex was not owned by the current thread at the time of the call.
 @subheading NOTES:
 
 @page
-@ifinfo
-@node pthread_cond_timedwait, Key Manager, pthread_cond_wait, Condition Variable Manager Directives
-@end ifinfo
 @subsection pthread_cond_timedwait
 
 @subheading CALLING SEQUENCE:

doc/posix_users/key.t

@@ -6,22 +6,8 @@
 @c  $Id$
 @c
 
-@ifinfo
-@node Key Manager, Key Manager Introduction, pthread_cond_timedwait, Top
-@end ifinfo
 @chapter Key Manager
-@ifinfo
-@menu
-* Key Manager Introduction::
-* Key Manager Background::
-* Key Manager Operations::
-* Key Manager Directives::
-@end menu
-@end ifinfo
 
-@ifinfo
-@node Key Manager Introduction, Key Manager Background, Key Manager, Key Manager
-@end ifinfo
 @section Introduction
 
 The key manager ...
@@ -35,28 +21,15 @@ The directives provided by the key manager are:
 @item @code{pthread_getspecific} -
 @end itemize
 
-@ifinfo
-@node Key Manager Background, Key Manager Operations, Key Manager Introduction, Key Manager
-@end ifinfo
 @section Background
 
-@ifinfo
-@node Key Manager Operations, Key Manager Directives, Key Manager Background, Key Manager
-@end ifinfo
+There is currently no text in this section.
+
 @section Operations
 
-@ifinfo
-@node Key Manager Directives, pthread_key_create, Key Manager Operations, Key Manager
-@end ifinfo
+There is currently no text in this section.
+
 @section Directives
-@ifinfo
-@menu
-* pthread_key_create::
-* pthread_key_delete::
-* pthread_setspecific::
-* pthread_getspecific::
-@end menu
-@end ifinfo
 
 This section details the key manager's directives.
 A subsection is dedicated to each of this manager's directives
@@ -64,9 +37,6 @@ and describes the calling sequence, related constants, usage,
 and status codes.
 
 @page
-@ifinfo
-@node pthread_key_create, pthread_key_delete, Key Manager Directives, Key Manager Directives
-@end ifinfo
 @subsection pthread_key_create
 
 @subheading CALLING SEQUENCE:
@@ -92,9 +62,6 @@ Insufficient memory exists to create the key.
 @end table
 
 @page
-@ifinfo
-@node pthread_key_delete, pthread_setspecific, pthread_key_create, Key Manager Directives
-@end ifinfo
 @subsection pthread_key_delete
  
 @subheading CALLING SEQUENCE:
@@ -120,9 +87,6 @@ The key was invalid
 @subheading NOTES:
 
 @page
-@ifinfo
-@node pthread_setspecific, pthread_getspecific, pthread_key_delete, Key Manager Directives
-@end ifinfo
 @subsection pthread_setspecific
 
 @subheading CALLING SEQUENCE:
@@ -148,9 +112,6 @@ The specified key is invalid.
 @subheading NOTES:
 
 @page
-@ifinfo
-@node pthread_getspecific, Clock Manager, pthread_setspecific, Key Manager Directives
-@end ifinfo
 @subsection pthread_getspecific
 
 @subheading CALLING SEQUENCE:

doc/posix_users/preface.texi

@@ -1,24 +0,0 @@
-@c
-@c  COPYRIGHT (c) 1988-1998.
-@c  On-Line Applications Research Corporation (OAR).
-@c  All rights reserved.
-@c
-@c  $Id$
-@c
-
-@ifinfo
-@node Preface, Thread Manager, Top, Top
-@end ifinfo
-@unnumbered Preface
-
-This is the user's guide for the POSIX API support for RTEMS.
-
-We intend for this manual to only be a listing of the API.  Please
-refer to the ISO/IEC 9945-1 @i{Information Technology -
-Portable Operating System Interface (POSIX) - Part 1: System
-Application Program Interface (API) [C Language]} for the specific
-functionality and behavior of the services.
-
-In addition, much of the POSIX API standard is actually implemented
-in the newlib ANSI C Library.  Please refer to documentation on
-newlib for more information on what it supplies.

doc/posix_users/sched.t

@@ -6,22 +6,8 @@
 @c  $Id$
 @c
 
-@ifinfo
-@node Scheduler Manager, Scheduler Manager Introduction, time, Top
-@end ifinfo
 @chapter Scheduler Manager
-@ifinfo
-@menu
-* Scheduler Manager Introduction::
-* Scheduler Manager Background::
-* Scheduler Manager Operations::
-* Scheduler Manager Directives::
-@end menu
-@end ifinfo
 
-@ifinfo
-@node Scheduler Manager Introduction, Scheduler Manager Background, Scheduler Manager, Scheduler Manager
-@end ifinfo
 @section Introduction
 
 The scheduler manager ...
@@ -35,20 +21,8 @@ The directives provided by the scheduler manager are:
 @item @code{sched_yield} - 
 @end itemize
 
-@ifinfo
-@node Scheduler Manager Background, Priority, Scheduler Manager Introduction, Scheduler Manager
-@end ifinfo
 @section Background
-@ifinfo
-@menu
-* Priority::
-* Scheduling Policies::
-@end menu
-@end ifinfo
 
-@ifinfo
-@node Priority, Scheduling Policies, Scheduler Manager Background, Scheduler Manager Background
-@end ifinfo
 @subsection Priority
 
 In the RTEMS implementation of the POSIX API, the priorities range from
@@ -56,9 +30,6 @@ the low priority of sched_get_priority_min() to the highest priority of
 sched_get_priority_max().  Numerically higher values represent higher
 priorities.
 
-@ifinfo
-@node Scheduling Policies, Scheduler Manager Operations, Priority, Scheduler Manager Background
-@end ifinfo
 @subsection Scheduling Policies
 
 The following scheduling policies are available:
@@ -87,23 +58,11 @@ the thread resumes its initial priority and has its budget replenished.
 
 @end table
 
-@ifinfo
-@node Scheduler Manager Operations, Scheduler Manager Directives, Scheduling Policies, Scheduler Manager
-@end ifinfo
 @section Operations
 
-@ifinfo
-@node Scheduler Manager Directives, sched_get_priority_min, Scheduler Manager Operations, Scheduler Manager
-@end ifinfo
+There is currently no text in this section.
+
 @section Directives
-@ifinfo
-@menu
-* sched_get_priority_min::
-* sched_get_priority_max::
-* sched_rr_get_interval::
-* sched_yield::
-@end menu
-@end ifinfo
 
 This section details the scheduler manager's directives.
 A subsection is dedicated to each of this manager's directives
@@ -111,9 +70,6 @@ and describes the calling sequence, related constants, usage,
 and status codes.
 
 @page
-@ifinfo
-@node sched_get_priority_min, sched_get_priority_max, Scheduler Manager Directives, Scheduler Manager Directives
-@end ifinfo
 @subsection sched_get_priority_min
 
 @subheading CALLING SEQUENCE:
@@ -141,9 +97,6 @@ The indicated policy is invalid.
 @subheading NOTES:
 
 @page
-@ifinfo
-@node sched_get_priority_max, sched_rr_get_interval, sched_get_priority_min, Scheduler Manager Directives
-@end ifinfo
 @subsection sched_get_priority_max
 
 @subheading CALLING SEQUENCE:
@@ -171,9 +124,6 @@ The indicated policy is invalid.
 @subheading NOTES:
 
 @page
-@ifinfo
-@node sched_rr_get_interval, sched_yield, sched_get_priority_max, Scheduler Manager Directives
-@end ifinfo
 @subsection sched_rr_get_interval
 
 @subheading CALLING SEQUENCE:
@@ -205,9 +155,6 @@ The specified interval pointer parameter is invalid.
 @subheading NOTES:
 
 @page
-@ifinfo
-@node sched_yield, Command and Variable Index, sched_rr_get_interval, Scheduler Manager Directives
-@end ifinfo
 @subsection sched_yield
 
 @subheading CALLING SEQUENCE: