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.
Cheers 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@informatik.uni-erlangen.de WWW : http://www4.informatik.uni-erlangen.de/~morty
On Thu, Aug 11, 2011 at 10:20:18 (CEST), Moritz Struebe wrote:
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/
-- Gruesse/greetings, Reinhard Tartler, KeyID 945348A4
On 2011-08-11 10:31, Reinhard Tartler wrote:
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?
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@informatik.uni-erlangen.de WWW : http://www4.informatik.uni-erlangen.de/~morty
Hi all,
On Do 11 Aug 2011 10:37:12 CEST Moritz Struebe wrote:
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@das-netzwerkteam.de, http://das-netzwerkteam.de
freeBusy: https://mail.das-netzwerkteam.de/freebusy/m.gabriel%40das-netzwerkteam.de.xf...
On 2011-08-14 18:23, Mike Gabriel wrote:
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@informatik.uni-erlangen.de WWW : http://www4.informatik.uni-erlangen.de/~morty
Hi Morty,
On Do 11 Aug 2011 10:20:18 CEST Moritz Struebe wrote:
+1 from me for this patch.
There are more cmdline options for x2goclient (below is a complete list):
1110 --command 1115 --server 1120 --session 1125 --sshport 1130 --user 1135 --rootless 1143 --checkexitstatus UNDOCUMENTED 1151 --showtermbutton UNDOCUMENTED 1159 --showexpbutton UNDOCUMENTED 1167 --showconfig UNDOCUMENTED 1175 --showextconfig UNDOCUMENTED 1183 --showstatusbar UNDOCUMENTED 1191 --showtoolbar UNDOCUMENTED 1200 --sound 1209 --exportfs 1219 --speed 1224 modem 1226 isdn 1228 adsl 1230 wan 1232 lan 1243 --compression 1249 --quality 1255 --dpi 1261 --kbdlayout 1267 --kbdtype 1273 --brokerurl UNDOCUMENTED 1279 --proxy UNDOCUMENTED 1290 --proxysshport UNDOCUMENTED 1295 --cookie UNDOCUMENTED 1300 --x2gosession UNDOCUMENTED 1305 --connectionts UNDOCUMENTED
The number at the beginning of the above list refers to the current
line number in onmainwindow_part4.cpp as found in the latext
x2goclient Git version. The ,,UNDOCUMENTED'' string marks those
options that are not yet documented in the x2goclient.1 man page.
Probably we should add the UNDOCUMENTED options to the man page, but
for most of the new command line options I do not know their usage...
-> Alex? Heinz?
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@das-netzwerkteam.de, http://das-netzwerkteam.de
freeBusy: https://mail.das-netzwerkteam.de/freebusy/m.gabriel%40das-netzwerkteam.de.xf...
-
Mike Gabriel -
Moritz Struebe -
Reinhard Tartler