[X2go-Dev] [PATCH] Edit x2goclient docu

[Mike Gabriel]

Hi all,

On Do 11 Aug 2011 10:37:12 CEST Moritz Struebe wrote:

> On 2011-08-11 10:31, Reinhard Tartler wrote:
>> On Thu, Aug 11, 2011 at 10:20:18 (CEST), Moritz Struebe wrote:
>>
>>> Hi there,
>>>
>>> here is a small patch for the x2goclient-man-page. The wording is a bit
>>> different to the help of the client itself. Is it reasonable to reuse
>>> the output of man for the application? That way there is no need to keep
>>> the documentation in sync.
>> The other way round seems easier to me: change x2goclient's --help
>> output to be parsable by help2man(1), and generate the manpage from
>> this.
>>
>> http://www.gnu.org/software/help2man/
>>
>
> Sounds good to me. Especially formatting man-pages sucks! Extracting
> documentation to a text-file and including that file into the binary
> shouldn't be to difficult. That would simplify maintaining the
> documentation and provide a stronger separation of concerns.
> @Alex: Any opinion on this?

I personally do not like the idea of deriving a man page from command  
output. I expect a command output to be really short and give info in  
a nutshell.

For simple tools like the GNU tools the help2man tool is very neat.

 From a man page for a software like X2go, however, I expect some more  
infos than those presented on ,,x2goclient --help'', esp. in the  
examples section of the man page. To my point of view, we should keep  
this separate and improve the x2goclient man page manually.

Greets,
Mike


-- 

DAS-NETZWERKTEAM
mike gabriel, dorfstr. 27, 24245 barmissen
fon: +49 (4302) 281418, fax: +49 (4302) 281419

GnuPG Key ID 0xB588399B
mail: mike.gabriel at das-netzwerkteam.de, http://das-netzwerkteam.de

freeBusy:
https://mail.das-netzwerkteam.de/freebusy/m.gabriel%40das-netzwerkteam.de.xfb
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: Digitale PGP-Unterschrift
URL: <http://lists.x2go.org/pipermail/x2go-dev/attachments/20110814/d309a2df/attachment.pgp>