[Nut-upsdev] updates to man pages

Arnaud Quette aquette.dev at gmail.com
Fri Jan 2 09:31:32 UTC 2009


2008/12/31 Charles Lepple <clepple at gmail.com>

> Attached is a patch to hopefully improve the wording of some of the man
> pages.
>
> I will commit this in the next few days, but I wanted to give the
> driver authors a chance to comment.
>
> One thing that I feel is important is cross-referencing between the
> man pages. On the off-chance that someone does RTFM, it would be good
> if we make sure that a user doesn't have to read too far in order to
> find out whether the driver man page refers to the serial or USB
> driver (and where to go if they are reading the wrong page).
>

indeed. That's part of the general Documentation thing!

Summary:
>  * Update driver list in man/nutupsdrv.8
>  * Small wording and punctuation changes to man/blazer.8
>  * Mention man/bcmxcp_usb.8 in man/bcmxcp.8.
>  * Fix wording of sections written prior to repeater mode. (dummy-ups.8)
>
>  man/bcmxcp.8     |   13 +++++++---
>  man/bcmxcp_usb.8 |    2 +-
>  man/blazer.8     |   12 +++++-----
>  man/dummy-ups.8  |   16 +++++++------
>  man/nutupsdrv.8  |   62
> ++++++++++++++++++++++++++++++++++++++++--------------
>  5 files changed, 71 insertions(+), 34 deletions(-)
>  mode change 100755 => 100644 man/blazer.8
>

I've checked the dummy-ups and nutupsdrv changes, and these are fine.
thanks for the proof reading ;-)

And Happy New Year to you all.

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://people.debian.org/~aquette/
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/20090102/fdaf3a4f/attachment.htm 


More information about the Nut-upsdev mailing list