mirrors/maddy
1
0
Fork 0
mirror of https://github.com/foxcpp/maddy.git synced 2025-04-07 06:57:37 +03:00
Code Issues Projects Releases Packages Wiki Activity
maddy/docs/man
History
fox.cpp c83a2f09dc
docs: Fix a number of links in documentation 
Remove link to CONTRIBUTING.md from README.md since it is included
in documentation build and results in broken link since CONTRIBUTING.md
is not included. It does not seem to be possible to include files from
parent directories and symlinks do not work.

Fix man page link in seclevels.md.

Add missing maddy-tables(5) link in maddy(1) "See Also".

Closes #223.
2020-05-31 19:07:40 +03:00
..
.gitignore docs: Move the project documentation from GitHub Wiki 2019-12-06 22:56:47 +03:00
maddy-auth.5.scd Update refernecs to file table module 2020-05-04 23:00:20 +03:00
maddy-config.5.scd pkg/cfgparser: Rework environment expansion syntax 2020-02-04 20:03:19 +03:00
maddy-filters.5.scd modify/dkim: Allow to sign emails from subdomains using a top domain key 2020-05-28 20:42:28 +00:00
maddy-imap.5.scd docs: Move the project documentation from GitHub Wiki 2019-12-06 22:56:47 +03:00
maddy-smtp.5.scd Update refernecs to file table module 2020-05-04 23:00:20 +03:00
maddy-storage.5.scd storage/imapsql: Implement module.Table interface 2020-05-23 02:55:45 +03:00
maddy-tables.5.scd Update refernecs to file table module 2020-05-04 23:00:20 +03:00
maddy-targets.5.scd add docs 2020-05-28 20:30:03 +00:00
maddy-tls.5.scd docs: Move the project documentation from GitHub Wiki 2019-12-06 22:56:47 +03:00
maddy.1.scd docs: Fix a number of links in documentation 2020-05-31 19:07:40 +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

README.md

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.