گزینه‌های بسته (PACKAGE OPTIONS)

بستهٔ latex2man گزینه‌های زیر را می‌پذیرد:

fancy

استفاده از بستهٔ LaTeX با نام fancyheadings.

fancyhdr

استفاده از بستهٔ LaTeX با نام fancyhdr.

nofancy

نه از بستهٔ LaTeX با نام fancyheadings و نه از fancyhdr استفاده نمی‌شود.

گزینهٔ پیش‌فرض را می‌توان در فایل latex2man.cfg مشخص کرد.

محیط‌های خاص بسته (PACKAGE SPECIFIC ENVIRONMENTS)

محیط‌های زیر توسط این بسته ارائه می‌شوند:

\begin{Name}{chapter}{name}{author}{info}{title}

محیط Name پنج آرگومان می‌گیرد: ۱. فصل صفحهٔ راهنما، ۲. نام صفحهٔ راهنما، ۳. نویسنده، ۴. اطلاعاتی کوتاه دربارهٔ ابزار که در خط پاصفحهٔ صفحهٔ راهنما چاپ می‌شود، و ۵. متنی که به عنوان عنوان برای HTML و LaTeX استفاده می‌شود (برای خروجی صفحهٔ راهنما یا TeXinfo نادیده گرفته می‌شود). محیط Name باید نخستین محیط در سند باشد. پردازش با این محیط آغاز می‌شود. هر متنی پیش از آن نادیده گرفته می‌شود (استثنا: دستورهای setVersion و setDate). (توجه: تمام آرگومان‌های \begin{Name} باید در یک خط نوشته شوند).

\begin{Table}[width]{columns}

محیط Table دو آرگومان می‌گیرد: نخستین آرگومانِ اختیاری پهنای ستون آخر را مشخص می‌کند، و دومی تعداد ستون‌ها را تعیین می‌کند. برای نمونه:

\begin{Table}[2cm]{3}
Here & am & I \\\hline
A 1 & A 2 & A 3 1 2 3 4 5 A 3 1 2 3 4 5 \\
B 1 & B 2 & B 3 \\
\end{Table}

به‌صورت زیر حروف‌چینی خواهد شد:

اگر آرگومان اختیاری width داده نشود، همهٔ مدخل‌ها چپ‌چین حروف‌چینی می‌شوند. مقدار width طولی است که به‌صورت مطلق برحسب cm اندازه‌گیری می‌شود. در پردازش با LaTeX، ستون آخر به‌صورت یک ستون p{width} حروف‌چینی می‌شود. ترجمه به دستورهای troff(1) منجر به مشخصهٔ ستون lw(width) می‌شود. ترجمه به HTML و TexInfo پارامتر width را نادیده می‌گیرد.

می‌توان از \hline استفاده کرد.

اگر صفحهٔ راهنما با troff(1) قالب‌بندی شود و جدول‌ها به کار رفته باشند، پیش‌پردازندهٔ tbl(1) باید فراخوانی شود، که معمولاً با دادن گزینهٔ -t به فراخوانی troff(1) انجام می‌گیرد. هنگام مشاهدهٔ صفحهٔ راهنمای تولیدشده با استفاده از man(1)، ابزار tbl(1) به‌صورت خودکار فراخوانی می‌شود.

\begin{Description}

همانند \begin{description} است.

\begin{Description}[label]

مشابه \begin{description} است، با این تفاوت که برچسب‌های موارد حداقل هم‌اندازه با کلمهٔ (اختیاری) label خواهند بود. این تفاوت تنها در خروجی DVI و PDF قابل مشاهده است، نه در خروجی troff، TexInfo یا HTML.

محیط‌های LaTeX پذیرفته‌شده (ACCEPTED LaTeX ENVIRONMENTS)

محیط‌های زیر پذیرفته می‌شوند:

*

description

*

enumerate

*

itemize

*

verbatim

*

center

آن‌ها می‌توانند تو در تو باشند:

*

Itemize و center تو در تو:
یک خط وسط‌چین‌شده.

