.TH INFORMANT 1 "02 SEPTEMBER 2024" informant-v0.6.0 "Informant Manual"
.SH "نام (NAME)"
informant \- بررسی اخبار مهم آرچ لینوکس پیش از به‌روزرسانی با Pacman

.SH "خلاصه دستور (SYNOPSIS)"
.I informant
[\fIگزینه‌ها\fR] check

.I informant
[\fIگزینه‌ها\fR] list [--reverse --unread]

.I informant
[\fIگزینه‌ها\fR] read [<\fIمورد\fR> | --all]

.SH "توضیحات (DESCRIPTION)"
دستور
.I informant
دارای سه حالت عملیاتی است: check، list و read.

.SH "دستورها (COMMANDS)"

.TP
.B check
اخبار خوانده‌نشده آرچ لینوکس را بررسی می‌کند و با کد خروجی برابر با تعداد موارد خوانده‌نشده خارج می‌شود.

.TP
.B list
عناوین جدیدترین اخبار را (صرف‌نظر از اینکه خوانده شده‌اند یا خیر) چاپ می‌کند. دستور list دو گزینه اختصاصی نیز می‌پذیرد:
.RS
.TP
.B \-\-reverse
عناوین را از قدیمی‌ترین به جدیدترین (به جای جدیدترین به قدیمی‌ترین) چاپ می‌کند.
.TP
.B \-\-unread
تنها عناوین موارد خوانده‌نشده را چاپ می‌کند.
.RE

.TP
.BR read " " [<\fIمورد\fR> | \-\-all]
مورد خبری مشخص‌شده را چاپ کرده و آن را به عنوان خوانده‌شده علامت‌گذاری می‌کند.
.B <\fIمورد\fR>
می‌تواند به صورت یک اندیس (چاپ‌شده توسط دستور
.B list
بدون گزینه‌های
.B \-\-unread
یا
.BR \-\-reverse )
یا به صورت یک رشته منطبق بر بخشی از عنوان یک مورد خبری داده شود. دستور
.B read
در صورتی که دسترسی نوشتن روی فایل ذخیره‌سازی را نداشته باشد، با کد وضعیت 255 خارج می‌شود.

هنگامی که بدون
.B <\fIمورد\fR>
یا
.B \-\-all
اجرا شود، دستور read به صورت تعاملی اجرا شده و تمامی موارد خبری خوانده‌نشده را از قدیمی‌ترین به جدیدترین چاپ می‌کند و از کاربر می‌پرسد که آیا مایل به ادامه خواندن است یا خیر.
.RS
.TP
.B \-\-all
تمامی جدیدترین موارد خبری را بدون چاپ کردن، به عنوان خوانده‌شده علامت‌گذاری می‌کند.
.RE

.SH "گزینه‌ها (OPTIONS)"
این‌ها گزینه‌های عمومی هستند که می‌توان آن‌ها را برای هر یک از زیردستورها به کار برد.

.TP
.BR \-c " " <cfile> ", " \-\-config=<cfile>
پیکربندی را از <cfile> می‌خواند. تنظیمات و نحو پیکربندی در بخش «پیکربندی (CONFIGURATION)» در ادامه آمده است.

.TP
.BR \-d ", " \-\-debug
پیام‌های اشکال‌زدایی را چاپ می‌کند و تغییری در فایل ذخیره‌سازی ایجاد نمی‌کند.

.TP
.BR \-r ", " \-\-raw
هنگام چاپ موارد، هیچ نشانه‌گذاری را جایگزین نمی‌کند؛ موارد دقیقاً همان‌طور که توسط فید RSS برگردانده شده‌اند چاپ می‌شوند.

.TP
.BR \-f " " <file> ", " \-\-file=<file>
از <file> به عنوان مسیر ذخیره‌سازی برای علامت‌گذاری موارد به عنوان خوانده‌شده استفاده می‌کند. این یک فایل باینری است.

.PP
.B نکته:
تغییر این فایل، فایلی را که توسط قلاب pacman خوانده می‌شود تغییر نخواهد داد زیرا قلاب pacman با دسترسی ریشه (root) اجرا می‌شود؛ در صورتی که می‌خواهید آن را تغییر دهید، می‌توانید به صورت دستی با ویرایش فایل /usr/share/libalpm/hooks/00-informant.hook این کار را انجام دهید.

.TP
.BR \-p " " <pager> ", " \-\-pager=<pager>
از <pager> برای نمایش موارد خبری استفاده می‌کند. این گزینه متغیر محیطی
.B $INFORMANT_PAGER
را بازنویسی می‌کند.

.TP
.BR \-\-no\-cache
هنگام دریافت فیدها از حافظه پنهان (/var/cache/informant/) صرف‌نظر می‌کند (این کار احتمالاً منجر به دریافت کندتر فید اما نتایج به‌روزتر می‌شود). استفاده از این گزینه می‌تواند برای بررسی مشکلات اجرای informant ناشی از حافظه پنهان مفید باشد.

.TP
.BR \-\-clear\-cache
دایرکتوری حافظه پنهان (/var/cache/informant/) را پیش از دریافت فید(ها) خالی می‌کند.

