usr/src/man/man1m/etrn.1m

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ETRN 1M "Aug 10, 2004"
   7 .SH NAME
   8 etrn \- start mail queue run
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBetrn\fR [\fB-b\fR] [\fB-v\fR] \fIserver-host\fR [\fIclient-hosts\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 SMTP's \fBETRN\fR command allows an SMTP client and server to interact, giving
  19 the server an opportunity to start the processing of its queues for messages to
  20 go to a given host. This is meant to be used in start-up conditions, as well as
  21 for mail nodes that have transient connections to their service providers.
  22 .sp
  23 .LP
  24 The \fBetrn\fR utility initiates an SMTP session with the host
  25 \fIserver-host\fR and sends one or more \fBETRN\fR commands as follows: If no
  26 \fIclient-hosts\fR are specified, \fBetrn\fR looks up every host name for which
  27 \fBsendmail\fR(1M) accepts email and, for each name, sends an \fBETRN\fR
  28 command with that name as the argument. If any \fIclient-hosts\fR are
  29 specified, \fBetrn\fR uses each of these as arguments for successive \fBETRN\fR
  30 commands.
  31 .SH OPTIONS
  32 .sp
  33 .LP
  34 The following options are supported:
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fB-b\fR\fR
  39 .ad
  40 .RS 6n
  41 System boot special case. Make sure localhost is accepting SMTP connections
  42 before initiating the SMTP session with server-host.
  43 .sp
  44 This option is useful because it prevents race conditions between
  45 \fBsendmail\fR(1M) accepting connections and \fIserver-host\fR attempting to
  46 deliver queued mail. This check is performed automatically if no
  47 \fIclient-hosts\fR are specified.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fB-v\fR\fR
  54 .ad
  55 .RS 6n
  56 The normal mode of operation for \fBetrn\fR is to do all of its work silently.
  57 The \fB-v\fR option makes it verbose, which causes \fBetrn\fR to display its
  58 conversations with the remote SMTP server.
  59 .RE
  60
  61 .SH ENVIRONMENT VARIABLES
  62 .sp
  63 .LP
  64 No environment variables are used. However, at system start-up,
  65 \fBsvc:/network/smtp:sendmail\fR reads \fB/etc/default/sendmail\fR. In this
  66 file, if the variable \fBETRN_HOSTS\fR is set, \fBsvc:/network/smtp:sendmail\fR
  67 parses this variable and invokes \fBetrn\fR appropriately. \fBETRN_HOSTS\fR
  68 should be of the form:
  69 .sp
  70 .in +2
  71 .nf
  72 "s1:c1.1,c1.2        s2:c2.1 s3:c3.1,c3.2,c3.3"
  73 .fi
  74 .in -2
  75 .sp
  76
  77 .sp
  78 .LP
  79 That is, white-space separated groups of \fIserver:client\fR where \fIclient\fR
  80 can be one or more comma-separated names. The \fI:client\fR part is optional.
  81 \fIserver\fR is the name of the server to prod; a mail queue run is requested
  82 for each \fIclient\fR name. This is comparable to running:
  83 .sp
  84 .in +2
  85 .nf
  86 /usr/lib/sendmail -qR \fIclient\fR
  87 .fi
  88 .in -2
  89 .sp
  90
  91 .sp
  92 .LP
  93 on the host \fIserver\fR.
  94 .SH EXAMPLES
  95 .LP
  96 \fBExample 1 \fRUsing \fBetrn\fR
  97 .sp
  98 .LP
  99 Inserting the line:
 100
 101 .sp
 102 .in +2
 103 .nf
 104 ETRN_HOSTS="s1.domain.com:clnt.domain.com s2.domain.com:clnt.domain.com"
 105 .fi
 106 .in -2
 107 .sp
 108
 109 .sp
 110 .LP
 111 in \fB/etc/default/sendmail\fR results in \fBsvc:/network/smtp:sendmail\fR
 112 invoking \fBetrn\fR such that \fBETRN\fR commands are sent to both
 113 \fBs1.domain.com\fR and \fBs2.domain.com\fR, with both having
 114 \fBclnt.domain.com\fR as the \fBETRN\fR argument.
 115
 116 .sp
 117 .LP
 118 The line:
 119
 120 .sp
 121 .in +2
 122 .nf
 123 ETRN_HOSTS="server.domain.com:client1.domain.com,client2.domain.com"
 124 .fi
 125 .in -2
 126 .sp
 127
 128 .sp
 129 .LP
 130 results in two \fBETRN\fR commands being sent to \fBserver.domain.com\fR, one
 131 with the argument \fBclient1.domain.com\fR, the other with the argument
 132 \fBclient2.domain.com\fR.
 133
 134 .sp
 135 .LP
 136 The line:
 137
 138 .sp
 139 .in +2
 140 .nf
 141 ETRN_HOSTS="server1.domain.com server2.domain.com"
 142 .fi
 143 .in -2
 144 .sp
 145
 146 .sp
 147 .LP
 148 results in set of a \fBETRN\fR commands being sent to both
 149 \fBserver1.domain.com\fR and \fBserver2.domain.com\fR; each set contains one
 150 \fBETRN\fR command for each host name for which \fBsendmail\fR(1M) accepts
 151 email, with that host name as the argument.
 152
 153 .SH FILES
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB/etc/mail/sendmail.cf\fR\fR
 158 .ad
 159 .RS 25n
 160 \fBsendmail\fR configuration file
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fB/etc/default/sendmail\fR\fR
 167 .ad
 168 .RS 25n
 169 Variables used by \fBsvc:/network/smtp:sendmail\fR
 170 .RE
 171
 172 .SH ATTRIBUTES
 173 .sp
 174 .LP
 175 See \fBattributes\fR(5) for descriptions of the following attributes:
 176 .sp
 177
 178 .sp
 179 .TS
 180 box;
 181 c | c
 182 l | l .
 183 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 184 _
 185 Interface Stability     Stable
 186 .TE
 187
 188 .SH SEE ALSO
 189 .sp
 190 .LP
 191 \fBsendmail\fR(1M), \fBattributes\fR(5)
 192 .sp
 193 .LP
 194 RFC 1985
 195 .SH NOTES
 196 .sp
 197 .LP
 198 Not all SMTP servers support \fBETRN\fR.