خط وسط‌چین‌شدهٔ دیگر.

*

موردی دیگر و enumerate تو در تو

دستورهای زیر ارائه شده‌اند:

\Opt{option}

گزینه: \Opt{-o} به‌صورت -o حروف‌چینی می‌شود.

\Arg{argument}

آرگومان: \Arg{filename} به‌صورت filename حروف‌چینی می‌شود.

\OptArg{option}{argument}

گزینه به همراه آرگومان:
\OptArg{-o}{filename} به‌صورت -ofilename حروف‌چینی می‌شود.

\OptoArg{option}{argument}

گزینه به همراه آرگومان اختیاری:
\OptoArg{-o}{filename} به‌صورت -o[filename] حروف‌چینی می‌شود.

\oOpt{option}

گزینه اختیاری، برای مثال \oOpt{-o} به‌صورت [-o] حروف‌چینی می‌شود.

\oArg{argument}

آرگومان اختیاری، برای مثال \oArg{filename} به‌صورت [filename] حروف‌چینی می‌شود.

\oOptArg{option}{argument}

گزینه اختیاری همراه با آرگومان، برای مثال
\oOptArg{-o}{filename} به‌صورت [-ofilename] حروف‌چینی می‌شود.

\oOptoArg{option}{argument}

گزینه اختیاری با آرگومان اختیاری، برای مثال
\oOptoArg{-o}{filename} به‌صورت [-o[filename]] حروف‌چینی می‌شود.

\File{filename}

برای حروف‌چینی نام فایل‌ها استفاده می‌شود، برای مثال \File{filename} به‌صورت filename حروف‌چینی می‌شود.

\Prog{prog}

برای حروف‌چینی نام برنامه‌ها استفاده می‌شود، برای مثال \Prog{latex2man} به‌صورت latex2man حروف‌چینی می‌شود.

\Cmd{command}{chapter}

برای حروف‌چینی ارجاع‌ها به سایر دستورها استفاده می‌شود، برای مثال
\Cmd{latex2man}{1} به‌صورت latex2man(1) حروف‌چینی می‌شود.

\Bar

به‌صورت | حروف‌چینی می‌شود.

\Bs

(BackSlash) به‌صورت \ حروف‌چینی می‌شود.

\Tilde

به‌صورت یک ~ حروف‌چینی می‌شود.

\Dots

به‌صورت ... حروف‌چینی می‌شود.

\Bullet

به‌صورت * حروف‌چینی می‌شود.

\setVersion{..}

مقدار .. را به‌عنوان اطلاعات نسخه تنظیم می‌کند.

\setVersionWord{..}

مقدار .. را برای کلمه Version: در خط پاورقی تنظیم می‌کند.
پیش‌فرض \setVersionWord{Version:} است.

\Version

اطلاعات نسخه را برمی‌گرداند.

\setDate{..}

مقدار .. را به‌عنوان اطلاعات تاریخ تنظیم می‌کند.

\Date

اطلاعات تاریخ را برمی‌گرداند.

\Email{..}

برای مشخص کردن نشانی رایانامه (Email) استفاده می‌شود:
\Email{Juergen.Vollmer@informatik-vollmer.de} به‌صورت زیر حروف‌چینی می‌شود:
Juergen.Vollmer@informatik-vollmer.de.

\URL{..}

