*** NOTE: from openSUSE 10.2, you must setup the help server manually ***
*** to use in-browser help.  khelpcenter and yelp help are unchanged  ***
*** See 2.2 below                                                     ***

German version see below  / Deutsche Version siehe unten.

SUSE HELP SYSTEM
----------------

1. Requirements. How to start. 
------------------------------

If you start SUSE Help from the command line with susehelp (suseaide,
suseayuda, hilfe) the system automatically detects the best
browser. Depending on the installed packages you have the following
possibilities:

1.1 SUSE Helpcenter

Needed packages: kdebase3 kdebase3-SuSE
How to start: click the lifesaver on the panel
              khelpcenter (as command)

1.2 Webserver + browser

Needed packages: e.g apache, netscape. You may use any other combination
of webserver and webbrowser. Don't forget to start your webserver. 
Additionally you have to install the package inf2htm for Infopages.

How to start: just point your browser to http://localhost/susehelp/

1.3 Documentation server

You have the capability to allow centralized access to the full set of
documentation available with SUSE Linux.

Client:
Needed packages: susehelp and a browser of your choice (e.g Konqueror,
                 Netscape...)
How to start:  just point your browser to http://SERVER-Name/susehelp/

Server:
Needed packages: susehelp, web-server (e.g. apache), documentation packages,
                 inf2htm


2. Configuration
----------------
You need to be logged in as root.

2.1 Index generation

From the command line with the command susehelpindex, or by setting 
DOC_AUTOINDEX=yes in /etc/sysconfig/susehelp.

2.2 documentation server

Copy SuSEconfig.susehelp from /usr/share/doc/packages/susehelp/examples
to /sbin/conf.d.

Ensure package 'htdig' is installed.

Please set the following variables in /etc/sysconfig/susehelp resp.
/etc/sysconfig/apache2

For the client:

In /etc/sysconfig/susehelp:
DOC_HOST="myhelpserver.domain.example"

In /etc/sysconfig/apache2:
DOC_SERVER="no"

For the server:

In /etc/sysconfig/susehelp:
DOC_HOST="myhelpserver.domain.example"
DOC_ALLOW="localhost .domain.example"

In /etc/sysconfig/apache2:
DOC_SERVER="yes"

Don't forget to replace "myhelpserver.domain.example" with the name of the
doc server, usually the same as FQHOSTNAME.

Afterwards run "/sbin/SuSEconfig" and start apache with "rcapache start".


Remember to have fun!

------------------------------------------------------------------------------
SUSE Hilfe-System
-----------------

1. Einsatzmglichkeiten, Aufruf, bentigte Pakete
-------------------------------------------------

Wenn Sie die SUSE Hilfe von der Kommandozeile mit hilfe (susehelp / suseaide
 / suseayuto) aufrufen, wird automagisch erkannt, welcher Betrachter
 (Browser) gestartet werden soll.
Die folgenden Mglichkeiten sind davon abhngig, welche Pakete zustzlich zu
susehelp und den einzelnen Dokumentationspaketen installiert sind:

1.1. SUSE Helpcenter.

Bentigte Pakete: kdebase3 kdebase3-SuSE
weitere Aufrufmglichkeiten: - ber den Rettungsring im Panel
                             - SUSE Hilfe im K-Men
                             - auf der Kommandozeile: khelpcenter

1.2. Web-Server + Web-Browser

Bentigte Pakete: z.B. apache, netscape.
Es knnen natrlich auch andere Web-Server und/oder Browser eingesetzt werden,
wenn sie entsprechend  konfiguriert werden.
Anmerkung: Nach Installation der Pakete vergessen Sie nicht, den Web-Server
auch zu starten ("rcapache start").
Fr das Anzeigen von Infopages bentigen Sie in diesem Fall zustzlich das Paket
inf2htm.

Aufrufmglichkeiten: in der URL-Zeile des Browsers:
 http://localhost/susehelp/index.html.de
Legen Sie sich am besten ein Lesezeichen darauf.

1.3. Dokumentationsserver

Sie knnen die SUSE Hilfe auch im Netz einsetzen und die gesamte Dokumentation
auf einem Server installieren. 

Fr die Clients:
Bentigte Pakete: susehelp und einen Browser (z.B. Konqueror, Netscape, ...)
Aufruf: ber URL: http://SERVER-Name/susehelp/index.html.de

Fr den Server:
Bentigte Pakete: susehelp, Web-Server(z.B. apache), Dokumentationspakete
(evtl. zustzlich inf2htm).
Der Aufruf erfolgt vom Client.
 

2. Konfiguration
----------------

Die Konfiguration kann nur mit root-Rechten erfolgen!

2.1. Index-Generierung

Auf der Kommandozeile mit dem Kommando susehelpindex, oder automatisch mittels
SuSEconfig, wenn DOC_AUTOINDEX=yes in /etc/sysconfig/susehelp gesetzt ist.


2.2 Dokumentationsserver

Kopieren Sie die Datei
/usr/share/doc/packages/susehelp/examples/SuSEconfig.susehelp in
/sbin/conf.d.

Stellen Sie sicher, da das Paket 'htdig' installiert ist.

In /etc/sysconfig/susehelp bzw. /etc/sysconfig/apache2 sind folgende
Variablen zu setzen:

Fr die Clients:
In /etc/sysconfig/susehelp:
DOC_HOST="myhelpserver.domain.example"

In /etc/sysconfig/apache2:
DOC_SERVER="no"

Fr den Server:

In /etc/sysconfig/susehelp:
DOC_HOST="myhelpserver.domain.example"
DOC_ALLOW="localhost .domain.example"

In /etc/sysconfig/apache2:
DOC_SERVER="yes"

Dabei ist myhelpserver.domain.example entsprechend zu ersetzen.

Anschlieend lassen Sie "/sbin/SuSEconfig" laufen und starten den
Web-Server mit "rcapache start".

SUSE wnscht Ihnen viel Spass ...
