INNREPORT.CONF(5) InterNetNews Documentation INNREPORT.CONF(5)

innreport.conf - پروندهٔ پیکربندی برای innreport

پروندهٔ pathetc/innreport.conf امکان پیکربندی رفتار innreport را فراهم می‌کند. این پرونده از مجموعه‌ای از خطوط تشکیل شده است؛ خطوط خالی و مواردی که پس از علامت هش ("#") در یک خط می‌آیند نادیده گرفته می‌شوند. ساختار این پرونده بدین صورت است:

section default {
    libpath             "/path/to/libraries";
    logpath             "/path/to/logs";
    module              "innreport_inn";
    display_conf_file   "innreport-display.conf";
    unwanted_log        "unwanted.log";
    text                true;
    html                true;  # Enable HTML reports.
    # Other options to set.
};

تنها این بخش default نیاز به پیکربندی دارد. این بخش با "section default {" آغاز شده و با "};" پایان می‌یابد. هر خط در این بخش شامل یک نام گزینه، به همراه یک یا چند فاصله یا تب پس از آن، مقدار گزینه و یک نقطه-ویرگول ";" است.

گزینهٔ display_conf_file نام پروندهٔ پیکربندی نمایشِ مورد استفاده را تعیین می‌کند. این پرونده که در libpath قرار دارد، نحوی مشابه با innreport.conf دارد. اگر می‌خواهید از یک پیکربندی نمایش سفارشی استفاده کنید، کافی است نام پروندهٔ پیش‌فرض innreport-display.conf را به نام دیگری تغییر دهید و آن را در display_conf_file تنظیم کنید (در غیر این صورت، innreport-display.conf با هر بار به‌روزرسانی INN بازنویسی خواهد شد).

بخش‌های تعریف‌شده در پروندهٔ پیکربندی نمایش برای مشخص کردن پارامترهای نمایش، و نحوه و محتوای گزارش به کار می‌روند، اما در حالت عادی نباید تغییر داده شوند (مگر این‌که دقیقاً بدانید چه کار می‌کنید). این بخش‌ها به یک زبان خاص‌دامنه (DSL) نوشته شده‌اند که برای تغییر یافتن طراحی نشده است (ممکن است گزارش‌ها را مختل کنید، به‌ویژه در صورت تغییر پارامترهای data، double، format، primary، sort، total یا value). ساده‌ترین پارامترها برای تغییر در صورت نیاز عبارت‌اند از:

  • title (عناوین بخش‌ها در innreport)،
  • name (نام ستون‌ها)،
  • color (رنگ منحنی‌ها در نمودارها)،
  • numbering (یک مقدار بولی برای تنظیم این‌که آیا هر سطر از گزارش‌های HTML با شماره رتبه پیشوندگذاری شود یا خیر)،
  • text، html و skip (مقادیر بولی برای تنظیم این‌که آیا یک بخش مشخص به‌ترتیب در گزارش‌های متنی، HTML یا هر دو وجود داشته باشد یا خیر)،
  • top (حداکثر تعداد مقادیر جهت نمایش)؛ می‌توانید مقادیر متفاوتی را برای گزارش‌های متنی و HTML با top_text و top_html مشخص کنید.

گزینه‌های زیر را می‌توان در بخش default از پروندهٔ پیکربندی عمومی innreport.conf تنظیم کرد:

مشخص می‌کند که در صورت فعال بودن گزارش‌های HTML، آیا صفحات HTML و نمودارها بایگانی شوند یا خیر. هنگامی که این گزینه روی "true" (که مقدار پیش‌فرض است) تنظیم شده باشد، تاریخی به نام پروندهٔ هر گزارش و هر نمودار افزوده خواهد شد. در غیر این صورت، تنها آخرین گزارش HTML نگه‌داری می‌شود.

استفاده از فلگ -[no]archive همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

هنگامی که این گزینه روی "true" (که مقدار پیش‌فرض است) تنظیم شده باشد، جستجوهای حساس به حروف بزرگ و کوچک برای الگوهای از پیش تعیین‌شده در پرونده‌های لاگ اخبار انجام می‌پذیرد.

استفاده از فلگ -[no]casesensitive همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

مشخص می‌کند که در صورت فعال بودن و بایگانی شدن گزارش‌های HTML، چه تعداد پروندهٔ گزارش باید نگه‌داری شوند. مقدار پیش‌فرض "0" است، به این معنا که تمام بایگانی‌ها نگه‌داری می‌شوند. مقدار "none" نیز به معنای "0" است.

