DOC/ENH: update man pages for release

man/fail2ban-client.1

@@ -1,12 +1,12 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.41.2.
-.TH FAIL2BAN-CLIENT "1" "January 2014" "fail2ban-client v0.8.12" "User Commands"
+.TH FAIL2BAN-CLIENT "1" "March 2014" "fail2ban-client v0.9.0" "User Commands"
 .SH NAME
 fail2ban-client \- configure and control the server
 .SH SYNOPSIS
 .B fail2ban-client
 [\fIOPTIONS\fR] \fI<COMMAND>\fR
 .SH DESCRIPTION
-Fail2Ban v0.8.12 reads log file that contains password failure report
+Fail2Ban v0.9.0 reads log file that contains password failure report
 and bans the corresponding IP addresses using firewall rules.
 .SH OPTIONS
 .TP
@@ -69,8 +69,9 @@ return this output
 LOGGING
 .TP
 \fBset loglevel <LEVEL>\fR
-sets logging level to <LEVEL>. 0
+sets logging level to <LEVEL>.
-is minimal, 4 is debug
+Levels: CRITICAL, ERROR, WARNING,
+NOTICE, INFO, DEBUG
 .TP
 \fBget loglevel\fR
 gets the logging level
@@ -87,6 +88,25 @@ gets logging target
 flushes the logtarget if a file
 and reopens it. For log rotation.
 .IP
+DATABASE
+.TP
+\fBset dbfile <FILE>\fR
+set the location of fail2ban
+persistent datastore. Set to
+"None" to disable
+.TP
+\fBget dbfile\fR
+get the location of fail2ban
+persistent datastore
+.TP
+\fBset dbpurgeage <SECONDS>\fR
+sets the max age in <SECONDS> that
+history of bans will be kept
+.TP
+\fBget dbpurgeage\fR
+gets the max age in seconds that
+history of bans will be kept
+.IP
 JAIL CONTROL
 .TP
 \fBadd <JAIL> <BACKEND>\fR
@@ -115,14 +135,28 @@ adds <IP> to the ignore list of
 removes <IP> from the ignore list
 of <JAIL>
 .TP
-\fBset <JAIL> addlogpath <FILE>\fR
+\fBset <JAIL> addlogpath <FILE> ['tail']\fR
 adds <FILE> to the monitoring list
-of <JAIL>
+of <JAIL>, optionally starting at
+the 'tail' of the file (default
+\&'head').
 .TP
 \fBset <JAIL> dellogpath <FILE>\fR
 removes <FILE> from the monitoring
 list of <JAIL>
 .TP
+\fBset <JAIL> logencoding <ENCODING>\fR
+sets the <ENCODING> of the log
+files for <JAIL>
+.TP
+\fBset <JAIL> addjournalmatch <MATCH>\fR
+adds <MATCH> to the journal filter
+of <JAIL>
+.TP
+\fBset <JAIL> deljournalmatch <MATCH>\fR
+removes <MATCH> from the journal
+filter of <JAIL>
+.TP
 \fBset <JAIL> addfailregex <REGEX>\fR
 adds the regular expression
 <REGEX> which must match failures
@@ -153,6 +187,10 @@ back for <JAIL>
 sets the number of seconds <TIME>
 a host will be banned for <JAIL>
 .TP
+\fBset <JAIL> datepattern <PATTERN>\fR
+sets the <PATTERN> used to match
+date/times for <JAIL>
+.TP
 \fBset <JAIL> usedns <VALUE>\fR
 sets the usedns mode for <JAIL>
 .TP
@@ -167,48 +205,80 @@ sets the number of failures
 <RETRY> before banning the host
 for <JAIL>
 .TP
-\fBset <JAIL> addaction <ACT>\fR
+\fBset <JAIL> maxlines <LINES>\fR
+sets the number of <LINES> to
+buffer for regex search for <JAIL>
+.IP
+set <JAIL> addaction <ACT>[ <PYTHONFILE> <JSONKWARGS>]
+.IP
 adds a new action named <NAME> for
-<JAIL>
+<JAIL>. Optionally for a Python
+based action, a <PYTHONFILE> and
+<JSONKWARGS> can be specified,
+else will be a Command Action
 .TP
 \fBset <JAIL> delaction <ACT>\fR
-removes the action <NAME> from
+removes the action <ACT> from
 <JAIL>
-.TP
+.IP
-\fBset <JAIL> setcinfo <ACT> <KEY> <VALUE>\fR
+COMMAND ACTION CONFIGURATION
-sets <VALUE> for <KEY> of the
+.IP
-action <NAME> for <JAIL>
+set <JAIL> action <ACT> actionstart <CMD>
-.TP
+.IP
-\fBset <JAIL> delcinfo <ACT> <KEY>\fR
-removes <KEY> for the action
-<NAME> for <JAIL>
-.TP
-\fBset <JAIL> actionstart <ACT> <CMD>\fR
 sets the start command <CMD> of
 the action <ACT> for <JAIL>
