RECOLL.CONF(5) File Formats Manual RECOLL.CONF(5)

recoll.conf - پرونده پیکربندی شخصی اصلی برای Recoll

این پرونده پیکربندی نمایه‌سازی را برای سامانه جستجوی تمام‌متن Recoll مشخص می‌کند.

پرونده پیکربندی سراسری سیستم معمولاً درون مسیر /usr/[local]/share/recoll/examples قرار دارد. هر پارامتری که در پرونده عمومی تنظیم شود، با بازتعریف آن در پرونده پیکربندی نمایه مشخص، به طور پیش‌فرض: $HOME/.recoll/recoll.conf بازنویسی (override) می‌شود.

تمام دستورهای recoll گزینه -c را می‌پذیرند یا از متغیر محیطی $RECOLL_CONFDIR برای تعیین شاخه پیکربندی نمایه غیرپیش‌فرض استفاده می‌کنند.

نمونه کوتاهی از این پرونده می‌تواند به شکل زیر باشد:

# Space-separated list of directories to index.
topdirs =  ~/docs /usr/share/doc
[~/somedirectory-with-utf8-txt-files]
defaultcharset = utf-8

سه نوع خط در این پرونده وجود دارد:

  • توضیحات (کامنت) یا خطوط خالی.
  • انتساب پارامتر.
  • تعریف بخش (Section).

خطوط خالی یا خطوطی که با # شروع می‌شوند نادیده گرفته می‌شوند.

خطوط انتساب به صورت 'name = value' هستند. در توضیحات زیر، آن‌ها همچنین دارای یک نوع داده هستند که بیشتر جنبه راهنما دارد. دو موردی که چندان بدیهی نیستند عبارتند از: 'fn': مسیر پرونده، و 'dfn': مسیر شاخه.

خطوط بخش‌ها امکان بازتعریف یک پارامتر را برای یک زیرشاخه فراهم می‌کنند. برخی از پارامترهای مورد استفاده برای نمایه‌سازی، به صورت سلسله‌مراتبی از جزئی‌ترین به کلی‌ترین بررسی می‌شوند. همه پارامترها را نمی‌توان به طور معنی‌داری بازتعریف کرد؛ این مورد برای هر پارامتر در بخش بعدی مشخص شده است.

نویسه مدک (~) در نام پرونده‌ها به نام شاخه خانگی کاربر گسترش می‌یابد.

برخی مقادیر 'string' از نوع فهرست هستند که صرفاً در توضیحاتشان به آن اشاره شده است. در این حالت از فاصله برای جداسازی استفاده می‌شود و مواردی که شامل فاصله هستند می‌توانند با گیومه دوگانه نقل‌قول شوند.

فهرست جداشده با فاصله از پرونده‌ها یا شاخه‌ها برای نمایه‌سازی بازگشتی. می‌توانید از پیوندهای نمادین (symbolic links) در فهرست استفاده کنید؛ آن‌ها بدون توجه به مقدار متغیر followLinks دنبال خواهند شد. مقدار پیش‌فرض ~ است: نمایه‌سازی بازگشتی شاخه خانگی کاربر.
فهرست جداشده با فاصله از پرونده‌ها یا شاخه‌ها برای پایش به‌روزرسانی‌ها. هنگام اجرای نمایه‌ساز بلادرنگ (real-time)، این گزینه امکان پایش تنها بخشی از کل محدوده نمایه‌شده را فراهم می‌کند. عناصر باید در ساختار درختی تعریف‌شده توسط اعضای 'topdirs' قرار داشته باشند.
نام‌های پرونده و شاخه که باید نادیده گرفته شوند. فهرستی جداشده با فاصله از الگوهای نویسه عام ساده (الگوهای ساده، نه مسیرها؛ نباید حاوی نویسه '/' باشند) که در برابر نام‌های پرونده و شاخه بررسی می‌شوند.

برای مقدار اولیه به پیکربندی پیش‌فرض نگاهی بیندازید؛ ممکن است برخی مدخل‌ها مناسب شرایط شما نباشند. ساده‌ترین روش مشاهده آن از طریق برگه "local parameters" در پنجره پیکربندی نمایه واسط گرافیکی (GUI) است.

فهرست موجود در پیکربندی پیش‌فرض، شاخه‌های پنهان (نام‌هایی که با نقطه شروع می‌شوند) را مستثنی نمی‌کند، به این معنی که ممکن است مواردی را که نمی‌خواهید نمایه‌سازی کند. از سوی دیگر، کلاینت‌های ایمیل مانند Thunderbird معمولاً پیام‌ها را در شاخه‌های پنهان ذخیره می‌کنند و شما احتمالاً می‌خواهید این‌ها نمایه شوند. یک راه حل ممکن این است که ".*" را در "skippedNames" قرار دهید و مواردی مانند "~/.thunderbird" و "~/.evolution" را به "topdirs" اضافه کنید.

حتی نام پرونده‌ها نیز برای الگوهای موجود در این فهرست نمایه نمی‌شوند؛ برای رویکردی جایگزین که نام پرونده‌ها را نمایه می‌کند، متغیر "noContentSuffixes" را ببینید. می‌تواند برای هر زیرشاخه‌ای بازتعریف شود.

فهرستی از الگوهای نام برای حذف از فهرست پیش‌فرض skippedNames. امکان تغییر فهرست در پیکربندی محلی بدون کپی کردن کل آن را فراهم می‌کند.
فهرستی از الگوهای نام برای افزودن به فهرست پیش‌فرض skippedNames. امکان تغییر فهرست در پیکربندی محلی بدون کپی کردن کل آن را فراهم می‌کند.
الگوهای پالایه نام پرونده‌های عادی. این متغیر معمولاً خالی است. در صورت تنظیم، فقط نام پرونده‌هایی که در skippedNames نیستند و با یکی از الگوها مطابقت دارند برای نمایه‌سازی در نظر گرفته می‌شوند. قابل بازتعریف برای هر زیرشاخه. روی شاخه‌ها اعمال نمی‌شود.
فهرستی از پسوندهای پایانی نام (که لزوماً با نقطه جدا نشده‌اند) که برای آن‌ها فقط نام‌ها نمایه می‌شوند ("Ignored endings" در ترجیحات واسط گرافیکی). فقط نام‌ها نمایه خواهند شد. این متغیر مکمل فهرست منسوخ‌شده recoll_noindex در پرونده mimemap است که در انتشار‌های آینده حذف خواهد شد (انتقال از mimemap به recoll.conf امکان ویرایش فهرست از طریق واسط گرافیکی را فراهم می‌کند). این متغیر با skippedNames تفاوت دارد زیرا فقط مطابقت با پایان نام است (نه الگوهای نویسه عام) و خود نام پرونده به طور معمول نمایه می‌شود. این مورد برای زیرشاخه‌ها قابل بازتعریف است.
فهرستی از پسوندهای پایانی نام برای حذف از فهرست پیش‌فرض noContentSuffixes.
فهرستی از پسوندهای پایانی نام برای افزودن به فهرست پیش‌فرض noContentSuffixes.
مسیرهای مطلقی که نباید وارد آن‌ها شد. فهرستی جداشده با فاصله از عبارات نویسه عام برای مسیرهای مطلق سیستم‌فایل (برای پرونده‌ها یا شاخه‌ها). این متغیر باید در بالاترین سطح پرونده پیکربندی تعریف شود، نه در یک بخش فرعی.

هر مقداری در فهرست باید از نظر متنی با مقادیر موجود در topdirs همخوانی داشته باشد؛ هیچ تلاشی برای حل پیوندهای نمادین انجام نمی‌شود. در عمل، اگر مانند حالت معمول، /home یک پیوند به /usr/home باشد، topdirs پیش‌فرض شما دارای یک ورودی "~" خواهد بود که به "/home/yourlogin" تبدیل می‌شود. در این حالت، هر ورودی skippedPaths باید با "/home/yourlogin" شروع شود و *نه* با "/usr/home/yourlogin".

شاخه‌های نمایه و پیکربندی به صورت خودکار به فهرست اضافه خواهند شد.

عبارات با استفاده از "fnmatch(3)" و با پرچم FNM_PATHNAME که به طور پیش‌فرض تنظیم شده مطابقت داده می‌شوند. این بدان معناست که نویسه‌های "/" باید به طور صریح مطابقت داده شوند. می‌توانید "skippedPathsFnmPathname" را برابر 0 قرار دهید تا استفاده از FNM_PATHNAME غیرفعال شود (به این معنی که "/*/dir3" با "/dir1/dir2/dir3" مطابقت خواهد داشت).

مقدار پیش‌فرض شامل نقاط اتصال متداول برای رسانه‌های جداشدنی است تا به شما یادآوری کند در بیشتر موارد نمایه‌سازی آن‌ها توسط Recoll ایده مناسبی نیست. افزودن صریح "/media/xxx" به متغیر "topdirs" این مورد را بازنویسی می‌کند.

