/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: 2016-02-29 21:28:39 UTC
  • mto: This revision was merged to the branch mainline in revision 814.
  • Revision ID: teddy@recompile.se-20160229212839-hoz3rw1us3uds68n
Tags: version-1.7.3-1
* Makefile (version): Changed to "1.7.3".
* NEWS (Version 1.7.3): New entry.
* debian/changelog (1.7.3-1): - '' -

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