HELP2MAN(1)                      User Commands                     HELP2MAN(1)

نام (NAME)
       help2man - تولید یک صفحه راهنمای ساده

خلاصه دستور (SYNOPSIS)
       help2man [OPTION]... EXECUTABLE

توضیحات (DESCRIPTION)
       دستور `help2man' یک صفحه راهنما از خروجی‌های `--help' و `--version'
       تولید می‌کند.

       -n, --name=STRING
              توضیح برای بند NAME

       -s, --section=SECTION
              شماره بخش صفحه راهنما (1, 6, 8)

       -m, --manual=TEXT
              نام کتابچه راهنما (دستورهای کاربر، ...)

       -S, --source=TEXT
              منبع برنامه (FSF، Debian، ...)

       -L, --locale=STRING
              انتخاب محلی‌سازی (پیش‌فرض "C")

       -i, --include=FILE
              ضمیمه کردن محتوا از `FILE'

       -I, --opt-include=FILE
              ضمیمه کردن محتوا از `FILE' در صورت وجود

       -o, --output=FILE
              ارسال خروجی به `FILE'

       -p, --info-page=TEXT
              نام کتابچه راهنمای Texinfo

       -N, --no-info
              حذف ارجاع به کتابچه راهنمای Texinfo

       -l, --libtool
              حذف `lt-' از نام برنامه

       --help چاپ این راهنما و سپس خروج

       --version
              چاپ شماره نسخه و سپس خروج

       فایل اجرایی EXECUTABLE باید گزینه‌های `--help' و `--version' را بپذیرد و
       در خروجی استاندارد تولید خروجی کند، هرچند گزینه‌های جایگزین را می‌توان با
       موارد زیر تعیین کرد:

       -h, --help-option=STRING
              رشته گزینه راهنما

       -v, --version-option=STRING
              رشته گزینه نسخه

       --version-string=STRING
              رشته نسخه

       --no-discard-stderr
              شامل کردن stderr هنگام تجزیه خروجی گزینه

فایل‌های ضمیمه (INCLUDE FILES)
       محتوای بیشتر را می‌توان با گزینه‌های --include و --opt-include در خروجی
       تولیدشده ضمیمه کرد. قالب آن ساده است:

           [section]
           text

           /pattern/
           text

       بلوک‌هایی از متن عینا *roff یا در ابتدای بخشِ مشخص‌شده‌ی [section] (بدون
       حساسیت به بزرگی و کوچکی حروف)، یا پس از بندی مطابق با /pattern/ در
       خروجی درج می‌شوند.

       الگوها از نحو عبارات باقاعده پرل استفاده می‌کنند و ممکن است
       اصلاح‌کننده‌های i، s یا m را به دنبال داشته باشند (به perlre(1) مراجعه
       کنید).

       خطوط پیش از نخستین بخش یا الگو که با `-' آغاز می‌شوند به عنوان گزینه
       پردازش می‌شوند. هر چیز دیگری نادیده گرفته می‌شود و می‌تواند برای
       یادداشت‌ها، کلیدواژه‌های RCS و موارد مشابه استفاده شود.

       ترتیب بخش‌های خروجی (برای موارد ضمیمه‌شده) به صورت زیر است:

           NAME
           SYNOPSIS
           DESCRIPTION
           OPTIONS
           other
           ENVIRONMENT
           FILES
           EXAMPLES
           AUTHOR
           REPORTING BUGS
           COPYRIGHT
           SEE ALSO

       هر بخش [NAME] یا [SYNOPSIS] که در فایل ضمیمه بیاید، جایگزین چیزی خواهد
       شد که به طور خودکار تولید می‌شد (اگرچه همچنان می‌توانید بخش اول را در
       صورت نیاز با --name لغو و بازنویسی کنید).

       سایر بخش‌ها پیش از خروجی خودکار برای بخش‌های استاندارد ارائه‌شده در بالا
       قرار می‌گیرند، یا در بخش other (در بالا) به ترتیبی که در فایل ضمیمه دیده
       شده‌اند اضافه می‌شوند.

       محل قرارگیری متن در داخل بخش را می‌توان به صورت صریح با استفاده از نحو
       [<section]، [=section] یا [>section] مشخص کرد تا متن اضافی به ترتیب
       قبل، به جای، یا بعد از خروجی پیش‌فرض قرار گیرد.

در دسترس بودن (AVAILABILITY)
       تازه‌ترین نسخه این توزیع به صورت برخط از نشانی زیر در دسترس است:

           ftp://ftp.gnu.org/gnu/help2man

نویسنده (AUTHOR)
       نوشته‌شده توسط Brendan O'Dea <bod@debian.org>

گزارش باگ‌ها (REPORTING BUGS)
       گزارش اشکالات به <bug-help2man@gnu.org>.

حق نشر (COPYRIGHT)
       حق نشر © 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.
       این یک نرم‌افزار آزاد است؛ برای شرایط رونوشت‌برداری به کد منبع مراجعه
       کنید. هیچ ضمانتی وجود ندارد؛ حتی برای قابلیت فروش یا تناسب با یک هدف
       خاص.

همچنین ببینید (SEE ALSO)
       مستندات کامل برای help2man به عنوان یک کتابچه راهنمای Texinfo نگهداری
       می‌شود. اگر برنامه‌های info و help2man به طور مناسب در سیستم شما نصب شده
       باشند، دستور

              info help2man

       باید دسترسی شما به کتابچه راهنمای کامل را فراهم کند.

GNU help2man 1.49.3              December 2022                     HELP2MAN(1)