Software / code / prosody-modules
Changeset
4422:2047dd56cc40
mod_invites: add extensive help message
| author | Jonas Schäfer <jonas@wielicki.name> |
|---|---|
| date | Mon, 01 Feb 2021 16:43:27 +0100 |
| parents | 4421:94805a7e7b30 |
| children | 4423:ca821df93cb9 |
| files | mod_invites/mod_invites.lua |
| diffstat | 1 files changed, 25 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_invites/mod_invites.lua Sun Jan 31 19:16:36 2021 +0100 +++ b/mod_invites/mod_invites.lua Mon Feb 01 16:43:27 2021 +0100 @@ -262,7 +262,31 @@ while #arg > 0 do local value = arg[1]; table.remove(arg, 1); - if value == "--reset" then + if value == "--help" then + print("usage: prosodyctl mod_"..module.name.." generate DOMAIN --reset USERNAME") + print("usage: prosodyctl mod_"..module.name.." generate DOMAIN [--admin] [--role ROLE] [--group GROUPID]...") + print() + print("This command has two modes: password reset and new account.") + print("If --reset is given, the command operates in password reset mode and in new account mode otherwise.") + print() + print("required arguments in password reset mode:") + print() + print(" --reset USERNAME Generate a password reset link for the given USERNAME.") + print() + print("optional arguments in new account mode:") + print() + print(" --admin Make the new user privileged") + print(" Equivalent to --role prosody:admin") + print(" --role ROLE Grant the given ROLE to the new user") + print(" --group GROUPID Add the user to the group with the given ID") + print(" Can be specified multiple times") + print() + print("--role and --admin override each other; the last one wins") + print("--group can be specified multiple times; the user will be added to all groups.") + print() + print("--reset and the other options cannot be mixed.") + return 2 + elseif value == "--reset" then local nodeprep = require "util.encodings".stringprep.nodeprep; local username = nodeprep(arg[1]) table.remove(arg, 1);
