Man Pages that Should Exist
Todo
- sahpi.7 - over of the spec, ref other man pages (and spec)
- hpi*.1 - all the hpi clients
- openhpid.1 - overview of the daemon, all config flags
- openhpi.conf.5 - document all elements of the conf file
- saHpi*.3 - all saHpi functions, add specifc openhpisms to it (ad gnome-doc, then auto gen)
- oHpi*.3 - all oHpi exported functions (should be able to auto gen from gnome-doc)
- oh_*.3 - all oh_ exported utility functions (should be able to auto gen from gnome-doc)
Done
- openhpi-switcher.1 - overview of openhpi switcher command.
- openhpi.7 - overview of the library, ref other man pages. (Todo: This should include all known environmental variables as well)
How to Write a Man Page
Write it in POD (man perlpod). There are other ways to do this, but this requires the least amount of learning new markup. pod2man is the converter that turns this into groff.
File should be named $file.pod.# (where # is man section number) in man/ dir of openhpi.
Everything else will just work.
