RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

Cleaned up formatting.

Browse Source 
Added notes on background and operations sections.

Added NOTE to indicate the feature flag defined.
This commit is contained in:
Joel Sherrill
1998-08-25 20:54:47 +00:00
parent d5ef5bd16f
commit d1a859c0c2
4 changed files with 852 additions and 735 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
doc/new_chapters/adminiface.t
View File

@@ -10,8 +10,11 @@
@section Introduction @section Introduction
The The administration interface manager provides a portable
administration interface manager is ... interface for some system administrative functions.
The capabilities in this manager were defined in the POSIX
1003.1h/D3 proposed standard titled @b{Services for Reliable,
Available, and Serviceable Systems}.
The directives provided by the administration interface manager are: The directives provided by the administration interface manager are:
@@ -21,6 +24,49 @@ The directives provided by the administration interface manager are:
@section Background @section Background
@subsection admin_args Structure
@example
put structure here
@end example
@table @b
@item admin_type
This field ...
@table @b
@item ADMIN_AUTOBOOT
This field ...
@item ADMIN_HALT
This field ...
@item ADMIN_FAST
This field ...
@item ADMIN_IMMEDIATE
This field ...
@item ADMIN_ALTSYSTEM
This field ...
@item ADMIN_ALTCONFIG
This field ...
@item ADMIN_SYSDUMP
This field ...
@item ADMIN_INIT
This field ...
@end table
@item admin_data
This field ...
@end table
@section Operations @section Operations
@section Directives @section Directives
@@ -38,8 +84,8 @@ and status codes.
@ifset is-C @ifset is-C
@example @example
int admin_shutdown( int admin_shutdown(
struct admin_args_ *args[], struct admin_args *args[],
size_t nargs size_t nargs
); );
@end example @end example
@end ifset @end ifset
@@ -52,8 +98,7 @@ int admin_shutdown(
@table @b @table @b
@item EINVAL @item EINVAL
An invalid argument was passed to the function call. An invalid argument was passed to the function call.
@item ENOSYS
The function admin_shutdown() is not supported by this implementation.
@item EPERM @item EPERM
The caller does not have appropriate permission for shutting down the The caller does not have appropriate permission for shutting down the
system. system.
@@ -62,20 +107,15 @@ system.
@subheading DESCRIPTION: @subheading DESCRIPTION:
The @code{admin_shutdown} function restarts the system. The
If @code{_POSIX_ADMIN} is defined: @code{args} argument specifies alternate or optional behavior
for the @code{admin_shutdown} function. The @code{admin_type}
The @code{admin_shutdown} function restarts the system. The member of each element of the @code{args} array specifies the
@code{args} argument specifies alternate or optional behavior optional behavior to be performed. There are som @code{admin_types}
for the @code{admin_shutdown} function. The @code{admin_type} values that may provoke unspecified behavior. The @code{nargs}
member of each element of the @code{args} array specifies the argument specifies the length of the @code{args} array.
optional behavior to be performed. There are som @code{admin_types}
values that may provoke unspecified behavior. The @code{nargs}
argument specifies the length of the @code{args} array.
Otherwise:
The @code{admin_shutdown} function shall fail.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_ADMIN} feature flag is defined to indicate
this service is available.

788
doc/new_chapters/confspace.t
View File

File diff suppressed because it is too large Load Diff

39
doc/new_chapters/dumpcontrol.t
View File

