/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-monitor.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-07 01:44:44 UTC
  • mfrom: (24.1.93 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080907014444-cf4ilzndc0tbn8va
Merge & resolve.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY COMMANDNAME "mandos-monitor">
5
 
<!ENTITY TIMESTAMP "2011-02-27">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
 
]>
9
 
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
17
 
    <authorgroup>
18
 
      <author>
19
 
        <firstname>Björn</firstname>
20
 
        <surname>Påhlsson</surname>
21
 
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
23
 
        </address>
24
 
      </author>
25
 
      <author>
26
 
        <firstname>Teddy</firstname>
27
 
        <surname>Hogeborn</surname>
28
 
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
30
 
        </address>
31
 
      </author>
32
 
    </authorgroup>
33
 
    <copyright>
34
 
      <year>2010</year>
35
 
      <year>2011</year>
36
 
      <holder>Teddy Hogeborn</holder>
37
 
      <holder>Björn Påhlsson</holder>
38
 
    </copyright>
39
 
    <xi:include href="legalnotice.xml"/>
40
 
  </refentryinfo>
41
 
  
42
 
  <refmeta>
43
 
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
 
    <manvolnum>8</manvolnum>
45
 
  </refmeta>
46
 
  
47
 
  <refnamediv>
48
 
    <refname><command>&COMMANDNAME;</command></refname>
49
 
    <refpurpose>
50
 
      Text-based GUI to control the Mandos server.
51
 
    </refpurpose>
52
 
  </refnamediv>
53
 
  
54
 
  <refsynopsisdiv>
55
 
    <cmdsynopsis>
56
 
      <command>&COMMANDNAME;</command>
57
 
    </cmdsynopsis>
58
 
  </refsynopsisdiv>
59
 
  
60
 
  <refsect1 id="description">
61
 
    <title>DESCRIPTION</title>
62
 
    <para>
63
 
      <command>&COMMANDNAME;</command> is an interactive program to
64
 
      monitor and control the operations of the Mandos server (see
65
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
66
 
      >8</manvolnum></citerefentry>).
67
 
    </para>
68
 
  </refsect1>
69
 
  
70
 
  <refsect1 id="purpose">
71
 
    <title>PURPOSE</title>
72
 
    <para>
73
 
      The purpose of this is to enable <emphasis>remote and unattended
74
 
      rebooting</emphasis> of client host computer with an
75
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
76
 
      linkend="overview"/> for details.
77
 
    </para>
78
 
  </refsect1>
79
 
  
80
 
  <refsect1 id="overview">
81
 
    <title>OVERVIEW</title>
82
 
    <xi:include href="overview.xml"/>
83
 
    <para>
84
 
      This program is used to monitor and control the Mandos server.
85
 
      In particular, it can be used to approve Mandos clients which
86
 
      have been configured to require approval.  It also shows all
87
 
      significant events reported by the Mandos server.
88
 
    </para>
89
 
  </refsect1>
90
 
  
91
 
  <refsect1 id="keys">
92
 
    <title>KEYS</title>
93
 
    <para>
94
 
      This program is used to monitor and control the Mandos server.
95
 
      In particular, it can be used to approve Mandos clients which
96
 
      have been configured to require approval.  It also shows all
97
 
      significant events reported by the Mandos server.
98
 
    </para>
99
 
    <table>
100
 
      <title>Global Keys</title><tgroup cols="2"><thead>
101
 
      <row>
102
 
        <entry>Keys</entry>
103
 
        <entry>Function</entry>
104
 
      </row>
105
 
      </thead><tbody>
106
 
      <row>
107
 
        <entry>q, Q</entry>
108
 
        <entry>Quit</entry>
109
 
      </row>
110
 
      <row>
111
 
        <entry>Ctrl-L</entry>
112
 
        <entry>Redraw screen</entry>
113
 
      </row>
114
 
      <row>
115
 
        <entry>?, F1</entry>
116
 
        <entry>Show help</entry>
117
 
      </row>
118
 
      <row>
119
 
        <entry>l, D</entry>
120
 
        <entry>Toggle log window</entry>
121
 
      </row>
