Merge pull request #3903 from pano9000/docs_status-flavor

docs: explicitly list supported status flavors
pull/3909/head
Sergey G. Brester 2024-12-21 18:43:32 +01:00 committed by GitHub
commit b6aebc333c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 7 additions and 7 deletions

View File

@ -58,7 +58,7 @@ protocol = [
["banned", "return jails with banned IPs as dictionary"], ["banned", "return jails with banned IPs as dictionary"],
["banned <IP> ... <IP>]", "return list(s) of jails where given IP(s) are banned"], ["banned <IP> ... <IP>]", "return list(s) of jails where given IP(s) are banned"],
["status", "gets the current status of the server"], ["status", "gets the current status of the server"],
["status --all [FLAVOR]", "gets the current status of all jails, with optional flavor or extended info"], ["status --all [FLAVOR]", "gets the current status of all jails, with optional output style [FLAVOR]. Flavors: 'basic' (default), 'cymru', 'short', 'stats'"],
["stat[istic]s", "gets the current statistics of all jails as table"], ["stat[istic]s", "gets the current statistics of all jails as table"],
["ping", "tests if the server is alive"], ["ping", "tests if the server is alive"],
["echo", "for internal usage, returns back and outputs a given string"], ["echo", "for internal usage, returns back and outputs a given string"],
@ -84,7 +84,7 @@ protocol = [
["add <JAIL> <BACKEND>", "creates <JAIL> using <BACKEND>"], ["add <JAIL> <BACKEND>", "creates <JAIL> using <BACKEND>"],
["start <JAIL>", "starts the jail <JAIL>"], ["start <JAIL>", "starts the jail <JAIL>"],
["stop <JAIL>", "stops the jail <JAIL>. The jail is removed"], ["stop <JAIL>", "stops the jail <JAIL>. The jail is removed"],
["status <JAIL> [FLAVOR]", "gets the current status of <JAIL>, with optional flavor or extended info"], ["status <JAIL> [FLAVOR]", "gets the current status of <JAIL>, with optional output style [FLAVOR]. Flavors: 'basic' (default), 'cymru', 'short', 'stats'"],
['', "JAIL CONFIGURATION", ""], ['', "JAIL CONFIGURATION", ""],
["set <JAIL> idle on|off", "sets the idle state of <JAIL>"], ["set <JAIL> idle on|off", "sets the idle state of <JAIL>"],
["set <JAIL> ignoreself true|false", "allows the ignoring of own IP addresses"], ["set <JAIL> ignoreself true|false", "allows the ignoring of own IP addresses"],

View File

@ -125,8 +125,8 @@ server
.TP .TP
\fBstatus \fB\-\-all\fR [FLAVOR]\fR \fBstatus \fB\-\-all\fR [FLAVOR]\fR
gets the current status of all gets the current status of all
jails, with optional flavor or jails, with optional output style [FLAVOR].
extended info Flavors: 'basic' (default), 'cymru', 'short', 'stats'.
.TP .TP
\fBstat[istic]s\fR \fBstat[istic]s\fR
gets the current statistics of all gets the current statistics of all
@ -217,9 +217,9 @@ stops the jail <JAIL>. The jail is
removed removed
.TP .TP
\fBstatus <JAIL> [FLAVOR]\fR \fBstatus <JAIL> [FLAVOR]\fR
gets the current status of <JAIL>, gets the current status of all
with optional flavor or extended jails, with optional output style [FLAVOR].
info Flavors: 'basic' (default), 'cymru', 'short', 'stats'.
.IP .IP
JAIL CONFIGURATION JAIL CONFIGURATION
.TP .TP