/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-options.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

Lines of Context:
46
46
    <emphasis>not</emphasis> run in debug mode.
47
47
  </para>
48
48
  
49
 
  <para id="priority_compat">
 
49
  <para id="priority">
50
50
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
51
 
    The default is <quote><literal
52
 
    >SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:</literal>
53
 
    <literal>+SIGN-RSA-RMD160</literal></quote>.
54
 
    See <citerefentry><refentrytitle
 
51
    The default is
 
52
    <!-- &#x200b; is Unicode ZERO WIDTH SPACE; allows line breaks -->
 
53
    <quote><literal>SECURE128&#x200b;:!CTYPE-X.509&#x200b;:+CTYPE-RAWPK&#x200b;:!RSA&#x200b;:!VERS-ALL&#x200b;:+VERS-TLS1.3&#x200b;:%PROFILE_ULTRA</literal></quote>
 
54
    when using raw public keys in TLS, and
 
55
    <quote><literal>SECURE256&#x200b;:!CTYPE-X.509&#x200b;:+CTYPE-OPENPGP&#x200b;:!RSA&#x200b;:+SIGN-DSA-SHA256</literal></quote>
 
56
    when using OpenPGP keys in TLS,.  See <citerefentry><refentrytitle
55
57
    >gnutls_priority_init</refentrytitle>
56
58
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
57
59
    <emphasis>Warning</emphasis>: changing this may make the
58
60
    <acronym>TLS</acronym> handshake fail, making server-client
59
 
    communication impossible.
60
 
  </para>
61
 
  
62
 
  <para id="priority">
63
 
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
64
 
    The default is <quote><literal
65
 
    >SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.  See
66
 
    <citerefentry><refentrytitle >gnutls_priority_init</refentrytitle>
67
 
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
68
 
    <emphasis>Warning</emphasis>: changing this may make the
69
 
    <acronym>TLS</acronym> handshake fail, making server-client
70
 
    communication impossible.
 
61
    communication impossible.  Changing this option may also make the
 
62
    network traffic decryptable by an attacker.
71
63
  </para>
72
64
  
73
65
  <para id="servicename">
123
115
    implies this option.
124
116
  </para>
125
117
  
 
118
  <para id="zeroconf">
 
119
    This option controls whether the server will announce its
 
120
    existence using Zeroconf.  Default is to use Zeroconf.  If
 
121
    Zeroconf is not used, a <option>port</option> number or a
 
122
    <option>socket</option> is required.
 
123
  </para>
 
124
  
126
125
</section>