/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 17:16:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830171633-rjyuhsemikw6lg2w
* mandos-keygen.xml (SYNOPSIS): Fixed tags.  Unify short and long
                                options.
* plugins.d/password-request.xml (SYNOPSIS): - '' -

* mandos-clients.conf.xml: Removed extra white space.
* plugin-runner.xml: - '' -
* plugins.d/password-prompt.xml: - '' -
* mandos-keygen.xml: - '' -
* plugins.d/password-request.xml: - '' -

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>
 
77
      <arg>--interface<arg choice="plain">NAME</arg></arg>
76
78
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
79
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
80
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
82
84
    </cmdsynopsis>
83
85
    <cmdsynopsis>
84
86
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">IF</arg></arg>
 
87
      <arg>-i<arg choice="plain">NAME</arg></arg>
86
88
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
89
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
90
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
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
 
        IF</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>
572
577
      </varlistentry>
573
578
      <varlistentry>
574
579
        <term>
575
 
          <ulink
576
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
580
          <ulink url="http://www.gnu.org/software/gnutls/"
 
581
          >GnuTLS</ulink>
577
582
        </term>
578
583
      <listitem>
579
584
        <para>
585
590
      </varlistentry>
586
591
      <varlistentry>
587
592
        <term>
588
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
 
          Unicast Addresses</citation>
 
593
          RFC 4291: <citetitle>IP Version 6 Addressing
 
594
          Architecture</citetitle>
591
595
        </term>
592
596
        <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>
 
597
          <variablelist>
 
598
            <varlistentry>
 
599
              <term>Section 2.2: <citetitle>Text Representation of
 
600
              Addresses</citetitle></term>
 
601
              <listitem><para/></listitem>
 
602
            </varlistentry>
 
603
            <varlistentry>
 
604
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
605
              Address</citetitle></term>
 
606
              <listitem><para/></listitem>
 
607
            </varlistentry>
 
608
            <varlistentry>
 
609
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
610
            Addresses</citetitle></term>
 
611
            <listitem>
 
612
              <para>
 
613
                The clients use IPv6 link-local addresses, which are
 
614
                immediately usable since a link-local addresses is
 
615
                automatically assigned to a network interfaces when it
 
616
                is brought up.
 
617
              </para>
 
618
            </listitem>
 
619
            </varlistentry>
 
620
          </variablelist>
599
621
        </listitem>
600
622
      </varlistentry>
601
623
      <varlistentry>
602
624
        <term>
603
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
604
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
625
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
626
          Protocol Version 1.1</citetitle>
605
627
        </term>
606
628
      <listitem>
607
629
        <para>
611
633
      </varlistentry>
612
634
      <varlistentry>
613
635
        <term>
614
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
615
 
          Format</citetitle></citation>
 
636
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
616
637
        </term>
617
638
      <listitem>
618
639
        <para>
622
643
      </varlistentry>
623
644
      <varlistentry>
624
645
        <term>
625
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
626
 
          Transport Layer Security</citetitle></citation>
 
646
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
647
          Security</citetitle>
627
648
        </term>
628
649
      <listitem>
629
650
        <para>
635
656
    </variablelist>
636
657
  </refsect1>
637
658
</refentry>
 
659
<!-- Local Variables: -->
 
660
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
661
<!-- time-stamp-end: "[\"']>" -->
 
662
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
663
<!-- End: -->