.

NAME

ctys-help-on - Common Online-Help Interface

SYNTAX

<ctys-command>

-H <help-option>

   <help-option>:=
         (man|html|pdf)][=((1-9)|<help-on-item>[,<help-on-item-list>])
       | (path|list|listall)
       | funcList=<any-function>][@<module-name>[@...]][,<any-function>...]
       | funcListMod=<any-function>][@<module-name>[@...]][,<any-function>...]
       | funcHead=<any-function>][@<module-name>[@...]][,<any-function>...]
     )

DESCRIPTION

The -H option is the common generic option of all tools for the display of online help.

The default is the display of man pages within a commandline terminal. This could be any valid document within the search list defined by the variable MANPATH. The output format could be optionally specified as PDF and HTML documents.

This tool is also used within menu entries of the XDG desktop of Freedesktop.org for graphical display of online help. Therefore the current version provides the simple HTML lists doc.html for the DOC-Package, and the base.html file for the BASE-Package.

REMARK:
For the -H option of the call 'ctys -H man' and 'ctys-vhost -H man' the man parameter is mandatory. In all other cases the call '<any-other-ctys> -H' searches for 'man' output by default within MANPATH.

.

OPTIONS

The following suboptions and parameters could be applied:

-H path

Displays current document and man path.

-H list

Lists available online documents and manpages.

-H listall

Lists available online documents and manpages including the documents available by MANPATH.

-H (man|html|pdf)[=([1-9]|[<help-on-item-list>])

Displays the requested information with one of the formats man, pdf, or html. The following viewers are preconfigured as shell variables within the configuration files and can be adapted as required:

  CTYS_MANVIEWER=man
  CTYS_PDFVIEWER=(acroread else kpdf else gpdf)
  CTYS_HTMLVIEWER=(konqueror else firefox)

Default is manpage for the current process with man 1 .... Additional constraints could be applied such as another man-section or a filename, which could be either literally matching or a string to be expanded. In case of expansion the first match is taken.

-H funcList[=[<any-function>][@<module-name>[@...]]]

List of function names, sorted by function names. In addition the file names and line numbers are displayed too.

-H funcListMod[=[<any-function>][@<module-name>[@...]]]

List of function names, sorted by file names. In addition the file names and line numbers are displayed too.

-H funcHead[=[<any-function>][@<module-name>[@...]]]

Displays the contents of function headers, sorted by file names. The following constraints could be applied:

• <any-function>: If given <any-function> than only this is displayed.
• <module-name>: If given <module-name>, than the functions contained within this module only are displayed.
  
  

.

EXAMPLES

• <ctys-command> -H html=base
  Displays a summary of links for all documents contained in the BASE package.
  
  
• <ctys-command> -H html=doc
  Displays a summary of links for all documents contained in the DOC package.
  
  
• <ctys-command> -H list
  Lists available online documents and manpages.
  
  
• <ctys-command> -H ctys
  Displays the manpage for ctys with man.
  
  
• <ctys-command> -H man=ctys
  Displays the manpage for ctys with man.
  
  
• <ctys-command> -H html=ctys
  Displays the manpage for ctys with CTYS_HTMLVIEWER, by default firefox or konqueror.
  
  
• <ctys-command> -H pdf=ctys
  Displays the manpage for ctys with CTYS_PDFVIEWER, by default kpdf, gpdf, or acroread.
  
  
• <ctys-command> -H pdf=howto
  Displays the ctys-howto-online.pdf, which is displayed in alphabetical order before ctys-howto-print.pdf.

• <ctys-command> -H pdf=howto-print
  Displays the ctys-howto-print.pdf, which is the first appropriate match.

• <ctys-command> -H pdf=command-ref
  Displays the ctys-command-reference.pdf.

• <ctys-command> -H html=CLI,X11,VNC,VMW
  Displays the manpage for ctys-CLI, ctys-X11, ctys-VNC and ctys-VNM with CTYS_HTMLVIEWER, by default firefox or konqueror. For incomplete names a search with find is utilized for name expansion.
  
  
• <ctys-command> -H html=ctys-extractARPlst,extractMAClst
  Displays the manpage for ctys-extractARPlst and ctys-extractARPlst
  with CTYS_HTMLVIEWER, by default firefox or konqueror. For incomplete names a search with find is utilized for name expansion.
  
  
  

SEE ALSO

ctys manuals

ctys-command-reference-online.pdf, ctys-command-reference-print.pdf

AUTHOR

Written and maintained by Arno-Can Uestuensoez:

COPYRIGHT

Copyright (C) 2008, 2009, 2010 Ingenieurbuero Arno-Can Uestuensoez

This is software and documentation from BASE package,

• for software see GPL3 for license conditions,
• for documents see GFDL-1.3 with invariant sections for license conditions.
  The whole document - all sections - is/are defined as invariant.

For additional information refer to enclosed Releasenotes and License files.