.
ctys-help-on - Common Online-Help Interface
<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>...]
| _ONLINEHELP_
| _HELP_
)
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.
.
The following suboptions and parameters could be applied:
Displays current document and man path.
Lists available online documents and manpages.
Lists available online documents and manpages including the documents available by MANPATH.
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.
List of function names, sorted by function names. In addition the file names and line numbers are displayed too.
List of function names, sorted by file names. In addition the file names and line numbers are displayed too.
Displays the contents of function headers, sorted by file names. The following constraints could be applied:
Displays the predefined online help for the installed package.
.
Displays the predefined online help for the installed package.
Displays a summary of links for all documents contained in the BASE package.
Displays the extended online help as contained in the DOC package.
Lists available online documents and manpages.
Displays the manpage for ctys with man.
Displays the manpage for ctys with man.
Displays the manpage for ctys with CTYS_HTMLVIEWER,
by default firefox or konqueror.
Displays the manpage for ctys with CTYS_PDFVIEWER,
by default kpdf, gpdf, or acroread.
Displays the ctys-howto-online.pdf, which is
displayed in alphabetical order before ctys-howto-print.pdf.
Displays the ctys-howto-print.pdf, which is
the first appropriate match.
Displays the ctys-command-reference.pdf.
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.
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.
| Arno-Can Uestuensoez | <https://arnocan.wordpress.com/> |
| <https://unifiedsessionsmanager.sourceforge.io/> | |
| <https://github.com/unifiedsessionsmanager> | |
|
Copyright (C) 2008, 2009, 2010, 2011, 2020 Ingenieurbuero Arno-Can Uestuensoez
This is software and documentation from BASE package,
For additional information refer to enclosed Releasenotes and License files.
