summaryrefslogtreecommitdiffstats
path: root/doc/new_chapters/adminiface.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1998-08-25 20:54:47 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1998-08-25 20:54:47 +0000
commitd1a859c0c20ea726ed2f3b2936ff406274bc62a4 (patch)
tree1d9cad10148f0a1296996f0ff7940d60269cae00 /doc/new_chapters/adminiface.t
parentCommit for review (diff)
downloadrtems-d1a859c0c20ea726ed2f3b2936ff406274bc62a4.tar.bz2
Cleaned up formatting.
Added notes on background and operations sections. Added NOTE to indicate the feature flag defined.
Diffstat (limited to 'doc/new_chapters/adminiface.t')
-rw-r--r--doc/new_chapters/adminiface.t80
1 files changed, 60 insertions, 20 deletions
diff --git a/doc/new_chapters/adminiface.t b/doc/new_chapters/adminiface.t
index ce11b1b862..a037f61ffa 100644
--- a/doc/new_chapters/adminiface.t
+++ b/doc/new_chapters/adminiface.t
@@ -10,8 +10,11 @@
@section Introduction
-The
-administration interface manager is ...
+The administration interface manager provides a portable
+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:
@@ -21,6 +24,49 @@ The directives provided by the administration interface manager are:
@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 Directives
@@ -38,8 +84,8 @@ and status codes.
@ifset is-C
@example
int admin_shutdown(
- struct admin_args_ *args[],
- size_t nargs
+ struct admin_args *args[],
+ size_t nargs
);
@end example
@end ifset
@@ -52,8 +98,7 @@ int admin_shutdown(
@table @b
@item EINVAL
An invalid argument was passed to the function call.
-@item ENOSYS
-The function admin_shutdown() is not supported by this implementation.
+
@item EPERM
The caller does not have appropriate permission for shutting down the
system.
@@ -62,20 +107,15 @@ system.
@subheading DESCRIPTION:
-
-If @code{_POSIX_ADMIN} is defined:
-
- The @code{admin_shutdown} function restarts the system. The
- @code{args} argument specifies alternate or optional behavior
- for the @code{admin_shutdown} function. The @code{admin_type}
- member of each element of the @code{args} array specifies the
- 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.
+The @code{admin_shutdown} function restarts the system. The
+@code{args} argument specifies alternate or optional behavior
+for the @code{admin_shutdown} function. The @code{admin_type}
+member of each element of the @code{args} array specifies the
+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.
@subheading NOTES:
+The @code{_POSIX_ADMIN} feature flag is defined to indicate
+this service is available.