fa074ec16c
There's an inconsistency between chasquid (which uses `--config_dir`) and chasquid-util (which uses `--configdir`). That is prone to cause confusion, so this patch renames chasquid-util's flag, leaving the old one as deprecated with a warning message. Closes https://github.com/albertito/chasquid/pull/60. Amended-by: Alberto Bertogli <albertito@blitiri.com.ar> Added test case for the deprecated option, adjusted commit message.
70 lines
1.7 KiB
Markdown
70 lines
1.7 KiB
Markdown
# NAME
|
|
|
|
chasquid-util - chasquid management tool
|
|
|
|
# SYNOPSIS
|
|
|
|
**chasquid-util** \[_options_\] user-add _user@domain_ \[--password=_password_\] \[--receive\_only\]
|
|
|
|
**chasquid-util** \[_options_\] user-remove _user@domain_
|
|
|
|
**chasquid-util** \[_options_\] authenticate _user@domain_ \[--password=_password_\]
|
|
|
|
**chasquid-util** \[_options_\] check-userdb _domain_
|
|
|
|
**chasquid-util** \[_options_\] aliases-resolve _addr_
|
|
|
|
**chasquid-util** \[_options_\] domaininfo-remove _domain_
|
|
|
|
**chasquid-util** \[_options_\] print-config
|
|
|
|
# DESCRIPTION
|
|
|
|
chasquid-util is a command-line utility for [chasquid(1)](chasquid.1.md) operations.
|
|
|
|
# OPTIONS
|
|
|
|
- **user-add** _user@domain_ \[--password=_password_\] \[--receive\_only\]
|
|
|
|
Add a new user to the domain.
|
|
|
|
If _--receive\_only_ is given, then the user will never successfully
|
|
authenticate. This is useful when creating receive-only users.
|
|
|
|
- **user-remove** _user@domain_
|
|
|
|
Remove the user from the domain.
|
|
|
|
- **authenticate** _user@domain_ \[--password=_password_\]
|
|
|
|
Check the user's password.
|
|
|
|
- **check-userdb** _domain_
|
|
|
|
Check the integrity of the domain's users database.
|
|
|
|
- **aliases-resolve** _addr_
|
|
|
|
Resolve the given address. Talks to the running chasquid instance.
|
|
|
|
- **domaininfo-remove** _domain_
|
|
|
|
Remove the domain information entry. This can be used to manually allow a
|
|
security level downgrade. Talks to the running chasquid instance.
|
|
|
|
- **print-config**
|
|
|
|
Parse and print the configuration in a human-readable way.
|
|
|
|
- **-C** or **--config\_dir=<path**>
|
|
|
|
Configuration directory.
|
|
|
|
- **--configdir=<path**>
|
|
|
|
Deprecated alias for **--config\_dir=<path**>.
|
|
|
|
# SEE ALSO
|
|
|
|
[chasquid(1)](chasquid.1.md)
|