.\" Man page generated from reStructuredText.
.
.TH G-IR-SCANNER 1 "" "" ""
.SH "نام (NAME)"
g-ir-scanner \- استخراج فراداده‌های C از کد منبع و سرآیندها
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH "خلاصه دستور (SYNOPSIS)"
.sp
\fBg\-ir\-scanner\fP [OPTION...] FILES...
.SH "توضیحات (DESCRIPTION)"
.sp
برنامهٔ \fBg\-ir\-scanner\fP ابزاری است که با تجزیهٔ سرآیندها و درون‌نگری (introspection) کتابخانه‌های مبتنی بر GObject، فایل‌های GIR XML را تولید می‌کند. این ابزار معمولاً در طول مرحلهٔ ساخت عادی یک پروژه فراخوانی می‌شود و اطلاعات روی دیسک ذخیره شده و بعداً نصب می‌شوند تا انقیادهای زبان (language bindings) و سایر برنامه‌ها بتوانند از آن‌ها استفاده کنند. فایل‌های سرآیند و فایل‌های منبع به‌عنوان آرگومان در خط فرمان داده می‌شوند. پسوند فایل مشخص می‌کند که با فایل به‌عنوان یک فایل منبع (.c) برخورد شود یا یک فایل سرآیند (.h). در حال حاضر پویشگر فقط از کتابخانه‌های مبتنی بر C پشتیبانی می‌کند.
.SH "گزینه‌ها (OPTIONS)"
.INDENT 0.0
.TP
.B \-\-help
نمایش گزینه‌های راهنما.
.TP
.B \-\-quiet
در صورت ارسال، جزئیات عملیات عادی را چاپ نمی‌کند.
.TP
.B \-\-warn\-all
نمایش هشدارها برای APIهای عمومی که قابل درون‌نگری نیستند.
.TP
.B \-\-warn\-error
تبدیل هشدارها به خطاهای مهلک.
.TP
.B \-\-strict
نمایش هشدارها برای API با درون‌نگری سخت‌گیرانه (strict).
.TP
.BI \-\-format\fB= FORMAT
این پارامتر قالب خروجی مورد استفاده را تعیین می‌کند. مقدار پیش‌فرض gir است.
.TP
.BI \-\-include\fB= NAME
افزودن وابستگی درون‌نگری مشخص‌شده به فضای نام (namespace) پویش‌شده. NAME به شکل NAMESPACE\-VERSION است، مانند Gtk\-3.0.
.TP
.BI \-\-include\-uninstalled\fB= PATH
افزودن وابستگی درون‌نگری مشخص‌شده به فضای نام پویش‌شده. تفاوت این گزینه با \fB\-\-include\fP در این است که مسیر یک فایل را دریافت می‌کند و وابستگی‌های pkg\-config را پردازش نمی‌کند (زیرا ممکن است هنوز نصب نشده باشند).
.TP
.BI \-\-add\-include\-path\fB= PATH
افزودن یک دایرکتوری به مسیری که پویشگر برای یافتن فایل‌های GIR از آن استفاده می‌کند. می‌تواند چندین بار برای مشخص کردن چندین دایرکتوری استفاده شود.
.TP
.BI \-i\fP,\fB  \-\-library\fB= LIBRARY
کتابخانه‌ای را مشخص می‌کند که باید درون‌نگری شود. این بدین معناست که توابع *_get_type() درون آن برای نوع‌داده‌های GObject فراخوانی خواهند شد. نام کتابخانه نباید شامل پیشوند ابتدایی lib یا پسوند پایانی کتابخانهٔ مشترک باشد.
.TP
.BI \-L\fP,\fB  \-\-library\-path\fB= PATH
گنجاندن این دایرکتوری هنگام جستجو برای یک کتابخانه. این گزینه می‌تواند چندین بار برای اضافه کردن بیش از یک دایرکتوری جهت جستجوی کتابخانه‌ها مشخص شود.
.TP
.BI \-I\fB directory
گنجاندن این دایرکتوری در فهرست دایرکتوری‌هایی که برای فایل‌های سرآیند جستجو می‌شوند. لازم است تمام دایرکتوری‌هایی را که در حالت عادی هنگام استفاده از فایل‌های منبع مشخص‌شده به کامپایلر می‌دهید، به پویشگر نیز ارسال کنید.
.TP
.BI \-\-c\-include\fB= C_INCLUDES
سرآیندهایی که باید در برنامه‌های C گنجانده شوند. این گزینه می‌تواند چندین بار برای گنجاندن بیش از یک سرآیند مشخص شود.
.TP
.BI \-n\fP,\fB  \-\-namespace\fB= NAME
نام فضای نام (namespace). این نام باید با حروف بزرگ آغاز شود؛ برای مثال حرف اول باید بزرگ باشد. نمونه‌ها: Gtk، Clutter، WebKit.
.TP
.B \-\-no\-libtool
غیرفعال کردن استفاده از libtool برای کامپایل باینری ساختگی (stub) درون‌نگری. اگر سیستم ساخت شما نیازی به libtool ندارد، از این گزینه استفاده کنید.
.TP
.B \-\-libtool
مسیر کامل فایل اجرایی libtool. معمولاً برای سیستم‌های Automake استفاده می‌شود.
.TP
.BI \-\-nsversion\fB= VERSION
نسخهٔ فضای نام؛ برای نمونه 1.0. این معمولاً نسخهٔ پلتفرم است، مانند 2.0 برای Gtk+ و نه 2.12.7.
.TP
.BI \-p\fP,\fB  \-\-program\fB= PROGRAM
یک باینری را مشخص می‌کند که باید درون‌نگری شود. این بدان معناست که توابع *_get_type() در آن برای نوع‌داده‌های GObject فراخوانی خواهند شد. باینری باید طوری اصلاح شده باشد که گزینهٔ \fB\-\-introspect\-dump=\fP را بپذیرد و آرگومان ارسالی به این تابع را به g_irepository_dump بفرستد.
.TP
.BI \-\-program\-arg\fB= ARG
آرگومان اضافی برای ارسال به برنامه جهت درون‌نگری.
.TP
.BI \-\-identifier\-prefix\fB= PREFIX
این گزینه می‌تواند چندین بار مشخص شود. هر کدام پیشوندی را مشخص می‌کند که از تمام شناسه‌های C حذف خواهد شد. اگر مقداری مشخص نشود، از فضای نام استفاده خواهد شد. برای مثال، پیشوند شناسهٔ Foo، شناسهٔ typdef struct _FooBar FooBar; را به‌صورت Foo.Bar صادر می‌کند.
.TP
.BI \-\-symbol\-prefix\fB= PREFIX
این گزینه می‌تواند چندین بار مشخص شود. هر کدام پیشوندی را مشخص می‌کند که از تمام نمادهای C حذف خواهد شد. برای مثال، پیشوند نماد foo نماد foo_bar_do_something را به‌صورت Foo.Bar.do_something صادر می‌کند.
.TP
.B \-\-accept\-unprefixed
در صورت تعیین، پویشگر شناسه‌ها و نمادهایی را که با پیشوند فضای نام مطابقت ندارند، خواهد پذیرفت. در صورت امکان از استفاده از این گزینه خودداری کنید.
.TP
.BI \-\-output\fB= FILENAME
نام فایل خروجی. معمولاً به‌صورت نام فضای نام + پسوند قالب؛ مانند GLib\-2.0.gir.
.TP
.BI \-\-pkg\fB= PACKAGE
فهرست بسته‌های pkg\-config که پرچم‌های کامپایلر و پیونددهنده از آن‌ها دریافت می‌شود. این گزینه می‌تواند چندین بار برای گنجاندن پرچم‌ها از چند بستهٔ pkg\-config مشخص شود.
.TP
.BI \-\-pkg\-export\fB= PACKAGE
فهرست بسته‌های pkg\-config که توسط gir تولیدشده ارائه می‌شوند. اگر gir بسته‌های بیشتری ارائه دهد، این گزینه می‌تواند چندین بار مشخص شود. در صورت عدم تعیین، بسته‌های مشخص‌شده با \fB\-\-pkg=\fP استفاده خواهند شد.
.TP
.BI \-\-compiler\fB= COMPILER
کامپایلر C که به‌صورت داخلی توسط g\-ir\-scanner هنگام درون‌نگری اطلاعات نوع زمان اجرا مانند ویژگی‌ها، سیگنال‌ها، اجداد و رابط‌های پیاده‌سازی‌شده استفاده می‌شود. این گزینه دارای همان معناشناسی متغیر محیطی \fBCC\fP است.
.TP
.B \-\-verbose
حالت پرگو؛ شامل برخی اطلاعات اشکال‌زدایی.
.UNINDENT
.SH "محیط (ENVIRONMENT)"
.sp
ابزار g\-ir\-scanner از متغیر \fBXDG_DATA_DIRS\fP برای بررسی دایرکتوری‌ها استفاده می‌کند؛ فایل‌های gir در \fBXDG_DATA_DIRS/gir\-1.0\fP قرار دارند. این متغیر معمولاً توسط توزیع مقداردهی می‌شود، بنابراین نیازی نیست خودتان آن را تنظیم کنید.
.sp
متغیر \fBGI_SCANNER_DISABLE_CACHE\fP تضمین می‌کند که پویشگر داده‌های حافظهٔ موقت (cache) را در \fB$HOME\fP ننویسد.
.sp
متغیر \fBGI_SCANNER_DEBUG\fP می‌تواند برای اشکال‌زدایی مشکلات مربوط به g\-ir\-scanner در سیستم ساخت به کار رود. هنگامی که مقدار آن روی \fBsave\-temps\fP تنظیم شود، g\-ir\-scanner پس از پایان کار، فایل‌ها و دایرکتوری‌های موقت را حذف نخواهد کرد.
.sp
متغیر \fBGI_HOST_OS\fP می‌تواند برای کنترل نام سیستم‌عامل روی میزبانی که پویشگر را اجرا می‌کند، استفاده شود. این متغیر دارای همان معناشناسی ویژگی \fBos.name\fP در پایتون است.
.sp
متغیر \fBGI_CROSS_LAUNCHER\fP می‌تواند برای کپسوله‌سازی باینری درون‌نگری GType تولیدشده توسط g\-ir\-scanner قبل از اجرای آن استفاده شود. این متغیر هنگام تولید داده‌های درون‌نگری در یک محیط کامپایل چندسکویی (cross-compilation) مفید است.
.SH "گزارش باگ‌ها (BUGS)"
.sp
گزارش باگ‌ها در \fI\%https://gitlab.gnome.org/GNOME/gobject\-introspection/issues\fP
.SH "صفحه اصلی و تماس (HOMEPAGE AND CONTACT)"
.sp
\fI\%https://gi.readthedocs.io\fP
.SH "نویسندگان (AUTHORS)"
.sp
Johan Dahlin
.\" Generated by docutils manpage writer.
.