.TH R2E 1 .SH "نام (NAME)" r2e \- دریافت خوراک‌های RSS از طریق ایمیل .SH "خلاصه دستور (SYNOPSIS)" .B r2e .RI [ options ] .I .RI [ ] .SH "توضیحات (DESCRIPTION)" .BR r2e یک برنامه ساده است که می‌توانید آن را در .BR crontab (5) خود اجرا کنید. این برنامه خوراک‌های RSS را پایش می‌کند و برای هر مورد جدید، یک پیام ایمیل با قالب‌بندی مناسب برای شما می‌فرستد. .P برای شروع سریع با .B r2e این مراحل را امتحان کنید: .P .RS 4 .EX .BI "r2e new " "your@yourdomain.com" .BI "r2e add " "feedname http://feed.url/somewhere.rss" .BI "r2e run" .EE .RE .P اگر می‌خواهید موارد به‌طور خودکار برای شما ارسال شوند، در نهایت باید دستور آخر در crontab شما قرار داده شود. .SH "گزینه‌ها (OPTIONS)" .TP 4 \-h, \-\-help نمایش راهنمای rss2email و خروج. .TP \-v, \-\-version نمایش نسخه rss2email و خروج. .TP \-\-full\-version نمایش نسخه Python، کامپایلر استفاده‌شده برای کامپایل Python و بسته‌های استفاده‌شده توسط rss2email. .TP \-c, \-\-config \fI\fR پیکربندی برنامه به‌طور پیش‌فرض از $XDG_CONFIG_HOME/rss2mail.cfg خوانده می‌شود (همچنین بخش‌های FILES و ENVIRONMENT VARIABLES را در زیر ببینید). از این گزینه برای تنظیم یک فایل پیکربندی متفاوت استفاده کنید. .TP \-d, \-\-data \fI\fR داده‌های پویای برنامه به‌طور پیش‌فرض از $XDG_DATA_HOME/rss2mail\&.json خوانده می‌شود (همچنین بخش‌های FILES و ENVIRONMENT VARIABLES را در زیر ببینید). از این گزینه برای تنظیم یک فایل داده متفاوت استفاده کنید. .TP \-V, \-\-verbose افزایش سطح پرگویی گزارش‌ها. .SH "دستورها (COMMANDS)" .TP 4 .B new \fR[\fI\fR] ایجاد یک پایگاه‌داده جدید برای خوراک‌ها. اگر آرگومان \fI\fR داده شود، نشانی ایمیل پیش‌فرضی را تنظیم می‌کند که ایمیل‌ها به آن ارسال می‌شوند. .TP .B email \fR[\fI\fR] به‌روزرسانی نشانی ایمیل مقصد پیش‌فرض به \fI\fR. .TP .B add \fR[\fI\-\-only-new\fR] \fI\fR \fI\fR [\fI\fR] اشتراک در یک خوراک. آرگومان \fI\fR نامی را برای استفاده‌های بعدی به خوراک اختصاص می‌دهد. \fI\fR نشانی اینترنتی خوراک است. آرگومان اختیاری \fI\fR نشانی ایمیلی است که موارد جدید به آن ارسال می‌شوند و جایگزین نشانی پیش‌فرض برای این خوراک خاص می‌شود. این کار را برای هر خوراکی که می‌خواهید در آن مشترک شوید تکرار کنید. .P .RS 4 گزینه \-\-only-new خوراک را در زمان افزودن بدون ارسال ورودی‌ها واکشی می‌کند، به‌طوری که اجرای بعدی \fBrun\fR آن‌ها را از قبل ارسال‌شده در نظر می‌گیرد. این گزینه زمانی باید استفاده شود که فرد فقط به ورودی‌هایی علاقه‌مند است که در زمان اجرای \fBadd\fR هنوز در خوراک وجود ندارند. .RE .TP .B run \fR[\fI\-\-no-send\fR] \fR[\fI\-\-clean\fR] \fR[\fI\fR [\fI\fR ...]] پویش خوراک‌ها و ارسال ایمیل برای موارد جدید. این دستور می‌تواند در یک کار cron اجرا شود. .P .RS 4 گزینه \-\-no-send از ارسال هرگونه ایمیل توسط \fBr2e\fR جلوگیری می‌کند. این کار می‌تواند در اولین باری که آن را اجرا می‌کنید مفید باشد، زیرا در غیر این صورت برای هر ورودی موجود در خوراک یک ایمیل ارسال خواهد شد. .P گزینه \-\-clean با حذف ورودی‌های قدیمی، اندازه پایگاه‌داده را کاهش می‌دهد. این گزینه دانلود اجباری خوراک‌های انتخاب‌شده یا تمام خوراک‌ها را اعمال می‌کند، و فقط باید به‌صورت هفتگی یا ماهانه استفاده شود. .P اگر یک \fI\fR مشخص شود، \fBr2e\fR فقط آن خوراک را دانلود خواهد کرد. \fI\fR می‌تواند نام خوراک (تنظیم‌شده توسط \fBadd\fR) یا نمایه خوراک (نمایش‌داده‌شده توسط \fBlist\fR) باشد. .RE .TP .B list فهرست کردن تمام خوراک‌های موجود در پایگاه‌داده. .TP .B pause \fR[\fI\fR [\fI\fR ...]] مکث در خوراک‌ها (غیرفعال کردن واکشی). گزینه \fI\fR خوراک(ها) را برای مکث انتخاب می‌کند (برای مقادیر ممکن به \fBrun\fR مراجعه کنید). اگر هیچ \fI\fR داده نشود، همه خوراک‌ها به حالت مکث درمی‌آیند. .TP .B unpause \fR[\fI\fR [\fI\fR ...]] خروج خوراک‌ها از حالت مکث (فعال کردن واکشی). .TP .B delete \fI\fR [\fI\fR [\fI\fR ...]] حذف یک یا چند خوراک از پایگاه‌داده. گزینه \fI\fR خوراک(ها) را برای حذف انتخاب می‌کند (برای مقادیر ممکن به \fBrun\fR مراجعه کنید). .TP .B reset \fR[\fI\fR [\fI\fR ...]] فراموش کردن داده‌های پویای خوراک (مثلاً برای ارسال مجدد ورودی‌های قدیمی). گزینه \fI\fR خوراک(ها) را برای بازنشانی انتخاب می‌کند (برای مقادیر ممکن به \fBrun\fR مراجعه کنید). اگر هیچ \fI\fR داده نشود، همه خوراک‌ها بازنشانی می‌شوند. .TP .B opmlimport \fR[\fI\fR] وارد کردن خوراک‌های جدید از OPML. مقدار \fI\fR فایلی است که داده‌های OPML از آن خوانده می‌شوند. اگر \fI\fR داده نشود، \fBr2e\fR داده‌ها را از stdin می‌خواند. .TP .B opmlexport \fR[\fI\fR] صادر کردن تمام خوراک‌ها به OPML. مقدار \fI\fR فایلی است که داده‌های OPML در آن نوشته خواهند شد. اگر \fI\fR داده نشود، \fBr2e\fR داده‌ها را در stdout می‌نویسد..SH "پیکربندی (CONFIGURATION)" رفتار این برنامه را می‌توان از طریق \fI$XDG_CONFIG_HOME/rss2email.cfg\fR کنترل کرد (همچنین بخش‌های \fBفایل‌ها (FILES)\fR و \fBمتغیرهای محیطی (ENVIRONMENT VARIABLES)\fR را در زیر ببینید). قالب این فایل مشابه فایل‌های INI مایکروسافت ویندوز است. این فایل توسط کلاس ConfigParser پایتون تجزیه می‌شود، بنابراین برای جزئیات قالب به مستندات پایتون در http://docs\&.python\&.org/3/library/configparser\&.html مراجعه کنید. .P فایل پیکربندی، تنظیمات عمومی (اعمال‌شده بر روی تمام فیدها) را در بخش \fB[DEFAULT]\fR ذخیره می‌کند. دستور \fBnew\fR یک فایل پیکربندی برای شما می‌سازد که می‌توانید آن را به دلخواه ویرایش کنید. دستور \fBadd\fR بخش‌های مربوط به فیدهای خاص را اضافه می‌کند. برای بازنویسی هر تنظیمی برای همهٔ فیدها، مقدار آن را در بخش \fB[DEFAULT]\fR تغییر دهید. برای بازنویسی یک تنظیم برای فیدی خاص، آن تنظیم را به بخش ویژهٔ همان فید اضافه کنید. در اینجا نمونه‌ای برای بازنویسی \fBuse-publisher-email\fR و \fBname-format\fR برای فید \fBfeedname\fR آورده شده است. .P .RS 4 .EX [DEFAULT] from = user@rss2email.invalid force-from = False use-publisher-email = False name-format = {feed-title}: {author} .\|.\|. verbose = warning [feed.feedname] url = http://feed.url/somewhere.rss use-publisher-email = True name-format = {author} ({feed.title}) .EE .RE .P می‌توانید موارد زیر را پیکربندی کنید: .SS "نشانی‌دهی (Addressing)" .IP from نشانی ایمیلی که پیام‌ها به‌طور پیش‌فرض از آن فرستاده می‌شوند .IP use-8bit تنظیمات Transfer-Encoding. برای ارسال ایمیل به‌صورت محلی، استفاده از 8bit امن و راحت است. .IP force-from مقدار True: تنها از نشانی 'from' استفاده کند. مقدار False: در صورت امکان از نشانی ایمیل مشخص‌شده توسط فید استفاده کند. .IP use-publisher-email مقدار True: اگر ایمیل نویسنده یافت نشد، از ایمیل ناشر استفاده کند. مقدار False: به‌جای آن فقط از ایمیل 'from' استفاده کند. .IP name-format در صورت خالی بودن، به‌جای نام خوانا به‌همراه نشانی ایمیل، تنها از نشانی ایمیل فید استفاده می‌کند. صفت‌های در دسترس ممکن است شامل 'feed'، 'feed-name'، 'feed-url'، 'feed-title'، 'author' و 'publisher' باشند، اما تنها وجود 'feed'، 'feed-name' و 'feed-url' تضمین شده است. .IP to این گزینه را برابر نشانی‌های ایمیل پیش‌فرض To (گیرنده) قرار دهید. .RE .SS "دریافت (Fetching)" .IP proxy تنظیم یک پراکسی HTTP (مانند 'http://your.proxy.here:8080') .IP feed-timeout تنظیم مهلت زمانی (به ثانیه) برای دریافت پاسخ از سرور فید .RE .SS "پردازش (Processing)" .IP active مقدار True: دریافت، پردازش و ارسال فیدها از طریق ایمیل. مقدار False: فیدها را دریافت، پردازش یا ایمیل نکند. .IP digest مقدار True: در هر بار اجرای rss2email، برای هر فید یک ایمیل تجمیعی واحد شامل چندین ورودی ارسال کند. مقدار False: به ازای هر ورودی یک ایمیل جداگانه بفرستد. .IP digest-type نوع Content-Type پیام برای ایمیل‌های تجمیعی. مقادیر معتبر شامل 'multipart/digest' و 'multipart/mixed' هستند. مورد اول پیش‌فرض است، اما بسیاری از برنامه‌های کاربری ایمیل از آن پشتیبانی نمی‌کنند. .IP date-header مقدار True: در صورت امکان، هدر Date را بر اساس تاریخ ورودی تولید کند. مقدار False: هدر Date را بر اساس زمان ارسال ایجاد کند. .IP date-header-order فهرستی جداشده با کاما از ترکیبی از موارد ('issued', 'created', 'modified', 'expired') که ترتیب اولویت تاریخ‌ها را برای استفاده در هدر Date ایمیل مشخص می‌کند. .IP bonus-header تنظیم این گزینه برای افزودن هدرهای اضافی به تمامی ایمیل‌ها مثال: bonus-header = 'Approved: joe@bob.org' .IP trust-guid مقدار True: به ازای هر پست، یک ایمیل دریافت شود. مقدار False: با هر بار تغییر یک پست، یک ایمیل دریافت شود. .IP trust-link مقدار True: به ازای هر پیوند یکتای url، یک ایمیل دریافت شود. مقدار False: بر اساس اولویت تنظیم trust-guid عمل کند. تغییر این گزینه برای فیدهای موجود ممکن است منجر به دریافت موارد تکراری شود، زیرا ورودی‌های قدیمی تحت شناسه‌های جدید مبتنی بر پیوندشان ثبت نخواهند شد. .IP encodings برای کدگذاری دقیق‌تر ایمیل‌های حاوی نویسه‌های بین‌المللی، فهرست زیر پیمایش شده و از نخستین مجموعه نویسه (character set) کارآمد استفاده می‌شود. .IP post-process قلاب‌های پردازشی کاربر. به فاصلهٔ پس از نام ماژول دقت کنید. مثال: post-process = 'rss2email.post_process.downcase downcase_message' .IP digest-post-process قلاب‌های پردازشی کاربر برای پیام‌های تجمیعی (digest). اگر 'digest' فعال باشد، قلاب معمول 'post-process' پیام‌های مربوط به هر ورودی را پردازش می‌کند، اما این قلاب پیش از ارسال، همراه با کل پیام تجمیعی فراخوانی می‌شود. مثال: digest-post-process = 'rss2email.post_process.downcase downcase_message' .IP subject-format قالب خط موضوع (Subject). صفت‌های در دسترس عبارتند از 'feed'، 'feed-name'، 'feed-url' و 'feed-title'. .RE .SS "تبدیل اچ‌تی‌ام‌ال (HTML conversion)" .IP html-mail مقدار True: در صورت امکان، پیام‌ها با قالب text/html ارسال شوند. مقدار False: تبدیل HTML به متن ساده (plain text). .IP use-css استفاده از CSS .IP css استایل‌دهی اختیاری CSS .RE.SS گزینه‌های html2text .IP unicode-snob استفاده از نویسه‌های یونیکد (Unicode) به‌جای معادل‌های شبه‌اسکی (ascii) آن‌ها. .IP links-after-each-paragraph قرار دادن پیوندها پس از هر بند به‌جای قرار دادن آن‌ها در انتها. .IP inline-links استفاده از قالب‌بندی درون‌خطی (inline) به‌جای مرجع (reference) برای تصاویر و پیوندها. .IP wrap-links شکستن خطوط پیوندها بر اساس عرض متن. .IP body-width شکستن خطوط طولانی در موقعیت مشخص‌شده. هر مقدار منفی برای غیرفعال کردن شکستن خطوط، 0 برای عرض 78 (جهت سازگاری)، یا هر عرض مثبت دیگر. .RE .SS ارسال ایمیل .IP email-protocol انتخاب پروتکل از میان: sendmail، smtp، imap، maildir .IP sendmail مسیر sendmail (یا موارد سازگار با آن) .RE .SS پیکربندی SMTP .IP smtp-auth تنظیم روی True برای استفاده از SMTP AUTH .IP smtp-username نام کاربری برای SMTP AUTH .IP smtp-password گذرواژه برای SMTP AUTH .IP smtp-server سرور SMTP .IP smtp-ssl اتصال به سرور SMTP با استفاده از SSL .RE .SS پیکربندی IMAP .IP imap-auth تنظیم روی True برای استفاده از احراز هویت IMAP. .IP imap-username نام کاربری برای احراز هویت IMAP .IP imap-password گذرواژه برای احراز هویت IMAP .IP imap-server سرور IMAP .IP imap-port درگاه (پورت) IMAP .IP imap-ssl اتصال به سرور IMAP با استفاده از SSL .IP imap-mailbox جایی که پیام‌های جدید باید در آن ذخیره شوند .RE .SS پیکربندی Maildir .IP maildir-path مسیر maildir برای نوشتن پیام‌ها در آن .IP maildir-mailbox صندوق پستی (mailbox) درون maildir-path برای نوشتن پیام‌ها در آن .RE .SS متفرقه .IP user-agent رشته‌ای که به عنوان HTTP User-Agent در درخواست‌های وب و به عنوان سرایند User-Agent در ایمیل‌های خروجی استفاده می‌شود. در صورت وجود، __VERSION__ و __URL__ با شماره نسخه و وب‌سایت rss2email جایگزین می‌شوند. .IP verbose میزان پرگویی (یکی از \(aqerror\(aq، \(aqwarning\(aq، \(aqinfo\(aq یا \(aqdebug\(aq). .RE .P .SH "فایل‌ها (FILES)" .TP 4 .B $XDG_CONFIG_HOME/rss2email.cfg اگر این فایل وجود داشته باشد، برای پیکربندی برنامه خوانده می‌شود. .TP .B $XDG_DATA_HOME/rss2email\&.json پایگاه داده فیدها. برای افزودن، حذف یا تغییر فیدها از \fBr2e\fR استفاده کنید؛ آن را مستقیماً ویرایش نکنید. .SH "متغیرهای محیطی (ENVIRONMENT VARIABLES)" تمام متغیرهای محیطی استفاده‌شده توسط \fBr2e\fR در «مشخصات دایرکتوری پایه XDG» (XDG Base Directory Specification) تعریف شده‌اند که هدف آن استانداردسازی مکان فایل‌های پیکربندی و داده‌های مخصوص کاربر است. .TP 4 .B XDG_CONFIG_HOME دایرکتوری ترجیحی برای فایل‌های پیکربندی. پیش‌فرض آن $HOME/\&.config است. .TP .B XDG_DATA_HOME دایرکتوری ترجیحی برای فایل‌های داده. پیش‌فرض آن $HOME/\&.local/share است. .TP .B XDG_RUNTIME_DIR دایرکتوری ترجیحی برای فایل‌های قفل (lockfiles). پیش‌فرض آن /tmp/rss2email-UID است. .TP .B XDG_CONFIG_DIRS فهرستی از دایرکتوری‌های پایه برای فایل‌های پیکربندی علاوه بر $XDG_CONFIG_HOME که با دونقطه «:» از هم جدا شده و بر اساس اولویت مرتب شده‌اند. پیش‌فرض آن /etc/xdg است. اگر چندین فایل پیکربندی در این مسیر یافت شود، همگی توسط کلاس ConfigParser خوانده خواهند شد (بخش CONFIGURATION در بالا را نیز ببینید). .TP .B XDG_DATA_DIRS فهرستی از دایرکتوری‌های پایه برای فایل‌های داده که با دونقطه «:» از هم جدا شده و بر اساس اولویت مرتب شده‌اند. پیش‌فرض آن /usr/local/share/:/usr/share/ است. تنها از نخستین فایل منطبق استفاده می‌شود. .B .SH "نویسندگان (AUTHORS)" پروژه rss2email توسط Aaron Swartz آغاز شد و هم‌اکنون توسط گروهی از افراد نگه‌داری می‌شود. برای مشاهده فهرست کامل‌تری از مشارکت‌کنندگان، فایل AUTHORS را در توزیع rss2email ببینید. .SH "گزارش باگ‌ها (REPORTING BUGS)" گزارش باگ‌ها با ایجاد یک issue در: .UR https://github.com/rss2email/rss2email .UE .