Nut upsdev - Sep 2009 - RFC: boilerplate text in driver man pages

All,

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)).

Thoughts?

Hey Charles

2009/9/15 Charles Lepple <clepple at gmail.com>
> All,
>
> 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)).
>
> Thoughts?
>
we should use "BASIC OPTIONS" instead of the standard
"OPTIONS" used in
nutupsdrv
also making a direct link to nutupsdrv (with the standard boilerplate "for
other avail. options, refer to...") is a good idea.

cheers
Arnaud
-- 
Linux / Unix Expert R&D - Eaton - http://www.eaton.com/mgeops
Network UPS Tools (NUT) Project Leader - http://www.networkupstools.org/
Debian Developer - http://www.debian.org
Free Software Developer - http://arnaud.quette.free.fr/
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.alioth.debian.org/pipermail/nut-upsdev/attachments/20090916/55d95b18/attachment.htm>