استفاده از فلگ -cycle همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

پروندهٔ پیکربندی نمایش مورد استفاده را که در دایرکتوری تعیین‌شده با گزینهٔ libpath قرار دارد، تعریف می‌کند. مقدار پیش‌فرض "innreport-display.conf" است.
مجموعه نویسه‌ها (کدگذاری) را برای استفاده در اعلان‌های XML و Content-Type گزارش‌های HTML مشخص می‌کند. مقدار پیش‌فرض "ISO-8859-1" است.
متنی را برای پیوست شدن به انتهای آخرین تگ "<div>" در هر گزارش HTML، جایی که نسخهٔ innreport نمایش داده می‌شود، مشخص می‌کند. این گزینه به‌طور پیش‌فرض تنظیم نشده است.
اگر کتابخانهٔ گرافیکی پرل GD.pm نصب شده باشد و گزارش‌های HTML فعال باشند، در صورتی که توسط "GD" پشتیبانی شود (که در نسخه‌های نوین چنین است)، نمودارها نیز در قالب PNG تولید می‌شوند (در غیر این صورت در قالب GIF تولید خواهند شد). این گزینه به‌طور پیش‌فرض روی "true" تنظیم شده است، به این معنا که تولید نمودار فعال است.

استفاده از فلگ -[no]graph همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

رنگ پس‌زمینهٔ نمودارها در گزارش‌های HTML را به‌صورت یک مقدار رنگ هگزادسیمال HTML مشخص می‌کند. مقدار پیش‌فرض "#FFFFFF" (سفید) است.
رنگ پیش‌زمینهٔ نمودارها در گزارش‌های HTML را به‌صورت یک مقدار رنگ هگزادسیمال HTML مشخص می‌کند. مقدار پیش‌فرض "#000000" (سیاه) است.
عرض نمودارها در گزارش‌های HTML را بر حسب پیکسل تعیین می‌کند. مقدار پیش‌فرض "550" است.
این یک گزینهٔ اجباری بدون مقدار پیش‌فرض است. این گزینه دو هدف را دنبال می‌کند: تولید گزارش‌های HTML علاوه بر گزارش متنی ساده که در خروجی استاندارد چاپ می‌شود، و پیکربندی این‌که آیا بخشی از گزارش باید در خروجی HTML موجود باشد یا خیر، در بخش‌هایی به غیر از default (در پروندهٔ پیکربندی نمایش).

اگر روی "true" تنظیم شود و هنگام فراخوانی innreport فلگ -nohtml داده نشده باشد، گزارش‌های HTML تولید خواهند شد. این گزارش‌ها شامل بخش‌هایی که در پروندهٔ پیکربندی نمایش به‌صورت جداگانه گزینهٔ html آن‌ها روی "false" تنظیم شده است نخواهند بود (به‌طور پیش‌فرض، همه چیز در گزارش‌های HTML گنجانده می‌شود). در غیر این صورت، اگر فلگ -nohtml داده شود، هیچ گزارش HTML تولید نخواهد شد.

اگر روی "false" تنظیم شود و هنگام فراخوانی innreport فلگ -html داده نشده باشد، هیچ گزارش HTML تولید نخواهد شد. در غیر این صورت، اگر فلگ -html داده شود، گزارش‌های HTML تولید خواهند شد، اما تنها بخش‌هایی که در پروندهٔ پیکربندی نمایش به‌طور جداگانه html آن‌ها روی "true" تنظیم شده باشد در گزارش‌ها حضور خواهند داشت.

عناصر اضافی را برای الحاق به تگ "<body>" در گزارش‌های HTML مشخص می‌کند. این گزینه به‌طور پیش‌فرض تنظیم نشده است.

توجه داشته باشید که استفاده از این گزینه منجر به ایجاد XHTML نامعتبر می‌شود. در عوض باید با استفاده از گزینهٔ html_css_url یک پروندهٔ CSS سفارشی ارائه دهید.

نام یک پروندهٔ CSS را برای اعمال یک شیوهٔ نگارش (استایل) سفارشی به گزارش‌های HTML مشخص می‌کند. این پرونده در دایرکتوری تعیین‌شده با گزینهٔ html_dir قرار دارد. همچنین می‌تواند یک URL باشد که در این صورت پرونده ممکن است در مکان دیگری واقع شده باشد.

در صورت تنظیم نشدن (که حالت پیش‌فرض است)، innreport یک برگهٔ استایل سفارشی پیش‌فرض به نام innreport.css در html_dir ایجاد کرده و از آن برای گزارش‌های HTML استفاده می‌کند.

