opendkim-genzone(8) [debian man page]
opendkim-genzone(8) System Manager's Manual opendkim-genzone(8) NAME
opendkim-genzone - DKIM public key zone file generation tool SYNOPSIS
opendkim-genzone [-C address] [-d domain] [-D] [-E secs] [-N ns[,...]] [-o file] [-r secs] [-R secs] [-S] [-t secs] [-T secs] [-v] [-x conffile] [dataset] DESCRIPTION
opendkim-genzone generates a file suitable for use with named(8) to publish a set of public keys. The dataset parameter should specify a set of data as described in the opendkim(8) man page. It can currently refer to flat files, Sleepy- cat databases, comma-separated lists, LDAP directories or SQL databases. The dataset may be omitted if a configuration file (via the -x command line flag) is specified referring to a configuration file that sets a KeyTable parameter, in which case that value will be used. The database contents should be formatted as described for the KeyTable parameter, described in the opendkim.conf(5) man page. OPTIONS
-C contact Uses contact as the contact information to be used when an SOA record is generated (see -S below). If not specified, the userid of the executing user and the local hostname will be used; if the executing user can't be determined, "hostmaster" will be used. -d domain Restricts output to those records for which the domain field is the specified domain. -D Adds a "._domainkey" suffix to selector names in the zone file. -E secs When generating an SOA record (see -S below), use secs as the default record expiration time. The default is 604800. -N nslist Specifies a comma-separated list of nameservers, which will be output in NS records before the TXT records. The first nameserver in this list will also be used in the SOA record (if -S is also specified) as the authority hostname. -o file Sends output to the named file rather than standard output. -r secs When generating an SOA record (see -S below), use secs as the zone refresh time. The default is 10800. -R secs When generating an SOA record (see -S below), use secs as the zone retry time. The default is 1800. -S Asks for an SOA record to be generated at the top of the output. The content of this output can be controlled using the -E, -r, -R, -T options. The serial number will be generated based on the current time of day. -t ttl Puts a TTL (time-to-live) value of ttl on all records output. The units are in seconds. -T secs When generating an SOA record (see -S below), use secs as the default record TTL time. The default is 86400. -v Increases the verbosity of debugging output written to standard error. -x conffile Names an opendkim.conf(5) file to be read for LDAP-specific parameters when an LDAP dataset is given on the command line. Not required for other dataset types. The default is /etc/opendkim.conf. VERSION
This man page covers the version of opendkim-genzone that shipped with version 2.6.8 of OpenDKIM. COPYRIGHT
Copyright (c) 2010, 2012, The OpenDKIM Project. All rights reserved. SEE ALSO
opendkim(8), opendkim.conf(5) The OpenDKIM Project opendkim-genzone(8)
Check Out this Related Man Page
opendkim-spam(1) General Commands Manual opendkim-spam(1) NAME
opendkim-spam - DKIM filter spam correlation tool SYNOPSIS
opendkim-spam [options] DESCRIPTION
opendkim-spam accepts a regular format message (RFC5322) on standard input and uses it to update a local SQL database being updated by opendkim(8) with an indiciation that a user believes the input message is spam or otherwise abusive. This feedback is important input toward developing DKIM-based domain reputation systems. The tool is intended to be used directly from within shell-based mail readers such as alpine(1) or mutt(1) using a "pipe" command, which feeds the message being read to the specified program. This tool is experimental. If the experiment proves useful, the feedback could be used as an input stream to a larger-scale collaborative feedback system that can be used to identify sources of signed mail that have good reputations. OPTIONS
-b backend Specifies the style of backend database in use. The default is "mysql". -c file Names a configuration file from which operating parameters will be read. The configuration file contains entries of the form "key value", one per line. Empty lines or lines beginning with a hash ("#") character are ignored. Command line equivalents for the configuration file are available as runtime overrides. The default configuration file location is /etc/opendkim-spam.conf. See the CONFIGURATION FILE section for a list of known values. -f Run in the foreground rather than executing as a background process. Intended mainly for debugging. -d name Indicates the name of the database to be accessed. The default is "opendkim". -h host Specifies the host where the database server is running. The default is "localhost". -o file Writes an update record to an OpenDKIM statistics file rather than directly to a database. There is no default. Note that if this option is used, all database-specific options are ignored. -p password Specifies the password to be used when authenticating to the database. The default is "opendkim". -P port Specifies the port number where the database server is listening. The default depends on which backend is in use. -s column Names the database column whose value should be set to "1" as a result of this user action. The default is "uspam". -u user Identifies the database user to be used when connecting to the database. The default is "opendkim". -v Requests verbose output. Can be specified multiple times for more and more information. -V Print version number and exit. CONFIGURATION FILE
The configuration file used by opendkim-spam(1) is expected to be a text file. Empty lines or lines starting with a hash ("#") character are ignored. All other lines should consist of a parameter name followed by one or more whitespace characters, then followed by its intended value. Parameters match command line options (specified above), but when present the command line options override the configuration file options. The list of configuration file parameters and their command line equivalents are as follows; see above for descriptions: Background -f (opposite meaning) DatabaseBackend -b DatabaseName -d DatabaseHost -h DatabasePassword -p DatabasePort -P DatabaseSpamColumn -s DatabaseUser -u StatisticsFile -o NOTES
It is possible to compile this application without SQL support, in which case only the StatisticsFile setting has any meaning (and, in fact, it is required in that case). VERSION
This man page covers the version of opendkim-spam that shipped with version 2.6.8 of OpenDKIM. COPYRIGHT
Copyright (c) 2011, 2012, The OpenDKIM Project. All rights reserved. SEE ALSO
alpine(1), mutt(1), opendkim(8) RFC6376 - DomainKeys Identified Mail The OpenDKIM Project opendkim-spam(1)