OpenLightingProject / ola

The Open Lighting Architecture - The Travel Adaptor for the Lighting Industry
https://www.openlighting.org/ola/
Other
648 stars 206 forks source link

Consider switching to help2man #940

Open peternewman opened 9 years ago

peternewman commented 9 years ago

https://www.gnu.org/software/help2man/

Possibly for the Python tools at least, or extend our flag code to use some similar options.

peternewman commented 9 years ago

It seems to work okay, with only minor initial tweaking needed: help2man -N -n "Gather RDM model info from responders" --version-string=" " -o man/rdm_model_collector.py.1 tools/rdm/rdm_model_collector.py help2man -N -n "Test RDM responders for adherance to the standards" --version-string=" " -o man/rdm_responder_test.py.1 tools/rdm/rdm_responder_test.py help2man -N -n "A web server for testing RDM responders for adherance to the standards" --version-string=" " -o man/rdm_test_server.py.1 tools/rdm/rdm_test_server.py

nomis52 commented 9 years ago

Can we close this?

peternewman commented 8 years ago

help2man -N -n "Get the value of a PID for an RDM device" --version-string=" " -o man/ola_rdm_get.1 ./examples/ola_rdm_get help2man -N -n "Set the value of a PID for an RDM device" --version-string=" " -o man/ola_rdm_set.1 ./examples/ola_rdm_set

peternewman commented 8 years ago

help2man -N -n "Sets the DMX values for a universe." --version-string=" " -o man/ola_set_dmx.1 ./examples/ola_set_dmx