[832e33c] | 1 | @c |
---|
| 2 | @c COPYRIGHT (c) 1988-1998. |
---|
| 3 | @c On-Line Applications Research Corporation (OAR). |
---|
| 4 | @c All rights reserved. |
---|
| 5 | @c |
---|
| 6 | @c $Id$ |
---|
| 7 | @c |
---|
| 8 | |
---|
| 9 | @chapter Administration Interface Manager |
---|
| 10 | |
---|
| 11 | @section Introduction |
---|
| 12 | |
---|
[d1a859c] | 13 | The administration interface manager provides a portable |
---|
| 14 | interface for some system administrative functions. |
---|
| 15 | The capabilities in this manager were defined in the POSIX |
---|
| 16 | 1003.1h/D3 proposed standard titled @b{Services for Reliable, |
---|
| 17 | Available, and Serviceable Systems}. |
---|
[832e33c] | 18 | |
---|
| 19 | The directives provided by the administration interface manager are: |
---|
| 20 | |
---|
| 21 | @itemize @bullet |
---|
[b044905b] | 22 | @item @code{admin_shutdown} - Shutdown the system |
---|
[832e33c] | 23 | @end itemize |
---|
| 24 | |
---|
| 25 | @section Background |
---|
| 26 | |
---|
[d1a859c] | 27 | @subsection admin_args Structure |
---|
| 28 | |
---|
| 29 | @example |
---|
| 30 | put structure here |
---|
| 31 | @end example |
---|
| 32 | |
---|
| 33 | @table @b |
---|
| 34 | @item admin_type |
---|
| 35 | This field ... |
---|
| 36 | |
---|
| 37 | @table @b |
---|
| 38 | @item ADMIN_AUTOBOOT |
---|
| 39 | This field ... |
---|
| 40 | |
---|
| 41 | @item ADMIN_HALT |
---|
| 42 | This field ... |
---|
| 43 | |
---|
| 44 | @item ADMIN_FAST |
---|
| 45 | This field ... |
---|
| 46 | |
---|
| 47 | @item ADMIN_IMMEDIATE |
---|
| 48 | This field ... |
---|
| 49 | |
---|
| 50 | @item ADMIN_ALTSYSTEM |
---|
| 51 | This field ... |
---|
| 52 | |
---|
| 53 | @item ADMIN_ALTCONFIG |
---|
| 54 | This field ... |
---|
| 55 | |
---|
| 56 | @item ADMIN_SYSDUMP |
---|
| 57 | This field ... |
---|
| 58 | |
---|
| 59 | @item ADMIN_INIT |
---|
| 60 | This field ... |
---|
| 61 | |
---|
| 62 | |
---|
| 63 | @end table |
---|
| 64 | |
---|
| 65 | @item admin_data |
---|
| 66 | This field ... |
---|
| 67 | |
---|
| 68 | @end table |
---|
| 69 | |
---|
[832e33c] | 70 | @section Operations |
---|
| 71 | |
---|
[571a915] | 72 | @subsection Shutting Down the System |
---|
| 73 | |
---|
[832e33c] | 74 | @section Directives |
---|
| 75 | |
---|
| 76 | This section details the administration interface manager's directives. |
---|
| 77 | A subsection is dedicated to each of this manager's directives |
---|
| 78 | and describes the calling sequence, related constants, usage, |
---|
| 79 | and status codes. |
---|
| 80 | |
---|
| 81 | @page |
---|
[b044905b] | 82 | @subsection admin_shutdown - Shutdown the system |
---|
[832e33c] | 83 | |
---|
| 84 | @subheading CALLING SEQUENCE: |
---|
| 85 | |
---|
| 86 | @ifset is-C |
---|
| 87 | @example |
---|
[984e5c1d] | 88 | #include <admin.h> |
---|
| 89 | |
---|
[832e33c] | 90 | int admin_shutdown( |
---|
[d1a859c] | 91 | struct admin_args *args[], |
---|
| 92 | size_t nargs |
---|
[832e33c] | 93 | ); |
---|
| 94 | @end example |
---|
| 95 | @end ifset |
---|
| 96 | |
---|
| 97 | @ifset is-Ada |
---|
| 98 | @end ifset |
---|
| 99 | |
---|
| 100 | @subheading STATUS CODES: |
---|
| 101 | |
---|
[16bed8a] | 102 | @table @b |
---|
[b044905b] | 103 | @item EINVAL |
---|
| 104 | An invalid argument was passed to the function call. |
---|
[d1a859c] | 105 | |
---|
[b044905b] | 106 | @item EPERM |
---|
| 107 | The caller does not have appropriate permission for shutting down the |
---|
| 108 | system. |
---|
[16bed8a] | 109 | |
---|
| 110 | @end table |
---|
| 111 | |
---|
[832e33c] | 112 | @subheading DESCRIPTION: |
---|
| 113 | |
---|
[d1a859c] | 114 | The @code{admin_shutdown} function restarts the system. The |
---|
| 115 | @code{args} argument specifies alternate or optional behavior |
---|
| 116 | for the @code{admin_shutdown} function. The @code{admin_type} |
---|
| 117 | member of each element of the @code{args} array specifies the |
---|
[142f6a5] | 118 | optional behavior to be performed. There are some @code{admin_types} |
---|
[d1a859c] | 119 | values that may provoke unspecified behavior. The @code{nargs} |
---|
| 120 | argument specifies the length of the @code{args} array. |
---|
[b044905b] | 121 | |
---|
[832e33c] | 122 | @subheading NOTES: |
---|
| 123 | |
---|
[d1a859c] | 124 | The @code{_POSIX_ADMIN} feature flag is defined to indicate |
---|
| 125 | this service is available. |
---|