summaryrefslogtreecommitdiffstats
path: root/doc/new_chapters/adminiface.t
blob: 83f8c539ee3b8563732dfa0d35961cf39ed466e9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
@c
@c  COPYRIGHT (c) 1988-1998.
@c  On-Line Applications Research Corporation (OAR).
@c  All rights reserved. 
@c
@c  $Id$
@c

@chapter Administration Interface Manager

@section Introduction

The 
administration interface manager is ...

The directives provided by the administration interface manager are:

@itemize @bullet
@item @code{admin_shutdown} - Shutdown the system
@end itemize

@section Background

@section Operations

@section Directives

This section details the administration interface manager's directives.
A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.

@page
@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

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@table @b
@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:


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: