usr.sbin/mailwrapper/mailwrapper.8

   1 .\"     $NetBSD: mailwrapper.8,v 1.11 2002/02/08 01:38:50 ross Exp $
   2 .\" $FreeBSD: src/usr.sbin/mailwrapper/mailwrapper.8,v 1.12 2004/07/02 23:12:48 ru Exp $
   3 .\"
   4 .\" Copyright (c) 1998
   5 .\"     Perry E. Metzger.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgment:
  17 .\"     This product includes software developed for the NetBSD Project
  18 .\"     by Perry E. Metzger.
  19 .\" 4. The name of the author may not be used to endorse or promote products
  20 .\"    derived from this software without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  23 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  24 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  25 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  26 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  27 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  31 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .\" The following requests are required for all man pages.
  34 .Dd December 16, 1998
  35 .Dt MAILWRAPPER 8
  36 .Os
  37 .Sh NAME
  38 .Nm mailwrapper
  39 .Nd invoke appropriate MTA software based on configuration file
  40 .Sh SYNOPSIS
  41 Special.
  42 See below.
  43 .Sh DESCRIPTION
  44 At one time, the only Mail Transfer Agent (MTA) software easily available
  45 was
  46 .Xr sendmail 8 .
  47 As a result of this, most Mail User Agents (MUAs) such as
  48 .Xr mail 1
  49 had the path and calling conventions expected by
  50 .Xr sendmail 8
  51 compiled in.
  52 .Pp
  53 Times have changed, however.
  54 On a modern
  55 .Ux
  56 system, the administrator may wish to use one of several
  57 available MTAs.
  58 .Pp
  59 It would be difficult to modify all MUA software typically available
  60 on a system, so most of the authors of alternative MTAs have written
  61 their front end message submission programs so that they use the same
  62 calling conventions as
  63 .Xr sendmail 8
  64 and may be put into place instead of
  65 .Xr sendmail 8
  66 in
  67 .Pa /usr/sbin/sendmail .
  68 .Pp
  69 .Xr sendmail 8
  70 also typically has aliases named
  71 .Xr mailq 1
  72 and
  73 .Xr newaliases 1
  74 linked to it.
  75 The program knows to behave differently when its
  76 .Va argv[0]
  77 is
  78 .Dq mailq
  79 or
  80 .Dq newaliases
  81 and behaves appropriately.
  82 Typically, replacement MTAs provide similar
  83 functionality, either through a program that also switches behavior
  84 based on calling name, or through a set of programs that provide
  85 similar functionality.
  86 .Pp
  87 Although having replacement programs that plug replace
  88 .Xr sendmail 8
  89 helps in installing alternative MTAs, it essentially makes the
  90 configuration of the system depend on hand installing new programs in
  91 .Pa /usr .
  92 This leads to configuration problems for many administrators, since
  93 they may wish to install a new MTA without altering the system
  94 provided
  95 .Pa /usr .
  96 (This may be, for example, to avoid having upgrade problems when a new
  97 version of the system is installed over the old.)
  98 They may also have a shared
  99 .Pa /usr
 100 among several
 101 machines, and may wish to avoid placing implicit configuration
 102 information in a read-only
 103 .Pa /usr .
 104 .Pp
 105 The
 106 .Nm
 107 utility is designed to replace
 108 .Pa /usr/sbin/sendmail
 109 and to invoke an appropriate MTA instead of
 110 .Xr sendmail 8
 111 based on configuration information placed in
 112 .Pa /etc/mail/mailer.conf .
 113 This permits the administrator to configure which MTA is to be invoked on
 114 the system at run time.
 115 .Pp
 116 Other configuration files may need to be altered when replacing
 117 .Xr sendmail 8 .
 118 For example, if the replacement MTA does not support the
 119 .Fl A
 120 option with
 121 .Xr mailq 1 ,
 122 .Va daily_status_include_submit_mailq
 123 should be turned off in
 124 .Pa /etc/periodic.conf .
 125 .Sh FILES
 126 Configuration for
 127 .Nm
 128 is kept in
 129 .Pa /etc/mail/mailer.conf .
 130 .Pa /usr/sbin/sendmail
 131 is typically set up as a symbolic link to
 132 .Nm
 133 which is not usually invoked on its own.
 134 .Sh EXIT STATUS
 135 .Nm
 136 exits 0 on success, and \*[Gt]0 if an error occurs.
 137 .Sh DIAGNOSTICS
 138 The
 139 .Nm
 140 utility will print a diagnostic if its configuration file is malformed or does
 141 not contain a mapping for the name under which
 142 .Nm
 143 was invoked.
 144 In case the configuration file does not exist at all, a syslog event is being
 145 generated and
 146 .Nm
 147 falls back to the default mailer, which is
 148 .Xr sendmail 8 .
 149 .Sh SEE ALSO
 150 .Xr mail 1 ,
 151 .Xr mailq 1 ,
 152 .Xr newaliases 1 ,
 153 .Xr mailer.conf 5 ,
 154 .Xr periodic.conf 5 ,
 155 .Xr sendmail 8
 156 .Sh HISTORY
 157 The
 158 .Nm
 159 utility first appeared in
 160 .Nx 1.4
 161 and then
 162 .Fx 4.0 .
 163 .Sh AUTHORS
 164 .An Perry E. Metzger Aq Mt perry@piermont.com
 165 .Sh BUGS
 166 The entire reason this program exists is a crock.
 167 Instead, a command
 168 for how to submit mail should be standardized, and all the "behave
 169 differently if invoked with a different name" behavior of things like
 170 .Xr mailq 1
 171 should go away.