xref: /freebsd/share/man/man5/forward.5 (revision e627b39baccd1ec9129690167cf5e6d860509655)
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.Dd July 2, 1996
33.Dt FORWARD 5
34.Os
35.Sh NAME
36.Nm forward
37.Nd mail forwarding instructions
38.Sh DESCRIPTION
39The
40.Nm .forward
41file contains a list of mail addresses or programs
42that the user's mail should be redirected to.  If the
43file is not present, then no mail forwarding will be done.
44Mail may also be forwarded as the standard input to a program
45by prefixing the line
46with the normal shell pipe symbol (|).  If arguments
47are to be passed to the command, then the entire line
48should be enclosed in quotes.  For security reasons, the
49.Nm .forward
50file must be owned by the user the mail is being sent to,
51or by root, and the user's shell must be listed in
52.Pa /etc/shells .
53.Pp
54For example, if a
55.Nm .forward
56file contained the following lines:
57.Bd -literal -offset indent
58nobody@FreeBSD.org
59"|/usr/bin/vacation nobody"
60.Ed
61.Pp
62Mail would be forwarded to
63.Ar nobody@FreeBSD.org
64and to the program
65.Pa /usr/bin/vacation
66with the single argument
67.Ar nobody .
68
69.Sh FILES
70.Bl -tag -width $HOME/.forward -compact
71.It Pa $HOME/.forward
72
73The user's forwarding instructions.
74.El
75.Sh SEE ALSO
76.Xr mailaddr 7 ,
77.Xr sendmail 8
78