اگر مایلید استایل خود را فراهم کنید، به موارد تعریف‌شده در CSS پیش‌فرض و گزارش‌های HTML نگاهی بیندازید و آن را بر اساس نیازهای خود تغییر دهید. در طول چندین نگارش مختلف از innreport که ممکن است کلاس‌ها دستخوش تغییر شوند، اطمینان حاصل کنید که تعاریف کلاس‌های قدیمی را برای سازگاری عقروعطف با گزارش‌های HTML تولیدشدهٔ قبلی که همچنان به آن پروندهٔ سفارشی ارجاع می‌دهند، حفظ می‌کنید.

در صورت فعال بودن گزارش‌های HTML، دایرکتوری صفحات وب را تعیین می‌کند. مقدار پیش‌فرض، مقدار pathhttp تنظیم‌شده در inn.conf است.

استفاده از فلگ -dir همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

پسوند پروندهٔ گزارش‌های HTML تولیدشده را در صورت فعال بودن تعیین می‌کند. پسوند باید با یک نقطه (".") شروع شود. مقدار پیش‌فرض ".html" است.

ممکن است بخواهید به جای آن از ".xhtml" استفاده کنید تا وب‌سرور نوع MIME صحیح را ارائه دهد، چرا که innreport صفحات XHTML 1.1 تولید می‌کند.

نام پرونده‌ای را در html_dir مشخص می‌کند که محتوای آن درست پیش از تگ "</body>" در هر گزارش HTML پیوست خواهد شد. این گزینه به‌طور پیش‌فرض تنظیم نشده است.
نام پرونده‌ای را در html_dir مشخص می‌کند که محتوای آن درست پس از تگ "<body>" در هر گزارش HTML پیوست خواهد شد. این گزینه به‌طور پیش‌فرض تنظیم نشده است.
مشخص می‌کند که آیا در صورت تنظیم روی "true"، ورودی‌های ناشناخته از پرونده‌های لاگ اخبار در گزارش‌های HTML گزارش شوند یا خیر. این گزینه به‌طور پیش‌فرض همان مقدار گزارش‌های متنی ساده را (که با گزینهٔ unknown تنظیم شده) می‌گیرد.

استفاده از فلگ -[no]html-unknown همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

نام یک پروندهٔ XSL را برای اعمال عملیات شیوه‌بندی به گزارش‌های HTML مشخص می‌کند. این پرونده در دایرکتوری تعیین‌شده با گزینهٔ html_dir قرار دارد. همچنین می‌تواند یک URL باشد که در این صورت پرونده ممکن است در مکان دیگری واقع شده باشد.

