Mirrors/go-chasquid-smtp
1
0
Fork 0
mirror of https://blitiri.com.ar/repos/chasquid synced 2026-10-29 15:02:30 +00:00
Code Releases Activity

docs: Regenerate man pages with a newer version of pod2man

Browse Source 
No content changes, just regeneration with a newer version of pod2man,
so future changes to the sources are cleaner and easier to review.
This commit is contained in:
Alberto Bertogli
2026-09-27 20:45:21 +01:00
parent a09963d91f
commit f22d2289af
5 changed files with 59 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/man/chasquid-util.1
+22 -19
View File
@@ -1,5 +1,5 @@
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -52,6 +52,9 @@
. \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "chasquid-util 1"
@@ -64,49 +67,49 @@
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]
\&\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
\&\fBchasquid\-util\fR [\fIoptions\fR] user\-remove \fIuser@domain\fR
.PP
\&\fBchasquid-util\fR [\fIoptions\fR] authenticate \fIuser@domain\fR [\-\-password=\fIpassword\fR]
\&\fBchasquid\-util\fR [\fIoptions\fR] authenticate \fIuser@domain\fR [\-\-password=\fIpassword\fR]
.PP
\&\fBchasquid-util\fR [\fIoptions\fR] check-userdb \fIdomain\fR
\&\fBchasquid\-util\fR [\fIoptions\fR] check\-userdb \fIdomain\fR
.PP
\&\fBchasquid-util\fR [\fIoptions\fR] aliases-resolve \fIaddr\fR
\&\fBchasquid\-util\fR [\fIoptions\fR] aliases\-resolve \fIaddr\fR
.PP
\&\fBchasquid-util\fR [\fIoptions\fR] domaininfo-remove \fIdomain\fR
\&\fBchasquid\-util\fR [\fIoptions\fR] domaininfo\-remove \fIdomain\fR
.PP
\&\fBchasquid-util\fR [\fIoptions\fR] print-config
\&\fBchasquid\-util\fR [\fIoptions\fR] print\-config
.SH DESCRIPTION
.IX Header "DESCRIPTION"
chasquid-util is a command-line utility for \fBchasquid\fR\|(1) operations.
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
.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
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
Check the user\*(Aqs 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
Check the integrity of the domain\*(Aqs 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
.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
.IP \fBprint\-config\fR 8
.IX Item "print-config"
Parse and print the configuration in a human-readable way.
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.
docs/man/chasquid.1
+10 -7
View File
@@ -1,5 +1,5 @@
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -52,6 +52,9 @@
. \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "chasquid 1"
@@ -70,7 +73,7 @@ chasquid \- SMTP (email) server
chasquid is an SMTP (email) server with a focus on simplicity, security, and
ease of operation.
.PP
It's written in Go, and distributed under the Apache license 2.0.
It\*(Aqs written in Go, and distributed under the Apache license 2.0.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-config_dir\fR \fIdir\fR" 8
@@ -78,7 +81,7 @@ It's written in Go, and distributed under the Apache license 2.0.
configuration directory (default \fI/etc/chasquid\fR)
.IP "\fB\-config_overrides\fR \fIconfig\fR" 8
.IX Item "-config_overrides config"
configuration values (in text protobuf format) to override the on-disk
configuration values (in text protobuf format) to override the on\-disk
configuration with. This should only be needed in very specific cases for
deployments where editing the configuration file is not feasible.
.IP \fB\-alsologtostderr\fR 8
@@ -101,7 +104,7 @@ verbosity level (1 = debug)
show version and exit
.SH FILES
.IX Header "FILES"
The daemon's configuration is by default in \fI/etc/chasquid/\fR, and can be
The daemon\*(Aqs configuration is by default in \fI/etc/chasquid/\fR, and can be
changed with the \fI\-config_dir\fR flag.
.PP
Inside that directory, the daemon expects the following structure:
@@ -110,10 +113,10 @@ Inside that directory, the daemon expects the following structure:
Main config file, see \fBchasquid.conf\fR\|(5).
.IP \fIdomains/\fR 8
.IX Item "domains/"
Per-domain configuration.
Per\-domain configuration.
.IP \fIdomains/example.com/\fR 8
.IX Item "domains/example.com/"
Domain-specific configuration. Can be empty.
Domain\-specific configuration. Can be empty.
.IP \fIdomains/example.com/users\fR 8
.IX Item "domains/example.com/users"
User and password database for this domain.
@@ -134,7 +137,7 @@ Certificate (full chain).
Private key.
.PP
Note the \fIcerts/\fR directory layout matches the one from certbot (client for
Let's Encrypt CA), so you can just symlink \fIcerts/\fR to
Let\*(Aqs Encrypt CA), so you can just symlink \fIcerts/\fR to
\&\fI/etc/letsencrypt/live\fR.
.PP
Make sure the user you use to run chasquid under ("mail" in the example
docs/man/chasquid.conf.5
+14 -11
View File
@@ -1,5 +1,5 @@
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -52,10 +52,13 @@
. \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "chasquid.conf 5"
.TH chasquid.conf 5 2025-06-07 "" ""
.TH chasquid.conf 5 2025-05-02 "" ""
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -64,10 +67,10 @@
chasquid.conf(5) \-\- chasquid configuration file
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBchasquid.conf\fR\|(5) is \fBchasquid\fR\|(1)'s main configuration file.
\&\fBchasquid.conf\fR\|(5) is \fBchasquid\fR\|(1)\*(Aqs main configuration file.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The file is in protocol buffers' text format.
The file is in protocol buffers\*(Aq text format.
.PP
Comments start with \f(CW\*(C`#\*(C'\fR. Empty lines are allowed. Values are of the form
\&\f(CW\*(C`key: value\*(C'\fR. Values can be strings (quoted), integers, or booleans (\f(CW\*(C`true\*(C'\fR or
@@ -80,8 +83,8 @@ Some values might be repeated, for example the listening addresses.
.IX Item "hostname (string):"
Default hostname to use when saying hello. This is used to say hello to
clients (for aesthetic purposes), and as the HELO/EHLO domain on outgoing SMTP
connections (so ideally it would resolve back to the server, but it isn't a
big deal if it doesn't). Default: the system's hostname.
connections (so ideally it would resolve back to the server, but it isn\*(Aqt a
big deal if it doesn\*(Aqt). Default: the system\*(Aqs hostname.
.IP "\fBmax_data_size_mb\fR (int):" 8
.IX Item "max_data_size_mb (int):"
Maximum email size, in megabytes. Default: 50.
@@ -97,7 +100,7 @@ which means systemd passes sockets to us. systemd sockets must be named with
\&\fBFileDescriptorName=submission\fR.
.IP "\fBsubmission_over_tls_address\fR (repeated string):" 8
.IX Item "submission_over_tls_address (repeated string):"
Addresses to listen on for submission-over-TLS (usually port 465). Default:
Addresses to listen on for submission\-over\-TLS (usually port 465). Default:
"systemd", which means systemd passes sockets to us. systemd sockets must be
named with \fBFileDescriptorName=submission_tls\fR.
.IP "\fBmonitoring_address\fR (string):" 8
@@ -150,10 +153,10 @@ syslog (at \f(CW\*(C`MAIL|INFO\*(C'\fR priority). If \f(CW\*(C`<stdout>\*(C'\fR
\&\f(CW\*(C`<stderr>\*(C'\fR, log to stderr. Default: \f(CW\*(C`<syslog>\*(C'\fR.
.IP "\fBdovecot_auth\fR (bool):" 8
.IX Item "dovecot_auth (bool):"
Enable dovecot authentication. If true, users that are not found in chasquid's
Enable dovecot authentication. If true, users that are not found in chasquid\*(Aqs
databases will be authenticated via dovecot. Default: \f(CW\*(C`false\*(C'\fR.
.Sp
The path to dovecot's auth sockets is autodetected, but can be manually
The path to dovecot\*(Aqs auth sockets is autodetected, but can be manually
overridden using the \f(CW\*(C`dovecot_userdb_path\*(C'\fR and \f(CW\*(C`dovecot_client_path\*(C'\fR if
needed.
.IP "\fBhaproxy_incoming\fR (bool):" 8
@@ -164,7 +167,7 @@ information is preserved, and SPF checks can be performed properly.
Default: \f(CW\*(C`false\*(C'\fR.
.IP "\fBmax_queue_items\fR (int):" 8
.IX Item "max_queue_items (int):"
\&\fBEXPERIMENTAL\fR, might change in backwards-incompatible ways.
\&\fBEXPERIMENTAL\fR, might change in backwards\-incompatible ways.
.Sp
Maximum number of items in the queue.
.Sp
@@ -173,7 +176,7 @@ careful when increasing this, as we keep all items in memory.
Default: \f(CW200\fR (but may change in the future).
.IP "\fBgive_up_send_after\fR (string):" 8
.IX Item "give_up_send_after (string):"
\&\fBEXPERIMENTAL\fR, might change in backwards-incompatible ways.
\&\fBEXPERIMENTAL\fR, might change in backwards\-incompatible ways.
.Sp
How long do we keep retrying sending an email before we give up. Once we give
up, a DSN will be sent back to the sender.
docs/man/mda-lmtp.1
+7 -4
View File
@@ -1,5 +1,5 @@
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -52,6 +52,9 @@
. \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "mda-lmtp 1"
@@ -64,14 +67,14 @@
mda\-lmtp \- MDA that uses LMTP to do the mail delivery
.SH SYNOPSIS
.IX Header "SYNOPSIS"
mda-lmtp
mda\-lmtp
[\fB\-addr_network\fR \fInet\fR]
\&\fB\-addr\fR \fIaddr\fR
\&\fB\-d\fR \fIrecipient\fR
\&\fB\-f\fR \fIfrom\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
mda-lmtp is a very basic MDA that uses LMTP to do the mail delivery.
mda\-lmtp is a very basic MDA that uses LMTP to do the mail delivery.
.PP
It takes command line arguments similar to maildrop or procmail, reads an
email via standard input, and sends it over the given LMTP server. Supports
@@ -80,7 +83,7 @@ connecting to LMTP servers over UNIX sockets and TCP.
It can be used when your mail server does not support LMTP directly.
.SH EXAMPLE
.IX Header "EXAMPLE"
\&\fBmda-lmtp\fR \fI\-\-addr=localhost:1234\fR \fI\-f juan@casa\fR \fI\-d jose\fR < email
\&\fBmda\-lmtp\fR \fI\-\-addr=localhost:1234\fR \fI\-f juan@casa\fR \fI\-d jose\fR < email
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-addr\fR \fIaddress\fR" 8
docs/man/smtp-check.1
+6 -3
View File
@@ -1,5 +1,5 @@
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -52,6 +52,9 @@
. \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "smtp-check 1"
@@ -64,10 +67,10 @@
smtp\-check \- SMTP setup checker
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBsmtp-check\fR [\-port \fIport\fR] [\-localname \fIdomain\fR] [\-skip_tls_check] \fIdomain\fR
\&\fBsmtp\-check\fR [\-port \fIport\fR] [\-localname \fIdomain\fR] [\-skip_tls_check] \fIdomain\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
smtp-check is a command-line too for checking SMTP setups (DNS records, TLS
smtp\-check is a command\-line too for checking SMTP setups (DNS records, TLS
certificates, SPF, etc.).
.SH OPTIONS
.IX Header "OPTIONS"