maddy/docs/man/README.md
fox.cpp d886ddd297
docs: Move the project documentation from GitHub Wiki
Having it in the same directory as the source code makes it simplier to
keep in sync with the source code itself.
2019-12-06 22:56:47 +03:00

497 B

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

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