برای نادیده گرفتن استفاده از FNM_PATHNAME در تطبیق مسیرهای رد شده، روی 0 تنظیم کنید.
نام پرونده‌ای که باعث نادیده گرفته شدن شاخه والد آن می‌شود. هر شاخه‌ای که حاوی پرونده‌ای با این نام باشد، به گونه‌ای نادیده گرفته می‌شود که گویی بخشی از فهرست skippedPaths بوده است. مثال: .recoll-noindex
معادل skippedPaths مختص نمایه‌سازی بلادرنگ. این امکان را فراهم می‌کند که بخش‌هایی از درخت در ابتدا نمایه شوند اما پایش نشوند. اگر daemSkippedPaths تنظیم نشود، دیمن از skippedPaths استفاده می‌کند.
دنبال کردن پیوندهای نمادین در هنگام نمایه‌سازی. پیش‌فرض نادیده گرفتن پیوندهای نمادین برای جلوگیری از نمایه‌سازی مکرر پرونده‌های پیوند خورده است. هیچ تلاشی برای جلوگیری از تکرار هنگام فعال بودن این گزینه انجام نمی‌شود. این گزینه را می‌توان با استفاده از بخش‌ها به صورت جداگانه برای هر یک از اعضای "topdirs" تنظیم کرد. نمی‌توان آن را در سطحی پایین‌تر از "topdirs" تغییر داد. پیوندها در خود فهرست "topdirs" همیشه دنبال می‌شوند.
فهرست محدودکننده انواع MIME نمایه‌شده. به طور معمول تنظیم نشده است (که در این حالت تمام انواع پشتیبانی‌شده نمایه می‌شوند). در صورت تنظیم، فقط محتوای انواع موجود در فهرست نمایه خواهد شد. در هر صورت اگر indexallfilenames تنظیم شده باشد (پیش‌فرض)، نام‌ها نمایه خواهند شد. نام‌های نوع MIME باید از پرونده mimemap گرفته شوند (مقادیر ممکن است در برخی موارد با خروجی xdg-mime یا file -i متفاوت باشند). برای زیرشاخه‌ها قابل بازتعریف است. نسخه‌های Recoll بعد از 1.43.7 (به استثنای آن) از نویسه‌های عام در مقادیر پشتیبانی می‌کنند.
فهرست انواع MIME مستثنی‌شده. به شما امکان می‌دهد برخی انواع را از نمایه‌سازی خارج کنید. نام‌های نوع MIME باید از پرونده mimemap گرفته شوند (مقادیر ممکن است در برخی موارد با خروجی xdg-mime یا file -i متفاوت باشند). برای زیرشاخه‌ها قابل بازتعریف است. نسخه‌های Recoll بعد از 1.43.7 (به استثنای آن) از نویسه‌های عام در مقادیر پشتیبانی می‌کنند.
انواع MIME که برای آن‌ها هش md5 محاسبه نمی‌کنیم. چکسام‌های md5 فقط برای حذف نتایج تکراری استفاده می‌شوند و محاسبه آن‌ها روی پرونده‌های چندرسانه‌ای یا سایر پرونده‌های حجیم می‌تواند بسیار پرهزینه باشد. این فهرست به شما امکان می‌دهد محاسبه md5 را برای انواع مشخصی خاموش کنید. این پارامتر سراسری است (بدون بازتعریف برای زیرشاخه‌ها). در حال حاضر، فقط روی پردازنده‌های خارجی (exec و execm) اثر دارد. انواع پرونده‌ها را می‌توان با فهرست کردن انواع MIME (مانند audio/mpeg) یا نام پردازنده‌ها (مانند rclaudio.py) تعیین کرد.
محدودیت حجم برای پرونده‌های فشرده‌شده. برای شناسایی باید این پرونده‌ها را در یک شاخه موقت از حالت فشرده خارج کنیم که در برخی موارد می‌تواند اتلاف‌کننده باشد. اتلاف را محدود کنید. مقدار منفی یعنی بدون محدودیت. مقدار 0 منجر به عدم پردازش هرگونه پرونده فشرده می‌شود. پیش‌فرض 100 مگابایت است. این گزینه مربوط به آرشیوهایی مانند پرونده‌های zip یا rar *نیست*، بلکه فقط برای پرونده‌های منفرد مثلاً gzipped است.
محدودیت اندازه برای پرونده‌های متنی. عمدتاً برای رد کردن گزارش‌های (log) بسیار بزرگ است. همچنین برای حداکثر اندازه بدنه پیام‌های ایمیل استفاده می‌شود. پیش‌فرض 20 مگابایت است. برای غیرفعال کردن از مقدار -1 استفاده کنید.
اندازه صفحه برای پرونده‌های متنی. اگر این مورد تنظیم شود، پرونده‌های text/plain به اسنادی با تقریباً این اندازه تقسیم می‌شوند. این کار استفاده از حافظه را در زمان نمایه‌سازی کاهش می‌دهد و به بارگذاری داده‌ها در پنجره پیش‌نمایش در زمان پرس‌وجو کمک می‌کند. به ویژه برای پرونده‌های بسیار بزرگ، مانند لاگ‌های برنامه یا سیستم کاربرد دارد. همچنین textfilemaxmbs و compressedfilemaxkbs را ببینید.
پردازش پرونده‌های ناشناخته text/xxx به صورت text/plain. امکان نمایه‌سازی انواع پرونده‌های متنی را که توسط "file" یا "xdg-mime" به صورت text/whatever شناسایی شده‌اند بدون نیاز به تنظیم صریح در پیکربندی فراهم می‌کند. این مورد برای نمایه‌سازی به خوبی کار می‌کند (اگرچه باعث پردازش پرونده‌های بی‌استفاده زیادی نیز خواهد شد)، اما اسنادی که به این روش نمایه می‌شوند توسط نمایشگر دسکتاپ باز خواهند شد، حتی اگر text/plain ویرایشگر خاص خود را داشته باشد.
نمایه‌سازی نام پرونده‌های پردازش‌نشده. نام پرونده‌هایی را که محتوای آن‌ها را به دلیل نوع MIME مستثنی‌شده یا پشتیبانی‌نشده نمایه نمی‌کنیم، نمایه می‌کند.
تلاش برای حدس نوع MIME از داده‌های سند. این نام تاریخی است و برای سازگاری حفظ شده است؛ نسخه‌های قدیمی در صورت عدم استفاده از پسوند، دستور 'file' یا 'xdg-mime' را برای تعیین نوع MIME اجرا می‌کردند. به طور پیش‌فرض، نسخه‌های فعلی Recoll از libmagic برای این کار استفاده می‌کنند. پارامترهای پیکربندی زمان کامپایل و زمان اجرا همچنان می‌توانند رفتار قدیمی را بازگردانند و libmagic را غیرفعال کرده و از یک دستور استفاده کنند.

روش شناسایی بر اساس داده در برخی موارد می‌تواند دقیق‌تر از روش مبتنی بر پسوند باشد، اما کندتر است و باعث نمایه‌سازی پرونده‌های "متنی" بدون پسوند جعلی زیادی می‌شود. علاوه بر این، تمام قالب‌های مبتنی بر zip (مانند libreoffice) را به عنوان application/zip شناسایی می‌کند که البته نادرست است، بنابراین تنها می‌تواند یک گام ثانویه باشد.

همچنین "systemfilecommand" را ببینید.

استفاده از دستور به جای libmagic. تنها زمانی معنا دارد که libmagic کامپایل شده باشد و usesystemfilecommand تنظیم شده باشد. اجرای دستور را به استفاده از کتابخانه ترجیح می‌دهد.
دستور مورد استفاده برای حدس نوع MIME (اگر برای استفاده از libmagic کامپایل نشده باشد). در حال حاضر پیش‌فرض استفاده از libmagic است. در صورت استفاده، این دستور باید عملکردی مشابه "file --mime-type" داشته باشد. مسیر پرونده به عنوان آخرین پارامتر به خط فرمان اضافه خواهد شد. دستور "xdg-mime" بهتر از دستور سنتی "file" کار می‌کند و اکنون پیش‌فرض پیکربندی‌شده است (با یک جایگزین درون‌برنامه‌ای به "file").
تصمیم‌گیری درباره پردازش صف وب. این صف شاخه‌ای است که افزونه‌های مرورگر وب Recoll رونوشت‌هایی از صفحات بازدیدشده را در آن ایجاد می‌کنند.
محدودیت اندازه برای اعضای آرشیو. این مقدار در متغیر محیطی RECOLL_FILTER_MAXMEMBERKB به پردازنده‌های MIME ارسال می‌شود.
تصمیم‌گیری در مورد ذخیره بزرگی و کوچکی حروف و اعراب (diacritics) در نمایه. در صورت ذخیره، جستجوهای حساس به حروف بزرگ و کوچک و اعراب قابل انجام هستند، اما نمایه بزرگ‌تر خواهد شد و ممکن است رفتارهای عجیب حاشیه‌ای رخ دهد. پیش‌فرض یک نمایه بدون تمایز (stripped) است. هنگام استفاده از چندین نمایه برای یک جستجو، این پارامتر باید برای همه یکسان تعریف شود. تغییر این مقدار مستلزم بازنشانی نمایه است.
تصمیم‌گیری در مورد ذخیره محتوای متنی اسناد در نمایه. ذخیره متن امکان استخراج بخش‌های متنی (snippets) را در زمان پرس‌وجو به جای ساخت آن‌ها از داده‌های موقعیت نمایه فراهم می‌کند.

