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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 18:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830184541-j8zru4q0rlz5a0hw
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.  Improve wording of "secfile"
             option.
  (EXPANSION): Improved wording slightly.

* mandos-options.xml (interface): Improve wording.

* mandos.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos">
 
6
<!ENTITY TIMESTAMP "2008-08-30">
6
7
]>
7
8
 
8
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
10
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
    <title>Mandos Manual</title>
11
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
 
13
    <productname>Mandos</productname>
13
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
14
16
    <authorgroup>
15
17
      <author>
16
18
        <firstname>Björn</firstname>
65
67
  <refnamediv>
66
68
    <refname><command>&COMMANDNAME;</command></refname>
67
69
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
70
      Gives encrypted passwords to authenticated Mandos clients
69
71
    </refpurpose>
70
72
  </refnamediv>
71
73
 
141
143
 
142
144
    <variablelist>
143
145
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
146
        <term><option>-h</option></term>
 
147
        <term><option>--help</option></term>
145
148
        <listitem>
146
149
          <para>
147
150
            Show a help message and exit
150
153
      </varlistentry>
151
154
 
152
155
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
154
 
        >NAME</replaceable></literal></term>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
 
158
        <term><option>--interface</option>
 
159
        <replaceable>NAME</replaceable></term>
155
160
        <listitem>
156
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
162
        </listitem>
337
342
    <title>ENVIRONMENT</title>
338
343
    <variablelist>
339
344
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
345
        <term><envar>PATH</envar></term>
341
346
        <listitem>
342
347
          <para>
343
348
            To start the configured checker (see <xref
448
453
        Normal invocation needs no options:
449
454
      </para>
450
455
      <para>
451
 
        <userinput>mandos</userinput>
 
456
        <userinput>&COMMANDNAME;</userinput>
452
457
      </para>
453
458
    </informalexample>
454
459
    <informalexample>
461
466
      <para>
462
467
 
463
468
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
469
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
470
 
466
471
      </para>
467
472
    </informalexample>
473
478
      <para>
474
479
 
475
480
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
481
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
482
 
478
483
      </para>
479
484
    </informalexample>
538
543
    <title>SEE ALSO</title>
539
544
    <para>
540
545
      <citerefentry>
 
546
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
547
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
541
548
        <refentrytitle>mandos.conf</refentrytitle>
542
549
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
550
        <refentrytitle>password-request</refentrytitle>
546
551
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
552
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
651
656
    </variablelist>
652
657
  </refsect1>
653
658
</refentry>
 
659
<!-- Local Variables: -->
 
660
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
661
<!-- time-stamp-end: "[\"']>" -->
 
662
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
663
<!-- End: -->