xref: /netbsd/usr.sbin/srtconfig/srtconfig.1 (revision 6550d01e)
1.\" $NetBSD: srtconfig.1,v 1.3 2007/08/05 09:31:24 dsieger Exp $
2.\" This file is in the public domain.
3.Dd August 21, 2000
4.Dt SRTCONFIG 1
5.Os
6.Sh NAME
7.Nm srtconfig
8.Nd configure srt interfaces
9.Sh SYNOPSIS
10.Nm
11.Ar srtX
12.Nm
13.Ar srtX
14.Ar N
15.Nm
16.Ar srtX
17del
18.Ar N
19.Nm
20.Ar srtX
21add
22.Ar srcaddr
23.Ar mask
24.Ar dstif
25.Ar dstaddr
26.Nm
27.Ar srtX
28set
29.Ar N
30.Ar srcaddr
31.Ar mask
32.Ar dstif
33.Ar dstaddr
34.Sh DESCRIPTION
35.Nm
36configures, or queries the configuration of,
37.Xr srt 4
38interfaces.
39An
40.Xr srt 4
41interface parcels packets out to other interfaces based on their source
42addresses (the normal routing mechanisms handle routing decisions based
43on destination addresses).
44An interface may have any number of routing choices; they are
45examined in order until one matching the packet is found.  The
46packet is sent to the corresponding interface.
47(Any interface, even another
48.Nm srt
49interface, may be specified; if the configurations collaborate to cause
50a packet to loop forever, the system will lock up or crash.)
51.Pp
52When run with only one argument,
53.Nm
54prints the settings for the specified interface.
55.Pp
56When run with two arguments,
57.Nm
58prints the settings for the routing choice whose number is given as the
59second argument.
60.Pp
61The form with
62.Sq del
63deletes a routing choice, identified by its number.
64Other choices with higher numbers, if any, will be renumbered
65accordingly.
66.Pp
67The
68.Sq add
69form adds a choice; the other arguments describe it, and are documented
70below.
71The new choice is added at the end of the list.
72.Pp
73The
74.Sq set
75form replaces an existing choice, given its number.
76The other arguments describe the new choice which is to replace
77whatever currently exists at the given number
78.Ar N .
79.Pp
80A choice is described by four pieces of information: a source address
81and mask, which are used to determine which choice an outgoing packet
82uses, a destination interface, and a destination address for the new
83interface.
84The source address and mask are specified like any Internet
85addresses (for convenience, the mask may instead be specified as a
86.Sq /
87followed by a small integer, CIDR-style; note that in this case the
88mask must still be a separate argument; it cannot be appended to the
89end of the source address argument).
90.Pp
91Each srt interface also has ordinary source and destination addresses
92which are set with
93.Xr ifconfig 8
94like any other interface; these should not be confused with any of the
95above.
96.Sh AUTHORS
97.An der Mouse
98.Aq mouse@rodents.montreal.qc.ca
99