← Back to branch summary

~ubuntu-branches/ubuntu/trusty/opendkim/trusty

« back to all changes in this revision

Viewing changes to opendkim/opendkim.conf.5.in

  • Committer: Package Import Robot
  • Author(s): Scott Kitterman
  • Date: 2012-06-08 14:38:25 UTC
  • mfrom: (1.2.14) (3.2.7 sid)
  • Revision ID: package-import@ubuntu.com-20120608143825-ehz9xxdvii6podhh
Tags: 2.6.0-1
* New upstream release (now DFSG free so tarball repacking no longer
  required)
  - Rename libopendkim6 to libopendkim7 to match new soname
    - Update package and dependencies in debian/control
    - Rename .install and .doc files
  - Drop --enable-xtags from configure in debian/rules since it is now on by
    default
  - Update debian/copyright
  - Remove dversionmangle from debian/watch
  - Update README.Debian to reflect documentation no longer being stripped
* Correct copyright/license information in libar/ar-strl.h based on feedback
  from upstream (correction already implemented upstream for the next
  relese)
* Set --sysconfdir=/etc in configure so that generated man pages refer to
  the correct configuration file locations

Show diffs side-by-side

added added

removed removed

Lines of Context:
opendkim/opendkim.conf.5.in
2
2
 
3
3
.SH NAME
4
4
.B opendkim.conf
5
 
- Configuration file for opendkim
 
5
\- Configuration file for opendkim
6
6
 
7
7
.SH LOCATION
8
8
.I @SYSCONFDIR@/opendkim.conf
43
43
.I opendkim(8)
44
44
man page for a description of such parameters.
45
45
 
 
46
Unless otherwise stated, Boolean values default to "false", integer values
 
47
default to 0, and string and dataset values default to being undefined.
 
48
 
46
49
.SH PARAMETERS
47
50
.TP
48
51
.I AddAllSignatureResults (Boolean)
139
142
 
140
143
.TP
141
144
.I Background (Boolean)
142
 
Normally
 
145
Causes
143
146
.I opendkim
144
 
forks and exits immediately, leaving the service running in the background.
145
 
This flag suppresses that behaviour so that it runs in the foreground.
 
147
to fork and exits immediately, leaving the service running in the background.
 
148
The default is "true".
146
149
 
147
150
.TP
148
151
.I BaseDirectory (string)
482
485
Specifies the user ID to use when conducting an LDAP "bind" operation.
483
486
There is no default.
484
487
 
 
488
.TP
 
489
.I LDAPKeepaliveIdle (integer)
 
490
Sets the number of seconds a connection to an LDAP server needs to remain
 
491
idle before TCP starts sending keepalive probes.  If not specified, the
 
492
LDAP library default is used.
 
493
 
 
494
.TP
 
495
.I LDAPKeepaliveInterval (integer)
 
496
Sets the interval in seconds between TCP keepalive probes.  If not specified,
 
497
the LDAP library default is used.
 
498
 
 
499
.TP
 
500
.I LDAPKeepaliveProbes (integer)
 
501
Sets the maximum number of keepalive probes TCP should send before abandoning
 
502
the connection.  If not specified, the LDAP library default is used.
 
503
 
 
504
.TP 
 
505
.I LDAPSoftStart (Boolean)
 
506
If set, the inability to bind and authenticate to an LDAP server will not
 
507
prevent the filter from starting, and reconnections will be attempted for
 
508
each query.  The default is "False".
 
509
 
 
510
.TP
 
511
.I LDAPTimeout (integer)
 
512
Sets the time in seconds after which an LDAP operation should be abandoned.
 
513
The default is 5.
 
514
 
485
515
.TP 
486
516
.I LDAPUseTLS (Boolean)
487
517
Indicates whether or not a TLS connection should be established when
503
533
weaker policies than the verifier would like to enforce.
504
534
 
505
535
.TP
 
536
.I LogResults (boolean)
 
537
If logging is enabled (see
 
538
.I Syslog
 
539
below), requests that the results of evaluation of all signatures that were
 
540
at least partly intact (i.e., the "d=", "s=", and "b=" tags could be
 
541
extracted).
 
542
 
 
543
.TP
506
544
.I LogWhy (boolean)
507
545
If logging is enabled (see
508
546
.I Syslog
637
675
.I SendReports.
638
676
The default is @SENDMAIL_PATH@.  The executable should accept typical
639
677
.B sendmail(8)
640
 
command line options "-t" (take addresses from message body) and "-f"
 
678
command line options "\-t" (take addresses from message body) and "\-f"
641
679
(set envelope sender), accept the new message on its standard input, and
642
680
return a non-zero exit status on any error.
643
681
 
837
875
Specifies a file containing a list of text replacement rules that are
838
876
applied to the message header fields to replace certain content expected to be
839
877
changed as the message passes through local MTAs.  This can be used to
840
 
accomodate expected changes such as are made to From: fields by MTA
 
878
accommodate expected changes such as are made to From: fields by MTA
841
879
"masquerade" features.  Each entry in the file consists of a POSIX regular
842
880
expression, followed by a tab (ASCII 9), followed by the text that should
843
881
be used to replace the text matching the expression.  The '#' character
868
906
.I RequestReports (boolean)
869
907
When signing, includes a request for signature evaluation failures in the
870
908
signature.  (See draft-ietf-marf-dkim-reporting for details.)
871
 
@XTAGS_MANNOTICE@
872
909
 
873
910
.TP
874
911
.I RequiredHeaders (boolean)
997
1034
.TP
998
1035
.I SignatureAlgorithm (string)
999
1036
Selects the signing algorithm to use when generating signatures.
1000
 
Use 'opendkim -V' to see the list of supported algorithms.
 
1037
Use 'opendkim \-V' to see the list of supported algorithms.
1001
1038
The default is
1002
1039
.I rsa-sha256
1003
1040
if it is available, otherwise it will be
1028
1065
.I KeyTable
1029
1066
(see above) that identifies which key should be used in generating
1030
1067
the signature, and an optional second field naming the signer of the message
1031
 
that will be included in the "i=" tag in the generated signature.
 
1068
that will be included in the "i=" tag in the generated signature.  Note
 
1069
that the "i=" value will not be included in the signature if it conflicts
 
1070
with the signing domain (the "d=" value).
1032
1071
 
1033
1072
If the first field contains only a "%" character, it will be replaced by the
1034
1073
domain found in the From: header field.  Similarly, within the optional