github
/
fail2ban
mirror of https://github.com/fail2ban/fail2ban
1
0
Fork 0
Code Issues Releases Wiki Activity

DOC: rudimentary manpage for fail2ban-testcases (+updated other mans for consistency)

pull/1098/head
Yaroslav Halchenko 2015-07-05 21:46:39 -04:00
parent 38f8e1a82a
commit 46510948a7
7 changed files with 59 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
ChangeLog
View File

@ -36,6 +36,7 @@ ver. 0.9.3 (2015/XX/XXX) - wanna-be-released
multiple CF accounts, and jail.conf got new compound action
definition action_cf_mwl to submit cloudflare report.
* Check access to socket for more detailed logging on error (gh-595)
* fail2ban-testcases man page
ver. 0.9.2 (2015/04/29) - better-quick-now-than-later

6
man/fail2ban-client.1
View File

@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4.
.TH FAIL2BAN-CLIENT "1" "April 2015" "fail2ban-client v0.9.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.6.
.TH FAIL2BAN-CLIENT "1" "July 2015" "fail2ban-client v0.9.2.dev" "User Commands"
.SH NAME
fail2ban-client \- configure and control the server
.SH SYNOPSIS
.B fail2ban-client
[\fI\,OPTIONS\/\fR] \fI\,<COMMAND>\/\fR
.SH DESCRIPTION
Fail2Ban v0.9.2 reads log file that contains password failure report
Fail2Ban v0.9.2.dev reads log file that contains password failure report
and bans the corresponding IP addresses using firewall rules.
.SH OPTIONS
.TP

4
man/fail2ban-regex.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4.
.TH FAIL2BAN-REGEX "1" "April 2015" "fail2ban-regex 0.9.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.6.
.TH FAIL2BAN-REGEX "1" "July 2015" "fail2ban-regex 0.9.2.dev" "User Commands"
.SH NAME
fail2ban-regex \- test Fail2ban "failregex" option
.SH SYNOPSIS

6
man/fail2ban-server.1
View File

@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4.
.TH FAIL2BAN-SERVER "1" "April 2015" "fail2ban-server v0.9.2" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.6.
.TH FAIL2BAN-SERVER "1" "July 2015" "fail2ban-server v0.9.2.dev" "User Commands"
.SH NAME
fail2ban-server \- start the server
.SH SYNOPSIS
.B fail2ban-server
[\fI\,OPTIONS\/\fR]
.SH DESCRIPTION
Fail2Ban v0.9.2 reads log file that contains password failure report
Fail2Ban v0.9.2.dev 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

34
man/fail2ban-testcases.1 Normal file
View File

@ -0,0 +1,34 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.6.
.TH FAIL2BAN-TESTCASES "1" "July 2015" "fail2ban-testcases 0.9.2.dev" "User Commands"
.SH NAME
fail2ban-testcases \- run Fail2Ban unit-tests
.SH SYNOPSIS
.B fail2ban-testcases
[\fI\,OPTIONS\/\fR] [\fI\,regexps\/\fR]
.SH DESCRIPTION
Script to run Fail2Ban tests battery
.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-l\fR LOG_LEVEL, \fB\-\-log\-level\fR=\fI\,LOG_LEVEL\/\fR
Log level for the logger to use during running tests
.TP
\fB\-n\fR, \fB\-\-no\-network\fR
Do not run tests that require the network
.TP
\fB\-t\fR, \fB\-\-log\-traceback\fR
Enrich log\-messages with compressed tracebacks
.TP
\fB\-\-full\-traceback\fR
Either to make the tracebacks full, not compressed (as
by default)
.SH "SEE ALSO"
.br
fail2ban-client(1)
fail2ban-server(1)
fail2ban-regex(1)

11
man/fail2ban-testcases.h2m Normal file
View File

@ -0,0 +1,11 @@
Include file for help2man man page
$Id: $
[name]
fail2ban-testcases \- run Fail2Ban unit-tests
[see also]
.br
fail2ban-client(1)
fail2ban-server(1)
fail2ban-regex(1)

5
man/generate-man
View File

@ -40,6 +40,11 @@ echo -n "Generating fail2ban-server "
help2man --section=1 --no-info --include=fail2ban-server.h2m --output fail2ban-server.1 ../bin/fail2ban-server
echo "[done]"
# fail2ban-testcases
echo -n "Generating fail2ban-testcases "
help2man --section=1 --no-info --include=fail2ban-testcases.h2m --output fail2ban-testcases.1 ../bin/fail2ban-testcases
echo "[done]"
# fail2ban-regex
echo -n "Generating fail2ban-regex "
help2man --section=1 --no-info --include=fail2ban-regex.h2m --output fail2ban-regex.1 ../bin/fail2ban-regex