Komentáře

Slovo začínající znakem # a všechny následující znaky až do konce řádku jsou ignorovány. Toto neplatí pro řádky obsahující podmínku, ty nemohou být komentovány.

Předpisy

Řádek začínající znakem ':' označuje začátek předpisu. Má tento formát:

:0 [příznaky] [ : [lokální_zámek] ] <jedna nebo více podmínek
(jedna na řádek)> <právě jeden akční řádek>

Podmínkový řádek začíná znakem `*'. Zbytek řádku kromě uvozujících a koncových mezer je poslán znak po znaku na vstup vnitřního egrep-u. Regulární výrazy vnitřního egrepu jsou naprosto kompatibilní s rozšířenou syntaxí regulárních výrazů programu egrep(1). Viz též Rozšířená syntaxe regulárních výrazů.

Mezi podmínkami v jednom předpisu platí logický součin (AND). Pokud předpis neobsahuje žádnou podmínku, výsledek testu bude vždycky pravdivý.

Příznak může být jeden z následujících znaků:

H

Do programu egrep se pošle záhlaví zprávy (standard).

B

[přibližně] Do egrepu se pošle tělo zprávy.

D

Sdělí egrepu, že má rozlišovat malá a velká písmena (standard je nerozlišovat).

A

Tento předpis bude závislý na posledním předcházejícím předpisu bez příznaku `A' nebo `a' (na aktuální úrovni vnoření). To vám umožňuje řetězit akce, které závisí na společné podmínce.

a

Má tentýž význam jako `A', ale bude zároveň záviset na úspěšném dokončení předchozího předpisu.

E

Tento předpis se provede pouze v případě, že bezprostředně předcházející předpis nebyl proveden. Jeho úspěšné provedení rovněž znemožní provedení bezprostředně následujících předpisů s `E'. To vám umožňuje definovat akce typu `else if'.

e

Předpis se provede pouze v případě, že bezprostředně předcházející předpis selhal. To vám umožňuje definovat akce na zpracování chyb.

h

Záhlaví zprávy se pošle na vstup roury, do souboru nebo na místo určení zprávy (default).

b

Tělo zprávy se pošle na vstup roury, do souboru nebo na místo určení zprávy (default).

f

S rourou se má zacházet jako s filtrem.

c

Vytvoř kopii zpracovávané zprávy. Tento příznak má význam pouze v doručujících předpisech. Jediný druh nedoručujícího předpisu v němž dojde tento příznak smysluplného použití je blok (vnoření). Aby mohla být zpracována kopie, příznak způsobí rozdvojení právě běžícího procesu (zámky se nedědí), přičemž nový proces pokračuje ve zpracování obvyklým způsobem, zatímco původní proces přeskočí blok a pokračuje za ním.

w

Čeká na ukončení spuštěného filtru nebo programu a otestuje návratovou hodnotu (standardně ji ignoruje). Pokud bude filtr neúspěšný, text nebude filtrován.

W

Stejný význam jako příznak `w', ale potlačí hlášky `Program failure'.

i

Ignoruje chyby zápisu v tomto předpisu (obvykle nastávají při předčasném uzavření roury).

r

`Hrubý' režim (raw). Nepokouší se ujistit jestli zpráva končí prázdným řádkem, zapíše ji tak jak je.

Můžete použít zvláštní podmínky, které nejsou přímo regulárními výrazy. Takové podmínky musí začínat:

!

Negace podmínky následující po vykřičníku.

$

Zbytek podmínky vyhodnotí podle pravidel pro substituci uvnitř dvojitých uvozovek v sh(1) , přeskočí úvodní mezery a potom znovu vyhodnotí.

?

Použije návratový kód uvedeného programu.

<

Otestuje, zda je celková délka zprávy menší než uvedený počet bajtů (decimálně).

>

Obdobně jako '<'.

jméno_proměnné ??

Porovná zbytek podmínky s hodnotou této proměnné (nesmí se jednat o pseudoproměnnou). Zvláštním případem jsou `B', `H', `HB' a `BH', které pouze mění prohledávanou oblast záhlaví/těla zprávy, definovanou pro aktuální předpis.

\

Použijte, chcete-li použít kterýkoliv z výše uvedených znaků na začátku řádku v jeho normálním významu.

Lokální zámek

