.

NAME

ctys-help-on - Einheitliche Online-Schnittstelle fuer Hilfe

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>...]
     )

BESCHREIBUNG

Die -H Option is die einheitliche generische Option fuer alle Tools zur ausgabe der Online-Hilfe.

Der Default ist die Ausgabe der 'man pages' auf die Konsole. Dies kann jedes beliebige Dokument sein, das sich innerhalb der Suchpfade befindet, die durch die Variable MANPATH definiert sind. Insabesondere sind auch eindeutige Teil-Strings zulaessig. Das Ausgabeformat kann auch als PDF bzw. HTML spezifiziert werden.

Dieses Tool wird auch fuer die Menueeintraege der XDG Desktops von Freedesktop.org eingesetzt. Dafuer wird als Online-Manual eine einache Liste doc.html fuer das DOC-Packet, und die Datei base.html fuer das BASE-Packet bereitgestellt.

ANMERKUNG:
Fuer die -H Option der speziellen Aufrufe 'ctys -H man' und 'ctys-vhost -H man' ist der 'man' Parameter Pflicht, alle anderen arfordern diesen nicht explizit, verwenden diesen bei Fehlen als Voreinstellung.

.

OPTIONEN

The following suboptions and parameters could be applied:

-H path

Zeigt den altuellen Dokumenten und MAN Suchpfad.

-H list

Listet aktuell verfuebare Online-Documente und MAN-Pages exclusive dem System-MAN-Pages.

-H listall

Listet aktuell verfuebare Online-Documente und MAN-Pages inclusive dem System-MAN-Pages.

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

Zeigt die angeforderte infomation in dem gewaehlten Format: man, pdf oder html. Die folgende Liste zeigt die Voreinstellung in der benutzten Prioritaet abhaengig von der verfuegbarkeit.

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

Default ausgabe ist manpage des aufrufenden Programs mit man 1 .... Es koennen Teilstrings benutzt werden - einschliesslich System-Manpages. Der erste Treffer wird dann angezeigt.

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

Zeigt eine Liste aller Funktionsnamen. Es werden zusaetzlich Dateiname und Funktionsname ausgegeben.

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

Zeigt eine Liste von Funktionsnamen optional in Modulen an. Es werden zusaetzlich Dateiname und Funktionsname ausgegeben.

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

Zeigt die aller oder gewaehlter Funktions-Header in Modulen an.

.

BEISPIELE

• <ctys-command> -H html=base
  Zeigt die Startseite fuer die Online-Hilfe des BASE package.
  
  
• <ctys-command> -H html=doc
  Zeigt die Startseite fuer die Online-Hilfe des DOC package.
  
  
• <ctys-command> -H list
  Listet verfuegbare Online Dokumente und Manpages.
  
  
• <ctys-command> -H ctys
  Zeigt die manpage fuer ctys mit man.
  
  
• <ctys-command> -H man=ctys
  Zeigt die manpage fuer ctys mit man.
  
  
• <ctys-command> -H html=ctys
  Zeigt die manpage fuer ctys mit CTYS_HTMLVIEWER, als Default firefox oder konqueror.
  
  
• <ctys-command> -H pdf=ctys
  Zeigt die manpage fuer ctys mit CTYS_PDFVIEWER, als Default kpdf, gpdf oder acroread.
  
  
• <ctys-command> -H pdf=howto
  Zeigt die ctys-howto-online.pdf, Es erfolgt ein Suchen mit First-Wins, d.h. der String muss eindeutig Treffen, der kuerzere gewinnt.
  
  
• <ctys-command> -H pdf=howto-print
  Zeigt die ctys-howto-print.pdf, Es erfolgt ein Suchen mit First-Wins, d.h. der String muss eindeutig Treffen, der kuerzere gewinnt.

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

• <ctys-command> -H html=CLI,X11,VNC,VMW
  Zeigt die manpage fuer ctys-CLI, ctys-X11, ctys-VNC und ctys-VNM with CTYS_HTMLVIEWER, als Default firefox oder konqueror. Fuer unvollstaendige Namen wird Suchen mit find benutzt.
  
  
• <ctys-command> -H html=ctys-extractARPlst,extractMAClst
  
  Zeigt die manpage fuer ctys-extractARPlst und ctys-extractARPlst CTYS_HTMLVIEWER, als Default firefox oder konqueror. Fuer unvollstaendige Namen wird Suchen mit find benutzt.
  
  
  

SIEHE AUCH

ctys manuale

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

AUTOR

Kozeption, Design und Implementierung durch Arno-Can Uestuensoez:

COPYRIGHT

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

Dies ist freie Software und Documentation des BASE Pakets,

• fuer Software-Lizenzen siehe GPL3,
• fuer Dokumentations-Lizenz des BASE-Pakets siehe GFDL-1.3 mit invarianten Sektionen.

Das gesamte Dokument - alle Sektionen - sind als Invariant definiert.

Fuer weitere Informationen siehe beigefuegte Freigabemitteilung und Lizenz Dateien.