قالب‌های جدیدتر نمایه Xapian استفاده ما از فهرست موقعیت‌ها را در برخی موارد به شدت کند کرده‌اند. آخرین قالب نمایه Xapian با عملکرد مناسب برای روش قدیمی Chert است که برای نسخه 1.2 پیش‌فرض بوده، در 1.4 هنوز پشتیبانی می‌شود اما پیش‌فرض نیست و در 1.6 حذف خواهد شد.

متن سند ذخیره‌شده از قالب اصلی به متن ساده UTF-8 تبدیل می‌شود، اما حروف بزرگ، اعراب یا علائم نگارشی از آن حذف نمی‌شوند. ذخیره آن معمولاً اندازه نمایه را بین ۱۰ تا ۲۰ درصد افزایش می‌دهد، اما امکان تولید قطعه‌متن‌های زیباتر را نیز فراهم می‌کند، بنابراین اگر فضای کافی دارید، حتی اگر برای کارایی شدیداً لازم نباشد ارزش فعال‌سازی دارد.

این متغیر فقط هنگام ایجاد یک نمایه تأثیر دارد، به این معنی که شاخه xapiandb نباید از قبل وجود داشته باشد. تأثیر دقیق آن به نسخه Xapian بستگی دارد.

برای Xapian 1.4، اگر متغیر روی 0 تنظیم می‌شد، از قالب Chert استفاده می‌کردیم و متن را ذخیره نمی‌کردیم. اگر متغیر 1 بود، Glass استفاده می‌شد و متن ذخیره می‌شد. ما دیگر این کار را انجام نمی‌دهیم: ذخیره متن ثابت شده که گزینه بسیار بهتری است و حذف این حالت کد را ساده‌تر می‌کند.

بنابراین در حال حاضر، قالب نمایه برای یک نمایه جدید همیشه پیش‌فرض است، اما متغیر همچنان کنترل می‌کند که آیا متن ذخیره شود یا خیر، و همچنین روش تولید چکیده را تعیین می‌کند. با Xapian 1.4 و بالاتر، و در صورت تنظیم متغیر روی 0، تولید چکیده ممکن است بسیار کند باشد، اما اگر اصلاً از تولید چکیده استفاده نمی‌کنید، با استفاده از تنظیم مناسب در واسط گرافیکی و/یا اجتناب از API پایتون یا گزینه‌های recollq که آن را فعال می‌کنند، این تنظیم همچنان برای صرفه‌جویی در فضا مفید است.

تصمیم‌گیری درباره تولید اصطلاحات (terms) برای اعداد. به عنوان مثال اگر nonumbers تنظیم شود، "123"، "1.5e6"، و 192.168.1.4 نمایه نخواهند شد (اما "value123" همچنان نمایه می‌شود). اعداد اغلب برای جستجو جالب هستند و این گزینه احتمالاً نباید تنظیم شود مگر در شرایط خاص، مانند اسناد علمی با مقادیر عظیمی از اعداد، که تنظیم nonumbers اندازه نمایه را کاهش می‌دهد. این مورد فقط می‌تواند برای کل نمایه تنظیم شود، نه برای یک زیرشاخه.
عدم ذخیره موقعیت اصطلاحات. موقعیت اصطلاحات امکان جستجوی عبارات و مجاورت را فراهم می‌کند، اما نمایه را بسیار بزرگ‌تر می‌کند. در برخی شرایط خاص، ممکن است بخواهید از آن‌ها صرف‌نظر کنید.
تعیین می‌کند که آیا وقتی ورودی "co-worker" است، "coworker" نیز نمایه شود یا خیر. این قابلیت در نسخه 1.22 جدید است و به طور پیش‌فرض روشن است. خاموش کردن این متغیر رفتار قبلی را بازیابی می‌کند.
رشته‌ای از نویسه‌های نشانه‌گذاری UTF-8 برای نمایه‌سازی به عنوان کلمات. اصطلاحات حاصل سپس قابل جستجو خواهند بود و برای مثال، با تنظیم پارامتر روی "%€" (بدون گیومه‌ها)، می‌توانید به طور جداگانه برای "100%" یا "100€" جستجو کنید. توجه داشته باشید که "100%" یا "100 %" به یک شکل نمایه می‌شوند، زیرا نویسه‌ها خود جداکننده کلمه هستند.
پردازش بک‌اسلش به عنوان یک حرف عادی. این ممکن است برای افرادی که می‌خواهند دستورهای TeX را همان‌گونه که هستند نمایه کنند مفید باشد اما کاربرد عمومی چندانی ندارد.
پردازش خط زیر (underscore) به عنوان حرف عادی. این در موارد بسیار زیادی کاربرد دارد به طوری که جای شگفتی است چرا پیش‌فرض نیست.
حداکثر طول اصطلاح بر حسب نویسه‌های یونیکد. کلمات طولانی‌تر از این مقدار نادیده گرفته می‌شوند. مقدار پیش‌فرض 40 است و قبلاً در کد به طور ثابت نوشته شده بود، اما اکنون قابل تنظیم است. در صورت تغییر مقدار ممکن است نیاز به بازنشانی نمایه داشته باشید.
حداکثر اندازه باینری یک رکورد داده سند Xapian. رکورد داده شامل فیلدهای متاداده "ذخیره‌شده" سند است. اندازه بسیار بزرگ معمولاً نشان‌دهنده خطای تجزیه سند است. Xapian یک محدودیت سخت حدوداً 100 مگابایتی برای این موضوع دارد.
حداکثر اندازه باینری متن ذخیره‌شده یک سند. Xapian یک محدودیت سخت حدود 100 مگابایت برای مقدار فشرده‌شده دارد، اما محدودیت ما قبل از فشرده‌سازی است، بنابراین ممکن است مقداری انعطاف وجود داشته باشد.
تصمیم‌گیری درباره خاموش کردن تفکیک حروف/کلمات ویژه آسیای شرقی (چینی، کره‌ای، ژاپنی - CJK). اگر هیچ سند CJK ندارید، این گزینه مقدار کمی از مصرف CPU را کاهش می‌دهد. اگر پایگاه اسناد شما شامل چنین متونی است اما علاقه‌ای به جستجوی آن ندارید، تنظیم nocjk می‌تواند صرفه‌جویی قابل توجهی در زمان و فضا داشته باشد.
به شما امکان می‌دهد اندازه n-gramهای استفاده‌شده برای نمایه‌سازی متون CJK را تنظیم کنید. مقدار پیش‌فرض 2 احتمالاً در بیشتر موارد مناسب است. مقدار 3 دقت و کارایی بیشتری روی کلمات طولانی‌تر فراهم می‌کند، اما نمایه تقریباً دو برابر بزرگ‌تر خواهد شد.
نشانه‌گذار خارجی برای هانگول کره‌ای. این امکان را فراهم می‌کند که از یک پردازنده ویژه زبان برای استخراج اصطلاحات از متن کره‌ای استفاده شود، به جای تولیدکننده عمومی اصطلاح n-gram. برای دستورالعمل‌ها به https://www.recoll.org/pages/recoll-korean.html مراجعه کنید.
نشانه‌گذار خارجی برای چینی. این امکان را فراهم می‌کند که از نشانه‌گذار Jieba ویژه زبان برای استخراج اصطلاحات معنی‌دار از متن چینی استفاده شود، به جای تولیدکننده عمومی اصطلاح n-gram. برای دستورالعمل‌ها به https://www.recoll.org/pages/recoll-chinese.html مراجعه کنید.
زبان‌هایی که باید برای آن‌ها داده‌های ریشه‌یابی (stemming) ایجاد شود. نام ریشه‌یاب‌ها را می‌توان با اجرای "recollindex -l" پیدا کرد، یا می‌توان آن را از فهرستی در واسط گرافیکی تنظیم کرد. مقادیر، نام کامل زبان‌ها هستند، مانند english، french...
مجموعه نویسه (کدگذاری) پیش‌فرض. برای پرونده‌هایی استفاده می‌شود که حاوی تعریف مجموعه نویسه نیستند (مانند text/plain). مقادیر یافت‌شده درون پرونده‌ها، مانند برچسب "charset" در اسناد HTML، آن را بازنویسی می‌کنند. اگر تنظیم نشود، مجموعه نویسه پیش‌فرض همان است که توسط محیط NLS مشخص شده است ($LC_ALL, $LC_CTYPE, $LANG)، یا در نهایت iso-8859-1 (در واقع cp-1252). اگر به دلایلی یک پیش‌فرض کلی می‌خواهید که با LANG شما مطابقت ندارد و 8859-1 نیست، از این متغیر استفاده کنید. این مقدار برای هر زیرشاخه‌ای قابل بازتعریف است.
فهرستی از نویسه‌ها با کدگذاری UTF-8 که هنگام تبدیل متن به حروف کوچک بدون اعراب باید به طور ویژه مدیریت شوند. به عنوان مثال، در سوئدی، حرف a با دونقطه جزو الفبای کامل است و نباید به a تبدیل شود. هر عنصر در فهرست جداشده با فاصله، نویسه خاص را به عنوان اولین عنصر و معادل آن را به عنوان عنصر دوم دارد. مدیریت هر دو نسخه کوچک و بزرگ یک نویسه باید مشخص شود، زیرا قرار گرفتن در فهرست، هم پردازش استاندارد اعراب و هم حروف بزرگ/کوچک را غیرفعال می‌کند. مقدار سراسری است و هم بر نمایه‌سازی و هم بر پرس‌وجو تأثیر می‌گذارد. ما همچنین چند نویسه گیج‌کننده یونیکد (نقل‌قول‌ها، خط فاصله) را به معادل ASCII آن‌ها تبدیل می‌کنیم تا از شکست‌های "نامرئی" در جستجو جلوگیری شود.