.TP
.BR \-\-clear\-readlist
فایل ذخیره‌سازی اخبار خوانده‌شده (به صورت پیش‌فرض /var/lib/informant.dat) را خالی می‌کند؛ این بدان معناست که هر مورد خبری که قبلاً خوانده شده و در فید بازگردانده می‌شود، باید دوباره خوانده شود. فید خبری تنها تعداد مشخصی از فایل‌ها را برمی‌گرداند و به مرور زمان ممکن است مواردی در فایل ذخیره‌سازی باقی بمانند که دیگر هنگام دریافت فید برگردانده نمی‌شوند؛ این گزینه می‌تواند برای پاکسازی فایل ذخیره‌سازی استفاده شود.

با پاک کردن فایل ذخیره‌سازی و سپس علامت‌گذاری همه موارد به عنوان خوانده‌شده، عملاً تمام موارد قدیمی را از فایل ذخیره‌سازی حذف می‌کنید:
.EX
    informant --clear-readlist read --all
.EE

.TP
.BR \-h ", " \-\-help
راهنما را چاپ کرده و خارج می‌شود.

.TP
.BR \-V ", " \-\-version
اطلاعات نسخه را چاپ کرده و خارج می‌شود.

.SH "محیط (ENVIRONMENT)"

.TP
.BR INFORMANT_PAGER
در صورت تنظیم بودن
.BR $INFORMANT_PAGER ،
مقدار آن به عنوان نام برنامه‌ای که برای نمایش موارد خبری استفاده می‌شود، به کار می‌رود.

.SH "پیکربندی (CONFIGURATION)"
برنامه Informant می‌تواند پیکربندی شود تا به جای فید اخبار آرچ لینوکس، چندین فید را بررسی کند (اینکه این کار واقعاً مفید است یا خیر بر عهده کاربر است). Informant به دنبال فایل
.B informantrc.json
در چند مکان می‌گردد و به این ترتیب آن‌ها را بررسی می‌کند:
.RS
.PP
\- گزینه ارائه‌شده در خط فرمان (cfile)

.PP
\- $HOME/.informantrc.json

.PP
\- $XDG_CONFIG_HOME/informantrc.json

.PP
\- /etc/informantrc.json

.PP
\- به ازای هر دایرکتوری $d در $XDG_CONFIG_DIRS به دنبال $d/informantrc.json می‌گردد.
.RE

.PP
.B نکته:
اگر می‌خواهید فایل پیکربندی در قلاب pacman استفاده شود، اطمینان حاصل کنید که از مسیر ذخیره‌سازی‌ای استفاده کنید که هنگام اجرای informant به صورت root/sudo قابل دسترسی باشد.

.SS "ساختار پیکربندی (Configuration Syntax)"
ساختار informantrc.json یک شیء JSON است که شامل یک کلید است:
.B feeds
که فهرستی است که فیدهایی را که می‌خواهید informant بررسی کند، توصیف می‌کند. هر فید به عنوان یک شیء JSON با کلیدهای زیر نمایش داده می‌شود:
.RS

.TP
.BR name " (اختیاری)"
برای نشان دادن اینکه هر مورد خبری از کدام فید است استفاده می‌شود.

.TP
.BR url " (الزامی)"
نشانی اینترنتی (URL) فید.

.TP
.BR title\-key " (اختیاری)"
پیش‌فرض آن
.IR title
است؛ کلیدی که برای ارجاع به عنوان مورد خبری در فید استفاده می‌شود.

.TP
.BR body\-key " (اختیاری)"
پیش‌فرض آن
.IR summary
است؛ کلیدی که برای ارجاع به بدنه مورد خبری در فید استفاده می‌شود.

.TP
.BR timestamp\-key " (اختیاری)"
پیش‌فرض آن
.IR published
است؛ کلیدی که برای ارجاع به تاریخ مورد خبری در فید استفاده می‌شود.
.RE

.PP
برای مثال، فایل informantrc.json زیر، informant را طوری پیکربندی می‌کند که فید اخبار آرچ لینوکس و همچنین فید اخبار Arch Linux 32 را بررسی کند:
.EX
{
    "feeds": [
        {
            "name": "Arch News",
            "url": "https://archlinux.org/feeds/news",
            "title-key": "title",
            "body-key": "summary",
            "timestamp-key": "published"
        },
        {
            "name": "Arch32 News",
            "url": "https://bbs.archlinux32.org/extern.php?action=feed&fid=12&type=atom",
            "title-key": "title",
            "body-key": "summary",
            "timestamp-key": "updated"
        }
    ]
}
.EE

.SH "نویسنده (AUTHOR)"
Bradford Smith <\fIhttps://github.com/bradford-smith94\fR>

.SH "مجوز (LICENSE)"
MIT

.SH "اشکالات (BUGS)"
لطفاً اشکالات را در این نشانی گزارش دهید:
<\fIhttps://github.com/bradford-smith94/informant/issues\fR>

.SH "همچنین ببینید (SEE ALSO)"
.BR alpm-hooks (5)