/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 plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2016-08-25 16:17:23 UTC
  • Revision ID: teddy@recompile.se-20160825161723-wsbn6sxyk29qgmsv
PEP8 compliance: mandos-ctl

* mandos-ctl: Add PEP8 compliance (as per the "pycodestyle" tool).

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.xml
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2015-03-08">
 
5
<!ENTITY TIMESTAMP "2016-07-10">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
36
38
      <year>2012</year>
37
39
      <year>2013</year>
38
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
39
43
      <holder>Teddy Hogeborn</holder>
40
44
      <holder>Björn Påhlsson</holder>
41
45
    </copyright>
98
102
      </arg>
99
103
      <sbr/>
100
104
      <arg>
 
105
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
106
      </arg>
 
107
      <sbr/>
 
108
      <arg>
101
109
        <option>--delay <replaceable>SECONDS</replaceable></option>
102
110
      </arg>
103
111
      <sbr/>
312
320
          <para>
313
321
            Sets the number of bits to use for the prime number in the
314
322
            TLS Diffie-Hellman key exchange.  The default value is
315
 
            selected automatically based on the OpenPGP key.
 
323
            selected automatically based on the OpenPGP key.  Note
 
324
            that if the <option>--dh-params</option> option is used,
 
325
            the values from that file will be used instead.
 
326
          </para>
 
327
        </listitem>
 
328
      </varlistentry>
 
329
      
 
330
      <varlistentry>
 
331
        <term><option>--dh-params=<replaceable
 
332
        >FILE</replaceable></option></term>
 
333
        <listitem>
 
334
          <para>
 
335
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
336
            needed by the TLS Diffie-Hellman key exchange from.  If
 
337
            this option is not given, or if the file for some reason
 
338
            could not be used, the parameters will be generated on
 
339
            startup, which will take some time and processing power.
 
340
            Those using servers running under time, power or processor
 
341
            constraints may want to generate such a file in advance
 
342
            and use this option.
316
343
          </para>
317
344
        </listitem>
318
345
      </varlistentry>
445
472
  
446
473
  <refsect1 id="environment">
447
474
    <title>ENVIRONMENT</title>
 
475
    <variablelist>
 
476
      <varlistentry>
 
477
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
478
        <listitem>
 
479
          <para>
 
480
            This environment variable will be assumed to contain the
 
481
            directory containing any helper executables.  The use and
 
482
            nature of these helper executables, if any, is
 
483
            purposefully not documented.
 
484
        </para>
 
485
        </listitem>
 
486
      </varlistentry>
 
487
    </variablelist>
448
488
    <para>
449
 
      This program does not use any environment variables, not even
450
 
      the ones provided by <citerefentry><refentrytitle
 
489
      This program does not use any other environment variables, not
 
490
      even the ones provided by <citerefentry><refentrytitle
451
491
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
452
492
    </citerefentry>.
453
493
    </para>
653
693
    </variablelist>
654
694
  </refsect1>
655
695
  
656
 
<!--   <refsect1 id="bugs"> -->
657
 
<!--     <title>BUGS</title> -->
658
 
<!--     <para> -->
659
 
<!--     </para> -->
660
 
<!--   </refsect1> -->
 
696
  <refsect1 id="bugs">
 
697
    <title>BUGS</title>
 
698
    <xi:include href="../bugs.xml"/>
 
699
  </refsect1>
661
700
  
662
701
  <refsect1 id="example">
663
702
    <title>EXAMPLE</title>
803
842
      </varlistentry>
804
843
      <varlistentry>
805
844
        <term>
806
 
          <ulink url="http://www.gnu.org/software/gnutls/"
807
 
          >GnuTLS</ulink>
 
845
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
808
846
        </term>
809
847
      <listitem>
810
848
        <para>
816
854
      </varlistentry>
817
855
      <varlistentry>
818
856
        <term>
819
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
857
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
820
858
                 >GPGME</ulink>
821
859
        </term>
822
860
        <listitem>
860
898
      </varlistentry>
861
899
      <varlistentry>
862
900
        <term>
863
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
864
 
          Protocol Version 1.1</citetitle>
 
901
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
902
          Protocol Version 1.2</citetitle>
865
903
        </term>
866
904
      <listitem>
867
905
        <para>
868
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
906
          TLS 1.2 is the protocol implemented by GnuTLS.
869
907
        </para>
870
908
      </listitem>
871
909
      </varlistentry>
882
920
      </varlistentry>
883
921
      <varlistentry>
884
922
        <term>
885
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
923
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
886
924
          Security</citetitle>
887
925
        </term>
888
926
      <listitem>