/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-29 07:30:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829073017-tvryowganbf75zp5
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
                                      man-pages(7).
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml (SEE ALSO): Changed from an
                                             <itemizedlist> to a
                                             <para>, as per
                                             man-pages(7).  Also
                                             alphabetize.

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-29">
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>
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>
150
152
      </varlistentry>
151
153
 
152
154
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
155
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
156
        >NAME</replaceable></literal></term>
155
157
        <listitem>
156
158
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
159
        </listitem>
274
276
        <entry>-><!-- &rarr; --></entry>
275
277
      </row>
276
278
      <row>
277
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
279
        <entry><quote><literal>1\r\n</literal></quote></entry>
278
280
        <entry>-><!-- &rarr; --></entry>
279
281
      </row>
280
282
      <row>
310
312
      longer eligible to receive the encrypted password.  The timeout,
311
313
      checker program, and interval between checks can be configured
312
314
      both globally and per client; see <citerefentry>
313
 
      <refentrytitle>mandos.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
315
315
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
316
      <manvolnum>5</manvolnum></citerefentry>.
317
317
    </para>
320
320
  <refsect1 id="logging">
321
321
    <title>LOGGING</title>
322
322
    <para>
323
 
      The server will send log messaged with various severity levels
324
 
      to <filename>/dev/log</filename>.  With the
 
323
      The server will send log message with various severity levels to
 
324
      <filename>/dev/log</filename>.  With the
325
325
      <option>--debug</option> option, it will log even more messages,
326
326
      and also show them on the console.
327
327
    </para>
348
348
            <varname>PATH</varname> to search for matching commands if
349
349
            an absolute path is not given.  See <citerefentry>
350
350
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
351
 
          </citerefentry>
 
351
            </citerefentry>.
352
352
          </para>
353
353
        </listitem>
354
354
      </varlistentry>
450
450
        Normal invocation needs no options:
451
451
      </para>
452
452
      <para>
453
 
        <userinput>mandos</userinput>
 
453
        <userinput>&COMMANDNAME;</userinput>
454
454
      </para>
455
455
    </informalexample>
456
456
    <informalexample>
463
463
      <para>
464
464
 
465
465
<!-- do not wrap this line -->
466
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
466
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
467
467
 
468
468
      </para>
469
469
    </informalexample>
475
475
      <para>
476
476
 
477
477
<!-- do not wrap this line -->
478
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
478
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
479
479
 
480
480
      </para>
481
481
    </informalexample>
538
538
 
539
539
  <refsect1 id="see_also">
540
540
    <title>SEE ALSO</title>
 
541
    <para>
 
542
      <citerefentry>
 
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
545
        <refentrytitle>mandos.conf</refentrytitle>
 
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
547
        <refentrytitle>password-request</refentrytitle>
 
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
550
      </citerefentry>
 
551
    </para>
541
552
    <variablelist>
542
553
      <varlistentry>
543
554
        <term>
544
 
          <citerefentry>
545
 
            <refentrytitle>password-request</refentrytitle>
546
 
            <manvolnum>8mandos</manvolnum>
547
 
          </citerefentry>
548
 
        </term>
549
 
        <listitem>
550
 
          <para>
551
 
            This is the actual program which talks to this server.
552
 
            Note that it is normally not invoked directly, and is only
553
 
            run in the initial RAM disk environment, and not on a
554
 
            fully started system.
555
 
          </para>
556
 
        </listitem>
557
 
      </varlistentry>
558
 
      <varlistentry>
559
 
        <term>
560
555
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
561
556
        </term>
562
557
        <listitem>
579
574
      </varlistentry>
580
575
      <varlistentry>
581
576
        <term>
582
 
          <ulink
583
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
577
          <ulink url="http://www.gnu.org/software/gnutls/"
 
578
          >GnuTLS</ulink>
584
579
        </term>
585
580
      <listitem>
586
581
        <para>
592
587
      </varlistentry>
593
588
      <varlistentry>
594
589
        <term>
595
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
596
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
597
 
          Unicast Addresses</citation>
 
590
          RFC 4291: <citetitle>IP Version 6 Addressing
 
591
          Architecture</citetitle>
598
592
        </term>
599
593
        <listitem>
600
 
          <para>
601
 
            The clients use IPv6 link-local addresses, which are
602
 
            immediately usable since a link-local addresses is
603
 
            automatically assigned to a network interfaces when it is
604
 
            brought up.
605
 
          </para>
 
594
          <variablelist>
 
595
            <varlistentry>
 
596
              <term>Section 2.2: <citetitle>Text Representation of
 
597
              Addresses</citetitle></term>
 
598
              <listitem><para/></listitem>
 
599
            </varlistentry>
 
600
            <varlistentry>
 
601
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
602
              Address</citetitle></term>
 
603
              <listitem><para/></listitem>
 
604
            </varlistentry>
 
605
            <varlistentry>
 
606
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
607
            Addresses</citetitle></term>
 
608
            <listitem>
 
609
              <para>
 
610
                The clients use IPv6 link-local addresses, which are
 
611
                immediately usable since a link-local addresses is
 
612
                automatically assigned to a network interfaces when it
 
613
                is brought up.
 
614
              </para>
 
615
            </listitem>
 
616
            </varlistentry>
 
617
          </variablelist>
606
618
        </listitem>
607
619
      </varlistentry>
608
620
      <varlistentry>
609
621
        <term>
610
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
611
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
622
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
623
          Protocol Version 1.1</citetitle>
612
624
        </term>
613
625
      <listitem>
614
626
        <para>
618
630
      </varlistentry>
619
631
      <varlistentry>
620
632
        <term>
621
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
622
 
          Format</citetitle></citation>
 
633
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
623
634
        </term>
624
635
      <listitem>
625
636
        <para>
629
640
      </varlistentry>
630
641
      <varlistentry>
631
642
        <term>
632
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
633
 
          Transport Layer Security</citetitle></citation>
 
643
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
644
          Security</citetitle>
634
645
        </term>
635
646
      <listitem>
636
647
        <para>
642
653
    </variablelist>
643
654
  </refsect1>
644
655
</refentry>
 
656
<!-- Local Variables: -->
 
657
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
658
<!-- time-stamp-end: "[\"']>" -->
 
659
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
660
<!-- End: -->