Skip to content

Commit

Permalink
update prebuild man-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@pjstevns
pjstevns committed Aug 10, 2010
1 parent 22c708d commit 2859a00
Show file tree
Hide file tree
Showing 3 changed files with 327 additions and 182 deletions.
119 changes: 73 additions & 46 deletions man/dbmail-sievecmd.8
View file
@@ -1,118 +1,145 @@
.\" Title: dbmail\-sievecmd
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
.\" Date: 10/16/2007
.\" Manual:
.\" Source:
'\" t
.\" Title: dbmail-sievecmd
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/10/2010
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "DBMAIL\-SIEVECMD" "8" "10/16/2007" "" ""
.TH "DBMAIL\-SIEVECMD" "8" "08/10/2010" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dbmail\-sievecmd \- manipulates Sieve scripts in the DBMail database.
dbmail-sievecmd \- manipulates Sieve scripts in the DBMail database\&.
.SH "SYNOPSIS"
.sp
dbmail\-sievecmd \-u username [\-l] [\-a scriptname] [\-d scriptname] [\-i scriptname file] [\-c [scriptname]] [\-e [scriptname]] [\-r scriptname] [\-f configfile] [\-nvVh]
.SH "DESCRIPTION"
DBMail stores Sieve scripts in a table in the DBMail database. These scripts are used to sort incoming mail for the email users. Each user has their own script space and may upload scripts to the dbmail\-timsieved(8) daemon. The dbmail\-sievecmd(8) utility provides a convenient method for the system administrator to work with Sieve scripts from the command line.
.sp
DBMail stores Sieve scripts in a table in the DBMail database\&. These scripts are used to sort incoming mail for the email users\&. Each user has their own script space and may upload scripts to the dbmail\-timsieved(8) daemon\&. The dbmail\-sievecmd(8) utility provides a convenient method for the system administrator to work with Sieve scripts from the command line\&.
.SH "OPTIONS"
.PP
\-u username
.RS 3n
Specify the user whose scripts we will be modifying.
.RS 4
Specify the user whose scripts we will be modifying\&.
.RE
.PP
\-l
.RS 3n
.RS 4
List scripts belonging to user
.RE
.PP
\-a scriptname
.RS 3n
.RS 4
Activates
scriptname, deactivating all other scripts.
scriptname, deactivating all other scripts\&.
.RE
.PP
\-d scriptname
.RS 3n
.RS 4
Deactivates
scriptname
if it was active.
if it was active\&.
.RE
.PP
\-i scriptname file
.RS 3n
.RS 4
Creates a script called
scriptname
by importing
file. If
file\&. If
file
is \- (dash) or unspecified,
\fIstdin\fR
will be read.
will be read\&.
.RE
.PP
\-c [scriptname]
.RS 3n
Print out the named script. If no script is given, the active script is printed.
.RS 4
Print out the named script\&. If no script is given, the active script is printed\&.
.RE
.PP
\-e [scriptname]
.RS 3n
Edit the named script. If no script is given, the active script is printed. The EDITOR environment variable is used to find the editor program.
.RS 4
Edit the named script\&. If no script is given, the active script is printed\&. The EDITOR environment variable is used to find the editor program\&.
.RE
.PP
\-r scriptname
.RS 3n
Remove the named script. If the script was active, no script will be active after it is deletion.
.RS 4
Remove the named script\&. If the script was active, no script will be active after it is deletion\&.
.RE
.SH "COMMON OPTIONS"
.PP
\-f configfile
.RS 3n
Specify an alternate config file. The utilities are currently hardcoded to use /etc/dbmail.conf for their configs, and will halt if the config file cannot be found. Use the \-f configfile option to specify your system's preferred config file location.
.RS 4
Specify an alternate config file\&. The utilities are currently hardcoded to use /etc/dbmail\&.conf for their configs, and will halt if the config file cannot be found\&. Use the \-f configfile option to specify your system\(cqs preferred config file location\&.
.RE
.PP
\-q
.RS 3n
Quietly skip interactive prompts and helpful status messages which would otherwise be printed to stdout. Use two \-q's to silence errors which would otherwise be printed to stderr.
.RS 4
Quietly skip interactive prompts and helpful status messages which would otherwise be printed to stdout\&. Use two \-q\(cqs to silence errors which would otherwise be printed to stderr\&.
.RE
.PP
\-v
.RS 3n
Operate verbosely. Some of the utilities in the DBMail suite can take two \-v's for extra verbosity. Those which don't understand this convention won't complain about having the extra \-v and will simply operate at their normal verbosity.
.RS 4
Operate verbosely\&. Some of the utilities in the DBMail suite can take two \-v\(cqs for extra verbosity\&. Those which don\(cqt understand this convention won\(cqt complain about having the extra \-v and will simply operate at their normal verbosity\&.
.RE
.PP
\-V
.RS 3n
Show the version and copyright, then exit.
.RS 4
Show the version and copyright, then exit\&.
.RE
.PP
\-h
.RS 3n
Show a brief summary of options, then exit.
.RS 4
Show a brief summary of options, then exit\&.
.RE
.SH "BUGS"
If you experience inexplicable problems with DBMail, please report the issue to the [1]\&\fIDBMail Bug Tracker\fR.
.sp
If you experience inexplicable problems with DBMail, please report the issue to the \m[blue]\fBDBMail Bug Tracker\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "LICENSE"
DBMail and its components are distributed under the terms of the GNU General Public License. Copyrights are held variously by the authors listed below.
.sp
DBMail and its components are distributed under the terms of the GNU General Public License\&. Copyrights are held variously by the authors listed below\&.
.SH "AUTHOR(S)"
DBMail is a collaborative effort among the core developers listed below and the tremendous help of the testers, patchers and bug hunters listed in the AUTHORS and THANKS files found in the DBMail source distribution.
.sp
.RS 3n
DBMail is a collaborative effort among the core developers listed below and the tremendous help of the testers, patchers and bug hunters listed in the AUTHORS and THANKS files found in the DBMail source distribution\&.
.sp
.if n \{\
.RS 4
.\}
.nf
Eelco van Beek Aaron Stone Paul J Stevens
Roel Rozendaal Open Source Engineer NFG Net Facilities Group BV
Ilja Booij Palo Alto, CA USA http://www.nfg.nl
IC&S http://hydricacid.com
Ilja Booij Palo Alto, CA USA http://www\&.nfg\&.nl
IC&S http://hydricacid\&.com
Koningsweg 4
3582 GE Utrecht
http://www.ic\-s.nl
http://www\&.ic\-s\&.nl
.fi
.sp
.if n \{\
.RE
.SH "REFERENCES"
.TP 3
1.\ DBMail Bug Tracker
.\}
.SH "NOTES"
.IP " 1." 4
DBMail Bug Tracker
.RS 4
\%http://dbmail.org/index.php?page=bugs
.RE
111 changes: 69 additions & 42 deletions man/dbmail-smtp.1
View file
@@ -1,98 +1,125 @@
.\" Title: dbmail\-smtp
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
.\" Date: 10/16/2007
.\" Manual:
.\" Source:
'\" t
.\" Title: dbmail-smtp
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 08/10/2010
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "DBMAIL\-SMTP" "1" "10/16/2007" "" ""
.TH "DBMAIL\-SMTP" "1" "08/10/2010" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dbmail\-smtp \- inserts messages into the DBMail mailsystem.
dbmail-smtp \- inserts messages into the DBMail mailsystem\&.
.SH "SYNOPSIS"
.sp
dbmail\-smtp [\-t headerfield] [\-d addresses] [\-u usernames] [\-m|\-M mailboxname] [\-r return path] [\-f configFile]
.SH "DESCRIPTION"
The dbmail\-smtp program inserts messages from the commandline or from any MTA into the DBMail mailsystem. The program reads from standard input.
.sp
The dbmail\-smtp program inserts messages from the commandline or from any MTA into the DBMail mailsystem\&. The program reads from standard input\&.
.SH "OPTIONS"
.PP
\-t headerfield
.RS 3n
Deliver messages to the recipient MIME header specified in headerfield. The default header to use is the "Delivered\-To:" header.
.RS 4
Deliver messages to the recipient MIME header specified in headerfield\&. The default header to use is the "Delivered\-To:" header\&.
.RE
.PP
\-d addresses\&...
.RS 3n
Deliver messages to the recipients specified by addresses. This option is mostly used for delivery from an MTA. Seperate multiple addresses by spaces.
.RS 4
Deliver messages to the recipients specified by addresses\&. This option is mostly used for delivery from an MTA\&. Seperate multiple addresses by spaces\&.
.RE
.PP
\-u usernames\&...
.RS 3n
Deliver messages straight to the given username. Seperate multiple usernames with spaces.
.RS 4
Deliver messages straight to the given username\&. Seperate multiple usernames with spaces\&.
.RE
.PP
\-m mailboxname
.RS 3n
Deliver messages to mailbox mailboxname of the recipient. If this mailbox does not exist yet, it is created. Sieve scripts will be run normally, possibly altering the destination mailbox.
.RS 4
Deliver messages to mailbox mailboxname of the recipient\&. If this mailbox does not exist yet, it is created\&. Sieve scripts will be run normally, possibly altering the destination mailbox\&.
.RE
.PP
\-M mailboxname
.RS 3n
Deliver messages to mailbox mailboxname of the recipient. If this mailbox does not exist yet, it is created. Sieve scripts are not run. Permission checks are not performed for mailbox creation or message delivery.
.RS 4
Deliver messages to mailbox mailboxname of the recipient\&. If this mailbox does not exist yet, it is created\&. Sieve scripts are not run\&. Permission checks are not performed for mailbox creation or message delivery\&.
.RE
.PP
\-r returnpath
.RS 3n
Set return path for bounces and other error reports to return path.
.RS 4
Set return path for bounces and other error reports to return path\&.
.RE
.SH "COMMON OPTIONS"
.PP
\-f configfile
.RS 3n
Specify an alternate config file. The utilities are currently hardcoded to use /etc/dbmail.conf for their configs, and will halt if the config file cannot be found. Use the \-f configfile option to specify your system's preferred config file location.
.RS 4
Specify an alternate config file\&. The utilities are currently hardcoded to use /etc/dbmail\&.conf for their configs, and will halt if the config file cannot be found\&. Use the \-f configfile option to specify your system\(cqs preferred config file location\&.
.RE
.PP
\-q
.RS 3n
Quietly skip interactive prompts and helpful status messages which would otherwise be printed to stdout. Use two \-q's to silence errors which would otherwise be printed to stderr.
.RS 4
Quietly skip interactive prompts and helpful status messages which would otherwise be printed to stdout\&. Use two \-q\(cqs to silence errors which would otherwise be printed to stderr\&.
.RE
.PP
\-v
.RS 3n
Operate verbosely. Some of the utilities in the DBMail suite can take two \-v's for extra verbosity. Those which don't understand this convention won't complain about having the extra \-v and will simply operate at their normal verbosity.
.RS 4
Operate verbosely\&. Some of the utilities in the DBMail suite can take two \-v\(cqs for extra verbosity\&. Those which don\(cqt understand this convention won\(cqt complain about having the extra \-v and will simply operate at their normal verbosity\&.
.RE
.PP
\-V
.RS 3n
Show the version and copyright, then exit.
.RS 4
Show the version and copyright, then exit\&.
.RE
.PP
\-h
.RS 3n
Show a brief summary of options, then exit.
.RS 4
Show a brief summary of options, then exit\&.
.RE
.SH "BUGS"
If you experience inexplicable problems with DBMail, please report the issue to the [1]\&\fIDBMail Bug Tracker\fR.
.sp
If you experience inexplicable problems with DBMail, please report the issue to the \m[blue]\fBDBMail Bug Tracker\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "LICENSE"
DBMail and its components are distributed under the terms of the GNU General Public License. Copyrights are held variously by the authors listed below.
.sp
DBMail and its components are distributed under the terms of the GNU General Public License\&. Copyrights are held variously by the authors listed below\&.
.SH "AUTHOR(S)"
DBMail is a collaborative effort among the core developers listed below and the tremendous help of the testers, patchers and bug hunters listed in the AUTHORS and THANKS files found in the DBMail source distribution.
.sp
.RS 3n
DBMail is a collaborative effort among the core developers listed below and the tremendous help of the testers, patchers and bug hunters listed in the AUTHORS and THANKS files found in the DBMail source distribution\&.
.sp
.if n \{\
.RS 4
.\}
.nf
Eelco van Beek Aaron Stone Paul J Stevens
Roel Rozendaal Open Source Engineer NFG Net Facilities Group BV
Ilja Booij Palo Alto, CA USA http://www.nfg.nl
IC&S http://hydricacid.com
Ilja Booij Palo Alto, CA USA http://www\&.nfg\&.nl
IC&S http://hydricacid\&.com
Koningsweg 4
3582 GE Utrecht
http://www.ic\-s.nl
http://www\&.ic\-s\&.nl
.fi
.sp
.if n \{\
.RE
.SH "REFERENCES"
.TP 3
1.\ DBMail Bug Tracker
.\}
.SH "NOTES"
.IP " 1." 4
DBMail Bug Tracker
.RS 4
\%http://dbmail.org/index.php?page=bugs
.RE

0 comments on commit 2859a00

Please sign in to comment.