کامنت‌ها (Comments)

هر خطی که با نویسهٔ '#' آغاز شود به عنوان یک کامنت (توضیح) در نظر گرفته می‌شود.

دستورالعمل‌ها (Directives)

base=base-directory

مسیر دایرکتوری والد مشترک تمام پوشه‌های maildir شما را مشخص می‌کند.

imap_server=hostname

اگر هرگونه پوشهٔ منبع IMAP مشخص شده باشد یا پوشهٔ نتایج یک پوشهٔ IMAP باشد، نام میزبان کارساز IMAP را مشخص می‌کند. درگاه (port) در حال حاضر همواره ۱۴۳ است. این گزینه با گزینهٔ 'imap_pipe' ناسازگار بوده و مانعة‌الجمع است.

imap_pipe=shell-command

اگر هرگونه پوشهٔ منبع IMAP مشخص شده باشد یا پوشهٔ نتایج یک پوشهٔ IMAP باشد، یک دستور پوسته را مشخص می‌کند که می‌تواند برای اتصال به کارساز IMAP و ارتباط با آن از طریق لوله‌های یونیکس (UNIX pipes) به جای اتصال TCP/IP استفاده شود. این گزینه با گزینهٔ 'imap_server' مانعة‌الجمع است.

imap_username=username

اگر هرگونه پوشهٔ منبع IMAP مشخص شده باشد یا پوشهٔ نتایج یک پوشهٔ IMAP باشد، نام کاربری مورد استفاده برای ورود به کارساز IMAP را مشخص می‌کند. این پارامتر اختیاری است، اما کارسازهای IMAP معمولاً از کلاینت‌ها می‌خواهند وارد سیستم شوند، بنابراین تعیین آن معمولاً ضروری است. یک نمونه از مواردی که به آن نیازی نیست، زمانی است که گزینهٔ 'imap_pipe' در حال استفاده است و دستور پوسته یک اتصال در وضعیت از پیش احرازهویت‌شده (pre-authenticated) با کارساز IMAP برقرار کرده است.

imap_password=password

اگر هرگونه پوشهٔ منبع IMAP مشخص شده باشد یا پوشهٔ نتایج یک پوشهٔ IMAP باشد، گذرواژهٔ مورد استفاده برای ورود به کارساز IMAP را مشخص می‌کند. این پارامتر اختیاری است، اما کارسازهای IMAP معمولاً از کلاینت‌ها می‌خواهند وارد سیستم شوند، بنابراین تعیین آن معمولاً ضروری است.

maildir=list-of-folder-specifications

