diff options
author | Wade A Smith <warm38@juno.com> | 1998-08-10 14:54:01 +0000 |
---|---|---|
committer | Wade A Smith <warm38@juno.com> | 1998-08-10 14:54:01 +0000 |
commit | b044905b12775fb7327a269180f485cd60d6f5ed (patch) | |
tree | 33c16be24f2c22a18a6f79c8ee1a4b3ca05bacff /doc/new_chapters | |
parent | Documented the following Event Logging routines: (diff) | |
download | rtems-b044905b12775fb7327a269180f485cd60d6f5ed.tar.bz2 |
Documented the admin_shutdown function
Diffstat (limited to 'doc/new_chapters')
-rw-r--r-- | doc/new_chapters/adminiface.t | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/doc/new_chapters/adminiface.t b/doc/new_chapters/adminiface.t index 0340abf8c6..32d327a318 100644 --- a/doc/new_chapters/adminiface.t +++ b/doc/new_chapters/adminiface.t @@ -16,7 +16,7 @@ administration interface manager is ... The directives provided by the administration interface manager are: @itemize @bullet -@item @code{admin_shutdown} - +@item @code{admin_shutdown} - Shutdown the system @end itemize @section Background @@ -31,13 +31,15 @@ and describes the calling sequence, related constants, usage, and status codes. @page -@subsection admin_shutdown - +@subsection admin_shutdown - Shutdown the system @subheading CALLING SEQUENCE: @ifset is-C @example int admin_shutdown( + struct admin_args_ *args[], + size_t nargs ); @end example @end ifset @@ -48,12 +50,19 @@ int admin_shutdown( @subheading STATUS CODES: @table @b -@item E -The +@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. @end table @subheading DESCRIPTION: +The @code{admin_shutdown} function restarts the system. + @subheading NOTES: |