نام (NAME)

bomtool — ابزار بررسی صورت‌مواد نرم‌افزاری (Software Bill of Materials)

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

bomtool [options] module ...

توضیحات (DESCRIPTION)

bomtool برنامه‌ای است که یک صورت‌مواد نرم‌افزاری (SBOM) متنی مبتنی بر SPDX 2.0 را برای مجموعه‌ای مشخص از ماژول‌های pkg-config تولید می‌کند. خروجی این ابزار در صورت نیاز می‌تواند به سایر قالب‌های SBOM تبدیل شود.

گزینه‌ها (OPTIONS)

گزینه‌ها به شرح زیر هستند:

--about

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

--version

شماره نسخهٔ برنامهٔ bomtool را در خروجی استاندارد چاپ کرده و خارج می‌شود. بیشتر گزینه‌های دیگر و تمام آرگومان‌های خط فرمان نادیده گرفته می‌شوند.

--define-variable=varname=value

متغیر varname را با مقدار value تعریف می‌کند. متغیرها در خروجی پرس‌وجو استفاده می‌شوند، و ممکن است نتایج برخی ماژول‌ها بر اساس وجود تعریف متغیر تغییر کند.

--creation-time time

به‌جای زمان کنونی، از time به‌عنوان مقدار فیلد Created در SBOM تولیدشده استفاده می‌کند. استاندارد SPDX استفاده از زمان با قالب ISO 8601 را توصیه می‌کند، یعنی: YYYY-MM-DDThh:mm:ssZ. این گزینه نسبت به متغیر محیطی SOURCE_DATE_EPOCH اولویت دارد.

--output file

صورت‌مواد نرم‌افزاری (SBOM) تولیدشده را به‌جای خروجی استاندارد، در file می‌نویسد.

محیط (ENVIRONMENT)

PKG_CONFIG_DEBUG_SPEW

در صورت تنظیم شدن، پیام‌های اشکال‌زدایی (دیباگ) را در خطای استاندارد (stderr) چاپ می‌کند.

PKG_CONFIG_IGNORE_CONFLICTS

در صورت تنظیم شدن، قوانین Conflicts (تداخل‌ها) در ماژول‌ها نادیده گرفته می‌شوند. این متغیر اثری مشابه با گزینهٔ --ignore-conflicts در pkgconf(1) دارد.

PKG_CONFIG_LIBDIR

فهرستی جداشده با دو نقطه (:) از دایرکتوری‌های با اولویت پایین که فایل‌های pc(5) در آن‌ها جستجو می‌شوند. مسیر جستجوی ماژول با افزودن این فهرست به انتهای PKG_CONFIG_PATH (که اولویت بالاتری دارد) ساخته می‌شود. اگر PKG_CONFIG_LIBDIR تعریف نشده باشد، فهرست پیش‌فرض کامپایل‌شده در برنامهٔ bomtool از ماکروی پیش‌پردازندهٔ PKG_DEFAULT_PATH به‌جای آن اضافه می‌شود. اگر PKG_CONFIG_LIBDIR تعریف شده ولی خالی باشد، چیزی اضافه نخواهد شد.

PKG_CONFIG_MAXIMUM_TRAVERSE_DEPTH

محدودیتی برای عمق مجاز پیمایش در گراف وابستگی اعمال می‌کند.

PKG_CONFIG_PATH

فهرستی جداشده با دو نقطه (:) از دایرکتوری‌های با اولویت بالا که فایل‌های pc(5) در آن‌ها جستجو می‌شوند.

PKG_CONFIG_PRELOADED_FILES

فهرستی جداشده با دو نقطه (:) از فایل‌های pc(5) که پیش از هر فایل pkg-config دیگری بارگذاری می‌شوند. به این بسته‌ها بالاترین اولویت نسبت به هر فایل pc(5) دیگری داده می‌شود که در غیر این صورت بستهٔ مشخص‌شده را ارائه می‌کردند.

SOURCE_DATE_EPOCH

اگر تنظیم شده باشد و گزینهٔ --creation-time داده نشده باشد، فیلد Created در SBOM تولیدشده به‌جای زمان کنونی از این برچسب زمانی یونیکس (UNIX timestamp) گرفته می‌شود که امکان تولید بازتولیدپذیر (reproducible) صورت‌مواد نرم‌افزاری را فراهم می‌آورد.

کدهای خروج (EXIT STATUS)

The bomtool utility exits 0 on success, and >0 if an error occurs.

مثال‌ها (EXAMPLES)

تولید یک SBOM برای بسته‌ای به نام foo:

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

pc(5), pkgconf(1)

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

برنامهٔ bomtool و این صفحهٔ راهنما توسط نویسندگان pkgconf (پروندهٔ AUTHORS را ببینید) نوشته شده است.