Update documentation.
[usenet/usevote.git] / README
diff --git a/README b/README
index 3746e04..d45d71a 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-UseVoteGer 4.11  (c) 2001-2012 Marc Langer
+UseVoteGer 4.12  (c) 2001-2014 Marc Langer
 
 UseVoteGer is a voting software for usenet votes.
 
@@ -18,7 +18,7 @@ written in C). Not all functions of Usevote/UseVoteGer 3.x are implemented!
  
 -------------------------------------------------------------------------------
 
-UseVoteGer 4.11 - Usenet-Abstimmungssoftware
+UseVoteGer 4.12 - Usenet-Abstimmungssoftware
 ===========================================
 
 von Marc Langer <uv@marclanger.de>
@@ -187,7 +187,7 @@ UVrules.pm        Routinen zur Regelverarbeitung (usevote.rul)
 UVsendmail.pm     Routinen zum Erzeugen von Mails
 UVtemplate.pm     Routinen zur Verarbeitung von Vorlagen (Templates)
 bdsgtext.cfg      Spezieller Text fuer den Wahlschein (Hinweis auf
-                  Datenschutzgesetz), muss ausserhalb Deutschlands ggfls.
+                  DSGVO), muss ausserhalb Deutschlands ggfls.
                   angepasst oder kann ignoriert werden (bdsg=0 in usevote.cfg)
 mailpatterns.cfg  Wildcards fuer verdaechtige Mailadressen
 messages.cfg      Programm-Meldungen (Ressourcen-Datei)
@@ -324,6 +324,7 @@ ohne die .pl und .pm Dateien jedesmal mitzukopieren. Folgende Dateien
 sollten im Abstimmungsverzeichnis vorhanden sein (notwendig ist nur
 usevote.cfg, darin können alle anderen Pfade angepasst werden):
 
+ballot.sample
 bdsgtext.cfg
 mailpatterns.cfg
 messages.cfg
@@ -404,6 +405,7 @@ mit einzelnen Stimmen wirst Du interaktiv durch Menues gefuehrt.
 Meistens gibt es folgende Moeglichkeiten, die durch die
 eingeklammerten Buchstaben und Zahlen aufgerufen werden koennen:
 
+(0) Wahlschein mit Original vergleichen (diff)
 (1) Anzeigen der Wahlmail
 
 Bestaetigen oder Aendern von Wahlschein-Eigenschaften:
@@ -412,6 +414,7 @@ Bestaetigen oder Aendern von Wahlschein-Eigenschaften:
 (4) Stimmen
 (5) Scheinkennung
 (6) Datenschutzklausel
+(7) Abstimmung
 
 (i) Diese Stimme ignorieren (ohne Benachrichtigung verwerfen)
 (w) Weiter
@@ -426,8 +429,11 @@ Teilweise gibt es Unteroptionen:
 Nun solltest Du zunaechst mit (1) die Mail ansehen und anhand
 der bemaengelten Punkte entscheiden, ob der Wahlschein gueltig
 oder ungueltig ist bzw. welche Maengel tatsaechlich zutreffen.
+Mit (0) kannst Du einen Dateivergleich zu einem vorher hinterlegten
+Musterwahlschein ausfuehren ("diff"), um Aenderungen/Fehler schneller
+zu sehen.
 
-Mit den Optionen (2) bis (6) kannst Du einzelne Eigenschaften
+Mit den Optionen (2) bis (7) kannst Du einzelne Eigenschaften
 des Wahlscheins nachbessern (wenn Usevote z.B. einen Namen oder
 eine Stimme nicht korrekt erkannt hat) oder auch einfach die
 Korrektheit bestaetigen.
@@ -518,7 +524,7 @@ Das Endergebnis kannst Du mit "uvcount.pl -r" ausgeben lassen.
 Bei Verfahren mit mehreren Abstimmungspunkten wird automatusch
 das folgende tabellarische Format verwendet:
 
