/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>
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>
539
550
    <variablelist>
540
551
      <varlistentry>
541
552
        <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>
558
553
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
559
554
        </term>
560
555
        <listitem>
577
572
      </varlistentry>
578
573
      <varlistentry>
579
574
        <term>
580
 
          <ulink
581
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
575
          <ulink url="http://www.gnu.org/software/gnutls/"
 
576
          >GnuTLS</ulink>
582
577
        </term>
583
578
      <listitem>
584
579
        <para>
590
585
      </varlistentry>
591
586
      <varlistentry>
592
587
        <term>
593
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
594
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
595
 
          Unicast Addresses</citation>
 
588
          RFC 4291: <citetitle>IP Version 6 Addressing
 
589
          Architecture</citetitle>
596
590
        </term>
597
591
        <listitem>
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>
 
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>
604
616
        </listitem>
605
617
      </varlistentry>
606
618
      <varlistentry>
607
619
        <term>
608
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
609
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
620
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
621
          Protocol Version 1.1</citetitle>
610
622
        </term>
611
623
      <listitem>
612
624
        <para>
616
628
      </varlistentry>
617
629
      <varlistentry>
618
630
        <term>
619
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
620
 
          Format</citetitle></citation>
 
631
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
621
632
        </term>
622
633
      <listitem>
623
634
        <para>
627
638
      </varlistentry>
628
639
      <varlistentry>
629
640
        <term>
630
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
631
 
          Transport Layer Security</citetitle></citation>
 
641
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
642
          Security</citetitle>
632
643
        </term>
633
644
      <listitem>
634
645
        <para>