xref: /minix/share/man/man5/route.conf.5 (revision 03ac74ed)
1.\"        $NetBSD: route.conf.5,v 1.5 2012/05/02 22:38:31 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 May 1, 2012
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.
49If a line starts with a
50.Sq \&! ,
51the rest of the line will get evaluated as a shell script fragment.
52All other lines are passed to
53.Xr route 8 .
54During start-up, they are passed behind a
55.Dq Ic route add \-
56command and during shutdown behind a
57.Dq Ic route delete \-
58command.
59.Sh FILES
60.Bl -tag -width XXetcXrouteXconfXX
61.It Pa /etc/route.conf
62The
63.Nm
64file resides in
65.Pa /etc .
66.It Pa /etc/rc.d/staticroute
67.Xr rc.d 8
68script that parses
69.Nm .
70.El
71.Sh EXAMPLES
72In this example, the interface for the desired routing changes is set,
73the IP address on that interface is determined, and a route is added
74during startup, or deleted during system shutdown.
75.Bd -literal -offset indent
76# Set interface and determine current IP address for added route.
77!ifname=bnx0
78!ipaddr=$(/sbin/ifconfig ${ifname} | awk '$1 == "inet" {print $2}')
79net 10.10.1 -interface ${ipaddr}
80.Ed
81.Pp
82In this example,
83IP forwarding is turned on during
84start-up, and a static route added for 192.168.2.0.
85During system shutdown, the route is removed
86and IP forwarding turned off.
87.Bd -literal -offset indent
88# Turn on/off IP forwarding.
89+sysctl -w net.inet.ip.forwarding=1
90-sysctl -w net.inet.ip.forwarding=0
91net 192.168.2.0 -netmask 255.255.255.0 192.168.150.2
92.Ed
93.Sh SEE ALSO
94.Xr rc.conf 5 ,
95.Xr rc 8 ,
96.Xr route 8
97