"Timshel Knoll" <[EMAIL PROTECTED]> writes:
> Part of the work I have put in to the packaging is writing a whole heap of
> manpages for the various lsh commands. I have basically derived these from
> the <command> --help screens and the info page. I'm still only about half
> way through the commands, and I will send them to you as soon as I've
> finished.
Please, please look into ways to update things automatically. There's
the help2man tool (the texinfo folks recommends it, and it is used for
many GNU packages, but I haven't yet looked into it personally) to
process --help output, which should help at least with some things.
Perhaps you can organize the man page as an introduction (written by
hand), and automatically combine it with help2man output. Or
experiment with @ifman-sections in the texinfo file, and cut them out
with sed. For lsh, the material that I believe would make sense to put
in a manpage is the "Invoking lsh" node and its subnodes, i.e. the
information you get with
info --file lsh.info --subnodes "Invoking lsh" | cat
(the final cat is needed to prevent info from starting in interactive
mode). The rest of the commands are simple enough that a man page
based on --help output may suffice.
Don't get me wrong, I'm not trying to tell you that you must do things
a certain way. But I have been thinking about how to write and
_maintain_ lsh man pages, and the above is the best plan I have been
able to come up with so far. If you decide to do something even
better, please let me know about it.
> I have therefore taken up the suggestion of naming the package
> 'lsh-utils', and the client is '/usr/bin/lshc' rather than just
> 'lsh'.
Sounds lika a reasonable resolution. In the long term, I think debian
needs something like modules (or cmod) to deal with name collisions,
both between different packages, and with several versions of a
package installed in parallell. You may want to add a comment to the
texinfo manual saying that lsh is sometimes installed under the name
"lshc" on some systems.
Regards,
/Niels
