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