xref: /netbsd/share/man/man5/route.conf.5 (revision 6550d01e)
1.\"        $NetBSD: route.conf.5,v 1.3 2008/05/08 15:34:39 wiz Exp $
2.\"
3.\" Copyright (c) 2004 Thomas Klausner
4.\" 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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd June 24, 2004
27.Dt ROUTE.CONF 5
28.Os
29.Sh NAME
30.Nm route.conf
31.Nd static routes config file
32.Sh DESCRIPTION
33The
34.Nm
35file is read by the
36.Pa staticroute
37rc.d script during system start-up and shutdown,
38and is intended for adding and removing static routes.
39.Ss FILE FORMAT
40Lines starting with a hash
41.Pq Sq #
42are comments and ignored.
43Lines starting with a plus sign
44.Pq Sq +
45are run during start-up,
46while lines starting with a minus sign
47.Pq Sq \-
48are run during system shutdown.
49All other lines are passed to
50.Xr route 8 .
51During start-up, they are passed behind a
52.Dq Ic route add \-
53command and during shutdown behind a
54.Dq Ic route delete \-
55command.
56.Sh FILES
57.Bl -tag -width XXetcXrouteXconfXX
58.It Pa /etc/route.conf
59The
60.Nm
61file resides in
62.Pa /etc .
63.It Pa /etc/rc.d/staticroute
64.Xr rc.d 8
65script that parses
66.Nm .
67.El
68.Sh EXAMPLES
69In this example, if the
70.Pa staticroute
71script is enabled in
72.Xr rc.conf 5 ,
73IP forwarding is turned on during
74start-up, and a static route added for 192.168.2.0.
75During system shutdown, the route is removed
76and IP forwarding turned off.
77.Bd -literal -offset indent
78# Turn on/off IP forwarding.
79+sysctl -w net.inet.ip.forwarding=1
80-sysctl -w net.inet.ip.forwarding=0
81net 192.168.2.0 -netmask 255.255.255.0 192.168.150.2
82.Ed
83.Sh SEE ALSO
84.Xr rc.conf 5 ,
85.Xr rc 8 ,
86.Xr route 8
87