From 8d081ac85398030bb1c1f5f6e59e5c995a6987fa Mon Sep 17 00:00:00 2001
From: Jan Ulrich Hasecke <jan.ulrich@hasecke.com>
Date: Wed, 06 Nov 2019 12:41:11 +0100
Subject: [PATCH] hsscript umgestellt

---
 source/referenz/hsadmin/syntax.rst |   77 +++++++++++++++++++-------------------
 1 files changed, 39 insertions(+), 38 deletions(-)

diff --git a/source/referenz/hsadmin/syntax.rst b/source/referenz/hsadmin/syntax.rst
index 6c6b296..bc68bef 100644
--- a/source/referenz/hsadmin/syntax.rst
+++ b/source/referenz/hsadmin/syntax.rst
@@ -1,51 +1,52 @@
 ======
 Syntax
 ======
-Die Funktionen von HSAdmin können über das Kommandozeilenprogramm
-hsscript aufgerufen werden, welches Befehle per Parameter,
-Dateiübergabe oder interaktiv entgegennimmt.
 
-Aufruf
-------
+Die Funktionen von HSAdmin können über das Kommandozeilenprogramm :command:`hsscript` aufgerufen werden, welches Befehle per Parameter, Dateiübergabe oder interaktiv entgegennimmt.
+Der Aufruf erfolgt nach folgender Syntax:
 
 .. code-block:: console
 
    $ hsscript -u <Benutzer> -e <Befehl>...
 
-+----------------------+---------------------------------------------------------------------------------+
-| Parameter            | Erläuterung                                                                     |
-+======================+=================================================================================+
-| | --user <Benutzer>  | Benutzer, welcher zur Authentifizierung und Autorisierung verwendet werden soll |
-| | -u <Benutzer>      |                                                                                 |
-+----------------------+---------------------------------------------------------------------------------+
-| | --runas <Benutzer> | Benutzer, mit dessen Rechten der Befehl ausgeführt werden soll                  |
-| | -r <Benutzer>      |                                                                                 |
-+----------------------+---------------------------------------------------------------------------------+
-| | --expr <Befehl>    | Befehl, welcher ausgeführt werden soll                                          |
-| | -e <Befehl>        |                                                                                 |
-+----------------------+---------------------------------------------------------------------------------+
-| | --file <Datei>     | Datei, aus welcher Befehle gelesen und ausgeführt werden sollen                 |
-| | -f <Datei>         |                                                                                 |
-+----------------------+---------------------------------------------------------------------------------+
-| | --interactive      | interaktiver Modus                                                              |
-| | -i                 |                                                                                 |
-+----------------------+---------------------------------------------------------------------------------+
 
-Befehle
--------
+Die folgenden Optionen können übergeben werden.
 
-::
+.. option:: -u --user
 
-  module.function({where:{field:'value',...}, set:{field:'value',...}}) 
+   Benutzer, welcher zur Authentifizierung und Autorisierung verwendet werden soll, zum Beispiel ``xyz00``.
 
-+-----------+-------------------------------------------------------------+
-| Parameter | Erläuterung                                                 |
-+===========+=============================================================+
-| module    | Modul, dessen Funktion aufgerufen werden soll               |
-+-----------+-------------------------------------------------------------+
-| function  | Funktion, welche aufgerufen werden soll                     |
-+-----------+-------------------------------------------------------------+
-| where     | selektiert nach Wert eines oder mehrerer Felder             |
-+-----------+-------------------------------------------------------------+
-| set       | setzt oder aktualisiert den Wert eines oder mehrerer Felder |
-+-----------+-------------------------------------------------------------+
+.. option:: -r --runas
+
+   Benutzer, mit dessen Rechten der Befehl ausgeführt werden soll, zum Beispiel ``xzy00-doms``.
+
+.. option:: -e --expr
+
+   Der Befehl, der ausgeführt werden soll.
+   Er setzt sich aus einer Reihe von Parametern zusammen.
+   Der Befehl hat folgende Syntax::
+
+      module.function({where:{field:'value',...}, set:{field:'value',...}}) 
+
+   +-----------+---------------------------------------------------------------------------------------+
+   | Parameter |                                      Erläuterung                                      |
+   +===========+=======================================================================================+
+   | module    | Modul, dessen Funktion aufgerufen werden soll (z.B. ``user`` oder ``mysqldb``)        |
+   +-----------+---------------------------------------------------------------------------------------+
+   | function  | Funktion, welche aufgerufen werden soll (``search``, ``add``, ``update``, ``remove``) |
+   +-----------+---------------------------------------------------------------------------------------+
+   | where     | selektiert nach Wert eines oder mehrerer Felder                                       |
+   +-----------+---------------------------------------------------------------------------------------+
+   | set       | setzt oder aktualisiert den Wert eines oder mehrerer Felder                           |
+   +-----------+---------------------------------------------------------------------------------------+
+
+   Die Module und Funktionen werden in den folgenden Kapiteln erklärt.
+
+.. option:: -f --file
+
+   Datei, aus welcher Befehle gelesen und ausgeführt werden sollen
+
+.. option:: -i --interactive
+
+   Das Programm startet im interaktiven Modus.
+   Die Befehle können am Kommandozeilen-Prompt eingegeben werden.

--
Gitblit v1.9.0-SNAPSHOT