share/man/man5/forward.5

   1 .\" Copyright (c) 1996
   2 .\"     Mike Pritchard <mpp@FreeBSD.org>.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Mike Pritchard and
  15 .\"     contributors.
  16 .\" 4. Neither the name of the author nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $FreeBSD: src/share/man/man5/forward.5,v 1.4.2.3 2001/07/21 09:16:52 schweikh Exp $
  33 .\" $DragonFly: src/share/man/man5/forward.5,v 1.2 2003/06/17 04:37:00 dillon Exp $
  34 .\"
  35 .Dd July 2, 1996
  36 .Dt FORWARD 5
  37 .Os
  38 .Sh NAME
  39 .Nm forward
  40 .Nd mail forwarding instructions
  41 .Sh DESCRIPTION
  42 The
  43 .Nm .forward
  44 file contains a list of mail addresses or programs
  45 that the user's mail should be redirected to.  If the
  46 file is not present, then no mail forwarding will be done.
  47 Mail may also be forwarded as the standard input to a program
  48 by prefixing the line
  49 with the normal shell pipe symbol (|).  If arguments
  50 are to be passed to the command, then the entire line
  51 should be enclosed in quotes.  For security reasons, the
  52 .Nm .forward
  53 file must be owned by the user the mail is being sent to,
  54 or by root, and the user's shell must be listed in
  55 .Pa /etc/shells .
  56 .Pp
  57 For example, if a
  58 .Nm .forward
  59 file contained the following lines:
  60 .Bd -literal -offset indent
  61 nobody@FreeBSD.org
  62 "|/usr/bin/vacation nobody"
  63 .Ed
  64 .Pp
  65 Mail would be forwarded to
  66 .Aq nobody@FreeBSD.org
  67 and to the program
  68 .Pa /usr/bin/vacation
  69 with the single argument
  70 .Ar nobody .
  71 .Pp
  72 If a local user address is prefixed with a backslash
  73 character, mail is delivered directly to the user's
  74 mail spool file, bypassing further redirection.
  75 .Pp
  76 For example, if user chris had a
  77 .Nm .forward
  78 file containing the following lines:
  79 .Bd -literal -offset indent
  80 chris@otherhost
  81 \echris
  82 .Ed
  83 .Pp
  84 One copy of mail would be forwarded to
  85 .Ar chris@otherhost
  86 and another copy would be retained as mail for local user chris.
  87 .Sh FILES
  88 .Bl -tag -width $HOME/.forward -compact
  89 .It Pa $HOME/.forward
  90 The user's forwarding instructions.
  91 .El
  92 .Sh SEE ALSO
  93 .Xr aliases 5 ,
  94 .Xr mailaddr 7 ,
  95 .Xr sendmail 8