مثال‌ها: Swedish: unac_except_trans = ää Ää öö Öö üü Üü ßss œoe Œoe æae Æae ffff fifi flfl åå Åå ’' ❜' ʼ' ‐- - German: unac_except_trans = ää Ää öö Öö üü Üü ßss œoe Œoe æae Æae ffff fifi flfl ’' ❜' ʼ' ‐- - French: you probably want to decompose oe and ae and nobody would type a German ß unac_except_trans = ßss œoe Œoe æae Æae ffff fifi flfl ’' ❜' ʼ' ‐- - پیش‌فرض برای همه تا زمانی که کسی اعتراض کند به شرح زیر است. این تجزیه‌ها توسط unac انجام نمی‌شوند، اما بعید است کسی فرم‌های ترکیبی را در جستجو تایپ کند. unac_except_trans = ßss œoe Œoe æae Æae ffff fifi flfl ’' ❜' ʼ' ‐-

مجموعه نویسه پیش‌فرض را برای پیام‌های ایمیلی که مجموعه‌ای تعیین نکرده‌اند بازنویسی می‌کند. این عمدتاً برای خروجی‌های readpst (libpst) مفید است که utf-8 هستند اما آن را اعلام نمی‌کنند.
تنظیم فیلدها روی همه پرونده‌ها (معمولاً در یک بخش خاص از سیستم‌فایل). نحو به صورت معمول است: name = value ; attr1 = val1 ; [...] مقدار خالی است بنابراین به یک نقطه-ویرگول ابتدایی نیاز دارد. این برای مثال برای تنظیم فیلد rclaptg جهت انتخاب برنامه درون mimeview مفید است.
استفاده از mtime به جای ctime برای آزمایش این‌که آیا پرونده تغییر کرده است یا خیر. زمان علاوه بر اندازه که همیشه استفاده می‌شود، به کار می‌رود. تنظیم این گزینه می‌تواند نمایه‌سازی مجدد را در سیستم‌هایی که ویژگی‌های توسعه‌یافته (توسط برخی برنامه‌های دیگر) استفاده می‌شوند اما نمایه نمی‌شوند کاهش دهد، زیرا تغییر ویژگی‌های توسعه‌یافته فقط بر ctime تأثیر می‌گذارد. نکات: - این ممکن است از تشخیص تغییر در برخی موارد حاشیه‌ای تغییر نام پرونده جلوگیری کند (هدف باید اندازه و mtime یکسانی داشته باشد). - در این حالت احتمالاً باید noxattrfields را نیز روی 1 تنظیم کنید، مگر اینکه همچنان ترجیح دهید نمایه‌سازی xattr را انجام دهید، مثلاً اگر الگوی به‌روزرسانی پرونده محلی آن را ارزشمند کند (چرا که به طور کلی، این خطر وجود دارد که به‌روزرسانی‌های صرفِ ویژگی‌های توسعه‌یافته بدون تغییر پرونده شناسایی نشوند). پس از تغییر این گزینه، نمایه را کاملاً بازنشانی کنید.
غیرفعال کردن تبدیل ویژگی‌های توسعه‌یافته (extended attributes) به فیلدهای متاداده. در صورت تنظیم testmodifusemtime احتمالاً این گزینه نیز باید تنظیم شود.
تعریف دستورها برای جمع‌آوری متاداده‌های خارجی، مانند برچسب‌های tmsu. می‌تواند چندین ورودی وجود داشته باشد که با نقطه-ویرگول جدا شده‌اند، هر کدام مشخص می‌کنند داده‌ها وارد کدام نام فیلد می‌شوند و چه دستوری استفاده شود. نقطه-ویرگول ابتدایی را فراموش نکنید. تمام نام‌های فیلدها باید متفاوت باشند. در صورت لزوم می‌توانید از نام‌های مستعار در پرونده "field" استفاده کنید. به عنوان یک ترفند نه‌چندان تمیز که به خاطر راحتی پذیرفته شده است، هر نام فیلدی که با "rclmulti" شروع شود به عنوان نشانه‌ای در نظر گرفته می‌شود که دستور مقادیر چندین فیلد را درون یک متن ساختاریافته مانند پرونده پیکربندی recoll (خطوط "fieldname = fieldvalue") برمی‌گرداند. نام rclmultixx نادیده گرفته می‌شود و نام‌ها و مقادیر فیلدها از داده‌ها استخراج می‌شوند. مثال: metadatacmds = ; tags = tmsu tags %f; rclmulti1 = cmdOutputsConf %f
شاخه بالایی برای داده‌های Recoll. شاخه‌های داده Recoll معمولاً نسبت به شاخه پیکربندی قرار دارند (مانند ~/.recoll/xapiandb، ~/.recoll/mboxcache). اگر "cachedir" تنظیم شود، شاخه‌ها در زیر مقدار مشخص‌شده ذخیره می‌شوند (مثلاً اگر cachedir برابر ~/.cache/recoll باشد، dbdir پیش‌فرض ~/.cache/recoll/xapiandb خواهد بود). این گزینه بر dbdir، webcachedir، mboxcachedir، aspellDicDir تأثیر می‌گذارد، که البته هنوز می‌توان آن‌ها را جداگانه برای بازنویسی cachedir مشخص کرد. توجه داشته باشید که اگر چندین پیکربندی دارید، هر کدام باید cachedir متفاوتی داشته باشند؛ هیچ محاسبه خودکاری برای یک مسیر فرعی در cachedir وجود ندارد.
حداکثر اشغال سیستم‌فایل که فراتر از آن نمایه‌سازی را متوقف می‌کنیم. مقدار یک درصد است که مطابق با ستون "Capacity" در خروجی دستور df است. مقدار پیش‌فرض 0 است، به معنی عدم بررسی. این پارامتر فقط زمانی که نمایه‌ساز شروع به کار می‌کند بررسی می‌شود و رفتار یک فرایند در حال اجرا را تغییر نخواهد داد.
محل شاخه پایگاه‌داده Xapian. این شاخه در اولین نمایه‌سازی ایجاد خواهد شد. اگر مقدار یک مسیر مطلق نباشد، در صورت تنظیم، نسبت به cachedir و در غیر این صورت نسبت به شاخه پیکربندی (آرگومان -c یا $RECOLL_CONFDIR) تفسیر می‌شود. اگر چیزی مشخص نشود، پیش‌فرض ~/.recoll/xapiandb/ است.
نام پرونده موقتی که فرایند نمایه‌ساز وضعیت خود را در آن به‌روزرسانی می‌کند. پیش‌فرض: idxstatus.txt درون شاخه پیکربندی.
محل شاخه برای ذخیره پرونده‌های حافظه موقت آفست‌های پیام mbox. این مقدار در صورت تنظیم، معمولاً "mboxcache" در زیر cachedir است یا در غیر این صورت در زیر شاخه پیکربندی قرار دارد، اما اشتراک‌گذاری یک شاخه بین پیکربندی‌های مختلف ممکن است مفید باشد.
حداقل اندازه پرونده mbox که فراتر از آن آفست‌ها را کش می‌کنیم. ذخیره آفست‌ها برای پرونده‌های کوچک واقعاً منطقی نیست. پیش‌فرض 5 مگابایت است.
حداکثر اندازه پیام عضو mbox به مگابایت. اندازه‌ای که فراتر از آن فرض می‌کنیم قالب mbox خراب است یا اشتباه تفسیر شده است، که در این نقطه پردازش پرونده متوقف می‌شود.
شاخه‌ای که صفحات وب بایگانی‌شده را پس از پردازش در آن ذخیره می‌کنیم. این فقط توسط کد نمایه‌سازی تاریخچه وب استفاده می‌شود. توجه داشته باشید که این متفاوت از webdownloadsdir است که به نمایه‌ساز می‌گوید صفحات وب قبل از نمایه شدن و ذخیره در webcachedir، توسط مرورگر در کجا ذخیره شده‌اند. پیش‌فرض: cachedir/webcache در صورت تنظیم cachedir، در غیر این صورت $RECOLL_CONFDIR/webcache
حداکثر اندازه بایگانی وب به مگابایت. این فقط توسط کد نمایه‌سازی تاریخچه وب استفاده می‌شود. پیش‌فرض: 40 مگابایت. کاهش اندازه باعث کوتاه شدن فیزیکی پرونده نخواهد شد.
مسیر به صف نمایه‌سازی وب. قبلاً در افزونه قدیمی به صورت ثابت به عنوان ~/.recollweb/ToIndex تنظیم شده بود بنابراین نیازی به تغییر یا امکان تغییر آن وجود نداشت، اما افزونه WebExtensions اکنون پرونده‌ها را در شاخه Downloads کاربر بارگیری می‌کند و یک اسکریپت آن‌ها را به webqueuedir منتقل می‌کند. اسکریپت این مقدار را از پیکربندی می‌خواند بنابراین تغییر آن امکان‌پذیر شده است.
مسیر به شاخه بارگیری افزونه مرورگر. این به نمایه‌ساز می‌گوید افزونه مرورگر وب داده‌های صفحه وب را در کجا ذخیره می‌کند. سپس داده‌ها توسط یک اسکریپت به webqueuedir منتقل می‌شوند، پردازش می‌شوند و در نهایت برای پیش‌نمایش‌های بعدی در webcachedir ذخیره می‌شوند.
بازه زمانی بازیافت صفحه. به طور پیش‌فرض، فقط یک نسخه از یک URL در حافظه موقت نگهداری می‌شود. این را می‌توان با تنظیم این متغیر روی مقداری که تناوب نگهداری چندین نسخه را تعیین می‌کند ("day" ،"week" ،"month" ،"year") تغییر داد. توجه داشته باشید که افزایش بازه زمانی، ورودی‌های موجود را پاک نخواهد کرد.
محل ذخیره واژه‌نامه Aspell. واژه‌نامه aspell (با نام aspdict.(lang).rws) به طور معمول در شاخه تعیین‌شده توسط cachedir در صورت تنظیم، یا در زیر شاخه پیکربندی ذخیره می‌شود.
محل شاخه پردازنده‌های ورودی اجرایی. اگر RECOLL_FILTERSDIR در محیط تنظیم شده باشد، از آن استفاده می‌کنیم. پیش‌فرض $prefix/share/recoll/filters است. برای زیرشاخه‌ها قابل بازتعریف است.
محل شاخه آیکون‌ها. تنها دلیل تغییر این مورد این است که بخواهید آیکون‌های نمایش‌داده‌شده در فهرست نتایج را تغییر دهید. پیش‌فرض $prefix/share/recoll/images است.
آستانه (بر حسب مگابایت داده‌های جدید) برای تخلیه (flush) نمایه از حافظه به دیسک. تنظیم این گزینه امکان کنترل مصرف حافظه توسط فرایند نمایه‌ساز را فراهم می‌کند. مقدار 0 به معنای عدم تخلیه صریح است که اجازه می‌دهد Xapian کار خود را انجام دهد، یعنی تخلیه در ازای هر $XAPIAN_FLUSH_THRESHOLD سند ایجاد، اصلاح یا حذف‌شده: از آنجا که مصرف حافظه به میانگین اندازه اسناد بستگی دارد و نه فقط تعداد آن‌ها، رویکرد Xapian چندان مفید نیست و باید اجازه دهید Recoll تخلیه‌ها را مدیریت کند؛ هرچند مقدار کامپایل‌شده برنامه 0 است. مقدار پیش‌فرض پیکربندی‌شده (از این پرونده) اکنون 100 مگابایت است و در بسیاری از موارد مناسب خواهد بود. می‌توانید آن را تا 10 کاهش دهید تا در مصرف حافظه صرفه‌جویی شود، اما اگر به دنبال حداکثر سرعت هستید، ممکن است بخواهید مقادیر بین 20 تا 300 را آزمایش کنید. طبق تجربه، مقادیر بالاتر از این معمولاً نتیجه معکوس دارند.
لینوکس: حداکثر زمان اجرای پالایه خارجی بر حسب ثانیه. پیش‌فرض 1200 (20 دقیقه). برای عدم محدودیت روی 0 تنظیم کنید. این عمدتاً برای جلوگیری از حلقه‌های بی‌نهایت در پرونده‌های پست‌اسکریپت (loop.ps) است.
لینوکس: حداکثر فضای حافظه مجازی برای فرایندهای پالایه (setrlimit(RLIMIT_AS))، بر حسب مگابایت. توجه داشته باشید که این شامل کتابخانه‌های نگاشت‌شده نیز می‌شود (هیچ روش مطمئنی در لینوکس برای محدود کردن فقط فضای داده وجود ندارد)، بنابراین باید در اینجا کمی دست‌ودلباز باشیم. هر مقداری بیش از 2000 در ماشین‌های 32 بیتی نادیده گرفته می‌شود. مقدار پیش‌فرض بالا به دلیل پردازنده‌های مبتنی بر جاوا (pdftk) لازم است که به حافظه مجازی زیادی نیاز دارند، به ویژه pdftk هنگام اجرا از پایتون rclpdf.py. اگر به جاوا نیازی ندارید می‌توانید از مقدار بسیار کمتری استفاده کنید.
لینوکس: مقدار تنظیم امتیاز قاتل کمبود حافظه (OOM killer) برای فرایند نمایه‌ساز. choom(1) را ببینید. هنگام راه‌اندازی نمایه‌ساز، این مقدار به عنوان پارامتر adjust به دستور choom با فرایند نمایه‌ساز به عنوان هدف ارسال می‌شود.
عمق صف وظایف برای هر مرحله و کنترل پیکربندی ریسه‌بندی (threading). سه صف داخلی در مراحل خط لوله نمایه‌سازی وجود دارد (استخراج داده‌های پرونده، تولید اصطلاحات، به‌روزرسانی نمایه). این پارامتر عمق صف‌ها را برای هر مرحله مشخص می‌کند (سه مقدار صحیح). در عمل، نشان داده نشده است که صف‌های عمیق باعث افزایش عملکرد شوند. مقدار اول همچنین برای کنترل پیکربندی خودکار ریسه‌ها یا غیرفعال کردن چندریسه‌ای استفاده می‌شود. اگر عمق صف اول روی 0 تنظیم شود، Recoll عمق صف‌ها و تعداد ریسه‌ها را بر اساس تعداد پردازنده‌های شناسایی‌شده تنظیم می‌کند. مقادیر انتخابی به این شرح است (عمق، تعداد ریسه): 1 پردازنده -> بدون ریسه‌بندی. کمتر از 4 پردازنده: (2, 2) (2, 2) (2, 1). کمتر از 6 پردازنده: (2, 4)، (2, 2)، (2, 1). در غیر این صورت: (2, 5)، (2, 3)، (2, 1). اگر عمق صف اول روی -1 تنظیم شود، چندریسه‌ای به طور کامل غیرفعال خواهد شد. مقادیر دوم و سوم در هر دو حالت نادیده گرفته می‌شوند.
تعداد ریسه‌های استفاده‌شده برای هر مرحله نمایه‌سازی. اگر اولین ورودی در thrQSizes برابر 0 یا -1 نباشد، این سه مقدار تعداد ریسه‌های استفاده‌شده برای هر مرحله (استخراج داده‌های پرونده، تولید اصطلاحات، به‌روزرسانی نمایه) را تعریف می‌کنند. استفاده از مقداری غیر از 1 برای مرحله آخر منطقی نیست زیرا به‌روزرسانی نمایه Xapian لزوماً تک‌ریسه‌ای است (و توسط یک mutex محافظت می‌شود).
تعداد نمایه‌های موقت مورد استفاده در طول نمایه‌سازی افزایشی یا کامل. اگر روی صفر تنظیم نشود، مشخص می‌کند در طول نمایه‌سازی از چند نمایه موقت استفاده می‌کنیم. این نمایه‌های موقت در پایان عملیات در نمایه اصلی ادغام می‌شوند. استفاده از چندین نمایه و ادغام نهایی می‌تواند عملکرد نمایه‌سازی را هنگامی که به‌روزرسانی‌های تک‌ریسه‌ای نمایه Xapian به یک گلوگاه تبدیل می‌شوند، به طور چشمگیری بهبود بخشد. میزان مفید بودن این گزینه به نوع ورودی و پردازنده بستگی دارد. برای جزئیات بیشتر به راهنما مراجعه کنید.
تعلیق نمایه‌سازی بلادرنگ زمانی که سیستم با باتری کار می‌کند. نمایه‌ساز منتظر اتصال مجدد برق شهری (AC) می‌ماند و هنگام وقوع آن مجدداً اجرا می‌شود.
سطح پرگویی پرونده گزارش (log) از 1 تا 6. مقدار 2 فقط خطاها و هشدارها را چاپ می‌کند. مقدار 3 اطلاعاتی مانند به‌روزرسانی اسناد را چاپ می‌کند، 4 کاملاً پرگو و 6 بسیار پرگو است.
مقصد پرونده گزارش. برای نوشتن در کنسول از "stderr" (پیش‌فرض) استفاده کنید.
آغاز هر خط گزارش با تاریخ و زمان. مانند: 2025-08-21T18:58:24+0200 :3:...
بازنویسی loglevel برای نمایه‌ساز.
بازنویسی logfilename برای نمایه‌ساز.
بازنویسی logthedate برای نمایه‌ساز.
پرونده مقصد برای خروجی خطای استاندارد برنامه‌های کمکی خارجی. خروجی خطای برنامه خارجی به طور پیش‌فرض دست‌نخورده باقی می‌ماند، مثلاً هنگامی که برنامه recoll[index] از خط فرمان اجرا می‌شود به ترمینال می‌رود. برای بی‌صدا کردن کامل خروجی از /dev/null یا پرونده‌ای درون یک شاخه ناموجود استفاده کنید.
بازنویسی loglevel برای نمایه‌ساز بلادرنگ. پیش‌فرض استفاده از مقادیر idx... در صورت تنظیم، و در غیر این صورت مقادیر log... است.
بازنویسی logfilename برای نمایه‌ساز بلادرنگ. پیش‌فرض استفاده از مقادیر idx... در صورت تنظیم، و در غیر این صورت مقادیر log... است.
بازنویسی logthedate برای نمایه‌ساز بلادرنگ.
بازنویسی loglevel برای افزونه پایتون.
بازنویسی logfilename برای افزونه پایتون.
بازنویسی logthedate برای افزونه پایتون.
عدم پاکسازی داده‌ها برای پرونده‌های حذف‌شده یا غیرقابل‌دسترس. این می‌تواند توسط گزینه‌های خط فرمان recollindex بازنویسی شود و ممکن است زمانی مفید باشد که بخش‌هایی از مجموعه اسناد به طور قابل‌پیش‌بینی گاهی غیرقابل‌دسترس هستند، به طوری که فقط پس از اطمینان از وجود همه چیز، پاکسازی را اجرا کنید.
مکان اصلی شاخه پیکربندی. این منحصراً برای مجموعه‌داده‌های قابل‌حمل استفاده می‌شود. قرار دادن شاخه پیکربندی درون درخت شاخه، امکان ترجمه خودکار مسیر در زمان پرس‌وجو را پس از جابجایی مجموعه‌داده (مثلاً به دلیل اتصال در مکانی دیگر) فراهم می‌کند.
مکان فعلی شاخه پیکربندی. مکمل orgidxconfdir برای مجموعه‌داده‌های قابل‌حمل. این باید زمانی استفاده شود که شاخه پیکربندی از مجموعه‌داده به مکان دیگری کپی شده باشد، خواه به این دلیل که مجموعه‌داده فقط‌خواندنی است و یک رونوشت خواندنی/نوشتنی مورد نظر است، یا به دلایل عملکردی. این متغیر مکان جابجا شده اصلی را قبل از کپی ثبت می‌کند تا محاسبات تبدیل مسیر امکان‌پذیر شود. به عنوان مثال اگر مجموعه‌داده‌ای که در ابتدا با عنوان "/home/me/mydata/config" نمایه شده است در "/media/me/mydata" سوار شده باشد، و واسط گرافیکی از یک پیکربندی کپی‌شده اجرا شود، orgidxconfdir برابر با "/home/me/mydata/config" و curidxconfdir (طبق آنچه در پیکربندی کپی‌شده تنظیم شده) برابر با "/media/me/mydata/config" خواهد بود.
شاخه جاری فرایند نمایه‌سازی. پردازنده‌های ورودی گاهی پرونده‌های موقت را در شاخه جاری باقی می‌گذارند، بنابراین منطقی است که recollindex شاخه کاری خود را به یک شاخه موقت تغییر دهد (chdir). اگر مقدار خالی باشد، شاخه جاری تغییر نمی‌کند. اگر مقدار (به صورت لفظی) tmp باشد، از شاخه موقت تعیین‌شده توسط متغیرهای محیطی (RECOLL_TMPDIR در غیر این صورت TMPDIR در غیر این صورت /tmp) استفاده می‌کنیم. اگر مقدار یک مسیر مطلق به یک شاخه باشد، به آنجا می‌رویم.
اسکریپت مورد استفاده برای بررسی تقریبی (اکتشافی) اینکه آیا نیاز به تلاش مجدد برای نمایه‌سازی پرونده‌هایی که قبلاً شکست خورده‌اند وجود دارد یا خیر. اسکریپت پیش‌فرض تاریخ‌های تغییر را در /usr/bin و /usr/local/bin بررسی می‌کند. یک مسیر نسبی ابتدا در شاخه‌های پالایه‌ها و سپس در PATH جستجو می‌شود. برای حالات دیگر از یک مسیر مطلق استفاده کنید.
مکان‌های اضافی برای جستجوی فایل‌های اجرایی کمکی. این مورد به عنوان مثال در ویندوز توسط کد پایتون و در مک توسط recoll.app بسته‌بندی‌شده استفاده می‌شود (زیرا هیچ راه مطمئنی برای دستور دادن به launchd جهت تنظیم PATH وجود نداشت). از ":" به عنوان جداکننده در سیستم‌های مک و مشابه یونیکس استفاده کنید؛ ";" فقط برای ویندوز است.
طول چکیده‌هایی که در حین نمایه‌سازی ذخیره می‌کنیم. Recoll برای هر پرونده نمایه‌شده یک چکیده ذخیره می‌کند. این متن می‌تواند از یک بخش واقعی "abstract" در سند بیاید یا صرفاً ابتدای سند باشد. این متن در نمایه ذخیره می‌شود تا بتوان آن را در فهرست نتایج بدون رمزگشایی پرونده اصلی نمایش داد. پارامتر idxabsmlen اندازه چکیده ذخیره‌شده را مشخص می‌کند. مقدار پیش‌فرض 250 بایت است. واسط جستجو به شما این امکان را می‌دهد که این متن ذخیره‌شده یا یک چکیده ترکیبی ساخته‌شده از استخراج متن اطراف اصطلاحات جستجو را نمایش دهید. اگر همیشه چکیده ترکیبی را ترجیح می‌دهید، می‌توانید این مقدار را کاهش داده و کمی در فضا صرفه‌جویی کنید.
طول برش فیلدهای متاداده ذخیره‌شده. این بر نمایه‌سازی تأثیر نمی‌گذارد (کل فیلد در هر صورت پردازش می‌شود)، بلکه فقط بر مقدار داده‌های ذخیره‌شده در نمایه به منظور نمایش فیلدها در فهرست نتایج یا پیش‌نمایش‌ها اثر دارد. مقدار پیش‌فرض 150 بایت است که اگر فیلدهای سفارشی داشته باشید ممکن است خیلی کم باشد.
طول برش برای تمام متون اسناد. فقط ابتدای اسناد را نمایه می‌کند. این کار توصیه نمی‌شود مگر اینکه مطمئن باشید کلمات کلیدی مهم در بالا قرار دارند و با کمبود شدید فضای دیسک مواجه باشید.
نام پرونده مترادف‌های زمان نمایه‌سازی. این فقط برای ایجاد اصطلاحات منفرد چندکلمه‌ای برای مترادف‌های چندکلمه‌ای استفاده می‌شود تا جستجوهای عبارتی و مجاورتی برای آن‌ها کار کند (مثال: applejack "apple jack"). این ویژگی فقط در صورتی بر پرس‌وجو اثر می‌گذارد که پرونده‌های مترادف زمان پرس‌وجو و زمان نمایه یکسان باشند.
اولویت فرایند "nice" برای فرایندهای نمایه‌سازی. پیش‌فرض: 19 (کمترین). از نسخه 1.26.5 اضافه شد. در نسخه‌های قبلی روی 19 ثابت بود.
غیرفعال کردن استفاده از aspell. تولید واژه‌نامه aspell زمان‌بر است و برخی ترکیب‌های نسخه aspell، زبان و اصطلاحات محلی منجر به کرش کردن aspell می‌شوند، بنابراین گاهی اوقات غیرفعال کردن آن منطقی است.
تعاریف زبان مورد استفاده هنگام ایجاد واژه‌نامه aspell. مقدار باید با مجموعه‌ای از پرونده‌های تعریف زبان aspell مطابقت داشته باشد. می‌توانید "aspell dicts" را تایپ کنید تا فهرستی را مشاهده کنید. در صورت عدم تنظیم، پیش‌فرض استفاده از محیط NLS برای حدس زدن مقدار است. مقادیر، کدهای دورقمی زبان هستند (مانند "en" ،"fr"...).
گزینه و پارامتر اضافی برای دستور ایجاد واژه‌نامه aspell. برخی بسته‌های aspell ممکن است به یک گزینه اضافی نیاز داشته باشند (مثلاً در Debian Jessie: --local-data-dir=/usr/lib/aspell). باگ دبیان شماره 772415 را ببینید.
این گزینه را برای مشاهده خطاهای ایجاد واژه‌نامه aspell تنظیم کنید. همیشه خطاهای زیادی وجود دارد، بنابراین این عمدتاً برای اشکال‌زدایی است.
بازه زمانی به‌روزرسانی پایگاه‌داده کمکی. نمایه‌ساز بلادرنگ پایگاه‌های داده کمکی (stemdb، aspell) را فقط به صورت دوره‌ای به‌روزرسانی می‌کند، زیرا انجام آن برای هر تغییر سند بسیار پرهزینه خواهد بود. دوره پیش‌فرض یک ساعت است.
حداقل بازه زمانی (ثانیه) بین پردازش‌های صف نمایه‌سازی. نمایه‌ساز بلادرنگ هر رویداد را به محض ورود پردازش نمی‌کند، بلکه اجازه می‌دهد صف انباشته شود تا سربار کاهش یابد و چندین رویداد مؤثر بر یک پرونده تجمیع شوند. پیش‌فرض 30 ثانیه.
پارامترهای زمان‌بندی برای نمایه‌سازی بلادرنگ. تعاریف برای پرونده‌هایی که تأخیر بیشتری قبل از مجاز بودن نمایه‌سازی مجدد دریافت می‌کنند. این برای پرونده‌هایی با تغییرات سریع است که باید فقط هر از چند گاهی مجدداً نمایه شوند. فهرستی از جفت‌های wildcardPattern:seconds. الگوها با fnmatch(pattern, path, 0) مطابقت داده می‌شوند. می‌توانید ورودی‌های حاوی فاصله را با گیومه دوگانه نقل‌قول کنید (کل ورودی را نقل‌قول کنید، نه فقط الگو را). پیش‌فرض خالی است. مثال: mondelaypatterns = *.log:20 "*with spaces.*:30"
کلاس ionice برای فرایند نمایه‌سازی. علیرغم نام گمراه‌کننده آن، و در پلتفرم‌هایی که پشتیبانی می‌شود، این گزینه بر تمام فرایندهای نمایه‌سازی تأثیر می‌گذارد و نه فقط فرایندهای بلادرنگ/پایشی. مقدار پیش‌فرض 3 است (استفاده از کمترین اولویت "Idle").
پارامتر سطح کلاس ionice در صورتی که کلاس از آن پشتیبانی کند. پیش‌فرض خالی است، زیرا کلاس پیش‌فرض "Idle" سطحی ندارد.
مسیر به دستور soffice (مثلاً از libreoffice). برای اسناد صفحات اپل (Apple pages) و صفحات گسترده بزرگ openoffice استفاده می‌شود. اگر در مسیر فاصله وجود دارد (مانند C:/Program Files/) *و* می‌خواهید پارامترهایی به دستور پیش‌فرض اضافه کنید (نامعمول)، از گیومه دوگانه استفاده کنید. در صورت عدم تنظیم، recoll سعی می‌کند آن را در PATH پیدا کند.
ذخیره برخی پارامترهای واسط گرافیکی (GUI) به صورت محلی برای نمایه. تنظیمات واسط گرافیکی معمولاً در یک پرونده سراسری ذخیره می‌شوند که برای همه نمایه‌ها معتبر است. تنظیم این پارامتر باعث می‌شود برخی تنظیمات، مانند پیکربندی جدول نتایج، مختص نمایه شوند.
انواع MIME که برای آن‌ها متن ذخیره‌شده را به استخراج مجدد در زمان پرس‌وجو ترجیح می‌دهیم. هنگام واکشی متن سند در زمان پرس‌وجو (مثلاً برای پیش‌نمایش)، پیش‌فرض این است که در صورت در دسترس بودن پرونده، همیشه فرایند عادی استخراج متن اجرا شود. این متغیر فهرستی از الگوهای نویسه عام MIME را تعریف می‌کند که در صورت موجود بودن، صرفاً از متن ذخیره‌شده استفاده خواهیم کرد.
فعال‌سازی خودکار حساسیت به اعراب (فقط برای نمایه خام/غیر stripped). اگر نمایه تفکیک‌زدایی نشده باشد، تصمیم می‌گیرد که آیا در صورتی که اصطلاح جستجو دارای نویسه‌های اعراب‌دار باشد (که در unac_except_trans نیستند)، حساسیت به اعراب به طور خودکار فعال شود یا خیر. در غیر این صورت باید از زبان پرس‌وجو و اصلاح‌کننده "D" برای تعیین حساسیت به اعراب استفاده کنید. پیش‌فرض no است.
فعال‌سازی خودکار حساسیت به بزرگی و کوچکی حروف (فقط برای نمایه خام/غیر stripped). اگر نمایه تفکیک‌زدایی نشده باشد (indexStripChars را ببینید)، تصمیم می‌گیرد که آیا در صورتی که اصطلاح جستجو دارای حروف بزرگ در هر موقعیتی به جز موقعیت اول باشد، حساسیت به بزرگی/کوچکی حروف به طور خودکار فعال شود یا خیر. در غیر این صورت باید از زبان پرس‌وجو و اصلاح‌کننده "C" برای تعیین حساسیت استفاده کنید. پیش‌فرض yes است.
حداکثر تعداد گسترش پرس‌وجو برای یک اصطلاح منفرد (مثلاً هنگام استفاده از نویسه‌های عام). این فقط بر پرس‌وجوها تأثیر می‌گذارد، نه نمایه‌سازی. ما قبلاً این را اصلاً محدود نمی‌کردیم (به جز برای نام پرونده‌ها که محدودیت در 1000 بسیار کم بود)، اما در یک نمایه بزرگ غیرمنطقی است. پیش‌فرض 10000.
حداکثر تعداد بندهایی که به یک پرس‌وجوی منفرد Xapian اضافه می‌کنیم. این فقط بر پرس‌وجوها تأثیر می‌گذارد، نه نمایه‌سازی. در برخی موارد، نتیجه گسترش اصطلاح می‌تواند مضاعف باشد و ما می‌خواهیم از مصرف تمام حافظه جلوگیری کنیم. پیش‌فرض 50000.
حداکثر تعداد موقعیت‌هایی که هنگام پر کردن قطعه‌متن (snippet) برای فهرست نتایج پیمایش می‌کنیم. مقدار پیش‌فرض 1,000,000 ممکن است برای اسناد بسیار بزرگ ناکافی باشد؛ پیامد آن قطعه‌متن‌هایی با کلمات جاافتاده خواهد بود که احتمالاً معنا را تغییر می‌دهند.
دستور مورد استفاده برای تولید بندانگشتی‌ها (thumbnails). در صورت تنظیم، باید مسیری به یک دستور یا اسکریپت به همراه آرگومان‌های ثابت آن باشد. چهار آرگومان قبل از اجرا به آن الحاق می‌شوند: URL سند، نوع MIME، اندازه هدف آیکون (SIZE، مثلاً 128) و مسیر پرونده خروجی (PATH). دستور باید بر اساس این مقادیر یک تصویر بندانگشتی ایجاد کند. به عنوان مثال اگر MIME از نوع ویدیو باشد، یک اسکریپت می‌تواند از دستور زیر استفاده کند: ffmpegthumbnailer -iURL -oPATH -sSIZE.
اعمال پیش‌فرض گسترش ریشه برای اصطلاحات عبارتی. Recoll معمولاً گسترش ریشه را روی اصطلاحات درون جستجوهای عبارتی اعمال نمی‌کند. تنظیم این پارامتر رفتار پیش‌فرض را به گسترش اصطلاحات درون عبارت‌ها تغییر می‌دهد. در صورت تنظیم، می‌توانید از اصلاح‌کننده "l" برای غیرفعال کردن گسترش در یک مورد خاص استفاده کنید.
معکوس نسبت رخداد اصطلاح به کل اصطلاحات پایگاه‌داده که فراتر از آن به دنبال همسایگان املایی برای گسترش خودکار پرس‌وجو می‌گردیم. هنگامی که یک اصطلاح بسیار غیرمعمول است، ممکن است (بسته به انتخاب کاربر) به دنبال تغییرات املایی رایج‌تر بگردیم و احتمالاً آن‌ها را به پرس‌وجو اضافه کنیم.
نسبت بسامد همسایه املایی به بسامد اصطلاح ورودی کاربر که فراتر از آن همسایه را در پرس‌وجو لحاظ می‌کنیم. هنگامی که یک اصطلاح به دلیل نادر بودن برای گسترش املایی انتخاب شد، ما فقط همسایگان املایی را لحاظ می‌کنیم که به این نسبت رایج‌تر باشند.
نمایش نتایج اسناد جاسازی‌شده در dolphin/kio و krunner محیط KDE. اسناد جاسازی‌شده ممکن است نتایج را شلوغ کنند و همیشه از محیط kio یا krunner به راحتی قابل استفاده نیستند. تنظیم این متغیر نتایج را به اسناد مستقل محدود می‌کند.
تلاش برای OCR پرونده‌های PDF بدون محتوای متنی. این مورد می‌تواند در زیرشاخه‌ها تعریف شود. پیش‌فرض خاموش (off) است زیرا OCR بسیار کند است.
اجرای OCR حتی اگر سند PDF دارای محتوای متنی باشد. این می‌تواند در زیرشاخه‌ها تعریف شود. خروجی OCR به متن PDF الحاق خواهد شد.
استخراج رئوس مطالب و نشانک‌ها از اسناد PDF (به pdftohtml نیاز دارد). این به طور پیش‌فرض فعال نیست زیرا به ندرت مورد نیاز است و دستور اضافی کمی زمان می‌برد.
فعال کردن استخراج پیوست‌های PDF با اجرای pdfdetach (در صورت موجود بودن). قبلاً به طور پیش‌فرض غیرفعال بود زیرا از pdftk استفاده می‌کرد. ما اکنون از pdfdetach استفاده می‌کنیم که بخشی از poppler-utils بوده و سریع است.
استخراج متن از برچسب‌های متاداده XMP انتخاب‌شده. این فهرستی جداشده با فاصله از نام‌های واجد شرایط برچسب‌های XMP است. هر عنصر همچنین می‌تواند شامل یک ترجمه به نام فیلد Recoll باشد که با نویسه "|" جدا می‌شود. در صورت عدم وجود عنصر دوم، از نام برچسب به عنوان نام فیلد Recoll استفاده می‌شود. همچنین برای هدایت پردازش داده‌های استخراج‌شده، باید مشخصاتی را به پرونده "fields" اضافه کنید.
تعریف نام اسکریپت ویرایش فیلد XMP. این نام اسکریپتی را مشخص می‌کند که برای ویرایش مقادیر فیلد XMP بارگذاری می‌شود. اسکریپت باید یک کلاس "MetaFixer" با یک متد ()metafix تعریف کند که با نام برچسب واجد شرایط و مقدار هر فیلد انتخاب‌شده، جهت ویرایش یا پاک کردن فراخوانی می‌شود. برای هر سند یک نمونه جدید ایجاد می‌شود تا شیء بتواند وضعیت را برای مواردی مانند حذف مقادیر تکراری حفظ کند.
استفاده از skippedNames در داخل آرشیوهای Zip. مستقیماً توسط پردازنده rclzip.py واکشی می‌شود. الگوهای تعریف‌شده توسط skippedNames را در داخل آرشیوهای Zip نادیده می‌گیرد. برای زیرشاخه‌ها قابل بازتعریف است. نشانی https://www.recoll.org/faqsandhowtos/FilteringOutZipArchiveMembers.html را ببینید.
فهرست جداشده با فاصله از عبارات نویسه عام برای نام‌هایی که باید در داخل آرشیوهای zip نادیده گرفته شوند. این مستقیماً توسط پردازنده zip استفاده می‌شود. اگر zipUseSkippedNames تنظیم نشده باشد، zipSkippedNames الگوهایی را که باید در داخل آرشیوها نادیده گرفته شوند مشخص می‌کند. اگر zipUseSkippedNames تنظیم شده باشد، دو فهرست ادغام شده و استفاده می‌شوند. برای زیرشاخه‌ها قابل بازتعریف است. نشانی https://www.recoll.org/faqsandhowtos/FilteringOutZipArchiveMembers.html را ببینید.
کدگذاری مسیر پرونده. به پایتون 3.11+ نیاز دارد. برای استفاده از chardet روی "detect" تنظیم کنید. این برای پرونده‌های غیر استاندارد zip که متاداده آن‌ها نه UTF-8 (مشخص‌شده توسط یک پرچم پرونده) و نه CP437 (پیش‌فرض) است، مفید است. این پارامتر را می‌توان برای زیرشاخه‌های خاص تنظیم کرد. اگر مقدار روی "detect" تنظیم شده باشد، باید بسته پایتون 3 "chardet" را نصب کنید.
نمایه‌سازی بخش‌های سطح 1 org-mode به عنوان زیرسندهای جداگانه. این پیش‌فرض است. در صورت تنظیم روی false، پرونده‌های org-mode به صورت متن ساده نمایه می‌شوند.
فعال‌سازی ویژگی‌های خاص قالب mbox برای thunderbird/mozilla-seamonkey. این را برای شاخه‌ای (شاخه‌هایی) که پرونده‌های mbox ایمیل در آن ذخیره می‌شوند تنظیم کنید.
دستور به پردازنده تصویر غیرپیش‌فرض پایتون برای اجرای OCR. برای OCR پرونده‌های PDF به بخش PDF مراجعه کنید. OCR تصویر همچنین به تغییرات mimeconf نیاز دارد. به دفترچه راهنما مراجعه کنید. imgocr می‌تواند برای زیرشاخه‌ها تعریف شود.
ماژول‌های OCR برای آزمایش. اسکریپت ارشد OCR سعی می‌کند ماژول‌های مربوطه را به ترتیب بارگذاری کند و از اولین ماژولی استفاده کند که گزارش می‌دهد قادر به انجام OCR روی پرونده ورودی است. ماژول‌های tesseract (tesseract) و ABBYY FineReader (abbyy) در توزیع استاندارد وجود دارند. برای سازگاری با نسخه قبلی، اگر این متغیر اصلاً تعریف نشود، مقدار پیش‌فرض "tesseract" است. در صورت نیاز از یک مقدار خالی صریح استفاده کنید. مقدار در زیرشاخه‌ها قابل بازتعریف است.
محل ذخیره حافظه موقت داده‌های OCR. پیش‌فرض در صورت خالی یا تعریف‌نشده بودن، ذخیره داده‌های موقت OCR در زیر $RECOLL_CONFDIR/ocrcache است.
زبان فرضی برای OCR با tesseract. برای بهبود دقت OCR مهم است. این همچنین می‌تواند از طریق محتوای یک پرونده در شاخه‌ای که در حال حاضر پردازش می‌شود تنظیم شود. اسکریپت rclocrtesseract.py را ببینید. مقادیر نمونه: eng, fra... برای کدهای زبان و نحوه بارگیری بسته‌های زبان اضافی به مستندات وب‌سایت tesseract مراجعه کنید. هنگام تعیین چندین زبان، از جداکننده '+' و بدون فاصله استفاده کنید، مثلاً eng+fra. مقدار در زیرشاخه‌ها قابل بازتعریف است.
مسیر برای دستور tesseract. در گیومه قرار ندهید. این عمدتاً در ویندوز یا برای تعیین یک دستور غیرپیش‌فرض tesseract مفید است. مثلاً در ویندوز: tesseractcmd = C:/ProgramFiles/Tesseract-OCR/tesseract.exe
زبان فرضی برای OCR با abbyy. برای بهبود دقت OCR مهم است. این همچنین می‌تواند از طریق محتوای یک پرونده در شاخه‌ای که در حال حاضر پردازش می‌شود تنظیم شود. اسکریپت rclocrabbyy.py را ببینید. مقادیر نمونه: English, French... مستندات ABBYY را ببینید.
مسیر برای دستور abbyy. شاخه ABBY معمولاً در PATH نیست، بنابراین باید این را تنظیم کنید.
فعال کردن تبدیل گفتار به متن. تنها مقدار ممکن در حال حاضر "whisper" برای استفاده از برنامه whisper شرکت OpenAI است.
نام مدل whisper.
نام دستگاه (device) مورد استفاده برای whisper.

recollindex(1) recoll(1)

14 November 2012