122
 
      <row>
123
 
        <entry>TAB</entry>
124
 
        <entry>Switch window</entry>
125
 
      </row>
126
 
      <row>
127
 
        <entry>w, i</entry>
128
 
        <entry>Toggle log window line wrap</entry>
129
 
      </row>
130
 
      <row>
131
 
        <entry>Up, Ctrl-P, k</entry>
132
 
        <entry>Move up a line</entry>
133
 
      </row>
134
 
      <row>
135
 
        <entry>Down, Ctrl-N, j</entry>
136
 
        <entry>Move down a line</entry>
137
 
      </row>
138
 
      <row>
139
 
        <entry>PageUp, Meta-V, b</entry>
140
 
        <entry>Move up a page</entry>
141
 
      </row>
142
 
      <row>
143
 
        <entry>PageDown, Ctrl-V, SPACE, f</entry>
144
 
        <entry>Move down a page</entry>
145
 
      </row>
146
 
    </tbody></tgroup></table>
147
 
    <table>
148
 
      <title>Client List Keys</title><tgroup cols="2"><thead>
149
 
      <row>
150
 
        <entry>Keys</entry>
151
 
        <entry>Function</entry>
152
 
      </row>
153
 
      </thead><tbody>
154
 
      <row>
155
 
        <entry>+</entry>
156
 
        <entry>Enable client</entry>
157
 
      </row>
158
 
      <row>
159
 
        <entry>-</entry>
160
 
        <entry>Disable client</entry>
161
 
      </row>
162
 
      <row>
163
 
        <entry>a</entry>
164
 
        <entry>Approve client</entry>
165
 
      </row>
166
 
      <row>
167
 
        <entry>d</entry>
168
 
        <entry>Deny client</entry>
169
 
      </row>
170
 
      <row>
171
 
        <entry>R, _, Ctrl-K</entry>
172
 
        <entry>Remove client</entry>
173
 
      </row>
174
 
      <row>
175
 
        <entry>s</entry>
176
 
        <entry>Start checker for client</entry>
177
 
      </row>
178
 
      <row>
179
 
        <entry>S</entry>
180
 
        <entry>Stop checker for client</entry>
181
 
      </row>
182
 
      <row>
183
 
        <entry>C</entry>
184
 
        <entry>Force a successful check for this client.</entry>
185
 
      </row>
186
 
    </tbody></tgroup></table>
187
 
  </refsect1>
188
 
  
189
 
  <refsect1 id="bugs">
190
 
    <title>BUGS</title>
191
 
    <para>
192
 
      This program can currently only be used to monitor and control a
193
 
      Mandos server with the default D-Bus service name of
194
 
      <quote>Mandos</quote>.
195
 
    </para>
196
 
  </refsect1>
197
 
  
198
 
  <refsect1 id="example">
199
 
    <title>EXAMPLE</title>
200
 
    <informalexample>
201
 
      <para>
202
 
        This program takes no options:
203
 
      </para>
204
 
      <para>
205
 
        <userinput>&COMMANDNAME;</userinput>
206
 
      </para>
207
 
    </informalexample>
208
 
  </refsect1>
209
 
  
210
 
  <refsect1 id="security">
211
 
    <title>SECURITY</title>
212
 
    <para>
213
 
      This program must be permitted to access the Mandos server via
214
 
      the D-Bus interface.  This normally requires the root user, but
215
 
      could be configured otherwise by reconfiguring the D-Bus server.
216
 
    </para>
217
 
  </refsect1>
218
 
  
219
 
  <refsect1 id="see_also">
220
 
    <title>SEE ALSO</title>
221
 
    <para>
222
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
223
 
      <manvolnum>8</manvolnum></citerefentry>,
224
 
      <citerefentry><refentrytitle>mandos-ctl</refentrytitle>
225
 
      <manvolnum>8</manvolnum></citerefentry>
226
 
    </para>
227
 
  </refsect1>
228
 
  
229
 
</refentry>
230
 
<!-- Local Variables: -->
231
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
232
 
<!-- time-stamp-end: "[\"']>" -->
233
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
234
 
<!-- End: -->