/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
72
72
  <refsynopsisdiv>
73
73
    <cmdsynopsis>
74
74
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
75
      <arg>--interface<arg choice="plain">IF</arg></arg>
76
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
82
82
    </cmdsynopsis>
83
83
    <cmdsynopsis>
84
84
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
85
      <arg>-i<arg choice="plain">IF</arg></arg>
86
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
150
150
      </varlistentry>
151
151
 
152
152
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
154
 
        >NAME</replaceable></literal></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
155
155
        <listitem>
156
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
157
        </listitem>
536
536
 
537
537
  <refsect1 id="see_also">
538
538
    <title>SEE ALSO</title>
539
 
    <para>
540
 
      <citerefentry>
541
 
        <refentrytitle>mandos.conf</refentrytitle>
542
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>password-request</refentrytitle>
546
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
548
 
      </citerefentry>
549
 
    </para>
550
539
    <variablelist>
551
540
      <varlistentry>
552
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>
553
558
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
554
559
        </term>
555
560
        <listitem>
572
577
      </varlistentry>
573
578
      <varlistentry>
574
579
        <term>
575
 
          <ulink url="http://www.gnu.org/software/gnutls/"
576
 
          >GnuTLS</ulink>
 
580
          <ulink
 
581
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
577
582
        </term>
578
583
      <listitem>
579
584
        <para>
585
590
      </varlistentry>
586
591
      <varlistentry>
587
592
        <term>
588
 
          RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          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>
590
596
        </term>
591
597
        <listitem>
592
 
          <variablelist>
593
 
            <varlistentry>
594
 
              <term>Section 2.2: <citetitle>Text Representation of
595
 
              Addresses</citetitle></term>
596
 
              <listitem><para/></listitem>
597
 
            </varlistentry>
598
 
            <varlistentry>
599
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
600
 
              Address</citetitle></term>
601
 
              <listitem><para/></listitem>
602
 
            </varlistentry>
603
 
            <varlistentry>
604
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
605
 
            Addresses</citetitle></term>
606
 
            <listitem>
607
 
              <para>
608
 
                The clients use IPv6 link-local addresses, which are
609
 
                immediately usable since a link-local addresses is
610
 
                automatically assigned to a network interfaces when it
611
 
                is brought up.
612
 
              </para>
613
 
            </listitem>
614
 
            </varlistentry>
615
 
          </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>
616
604
        </listitem>
617
605
      </varlistentry>
618
606
      <varlistentry>
619
607
        <term>
620
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
621
 
          Protocol Version 1.1</citetitle>
 
608
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
609
          (TLS) Protocol Version 1.1</citetitle></citation>
622
610
        </term>
623
611
      <listitem>
624
612
        <para>
628
616
      </varlistentry>
629
617
      <varlistentry>
630
618
        <term>
631
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
619
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
620
          Format</citetitle></citation>
632
621
        </term>
633
622
      <listitem>
634
623
        <para>
638
627
      </varlistentry>
639
628
      <varlistentry>
640
629
        <term>
641
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
642
 
          Security</citetitle>
 
630
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
631
          Transport Layer Security</citetitle></citation>
643
632
        </term>
644
633
      <listitem>
645
634
        <para>