/mandos/trunk

To get this branch, use:
bzr branch /loggerhead/mandos/trunk
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY COMMANDNAME "mandos-monitor">
<!ENTITY TIMESTAMP "2019-02-10">
<!ENTITY % common SYSTEM "common.ent">
%common;
]>

<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
  <refentryinfo>
    <title>Mandos Manual</title>
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
    <productname>Mandos</productname>
    <productnumber>&version;</productnumber>
    <date>&TIMESTAMP;</date>
    <authorgroup>
      <author>
	<firstname>Björn</firstname>
	<surname>Påhlsson</surname>
	<address>
	  <email>belorn@recompile.se</email>
	</address>
      </author>
      <author>
	<firstname>Teddy</firstname>
	<surname>Hogeborn</surname>
	<address>
	  <email>teddy@recompile.se</email>
	</address>
      </author>
    </authorgroup>
    <copyright>
      <year>2010</year>
      <year>2011</year>
      <year>2012</year>
      <year>2013</year>
      <year>2014</year>
      <year>2015</year>
      <year>2016</year>
      <year>2017</year>
      <year>2018</year>
      <year>2019</year>
      <holder>Teddy Hogeborn</holder>
      <holder>Björn Påhlsson</holder>
    </copyright>
    <xi:include href="legalnotice.xml"/>
  </refentryinfo>
  
  <refmeta>
    <refentrytitle>&COMMANDNAME;</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  
  <refnamediv>
    <refname><command>&COMMANDNAME;</command></refname>
    <refpurpose>
      Text-based GUI to control the Mandos server.
    </refpurpose>
  </refnamediv>
  
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
    </cmdsynopsis>
  </refsynopsisdiv>
  
  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para>
      <command>&COMMANDNAME;</command> is an interactive program to
      monitor and control the operations of the Mandos server (see
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
      >8</manvolnum></citerefentry>).
    </para>
  </refsect1>
  
  <refsect1 id="purpose">
    <title>PURPOSE</title>
    <para>
      The purpose of this is to enable <emphasis>remote and unattended
      rebooting</emphasis> of client host computer with an
      <emphasis>encrypted root file system</emphasis>.  See <xref
      linkend="overview"/> for details.
    </para>
  </refsect1>
  
  <refsect1 id="overview">
    <title>OVERVIEW</title>
    <xi:include href="overview.xml"/>
    <para>
      This program is used to monitor and control the Mandos server.
      In particular, it can be used to approve Mandos clients which
      have been configured to require approval.  It also shows all
      significant events reported by the Mandos server.
    </para>
  </refsect1>
  
  <refsect1 id="keys">
    <title>KEYS</title>
    <para>
      This program is used to monitor and control the Mandos server.
      In particular, it can be used to approve Mandos clients which
      have been configured to require approval.  It also shows all
      significant events reported by the Mandos server.
    </para>
    <table>
      <title>Global Keys</title><tgroup cols="2"><thead>
      <row>
	<entry>Keys</entry>
	<entry>Function</entry>
      </row>
      </thead><tbody>
      <row>
	<entry>q, Q</entry>
	<entry>Quit</entry>
      </row>
      <row>
	<entry>Ctrl-L</entry>
	<entry>Redraw screen</entry>
      </row>
      <row>
	<entry>?, F1</entry>
	<entry>Show help</entry>
      </row>
      <row>
	<entry>l, D</entry>
	<entry>Toggle log window</entry>
      </row>
      <row>
	<entry>TAB</entry>
	<entry>Switch window</entry>
      </row>
      <row>
	<entry>w, i</entry>
	<entry>Toggle log window line wrap</entry>
      </row>
      <row>
	<entry>v</entry>
	<entry>Toggle verbose logging</entry>
      </row>
      <row>
	<entry>Up, Ctrl-P, k</entry>
	<entry>Move up a line</entry>
      </row>
      <row>
	<entry>Down, Ctrl-N, j</entry>
	<entry>Move down a line</entry>
      </row>
      <row>
	<entry>PageUp, Meta-V, b</entry>
	<entry>Move up a page</entry>
      </row>
      <row>
	<entry>PageDown, Ctrl-V, SPACE, f</entry>
	<entry>Move down a page</entry>
      </row>
    </tbody></tgroup></table>
    <table>
      <title>Client List Keys</title><tgroup cols="2"><thead>
      <row>
	<entry>Keys</entry>
	<entry>Function</entry>
      </row>
      </thead><tbody>
      <row>
	<entry>+</entry>
	<entry>Enable client</entry>
      </row>
      <row>
	<entry>-</entry>
	<entry>Disable client</entry>
      </row>
      <row>
	<entry>a</entry>
	<entry>Approve client</entry>
      </row>
      <row>
	<entry>d</entry>
	<entry>Deny client</entry>
      </row>
      <row>
	<entry>R, _, Ctrl-K</entry>
	<entry>Remove client</entry>
      </row>
      <row>
	<entry>s</entry>
	<entry>Start checker for client</entry>
      </row>
      <row>
	<entry>S</entry>
	<entry>Stop checker for client</entry>
      </row>
      <row>
	<entry>C</entry>
	<entry>Force a successful check for this client.</entry>
      </row>
    </tbody></tgroup></table>
  </refsect1>
  
  <refsect1 id="bugs">
    <title>BUGS</title>
    <para>
      This program can currently only be used to monitor and control a
      Mandos server with the default D-Bus bus name of
      <quote>se.recompile.Mandos</quote>.
    </para>
    <xi:include href="bugs.xml"/>
  </refsect1>
  
  <refsect1 id="example">
    <title>EXAMPLE</title>
    <informalexample>
      <para>
	This program takes no options:
      </para>
      <para>
	<userinput>&COMMANDNAME;</userinput>
      </para>
    </informalexample>
  </refsect1>
  
  <refsect1 id="security">
    <title>SECURITY</title>
    <para>
      This program must be permitted to access the Mandos server via
      the D-Bus interface.  This normally requires the root user, but
      could be configured otherwise by reconfiguring the D-Bus server.
    </para>
  </refsect1>
  
  <refsect1 id="see_also">
    <title>SEE ALSO</title>
    <para>
      <citerefentry><refentrytitle>intro</refentrytitle>
      <manvolnum>8mandos</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>mandos</refentrytitle>
      <manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>mandos-ctl</refentrytitle>
      <manvolnum>8</manvolnum></citerefentry>
    </para>
  </refsect1>
  
</refentry>
<!-- Local Variables: -->
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
<!-- time-stamp-end: "[\"']>" -->
<!-- time-stamp-format: "%:y-%02m-%02d" -->
<!-- End: -->