root/doc/cmds.txt

PROJEKT LANCELOT -- KOMMANDOSTRUKTUR (Stand 26.2.2005)
======================================================

pl-init(1): Mailingliste anlegen
--------------------------------

Syntax: pl-init [OPTIONEN] LISTE@DOMAIN EIGENTÜMER-ADRESSE

Legt eine neue Liste an und richtet die Datenbank dafür ein. Die
Datenbank wird unter dem Namen »LISTE@DOMAIN.pldb« im
Heimatverzeichnis des aufrufenden Benutzers plaziert.

Optionen:

  --our-isp: Die Liste folgt our-isp-Konventionen. Im besonderen heißt
             das, daß die Datenbank im Verzeichnis
             $HOME/domains/DOMAIN/LISTE statt in $HOME untergebracht wird.
             (Später bei der Mailzustellung stimmt es dann wieder.)
  --config PARAMETER=WERT: Der Parameter PARAMETER der Liste wird auf den
             Wert WERT gesetzt.
  --clone ANDERELISTE@ANDEREDOMAIN: Die Konfiguration der Mailingliste
             ANDERELISTE@ANDEREDOMAIN wird sinngemäß übernommen; an den
             relevanten Stellen wird LISTE@DOMAIN eingesetzt. Einzelne
             Parameter der Konfiguration von ANDERELISTE@ANDEREDOMAIN
             können mit der --config-Option modifiziert werden.
  --mailfilter: Es wird eine Datei namens »mailfilter.pl« erzeugt, die die
             nötigen Adreßumleitungen nach pl-incoming(1) enthält.


pl-conf(1): Mailinglisten-Konfigurationsparameter ändern
--------------------------------------------------------

Syntax: pl-conf --query LISTE@DOMAIN [PARAMETER ...]
        pl-conf --set LISTE@DOMAIN "PARAMETER = WERT" ...
        pl-conf --import LISTE@DOMAIN

Mit der Option »--query« gibt dieses Programm die Werte der benannten
Parameter (oder aller Parameter) aus. Mit »--set« können einzelne
Parameter manipuliert werden. Mit der Option »--import« werden Zeilen
der Form »PARAMETER = WERT« von der Standardeingabe gelesen.


pl-subscribe(1): Abonnenten manuell hinzufügen
----------------------------------------------

Syntax: pl-subscribe [OPTIONEN] LISTE@DOMAIN [ADRESSE ...]

Fügt die aufgezählten ADRESSEn der Abonnentenliste hinzu, sofern sie
noch nicht darin enthalten sind, und setzt ggf. Optionen. Schon
enthaltene Adressen werden nicht modifiziert. Werden keine Adressen
aufgezählt, liest pl-subscribe(1) Adressen von der Standardeingabe.

Optionen:
  --confirm: Die neuen Abonnenten landen im Zustand UNCONFIRMED und müssen
             das Abonnement erst bestätigen (analog: --noconfirm (Standard))
  --digest:  Die neuen Abonnenten bekommen die digest-Option gesetzt
             (analog: --nodigest (Standard))
  --mail:    Die neuen Abonnenten bekommen die nomail-Option gelöscht
             (Standard). (analog: --nomail)
  --welcome: Die neuen Abonnenten bekommen die Willkommensnachricht geschickt
             (Standard). (analog: --nowelcome).


pl-unsubscribe(1): Abonnenten manuell löschen
---------------------------------------------

Syntax: pl-unsubscribe [OPTIONEN] LISTE@DOMAIN [ADRESSE ...]

Entfernt die aufgezählten Adressen aus der Abonnentenliste, sofern sie
darin enthalten sind. Werden keine Adressen aufgezählt, liest
pl-unsubscribe(1) Adressen von der Standardeingabe.

Optionen:
  --confirm: Die benannten Adressen landen im Zustand UNSUB-UNCONF und
             müssen das Abbestellen erst bestätigen (analog: --noconfirm
             (Standard))
  --goodbye: Die benannten Adressen bekommen die Verabschiedungsnachricht
             geschickt (Standard). (analog: --nogoodbye)


pl-subchange(1): Abonnenten-Optionen ändern
-------------------------------------------

Syntax: pl-subchange [OPTIONEN] LISTE@DOMAIN [ADRESSE ...]

