manpages rewritten/converted in ReStructuredText

openv / vcontrold

:fire: vcontrold Daemon for control and logging of Viessmann® type heating devices

https://github.com/openv/openv/wiki

GNU General Public License v3.0

102 stars 57 forks source link

manpages rewritten/converted in ReStructuredText #11

Closed speters closed 6 years ago

speters commented 6 years ago

Basically the same as https://github.com/openv/vcontrold/pull/10

This branch features

rewritten or newly written manual pages in ReStructuredText format
conversion of vcontrold manpage to ReStructuredText
conversion to "standard unix" troff man format using rst2man

There are some minor hiccups, as e.g.

a table in vclient.1 rendered with an empty line between 1st and 2nd row
option lists required some weird escaping of - to \- - I could not spot exactly why

l3u commented 6 years ago

Nice work :-) I only did a little bit of formatting (as I'm the formatting guy here ;-)

I also changed the variable names. I think it's always meaningful to choose expressive ones (just a suggestion! If you don't like it, revert it!). If you want, you can read through https://community.kde.org/Policies/Kdelibs_Coding_Style for the style we use e. g. at KPhotoAlbum and I personally also use for other projects. Most of it is really meaningful and handy.

speters commented 6 years ago

Thx for all those fixes and helpful comments!

speters commented 6 years ago

Merged into master.