-.TP
+.IP
-\fBset <JAIL> actionstop <ACT> <CMD>\fR
+set <JAIL> action <ACT> actionstop <CMD> sets the stop command <CMD> of the
-sets the stop command <CMD> of the
+.IP
 action <ACT> for <JAIL>
-.TP
+.IP
-\fBset <JAIL> actioncheck <ACT> <CMD>\fR
+set <JAIL> action <ACT> actioncheck <CMD>
+.IP
 sets the check command <CMD> of
 the action <ACT> for <JAIL>
 .TP
-\fBset <JAIL> actionban <ACT> <CMD>\fR
+\fBset <JAIL> action <ACT> actionban <CMD>\fR
 sets the ban command <CMD> of the
 action <ACT> for <JAIL>
-.TP
+.IP
-\fBset <JAIL> actionunban <ACT> <CMD>\fR
+set <JAIL> action <ACT> actionunban <CMD>
+.IP
 sets the unban command <CMD> of
 the action <ACT> for <JAIL>
 .IP
+set <JAIL> action <ACT> timeout <TIMEOUT>
+.IP
+sets <TIMEOUT> as the command
+timeout in seconds for the action
+<ACT> for <JAIL>
+.IP
+GENERAL ACTION CONFIGURATION
+.IP
+set <JAIL> action <ACT> <PROPERTY> <VALUE>
+.IP
+sets the <VALUE> of <PROPERTY> for
+the action <ACT> for <JAIL>
+.IP
+set <JAIL> action <ACT> <METHOD>[ <JSONKWARGS>]
+.IP
+calls the <METHOD> with
+<JSONKWARGS> for the action <ACT>
+for <JAIL>
+.IP
 JAIL INFORMATION
 .TP
 \fBget <JAIL> logpath\fR
 gets the list of the monitored
 files for <JAIL>
 .TP
+\fBget <JAIL> logencoding\fR
+gets the encoding of the log files
+for <JAIL>
+.TP
+\fBget <JAIL> journalmatch\fR
+gets the journal filter match for
+<JAIL>
+.TP
 \fBget <JAIL> ignoreip\fR
 gets the list of ignored IP
 addresses for <JAIL>
@@ -235,6 +305,10 @@ will look back for failures for
 gets the time a host is banned for
 <JAIL>
 .TP
+\fBget <JAIL> datepattern\fR
+gets the patern used to match
+date/times for <JAIL>
+.TP
 \fBget <JAIL> usedns\fR
 gets the usedns setting for <JAIL>
 .TP
@@ -242,33 +316,53 @@ gets the usedns setting for <JAIL>
 gets the number of failures
 allowed for <JAIL>
 .TP
-\fBget <JAIL> addaction\fR
+\fBget <JAIL> maxlines\fR
-gets the last action which has
+gets the number of lines to buffer
-been added for <JAIL>
+for <JAIL>
 .TP
-\fBget <JAIL> actionstart <ACT>\fR
+\fBget <JAIL> actions\fR
+gets a list of actions for <JAIL>
+.IP
+COMMAND ACTION INFORMATION
+.TP
+\fBget <JAIL> action <ACT> actionstart\fR
 gets the start command for the
 action <ACT> for <JAIL>
 .TP
-\fBget <JAIL> actionstop <ACT>\fR
+\fBget <JAIL> action <ACT> actionstop\fR
 gets the stop command for the
 action <ACT> for <JAIL>
 .TP
-\fBget <JAIL> actioncheck <ACT>\fR
+\fBget <JAIL> action <ACT> actioncheck\fR
 gets the check command for the
 action <ACT> for <JAIL>
 .TP
-\fBget <JAIL> actionban <ACT>\fR
+\fBget <JAIL> action <ACT> actionban\fR
 gets the ban command for the
 action <ACT> for <JAIL>
 .TP
-\fBget <JAIL> actionunban <ACT>\fR
+\fBget <JAIL> action <ACT> actionunban\fR
 gets the unban command for the
 action <ACT> for <JAIL>
 .TP
-\fBget <JAIL> cinfo <ACT> <KEY>\fR
+\fBget <JAIL> action <ACT> timeout\fR
-gets the value for <KEY> for the
+gets the command timeout in
+seconds for the action <ACT> for
+<JAIL>
+.IP
+GENERAL ACTION INFORMATION
+.TP
+\fBget <JAIL> actionproperties <ACT>\fR
+gets a list of properties for the
 action <ACT> for <JAIL>
