diff options
| -rw-r--r-- | doc/new_chapters/adminiface.t | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/new_chapters/adminiface.t b/doc/new_chapters/adminiface.t index 32d327a318..83f8c539ee 100644 --- a/doc/new_chapters/adminiface.t +++ b/doc/new_chapters/adminiface.t @@ -62,7 +62,20 @@ system. @subheading DESCRIPTION: -The @code{admin_shutdown} function restarts the system. + +If {_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. @subheading NOTES: |