نام (NAME)

appstreamcli-compose - ساخت کاتالوگ فراداده AppStream از درخت‌های پوشه

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

appstreamcli compose [COMMAND]

توضیحات (DESCRIPTION)

این صفحه راهنما به‌طور خلاصه دستور appstreamcli compose را شرح می‌دهد.

ابزار appstreamcli compose برای ساخت کاتالوگ‌های فراداده AppStream از درخت‌های پوشه به کار می‌رود. این ابزار همچنین اقدامات متعدد مرتبط با تولید فراداده، مانند تغییر اندازه آیکون‌ها و تصاویر پیش‌نمایش، ادغام داده‌ها از پرونده‌های desktop-entry ارجاع‌شده و اطلاعات وضعیت ترجمه را انجام می‌دهد. بنابراین، این ابزار روشی سریع برای آزمایش نحوه نمایش نهایی فراداده‌های پردازش‌شده برنامه‌ای که به دست کاربران می‌رسد فراهم می‌سازد. این ابزار همچنین روشی آسان برای تولید داده‌های AppStream برای پروژه‌هایی فراهم می‌کند که نیازی به تولیدکننده‌های داده پیچیده‌تر مانند appstream-generator ندارند.

برای اینکه دستور appstreamcli compose در دسترس باشد، ممکن است لازم باشد ابتدا ماژول اختیاری compose را برای appstreamcli نصب کنید.

برای دریافت اطلاعات بیشتر درباره پروژه AppStream و سایر مؤلفه‌هایی که بخشی از آن هستند، به صفحات AppStream در Freedesktop.org[1] نگاهی بیندازید.

گزینه‌ها (OPTIONS)

SOURCE-DIRECTORIES

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

--origin NAME

شناسه مبدأ داده‌های AppStream را تنظیم می‌کند. این شناسه می‌تواند مقداری مانند "debian-unstable-main" یا "flathub" باشد.

--result-root DIR

پوشه‌ای را تنظیم می‌کند که تمام خروجی‌های تولیدشده مستقر بر روی سامانه کاربر به آن صادر می‌شوند. اگر این پارامتر مشخص نشود و تنها یک پوشه برای پردازش وجود داشته باشد، از همان پوشه به عنوان مسیر خروجی پیش‌فرض استفاده می‌شود.

اگر هر دو گزینه --data-dir و --icons-dir تنظیم شده باشند، استفاده از --result-root ضروری نیست و هیچ داده‌ای در آن پوشه نوشته نخواهد شد.

--data-dir DIR

پوشه‌ای را که کاتالوگ فراداده‌های AppStream تولیدشده در آن نوشته می‌شود، بازنویسی می‌کند. داده‌ها مستقیماً در این پوشه نوشته می‌شوند و هیچ زیرپوشه‌ای ایجاد نخواهد شد (برخلاف زمانی که از --result-root برای تنظیم مکان خروجی استفاده می‌شود).

--icons-dir DIR

پوشه‌ای را که آیکون‌های ذخیره‌شده در حافظه نهان (کَش) به آن صادر می‌شوند، بازنویسی می‌کند.

--hints-dir DIR

پوشه‌ای را برای ذخیره گزارش‌های راهنمایی (hints) ایجادشده در حین پردازش فراداده‌ها تعیین می‌کند. اگر این پارامتر تنظیم نشود، هیچ گزارش راهنمایی به صورت HTML/YAML ذخیره نخواهد شد.

--media-dir DIR

در صورت تنظیم، پوشه‌ای با محتوای رسانه‌ای (آیکون‌ها، تصاویر پیش‌نمایش و غیره) ایجاد می‌کند که می‌توان از طریق یک وب‌سرور ارائه کرد. فراداده‌ها به گونه‌ای گسترش می‌یابند که شامل اطلاعات مربوط به این رسانه‌های دوردست باشند.

--media-baseurl URL

نشانی اینترنتی (URL) که محتوای پوشه تعیین‌شده با --media-dir تحت آن ارائه خواهد شد. در صورت ایجاد پوشه رسانه‌ها، تنظیم این مقدار الزامی است.

--prefix DIR

پیشوند پیش‌فرضی را که در پوشه‌های پردازش‌شده استفاده می‌شود تنظیم می‌کند. در صورتی که به صراحت مقداری تعیین نشود، مقدار پیش‌فرض /usr در نظر گرفته می‌شود.

