/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: 2015-08-02 16:57:09 UTC
  • Revision ID: teddy@recompile.se-20150802165709-k0vuxe3vjph3n5ss
Deprecate the D-Bus property "se.recompile.Mandos.Client.ObjectPath".

The D-Bus property "se.recompile.Mandos.Client.ObjectPath" is
unnecessary - is not used by mandos-monitor or mandos-ctl, and I
cannot see it being useful for anyone.

* DBUS-API (se.recompile.Mandos.Client.ObjectPath): Remove;
                                                    deprecated.
* mandos (ClientDBus.ObjectPath_dbus_property): Annotate as
                                                deprecated.

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