/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 05:53:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829055359-wkdasnyxtylmnxus
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
                        "&COMMANDNAME;".

* plugins.d/password-prompt.c (main): Improved some documentation
                                      strings.  Do perror() of
                                      tcgetattr() fails.  Add debug
                                      output if interrupted by signal.
                                      Loop over write() instead of
                                      using fwrite() when outputting
                                      password.  Add debug output if
                                      getline() returns 0, unless it
                                      was caused by a signal.  Add
                                      exit status code to debug
                                      output.

* plugins.d/password-prompt.xml: Changed all single quotes to double
                                 quotes for consistency.  Removed
                                 <?xml-stylesheet>.
  (ENTITY TIMESTAMP): New.  Automatically updated by Emacs time-stamp
                      by using Emacs local variables.
  (/refentry/refentryinfo/title): Changed to "Mandos Manual".
  (/refentry/refentryinfo/productname): Changed to "Mandos".
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
  (/refentry/refentryinfo/copyright): Split copyright holders.
  (/refentry/refnamediv/refpurpose): Improved wording.
  (SYNOPSIS): Fix to use correct markup.  Add short options.
  (DESCRIPTION, OPTIONS): Improved wording.
  (OPTIONS): Improved wording.  Use more correct markup.  Document
             short options.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Document use of "cryptsource" and "crypttarget".
  (FILES): REMOVED.
  (BUGS): Add text.
  (EXAMPLE): Added some examples.
  (SECURITY): Added text.
  (SEE ALSO): Remove reference to mandos(8).  Add reference to
              crypttab(5).

Show diffs side-by-side

added added

removed removed

Lines of Context:
72
72
  <refsynopsisdiv>
73
73
    <cmdsynopsis>
74
74
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
75
      <arg>--interface<arg choice="plain">NAME</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">IF</arg></arg>
 
85
      <arg>-i<arg choice="plain">NAME</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
 
        IF</replaceable></literal></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
154
        >NAME</replaceable></literal></term>
155
155
        <listitem>
156
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
157
        </listitem>
448
448
        Normal invocation needs no options:
449
449
      </para>
450
450
      <para>
451
 
        <userinput>mandos</userinput>
 
451
        <userinput>&COMMANDNAME;</userinput>
452
452
      </para>
453
453
    </informalexample>
454
454
    <informalexample>
461
461
      <para>
462
462
 
463
463
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
465
 
466
466
      </para>
467
467
    </informalexample>
473
473
      <para>
474
474
 
475
475
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
477
 
478
478
      </para>
479
479
    </informalexample>
572
572
      </varlistentry>
573
573
      <varlistentry>
574
574
        <term>
575
 
          <ulink
576
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
575
          <ulink url="http://www.gnu.org/software/gnutls/"
 
576
          >GnuTLS</ulink>
577
577
        </term>
578
578
      <listitem>
579
579
        <para>
585
585
      </varlistentry>
586
586
      <varlistentry>
587
587
        <term>
588
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
 
          Unicast Addresses</citation>
 
588
          RFC 4291: <citetitle>IP Version 6 Addressing
 
589
          Architecture</citetitle>
591
590
        </term>
592
591
        <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>
 
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>
599
616
        </listitem>
600
617
      </varlistentry>
601
618
      <varlistentry>
602
619
        <term>
603
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
604
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
620
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
621
          Protocol Version 1.1</citetitle>
605
622
        </term>
606
623
      <listitem>
607
624
        <para>
611
628
      </varlistentry>
612
629
      <varlistentry>
613
630
        <term>
614
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
615
 
          Format</citetitle></citation>
 
631
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
616
632
        </term>
617
633
      <listitem>
618
634
        <para>
622
638
      </varlistentry>
623
639
      <varlistentry>
624
640
        <term>
625
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
626
 
          Transport Layer Security</citetitle></citation>
 
641
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
642
          Security</citetitle>
627
643
        </term>
628
644
      <listitem>
629
645
        <para>