summaryrefslogtreecommitdiffstats
path: root/doc/posix_users
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1999-10-11 20:45:18 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1999-10-11 20:45:18 +0000
commita7a33cc38e012d2002a18222051e1a6daec17b23 (patch)
tree80b5dd99427d5144b9b26bd96e855a17ec6f91c3 /doc/posix_users
parentAdded descriptions. (diff)
downloadrtems-a7a33cc38e012d2002a18222051e1a6daec17b23.tar.bz2
Added descriptions of routines to section headings.
Diffstat (limited to 'doc/posix_users')
-rw-r--r--doc/posix_users/cspecific.t84
-rw-r--r--doc/posix_users/io.t36
-rw-r--r--doc/posix_users/memorymgmt.t40
3 files changed, 80 insertions, 80 deletions
diff --git a/doc/posix_users/cspecific.t b/doc/posix_users/cspecific.t
index 5e2de31617..9a83493a35 100644
--- a/doc/posix_users/cspecific.t
+++ b/doc/posix_users/cspecific.t
@@ -16,27 +16,27 @@ 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} -
+@item @code{setlocale} - Set the Current Locale
+@item @code{fileno} - Obtain File Descriptor Number for this File
+@item @code{fdopen} - Associate Stream with File Descriptor
+@item @code{flockfile} - Acquire Ownership of File Stream
+@item @code{ftrylockfile} - Poll to Acquire Ownership of File Stream
+@item @code{funlockfile} - Release Ownership of File Stream
+@item @code{getc_unlocked} - Get Character without Locking
+@item @code{getchar_unlocked} - Get Character from stdin without Locking
+@item @code{putc_unlocked} - Put Character without Locking
+@item @code{putchar_unlocked} - Put Character to stdin without Locking
+@item @code{setjmp} - Save Context for Non-Local Goto
+@item @code{longjmp} - Non-Local Jump to a Saved Context
+@item @code{sigsetjmp} - Save Context with Signal Status for Non-Local Goto
+@item @code{siglongjmp} - Non-Local Jump with Signal Status to a Saved Context
+@item @code{tzset} - Initialize Time Conversion Information
+@item @code{strtok_r} - Reentrant Extract Token from String
+@item @code{asctime_r} - Reentrant struct tm to ASCII Time Conversion
+@item @code{ctime_r} - Reentrant time_t to ASCII Time Conversion
+@item @code{gmtime_r} - Reentrant UTC Time Conversion
+@item @code{localtime_r} - Reentrant Local Time Conversion
+@item @code{rand_r} - Reentrant Random Number Generation
@end itemize
@section Background
@@ -55,7 +55,7 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
-@subsection setlocale -
+@subsection setlocale - Set the Current Locale
@subheading CALLING SEQUENCE:
@@ -82,7 +82,7 @@ The
@subheading NOTES:
@page
-@subsection fileno -
+@subsection fileno - Obtain File Descriptor Number for this File
@subheading CALLING SEQUENCE:
@@ -109,7 +109,7 @@ The
@subheading NOTES:
@page
-@subsection fdopen -
+@subsection fdopen - Associate Stream with File Descriptor
@subheading CALLING SEQUENCE:
@@ -136,7 +136,7 @@ The
@subheading NOTES:
@page
-@subsection flcokfile -
+@subsection flockfile - Acquire Ownership of File Stream
@subheading CALLING SEQUENCE:
@@ -163,7 +163,7 @@ The
@subheading NOTES:
@page
-@subsection ftrylockfile -
+@subsection ftrylockfile - Poll to Acquire Ownership of File Stream
@subheading CALLING SEQUENCE:
@@ -190,7 +190,7 @@ The
@subheading NOTES:
@page
-@subsection funlockfile -
+@subsection funlockfile - Release Ownership of File Stream
@subheading CALLING SEQUENCE:
@@ -217,7 +217,7 @@ The
@subheading NOTES:
@page
-@subsection getc_unlocked -
+@subsection getc_unlocked - Get Character without Locking
@subheading CALLING SEQUENCE:
@@ -244,7 +244,7 @@ The
@subheading NOTES:
@page
-@subsection getchar_unlocked -
+@subsection getchar_unlocked - Get Character from stdin without Locking
@subheading CALLING SEQUENCE:
@@ -271,7 +271,7 @@ The
@subheading NOTES:
@page
-@subsection putc_unlocked -
+@subsection putc_unlocked - Put Character without Locking
@subheading CALLING SEQUENCE:
@@ -298,7 +298,7 @@ The
@subheading NOTES:
@page
-@subsection putchar_unlocked -
+@subsection putchar_unlocked - Put Character to stdin without Locking
@subheading CALLING SEQUENCE:
@@ -325,7 +325,7 @@ The
@subheading NOTES:
@page
-@subsection setjmp -
+@subsection setjmp - Save Context for Non-Local Goto
@subheading CALLING SEQUENCE:
@@ -352,7 +352,7 @@ The
@subheading NOTES:
@page
-@subsection longjmp -
+@subsection longjmp - Non-Local Jump to a Saved Context
@subheading CALLING SEQUENCE:
@@ -379,7 +379,7 @@ The
@subheading NOTES:
@page
-@subsection sigsetjmp -
+@subsection sigsetjmp - Save Context with Signal Status for Non-Local Goto
@subheading CALLING SEQUENCE:
@@ -406,7 +406,7 @@ The
@subheading NOTES:
@page
-@subsection siglongjmp -
+@subsection siglongjmp - Non-Local Jump with Signal Status to a Saved Context
@subheading CALLING SEQUENCE:
@@ -433,7 +433,7 @@ The
@subheading NOTES:
@page
-@subsection tzset -
+@subsection tzset - Initialize Time Conversion Information
@subheading CALLING SEQUENCE:
@@ -460,7 +460,7 @@ The
@subheading NOTES:
@page
-@subsection strtok_r -
+@subsection strtok_r - Reentrant Extract Token from String
@subheading CALLING SEQUENCE:
@@ -487,7 +487,7 @@ The
@subheading NOTES:
@page
-@subsection asctime_r -
+@subsection asctime_r - Reentrant struct tm to ASCII Time Conversion
@subheading CALLING SEQUENCE:
@@ -514,7 +514,7 @@ The
@subheading NOTES:
@page
-@subsection ctime_r -
+@subsection ctime_r - Reentrant time_t to ASCII Time Conversion
@subheading CALLING SEQUENCE:
@@ -541,7 +541,7 @@ The
@subheading NOTES:
@page
-@subsection gmtime_r -
+@subsection gmtime_r - Reentrant UTC Time Conversion
@subheading CALLING SEQUENCE:
@@ -568,7 +568,7 @@ The
@subheading NOTES:
@page
-@subsection localtime_r -
+@subsection localtime_r - Reentrant Local Time Conversion
@subheading CALLING SEQUENCE:
@@ -595,7 +595,7 @@ The
@subheading NOTES:
@page
-@subsection rand_r -
+@subsection rand_r - Reentrant Random Number Generation
@subheading CALLING SEQUENCE:
diff --git a/doc/posix_users/io.t b/doc/posix_users/io.t
index d90c48f2d6..ad527aede5 100644
--- a/doc/posix_users/io.t
+++ b/doc/posix_users/io.t
@@ -15,7 +15,7 @@ The input and output primitives manager is ...
The directives provided by the input and output primitives manager are:
@itemize @bullet
-@item @code{pipe} - YYY
+@item @code{pipe} - Create an Inter-Process Channel
@item @code{dup} - Duplicates an open file descriptor
@item @code{dup2} - Duplicates an open file descriptor
@item @code{close} - Closes a file
@@ -27,14 +27,14 @@ The directives provided by the input and output primitives manager are:
@item @code{fdatasync} - Synchronize file in-core data with that on disk
@item @code{mount} - Mount a file system
@item @code{umount} - Unmount file systems
-@item @code{aio_read} - YYY
-@item @code{aio_write} - YYY
-@item @code{lio_listio} - YYY
-@item @code{aio_error} - YYY
-@item @code{aio_return} - YYY
-@item @code{aio_cancel} - YYY
-@item @code{aio_suspend} - YYY
-@item @code{aio_fsync} - YYY
+@item @code{aio_read} - Asynchronous Read
+@item @code{aio_write} - Asynchronous Write
+@item @code{lio_listio} - List Directed I/O
+@item @code{aio_error} - Retrieve Error Status of Asynchronous I/O Operation
+@item @code{aio_return} - Retrieve Return Status Asynchronous I/O Operation
+@item @code{aio_cancel} - Cancel Asynchronous I/O Request
+@item @code{aio_suspend} - Wait for Asynchronous I/O Request
+@item @code{aio_fsync} - Asynchronous File Synchronization
@end itemize
@section Background
@@ -53,7 +53,7 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
-@subsection pipe -
+@subsection pipe - Create an Inter-Process Channel
@subheading CALLING SEQUENCE:
@@ -845,7 +845,7 @@ Only the super-user may umount filesystems.
NONE
@page
-@subsection aio_read -
+@subsection aio_read - Asynchronous Read
@subheading CALLING SEQUENCE:
@@ -875,7 +875,7 @@ This routine is not currently supported by RTEMS but could be
in a future version.
@page
-@subsection aio_write -
+@subsection aio_write - Asynchronous Write
@subheading CALLING SEQUENCE:
@@ -905,7 +905,7 @@ This routine is not currently supported by RTEMS but could be
in a future version.
@page
-@subsection lio_listio -
+@subsection lio_listio - List Directed I/O
@subheading CALLING SEQUENCE:
@@ -935,7 +935,7 @@ This routine is not currently supported by RTEMS but could be
in a future version.
@page
-@subsection aio_error -
+@subsection aio_error - Retrieve Error Status of Asynchronous I/O Operation
@subheading CALLING SEQUENCE:
@@ -965,7 +965,7 @@ This routine is not currently supported by RTEMS but could be
in a future version.
@page
-@subsection aio_return -
+@subsection aio_return - Retrieve Return Status Asynchronous I/O Operation
@subheading CALLING SEQUENCE:
@@ -995,7 +995,7 @@ This routine is not currently supported by RTEMS but could be
in a future version.
@page
-@subsection aio_cancel -
+@subsection aio_cancel - Cancel Asynchronous I/O Request
@subheading CALLING SEQUENCE:
@@ -1025,7 +1025,7 @@ This routine is not currently supported by RTEMS but could be
in a future version.
@page
-@subsection aio_suspend -
+@subsection aio_suspend - Wait for Asynchronous I/O Request
@subheading CALLING SEQUENCE:
@@ -1055,7 +1055,7 @@ This routine is not currently supported by RTEMS but could be
in a future version.
@page
-@subsection aio_fsync -
+@subsection aio_fsync - Asynchronous File Synchronization
@subheading CALLING SEQUENCE:
diff --git a/doc/posix_users/memorymgmt.t b/doc/posix_users/memorymgmt.t
index 1aeaeb56a6..ee5bbdb9a0 100644
--- a/doc/posix_users/memorymgmt.t
+++ b/doc/posix_users/memorymgmt.t
@@ -16,16 +16,16 @@ 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} -
+@item @code{mlockall} - Lock the Address Space of a Process
+@item @code{munlockall} - Unlock the Address Space of a Process
+@item @code{mlock} - Lock a Range of the Process Address Space
+@item @code{munlock} - Unlock a Range of the Process Address Space
+@item @code{mmap} - Map Process Addresses to a Memory Object
+@item @code{munmap} - Unmap Previously Mapped Addresses
+@item @code{mprotect} - Change Memory Protection
+@item @code{msync} - Memory Object Synchronization
+@item @code{shm_open} - Open a Shared Memory Object
+@item @code{shm_unlink} - Remove a Shared Memory Object
@end itemize
@section Background
@@ -44,7 +44,7 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
-@subsection mlockall -
+@subsection mlockall - Lock the Address Space of a Process
@subheading CALLING SEQUENCE:
@@ -71,7 +71,7 @@ The
@subheading NOTES:
@page
-@subsection munlockall -
+@subsection munlockall - Unlock the Address Space of a Process
@subheading CALLING SEQUENCE:
@@ -98,7 +98,7 @@ The
@subheading NOTES:
@page
-@subsection mlock -
+@subsection mlock - Lock a Range of the Process Address Space
@subheading CALLING SEQUENCE:
@@ -125,7 +125,7 @@ The
@subheading NOTES:
@page
-@subsection munlock -
+@subsection munlock - Unlock a Range of the Process Address Space
@subheading CALLING SEQUENCE:
@@ -152,7 +152,7 @@ The
@subheading NOTES:
@page
-@subsection mmap -
+@subsection mmap - Map Process Addresses to a Memory Object
@subheading CALLING SEQUENCE:
@@ -179,7 +179,7 @@ The
@subheading NOTES:
@page
-@subsection munmap -
+@subsection munmap - Unmap Previously Mapped Addresses
@subheading CALLING SEQUENCE:
@@ -206,7 +206,7 @@ The
@subheading NOTES:
@page
-@subsection mprotect -
+@subsection mprotect - Change Memory Protection
@subheading CALLING SEQUENCE:
@@ -233,7 +233,7 @@ The
@subheading NOTES:
@page
-@subsection msync -
+@subsection msync - Memory Object Synchronization
@subheading CALLING SEQUENCE:
@@ -260,7 +260,7 @@ The
@subheading NOTES:
@page
-@subsection shm_open -
+@subsection shm_open - Open a Shared Memory Object
@subheading CALLING SEQUENCE:
@@ -287,7 +287,7 @@ The
@subheading NOTES:
@page
-@subsection shm_unlink -
+@subsection shm_unlink - Remove a Shared Memory Object
@subheading CALLING SEQUENCE: