yes, the manpage clearly states the reason and this was done deliberately after 
a discussion upstream. 
ltsp-build-client works completely different depending on what plugins are 
enabled in your distro ... 
having a less generic manpage would mean to maintain one for each distro or 
even each derivative ...

one way to solve the problem would be to generate the manpage at package
buildtime, scan the vendor-plugin and common-plugin dirs and have code
that generates a manpage that matches the exact plugin list and pulls
options as well as all option descriptions out of the plugin code ...

given that ltsp back when we created the manpage had bigger probs to
solve than writing a complex option parser that generates proper manpage
code, the decision was to have a generic manpage that points to --extra-
help which in turn is generated from plugin code at runtime ...

o...@osiris:~$ man ltsp-build-client
...
NAME
       ltsp-build-client - Builds an LTSP client system for use with the LTSP 
server

SYNOPSIS
       ltsp-build-client  <options>

DESCRIPTION
       ltsp-build-client builds an ltsp client chroot using standard packages 
for use with the ltsp server.  This chroot installation  can be modified in a 
number of ways as outlined in the OPTIONS section.  If present, defaults will 
be read from the configuration
       file /etc/ltsp/ltsp-build-client.conf, and will be overridden by using 
the command line options. ltsp-build-client is usually run as the root user.  
Visit http://www.ltsp.org for more information.

OPTIONS
       Not all options are available on all installations. For a complete list 
of available options, use the --help and --extra-help options.
...

scott: the code that generates the help output for --extra-help could be
used to instead spit out a manpage at buildtime i suppose ...

** Also affects: ltsp
   Importance: Undecided
       Status: New

** Changed in: ltsp
       Status: New => Confirmed

** Changed in: ltsp
   Importance: Undecided => Low

** Changed in: ltsp
     Assignee: (unassigned) => Scott Balneaves (sbalneav)

-- 
ltsp-build-client --extra-help options not documented in manpage
https://bugs.launchpad.net/bugs/479423
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.

-- 
ubuntu-bugs mailing list
ubuntu-bugs@lists.ubuntu.com
https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs

Reply via email to