Pokud umístíte na konec prvního řádku předpisu druhou dvojtečku, procmail použije lokální_zámek (pouze pro aktuální předpis). Volitelně můžete za dvojtečku zadat jméno zámku, který chcete použít. Pokud tak ovšem neučiníte, procmail použije jméno výstupního souboru (nebo jméno za první '>>'), za které připojí hodnotu $LOCKEXT.

Akční řádek předpisu

Akční řádek může začínat jedním z následujících znaků:

!

Pošle poštu (forward) na všechny následující e-mailové adresy.

|

Spustí určený program; pokud je nalezen kterýkoliv znak z $SHELLMETAS, pokusí se spustit program pomocí $SHELL-u. Volitelně můžete před znak roury umístit proměnná=, což způsobí, že standardní výstup spuštěného programu bude uložen do proměnné prostředí (procmail v tomto místě neukončí zpracovávání konfiguračního souboru). Pokud zadáte pouze znak roury bez žádného názvu programu, procmail přesměruje obsah zprávy na standardní výstup.

{

Následována alespoň jednou mezerou, tabulátorem nebo znakem nový řádek označuje začátek vnořeného bloku. Všechno uvnitř bloku až po následující uzavírající závorku bude záviset na podmínce aktuálního předpisu. Počet úrovní vnoření není omezen. Uzavírací závorka pouze ukončuje blok; v žádném případě nezpůsobuje ukončení procmailu. Když je dosaženo konce bloku, zpracování pokračuje obvyklým způsobem za blokem. Ve vnořeném bloku mají příznaky `B' a `H' vliv pouze na podmínky předcházející tento blok, příznaky `h' a `b' nemají vůbec žádný vliv.

Cokoliv jiného bude považováno za jméno poštovní schránky (buď jméno souboru nebo adresáře, absolutní nebo relativní k aktuálnímu adresáři (viz MAILDIR)). Pokud se jedná o jméno souboru (byť neexistujícího), zpráva bude přidána na jeho konec.

Pokud se jedná o jméno adresáře, zpráva bude doručena do souboru se zaručeně jedinečným názvem začínajícím $MSGPREFIX, nově vytvořeného v tomto adresáři. Pokud název adresáře končí řetězcem "/.", předpokládá se, že se jedná o složku systému MH a procmail použije další volné číslo, které nalezne. Pokud jméno schránky končí na "/", je tento adresář považován za složku maildir; tj. procmail doručí zprávu do souboru v podadresáři pojmenovaném "tmp" a přejmenuje jej, aby byl v podadresáři "new". Pokud je schránka určena jako složka MH nebo složka maildir, procmail vytvoří potřebné adresáře, pokud neexistují; nebude považovat schránku za neexistující jméno souboru. Pokud procmail doručuje do adresáře, můžete zadat několik adresářů do nichž chcete zprávu doručit (procmail k tomu používá hardlinky).

Implicitní hodnoty proměnných

LOGNAME, HOME and USER_SHELL

Vaše (příjemcovy) standardní hodnoty

SHELL

/bin/sh

PATH

$HOME/bin :/usr/local/bin :/usr/bin :/bin (Výjimkou je doba zpracování souboru /etc/procmailrc, kdy je nastavena na `/usr/local/bin :/usr/bin :/bin'.)

SHELLMETAS

& |<>~;?*[

SHELLFLAGS

-c

ORGMAIL

/var/mail/$LOGNAME
(V případě, že bylo zadáno -m nedefinováno)

MAILDIR

$HOME
(Kromě případu, kdy jméno prvního úspěšně otevřeného rc souboru začíná `./' nebo bylo zadáno -m; tehdy je implicitní hodnota `.')

DEFAULT

$ORGMAIL

MSGPREFIX

msg.

SENDMAIL

/usr/sbin/sendmail

SENDMAILFLAGS

-oi

HOST

Aktuální jméno počítače (hostname)

COMSAT

no
(Pokud je jméno rc souboru určeno v příkazové řádce)

PROCMAIL_VERSION

3.24

LOCKEXT

.lock

Ostatní nulované nebo přednastavené proměnné jsou IFS, ENV a PWD.

Z bezpečnostních důvodů vymaže procmail při startu všechny proměnné, které by které by mohly ovlivnit chování runtime linkeru.

Environment

Dříve než vás zahltí množství proměnných, mějte na paměti, že všechny mají rozumné implicitní hodnoty.

MAILDIR

Aktuální adresář za běhu procmailu (což znamená, že všechny cesty jsou relativní vzhledem k $MAILDIR).

DEFAULT

Standardní soubor poštovní schránky (pokud není určeno jinak, procmail uloží zprávu do této schránky). Před zápisem do této schránky použije procmail automaticky $DEFAULT$LOCKEXT jako zámek. Tuto proměnnou nemusíte nastavovat, neboť již obsahuje implicitní systémovou schránku.

LOGFILE

Tento soubor bude obsahovat jakákoliv chybová nebo diagnostická hlášení procmailu (za normálních okolností žádná :-) příp. jiných programů spuštěných procmailem. Jestliže tento soubor není definován, veškerá diagnostická nebo chybová hlášení budou zaslána e-mailem odesilateli zprávy. Viz též LOGABSTRACT.

VERBOSE

Nastavením této proměnné na `yes' nebo `on' (ano, resp. zapnout; pozn. překl.) případně `no' či `off' (ne, vypnout) můžete zapínat respektive vypínat rozšířenou diagnostiku.

LOGABSTRACT

Těsně před svým ukončením zapíše procmail do souboru $LOGFILE shrnutí zprávy: záhlaví `From:' a `Subject:', do jaké složky (schránky) byla zpráva uložena a jaká byla její délka v bajtech. Nastavením této proměnné na `no' se výpis potlačí. Nastavením této proměnné na `all' (všechno) se zajistí výpis pro každý úspěšně dokončený doručující předpis.

LOG

Cokoliv přiřazené této proměnné bude připojeno do souboru $LOGFILE.

ORGMAIL

Obvykle systémová schránka (ORiGinal MAILbox). Pokud z nějakého tajemného důvodu (jako `filesystem full') nemůže být zpráva doručena, tato schránka bude poslední možností. Pokud se procmailu nepodaří zprávu uložit ani sem (móc, moc špatný :-) vrátí zprávu odesílateli.

LOCKFILE

Globální semafor. Pokud tento soubor již existuje, procmail před dalším zpracováním počká až zmizí; potom jej sám vytvoří (a samozřejmě také smaže, když skončí). Pokud je specifikován více než jeden semafor bude ten předchozí smazán dříve než se zkusí vytvořit nový. Užívání globálního semaforu se nedoporučuje. Tam kde je to možné, použijte místo toho lokální zámky (na bázi jednotlivých předpisů).

LOCKEXT

Implicitní přípona, jejímž připojením ke jménu cílového souboru se získá jméno lokálního zámku (pokud jsou zapnuty, pro jednotlivé předpisy).

LOCKSLEEP

Počet sekund, které procmail vyčká než opět zkusí zámek (pokud již existoval); pokud není specifikováno, implicitní hodnota je 8 sekund.

LOCKTIMEOUT

Počet sekund, které musí uplynout od času poslední modifikace/vytvoření zámku aby procmail usoudil, že se to musí být soubor pozůstalý v důsledku chyby, který nyní může být nuceně odstraněn. Pokud je nastavena nula, lhůta se nepoužije a procmail bude čekat navždy dokud se soubor neodstraní; pokud není specifikována žádná hodnota, implicitně 1024 sekund. Tato proměnná se hodí proti zacyklení sendmailu/procmailu. Procmail je imunní vůči odchylkám hodin na různých počítačích.

TIMEOUT

Počet sekund, které musí uplynout než procmail usoudí, že některý z dceřiných procesů, které spustil, musel zamrznout. Dotyčný program obdrží od procmailu signál TERMINATE a zpracování konfiguračního souboru bude pokračovat. Pokud je nula, lhůta se nepoužije a procmail čeká dokud se neukončí dceřiný process; není-li hodnota specifikována je implicitní hodnota 960 sekund.

MSGPREFIX

Předpona souboru, pokud se zpráva doručuje do adresáře (nepoužívá se při doručování do MH adresáře).

HOST

Pokud toto není totožné se jménem počítače, které vrací hostname, zpracování aktuálního konfiguračního souboru se okamžitě ukončí. Pokud byly na příkazové řádce uvedeny další konfigurační soubory, zpracování bude pokračovat následujícím z nich. Pokud již byly všechny použity, program se ukončí, ale nezpůsobí chybu (tzn. že poštovnímu programu se bude zdát, že pošta byla doručena).

UMASK

Jméno říká vše (pokud ne, zapomeňte na něj :-). Jakákoliv hodnota přiřazená UMASK bude interpretována jako osmičkové číslo. Není-li specifikováno, maska je implicitně 077. Pokud maska dovoluje o+x, všechny schránky do nichž procmail doručuje přímo prodělají změnu o+x. To se dá použít ke kontrole zda přišla nová pošta.

SHELLMETAS

Pokud se kterýkoliv ze znaků řetězce SHELLMETAS objeví v řádku obsahujícím filtr nebo program, řádek bude poslán do $SHELL namísto přímého spuštění.

SHELLFLAGS

Jakékoliv volání $SHELL-u bude uskutečněno ve tvaru
"$SHELL" "$SHELLFLAGS" "$*";

SENDMAIL

Pokud nepoužíváte přesměrování (forwarding), nelamte si s tímhle hlavu. Určuje program, který bude forwardovat jakoukoliv poštu.
Volá se jako: "$SENDMAIL" $SENDMAILFLAGS "$@";

NORESRETRY

Počet opakovaných pokusů pokud nastane některá z chyb `process table full' (zaplnění tabulky procesů), `file table full' (zaplnění tabulky souborů), `out of memory' (nedostatek paměti) nebo `out of swap space' (zaplnění odkládacího prostoru). Pokud je toto číslo záporné, procmail to bude zkoušet donekonečna; pokud není specifikováno, implicitní hodnota je 4. Další pokusy o opakování akce nastávají v intervalu $SUSPEND sekund. Myšlenka tohoto uspořádání spočívá v tom, že pokud je např. vyčerpán swapovací prostor nebo se zaplnila tabulka procesů, obvykle to zjistí několik dalších programů, které buď skončí nebo zkolabují, čímž uvolní nedostávající se systémové zdroje procmailu.

SUSPEND

Čas v sekundách kdy bude procmail čekat na něco co momentálně není k dispozici (paměť, fork, atd.); není-li specifikováno, implicitní hodnota je 16 sekund. Viz též: LOCKSLEEP.

LINEBUF

Délka interní řádkové vyrovnávací paměti. Nelze nastavit menší než 128. Délka žádného řádku v konfiguračním souboru by neměla překročit $LINEBUF znaků před ani po provedení substitucí. Pokud není specifikováno, standard je 2048. Toto omezení samozřejmě neplatí na zprávu samotnou; ta může mít libovolné délky řádků nebo může být i binárním souborem. Viz též PROCMAIL_OVERFLOW.

DELIVERED

Pokud je nastavena na `yes', procmail bude předstírat (MTA), že zpráva byla doručena. Pokud při takovém nastavení nelze zprávu doručit, zpráva bude navždy ztracena (nebude odeslána na postmastera apod.).

TRAP

Při ukončení procmailu (neplatí, pokud bylo způsobeno přijatým signálem) se provede obsah této proměnné. Kopie zprávy je k dispozici na standardním vstupu. Jakýkoliv výstup vytvořený tímto příkazem bude připojen do souboru $LOGFILE. Možná použití TRAP-u: odstranění dočasných souborů, na míru šité výtahy zpráv, atd. Viz též: EXITCODE a LOGABSTRACT.

EXITCODE

Implicitně je návratová hodnota procmailu nula (úspěch), pokud úspěšně doručil zprávu nebo byla proměnná HOST špatně nastavena a na příkazové řádce nebyly žádné další konfigurační soubory; jinak je vráceno selhání. Ještě předtím ale procmail prozkoumá hodnotu této proměnné. Pokud byla této proměnné přiřazena kladná hodnota, použije se jako návratová hodnota při ukončení procmailu. Pokud je tato proměnná nastavena, ale prázdná, procmail použije návratovou hodnotu vrácenou programem TRAP Pokud tato proměnná není nastavena, procmail ji nastaví krátce před vyvoláním programu TRAP.

LASTFOLDER

Tuto proměnnou nastaví procmail, kdykoliv doručí nějakou zprávu do složky nebo do programu. Vždy obsahuje jméno souboru (nebo programu) kam procmail doručil zprávu. Pokud byla zpráva doručena do více složek najednou, bude $LASTFOLDER obsahovat hardlinkovaná jména souborů oddělěná mezerami.

MATCH

Procmail přiřadí této proměnné hodnotu, kdykoliv má uložit text z úspěšně porovnaného regulárního výrazu. Obsahuje veškerý text vyhovující regulárnímu výrazu za speciálním znakem `\/'.

SHIFT

Přiřazení kladné hodnoty této proměnné má stejný efekt jako příkaz `shift' v sh(1). Tento příkaz má největší využití při získání dalších argumentů předaných procmailu, když je použit jako generický filtr e-mailových zpráv.

INCLUDERC

Jméno konfiguračního souboru (relativní vzhledem k aktuálnímu adresáři), který bude zařazen do zpracování, jako by byl součástí aktuálního konfiguračního souboru. Vnořování je povoleno a je limitováno pouze systémovými zdroji (paměť a deskriptory souborů). Protože nejsou prováděny žádné kontroly přístupových práv nebo vlastníka konfiguračního souboru, měli by se uživatelé INCLUDERC ujistit, že právo zapisovat do něj nebo do jeho adresáře mají jen důvěryhodní uživatelé. Přiřazení INCLUDERC na příkazové řádce nemá žádný efekt.

SWITCHRC

Určuje konfigurační soubor (relativně k aktuálnímu adresáři), na který se při zpracovávání přejde. Pokud tento soubor neexistuje nebo se nejedná o normální soubor či /dev/null, zapíše se do logu chyba a zpracovávání bude pokračovat v aktuálním konfiguračním souboru. V opačném případě se zpracovávání aktuálního konfiguračního souboru ukončí a začne se s určeným konfiguračním souborem. Odnastavení (unsetting) SWITCHRC způsobí ukončení zpracovávání aktuálního konfiguračního souboru, jako kdyby normálně skončil. Stejně jako u INCLUDERC se ani zde neprovádí žádné kontroly přístupových práv a vlastníka konfiguračního souboru a přiřazení na příkazové řádce nemají žádný vliv.

PROCMAIL_VERSION

Číslo verze spuštěného programu procmail.

PROCMAIL_OVERFLOW

Tato proměnná bude nastavena na neprázdnou hodnotu pokud procmail zjistí přetečení bufferu. Viz sekce CHYBY, kde je uvedeno více o chování při výskytu přetečení.

COMSAT

Implicitně je notifikace comsat(8)/biff(1) zapnutá. Dá se vypnout nastavením této proměnné na `no'. Alternativně lze službu biff upravit nastavením této proměnné buď na `služba@', `@hostname' nebo `služba@hostname'. Není-li specifikováno, použije se biff@localhost.

DROPPRIVS

Nastaví-li se na `yes', procmail `shodí' všechna práva, kterých eventuálně mohl nabýt (suid, sgid). Toto se hodí pouze v případě, že chcete, aby se zbylá část souboru /etc/procmailrc provedla jménem příjemce.

Rozšířené regulární výrazy

The following tokens are known to both the procmail internal egrep and the standard egrep(1) (beware that some egrep implementations include other non-standard extensions; in particular, the repetition operator { is not supported by procmail's egrep):

^

Začátek řádku.

$

Konec řádku.

.

Jakýkoliv znak kromě konce řádku.

a*

Posloupnost libovolného, i nulového počtu áček.

a+

Posloupnost jednoho nebo více áček.

a?

Jedno nebo žádné a.

[^-a-d]

Jakýkoliv znak, který není pomlčka, a, b, c, d nebo konec řádku.

de|abc

Buď posloupnost `de' nebo `abc'.

(abc)*

Žádný výskyt nebo libovolný počet opakování posloupnosti `abc'.

\.

Jediná tečka; \ se používá k uvození všech znaků se zvláštním významem. Viz také použití $\ u proměnných.

Tohle byly samozřejmě pouze příklady. Jakákoliv složitější kombinace je rovněž přípustná.

Následující speciální konstrukce používá specifická rozšíření procmailu:

^ nebo $

Odpovídá novému řádku (u víceřádkových porovnání).

^^

Zakotví výraz na úplném začátku porovnávané oblasti, resp. na jejím úplném konci je-li tato kombinace nalezena na konci výrazu.

\< nebo \>

Porovnání se shoduje se znakem před anebo za slovem. Tyto speciální výrazy jsou pouhým synonymem pro `[^a-zA-Z0-9_]', ale shoda nastane i pro znak `nový řádek'. Jelikož tyto symboly se shodují se skutečnými znaky, lze je použít pouze k oddělení slov, nikoli pro odlišení mezer mezi slovy.

\/

Rozděluje výraz na dvě části. Všechno co se shoduje v pravé části se přiřadí proměnné MATCH.