فهرستی جداشده با دونقطه (colon-separated) از پوشه‌های Maildir (نسبت به `base') است که می‌خواهید نمایه شوند. هر ورودی که به `...' ختم شود، به صورت بازگشتی پیمایش می‌شود تا هرگونه پوشهٔ Maildir زیر آن پیدا شود.

می‌توان بیش از یک خط که با `maildir' آغاز می‌شود درج کرد. در این حالت، mairix خطوط را همانند اینکه فهرستی منفرد از پوشه‌ها در یک خط بسیار طولانی داده شده باشد، با دونقطه به یکدیگر متصل می‌کند.

هر ورودی جداشده با دونقطه می‌تواند یک wildcard باشد. برای ساختار نگارشی wildcardها توضیحات ذیل mbox (در ادامه) را ببینید. برای مثال:

maildir=zzz/foo*...

پوشه‌های maildir مانند موارد زیر را تطبیق خواهد داد (نسبت به base-directory):

zzz/foobar/xyz
zzz/fooquux
zzz/foo
zzz/fooabc/u/v/w

و

maildir=zzz/foo[abc]*

پوشه‌های maildir مانند موارد زیر را تطبیق خواهد داد (نسبت به folder_base):

zzz/fooa
zzz/fooaaaxyz
zzz/foobcd
zzz/fooccccccc

اگر نام یک پوشه حاوی دونقطه باشد، می‌توانید با استفاده از توالی دونقطه را اسکیپ کنید. در غیر این صورت، با نویسهٔ بک‌اسلش به صورت عادی رفتار می‌شود. (اگر نام پوشه واقعاً حاوی توالی باشد، متأسفانه کاری نمی‌توان کرد.)

mh=list-of-folder-specifications

فهرستی جداشده با دونقطه از پوشه‌های MH (نسبت به `base') است که می‌خواهید نمایه شوند. هر ورودی که به '...' ختم شود، به صورت بازگشتی برای یافتن هرگونه پوشهٔ MH زیر آن پیمایش می‌شود.

می‌توان بیش از یک خط که با 'mh' آغاز می‌شود درج کرد. در این حالت، mairix خطوط را همانند اینکه فهرستی منفرد از پوشه‌ها در یک خط بسیار طولانی داده شده باشد، با دونقطه به یکدیگر متصل می‌کند.

هر ورودی جداشده با دونقطه می‌تواند یک wildcard باشد؛ برای ساختار نگارشی و مفاهیم تعیین wildcardها، توضیحات ذیل maildir (در بالا) و mbox (در ادامه) را ببینید.

mairix انواع پوشه‌های MH ایجاد شده توسط برنامه‌های رایانامه زیر را می‌شناسد:

mbox=list-of-folder-specifications

فهرستی جداشده با دونقطه از پوشه‌های mbox یا MMDF (نسبت به `base') است که می‌خواهید نمایه شوند.

هر مورد جداشده با دونقطه در فهرست می‌تواند دارای پسوند '...' باشد. اگر مورد با یک پروندهٔ معمولی مطابقت داشته باشد، با آن پرونده به عنوان یک پوشهٔ mbox رفتار می‌شود و پسوند '...' نادیده گرفته می‌شود. اگر مورد با یک دایرکتوری مطابقت داشته باشد، یک پیمایش بازگشتی روی تمام محتویات درون آن دایرکتوری انجام می‌شود و تمام پرونده‌های معمولی ابتدا به عنوان پوشه‌های mbox/MMDF در نظر گرفته می‌شوند. (هر دایرکتوری که در این پیمایش یافت شود، خود مجدداً پیمایش می‌شود، زیرا این پیمایش بازگشتی است.)

هر مورد جداشده با دونقطه ممکن است شامل عملگرهای wildcard باشد، اما تنها در آخرین بخش مسیر آن. عملگرهای wildcard که در حال حاضر پشتیبانی می‌شوند عبارتند از:

*

تطبیق صفر یا چند نویسه (هر نویسهٔ تطبیق‌یافته دلخواه است)

?

تطبیق دقیقاً یک نویسهٔ دلخواه

[abcs-z]

کلاس نویسه: تطبیق یک نویسهٔ منفرد از مجموعهٔ a, b, c, s, t, u, v, w, x, y و z.

برای گنجاندن نویسهٔ ']' واقعی در کلاس، آن را بلافاصله پس از '[' آغازین قرار دهید. برای گنجاندن نویسهٔ '-' واقعی در کلاس، آن را بلافاصله پیش از ']' پایانی قرار دهید.

اگر این فرا‌نویسه‌ها (metacharacters) در بخش‌های غیرپایانی مسیر گنجانده شوند، هیچ معنای خاصی نخواهند داشت.

چند مثال:

mbox=foo/bar*

تطبیق با 'foo/bar' ،'foo/bar1' ،'foo/barrrr' و غیره

mbox=foo*/bar*

تطبیق با 'foo*/bar' ،'foo*/bar1' ،'foo*/barrrr' و غیره

mbox=foo/*

تطبیق با 'foo/bar' ،'foo/bar1' ،'foo/barrrr' ،'foo/foo' ،'foo/x' و غیره

mbox=foo...

تطبیق با هر پروندهٔ معمولی در درخت دایرکتوری به ریشهٔ 'foo'

mbox=foo/*...

مشابه مورد پیشین

mbox=foo/[a-z]*...

تطبیق با 'foo/a' ،'foo/aardvark/xxx' ،'foo/zzz/foobar' و 'foo/w/x/y/zzz'، اما نه 'foo/A/foobar'

پرونده‌های معمولی که کاندیدای پوشهٔ mbox هستند به صورت داخلی بررسی می‌شوند. تنها پرونده‌هایی که شامل خطوط جداکنندهٔ استاندارد mbox یعنی یا MMDF یعنی ´^A^A^A^A' باشند برای یافتن پیام‌ها پیمایش می‌شوند.

اگر یک پروندهٔ معمولی نامی با پسوند '.gz' داشته باشد و پشتیبانی از gzip در باینری mairix کامپایل شده باشد، پرونده به عنوان یک mbox فشرده با gzip در نظر گرفته می‌شود.

اگر یک پروندهٔ معمولی نامی با پسوند '.bz2' داشته باشد و پشتیبانی از bzip در باینری mairix کامپایل شده باشد، پرونده به عنوان یک mbox فشرده با bzip2 در نظر گرفته می‌شود.

می‌توان بیش از یک خط که با 'mbox' آغاز می‌شود درج کرد. در این حالت، mairix خطوط را همانند اینکه فهرستی منفرد از پوشه‌ها در یک خط بسیار طولانی داده شده باشد، با دونقطه به یکدیگر متصل می‌کند.

mairix هنگام دسترسی به پوشه‌های mbox هیچ‌گونه قفل‌گذاری (locking) روی آن‌ها انجام نمی‌دهد. اگر یک برنامهٔ تحویل رایانامه هم‌زمان در حال تغییر mbox باشد، احتمال دارد که یک یا چند پیام در mbox هرگز توسط mairix نمایه نشوند (دست‌کم تا زمانی که پایگاه داده حذف و از ابتدا دوباره ساخته شود). فرض بر این است که mairix برای نمایه کردن پوشه‌های بایگانی استفاده خواهد شد تا پوشه‌های ورودی جدید، بنابراین بعید است این موضوع در عمل مشکل چندانی ایجاد کند.

mairix می‌تواند حداکثر از ۶۵۵۳۶ پروندهٔ mbox مجزا و حداکثر از ۶۵۵۳۶ پیام درون هر mbox پشتیبانی کند.

imap=list-of-folders

فهرستی جداشده با دونقطه از پوشه‌های IMAP است که می‌خواهید نمایه شوند.

این پوشه‌ها همگی باید در یک حساب کاربری یکسان بر روی یک کارساز IMAP یکسان قرار داشته باشند. گزینه‌های پیکربندی imap_server و imap_pipe نحوهٔ اتصال به کارساز IMAP را مشخص می‌کنند.

می‌توان بیش از یک خط که با 'imap' آغاز می‌شود درج کرد. در این حالت، mairix خطوط را همانند اینکه فهرستی منفرد از پوشه‌ها در یک خط بسیار طولانی داده شده باشد، با دونقطه به یکدیگر متصل می‌کند.

omit=list-of-glob-patterns

فهرستی جداشده با دونقطه از الگوهای تطبیق (glob patterns) برای پوشه‌هایی است که باید از فرایند نمایه‌سازی حذف شوند. این ویژگی امکان استفاده از wildcardهای گسترده و عناصر بازگشتی را در دستورالعمل‌های maildir، mh و mbox فراهم می‌کند، در حالی که از گزینهٔ omit برای حذف انتخابی پوشه‌های ناخواسته از فهرست پوشه‌ها استفاده می‌شود.

درون الگوهای glob، یک '*' منفرد با هر توالی از نویسه‌ها غیر از '/' مطابقت دارد. اما '**' با هر توالی از نویسه‌ها شامل '/' مطابقت دارد. این قابلیت امکان ساخت الگوهای glob را فراهم می‌کند که دارای wildcard برای تنها یک جزء دایرکتوری یا هر تعداد جزء دایرکتوری باشند.

گزینهٔ omit می‌تواند به هر تعداد بار که نیاز باشد تعیین شود تا نیازی به گنجاندن کل فهرست الگوها در یک خط نباشد.

به عنوان مثال:

mbox=bulk...
omit=bulk/spam*

تمام پوشه‌های mbox را در هر سطحی زیر زیرشاخهٔ 'bulk' از پوشهٔ base نمایه می‌کند، به جز پوشه‌هایی که نام آن‌ها با 'bulk/spam' آغاز می‌شود، مانند 'bulk/spam' ،'bulk/spam2005' و غیره.

در مقابل:

mbox=bulk...
omit=bulk/spam**

تمام پوشه‌های mbox را در هر سطحی زیر زیرشاخهٔ 'bulk' از پوشهٔ base نمایه می‌کند، به جز پوشه‌هایی که نام آن‌ها با 'bulk/spam' آغاز می‌شود، مانند 'bulk/spam' ،'bulk/spam2005' ،'bulk/spam/2005' ،'bulk/spam/2005/jan' و غیره.

nochecks

این دستورالعمل هیچ آرگومانی نمی‌پذیرد. اگر خطی با nochecks شروع شود، معادل تعیین پرچم -Q در هر بار اجرای نمایه‌سازی است.

mfolder=match-folder-name

نام پوشه‌ای را (درون دایرکتوری مشخص‌شده توسط base) تعیین می‌کند که حالت جستجو خروجی خود را در آن می‌نویسد. (اگر مقدار mformat استفاده‌شده 'raw' یا 'excerpt' باشد، این تنظیم استفاده نمی‌شود و می‌توان از آن صرف‌نظر کرد.)

تنظیم mfolder می‌تواند برای یک جستجوی خاص با استفاده از گزینهٔ -o در mairix نادیده گرفته و جایگزین شود.

mairix از نوشتن نتایج جستجو در پوشه‌ای که به نظر می‌رسد در میان پوشه‌های نمایه‌شده است خودداری می‌کند. این کار برای جلوگیری از حذف تصادفی رایانامه‌ها انجام می‌شود.

اگر نخستین نویسهٔ مقدار mfolder برابر '/' یا '.' باشد، به عنوان یک نام مسیر مستقل در نظر گرفته می‌شود. این امر به شما امکان می‌دهد مسیرهای مطلق و مسیرهای نسبی نسبت به دایرکتوری جاری را برای محل نوشتن mfolder مشخص کنید. در غیر این صورت، مقدار mfolder به انتهای مقدار base اضافه می‌شود، همان‌طور که برای پوشه‌های منبع انجام می‌شد.

mformat=format

نوع پوشهٔ مورد استفاده برای پوشهٔ تطبیق (که نتایج جستجو به آنجا می‌روند) را تعیین می‌کند. شش مقدار معتبر برای format وجود دارد، یعنی 'maildir' ،'mh' ،'mbox' ،'imap' ،'raw' یا 'excerpt' (نتایج جستجوی MMDF پشتیبانی نمی‌شوند). اگر تنظیم 'raw' استفاده شود، mairix تنها مسیر پرونده‌های تطبیق‌یافته را چاپ خواهد کرد و هیچ پوشهٔ تطبیقی ایجاد نخواهد شد. اگر از تنظیم 'excerpt' استفاده شود، mairix همچنین سرآیندهای Date: ،Subject: ،From: ،Cc: ،To: از پیام‌های تطبیق‌یافته را چاپ خواهد کرد. در صورت عدم تعیین این گزینه، پیش‌فرض 'maildir' است. این تنظیم به حروف بزرگ و کوچک حساس نیست.

database=path-to-database

مسیری را مشخص می‌کند که پایگاه دادهٔ نمایهٔ mairix در آن نگهداری می‌شود. شما می‌توانید این پرونده را در هر کجایی که تمایل دارید نگهداری کنید.

در حال حاضر، mairix یک پروندهٔ پایگاه دادهٔ منفرد را در مکان مشخص‌شده توسط path-to-database قرار می‌دهد. با این حال، نسخهٔ آیندهٔ mairix ممکن است به جای آن یک دایرکتوری حاوی چندین پرونده در این مکان قرار دهد.

path-to-database باید یک مسیر مطلق باشد (که با '/' آغاز می‌شود). اگر از یک مسیر نسبی استفاده شود، نسبت به دایرکتوری جاری در زمان اجرای mairix تفسیر خواهد شد (نه نسبت به مکان پروندهٔ mairixrc یا نظایر آن).

follow_mbox_symlinks

این دستورالعمل هیچ آرگومانی نمی‌پذیرد. به طور پیش‌فرض، mairix پیوندهای نمادین (symlinks) به پرونده‌های mbox یا MMDF را هنگام نمایه‌سازی نادیده می‌گیرد. اگر خطی با follow_mbox_symlinks وجود داشته باشد، mairix به جای نادیده گرفتن، آن‌ها را دنبال خواهد کرد.

sort=date+

نتایج جستجو به ترتیب صعودی تاریخ مرتب خواهند شد. هیچ مقدار دیگری برای sort در حال حاضر پذیرفته نمی‌شود. در صورت نبود این ورودی، نتایج مرتب‌نشده خواهند بود.

گسترش‌ها (Expansions)

بخشی از هر خط در '.mairixrc' پس از علامت مساوی می‌تواند شامل انواع گسترش زیر باشد:

گسترش دایرکتوری خانگی (Home directory expansion)

اگر توالی '~/' در آغاز متن پس از علامت مساوی ظاهر شود، به دایرکتوری خانگی کاربر گسترش می‌یابد. مثال:

database=~/Mail/mairix_database

گسترش متغیرهای محیطی (Environment expansion)

اگر یک '$' با توالی‌ای از نویسه‌های الفبایی-عددی (یا '_') دنبال شود، کل رشته با جستجوی متغیر محیطی متناظر جایگزین می‌شود. به طور مشابه، اگر '$' با یک آکولاد باز ('{') دنبال شود، همه چیز تا آکولاد بستهٔ بعدی به عنوان متغیر محیطی جستجو می‌شود و نتیجه جایگزین کل توالی خواهد شد.

فرض کنید در پوسته دستور زیر را اجرا کنیم:

export FOO=bar

و پروندهٔ '.mairixrc' حاوی موارد زیر باشد:

maildir=xxx/$FOO
mbox=yyy/a${FOO}b

این معادل است با:

maildir=xxx/bar
mbox=yyy/abarb

اگر متغیر محیطی مشخص‌شده تنظیم نشده باشد، مقدار جایگزین رشتهٔ خالی خواهد بود.