/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-19 23:44:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819234417-8dz5prw19ihrklx6
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
                           commands here, and use it everywhere.
  (mandos.8, mandos.conf.5): New; also depend on "mandos-options.xml".

* mandos-keygen.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OVERVIEW): Changed to do <xi:include/>.

* mandos-options.xml (<simplesect>): Changed to a <section>.
  ([@id="address"]): Reordered sentences.

* mandos.conf.xml (OPTIONS): Removed illegal <arg> tags.
  (EXAMPLE): Added empty example.

* mandos.xml (NETWORK PROTOCOL): Bug fix: Changed "1\r\en" back to
                                 "1\r\n".
  (CHECKING): Do not refer to the non-relevant mandos.conf(5) manual.

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">
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>
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>
152
150
      </varlistentry>
153
151
 
154
152
      <varlistentry>
155
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
156
 
        >NAME</replaceable></literal></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
157
155
        <listitem>
158
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
159
157
        </listitem>
450
448
        Normal invocation needs no options:
451
449
      </para>
452
450
      <para>
453
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
454
452
      </para>
455
453
    </informalexample>
456
454
    <informalexample>
463
461
      <para>
464
462
 
465
463
<!-- do not wrap this line -->
466
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
467
465
 
468
466
      </para>
469
467
    </informalexample>
475
473
      <para>
476
474
 
477
475
<!-- do not wrap this line -->
478
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
479
477
 
480
478
      </para>
481
479
    </informalexample>
538
536
 
539
537
  <refsect1 id="see_also">
540
538
    <title>SEE ALSO</title>
541
 
    <para>
542
 
      <citerefentry>
543
 
        <refentrytitle>mandos.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>mandos-clients.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>
552
539
    <variablelist>
553
540
      <varlistentry>
554
541
        <term>
 
542
          <citerefentry>
 
543
            <refentrytitle>password-request</refentrytitle>
 
544
            <manvolnum>8mandos</manvolnum>
 
545
          </citerefentry>
 
546
        </term>
 
547
        <listitem>
 
548
          <para>
 
549
            This is the actual program which talks to this server.
 
550
            Note that it is normally not invoked directly, and is only
 
551
            run in the initial RAM disk environment, and not on a
 
552
            fully started system.
 
553
          </para>
 
554
        </listitem>
 
555
      </varlistentry>
 
556
      <varlistentry>
 
557
        <term>
555
558
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
556
559
        </term>
557
560
        <listitem>
574
577
      </varlistentry>
575
578
      <varlistentry>
576
579
        <term>
577
 
          <ulink url="http://www.gnu.org/software/gnutls/"
578
 
          >GnuTLS</ulink>
 
580
          <ulink
 
581
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
579
582
        </term>
580
583
      <listitem>
581
584
        <para>
587
590
      </varlistentry>
588
591
      <varlistentry>
589
592
        <term>
590
 
          RFC 4291: <citetitle>IP Version 6 Addressing
591
 
          Architecture</citetitle>
 
593
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
594
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
595
          Unicast Addresses</citation>
592
596
        </term>
593
597
        <listitem>
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>
 
598
          <para>
 
599
            The clients use IPv6 link-local addresses, which are
 
600
            immediately usable since a link-local addresses is
 
601
            automatically assigned to a network interfaces when it is
 
602
            brought up.
 
603
          </para>
618
604
        </listitem>
619
605
      </varlistentry>
620
606
      <varlistentry>
621
607
        <term>
622
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
 
          Protocol Version 1.1</citetitle>
 
608
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
609
          (TLS) Protocol Version 1.1</citetitle></citation>
624
610
        </term>
625
611
      <listitem>
626
612
        <para>
630
616
      </varlistentry>
631
617
      <varlistentry>
632
618
        <term>
633
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
619
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
620
          Format</citetitle></citation>
634
621
        </term>
635
622
      <listitem>
636
623
        <para>
640
627
      </varlistentry>
641
628
      <varlistentry>
642
629
        <term>
643
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
644
 
          Security</citetitle>
 
630
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
631
          Transport Layer Security</citetitle></citation>
645
632
        </term>
646
633
      <listitem>
647
634
        <para>
653
640
    </variablelist>
654
641
  </refsect1>
655
642
</refentry>
656
 
<!-- Local Variables: -->
657
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
658
 
<!-- time-stamp-end: "[\"']>" -->
659
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
660
 
<!-- End: -->