source: rtems/doc/new_chapters/adminiface.t @ 984e5c1d

4.104.114.84.9
Last change on this file since 984e5c1d was 984e5c1d, checked in by Wade A Smith <warm38@…>, on Aug 26, 1998 at 2:11:48 PM

Incorporated the "#include <admin.h>" statement in file

  • 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
88#include <admin.h>
89
90int admin_shutdown(
91  struct admin_args   *args[],
92  size_t               nargs
93);
94@end example
95@end ifset
96
97@ifset is-Ada
98@end ifset
99
100@subheading STATUS CODES:
101
102@table @b
103@item EINVAL
104An invalid argument was passed to the function call.
105
106@item EPERM
107The caller does not have appropriate permission for shutting down the
108system.
109
110@end table
111
112@subheading DESCRIPTION:
113
114The @code{admin_shutdown} function restarts the system.  The
115@code{args} argument specifies alternate or optional behavior
116for the @code{admin_shutdown} function.  The @code{admin_type}
117member of each element of the @code{args} array specifies the
118optional behavior to be performed.  There are some @code{admin_types}
119values that may provoke unspecified behavior.  The @code{nargs}
120argument specifies the length of the @code{args} array.
121
122@subheading NOTES:
123
124The @code{_POSIX_ADMIN} feature flag is defined to indicate
125this service is available.
Note: See TracBrowser for help on using the repository browser.