+.TP
+\fBget <JAIL> actionmethods <ACT>\fR
+gets a list of methods for the
+action <ACT> for <JAIL>
+.TP
+\fBget <JAIL> action <ACT> <PROPERTY>\fR
+gets the value of <PROPERTY> for
+the action <ACT> for <JAIL>
 .SH FILES
 \fI/etc/fail2ban/*\fR
 .SH AUTHOR

man/fail2ban-regex.1

@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.41.2.
-.TH FAIL2BAN-REGEX "1" "January 2014" "fail2ban-regex 0.8.12" "User Commands"
+.TH FAIL2BAN-REGEX "1" "March 2014" "fail2ban-regex 0.9.0" "User Commands"
 .SH NAME
 fail2ban-regex \- test Fail2ban "failregex" option
 .SH SYNOPSIS
@@ -17,6 +17,9 @@ a string representing a log line
 .TP
 filename
 path to a log file (\fI/var/log/auth.log\fP)
+.TP
+"systemd\-journal"
+search systemd journal (systemd\-python required)
 .SS "REGEX:"
 .TP
 string
@@ -39,6 +42,19 @@ show program's version number and exit
 \fB\-h\fR, \fB\-\-help\fR
 show this help message and exit
 .TP
+\fB\-d\fR DATEPATTERN, \fB\-\-datepattern\fR=\fIDATEPATTERN\fR
+set custom pattern used to match date/times
+.TP
+\fB\-e\fR ENCODING, \fB\-\-encoding\fR=\fIENCODING\fR
+File encoding. Default: system locale
+.TP
+\fB\-L\fR MAXLINES, \fB\-\-maxlines\fR=\fIMAXLINES\fR
+maxlines for multi\-line regex
+.TP
+\fB\-m\fR JOURNALMATCH, \fB\-\-journalmatch\fR=\fIJOURNALMATCH\fR
+journalctl style matches overriding filter file.
+"systemd\-journal" only
+.TP
 \fB\-l\fR LOG_LEVEL, \fB\-\-log\-level\fR=\fILOG_LEVEL\fR
 Log level for the Fail2Ban logger to use
 .TP
@@ -48,11 +64,17 @@ Be verbose in output
 \fB\-D\fR, \fB\-\-debuggex\fR
 Produce debuggex.com urls for debugging there
 .TP
+\fB\-\-print\-no\-missed\fR
+Do not print any missed lines
+.TP
+\fB\-\-print\-no\-ignored\fR
+Do not print any ignored lines
+.TP
 \fB\-\-print\-all\-missed\fR
-Either to print all missed lines
+Print all missed lines, no matter how many
 .TP
 \fB\-\-print\-all\-ignored\fR
-Either to print all ignored lines
+Print all ignored lines, no matter how many
 .TP
 \fB\-t\fR, \fB\-\-log\-traceback\fR
 Enrich log\-messages with compressed tracebacks

man/fail2ban-server.1

@@ -1,12 +1,12 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.41.2.
-.TH FAIL2BAN-SERVER "1" "January 2014" "fail2ban-server v0.8.12" "User Commands"
+.TH FAIL2BAN-SERVER "1" "March 2014" "fail2ban-server v0.9.0" "User Commands"
 .SH NAME
 fail2ban-server \- start the server
 .SH SYNOPSIS
 .B fail2ban-server
 [\fIOPTIONS\fR]
 .SH DESCRIPTION
-Fail2Ban v0.8.12 reads log file that contains password failure report
+Fail2Ban v0.9.0 reads log file that contains password failure report
 and bans the corresponding IP addresses using firewall rules.
 .PP
 Only use this command for debugging purpose. Start the server with

man/generate-man

@@ -2,7 +2,7 @@
 
 # fail2ban-client
 echo -n "Generating fail2ban-client "
-help2man --section=1 --no-info --include=fail2ban-client.h2m --output fail2ban-client.1 ../fail2ban-client
+help2man --section=1 --no-info --include=fail2ban-client.h2m --output fail2ban-client.1 ../bin/fail2ban-client
 echo "[done]"
 echo -n "Patching fail2ban-client   "
 # Changes the title.
@@ -33,12 +33,12 @@ echo "[done]"
 
 # fail2ban-server
 echo -n "Generating fail2ban-server "
-help2man --section=1 --no-info --include=fail2ban-server.h2m --output fail2ban-server.1 ../fail2ban-server
+help2man --section=1 --no-info --include=fail2ban-server.h2m --output fail2ban-server.1 ../bin/fail2ban-server
 echo "[done]"
 
 # fail2ban-regex
 echo -n "Generating fail2ban-regex  "
-help2man --section=1 --no-info --include=fail2ban-regex.h2m --output fail2ban-regex.1 ../fail2ban-regex
+help2man --section=1 --no-info --include=fail2ban-regex.h2m --output fail2ban-regex.1 ../bin/fail2ban-regex
 echo "[done]"
 echo -n "Patching fail2ban-regex    "
 # Changes the title.