/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 19:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              options.

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
 
72
74
  <refsynopsisdiv>
73
75
    <cmdsynopsis>
74
76
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
76
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
80
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
81
 
      <arg>--debug</arg>
82
 
    </cmdsynopsis>
83
 
    <cmdsynopsis>
84
 
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">IF</arg></arg>
86
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
90
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
91
 
      <arg>--debug</arg>
 
77
      <group>
 
78
        <arg choice="plain"><option>--interface
 
79
        <replaceable>NAME</replaceable></option></arg>
 
80
        <arg choice="plain"><option>-i
 
81
        <replaceable>NAME</replaceable></option></arg>
 
82
      </group>
 
83
      <sbr/>
 
84
      <group>
 
85
        <arg choice="plain"><option>--address
 
86
        <replaceable>ADDRESS</replaceable></option></arg>
 
87
        <arg choice="plain"><option>-a
 
88
        <replaceable>ADDRESS</replaceable></option></arg>
 
89
      </group>
 
90
      <sbr/>
 
91
      <group>
 
92
        <arg choice="plain"><option>--port
 
93
        <replaceable>PORT</replaceable></option></arg>
 
94
        <arg choice="plain"><option>-p
 
95
        <replaceable>PORT</replaceable></option></arg>
 
96
      </group>
 
97
      <sbr/>
 
98
      <arg><option>--priority
 
99
      <replaceable>PRIORITY</replaceable></option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--servicename
 
102
      <replaceable>NAME</replaceable></option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--configdir
 
105
      <replaceable>DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--debug</option></arg>
92
108
    </cmdsynopsis>
93
109
    <cmdsynopsis>
94
110
      <command>&COMMANDNAME;</command>
95
111
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
112
        <arg choice="plain"><option>-h</option></arg>
 
113
        <arg choice="plain"><option>--help</option></arg>
98
114
      </group>
99
115
    </cmdsynopsis>
100
116
    <cmdsynopsis>
101
117
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
118
      <arg choice="plain"><option>--version</option></arg>
103
119
    </cmdsynopsis>
104
120
    <cmdsynopsis>
105
121
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
122
      <arg choice="plain"><option>--check</option></arg>
107
123
    </cmdsynopsis>
108
124
  </refsynopsisdiv>
109
125
 
141
157
 
142
158
    <variablelist>
143
159
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
160
        <term><option>-h</option></term>
 
161
        <term><option>--help</option></term>
145
162
        <listitem>
146
163
          <para>
147
164
            Show a help message and exit
150
167
      </varlistentry>
151
168
 
152
169
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
170
        <term><option>-i</option>
 
171
        <replaceable>NAME</replaceable></term>
 
172
        <term><option>--interface</option>
 
173
        <replaceable>NAME</replaceable></term>
155
174
        <listitem>
156
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
176
        </listitem>
337
356
    <title>ENVIRONMENT</title>
338
357
    <variablelist>
339
358
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
359
        <term><envar>PATH</envar></term>
341
360
        <listitem>
342
361
          <para>
343
362
            To start the configured checker (see <xref
448
467
        Normal invocation needs no options:
449
468
      </para>
450
469
      <para>
451
 
        <userinput>mandos</userinput>
 
470
        <userinput>&COMMANDNAME;</userinput>
452
471
      </para>
453
472
    </informalexample>
454
473
    <informalexample>
461
480
      <para>
462
481
 
463
482
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
483
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
484
 
466
485
      </para>
467
486
    </informalexample>
473
492
      <para>
474
493
 
475
494
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
495
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
496
 
478
497
      </para>
479
498
    </informalexample>
538
557
    <title>SEE ALSO</title>
539
558
    <para>
540
559
      <citerefentry>
 
560
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
561
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
541
562
        <refentrytitle>mandos.conf</refentrytitle>
542
563
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
564
        <refentrytitle>password-request</refentrytitle>
546
565
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
566
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
572
591
      </varlistentry>
573
592
      <varlistentry>
574
593
        <term>
575
 
          <ulink
576
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
594
          <ulink url="http://www.gnu.org/software/gnutls/"
 
595
          >GnuTLS</ulink>
577
596
        </term>
578
597
      <listitem>
579
598
        <para>
585
604
      </varlistentry>
586
605
      <varlistentry>
587
606
        <term>
588
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
 
          Unicast Addresses</citation>
 
607
          RFC 4291: <citetitle>IP Version 6 Addressing
 
608
          Architecture</citetitle>
591
609
        </term>
592
610
        <listitem>
593
 
          <para>
594
 
            The clients use IPv6 link-local addresses, which are
595
 
            immediately usable since a link-local addresses is
596
 
            automatically assigned to a network interfaces when it is
597
 
            brought up.
598
 
          </para>
 
611
          <variablelist>
 
612
            <varlistentry>
 
613
              <term>Section 2.2: <citetitle>Text Representation of
 
614
              Addresses</citetitle></term>
 
615
              <listitem><para/></listitem>
 
616
            </varlistentry>
 
617
            <varlistentry>
 
618
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
619
              Address</citetitle></term>
 
620
              <listitem><para/></listitem>
 
621
            </varlistentry>
 
622
            <varlistentry>
 
623
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
624
            Addresses</citetitle></term>
 
625
            <listitem>
 
626
              <para>
 
627
                The clients use IPv6 link-local addresses, which are
 
628
                immediately usable since a link-local addresses is
 
629
                automatically assigned to a network interfaces when it
 
630
                is brought up.
 
631
              </para>
 
632
            </listitem>
 
633
            </varlistentry>
 
634
          </variablelist>
599
635
        </listitem>
600
636
      </varlistentry>
601
637
      <varlistentry>
602
638
        <term>
603
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
604
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
639
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
640
          Protocol Version 1.1</citetitle>
605
641
        </term>
606
642
      <listitem>
607
643
        <para>
611
647
      </varlistentry>
612
648
      <varlistentry>
613
649
        <term>
614
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
615
 
          Format</citetitle></citation>
 
650
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
616
651
        </term>
617
652
      <listitem>
618
653
        <para>
622
657
      </varlistentry>
623
658
      <varlistentry>
624
659
        <term>
625
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
626
 
          Transport Layer Security</citetitle></citation>
 
660
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
661
          Security</citetitle>
627
662
        </term>
628
663
      <listitem>
629
664
        <para>
635
670
    </variablelist>
636
671
  </refsect1>
637
672
</refentry>
 
673
<!-- Local Variables: -->
 
674
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
675
<!-- time-stamp-end: "[\"']>" -->
 
676
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
677
<!-- End: -->