From 222551b4ee928e230521371b27641cdbbd191e6b Mon Sep 17 00:00:00 2001
From: Marc O. Sandlus <marc.sandlus@hostsharing.net>
Date: Fri, 29 Nov 2019 10:16:49 +0100
Subject: [PATCH] weitere typos, mehrere Anmerkungen
---
source/referenz/hsadmin/user.rst | 75 ++++++++++++++++++++++++++++---------
1 files changed, 56 insertions(+), 19 deletions(-)
diff --git a/source/referenz/hsadmin/user.rst b/source/referenz/hsadmin/user.rst
index daf12e0..2badac6 100644
--- a/source/referenz/hsadmin/user.rst
+++ b/source/referenz/hsadmin/user.rst
@@ -1,27 +1,64 @@
-==================
-HSAdmin-Modul user
+.. _kap-modul-user:
+
+==========
+Modul user
+==========
+
+Funktionen
+==========
+
+.. option:: user.search
+
+ Suche Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten
+
+.. option:: user.add
+
+ Füge einen neuen Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten hinzu.
+
+.. option:: user.update
+
+ Aktualisiere einen Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten.
+
+.. option:: user.remove
+
+ Lösche einen Benutzer nach den im Befehlsausdruck angegebenen Feldern und Werten.
+
+Editierbare Felder
==================
-Das HSAdmin-Modul ``user`` verfügt über folgende Optionen:
+Das HSAdmin-Modul ``user`` kann entsprechend der folgenden Befehlssyntax von :command:`HSAdmin` Felder setzen oder verändern::
-+-----------------+-----------------------------------------------------------------------------------------------------------------+
-| Option | Erläuterung |
-+=================+=================================================================================================================+
-| name | Benutzerkennung (z.B. xyz00-abc) |
-+-----------------+-----------------------------------------------------------------------------------------------------------------+
-| comment | Kommentar |
-+-----------------+-----------------------------------------------------------------------------------------------------------------+
-| password | Passwort |
-+-----------------+-----------------------------------------------------------------------------------------------------------------+
-| shell | shell (z.B. ``/bin/bash``) |
-+-----------------+-----------------------------------------------------------------------------------------------------------------+
-| quota_softlimit | zugewiesene :term:`Quota` in Megabyte |
-+-----------------+-----------------------------------------------------------------------------------------------------------------+
-| quota_hardlimit | Grenze der :term:`Grace Period`, bis zu der Überschreitungen des Softlimit toleriert werden. Angabe in Megabyte |
-+-----------------+-----------------------------------------------------------------------------------------------------------------+
+ user.function({where:{field:'value',...}, set:{field:'value',...}})
-Beispiel:
+Im Modul ``user`` stehen folgende Felder zur Verfügung.
+
+name
+ Benutzerkennung (z.B. xyz00-abc)
+
+comment
+ Kommentar, in dem zum Beispiel die Funktion des Benutzers beschrieben werden kann
+
+password
+ Das Passwort
+
+shell
+ Die zugewiesene Shell (z.B. ``/bin/bash``)
+
+quota_softlimit
+ Das zugewiesene :term:`Quota` in Megabyte
+
+quote_hardlimit
+ Grenze der :term:`Grace Period`, bis zu der Überschreitungen des Softlimit toleriert werden. Angabe in Megabyte
+
+
+Beispiele
+=========
+
+In einer interaktiven Sitzung wird mit folgendem Befehl der neue Benutzer ``xyz00-mustermann`` angelegt.
.. code-block:: console
xyz00@hsadmin> user.add ({set:{name:'xyz00-mustermann',comment:'Max Mustermann',password:'!1?2-3aBc',shell:'/bin/bash',quota_softlimit:'50',quota_hardlimit:'75'}})
+
+
+.. todo:: Weitere Beispiele, mindestens noch eins mit where-Kondition
--
Gitblit v1.9.3