- Ja  Nein : 2/3? >=60? : ang.? : Gruppe
+ Ja  Nein : 2/3? >=15? : ang.? : Gruppe
 ==== ==== : ==== ===== : ===== : =======================================
  100   70 : Nein   Ja  :  Nein : Einrichtung von xyz
 
@@ -685,6 +691,10 @@ uvbounce.pl
   eingeschaltet und die Option -f (siehe unten) nicht benutzt wurde,
   werden die uebergebenen Dateinamen ignoriert.
 
+  Die Mails werden aus den uebergebenen Mailboxdateien geloescht
+  und statt dessen in einer neuen Datei mit der Erweiterung ".processed"
+  gespeichert.
+
   Die Vorlage fuer die ausgegebene Liste ist im templates-
   Unterverzeichnis konfigurierbar (Datei "bouncelist").
 
@@ -957,6 +967,7 @@ Hier eine Auflistung der immer anzupassenden Optionen
 votename         Name der Abstimmung
 group1           Erster Abstimmungsgegenstand
 group2           Zweiter (und so weiter durchnummerieren)
+sampleballotfile Datei mit Musterwahlschein aus dem CfV fuer Dateivergleich (diff)
 votefile         Mailbox mit eingehenden Stimmen (falls POP3 ausgeschaltet)
 mailboxtype      Typ der Mailbox (mbox, maildir)
 personal         Personalisierte Wahlscheine verwenden? [BOOL]
@@ -978,7 +989,7 @@ onestep          Mails direkt verschicken und Ergebnisse speichern? [BOOL]
 multigroup       Fuer das Ergebnis auch bei Eingruppenabstimmung des
                  Mehrgruppenformat waehlen? [BOOL]
 condition1       Bedingungen fuer einen Erfolg der Abstimmung in Perl-Syntax
-condition2       (normalerweise "$yes>=2*$no" und "$yes>=60"
+condition2       (normalerweise "$yes>=2*$no" und "$yes>=15"
 resultfile       Datei fuer Gesamtergebnis (normalerweise ergebnis.alle)
 idfile           Datei mit Scheinkennungen (bei "personal=1")
 pop3             POP3 benutzen? [BOOL] (andernfalls Stimmen aus Datei lesen)
@@ -1016,7 +1027,7 @@ domailfile       Name des Shellscripts zum Versenden der Bestaetigungsmails
                  (falls smtp=0, normalerweise tmp/domail)
 mailcmd          Aufruf des Mail Transfer Agents (MTA) zum Verschicken der
                  Bestaetigungsmails (falls smtp=0), z.B.
-                 "sendmail -oi -oem -femail@adresse"
+                 "sendmail -oi -oem -femail@adresse -- "
 sleepcmd         Weiteres Kommando, welches nach jeder Mail aufgerufen werden
                  soll (falls smtp=0). Sinnvoll ist ein "sleep x", wobei x bei
                  langsamen Systemen hoeher gewaehlt werden sollte.
@@ -1025,6 +1036,10 @@ clearcmd         Shellbefehl zum Loeschen des Bildschirms (Standard: clear),
                  oder Betriebssystem keinen solchen Befehl bereitstellen,
                  sollte ein Kommando verwendet werden, welches eine Trennlinie
                  oder aehnliches auf dem Bildschirm ausgibt, z.B. mit "echo"
+diff             Shellbefehl zum Dateivergleich (diff); es koennen auch 
+                 Parameter angegeben werden, z.B. "diff -u". Das verwendete
+                 Programm muss das Lesen einer Datei von STDIN erlauben
+                 ("-" statt Dateinamen fuer Einlesen von Standardeingabekanal)
 pager            Shellbefehl zum seitenweisen Darstellen von Mails auf dem
                  Bildschirm (normalerweise "less"). Unter Windows muss "more"
                  benutzt werden, unter Unix hingegen gibt es moeglicherweise
This page took 0.012782 seconds and 4 git commands to generate.