--print-report MODE

گزارش نکات و مشکلات (که در صورت تعیین --hints-dir به عنوان سند HTML و YAML صادر می‌شود) را به صورت متنی در کنسول چاپ می‌کند.

حالت‌های مختلفی برای چاپ پشتیبانی می‌شوند: on-error تنها در صورت شکست اجرای دستور، گزارشی کوتاه چاپ می‌کند (پیش‌فرض)، short گزارشی چکیده تولید می‌کند که همیشه چاپ می‌شود و full باعث چاپ یک گزارش مفصل می‌گردد.

--no-partial-urls

در صورت تنظیم، تمام نشانی‌های وب در داده‌های تولیدشده به صورت مطلق خواهند بود و از media_baseurl استفاده نخواهد شد. این امر تغییر آینه (mirror) رسانه‌ها را بدون بازتولید کل داده‌ها دشوارتر می‌کند و به منظور افزایش انعطاف‌پذیری، عموماً توصیه نمی‌شود.

--icon-policy POLICY-STRING

سیاست آیکون موجود را با یک سیاست سفارشی جایگزین می‌کند. سیاست آیکون تعیین می‌کند که با آیکون‌ها در اندازه‌های مختلف چگونه رفتار شود. آن‌ها می‌توانند فقط در حافظه نهان آیکون قرار گیرند، یک آیکون دوردست در مکان رسانه‌ها باشند یا هم در حافظه نهان ذخیره شوند و هم در مکان دوردست در دسترس باشند.

رشته سیاست آیکون (icon-policy) از عبارت‌های جداشده با ویرگولِ %{size}x%{size}@%{scale}=%{state} تشکیل شده است. مقادیر size و scale مربوط به اندازه و مقیاس آیکون هستند؛ در صورتی که مقیاس برابر ۱ باشد می‌توان آن را حذف کرد. مقدار state می‌تواند یکی از مقادیر remote، cached یا cached-remote باشد.

به‌طور پیش‌فرض، سیاست 48x48=cached,48x48@2=cached,64x64=cached,64x64@2=cached,128x128=cached-remote,128x128@2=cached-remote انتخاب شده است.

--image-format FORMAT

قالب پرونده‌ای را که آیکون‌ها و تصاویر پیش‌نمایش تولیدشده در آن ذخیره می‌شوند تعیین می‌کند. تنها قالب‌های jxl و png در اینجا مجاز هستند که jxl پیش‌فرض است.

قالب JPEG-XL (jxl) با همان کیفیت بصری، حجم پرونده به مراتب کمتری نسبت به PNG تولید می‌کند، اما کلاینت‌های قدیمی‌تر AppStream قادر به نمایش آن نیستند. در صورتی که فراداده‌های تولیدشده باید توسط نرم‌افزارهایی که قبل از پشتیبانی از JPEG-XL عرضه شده‌اند استفاده شوند، گزینه png را انتخاب کنید.

آیکون‌ها همیشه به صورت بدون اتلاف (lossless) ذخیره می‌شوند، در حالی که تصاویر پیش‌نمایش با تعادلی معقول بین کیفیت و اندازه کدگذاری می‌گردند.

--allow-custom CUSTOM-KEY-NAMES

به‌طور پیش‌فرض، تمام ورودی‌های custom تنظیم‌شده در داده‌های ورودی MetaInfo حذف می‌شوند. این پرچم امکان قرار دادن کلیدهای سفارشی در لیست مجاز را برای انتقال به داده‌های کاتالوگ خروجی نهایی فراهم می‌کند. نام کلیدهای سفارشی باید به صورت فهرستی جداشده با ویرگول ارائه شوند.

--components COMPONENT-IDs

فهرستی جداشده با ویرگول از شناسه‌های مؤلفه AppStream تعیین می‌کند که باید برای فراداده‌های تولیدشده در نظر گرفته شوند. تمام مؤلفه‌های موجود در داده‌های ورودی که در این فهرست ذکر نشده‌اند، برای خروجی نهایی نادیده گرفته خواهند شد.

--no-color

خروجی رنگی چاپ نشود.

--verbose

نمایش اطلاعات اشکال‌زدایی بیشتر.

--version

نمایش شماره نسخه appstreamcli compose