این گزینه به‌طور پیش‌فرض تنظیم نشده است. هنگامی که تنظیم شود، اعلان برگهٔ استایل XML متناظر به گزارش‌های HTML اضافه خواهد شد. این گزینه ممکن است برای سازگاری XHTML با مرورگرهای قدیمی‌تر مفید باشد (به https://www.w3.org/MarkUp/2004/xhtml-faq#ie مراجعه کنید).

به‌طور کلی‌تر، اگر به تبدیلات XSL علاقه‌مند هستید، ممکن است بخواهید نگاهی به innreport-filter.xslt موجود در دایرکتوری contrib بیندازید.

در صورت فعال بودن گزارش‌های HTML و تمایل به ایجاد نمودارها، مسیر وب تصاویر در صفحات HTML را تعیین می‌کند. این مسیر نسبت به دایرکتوری مشخص‌شده با گزینهٔ html_dir نسبی است. مقدار پیش‌فرض "pics" است.

استفاده از فلگ -webpath همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

در صورت فعال بودن گزارش‌های HTML، نام صفحهٔ وب اصلی (ایندکس) را تعیین می‌کند. مقدار پیش‌فرض "index.html" است.

شاید بخواهید به جای آن از "index.xhtml" استفاده کنید تا وب‌سرور نوع MIME صحیح را ارائه دهد، زیرا innreport صفحات XHTML 1.1 تولید می‌کند.

استفاده از فلگ -index همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

دایرکتوری‌ای را که ماژول پرلِ مشخص‌شده با گزینهٔ module در آن قرار دارد، تعریف می‌کند. این گزینه اجباری است و معمولاً روی مقداری برابر با pathlib در inn.conf تنظیم می‌شود.
دایرکتوری پروندهٔ لاگِ مربوط به گروه‌های خبری را که به‌صورت محلی توسط سرور اخبار نگه‌داری نمی‌شوند (تنظیم‌شده با گزینهٔ unwanted_log)، تعریف می‌کند. این گزینه اجباری است و معمولاً روی مقداری برابر با pathlog در inn.conf تنظیم می‌شود.
مشخص می‌کند که هنگام تنظیم گزینه‌های unknown یا html-unknown، چه تعداد از ورودی‌های ناشناخته از پرونده‌های لاگ اخبار گزارش شوند. مقدار پیش‌فرض "50" است. استفاده از "-1" به معنای نامحدود بودن است.

استفاده از فلگ -maxunrec همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

ماژول پرلِ استفاده‌شده توسط innreport برای تجزیه و خلاصه‌سازی پرونده‌های لاگ را تعریف می‌کند. این گزینه اجباری است و معمولاً روی "innreport_inn" تنظیم می‌شود. این مقدار معمولاً نباید تغییر داده شود مگر اینکه دقیقاً بدانید چه کار می‌کنید. ماژول پرلی که بارگذاری خواهد شد module.pm واقع در دایرکتوری تعیین‌شده با گزینهٔ libpath است.
در صورت فعال بودن و بایگانی شدن گزارش‌های HTML، جداکنندهٔ میان ساعت، دقیقه و ثانیه را در نام پرونده‌ها تعیین می‌کند. مقدار پیش‌فرض "." است زیرا ممکن است ":" توسط همهٔ مرورگرهای وب به‌درستی خوانده نشود. مراقب باشید که از "/" به‌عنوان جداکننده استفاده نکنید و تنها از نویسه‌های معتبر برای نام پرونده استفاده کنید.

استفاده از فلگ -separator همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

این یک گزینهٔ اجباری بدون مقدار پیش‌فرض است.

اگر روی "true" تنظیم شود، innreport گزارش متنی خود را در خروجی استاندارد چاپ خواهد کرد. این گزارش شامل بخش‌هایی که در پروندهٔ پیکربندی نمایش به‌صورت جداگانه گزینهٔ text آن‌ها روی "false" تنظیم شده باشد نخواهد بود (به‌طور پیش‌فرض، همه چیز در گزارش متنی موجود است).

اگر روی "false" تنظیم شود، innreport تنها بخش‌هایی را در خروجی استاندارد چاپ خواهد کرد که در پروندهٔ پیکربندی نمایش به‌طور جداگانه گزینهٔ text آن‌ها روی "true" تنظیم شده باشد (به‌طور پیش‌فرض، گزارش متنی خالی خواهد بود).

متنی را برای استفاده به‌عنوان کلمات ابتدایی گزارش‌های متنی و HTML و همچنین در عنوان گزارش‌های HTML مشخص می‌کند. به‌طور پیش‌فرض از "Daily Usenet report" استفاده می‌شود.
اگر روی "true" تنظیم شود، پس‌زمینهٔ نمودارهای تولیدشده در گزارش‌های HTML شفاف خواهد بود. مقدار پیش‌فرض "false" است.
تعیین می‌کند که آیا در صورت تنظیم روی "true"، ورودی‌های ناشناخته از پرونده‌های لاگ اخبار در گزارش‌های متنی ساده گزارش شوند یا خیر. این گزینه به‌طور پیش‌فرض فعال است.

استفاده از فلگ -[no]unknown همراه با innreport(8) بر پروندهٔ پیکربندی اولویت دارد.

نام پرونده‌ای را که توسط innreport برای نگه‌داری تعداد مقالاتی که به دلیل ارسال به گروه‌های خبریِ ناموجود در پروندهٔ active سرور اخبار رد شده‌اند به کار می‌رود، تعریف می‌کند. این پرونده هنگام پردازش پروندهٔ لاگ news.notice توسط innreport به‌روزرسانی شده و به ترتیب عددی معکوس نگه‌داری می‌شود (محبوب‌ترین گروه ردشده در ابتدا قرار می‌گیرد).

این گزینه اجباری است و معمولاً روی "unwanted.log" تنظیم می‌شود. این مقدار معمولاً نباید تغییر کند مگر اینکه دقیقاً بدانید چه کار می‌کنید. این پرونده در دایرکتوری تعیین‌شده با گزینهٔ logpath قرار دارد.

توجه داشته باشید که برای تولید این پرونده، گزینهٔ logtrash در inn.conf باید روی true تنظیم شده باشد.

توسط Julien Elie برای InterNetNews نوشته شده است.

innreport(8).

2023-03-07 INN 2.7.4