/mandos/release

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