diff options
author | Philip Hazel <ph10@hermes.cam.ac.uk> | 2006-12-19 12:28:35 +0000 |
---|---|---|
committer | Philip Hazel <ph10@hermes.cam.ac.uk> | 2006-12-19 12:28:35 +0000 |
commit | 3cb1b51eaf0fde876dcdc9e4e14a1458f5714eb6 (patch) | |
tree | ad9f9065cfafcaf8ea43042e84755bb996e5b2b2 /doc/doc-docbook/x2man | |
parent | 56f5d9bd6bb563f4f0eab011ed665da234d93e37 (diff) |
Update documentation and associated files for 4.64.
Diffstat (limited to 'doc/doc-docbook/x2man')
-rwxr-xr-x | doc/doc-docbook/x2man | 74 |
1 files changed, 49 insertions, 25 deletions
diff --git a/doc/doc-docbook/x2man b/doc/doc-docbook/x2man index 430d7d627..be25ae192 100755 --- a/doc/doc-docbook/x2man +++ b/doc/doc-docbook/x2man @@ -1,6 +1,6 @@ #! /usr/bin/perl -w -# $Cambridge: exim/doc/doc-docbook/x2man,v 1.5 2006/09/12 10:15:11 ph10 Exp $ +# $Cambridge: exim/doc/doc-docbook/x2man,v 1.6 2006/12/19 12:28:35 ph10 Exp $ # Script to find the command line options in the DocBook source of the Exim # spec, and turn them into a man page, because people like that. @@ -31,7 +31,7 @@ exim \\- a Mail Transfer Agent .B runq [options] arguments ... .br .B newaliases [options] arguments ... - +. .SH DESCRIPTION .rs .sp @@ -40,20 +40,41 @@ It is a large program with very many facilities. For a full specification, see the reference manual. This man page contains only a description of the command line options. It has been automatically generated from the reference manual source, hopefully without too much mangling. - -.SH DEFAULT ACTION +.P +Like other MTAs, Exim replaces Sendmail, and is normally called by user agents +(MUAs) using the path \\fI/usr/sbin/sendmail\\fP when they submit messages for +delivery (some operating systems use \\fI/usr/lib/sendmail\\fP). This path is +normally set up as a symbolic link to the Exim binary. It may also be used by +boot scripts to start the Exim daemon. Many of Exim's command line options are +compatible with Sendmail so that it can act as a drop-in replacement. +. +.SH "DEFAULT ACTION" .rs .sp If no options are present that require a specific action (such as starting the daemon or a queue runner, testing an address, receiving a message in a specific -format, or listing the queue), and there is at least one command line argument, -then \fB-bm\fR (accept a local message on the standard input, with the -arguments specifying the recipients) is assumed. Otherwise, Exim outputs a -brief message about itself and exits. - -.SH SETTING OPTIONS BY PROGRAM NAME +format, or listing the queue), and there are no arguments on the command line, +Exim outputs a brief message about itself and exits. +.sp +However, if there is at least one command line argument, \\fB-bm\\fR (accept a +local message on the standard input, with the arguments specifying the +recipients) is assumed. Thus, for example, if Exim is installed in +\\fI/usr/sbin\\fP, you can send a message from the command line like this: +.sp + /usr/sbin/exim -i <recipient-address(es)> + <message content, including all the header lines> + CTRL-D +.sp +The \\fB-i\\fP option prevents a line containing just a dot from terminating +the message. Only an end-of-file (generated by typing CTRL-D if the input is +from a terminal) does so. +. +.SH "SETTING OPTIONS BY PROGRAM NAME" .rs -.TP 10 +.sp +If an Exim binary is called using one of the names listed in this section +(typically via a symbolic link), certain options are assumed. +.TP \\fBmailq\\fR Behave as if the option \\fB\\-bp\\fP were present before any other options. The \\fB\\-bp\\fP option requests a listing of the contents of the mail queue @@ -82,8 +103,8 @@ Behave as if the option \\fB\\-bi\\fP were present before any other options, for compatibility with Sendmail. This option is used for rebuilding Sendmail's alias file. Exim does not have the concept of a single alias file, but can be configured to run a specified command if called with the \\fB\\-bi\\fP option. - -.SH OPTIONS +. +.SH "OPTIONS" .rs End @@ -144,11 +165,11 @@ while ($next) $optstart = 0; } - # Literal layout needs to be treated as a paragraph, and indented + # Literal layout needs to be wrapped with .sp, and indented. if (/<literallayout/) { - s/<literallayout[^>]*>/.P/; + s/<literallayout[^>]*>/.sp/; $indent = " "; } @@ -156,8 +177,8 @@ while ($next) # Others get marked - s/<para>/.P/; - s/<simpara>/.P/; + s/<para>/.sp/; + s/<simpara>/.sp/; # Skip index entries @@ -192,11 +213,6 @@ while ($next) next if /^\s*$/; - # It turns out that we don't actually want .P; a blank line is needed. - # But we can't set that above, because it will be discarded. - - s/^\.P\s*$/\n/; - # We are going to output some data; sort out special characters s/</</g; @@ -210,11 +226,19 @@ while ($next) s/-/\\-/g; - # Put in the indent, and write the line + # Put in the indent unless the line starts .sp, and then write the line - s/^/$indent/mg; + s/^/$indent/mg unless /^\.sp/; print OUT; } -# End of g2man +print OUT <<End; +. +.SH "SEE ALSO" +.rs +.sp +The full Exim specification, the Exim book, and the Exim wiki. +End + +# End of x2man |