@@ -10,8 +10,11 @@
@section Introduction @section Introduction
The The process dump control manager provides a portable
process dump control manager is ... interface for changing the path to which a process dump
is written. The capabilities in this manager were defined in
the POSIX 1003.1h/D3 proposed standard titled @b{Services for Reliable,
Available, and Serviceable Systems}.
The directives provided by the process dump control manager are: The directives provided by the process dump control manager are:
@@ -53,16 +56,18 @@ int dump_setpath(
Search permission is denied for a component of the path prefix, Search permission is denied for a component of the path prefix,
or write permission is denied on the directory containing the or write permission is denied on the directory containing the
file. file.
@item ENAMETOOLONG @item ENAMETOOLONG
The length of the argument exceeds @code{PATH_MAX} or a pathname The length of the argument exceeds @code{PATH_MAX} or a pathname
component is longer than @code{NAME_MAX} while @code{_POSIX_NO_TRUNC} component is longer than @code{NAME_MAX} while @code{_POSIX_NO_TRUNC}
is in effect. is in effect.
@item ENOENT @item ENOENT
The path argument points to an empty string. The path argument points to an empty string.
@item ENOSYS
The function dump_setpath() is not suppo9rted by this implementation.
@item ENOTDIR @item ENOTDIR
A component of the path prefix is not a directory. A component of the path prefix is not a directory.
@item EROFS @item EROFS
The directory entry specified resides on a read-only file system. The directory entry specified resides on a read-only file system.
@@ -70,22 +75,18 @@ The directory entry specified resides on a read-only file system.
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_DUMP} is defined: The @code{dump_setpath} function defines the pathname where process
dumps are written. The pathname pointed to by @code{path} shall
define where a process dump file will be written if the calling
process terminates with a dump file. The @code{path} argument
shall not name a directory.
The @code{dump_setpath} function defines the pathname where process If the @code{path} argument is NULL, the system shall not write a
dumps are written. The pathname pointed to by @code{path} shall process dump file if the calling process terminates with a dump
define where a process dump file will be written if the calling file. If the @code{dump_setpath} function fails, the pathname for
process terminates with a dump file. The @code{path} argument writing process dumps shall not change.
shall not name a directory.
If the @code{path} argument is NULL, the system shall not write a
process dump file if the calling process terminates with a dump
file. If the @code{dump_setpath} function fails, the pathname for
writing process dumps shall not change.
Otherwise:
The @code{dump_setpath} function shall fail.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_DUMP} feature flag is defined to indicate
this service is available.

680
doc/new_chapters/eventlog.t
View File

