/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

added configfile as a optional argument to plugin-runner

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">
7
6
]>
8
7
 
9
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
9
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
 
10
    <title>&COMMANDNAME;</title>
12
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
12
    <productname>&COMMANDNAME;</productname>
14
13
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
14
    <authorgroup>
17
15
      <author>
18
16
        <firstname>Björn</firstname>
67
65
  <refnamediv>
68
66
    <refname><command>&COMMANDNAME;</command></refname>
69
67
    <refpurpose>
70
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
71
69
    </refpurpose>
72
70
  </refnamediv>
73
71
 
74
72
  <refsynopsisdiv>
75
73
    <cmdsynopsis>
76
74
      <command>&COMMANDNAME;</command>
77
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
75
      <arg>--interface<arg choice="plain">IF</arg></arg>
78
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
80
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
84
82
    </cmdsynopsis>
85
83
    <cmdsynopsis>
86
84
      <command>&COMMANDNAME;</command>
87
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
85
      <arg>-i<arg choice="plain">IF</arg></arg>
88
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
90
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
143
141
 
144
142
    <variablelist>
145
143
      <varlistentry>
146
 
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
148
145
        <listitem>
149
146
          <para>
150
147
            Show a help message and exit
153
150
      </varlistentry>
154
151
 
155
152
      <varlistentry>
156
 
        <term><option>-i</option>
157
 
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
160
155
        <listitem>
161
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
162
157
        </listitem>
342
337
    <title>ENVIRONMENT</title>
343
338
    <variablelist>
344
339
      <varlistentry>
345
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
346
341
        <listitem>
347
342
          <para>
348
343
            To start the configured checker (see <xref
453
448
        Normal invocation needs no options:
454
449
      </para>
455
450
      <para>
456
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
457
452
      </para>
458
453
    </informalexample>
459
454
    <informalexample>
466
461
      <para>
467
462
 
468
463
<!-- do not wrap this line -->
469
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
470
465
 
471
466
      </para>
472
467
    </informalexample>
478
473
      <para>
479
474
 
480
475
<!-- do not wrap this line -->
481
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
482
477
 
483
478
      </para>
484
479
    </informalexample>
543
538
    <title>SEE ALSO</title>
544
539
    <para>
545
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
547
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
 
        <refentrytitle>mandos.conf</refentrytitle>
549
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
550
545
        <refentrytitle>password-request</refentrytitle>
551
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
552
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
577
572
      </varlistentry>
578
573
      <varlistentry>
579
574
        <term>
580
 
          <ulink url="http://www.gnu.org/software/gnutls/"
581
 
          >GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
582
577
        </term>
583
578
      <listitem>
584
579
        <para>
590
585
      </varlistentry>
591
586
      <varlistentry>
592
587
        <term>
593
 
          RFC 4291: <citetitle>IP Version 6 Addressing
594
 
          Architecture</citetitle>
 
588
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
589
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
590
          Unicast Addresses</citation>
595
591
        </term>
596
592
        <listitem>
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>
 
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>
621
599
        </listitem>
622
600
      </varlistentry>
623
601
      <varlistentry>
624
602
        <term>
625
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
626
 
          Protocol Version 1.1</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
627
605
        </term>
628
606
      <listitem>
629
607
        <para>
633
611
      </varlistentry>
634
612
      <varlistentry>
635
613
        <term>
636
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
637
616
        </term>
638
617
      <listitem>
639
618
        <para>
643
622
      </varlistentry>
644
623
      <varlistentry>
645
624
        <term>
646
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
647
 
          Security</citetitle>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
648
627
        </term>
649
628
      <listitem>
650
629
        <para>
656
635
    </variablelist>
657
636
  </refsect1>
658
637
</refentry>
659
 
<!-- Local Variables: -->
660
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
661
 
<!-- time-stamp-end: "[\"']>" -->
662
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
663
 
<!-- End: -->