Ändert Abonnementsoptionen für die benannten Adressen (sofern sie in
der Datenbank für die Liste stehen). Werden keine Adressen aufgezählt,
liest pl-subchange(1) Adressen von der Standardeingabe.

Optionen:
  --digest:  Die Adressen bekommen die digest-Option gesetzt
             (analog: --nodigest)
  --mail:    Die Adressen bekommen die nomail-Option gelöscht
             (analog: --nomail)
  --moderator: Die Adressen bekommen die moderator-Option gesetzt (und
             werden damit zu Listenmoderatoren) (analog: --nomoderator)
  --moderated: Die Adressen bekommen die moderated-Option gesetzt (so
             dass alle ihre Nachrichten moderiert werden müssen)
             (analog: --nomoderated)
  --blacklist: Die Adressen werden auf die »schwarze Liste« gesetzt; sie
             bekommen nichts geschickt und dürfen nichts schicken, können
             ihre Optionen nicht ändern sich außerdem nicht selbst aus
             diesem Zustand entfernen (nicht einmal durch Abbestellen).
             (analog: --noblacklist -- versetzt die Adresse wieder in
             den Zustand SUBSCRIBED).


pl-list(1): Listet aktuelle Abonnenten auf
------------------------------------------

Syntax: pl-list [OPTIONEN] LISTE@DOMAIN

Gibt Adressen aus der Datenbank für LISTE@DOMAIN auf der
Standardausgabe aus (eine Adresse pro Ausgabezeile).

Optionen:
  --digest:  Digest-Empfänger werden mit angezeigt (Standard)
             (analog: --nodigest)
  --mail:    Nicht-Nomail-Adressen werden mit angezeigt (Standard)
             (analog: --nomail)
  --name:    Der Name wird mit ausgegeben (soweit bekannt)
             (analog: --noname (Standard))
  --full:    Das komplette Ausgabeformat: Zeilen der Form

               SMdnm "Hugo Schulz" <hugo.schulz@example.com>
               ||||| Name          Adresse
               ||||`---------------------------- Moderated
               |||`----------------------------- Nomail
               ||`------------------------------ Digest
               |`------------------------------- Moderator
               `-------------------------------- Status [*]

             Status ist »U« für UNCONFIRMED, »S« für SUBSCRIBED,
             »u« für UNSUB-UNCONF, »B« für BOUNCING und »X« für BLACKLIST.

             Nicht gesetzte Optionen werden als »-« dargestellt.


pl-incoming(1): Behandelt eingehende Mail
-----------------------------------------

Syntax: pl-incoming LISTE@DOMAIN

Bearbeitet eingehende Mail an die Listenadresse(n). Bei der Installation der
Liste muß dafür gesorgt werden, daß Mail an die folgenden Adressen nach
pl-incoming(1) geleitet wird:

  LISTE@DOMAIN                  - Adresse für Beiträge
  LISTE-subscribe@DOMAIN        - Adresse für Abonnementswünsche
  LISTE-subscribe-...@DOMAIN    - Adresse für Abonnementswünsche
  LISTE-unsubscribe@DOMAIN      - Adresse für Abbestellwünsche
  LISTE-unsubscribe-...@DOMAIN  - Adresse für Abbestellwünsche
  LISTE-configure@DOMAIN        - Adresse für Konfigurationswünsche
  LISTE-bounces-...@DOMAIN      - Adresse für Fehlermeldungen
  LISTE-confirm-...@DOMAIN      - Adresse für Bestätigungen
  LISTE-mod-...@DOMAIN          - Adresse für Moderatoren-Mail
  LISTE-help@DOMAIN             - Adresse für Hilferufe
  LISTE-owner@DOMAIN            - Adresse für den Listeneigentümer


pl-janitor(1): Besorgt periodische Aufräumungsarbeiten
------------------------------------------------------

Syntax: pl-janitor LISTE@DOMAIN

Dieses Programm wird periodisch z. B. von cron(8) aufgerufen und
übernimmt Aufräumungsarbeiten, zum Beispiel:

- Entfernen von lange unbestätigten Abonnements-, Abbestell- oder
  Konfigurationsänderungswünschen
- Entfernen von zu moderierenden Nachrichten, auf die kein Moderator
  geantwortet hat
- Verschicken von Digests