\" SPDX-FileCopyrightText: 2021 GNOME Foundation
\" SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
.TH GI\-DOCGEN "1" "" "gi-docgen 2021.3" "User Commands"
.SH "نام (NAME)"
gi-docgen \- ابزار تولید مستندات با استفاده از gobject\-introspection
.SH "خلاصه دستور (SYNOPSIS)"
.sp
\fBgi\-docgen\fP COMMAND [OPTION...] GIR_FILE
.SH "توضیحات (DESCRIPTION)"
.sp
‏GI\-DocGen یک ابزار تولید مستندات برای کتابخانه‌های مبتنی بر GObject است. سامانهٔ GObject سیستم نوع پایه (base type system) پروژهٔ GNOME است. GI\-DocGen از داده‌های درون‌نگری (introspection) ماشین‌خوان ارائه‌شده توسط کتابخانه‌های مبتنی بر GObject برای تولید مرجع API این کتابخانه‌ها و سایر مستندات تکمیلی استفاده می‌کند.
.sp
فایل اجرایی اصلی gi\-docgen زیردستورهای گوناگونی را برای دسترسی به تمام عملکردهای خود ارائه می‌دهد.

.SH "گزینه‌های عمومی (COMMON OPTIONS)"
.sp
همهٔ دستورها گزینه‌های زیر را دارند:

.TP
.B \-\-quiet
عدم چاپ جزئیات عملیات جاری
.TP
.B \-\-fatal\-warnings
تبدیل هشدارها به خطاهای مهلک
.TP
.B \-\-help
چاپ راهنمای خط فرمان

.SH "دستور generate (THE GENERATE COMMAND)"
.sp
دستور \fBgenerate\fR قابلیت اصلی gi\-docgen را ارائه می‌دهد.

.B gi-docgen generate [
.I OPTIONS
.B ] [
.I GIR_FILE
.B ]

.sp
دستور generate فایل GIR داده‌شده و وابستگی‌های آن را تجزیه کرده و یک مرجع API برای فضای نام یافت‌شده در داده‌های درون‌نگری ایجاد می‌کند. پروژه‌ها می‌توانند از یک فایل پیکربندی برای کنترل جنبه‌های خروجی و همچنین ارائهٔ محتوای اضافی که باید در مستندات گنجانده شود، استفاده کنند.

.SS "گزینه‌ها:"
.TP
.BI \-\-config\fB= FILE
استفاده از فایل پیکربندی پروژه داده‌شده
.TP
.BI \-\-content\-dir\fB= PATH
مشخص کردن دایرکتوری‌ای که فایل‌های محتوای فهرست‌شده در فایل پیکربندی پروژه در آن قرار دارند
.TP
.BI \-\-templates\-dir\fB= PATH
مشخص کردن دایرکتوری‌ای که قالب‌های مورداستفاده برای تولید مستندات در آن قرار دارند
.TP
.BI \-\-theme\-name\fB= NAME
مشخص کردن نام قالب مورداستفاده هنگام تولید مستندات، که بر پیکربندی پروژه برتری خواهد داشت
.TP
.BI \-\-output\-dir\fB= PATH
ایجاد مستندات در دایرکتوری داده‌شده
.TP
.B \-\-no\-namespace\-dir
تولید مستقیم تمام فایل‌های مستندات در دایرکتوری خروجی، به جای ایجاد دایرکتوری با استفاده از نام و نسخهٔ فضای نام
.TP
.BI \-\-add\-include\-path\fB= PATH
افزودن یک دایرکتوری به مسیری که پویشگر (scanner) برای یافتن فایل‌های GIR از آن استفاده می‌کند. می‌تواند چندین بار برای مشخص کردن چندین دایرکتوری استفاده شود
.TP
.BI \-\-section\fB= NAME
تولید مستندات تنها برای بخش داده‌شده. می‌تواند چندین بار برای مشخص کردن چندین بخش استفاده شود. بخش‌های پشتیبانی‌شده عبارتند از \fIaliases\fR، \fIbitfields\fR، \fIclasses\fR، \fIdomains\fR، \fIenums\fR، \fIinterfaces\fR، \fIstructs\fR و \fIunions\fR. مقادیر ویژه عبارتند از \fIall\fR به معنای همهٔ بخش‌ها (پیش‌فرض)؛ و \fInone\fR به معنای هیچ بخشی
.TP
.B \-\-dry\-run
تجزیهٔ \fIGIR_FILE\fR بدون تولید مستندات

.SH "دستور gen-index (THE GEN-INDEX COMMAND)"
.sp
دستور \fBgen-index\fR نمایه‌ای از نمادها و اصطلاحات تولید می‌کند که می‌تواند برای جستجو در مستندات تولیدشده توسط gi\-docgen استفاده شود.

.B gi-docgen gen-index [
.I OPTIONS
.B ] [
.I GIR_FILE
.B ]

