نام (NAME)

notmuch-dump - ایجاد خروجی متنی ساده از برچسب‌های هر پیام

خلاصه دستور (SYNOPSIS)

notmuch dump [--gzip] [--format=(batch-tag|sup)] [--output=<file>] [--] [<search-term> ...]

توضیحات (DESCRIPTION)

تهیه خروجی از برچسب‌های پیام‌های منطبق با عبارت‌های جستجوی ارائه‌شده.

خروجی در صورت تعیین نام فایل، درون آن و در غیر این صورت در stdout نوشته می‌شود.

این برچسب‌ها تنها داده‌هایی در پایگاه داده notmuch هستند که نمی‌توان آن‌ها را مجدداً از خود پیام‌ها بازسازی کرد. بنابراین، خروجی notmuch dump تنها بخش حیاتی برای پشتیبان‌گیری است (و سازگاری بسیار بیشتری نسبت به فایل‌های بومی پایگاه داده با پشتیبان‌گیری افزایشی دارد).

برای جزئیات نحو (syntax) پشتیبانی‌شده برای <search-terms>، به notmuch-search-terms <#notmuch-search-terms-7> مراجعه کنید. در صورت عدم ارائه عبارت‌های جستجو، خروجی کاملی از تمام پیام‌های پایگاه داده تولید خواهد شد. آرگومان -- به notmuch اعلام می‌کند که آرگومان‌های باقی‌مانده عبارت‌های جستجو هستند.

گزینه‌های پشتیبانی‌شده برای dump عبارتند از:

--gzip: فشرده‌سازی خروجی با قالبی سازگار با gzip(1) https://manpages.debian.org/gzip.1.html.

--format=(sup|batch-tag): دستور notmuch restore از دو قالب خروجی متنی ساده پشتیبانی می‌کند، که هر دو شامل یک message-id در هر خط و به دنبال آن فهرستی از برچسب‌ها هستند.

batch-tag: قالب خروجی پیش‌فرض batch-tag به گونه‌ای طراحی شده است که در برابر message-idهای معیوب و برچسب‌های حاوی فاصله‌های خالی یا نویسه‌های غیر ascii(7) https://manpages.debian.org/ascii.7.html مقاوم‌تر باشد. هر خط دارای ساختار زیر است:

+<*encoded-tag*\ > +<*encoded-tag*\ > ... -- id:<*quoted-message-id*\ >

برچسب‌ها با جایگزین کردن هر بایتی که با عبارت منظم [A-Za-z0-9@=.,_+-] تطابق ندارد با %nn (که در آن nn کد هگز دورقمی است) کدگذاری هگز می‌شوند. شناسه پیام (message ID) یک پرس‌وجوی معتبر Xapian است که با استفاده از قوانین نقل‌قول عبارات بولی Xapian نقل‌قول شده است: اگر شناسه حاوی فاصله یا پرانتز بسته باشد، یا با یک نقل‌قول دوتایی (double quote) شروع شود، باید داخل نقل‌قول‌های دوتایی قرار گیرد و نقل‌قول‌های دوتایی درون شناسه باید دوبرابر شوند. خواننده دقیق متوجه خواهد شد که این مورد یک حالت خاص از قالب ورودی دسته‌ای (batch) برای notmuch-tag <#notmuch-tag-1> است؛ توجه داشته باشید که پرس‌وجوی تک message-id برای notmuch-restore <#notmuch-restore-1> اجباری است.

sup: قالب فایل خروجی sup به طور ویژه برای سازگاری با قالب فایل‌های تولیدشده توسط sup-dump(1) https://manpages.debian.org/sup-dump.1.html انتخاب شده است. بنابراین اگر پیش از این برای نامه‌های خود از sup استفاده می‌کردید، دستور notmuch-restore <#notmuch-restore-1> روشی را برای وارد کردن تمام برچسب‌هایتان (یا همان برچسب‌ها که sup آن‌ها را label می‌نامد) فراهم می‌کند. هر خط دارای ساختار زیر است:

<*message-id*\ > **(** <*tag*\ > ... **)**

با صفر یا چند برچسب که با فاصله از هم جدا شده‌اند. توجه داشته باشید که message-idهای (معیوب) ممکن است شامل نویسه‌های دلخواه غیر تهی (non-null) باشند. همچنین توجه داشته باشید که برچسب‌های حاوی فاصله با این قالب به درستی بازیابی نخواهند شد.

--include=(config|properties|tags): تعیین نوع فراداده‌هایی که در خروجی گنجانده می‌شوند.

config: داده‌های پیکربندی ذخیره‌شده در پایگاه داده را در خروجی می‌آورد. هر خط با "#@ " شروع می‌شود که به دنبال آن یک جفت کلید-مقدار جداشده با فاصله قرار دارد. در صورت نیاز، هم کلید و هم مقدار با هگز کدگذاری می‌شوند.
properties: فراداده‌های (کلید، مقدار) به ازای هر پیام را در خروجی می‌آورد. هر خط با "#= " شروع می‌شود که به دنبال آن یک شناسه پیام و فهرستی از جفت‌های key=value جداشده با فاصله قرار دارد. شناسه‌ها، کلیدها و مقادیر در صورت نیاز با هگز کدگذاری می‌شوند. برای جزئیات بیشتر به notmuch-properties <#notmuch-properties-7> مراجعه کنید.
tags: فراداده‌های بولی به ازای هر پیام، یعنی برچسب‌ها را در خروجی می‌آورد. برای شرح خروجی، بخش format در بالا را ببینید.

حالت پیش‌فرض شامل تمام انواع داده‌های موجود است. این گزینه می‌تواند چندین بار مشخص شود تا زیرمجموعه‌ای از آن‌ها انتخاب شود. از نسخه ۳ قالب خروجی (dump format)، یک خط سرآیند به شکل زیر وجود دارد:

#notmuch-dump <*format*>:<*version*> <*included*>

که در آن <included> فهرستی جداشده با ویرگول از گزینه‌های بالا است.

--output=<filename>: نوشتن خروجی در فایل مشخص‌شده به جای stdout.

همچنین ببینید (SEE ALSO)

notmuch <#notmuch-1>, notmuch-config <#notmuch-config-1>, notmuch-count <#notmuch-count-1>, notmuch-hooks <#notmuch-hooks-5>, notmuch-insert <#notmuch-insert-1>, notmuch-new <#notmuch-new-1>, notmuch-properties <#notmuch-properties-7>, notmuch-reply <#notmuch-reply-1>, notmuch-restore <#notmuch-restore-1>, notmuch-search <#notmuch-search-1>, notmuch-search-terms <#notmuch-search-terms-7>, notmuch-show <#notmuch-show-1>, notmuch-tag <#notmuch-tag-1>

نویسندگان (AUTHORS)

Carl Worth و بسیاری دیگر

کپی‌رایت و تکثیر (COPYRIGHT)

2009-2026، Carl Worth و بسیاری دیگر