mirror of
https://github.com/foxcpp/maddy.git
synced 2025-04-04 21:47:40 +03:00
f931cbfe45
New script build.sh is much more suitable for downstream packaging (e.g. ./build.sh package) than hacked together package.sh wrapper for get.sh while still being usable for "effort-less" installation. Additionally, hostname setting in get.sh is flawed in many ways and is not reimplemented in build.sh. build.sh has proper command line options that allow to customize build configuration and installation prefixes. Documentation page get.sh is removed since all applicable environment variables and flags are documented in ./build.sh --help. build.sh can be called from the source directory to build maddy from *this* source instead of forced 'go get' that was used in get.sh. However, if build.sh is called not from the source directory, it clones the repo and (optionally) uses the specified commit. This keeps build.sh usable in curl|bash commands. Due to the way source code is fetched, build.sh uses Git tags instead of Go module versions as get.sh did. |
||
|---|---|---|
| .. | ||
| .gitignore | ||
| maddy-auth.5.scd | ||
| maddy-config.5.scd | ||
| maddy-filters.5.scd | ||
| maddy-imap.5.scd | ||
| maddy-smtp.5.scd | ||
| maddy-storage.5.scd | ||
| maddy-targets.5.scd | ||
| maddy-tls.5.scd | ||
| maddy.1.scd | ||
| prepare_md.py | ||
| 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.