xref: /freebsd/contrib/blocklist/bin/blacklistctl.8 (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1.\" $NetBSD: blacklistctl.8,v 1.9 2016/06/08 12:48:37 wiz Exp $
2.\"
3.\" Copyright (c) 2015 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Christos Zoulas.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd June 7, 2016
31.Dt BLACKLISTCTL 8
32.Os
33.Sh NAME
34.Nm blacklistctl
35.Nd display and change the state of blacklistd
36.Sh SYNOPSIS
37.Nm
38.Cm dump
39.Op Fl abdnrw
40.Sh DESCRIPTION
41.Nm
42is a program used to display the state of
43.Xr blacklistd 8
44.Pp
45The following options are available:
46.Bl -tag -width indent
47.It Fl a
48Show all database entries, by default it shows only the embryonic ones.
49.It Fl b
50Show only the blocked entries.
51.It Fl d
52Increase debugging level.
53.It Fl n
54Don't display a header.
55.It Fl r
56Show the remaining blocked time instead of the last activity time.
57.It Fl w
58Normally the width of addresses is good for IPv4, the
59.Fl w
60flag, makes the display wide enough for IPv6 addresses.
61.El
62.Sh SEE ALSO
63.Xr blacklistd 8
64.Sh NOTES
65Sometimes the reported number of failed attempts can exceed the number
66of attempts that
67.Xr blacklistd 8
68is configured to block.
69This can happen either because the rule has been removed manually, or
70because there were more attempts in flight while the rule block was being
71added.
72This condition is normal; in that case
73.Xr blacklistd 8
74will first attempt to remove the existing rule, and then it will re-add
75it to make sure that there is only one rule active.
76.Sh HISTORY
77.Nm
78first appeared in
79.Nx 7 .
80.Fx
81support for
82.Nm
83was implemented in
84.Fx 11 .
85.Sh AUTHORS
86.An Christos Zoulas
87