xref: /openbsd-src/usr.sbin/ripctl/ripctl.8 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\"	$OpenBSD: ripctl.8,v 1.11 2015/07/27 18:48:05 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: July 27 2015 $
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.
34Commands may be abbreviated to the minimum unambiguous prefix; for example,
35.Cm s n
36for
37.Cm show neighbor .
38.Pp
39The following commands are available:
40.Bl -tag -width Ds
41.It Cm fib couple
42Insert the learned routes into the Forward Information Base a.k.a. the kernel
43routing table.
44.It Cm fib decouple
45Remove the learned routes from the Forward Information Base a.k.a. the kernel
46routing table.
47Decoupling the FIB from an RIP router may create routing loops and could cause
48major routing issues.
49.It Cm log brief
50Disable verbose debug logging.
51.It Cm log verbose
52Enable verbose debug logging.
53.It Cm show fib Op Ar destination | filter
54Show the Forwarding Information Base.
55.Ar destination
56can be specified to show the route matching a destination IP address.
57.Ar filter
58can be any of the following:
59.Pp
60.Bl -tag -width "interfaceXXinterfaceXX" -compact
61.It Cm connected
62Show only connected routes.
63.It Cm interface
64Show only interfaces.
65.It Cm rip
66Show only RIP routes.
67.It Cm static
68Show only static routes.
69.El
70.Pp
71.Cm connected ,
72.Cm rip ,
73and
74.Cm static
75may be specified together.
76.It Cm show interfaces
77Show details for all interfaces.
78.It Cm show neighbor
79Show neighbors.
80.It Cm show rib
81Show the Routing Information Base.
82.El
83.Sh FILES
84.Bl -tag -width "/var/run/ripd.sockXX" -compact
85.It Pa /var/run/ripd.sock
86.Ux Ns -domain
87socket used for communication with
88.Xr ripd 8 .
89.El
90.Sh SEE ALSO
91.Xr ripd.conf 5 ,
92.Xr ripd 8
93.Sh HISTORY
94The
95.Nm
96program first appeared in
97.Ox 4.1 .
98