@@ -10,8 +10,11 @@
@section Introduction @section Introduction
The The event logging manager provides a portable method for logging
event logging manager is ... system and appplication events and subsequent processing of those
events. The capabilities in this manager were defined in the POSIX
1003.1h/D3 proposed standard titled @b{Services for Reliable,
Available, and Serviceable Systems}.
The directives provided by the event logging manager are: The directives provided by the event logging manager are:
@@ -32,8 +35,37 @@ The directives provided by the event logging manager are:
@section Background @section Background
@subsection Log Files and Events
System log
Non-system logs
Events, facility, severity
@subsection Queries
@section Operations @section Operations
@subsection Creating and Writing a non-System Log
Discuss creating and writing to a non-system log.
@example
log_create
log_write loop
@end example
@subsection Reading a Log
Discuss opening and reading from a log.
@example
build a query
log_open
log_read loop
@end example
@section Directives @section Directives
This section details the event logging manager's directives. This section details the event logging manager's directives.
@@ -66,17 +98,20 @@ int log_write(
@table @b @table @b
@item EINVAL @item EINVAL
The facility argument is not a valid log_facility. The facility argument is not a valid log_facility.
@item EINVAL @item EINVAL
The severity argument exceeds @code{LOG_SEVERITY_MAX} The severity argument exceeds @code{LOG_SEVERITY_MAX}
@item EINVAL @item EINVAL
The len argument exceeds @code{LOG_ENTRY_MAXLEN} The len argument exceeds @code{LOG_ENTRY_MAXLEN}
@item ENOSPC @item ENOSPC
The log file has run out of space on the device. The log file has run out of space on the device.
@item ENOSYS
The function log_write() is not supported by this implementation.
@item EPERM @item EPERM
The caller does not have appropriate permission for writing to The caller does not have appropriate permission for writing to
the given facility. the given facility.
@item EIO @item EIO
An I/O error occurred in writing to the system event log. An I/O error occurred in writing to the system event log.
@@ -84,47 +119,44 @@ An I/O error occurred in writing to the system event log.
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The @code{log_write} function writes an event record, consisting
of event attributes, and the data identified by the @code{buf}
argument, to the system log. The @code{len} argument specifies
the length in bytes of the buffer pointed to by @code{buf}. The
@code{len} argument shall specify the value of the event record
length attribute. The value of @code{len} shall be less than or
equal to @code{LOG_ENTRY_MAXLEN} or the @code{log_write} shall fail.
The @code{log_write} function writes an event record, consisting The @code{event_id} argument identifies the type of event record
of event attributes, and the data identified by the @code{buf} being written. The @code{event_id} argument shall specify the value
argument, to the system log. The @code{len} argument specifies of the event ID attribute of the event record.
the length in bytes of the buffer pointed to by @code{buf}. The
@code{len} argument shall specify the value of the event record
length attribute. The value of @code{len} shall be less than or
equal to @code{LOG_ENTRY_MAXLEN} or the @code{log_write} shall fail.
The @code{event_id} argument identifies the type of event record The argument @code{facility} indicates the facility from which the
being written. The @code{event_id} argument shall specify the value event type is drawn. The @code{facility} aargument shall specify the
of the event ID attribute of the event record. value of the event record facility attribute. The value of the
@code{facility} argument shall be a valid log facility or the
@code{log_write} function shall fail.
The argument @code{facility} indicates the facility from which the The @code{severity} argument indicates the severity level of the
event type is drawn. The @code{facility} aargument shall specify the event record. The @code{severity} argument shall specify the value
value of the event record facility attribute. The value of the of the event record severity attribute. The value of the
@code{facility} argument shall be a valid log facility or the @code{severity} argument shall be less than or equal to
@code{log_write} function shall fail. @code{LOG_SEVERITY_MAX} or the @code{log_write} function shall fail.
The @code{severity} argument indicates the severity level of the The effective_UID of the calling process shall specify the event
event record. The @code{severity} argument shall specify the value record UID attribute. The efective-GID of the calling process
of the event record severity attribute. The value of the shall specify the event record GID attribute. The process ID
@code{severity} argument shall be less than or equal to of the calling process shall specify the event record process ID
@code{LOG_SEVERITY_MAX} or the @code{log_write} function shall fail. attribute. The process group ID of the calling process shall
specify the event record process group ID attribute. The current
The effective_UID of the calling process shall specify the event value of the system clock shall specify the event record timestamp
record UID attribute. The efective-GID of the calling process attribute.
shall specify the event record GID attribute. The process ID
of the calling process shall specify the event record process ID
attribute. The process group ID of the calling process shall
specify the event record process group ID attribute. The current
value of the system clock shall specify the event record timestamp
attribute.
Otherwise:
The @code{log_write} function shall fail.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_open - Open a log file @subsection log_open - Open a log file
@@ -149,68 +181,72 @@ int log_open(
@item EACCES @item EACCES
Search permission is denied on a component of the path prefix, Search permission is denied on a component of the path prefix,
or the log file exists and read permission is denied. or the log file exists and read permission is denied.
@item EINTR @item EINTR
A signal interrupted the call to log_open(). A signal interrupted the call to log_open().
@item EINVAL @item EINVAL
The log_facility field of the query argument is not a valid The log_facility field of the query argument is not a valid
facility set. facility set.
@item EINVAL @item EINVAL
The log_severity field of the query argument exceeds The log_severity field of the query argument exceeds
@code{LOG_SEVERITY_MAX}. @code{LOG_SEVERITY_MAX}.
@item EINVAL @item EINVAL
The path argument referred to a file that was not a log file. The path argument referred to a file that was not a log file.
@item EMFILE @item EMFILE
Too many log file descriptors are currently in use by this Too many log file descriptors are currently in use by this
process. process.
@item ENAMETOOLONG @item ENAMETOOLONG
The length of the path string exceeds @code{PATH_MAX}, or a pathname The length of the path string exceeds @code{PATH_MAX}, or a pathname
component is longer than @code{NAME_MAX} while @code{_POSIX_NO_TRUNC} is component is longer than @code{NAME_MAX} while @code{_POSIX_NO_TRUNC} is
in effect. in effect.
@item ENFILE @item ENFILE
Too many files are currently open in the system. Too many files are currently open in the system.
@item ENOENT @item ENOENT
The file specified by the path argument does not exist. The file specified by the path argument does not exist.
@item ENOTDIR @item ENOTDIR
A component of the path prefix is not a directory. A component of the path prefix is not a directory.
@item ENOSYS
The function log_open() is not supported by this implementation.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The @code{log_open} function establishes the connection between a
log file and a log file descriptor. It creates an open log file
description that refers to a log file and a log file descriptor that
refers to that open log file description. The log file descriptor is
used by other log functions to refer to that log file. The @code{path}
argument points to a pathname naming a log file. A @code{path}
argument of NULL specifies the current system log file.
The @code{log_open} function establishes the connection between a The @code{query} argument points to a log query specification that
log file and a log file descriptor. It creates an open log file restricts log operations using the returned log file descriptor to
description that refers to a log file and a log file descriptor that to event records from the log file which match the query. The
refers to that open log file description. The log file descriptor is predicate which determines the success of the match operation is the
used by other log functions to refer to that log file. The @code{path} logical AND of the individual comparison predicates for each member
argument points to a pathname naming a log file. A @code{path} of the log query specification. The query attribute of the open file
argument of NULL specifies the current system log file. description is set to filter as specified by the @code{query} argument.
If the value of the query argument is not NULL, the value of the
The @code{query} argument points to a log query specification that @code{log_facility} member of the @code{query} specification shall be
restricts log operations using the returned log file descriptor to a set of valid log facilities or the @code{log_open} shall fail. If
to event records from the log file which match the query. The the value of the @code{query} argument is not NULL, the value of the
predicate which determines the success of the match operation is the @code{log_severity} member of the @code{query} specification shall be
logical AND of the individual comparison predicates for each member less than or equal to @code{LOG_SEVERITY_MAX} or the @code{log_open}
of the log query specification. The query attribute of the open file shall fail. If the value of the @code{query} argument is NULL, no
description is set to filter as specified by the @code{query} argument. query filter shall be applied.
If the value of the query argument is not NULL, the value of the
@code{log_facility} member of the @code{query} specification shall be
a set of valid log facilities or the @code{log_open} shall fail. If
the value of the @code{query} argument is not NULL, the value of the
@code{log_severity} member of the @code{query} specification shall be
less than or equal to @code{LOG_SEVERITY_MAX} or the @code{log_open}
shall fail. If the value of the @code{query} argument is NULL, no
query filter shall be applied.
Otherwise:
The @code{log_open} shall fail.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_read - Read from the system Log @subsection log_read - Read from the system Log
@@ -236,14 +272,15 @@ int log_read(
@table @b @table @b
@item EBADF @item EBADF
The logdes argument is not a valid log file descriptor. The logdes argument is not a valid log file descriptor.
@item EBUSY @item EBUSY
No data available. The open log file descriptor references No data available. The open log file descriptor references
the current system log. and there are no unread event records the current system log. and there are no unread event records
remaining. remaining.
@item EINTR @item EINTR
A signal interrupted the call to log_read(). A signal interrupted the call to log_read().
@item ENOSYS
The function log_read() is not supported by this implementation.
@item EIO @item EIO
An I/O error occurred in reading from the event log. An I/O error occurred in reading from the event log.
@@ -251,37 +288,33 @@ An I/O error occurred in reading from the event log.
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The @code{log_read} function shall attempt to read the @code{log_entry}
structure and @code{log_len} bytes of data from the next event record
of the log file associated with the open log file descriptor @code{logdes},
placing the @code{log_entry} structure into the buffer pointed to by
@code{entry}, and the data into the buffer pointed to by @code{log_buf}.
The log record ID of the returned event record shall be stored in the
@code{log_recied} member of the @code{log_entry} structure for the event
record.
The @code{log_read} function shall attempt to read the @code{log_entry} If the query attribute of the open log file description associated with
structure and @code{log_len} bytes of data from the next event record the @code{logdes} is set, the event record read shall match that query.
of the log file associated with the open log file descriptor @code{logdes}, If the @code{entry} argument is not NULL it will point to a @code{log_entry}
placing the @code{log_entry} structure into the buffer pointed to by structure which sall be filled with the creation information for this log
@code{entry}, and the data into the buffer pointed to by @code{log_buf}. entry. If the argument @code{log_buf} is not NULL the data written with the
The log record ID of the returned event record shall be stored in the log entry will be placed in the buffer. The size of the buffer is specified
@code{log_recied} member of the @code{log_entry} structure for the event by the argument @code{log_len}.
record.
If the query attribute of the open log file description associated with
the @code{logdes} is set, the event record read shall match that query.
If the @code{entry} argument is not NULL it will point to a @code{log_entry}
structure which sall be filled with the creation information for this log
entry. If the argument @code{log_buf} is not NULL the data written with the
log entry will be placed in the buffer. The size of the buffer is specified
by the argument @code{log_len}.
If the @code{log_read} is successful the call shall store the actual length
of the data associated with the event record into the location specified by
@code{log_sizeread}. This number may be smaller or greater than
@code{log_len}.
Otherwise:
The @code{log_read} function shall fail.
If the @code{log_read} is successful the call shall store the actual length
of the data associated with the event record into the location specified by
@code{log_sizeread}. This number may be smaller or greater than
@code{log_len}.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_notify - Notify Process of writes to the system log. @subsection log_notify - Notify Process of writes to the system log.
@@ -304,11 +337,14 @@ int log_notify(
@table @b @table @b
@item EBADF @item EBADF
The logdes arfument is not a valid log file descriptor. The logdes arfument is not a valid log file descriptor.
@item EINVAL @item EINVAL
The notification argument specifies an invalid signal. The notification argument specifies an invalid signal.
@item EINVAL @item EINVAL
The process has requested a notify on a log that will not be The process has requested a notify on a log that will not be
written to. written to.
@item ENOSY @item ENOSY
The function log_notify() is not supported by this implementation. The function log_notify() is not supported by this implementation.
@@ -316,30 +352,26 @@ The function log_notify() is not supported by this implementation.
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: If the argument @code{notification} is not NULL this function registers
the calling process to be notified of event records received by the system
If the argument @code{notification} is not NULL this function registers log, which match the query parameters associated with the open log descriptor
the calling process to be notified of event records received by the system specified by @code{logdes}. The notification specified by the
log, which match the query parameters associated with the open log descriptor @code{notification} argument shall be sent to the process when an event
specified by @code{logdes}. The notification specified by the record received by the system log is matched by the query attribute of the
@code{notification} argument shall be sent to the process when an event open log file description associated with the @code{logdes} log file
record received by the system log is matched by the query attribute of the descriptor. If the calling process has already registered a notification
open log file description associated with the @code{logdes} log file for the @code{logdes} log file descriptor, the new notification shall
descriptor. If the calling process has already registered a notification replace the existing notification registration.
for the @code{logdes} log file descriptor, the new notification shall
replace the existing notification registration.
If the @code{notification} argument is NULL and the calling process is If the @code{notification} argument is NULL and the calling process is
currently registered to be notified for the @code{logdes} log file currently registered to be notified for the @code{logdes} log file
descriptor, the existing registration shall be removed. descriptor, the existing registration shall be removed.
Otherwise:
The @code{log_notify} function shall fail.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_close - Close log descriptor @subsection log_close - Close log descriptor
@@ -361,34 +393,29 @@ int log_close(
@table @b @table @b
@item EBADF @item EBADF
The logdes argument is not a valid log file descriptor. The logdes argument is not a valid log file descriptor.
@item ENOSYS
The function log_close() is not supported by t his implementation.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The @code{log_close} function deallocates the open log file descriptor
indicated by @code{log_des}.
The @code{log_close} function deallocates the open log file descriptor When all log file descriptors associated with an open log file description
indicated by @code{log_des}. have been closed, the open log file description shall be freed.
When all log file descriptors associated with an open log file description If the link count of the log file is zero, when all log file descriptors
have been closed, the open log file description shall be freed. have been closed, the space occupied by the log file shall be freed and the
log file shall no longer be accessible.
If the link count of the log file is zero, when all log file descriptors If the process has successfully registered a notification request for the
have been closed, the space occupied by the log file shall be freed and the log file descriptor, the registration shall be removed.
log file shall no longer be accessible.
If the process has successfully registered a notification request for the
log file descriptor, the registration shall be removed.
Otherwise:
The @code{log_close} function shall fail.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_seek - Reposition log file offset @subsection log_seek - Reposition log file offset
@@ -411,37 +438,42 @@ int log_seek(
@table @b @table @b
@item EBADF @item EBADF
The logdes argument is not a valid log file descriptor. The logdes argument is not a valid log file descriptor.
@item EINTR @item EINTR
The log_seek() function was interrupted by a signal. The log_seek() function was interrupted by a signal.
@item EINVAL @item EINVAL
The log_recid argument is not a valid record id. The log_recid argument is not a valid record id.
@item ENOSYS
The function log_seek() is not supported by this implementation.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The @code{log_seek} function shall set the log file offset of the open
log descriptioin associated with the @code{logdes} log file descriptor
to the event record in the log file identified by @code{log_recid}.
The @code{log_recid} argument is either the record id of a valid event
record or one of the following values, as defined in the header <evlog.h>:
The @code{log_seek} function shall set the log file offset of the open @table @b
log descriptioin associated with the @code{logdes} log file descriptor @item LOG_SEEK_START
to the event record in the log file identified by @code{log_recid}. Set log file position to point at the first event
The @code{log_recid} argument is either the record id of a valid event record in the log file
record or one of the following values, as defined in the header <evlog.h>:
LOG_SEEK_START - Set log file position to point at the first event
record in the log file
LOG_SEEK_END - Set log file position to point after the last event
record in the log file
If the @code{log_seek} function is interrupted, the state of the open log
file description associated with @code{logdes} is unspecified.
Otherwise: @item LOG_SEEK_END
Set log file position to point after the last event
record in the log file
The @code{log_seek} function shall fail. @end table
If the @code{log_seek} function is interrupted, the state of the open log
file description associated with @code{logdes} is unspecified.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_severity_before - Compare event record severities @subsection log_severity_before - Compare event record severities
@@ -464,31 +496,25 @@ int log_severity_before(
@table @b @table @b
@item EINVAL @item EINVAL
The value of either s1 or s2 exceeds @code{LOG_SEVERITY_MAX}. The value of either s1 or s2 exceeds @code{LOG_SEVERITY_MAX}.
@item ENOSYS
The function log_severity_before() is not supported by this
implementation.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The @code{log_severity_before} function shall compare the severity order
of the @code{s1} and @code{s2} arguments. Severity values ordered
according to this function shall be according to decreasing severity.
The @code{log_severity_before} function shall compare the severity order If @code{s1} is ordered before or is equal to @code{s2} then the ordering
of the @code{s1} and @code{s2} arguments. Severity values ordered predicate shall return 1, otherwise the predicate shall return 0. If
according to this function shall be according to decreasing severity. either @code{s1} or @code{s2} specify invlid severity values, the return
value of @code{log_severity_before} is unspecified.
If @code{s1} is ordered before or is equal to @code{s2} then the ordering
predicate shall return 1, otherwise the predicate shall return 0. If
either @code{s1} or @code{s2} specify invlid severity values, the return
value of @code{log_severity_before} is unspecified.
Otherwise:
The @code{log_severity_before} function shall fail.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_facilityemptyset - Manipulate log facility sets @subsection log_facilityemptyset - Manipulate log facility sets
@@ -510,50 +536,45 @@ int log_facilityemptyset(
@table @b @table @b
@item EINVAL @item EINVAL
The facilityno argument is not a valid facility. The facilityno argument is not a valid facility.
@item ENOSYS
The function is not supported by this implementation.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The facilitysetops primitives manipulate sets of facilities. They
operate on data objects addressable by the application.
The facilitysetops primitives manipulate sets of facilities. They The @code{log_facilityemptyset} function initializes the facility
operate on data objects addressable by the application. set pointed to by the argument @code{set}, such that all facilties
are included.
The @code{log_facilityemptyset} function initializes the facility Applications shall call either @code{log_facilityemptyset} or
set pointed to by the argument @code{set}, such that all facilties @code{log_facilityfillset} at least once for each object of type
are included. @code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
Applications shall call either @code{log_facilityemptyset} or The @code{log_facilityaddset} and @code{log_facilitydelset} functions
@code{log_cacilityfillset} at least once for each object of type respectively add or delete the individual facility specified by the
@code{log_facilityset_t} prior to any other use of that object. If value of the argument @code{facilityno} to or from the facility set
such an object is not initialized in this way, but is nonetheless pointed to by the argument @code{set}
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
The @code{log_facilityaddset} and @code{log_facilitydelset} functions The @code{log_facilityismember} function tests whether the facility
respectively add or delete the individual facility specified by the specified by the value of the argument @code{facilityno} is a member
value of the argument @code{facilityno} to or from the facility set of the set pointed to by the argument @code{set}. Upon successful
pointed to by the argument @code{set} completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
The @code{log_facilityismember} function tests whether the facility specified facility is a member of the specified set or returns a
specified by the value of the argument @code{facilityno} is a member value of zero to the location specified by @code{member} if the
of the set pointed to by the argument @code{set}. Upon successful specified facility is not a member of the specified set.
completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
specified facility is a member of the specified set or returns a
value of zero to the location specified by @code{member} if the
specified facility is not a member of the specified set.
Otherwise:
The function fails
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_facilityfillset - Manipulate log facility sets @subsection log_facilityfillset - Manipulate log facility sets
@@ -575,50 +596,45 @@ int log_facilityfillset(
@table @b @table @b
@item EINVAL @item EINVAL
The facilityno argument is not a valid facility. The facilityno argument is not a valid facility.
@item ENOSYS
The function is not supported by this implementation.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The facilitysetops primitives manipulate sets of facilities. They
operate on data objects addressable by the application.
The facilitysetops primitives manipulate sets of facilities. They The @code{log_facilityemptyset} function initializes the facility
operate on data objects addressable by the application. set pointed to by the argument @code{set}, such that all facilties
are included.
The @code{log_facilityemptyset} function initializes the facility Applications shall call either @code{log_facilityemptyset} or
set pointed to by the argument @code{set}, such that all facilties @code{log_facilityfillset} at least once for each object of type
are included. @code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
Applications shall call either @code{log_facilityemptyset} or The @code{log_facilityaddset} and @code{log_facilitydelset} functions
@code{log_cacilityfillset} at least once for each object of type respectively add or delete the individual facility specified by the
@code{log_facilityset_t} prior to any other use of that object. If value of the argument @code{facilityno} to or from the facility set
such an object is not initialized in this way, but is nonetheless pointed to by the argument @code{set}
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
The @code{log_facilityaddset} and @code{log_facilitydelset} functions The @code{log_facilityismember} function tests whether the facility
respectively add or delete the individual facility specified by the specified by the value of the argument @code{facilityno} is a member
value of the argument @code{facilityno} to or from the facility set of the set pointed to by the argument @code{set}. Upon successful
pointed to by the argument @code{set} completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
The @code{log_facilityismember} function tests whether the facility specified facility is a member of the specified set or returns a
specified by the value of the argument @code{facilityno} is a member value of zero to the location specified by @code{member} if the
of the set pointed to by the argument @code{set}. Upon successful specified facility is not a member of the specified set.
completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
specified facility is a member of the specified set or returns a
value of zero to the location specified by @code{member} if the
specified facility is not a member of the specified set.
Otherwise:
The function fails
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_facilityaddset - Manipulate log facility sets @subsection log_facilityaddset - Manipulate log facility sets
@@ -641,50 +657,45 @@ int log_facilityaddset(
@table @b @table @b
@item EINVAL @item EINVAL
The facilityno argument is not a valid facility. The facilityno argument is not a valid facility.
@item ENOSYS
The function is not supported by this implementation.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The facilitysetops primitives manipulate sets of facilities. They
operate on data objects addressable by the application.
The facilitysetops primitives manipulate sets of facilities. They The @code{log_facilityemptyset} function initializes the facility
operate on data objects addressable by the application. set pointed to by the argument @code{set}, such that all facilties
are included.
The @code{log_facilityemptyset} function initializes the facility Applications shall call either @code{log_facilityemptyset} or
set pointed to by the argument @code{set}, such that all facilties @code{log_facilityfillset} at least once for each object of type
are included. @code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
Applications shall call either @code{log_facilityemptyset} or The @code{log_facilityaddset} and @code{log_facilitydelset} functions
@code{log_cacilityfillset} at least once for each object of type respectively add or delete the individual facility specified by the
@code{log_facilityset_t} prior to any other use of that object. If value of the argument @code{facilityno} to or from the facility set
such an object is not initialized in this way, but is nonetheless pointed to by the argument @code{set}
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
The @code{log_facilityaddset} and @code{log_facilitydelset} functions The @code{log_facilityismember} function tests whether the facility
respectively add or delete the individual facility specified by the specified by the value of the argument @code{facilityno} is a member
value of the argument @code{facilityno} to or from the facility set of the set pointed to by the argument @code{set}. Upon successful
pointed to by the argument @code{set} completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
The @code{log_facilityismember} function tests whether the facility specified facility is a member of the specified set or returns a
specified by the value of the argument @code{facilityno} is a member value of zero to the location specified by @code{member} if the
of the set pointed to by the argument @code{set}. Upon successful specified facility is not a member of the specified set.
completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
specified facility is a member of the specified set or returns a
value of zero to the location specified by @code{member} if the
specified facility is not a member of the specified set.
Otherwise:
The function fails
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_facilitydelset - Manipulate log facility sets @subsection log_facilitydelset - Manipulate log facility sets
@@ -707,50 +718,45 @@ int log_facilitydelset(
@table @b @table @b
@item EINVAL @item EINVAL
The facilityno argument is not a valid facility. The facilityno argument is not a valid facility.
@item ENOSYS
The function is not supported by this implementation.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The facilitysetops primitives manipulate sets of facilities. They
operate on data objects addressable by the application.
The facilitysetops primitives manipulate sets of facilities. They The @code{log_facilityemptyset} function initializes the facility
operate on data objects addressable by the application. set pointed to by the argument @code{set}, such that all facilties
are included.
The @code{log_facilityemptyset} function initializes the facility Applications shall call either @code{log_facilityemptyset} or
set pointed to by the argument @code{set}, such that all facilties @code{log_facilityfillset} at least once for each object of type
are included. @code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
Applications shall call either @code{log_facilityemptyset} or The @code{log_facilityaddset} and @code{log_facilitydelset} functions
@code{log_cacilityfillset} at least once for each object of type respectively add or delete the individual facility specified by the
@code{log_facilityset_t} prior to any other use of that object. If value of the argument @code{facilityno} to or from the facility set
such an object is not initialized in this way, but is nonetheless pointed to by the argument @code{set}
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
The @code{log_facilityaddset} and @code{log_facilitydelset} functions The @code{log_facilityismember} function tests whether the facility
respectively add or delete the individual facility specified by the specified by the value of the argument @code{facilityno} is a member
value of the argument @code{facilityno} to or from the facility set of the set pointed to by the argument @code{set}. Upon successful
pointed to by the argument @code{set} completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
The @code{log_facilityismember} function tests whether the facility specified facility is a member of the specified set or returns a
specified by the value of the argument @code{facilityno} is a member value of zero to the location specified by @code{member} if the
of the set pointed to by the argument @code{set}. Upon successful specified facility is not a member of the specified set.
completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
specified facility is a member of the specified set or returns a
value of zero to the location specified by @code{member} if the
specified facility is not a member of the specified set.
Otherwise:
The function fails
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_facilityismember - Manipulate log facility sets @subsection log_facilityismember - Manipulate log facility sets
@@ -774,50 +780,45 @@ int log_facilityismember(
@table @b @table @b
@item EINVAL @item EINVAL
The facilityno argument is not a valid facility. The facilityno argument is not a valid facility.
@item ENOSYS
The function is not supported by this implementation.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: The facilitysetops primitives manipulate sets of facilities. They
operate on data objects addressable by the application.
The facilitysetops primitives manipulate sets of facilities. They The @code{log_facilityemptyset} function initializes the facility
operate on data objects addressable by the application. set pointed to by the argument @code{set}, such that all facilties
are included.
The @code{log_facilityemptyset} function initializes the facility Applications shall call either @code{log_facilityemptyset} or
set pointed to by the argument @code{set}, such that all facilties @code{log_facilityfillset} at least once for each object of type
are included. @code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
Applications shall call either @code{log_facilityemptyset} or The @code{log_facilityaddset} and @code{log_facilitydelset} functions
@code{log_cacilityfillset} at least once for each object of type respectively add or delete the individual facility specified by the
@code{log_facilityset_t} prior to any other use of that object. If value of the argument @code{facilityno} to or from the facility set
such an object is not initialized in this way, but is nonetheless pointed to by the argument @code{set}
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
The @code{log_facilityaddset} and @code{log_facilitydelset} functions The @code{log_facilityismember} function tests whether the facility
respectively add or delete the individual facility specified by the specified by the value of the argument @code{facilityno} is a member
value of the argument @code{facilityno} to or from the facility set of the set pointed to by the argument @code{set}. Upon successful
pointed to by the argument @code{set} completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
The @code{log_facilityismember} function tests whether the facility specified facility is a member of the specified set or returns a
specified by the value of the argument @code{facilityno} is a member value of zero to the location specified by @code{member} if the
of the set pointed to by the argument @code{set}. Upon successful specified facility is not a member of the specified set.
completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
specified facility is a member of the specified set or returns a
value of zero to the location specified by @code{member} if the
specified facility is not a member of the specified set.
Otherwise:
The function fails
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_create - Creates a log file @subsection log_create - Creates a log file
@@ -845,18 +846,15 @@ The is ????????????
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: This function dynamically allocates memory for the @code{ld}, associates
a directory path to the @code{Ld}, andprovides access permissions to the
This function dynamically allocates memory for the @code{ld}, associates @code{ld}.
a directory path to the @code{Ld}, andprovides access permissions to the
@code{ld}.
Otherwise:
The function fails
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
@page @page
@subsection log_sys_create - Creates a system log file @subsection log_sys_create - Creates a system log file
@@ -881,16 +879,10 @@ The directory path to the system log already exist.
@subheading DESCRIPTION: @subheading DESCRIPTION:
If @code{_POSIX_LOGGING} is defined: This function will create a predefined system log directory path and
system log file if they do not already exist.
This function will create a predefined system log directory path and system log
file if they do not already exist.
Otherwise:
The function fails
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.