source: rtems/doc/new_chapters/adminiface.t @ 571a915

4.104.114.84.95
Last change on this file since 571a915 was 571a915, checked in by Joel Sherrill <joel.sherrill@…>, on 08/25/98 at 22:09:13

Added some background and operations subsections.

  • Property mode set to 100644
File size: 2.4 KB
Line 
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
13The administration interface manager provides a portable
14interface for some system administrative functions.
15The capabilities in this manager were defined in the POSIX
161003.1h/D3 proposed standard titled @b{Services for Reliable,
17Available, and Serviceable Systems}.
18
19The directives provided by the administration interface manager are:
20
21@itemize @bullet
22@item @code{admin_shutdown} - Shutdown the system
23@end itemize
24
25@section Background
26
27@subsection admin_args Structure
28
29@example
30put structure here
31@end example
32
33@table @b
34@item admin_type
35This field ...
36
37@table @b
38@item ADMIN_AUTOBOOT
39This field ...
40
41@item ADMIN_HALT
42This field ...
43
44@item ADMIN_FAST
45This field ...
46
47@item ADMIN_IMMEDIATE
48This field ...
49
50@item ADMIN_ALTSYSTEM
51This field ...
52
53@item ADMIN_ALTCONFIG
54This field ...
55
56@item ADMIN_SYSDUMP
57This field ...
58
59@item ADMIN_INIT
60This field ...
61
62
63@end table
64
65@item admin_data
66This field ...
67
68@end table
69
70@section Operations
71
72@subsection Shutting Down the System
73
74@section Directives
75
76This section details the administration interface manager's directives.
77A subsection is dedicated to each of this manager's directives
78and describes the calling sequence, related constants, usage,
79and status codes.
80
81@page
82@subsection admin_shutdown - Shutdown the system
83
84@subheading CALLING SEQUENCE:
85
86@ifset is-C
87@example
88int admin_shutdown(
89  struct admin_args   *args[],
90  size_t               nargs
91);
92@end example
93@end ifset
94
95@ifset is-Ada
96@end ifset
97
98@subheading STATUS CODES:
99
100@table @b
101@item EINVAL
102An invalid argument was passed to the function call.
103
104@item EPERM
105The caller does not have appropriate permission for shutting down the
106system.
107
108@end table
109
110@subheading DESCRIPTION:
111
112The @code{admin_shutdown} function restarts the system.  The
113@code{args} argument specifies alternate or optional behavior
114for the @code{admin_shutdown} function.  The @code{admin_type}
115member of each element of the @code{args} array specifies the
116optional behavior to be performed.  There are some @code{admin_types}
117values that may provoke unspecified behavior.  The @code{nargs}
118argument specifies the length of the @code{args} array.
119
120@subheading NOTES:
121
122The @code{_POSIX_ADMIN} feature flag is defined to indicate
123this service is available.
Note: See TracBrowser for help on using the repository browser.