mobinmob / s6-networking-man-pages

mdoc versions of the documentation for the s6-networking suite

Summary

This repository provides mdoc(7) ports of the HTML documentation for the s6-networking suite. The HTML version on the s6-networking site is authoritative; in the event of semantic differences between an HTML original and its port, please open an issue in this repository.

Individual man pages can be produced with mandoc(1):

$ mandoc s6-clockadd.1.in > s6-clockadd.1

Alternatively, use the -a flag to view them directly:

$ mandoc -a s6-clockadd.1.in

man(7) and HTML versions can be produced with mandoc's -T flag:

$ mandoc -T man s6-clockadd.1.in > s6-clockadd.1.man
$ mandoc -T html s6-clockadd.1.in > s6-clockadd.1.html

To install the man pages, run make, followed by the appropriate install command for your system:

• make install-mdoc for mandoc-based systems;
• make install-man otherwise.

The default installation directory is /usr/share/man, but this can be changed by setting the MANPATH environment variable prior to running make install-*. The user running make install-* will need to have the appropriate permissions for installation in the chosen directory.

The man pages can be uninstalled by running make uninstall.