[X2go-Dev] [PATCH] Edit x2goclient docu

[Moritz Struebe]

On 2011-08-14 18:23, Mike Gabriel wrote:
> 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

Ok, I understand that. It would be nice to have both somehow organized.
Isn't there some kind of simple documentation system out there for doing
this. IMO man-pages are really ugly and somthing like

#parameter myparam
#shortdesc do somthing (p1, p2, p3)
#longdec myparam activetas some cool feature. p1 dos it this way and p2
does it the other way.

would be awesome. We can't be the only ones with such needs....

Morty

-- 
Dipl.-Ing. Moritz 'Morty' Struebe (Wissenschaftlicher Mitarbeiter)
Lehrstuhl für Informatik 4 (Verteilte Systeme und Betriebssysteme)
Friedrich-Alexander-Universität Erlangen-Nürnberg
Martensstr. 1
91058 Erlangen

Tel   : +49 9131 85-25419
Fax   : +49 9131 85-28732
eMail : struebe at informatik.uni-erlangen.de
WWW   : http://www4.informatik.uni-erlangen.de/~morty




-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 4482 bytes
Desc: S/MIME Kryptografische Unterschrift
URL: <http://lists.x2go.org/pipermail/x2go-dev/attachments/20110815/960c95f1/attachment.bin>