xref: /openbsd-src/usr.sbin/ripctl/ripctl.8 (revision 2b0358df1d88d06ef4139321dd05bd5e05d91eaf)
1.\"	$OpenBSD: ripctl.8,v 1.5 2008/12/06 21:18:16 sobrado Exp $
2.\"
3.\" Copyright (c) 2006 Michele Marchetto <mydecay@openbeer.it>
4.\" Copyright (c) 2004, 2005 Esben Norby <norby@openbsd.org>
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd $Mdocdate: December 6 2008 $
19.Dt RIPCTL 8
20.Os
21.Sh NAME
22.Nm ripctl
23.Nd control the Routing Information Protocol daemon
24.Sh SYNOPSIS
25.Nm
26.Ar command
27.Op Ar argument ...
28.Sh DESCRIPTION
29The
30.Nm
31program controls the
32.Xr ripd 8
33daemon.
34.Pp
35The following commands are available:
36.Bl -tag -width Ds
37.It Cm fib couple
38Insert the learned routes into the Forward Information Base a.k.a. the kernel
39routing table.
40.It Cm fib decouple
41Remove the learned routes from the Forward Information Base a.k.a. the kernel
42routing table.
43Decoupling the FIB from an RIP router may create routing loops and could cause
44major routing issues.
45.It Cm show fib Op Ar destination | filter
46Show the Forwarding Information Base.
47.Ar destination
48can be specified to show the route matching a destination IP address.
49.Ar filter
50can be any of the following:
51.Pp
52.Bl -tag -width "interfaceXXinterfaceXX" -compact
53.It Cm connected
54Show only connected routes.
55.It Cm interface
56Show only interfaces.
57.It Cm rip
58Show only RIP routes.
59.It Cm static
60Show only static routes.
61.El
62.Pp
63.Cm connected ,
64.Cm rip ,
65and
66.Cm static
67may be specified together.
68.It Cm show interfaces
69Show details for all interfaces.
70.It Cm show neighbor
71Show neighbors.
72.It Cm show rib
73Show the Routing Information Base.
74.El
75.Sh FILES
76.Bl -tag -width "/var/run/ripd.sockXX" -compact
77.It /var/run/ripd.sock
78Unix-domain socket used for communication with
79.Xr ripd 8 .
80.El
81.Sh SEE ALSO
82.Xr ripd.conf 5 ,
83.Xr ripd 8
84.Sh HISTORY
85The
86.Nm
87program first appeared in
88.Ox 4.1 .
89