برای مشخص کردن یک نشانی وب (URL) استفاده می‌شود: \URL{http://www.foo.de/\Tilde vollmer} به‌صورت زیر حروف‌چینی می‌شود:
http://www.foo.de/~vollmer.

\LatexManEnd

فایل ورودی تا زمان رسیدن به پایان فایل (end-of-file) یا
\LatexManEnd (در ابتدای یک سطر) خوانده و پردازش می‌شود. LaTeX این دستور را نادیده می‌گیرد.

\Lbr, \Rbr

به‌صورت [ و ] حروف‌چینی می‌شوند (این متغیرها تنها در مواقع خاصی نیاز هستند، مانند
\item[FooBar\LBr xx \Lbr]. معمولاً همان [ ] کار خواهد کرد).

\LBr, \RBr

به‌صورت { و } حروف‌چینی می‌شوند (این متغیرها هنگام استفاده از { یا } به‌عنوان آرگومان‌های ماکروها مورد نیاز هستند).

\Circum

به‌صورت ^ حروف‌چینی می‌شود.

\Percent

به‌صورت % حروف‌چینی می‌شود.

\TEXbr

اگر با LaTeX پردازش شود، باعث شکست سطر می‌شود (یعنی معادل \\ است). در خروجی latex2man این ماکرو نادیده گرفته می‌شود.

\TEXIbr

اگر خروجی TexInfo تولید شود، باعث شکست سطر می‌شود (یعنی معادل \\ است)، در غیر این صورت نادیده گرفته می‌شود.

\MANbr

اگر خروجی Man-Page تولید شود، باعث شکست سطر می‌شود (یعنی معادل \\ است)، در غیر این صورت نادیده گرفته می‌شود.

\HTMLbr

اگر خروجی HTML تولید شود، باعث شکست سطر می‌شود (یعنی معادل \\ است)، در غیر این صورت نادیده گرفته می‌شود.

\medskip

یک سطر خالی.

\SP

مقداری فاصله خالی اضافی تولید می‌کند و در ابتدای سطرها نیز کار می‌کند. کد سطر دوم بدین صورت است: \SP abc \SP\SP xx\\:
abc xx
abc xx
abc xx

نکته: به دلیل برخی «مشکلات» در TexInfo، سطرهایی که با \SP آغاز می‌شوند دارای یک . (نقطه) آغازین در خروجی TexInfo خواهند بود، -achar را ببینید.

\rcsInfo $Id ...$

در صورت استفاده از بستهٔ LaTeX به نام rcsinfo، از این دستور برای استخراج تاریخ صفحهٔ راهنما (Man-page) استفاده می‌شود.

\rcsInfoLongDate

در صورت استفاده از بستهٔ LaTeX به نام rcsinfo، از این دستور برای حروف‌چینی تاریخ کدگذاری‌شده در رشتهٔ $Id ..$ استفاده می‌شود.

ماکروهای پذیرفته‌شده LaTeX (ACCEPTED LaTeX MACROS)

دستورهای استاندارد LaTeX زیر پذیرفته می‌شوند:

\section{..}

ماکروی section یک آرگومان می‌گیرد: نام بخش صفحهٔ راهنما (Man-page). هر صفحهٔ راهنما از چندین بخش تشکیل شده است. معمولاً بخش‌های زیر در یک صفحهٔ راهنما وجود دارند: Name (مدیریت ویژه به عنوان محیط، رک. به بالا)، Synopsis، Description، Options، Files، See Also، Diagnostics، Return Values، Bugs، Author، version و غیره.

بخش Synopsis باید نخستین بخش پس از محیط Name باشد.

نکته: در نام بخش‌ها از ماکروهای LaTeX استفاده نکنید.

\subsection{..}

به خوبی کار می‌کند، همانند

\subsubsection{..}

این دستور.

\emph{..}

دستور \emph{example} به صورت example حروف‌چینی می‌شود.

\textbf{..}

دستور \textbf{example} به صورت example حروف‌چینی می‌شود.

\texttt{..}

دستور \texttt{example} به صورت example حروف‌چینی می‌شود.

\underline{..}

دستور \underline{example} به صورت example of underline . حروف‌چینی می‌شود.

\date{..}

از .. به عنوان تاریخ استفاده می‌کند.

\verb+..+

اما تنها + به عنوان جداکننده مجاز است.

$<$ به صورت < حروف‌چینی می‌شود.

$>$ به صورت > حروف‌چینی می‌شود.

$<=$ به صورت <= حروف‌چینی می‌شود.

$>=$ به صورت >= حروف‌چینی می‌شود.

$=$ به صورت = حروف‌چینی می‌شود.

$<>$ به صورت <> حروف‌چینی می‌شود.

$\ge$

به صورت $>=$ حروف‌چینی می‌شود.

$\le$

به صورت $<=$ حروف‌چینی می‌شود.

$\leftarrow$

به صورت $<--$ حروف‌چینی می‌شود.

$\Leftarrow$

به صورت $<==$ حروف‌چینی می‌شود.

$\rightarrow$

به صورت $-->$ حروف‌چینی می‌شود.

$\Rightarrow$

به صورت $==>$ حروف‌چینی می‌شود.

\{ به صورت { حروف‌چینی می‌شود.

\} به صورت } حروف‌چینی می‌شود.

\$ به صورت $ حروف‌چینی می‌شود.

\$ به صورت $ حروف‌چینی می‌شود؛ باید درون آرگومان‌های ماکرو

استفاده شود.

\_ به صورت _ حروف‌چینی می‌شود.

\& به صورت & حروف‌چینی می‌شود.

\# به صورت # حروف‌چینی می‌شود.

\% به صورت % حروف‌چینی می‌شود.

\,

به صورت یک فاصلهٔ کوچک‌تر - - (بین دو -) حروف‌چینی می‌شود

\-

برای مشخص کردن پیوند خط فاصله (hyphenation) در یک کلمه استفاده می‌شود.

\\ به صورت شکست خط حروف‌چینی می‌شود یا نشان‌دهندهٔ پایان یک ستون در

محیط Table است.

\ (یک \ به همراه یک فاصله) به صورت یک فاصله حروف‌چینی می‌شود،

اگرچه نمی‌توان از آن در ابتدای خط برای ایجاد تورفتگی استفاده کرد (دستور \SP را ببینید).

~ به صورت یک فاصله حروف‌چینی می‌شود.

\copyright

به صورت (C) حروف‌چینی می‌شود.

\noindent

\hline

درون یک محیط Table.

\item

درون محیط‌های itemize، enumerate یا description.

\today

16 ژانویه 2026 (همچنین بستهٔ LaTeX به نام rcsinfo را ببینید).

\ss,\"a, ...

\ss = ß, \"a= ä, \"o= ö, \"u= ü, \"A= Ä, \"O= Ö, \"U= Ü. قرار دادن این ماکروها درون { و } در همه جا مجاز است، حتی درون سایر ماکروها؛ مانند:

\textbf{\"a\"o\"u\"A\"O\"U\ss}
\textbf{\"a}{\"o}{\"u}{\"A}{\"O}{\"U}{\ss}}
\textbf{äöüÄÖÜß}

äöüÄÖÜß äöüÄÖÜß äöüÄÖÜß

اگر این حروف در کدگذاری 8-بیتی LATIN-1 استفاده شوند، به حرف معادل در قالب خروجی مورد نظر ترجمه می‌شوند. به عنوان مثال Ä در HTML تبدیل به &Auml; و در texinfo تبدیل به @"A می‌شود.

\input{..}

خواندن و پردازش نام فایل داده‌شده.

لطفاً توجه کنید: نام ماکروهای LaTeX و آرگومان‌های آن باید همگی در یک خط قرار گیرند.

latex2man ورودی LaTeX را پیش‌پردازش می‌کند تا امکان استفاده شرطی از متن فراهم شود. برای این منظور نوع خاصی از کامنت LaTeX استفاده می‌شود.

*

%@% IF condition %@%

*

%@% ELSE %@%

*

%@% END-IF %@%

یک خط باید تنها شامل چنین کامنتی باشد و هیچ چیز دیگری در آن قرار نگیرد. condition یک عبارت بولی شامل «نام‌ها» و عملگرها است. نام‌هایی که با گزینه -Cname داده می‌شوند دارای مقدار «true» هستند، در حالی که فرض می‌شود سایر نام‌های حاضر در عبارت «false» باشند. اگر ارزیابی عبارت بولی به مقدار «true» بیانجامد، متن بخش «then» استفاده شده و از متن بخش اختیاری «else» صرف‌نظر می‌شود (و بالعکس). ساختارهای IF/ELSE/END-IF می‌توانند تودرتو باشند. به عنوان عملگرهای بولی موارد زیر مجاز هستند:

استفاده از ( و ) برای گروه‌بندی مجاز است.

برای مثال:
%@% IF abc %@%
abc set
%@% IF xyz %@%
xyz set
%@% ELSE %@%
xyz NOT set
%@% END-IF %@%
%@% ELSE %@%
abc NOT set
%@% IF xyz || !XYZ %@%
xyz OR !XYZ set
%@% ELSE %@%
xyz OR !XYZ NOT set
%@% END-IF %@%
%@% END-IF %@%

این صفحه راهنما را از طریق latex2man با مثلاً -C'abc XYZ' اجرا کنید و نگاهی به خروجی تولیدشده بیندازید. (در صورت اجرای ساده سند LaTeX با LaTeX، تمام خطوط در فایل .dvi نمایش داده می‌شوند).
abc NOT set
xyz OR !XYZ set

برای بررسی قابلیت متن شرطی، هنگامی که latex2man با گزینه‌های زیر فراخوانی شود

-CHTML

خط‌های 1a، 2b، 3b، و 4b؛

-CTEXI

خط‌های 1b، 2a، 3b، و 4b؛

-CMAN

خط‌های 1b، 2b، 3a، و 4b؛

-CLATEX

خط‌های 1b، 2b، 3b، و 4a؛

فراخوانی LaTeX بدون پیش‌پردازش

تمام خطوط

باید نمایش داده شوند:

1b. شرط HTML تنظیم نشده بود.

2b. شرط TEXI تنظیم نشده بود.

3a. این متن تنها هنگام مشاهده خروجی MAN ظاهر می‌شود

4b. شرط LATEX تنظیم نشده بود.

فایل ترجمه ماکروی کاربر (مشخص‌شده با [-ttransfile]) حاوی دستورات Perl است که ترجمه ماکروهای LaTeX تعریف‌شده توسط کاربر را مشخص می‌کند. این ماکروها ممکن است بدون آرگومان، دارای یک یا دو آرگومان باشند. کدهای زیر مورد انتظار است:

*

کامنت‌ها با # شروع می‌شوند و تا انتهای خط ادامه دارند.

*

برای یک ماکروی \foo بدون آرگومان، کد زیر باید مشخص شود:

*

برای یک ماکروی \foo{..} با یک آرگومان، کد زیر باید مشخص شود:

*

برای یک ماکروی \foo{..}{..} با دو آرگومان، کد زیر باید مشخص شود:

*

فایل latex2man.trans حاوی چند نمونه کد است.

This
    {is}
        \texttt{a}
                  $test$
                         _of_
verbatim
<this is no HTML tag> and no @* TexInfo command

کارکرد زیربخش (SUBSECTION WORKS)

این یک \subsection است.

کارکرد زیر-زیربخش (Subsubsection works)

این یک \subsubsection است.

همچنان کارکرد زیر-زیربخش (Subsubsection still works)

این یک \subsubsection دیگر است.

نکات کلی (GENERAL REMARKS)

1.

خط‌های خالی به عنوان جداکننده‌های بند (پاراگراف) حروف‌چینی می‌شوند.

2.

آرگومان‌های دستورهای LaTeX نباید در چندین خط شکسته شوند.

3.

از تو در تو کردن فراخوانی ماکروها خودداری کنید.

4.

به‌جز محیط و ماکروهای ذکرشده، استفاده از سایر محیط‌ها یا ماکروهای LaTeX ترجمه نمی‌شود. استفاده از آن‌ها باعث ایجاد محتوای نامفهوم در خروجی خواهد شد.

5.

ابزار latex2man به نسخه Perl برابر یا بالاتر از 5.0004_03 نیاز دارد.

6.

اگر می‌خواهید سامانه را با Makefile توزیع‌شده نصب کنید، به GNU-make نیاز دارید. اگر آن را ندارید، باید مراحل نشان‌داده‌شده در Makefile را به‌صورت دستی اجرا کنید.