/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor.xml

* debian/mandos-client.README.Debian: Improved wording and formatting.
                                      Updated location of nfsroot.txt.
* debian/mandos.README.Debian: Improved wording and formatting.

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