.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH HELP2MAN "1" "December 2022" "GNU help2man 1.49.3" "User Commands"
.SH "نام (NAME)"
help2man \- تولید یک صفحه راهنمای ساده
.SH "خلاصه دستور (SYNOPSIS)"
.B help2man
[\fI\,OPTION\/\fR]... \fI\,EXECUTABLE\/\fR
.SH "توضیحات (DESCRIPTION)"
دستور `help2man' یک صفحه راهنما از خروجی‌های `\-\-help' و `\-\-version' تولید می‌کند.
.TP
\fB\-n\fR, \fB\-\-name\fR=\fI\,STRING\/\fR
توضیح برای بند NAME
.TP
\fB\-s\fR, \fB\-\-section\fR=\fI\,SECTION\/\fR
شماره بخش صفحه راهنما (1, 6, 8)
.TP
\fB\-m\fR, \fB\-\-manual\fR=\fI\,TEXT\/\fR
نام کتابچه راهنما (دستورهای کاربر، ...)
.TP
\fB\-S\fR, \fB\-\-source\fR=\fI\,TEXT\/\fR
منبع برنامه (FSF، Debian، ...)
.TP
\fB\-L\fR, \fB\-\-locale\fR=\fI\,STRING\/\fR
انتخاب محلی‌سازی (پیش‌فرض "C")
.TP
\fB\-i\fR, \fB\-\-include\fR=\fI\,FILE\/\fR
ضمیمه کردن محتوا از `FILE'
.TP
\fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,FILE\/\fR
ضمیمه کردن محتوا از `FILE' در صورت وجود
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
ارسال خروجی به `FILE'
.TP
\fB\-p\fR, \fB\-\-info\-page\fR=\fI\,TEXT\/\fR
نام کتابچه راهنمای Texinfo
.TP
\fB\-N\fR, \fB\-\-no\-info\fR
حذف ارجاع به کتابچه راهنمای Texinfo
.TP
\fB\-l\fR, \fB\-\-libtool\fR
حذف `lt\-' از نام برنامه
.TP
\fB\-\-help\fR
چاپ این راهنما و سپس خروج
.TP
\fB\-\-version\fR
چاپ شماره نسخه و سپس خروج
.PP
فایل اجرایی EXECUTABLE باید گزینه‌های `\-\-help' و `\-\-version' را بپذیرد و در خروجی استاندارد تولید خروجی کند، هرچند گزینه‌های جایگزین را می‌توان با موارد زیر تعیین کرد:
.TP
\fB\-h\fR, \fB\-\-help\-option\fR=\fI\,STRING\/\fR
رشته گزینه راهنما
.TP
\fB\-v\fR, \fB\-\-version\-option\fR=\fI\,STRING\/\fR
رشته گزینه نسخه
.TP
\fB\-\-version\-string\fR=\fI\,STRING\/\fR
رشته نسخه
.TP
\fB\-\-no\-discard\-stderr\fR
شامل کردن stderr هنگام تجزیه خروجی گزینه
.SH "فایل‌های ضمیمه (INCLUDE FILES)"
محتوای بیشتر را می‌توان با گزینه‌های
.B \-\-include
و
.B \-\-opt\-include
در خروجی تولیدشده ضمیمه کرد. قالب آن ساده است:
.PP
.nf
    [section]
    text

    /pattern/
    text
.fi
.PP
بلوک‌هایی از متن عینا *roff یا در ابتدای بخشِ مشخص‌شده‌ی
.BI [ section ]
(بدون حساسیت به بزرگی و کوچکی حروف)، یا پس از بندی مطابق با
.BI / pattern /\fR
در خروجی درج می‌شوند.
.PP
الگوها از نحو عبارات باقاعده پرل استفاده می‌کنند و ممکن است اصلاح‌کننده‌های
.IR i ،
.I s
یا
.I m
را به دنبال داشته باشند (به
.BR perlre (1)
مراجعه کنید).
.PP
خطوط پیش از نخستین بخش یا الگو که با `\-' آغاز می‌شوند به عنوان گزینه پردازش می‌شوند. هر چیز دیگری نادیده گرفته می‌شود و می‌تواند برای یادداشت‌ها، کلیدواژه‌های RCS و موارد مشابه استفاده شود.
.PP
ترتیب بخش‌های خروجی (برای موارد ضمیمه‌شده) به صورت زیر است:
.PP
.nf
    NAME
    SYNOPSIS
    DESCRIPTION
    OPTIONS
    \fIother\fR
    ENVIRONMENT
    FILES
    EXAMPLES
    AUTHOR
    REPORTING BUGS
    COPYRIGHT
    SEE ALSO
.fi
.PP
هر بخش
.B [NAME]
یا
.B [SYNOPSIS]
که در فایل ضمیمه بیاید، جایگزین چیزی خواهد شد که به طور خودکار تولید می‌شد (اگرچه همچنان می‌توانید بخش اول را در صورت نیاز با
.B \-\-name
لغو و بازنویسی کنید).
.PP
سایر بخش‌ها پیش از خروجی خودکار برای بخش‌های استاندارد ارائه‌شده در بالا قرار می‌گیرند، یا در بخش
.I other
(در بالا) به ترتیبی که در فایل ضمیمه دیده شده‌اند اضافه می‌شوند.
.PP
محل قرارگیری متن در داخل بخش را می‌توان به صورت صریح با استفاده از نحو
.RI [< section ]،
.RI [= section ]
یا
.RI [> section ]
مشخص کرد تا متن اضافی به ترتیب قبل، به جای، یا بعد از خروجی پیش‌فرض قرار گیرد.
.SH "در دسترس بودن (AVAILABILITY)"
تازه‌ترین نسخه این توزیع به صورت برخط از نشانی زیر در دسترس است:
.PP
.nf
    ftp://ftp.gnu.org/gnu/help2man
.fi
.SH "نویسنده (AUTHOR)"
نوشته‌شده توسط Brendan O'Dea <bod@debian.org>
.SH "گزارش باگ‌ها (REPORTING BUGS)"
گزارش اشکالات به <bug\-help2man@gnu.org>.
.SH "حق نشر (COPYRIGHT)"
حق نشر \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021, 2022 Free Software
Foundation, Inc.
.br
این یک نرم‌افزار آزاد است؛ برای شرایط رونوشت‌برداری به کد منبع مراجعه کنید. هیچ ضمانتی وجود ندارد؛ حتی برای قابلیت فروش یا تناسب با یک هدف خاص.
.SH "همچنین ببینید (SEE ALSO)"
مستندات کامل برای
.B help2man
به عنوان یک کتابچه راهنمای Texinfo نگهداری می‌شود. اگر برنامه‌های
.B info
و
.B help2man
به طور مناسب در سیستم شما نصب شده باشند، دستور
.IP
.B info help2man
.PP
باید دسترسی شما به کتابچه راهنمای کامل را فراهم کند.