1
0
mirror of https://blitiri.com.ar/repos/chasquid synced 2025-12-17 14:37:02 +00:00

docs: Regenerate man pages with a newer version of pod2man

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.
This commit is contained in:
Alberto Bertogli
2025-05-02 12:09:38 +01:00
parent 2d228f726d
commit f2e1524a13
4 changed files with 67 additions and 379 deletions

View File

@@ -1,4 +1,5 @@
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -15,29 +16,12 @@
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
@@ -68,88 +52,26 @@
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "chasquid 1"
.TH chasquid 1 "2023-10-03" "" ""
.TH chasquid 1 2023-10-03 "" ""
.\" 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"
.SH NAME
chasquid \- SMTP (email) server
.SH "SYNOPSIS"
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBchasquid\fR [\fIoptions\fR...]
.SH "DESCRIPTION"
.SH DESCRIPTION
.IX Header "DESCRIPTION"
chasquid is an \s-1SMTP\s0 (email) server with a focus on simplicity, security, and
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.
.SH "OPTIONS"
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-config_dir\fR \fIdir\fR" 8
.IX Item "-config_dir dir"
@@ -159,13 +81,13 @@ configuration directory (default \fI/etc/chasquid\fR)
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
.IP \fB\-alsologtostderr\fR 8
.IX Item "-alsologtostderr"
also log to stderr, in addition to the file
.IP "\fB\-logfile\fR \fIfile\fR" 8
.IX Item "-logfile file"
file to log to (enables logtime)
.IP "\fB\-logtime\fR" 8
.IP \fB\-logtime\fR 8
.IX Item "-logtime"
include the time when writing the log to stderr
.IP "\fB\-logtosyslog\fR \fItag\fR" 8
@@ -174,50 +96,50 @@ log to syslog, with the given tag
.IP "\fB\-v\fR \fIlevel\fR" 8
.IX Item "-v level"
verbosity level (1 = debug)
.IP "\fB\-version\fR" 8
.IP \fB\-version\fR 8
.IX Item "-version"
show version and exit
.SH "FILES"
.SH FILES
.IX Header "FILES"
The daemon's 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:
.IP "\fIchasquid.conf\fR" 8
.IP \fIchasquid.conf\fR 8
.IX Item "chasquid.conf"
Main config file, see \fBchasquid.conf\fR\|(5).
.IP "\fIdomains/\fR" 8
.IP \fIdomains/\fR 8
.IX Item "domains/"
Per-domain configuration.
.IP "\fIdomains/example.com/\fR" 8
.IP \fIdomains/example.com/\fR 8
.IX Item "domains/example.com/"
Domain-specific configuration. Can be empty.
.IP "\fIdomains/example.com/users\fR" 8
.IP \fIdomains/example.com/users\fR 8
.IX Item "domains/example.com/users"
User and password database for this domain.
.IP "\fIdomains/example.com/aliases\fR" 8
.IP \fIdomains/example.com/aliases\fR 8
.IX Item "domains/example.com/aliases"
Aliases for the domain.
.IP "\fIcerts/\fR" 8
.IP \fIcerts/\fR 8
.IX Item "certs/"
Certificates to use, one directory per pair.
.IP "\fIcerts/mx.example.com/\fR" 8
.IP \fIcerts/mx.example.com/\fR 8
.IX Item "certs/mx.example.com/"
Certificates for this domain.
.IP "\fIcerts/mx.example.com/fullchain.pem\fR" 8
.IP \fIcerts/mx.example.com/fullchain.pem\fR 8
.IX Item "certs/mx.example.com/fullchain.pem"
Certificate (full chain).
.IP "\fIcerts/mx.example.com/privkey.pem\fR" 8
.IP \fIcerts/mx.example.com/privkey.pem\fR 8
.IX Item "certs/mx.example.com/privkey.pem"
Private key.
.PP
Note the \fIcerts/\fR directory layout matches the one from certbot (client for
Let's Encrypt \s-1CA\s0), so you can just symlink \fIcerts/\fR to
Let's 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 (\*(L"mail\*(R" in the example
Make sure the user you use to run chasquid under ("mail" in the example
config) can access the certificates and private keys.
.SH "CONTACT"
.SH CONTACT
.IX Header "CONTACT"
Main website <https://blitiri.com.ar/p/chasquid>.
.PP