--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ma.8.pod	Fri Nov 04 06:29:26 2005 +0000
@@ -0,0 +1,164 @@
+=head1 NAME
+
+ma -- mailadmin tool
+
+=head1 SYNOPSIS
+
+B<ma> account [--add|--modify|--delete|--list] 
+[--address=s]
+[--fullname=s]
+[--group=s]
+[--[no]mbox]
+[--other=s]
+[--password=s]
+I<name>
+
+B<ma> alias  [--add|--modify|--delete|--list] [--members=s] I<name>
+
+B<ma> --help
+
+
+=head1 DESCRIPTION
+
+B<ma> ist ein Tool zur Administration vom Mailnutzern, deren Einstellungen im LDAP
+gespeichert sind.
+
+Es gliedert sich in zwei Sub-Kommands: C<account> und C<alias>.
+
+=head2 account
+
+Mit diesem Subkommando werden die Details des Accounts (Nutzer) modifiziert.
+Das sind vor allem Dinge wie 
+
+=over 4
+
+=item	. Name
+
+=item 	. Password
+
+=item	. Gruppenzugehörigkeit
+
+=item	. alternative Mailadressen
+
+=back
+
+Beeinflußt wird sowohl das LDAP als auch der Cyrus-Mailserver.  Im LDAP werden die Nutzerspezifischen 
+Daten gehalten, im Cyrus die Mailboxen.  Bei LDAP-Eintragungen wird davon ausgegangen, daß
+keine anderen Elemente in den entsprechenden Subbäumen liegen.  Besonders beim Löschen ist das zu berücksichtigen,
+denn z.B. das Entfernen eines Nutzer entfernt dessen B<gesamtes> LDAP-Objekt!
+
+=head1 OPTIONS
+
+=over 4
+
+=head2 OPTIONS für beide Sub-Kommandos
+
+=item B<--add>|B<--modify>|B<--delete>|B<--list>
+
+Ist eigentlich selbsterklärend :)
+
+=back
+
+=head2 OPTIONS für C<account>
+
+=over 4
+
+=item B<--address>=I<primäre Mailadresse>
+
+Die primäre Mailadresse des Nutzers.  Wird u.U. für das Masquerading bei ausgehender Mail
+genutzt.  Diese Adresse darf nicht schon existieren.  Mit einem C<!> am Ende der Adresse läßt sich 
+dieser Test ausschalten.
+
+=item B<--fullname>=I<Klartext-Name>
+
+Der volle Klartextname des Nutzers.  Wird nur für Dokumentationszwecke genutzt.
+
+=item B<--group>=I<Gruppenzuhörigkeit>
+
+Die Liste der Mailgruppen, in denen der Nutzer Mitglied ist.  Mail an diese Gruppen werden dann 
+auch an diesen Nutzer zugestellt.   Beim Neuanlegen genügt eine kommangetrennte Liste (keine Leerzeichen!).
+Beim Modifizieren können mit dem Präfix C<+> bzw. C<-> einzelne Gruppen hinzugefügt bzw. entfernt werden:
+
+	ma account --modify --group=+groupA,-groupB,+groupC hans
+
+entfernt C<hans> aus der Gruppe C<groupB> und fügt ihn in C<groupA> und C<groupB> ein.
+
+	ma account --modify --group= hans
+
+entfernt alle Gruppenzugehörigkeiten.
+
+	ma account --modify --group=groupA,groupB hans
+
+setzt genau die Zugehörigkeiten C<groupA> und C<groupB>.
+
+=item B<--[no]mbox>
+
+Mailbox-Anlegen oder auch nicht.  (Nur beim Neu-Anlegen.)
+
+=item B<--other=>=I<alternative Mailadressen>
+
+Wenn der Nutzer unter alternativen Mailadressen erreichbar sein soll, dann sind diese hier erwähnt.
+Es lassen sich Adressen hinzufügen und auch wieder löschen.  Die Syntax dazu entspricht der bei der 
+Gruppenzugehörigkeit.
+
+=item B<--password>=I<Passwort>
+
+Wenn beim Nutzeranlegen das Passwort nicht generiert werden soll, dann ist es hier anzugeben.
+Nachträglich läßt es sich auch hier ändern.
+
+=back
+
+=head2 Options für C<alias>
+
+=over 4
+
+=item B<--members>=I<Liste der Anliasangehörigen>
+
+Es können Alias-Mitglieder ein- und ausgetragen werden.  Die Syntax entspricht der oben bei der 
+Gruppenzugehörigkeit angegebenen.
+
+=back
+
+=head1 EXAMPLES
+
+Anlegen, Anzeigen, Verändern und Löschen eines Nutzers:
+
+	ma account --add --fullname "Hans Hanson" --other=h.hanson,hh --group=edv hans
+	ma account --list
+	ma account --modify --password=x --group=-edv,+it hans
+	ma account --delete hans
+
+Beim Löschen wird die B<Mailbox entfernt>!  Eventuelle Mitgliedschaften des Nutzers in
+Aliasen werden B<auch> berücksichtigt.  Die Nutzung 
+der Gruppen ist hier jedoch deutlich einfacher.
+
+Anlegen, Anzeigen, Verändern und Löschen eines Alias:
+
+	ma alias --add --members=hans,rudi operators
+	ma alias --list
+	ma alias --modify --members=+fritz operators
+	ma alias --delete operators
+
+=head1 Umgebungsvariablen
+
+=over 4
+
+=item	MA_CONF
+
+Konfigurations-Datei-Name.  Diese Variable B<muß> gesetzt werden, damit
+B<ma> sich überhaupt für eine Konfigurations-Datei interessiert.
+
+=item	LDAP_PASS
+
+Passwort für den LDAP-Administrator.  Optional.
+
+=item	IMAP_PASS
+
+Passwort für den IMAP-Administrator.  Optional.
+
+=back
+
+
+=head1 AUTHOR
+
+Heiko Schlittermann <hs@schlittermann.de>