f2e1524a13
The manpages are generated from pod files using pod2man, but it has been a long time since we last re-generated them, and the new versions of pod2man generate significantly different (and simpler) pages. So this patch just regenerates the man pages, to make future changes easier and more self contained to review.
119 lines
3.7 KiB
Groff
119 lines
3.7 KiB
Groff
.\" -*- mode: troff; coding: utf-8 -*-
|
|
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
|
|
.ie n \{\
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds C`
|
|
. ds C'
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is >0, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.\"
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
|
.de IX
|
|
..
|
|
.nr rF 0
|
|
.if \n(.g .if rF .nr rF 1
|
|
.if (\n(rF:(\n(.g==0)) \{\
|
|
. if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{\
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
. \}
|
|
.\}
|
|
.rr rF
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "chasquid-util 1"
|
|
.TH chasquid-util 1 2025-03-21 "" ""
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH NAME
|
|
chasquid\-util \- chasquid management tool
|
|
.SH SYNOPSIS
|
|
.IX Header "SYNOPSIS"
|
|
\&\fBchasquid-util\fR [\fIoptions\fR] user-add \fIuser@domain\fR [\-\-password=\fIpassword\fR] [\-\-receive_only]
|
|
.PP
|
|
\&\fBchasquid-util\fR [\fIoptions\fR] user-remove \fIuser@domain\fR
|
|
.PP
|
|
\&\fBchasquid-util\fR [\fIoptions\fR] authenticate \fIuser@domain\fR [\-\-password=\fIpassword\fR]
|
|
.PP
|
|
\&\fBchasquid-util\fR [\fIoptions\fR] check-userdb \fIdomain\fR
|
|
.PP
|
|
\&\fBchasquid-util\fR [\fIoptions\fR] aliases-resolve \fIaddr\fR
|
|
.PP
|
|
\&\fBchasquid-util\fR [\fIoptions\fR] domaininfo-remove \fIdomain\fR
|
|
.PP
|
|
\&\fBchasquid-util\fR [\fIoptions\fR] print-config
|
|
.SH DESCRIPTION
|
|
.IX Header "DESCRIPTION"
|
|
chasquid-util is a command-line utility for \fBchasquid\fR\|(1) operations.
|
|
.SH OPTIONS
|
|
.IX Header "OPTIONS"
|
|
.IP "\fBuser-add\fR \fIuser@domain\fR [\-\-password=\fIpassword\fR] [\-\-receive_only]" 8
|
|
.IX Item "user-add user@domain [--password=password] [--receive_only]"
|
|
Add a new user to the domain.
|
|
.Sp
|
|
If \fI\-\-receive_only\fR is given, then the user will never successfully
|
|
authenticate. This is useful when creating receive-only users.
|
|
.IP "\fBuser-remove\fR \fIuser@domain\fR" 8
|
|
.IX Item "user-remove user@domain"
|
|
Remove the user from the domain.
|
|
.IP "\fBauthenticate\fR \fIuser@domain\fR [\-\-password=\fIpassword\fR]" 8
|
|
.IX Item "authenticate user@domain [--password=password]"
|
|
Check the user's password.
|
|
.IP "\fBcheck-userdb\fR \fIdomain\fR" 8
|
|
.IX Item "check-userdb domain"
|
|
Check the integrity of the domain's users database.
|
|
.IP "\fBaliases-resolve\fR \fIaddr\fR" 8
|
|
.IX Item "aliases-resolve addr"
|
|
Resolve the given address. Talks to the running chasquid instance.
|
|
.IP "\fBdomaininfo-remove\fR \fIdomain\fR" 8
|
|
.IX Item "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.
|
|
.IP \fBprint-config\fR 8
|
|
.IX Item "print-config"
|
|
Parse and print the configuration in a human-readable way.
|
|
.IP "\fB\-C\fR or \fB\-\-config_dir=<path\fR>" 8
|
|
.IX Item "-C or --config_dir=<path>"
|
|
Configuration directory.
|
|
.IP \fB\-\-configdir=<path\fR> 8
|
|
.IX Item "--configdir=<path>"
|
|
Deprecated alias for \fB\-\-config_dir=<path\fR>.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fBchasquid\fR\|(1)
|