/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.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2024-09-08 00:08:15 UTC
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2012-01-01">
 
6
<!ENTITY TIMESTAMP "2023-04-30">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
34
34
    <copyright>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
 
37
      <year>2010</year>
37
38
      <year>2011</year>
38
39
      <year>2012</year>
 
40
      <year>2013</year>
 
41
      <year>2014</year>
 
42
      <year>2015</year>
 
43
      <year>2016</year>
 
44
      <year>2017</year>
 
45
      <year>2018</year>
 
46
      <year>2019</year>
39
47
      <holder>Teddy Hogeborn</holder>
40
48
      <holder>Björn Påhlsson</holder>
41
49
    </copyright>
61
69
  <refsect1 id="description">
62
70
    <title>DESCRIPTION</title>
63
71
    <para>
64
 
      The file &CONFPATH; is a simple configuration file for
 
72
      The file &CONFPATH; is a configuration file for
65
73
      <citerefentry><refentrytitle>mandos</refentrytitle>
66
74
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
67
75
      startup.  The configuration file starts with <quote><literal
174
182
        </listitem>
175
183
      </varlistentry>
176
184
      
 
185
      <varlistentry>
 
186
        <term><option>socket<literal> = </literal><replaceable
 
187
        >NUMBER</replaceable></option></term>
 
188
        <listitem>
 
189
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
190
        </listitem>
 
191
      </varlistentry>
 
192
      
177
193
    </variablelist>
178
194
  </refsect1>
179
195
  
191
207
      built-in module <systemitem class="library">ConfigParser</systemitem>
192
208
      requires it.
193
209
    </para>
 
210
    <xi:include href="bugs.xml"/>
194
211
  </refsect1>
195
212
  
196
213
  <refsect1 id="example">
210
227
      <programlisting>
211
228
[DEFAULT]
212
229
# A configuration example
213
 
interface = eth0
 
230
interface = enp1s0
214
231
address = fe80::aede:48ff:fe71:f6f2
215
232
port = 1025
216
 
debug = true
217
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
233
debug = True
 
234
priority = SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA:!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA
218
235
servicename = Daena
219
236
use_dbus = False
220
237
use_ipv6 = True