maddy/docs/man
2021-05-07 11:28:41 +03:00
..
.gitignore docs: Move the project documentation from GitHub Wiki 2019-12-06 22:56:47 +03:00
maddy-auth.5.scd Remove remaining references to 0.3 module names in code and docs 2020-12-13 19:47:27 +03:00
maddy-config.5.scd pkg/cfgparser: Rework environment expansion syntax 2020-02-04 20:03:19 +03:00
maddy-filters.5.scd check/spf: Change default action for softfail to 'ignore' 2021-04-30 23:56:06 +03:00
maddy-imap.5.scd Implement "IMAP filters" 2020-07-17 23:33:59 +03:00
maddy-smtp.5.scd endpoint/smtp: Allow to change the line length limit enforced by go-smtp 2021-05-07 11:28:41 +03:00
maddy-storage.5.scd docs: Fix Invalid catch-all Example (#353) 2021-05-03 01:51:17 +03:00
maddy-tables.5.scd docs: Update a number of snippets using outdated module names 2020-12-06 02:49:02 +03:00
maddy-targets.5.scd target/smtp: Do not attempt STARTTLS by default for LMTP connections 2020-12-06 14:15:32 +03:00
maddy-tls.5.scd Migrate TLS certificate loading to use modules for sources 2020-07-15 17:58:47 +03:00
maddy.1.scd docs: Split maddy(1) and maddy(5) 2020-07-15 01:31:05 +03:00
maddy.5.scd Remake Prometheus endpoint into a proper endpoint module 2020-08-23 15:41:52 +03:00
prepare_md.py docs: Move the project documentation from GitHub Wiki 2019-12-06 22:56:47 +03:00
README.md Rewrite build scripts 2020-02-07 20:33:58 +03:00

maddy manual pages

The reference documentation is maintained in the scdoc format and is compiled into a set of Unix man pages viewable using the standard man utility.

See https://git.sr.ht/~sircmpwn/scdoc for information about the tool used to build pages. It can be used as follows:

scdoc < maddy-filters.5.scd > maddy-filters.5
man ./maddy-filters.5

build.sh script in the repo root compiles and installs man pages if the scdoc utility is installed in the system.