[Nut-upsdev] RFC: boilerplate text in driver man pages

Charles Lepple clepple at gmail.com
Tue Sep 15 02:27:42 UTC 2009


With AsciiDoc, we can make use of some macros to cut down on some of  
the repetition in the driver man pages.

I don't want to go overboard on this, though - I know that drivers  
aren't meant to be invoked directly by users anyway.

I propose that we put all of the gory details into the nutupsdrv(8)  
man page (mostly there anyway), and just add a few basic options to  
the SYNOPSIS section of each driver page for completeness:

  -h (help)
  -V (version)
  -a ups-id (auto-start)
  -D (debug)

For "-D" we can continue to include the admonition about not sending  
debug info unless requested, and even leave out the fact that you can  
pass multiple "-D" options (which could be mentioned on nutupsdrv(8)).


More information about the Nut-upsdev mailing list