.sp
نمایهٔ تولیدشده فایلی با قالب JSON به نام \fIindex.json\fR است.

.SS "گزینه‌ها:"
.TP
.BI \-\-config\fB= FILE
استفاده از فایل پیکربندی پروژه داده‌شده
.TP
.BI \-\-content\-dir\fB= PATH
مشخص کردن دایرکتوری‌ای که فایل‌های محتوای فهرست‌شده در فایل پیکربندی پروژه در آن قرار دارند
.TP
.BI \-\-output\-dir\fB= PATH
ایجاد نمایه در دایرکتوری داده‌شده
.TP
.BI \-\-add\-include\-path\fB= PATH
افزودن یک دایرکتوری به مسیری که پویشگر برای یافتن فایل‌های GIR از آن استفاده می‌کند. می‌تواند چندین بار برای مشخص کردن چندین دایرکتوری استفاده شود
.TP
.B \-\-dry\-run
تجزیهٔ \fIGIR_FILE\fR بدون تولید مستندات

.SH "دستور check (THE CHECK COMMAND)"
.sp
دستور \fBcheck\fR مجموعه‌ای از بررسی‌ها را روی فایل درون‌نگری اجرا می‌کند تا اطمینان حاصل شود که API عمومی به‌درستی مستندسازی شده است. این دستور می‌تواند به عنوان بخشی از یک مجموعه آزمون استفاده شود.

.B gi-docgen check [
.I OPTIONS
.B ] [
.I GIR_FILE
.B ]

.SS "گزینه‌ها:"
.TP
.BI \-\-config\fB= FILE
استفاده از فایل پیکربندی پروژه داده‌شده
.TP
.BI \-\-add\-include\-path\fB= PATH
افزودن یک دایرکتوری به مسیری که پویشگر برای یافتن فایل‌های GIR از آن استفاده می‌کند. می‌تواند چندین بار برای مشخص کردن چندین دایرکتوری استفاده شود

.SH "دستور serve (THE SERVE COMMAND)"
.sp

دستور \fBserve\fR یک مرجع API تولید کرده و آن را با استفاده از یک کارساز محلی HTTP ارائه می‌دهد.

.B gi-docgen serve [
.I OPTIONS
.B ] [
.I GIR_FILE
.B ]

.sp
دستور serve فایل GIR داده‌شده و وابستگی‌های آن را تجزیه کرده و یک مرجع API برای فضای نام موجود در داده‌های درون‌نگری می‌سازد. پس از ساخت موفقیت‌آمیز مرجع، gi\-docgen یک کارساز محلی HTTP را که به دایرکتوری خروجی اشاره دارد، راه‌اندازی می‌کند.

.SS "گزینه‌ها:"
.TP
.BI \-\-bind\fB= ADDRESS
استفاده از آدرس داده‌شده برای کارساز HTTP؛ مقدار پیش‌فرض 127.0.0.1 است
.TP
.BI \-\-port\fB= PORT
استفاده از درگاه داده‌شده برای کارساز HTTP؛ مقدار پیش‌فرض 8080 است

.SH "دستور help (THE HELP COMMAND)"
.sp
دستور \fBhelp\fR راهنمای خط فرمان را چاپ می‌کند. اگر هنگام فراخوانی gi\-docgen هیچ دستور یا گزینه‌ای را مشخص نکنید، دستور help به‌طور ضمنی اجرا خواهد شد.

.B gi-docgen help [
.I OPTIONS
.B ] [
.I COMMAND
.B ]

.sp
اگر هیچ دستوری مشخص نشود، help فهرست دستورها را چاپ می‌کند.
.sp
اگر دستوری مشخص شود، help راهنمای خط فرمان آن برنامه را چاپ می‌کند.

.SS "گزینه‌ها:"
.TP
.B \-\-version
چاپ نسخهٔ gi\-docgen

.SH "وضعیت خروج (EXIT STATUS)"

.TP
.B 0
دستور با موفقیت انجام شد.
.TP
.B 1
خطا یا هشداری رخ داد.

.SH "متغیرهای محیطی (ENVIRONMENT VARIABLES)"
.sp
فایل اجرایی gi\-docgen از متغیرهای محیطی \fBXDG_DATA_DIRS\fP و \fBXDG_DATA_HOME\fP برای جستجوی داده‌های درون‌نگریِ گنجانده‌شده در فایل GIR استفاده می‌کند.
.sp
اگر متغیر محیطی \fBGIDOCGEN_DEBUG\fP تنظیم شده باشد، gi\-docgen پیام‌های اضافه‌ای چاپ خواهد کرد که می‌تواند هنگام اشکال‌زدایی مفید باشد.

.SH "همچنین ببینید (SEE ALSO)"
.sp
GI\-DocGen: http://gnome.pages.gitlab.gnome.org/gi-docgen
.sp
GObject\-Introspection: https://gi.readthedocs.org
.sp
GObject: https://developer.gnome.org/gobject