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