changes since 2.6.4
[fwknop.git] / perl / legacy / fwknop / knoptm.8
1 .\"
2 .TH KNOPTM 8 "August, 2009" Linux
3 .SH NAME
4 .B knoptm
5 \- Daemon in charge to remove firewall rules.
6
7 .SH DESCRIPTION
8 .B knoptm
9 is a daemon that removes rule entries from the iptables or ipfw policies to which
10 fwknop has added access rules for legitimate fwknop PK/SPA clients.  This daemon
11 runs in all authentication modes supported by fwknopd (both port knocking and SPA),
12 and enforces rule timeouts that defined by the
13 .I /etc/fwknop/access.conf
14 file.
15
16 .SH OPTIONS
17 .TP
18 .BR \-c "\fR,\fP " \-\^\-config\ \<config-file>
19 When run as a daemon
20 .B knoptm
21 references the file
22 .B /etc/fwknop/fwknop.conf
23 for various run-time configuration
24 variables. The path to this file can be changed through the use of the
25 .B \-\-config
26 command line option.
27 .TP
28 .BR \-i "\fR,\fP " \-\^\-interface
29 Specify the interface that
30 .B fwknopd
31 sniffs to acquire packet data.  This is
32 used for running interface checks, such as checking whether the interface
33 has been deleted and recreated (e.g. ppp restart for a VPN connection).
34 The
35 .B fwknopd
36 daemon passes this argument on the
37 .B knoptm
38 command line.
39 .TP
40 .BR \-\^\-Debug-to-file\ \<file>
41 Allow the user to collect outputs from the knoptm daemon by writing debug
42 information to a specific file.
43 .TP
44 .BR \-\^\-firewall-type\ \<firewall>
45 Manually specify the firewall type from the command line.
46 .TP
47 .BR \-h "\fR,\fP " \-\^\-help
48 Display usage information and exit.
49 .TP
50 .BR \-V "\fR,\fP " \-\^\-Version
51 Display version information and exit.
52 .TP
53 .BR  \-\^\-Lib-dir\ \<directory>
54 Path to the perl modules directory (not usually necessary).
55 .TP
56 .BR \-l ", " " \-\^\-locale\ \<locale>
57 Provide a locale setting other than the default "C" locale.
58 .TP
59 .BR \-\^\-no-locale
60 Do not set the locale at all so that the default system locale will apply.
61 .TP
62 .BR \-\^\-no-logs
63 Do not generate any log output or emails (fwknop_test.pl uses this).
64 .TP
65 .BR \-\^\-no-voluntary-exits
66 Disregard ENABLE_VOLUNTARY_EXITS setting. This way fwknopd/knoptm is not allowed
67 to be restarted periodically according to EXIT_INTERVAL.
68 .TP
69 .BR \-O "\fR,\fP " \-\^\-Override-config\ \<file>
70 Override config variable values that are normally read from the
71 /etc/fwknop/fwknop.conf file with values from the specified file. Multiple
72 override config files can be given as a comma separated list.
73
74 .SH DIAGNOSTICS
75 .B knoptm
76 can be run in debug mode with the \-\-debug command line option. This will
77 disable daemon mode execution, and print verbose information to the screen
78 on STDERR.
79
80 .SH "SEE ALSO"
81 .BR fwknopd (8),
82
83 .SH AUTHOR
84 Michael Rash <mbr@cipherdyne.org>
85
86 .SH DISTRIBUTION
87 .B knoptm
88 is distributed under the GNU General Public License (GPL), and the latest
89 version may be downloaded from
90 .B http://www.cipherdyne.org/