Improved --help.

This commit is contained in:
josedpedroso 2018-07-05 00:53:09 +01:00
parent 525bfa6bae
commit 44bb213a72
1 changed files with 10 additions and 10 deletions

View File

@ -445,20 +445,20 @@ def websockify_init():
"directory containing configuration files of this form " "directory containing configuration files of this form "
"(DEPRECATED: use `--token-plugin TokenFile --token-source " "(DEPRECATED: use `--token-plugin TokenFile --token-source "
" path/to/token/file` instead)") " path/to/token/file` instead)")
parser.add_option("--token-plugin", default=None, metavar="PLUGIN", parser.add_option("--token-plugin", default=None, metavar="CLASS",
help="use the given Python class to process tokens " help="use a Python class, usually one from websockify.token_plugins, "
"into host:port pairs") "such as TokenFile, to process tokens into host:port pairs")
parser.add_option("--token-source", default=None, metavar="ARG", parser.add_option("--token-source", default=None, metavar="ARG",
help="an argument to be passed to the token plugin" help="an argument to be passed to the token plugin "
"on instantiation") "on instantiation")
parser.add_option("--auth-plugin", default=None, metavar="PLUGIN", parser.add_option("--auth-plugin", default=None, metavar="CLASS",
help="use the given Python class to determine if " help="use a Python class, usually one from websockify.auth_plugins, "
"a connection is allowed") "such as BasicHTTPAuth, to determine if a connection is allowed")
parser.add_option("--auth-source", default=None, metavar="ARG", parser.add_option("--auth-source", default=None, metavar="ARG",
help="an argument to be passed to the auth plugin" help="an argument to be passed to the auth plugin "
"on instantiation") "on instantiation")
parser.add_option("--heartbeat", type=int, default=0, parser.add_option("--heartbeat", type=int, default=0, metavar="INTERVAL",
help="send a ping to the client every HEARTBEAT seconds") help="send a ping to the client every INTERVAL seconds")
parser.add_option("--log-file", metavar="FILE", parser.add_option("--log-file", metavar="FILE",
dest="log_file", dest="log_file",
help="File where logs will be saved") help="File where logs will be saved")