نام (NAME)

nroff - قالب‌بندی اسناد متنی با groff برای دستگاه‌های متنی و ترمینال

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

nroff [-abcCEhikpRStUVzZ] [-d ctext] [-d string=text] [-D fallback-input-encoding] [-I inclusion-directory] [-K input-encoding] [-m macro-package] [-M macro-directory] [-n page-number] [-o page-list] [-P postprocessor-argument] [-r cnumeric-expression] [-r register=numeric-expression] [-T output-device] [-w warning-category] [-W warning-category] [file ...]

nroff --help

nroff -v [other-nroff-option ...]

nroff --version [other-nroff-option ...]

توضیحات (DESCRIPTION)

دستور nroff اسناد نوشته‌شده به زبان groff(7) را برای دستگاه‌های شبیه به ماشین‌تحریر مانند شبیه‌سازهای ترمینال قالب‌بندی می‌کند. نسخه گنو nroff دستور nroff در AT&T را با استفاده از groff(1) شبیه‌سازی می‌کند. دستور nroff خروجی را از طریق grotty(1) (درایور خروجی ترمینال در groff) تولید می‌کند که باید از طرح کدگذاری نویسه مورد استفاده دستگاه مطلع باشد. در نتیجه، آرگومان‌های مجاز برای گزینه -T عبارتند از ascii، latin1 و utf8؛ هر مقدار دیگری نادیده گرفته می‌شود. اگر نه متغیر محیطی GROFF_TYPESETTER و نه گزینه خط فرمان -T (که متغیر محیطی را لغو می‌کند) دستگاهی (معتبر) را مشخص نکنند، nroff برای انتخاب یک دستگاه خروجی مناسب، محلی‌سازی (locale) را بررسی می‌کند. این برنامه ابتدا locale(1) را امتحان می‌کند، سپس چندین متغیر محیطی مرتبط با محلی‌سازی را بررسی می‌نماید؛ بخش «محیط» در ادامه را ببینید. اگر همه موارد فوق شکست بخورند، nroff مقدار “-T ascii” را فرض می‌کند.

گزینه‌های -a، -b، -c، -C، -d، -E، -i، -I، -m، -M، -n، -o، -r، -U، -w، -W و -z تأثیراتی دارند که در troff(1) شرح داده شده است. گزینه‌های -c و -h به ترتیب به معنای “-P -c” و “-P -h” هستند؛ -c همچنین برای خود troff نیز معنادار است. علاوه بر این، نسخه گنو nroff گزینه‌های -e، -q و -s در nroff مربوط به AT&T را نادیده می‌گیرد. صفحه راهنمای groff(1) گزینه‌های -D، -k، -K، -p، -P، -R، -t، -S و -Z را مستند کرده است. گزینه -V باعث می‌شود nroff دستور ساخته‌شده groff را در جریان خروجی استاندارد نمایش دهد، اما آن را اجرا نکند. گزینه‌های -v و --version اطلاعات نسخه nroff و برنامه‌هایی را که اجرا می‌کند نشان می‌دهند، در حالی که --help پیام راهنمای نحوه استفاده را نمایش می‌دهد؛ همگی پس از آن خارج می‌شوند.

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

در صورت بروز مشکل در تجزیه آرگومان‌ها، nroff با وضعیت 2 خارج می‌شود؛ اگر هر یک از گزینه‌های -V، -v، --version یا --help مشخص شده باشند با وضعیت 0 خارج می‌شود، و در غیر این صورت با وضعیت خروج groff خاتمه می‌یابد.

محیط (ENVIRONMENT)

به طور معمول، جداکننده مسیرها در متغیرهای محیطی که به PATH ختم می‌شوند، دونقطه (:) است؛ این مورد ممکن است بسته به سیستم‌عامل متفاوت باشد. به عنوان مثال، ویندوز در عوض از نقطه ویرگول (;) استفاده می‌کند.

GROFF_BIN_PATH: دستورات groff ابتدا در این دایرکتوری‌ها جستجو می‌شوند و پس از آن در دایرکتوری‌های مشخص‌شده در PATH. اگر تنظیم نشده باشد، دایرکتوری محل نصب فایل‌های اجرایی گنو roff، یعنی /usr/bin، پیش از PATH جستجو می‌شود.
GROFF_TYPESETTER: دستگاه خروجی پیش‌فرض را برای groff مشخص می‌کند.
LC_ALL
LC_CTYPE
LANG
LESSCHARSET: در صورتی که هیچ گزینه -T داده نشده باشد و GROFF_TYPESETTER تنظیم نشده باشد، یا مقادیر مشخص‌شده نامعتبر باشند، به همین ترتیب برای یافتن الگوهای منطبق با کدگذاری‌های نویسه استانداردی که توسط groff پشتیبانی می‌شوند، بررسی می‌شوند.

فایل‌ها (FILES)

/usr/share/groff/1.24.1/tmac/tty-char.tmac: تعاریف جایگزین (fallback) را برای نویسه‌های خاص roff مشخص می‌کند. این تعاریف از نظر بصری نسبت به تعاریف tty.tmac تقریب ضعیف‌تری از خروجی حروف‌چینی‌شده ارائه می‌دهند، اما در عوض انتقال اطلاعات معنایی را ترجیح می‌دهند. دستور nroff آن را به صورت خودکار بارگذاری می‌کند.

نکات (NOTES)

برنامه‌های صفحه‌بند (pager) مانند more(1) و less(1) ممکن است برای مدیریت صحیح برخی توالی‌های خروجی به گزینه‌های خط فرمان نیاز داشته باشند؛ صفحه راهنمای grotty(1) را ببینید.

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

groff(1), troff(1), grotty(1), locale(1), roff(7)