.\" sccsid = "@(#) man2html.1 1.2 08/12/97" .\" .\" ================================================ .\" ARGUMENT MACRO: .Ar "arg" [B] .de Ar .ie \\$2B \%\fB\\$1\fR .el \%\fI\\$1\fR .. .\" ================================================ .\" BRACKETED ARGUMENT MACRO: .Br "arg" [B] .de Br .ie \\$2B \%[\|\fB\\$1\fR\|] .el \%[\|\fI\\$1\fR\|] .. .\" ================================================ .\" OPTION FLAG MACRO .Of -x [arg] .de Of .ie \\n(.$==1 \%[\|\fB\\$1\fR\|] .el .if \\n(.$==2 \%[\|\fB\\$1\fR\0\fI\fI\\$2\fR\|] .. .\" ================================================ .\" SYNOPSIS START MACRO .de Ss .Ss name .na .nr aA \w\\$1\\0u .in +\\n(aAu 'ti -\\n(aAu .ta \\n(aAu \&\fB\\$1\fR\t\c .. .\" ================================================ .\" SYNOPSIS END MACRO .de Se .Se .ad .in .. .\" ================================================ .\" .\" .TH MAN2HTML 1 "97/08/12" .SH "نام (NAME)" .na man2html \- تبدیل صفحات راهنمای nroff(1) یونیکس به قالب HTML .SH "خلاصه دستور (SYNOPSIS)" .na .Ss man2html .Of -bare .Of -belem name .Of -botm lines .Of -cgiurl string .Of -cgiurlexp expr .Of -compress .Of -headmap mapfile .Of -help .Of -k .Of -leftm chars .Of -nodepage .Of -noheads .Of -pgsize lines .Of -seealso .Of -solaris .Of -sun .Of -title string .Of -topm lines .Of -uelem name .Se .sp 2 کاربرد متداول: .sp .Ss man2html .Of -options .BI "\0<\0" infile .BI "\0\0>\0" outfile .Se .sp .B man .I topic .B | man2html .Of -options .BI "\0>\0" outfile .\" .SH "توضیحات (DESCRIPTION)" .na فیلتر .B man2html متن قالب‌بندی‌شده‌ی nroff را از ورودی استاندارد .RI ( stdin ) می‌خواند و یک سند \s-1HTML\s+1 در خروجی استاندارد .RI ( stdout ) می‌نویسد. .LP خروجی قالب‌بندی‌شده‌ی nroff درون برچسب‌های .B \s-1
\s+1
قرار می‌گیرد، به استثنای موارد یا افزوده‌های زیر:
.RS 4n
.LP
.na
'ti -2n
'ta  2n
\(bu	عناوین بخش‌ها در برچسب‌های سربرگ
.I header
\s-1HTML\s+1 قرار می‌گیرند.
برای اطلاعات بیشتر به بخش
.B "\s-1فایل نگاشت عنوان بخش (SECTION HEAD MAP FILE)\s+1"
در زیر مراجعه کنید.
گزینه
.B \%-noheads
می‌تواند برای غیرفعال کردن این قابلیت استفاده شود.
.ad
.LP
.na
'ti -2n
'ta  2n
\(bu	کلمات پررنگ (Bold) که با دنباله‌های \%"" مشخص شده‌اند، در برچسب‌های
.B \s-1\s+1
(یا عنصری که از طریق گزینه
.B \%-belem
مشخص شده است) قرار می‌گیرند.
.ad
.LP
.na
'ti -2n
'ta  2n
\(bu	کلمات زیرخط‌دار که با دنباله‌های \%"_" مشخص شده‌اند، در برچسب‌های
.B \s-1\s+1
(یا عنصری که از طریق گزینه
.B \%-uelem
مشخص شده است) قرار می‌گیرند.
.ad
.RE
.SH "گزینه‌ها (OPTIONS)"
.na
.TP 0.5i
.B -bare
این گزینه برچسب‌های
.B \s-1\s+1
و
.B \s-1\s+1
\s-1HTML\s+1 را از خروجی حذف می‌کند.
این قابلیت زمانی مفید است که بخواهید خروجی را در یک سند \s-1HTML\s+1 دیگر ادغام کنید.
.TP 0.5i 
.BI -belem\0 name
از
.I name
به عنوان نام عنصری استفاده می‌کند که کاراکترهای با چاپ مجدد (overstrike) را در بر می‌گیرد.
مقدار پیش‌فرض \fBB\fR است.
.TP 0.5i 
.BI -botm\0 lines
آرگومان
.I lines
تعداد خطوط نشان‌دهنده حاشیه پایین ورودی قالب‌بندی‌شده nroff را مشخص می‌کند.
شمارش خطوط شامل هرگونه پاورقی جاری نیز می‌شود.
مقدار پیش‌فرض 7 است.
.TP 0.5i
.BI -cgiurl\0 string
آرگومان
.I string
یک \s-1URL\s+1 الگو برای ایجاد پیوند به سایر صفحات راهنما مشخص می‌کند.
برای اطلاعات بیشتر به بخش
.B "\s-1پیوند به دیگر صفحات راهنما (LINKING TO OTHER MANPAGES)\s+1"
در زیر مراجعه کنید.
.TP 0.5i
.BI -cgiurlexp\0 expr
آرگومان
.I expr
یک عبارت پرل (Perl) را مشخص می‌کند که برای ایجاد پیوند به سایر صفحات راهنما، به یک \s-1URL\s+1 ارزیابی می‌شود.
برای اطلاعات بیشتر به بخش
.B "\s-1پیوند به دیگر صفحات راهنما (LINKING TO OTHER MANPAGES)\s+1"
در زیر مراجعه کنید.
.TP 0.5i
.B -compress
خطوط خالی متوالی را در یک خط فشرده و ادغام می‌کند.
.TP 0.5i
.BI -headmap\0 mapfile
آرگومان
.I mapfile
خوانده می‌شود تا مشخص شود کدام برچسب‌های سربرگ \s-1HTML\s+1 باید برای عناوین بخش‌های مختلف در صفحه راهنما استفاده شوند.
برای اطلاعات درباره قالب فایل نگاشت به بخش
.B "\s-1فایل نگاشت عنوان بخش (SECTION HEAD MAP FILE)\s+1"
در زیر مراجعه کنید.
.TP 0.5i
.B -help
یک پیام راهنمای خلاصه چاپ کرده و فوراً خارج می‌شود.
.TP 0.5i
.B -k
ورودی حاصل از جستجوی کلیدواژه صفحه راهنما را پردازش می‌کند
.RB ( "man\ -k" ).
برای اطلاعات بیشتر به بخش
.B "\s-1جستجوی کلیدواژه (KEYWORD SEARCH)\s+1"
در زیر مراجعه کنید.
.TP 0.5i
.BI -leftm\0 chars
آرگومان
.I chars
عرض تعداد کاراکترهای تشکیل‌دهنده حاشیه سمت چپ ورودی قالب‌بندی‌شده nroff را مشخص می‌کند.
مقدار پیش‌فرض 0 است.
.TP 0.5i
.B -nodepage
به‌طور پیش‌فرض،
.B man2html
ورودی‌های چندصفحه‌ای قالب‌بندی‌شده nroff را در یک صفحه ادغام می‌کند.
این گزینه می‌تواند برای غیرفعال کردن صفحه‌زدایی استفاده شود که باعث می‌شود سربرگ‌ها و پاورقی‌های جاری ورودی قالب‌بندی‌شده nroff به خروجی \s-1HTML\s+1 منتقل شوند.
.TP 0.5i
.B -noheads
به‌طور پیش‌فرض،
.B man2html
عناوین بخش‌ها را در برچسب‌های سربرگ \s-1HTML\s+1 قرار می‌دهد.
برای اطلاعات بیشتر به بخش
.B "\s-1فایل نگاشت عنوان بخش (SECTION HEAD MAP FILE)\s+1"
در زیر مراجعه کنید.
این گزینه می‌تواند برای غیرفعال کردن این قابلیت مشخص شود.
.TP 0.5i
.BI -pgsize\0 lines
آرگومان
.I lines
تعداد خطوط تشکیل‌دهنده اندازه (طول) صفحه ورودی قالب‌بندی‌شده nroff را مشخص می‌کند.
مقدار پیش‌فرض 66 است.
.TP 0.5i
.B -seealso
اگر گزینه
.B -cgiurl
مشخص شده باشد، این گزینه ایجاد پیوندها به دیگر صفحات راهنما را تنها به بخش
.B "\%\s-1همچنین ببینید (SEE ALSO)\s+1"
محدود می‌کند.
.TP 0.5i
.B -solaris
اگر گزینه
.B -k
مشخص شده باشد، این گزینه عملکرد آن را تغییر می‌دهد تا قالب متناوب نتایج جستجوی کلیدواژه صفحه راهنما را که توسط ابزار
.BR man (1)
در سیستم‌های تحت اجرای
.IR Solaris
تولید می‌شود پردازش کند.
برای اطلاعات بیشتر به بخش
.B "\s-1جستجوی کلیدواژه (KEYWORD SEARCH)\s+1"
در زیر مراجعه کنید.
.TP 0.5i
.B -sun
الزام وجود چاپ مجدد ضخیم (bold overstriking) برای عنوان بخش در ورودی قالب‌بندی‌شده nroff را لغو می‌کند.
نام این گزینه
.B \%sun
گذاشته شده است زیرا روی یک ایستگاه کاری Sun مشخص شد که عناوین بخش‌ها در صفحات راهنما دارای چاپ مجدد نیستند.
.TP 0.5i
.BI -title\0 string
به‌طور پیش‌فرض،
.B man2html
عنوان \s-1HTML\s+1 تولید نمی‌کند
.RB ( \s-1\s+1 ).
این گزینه عنوان خروجی \s-1HTML\s+1 را روی
.IR string
مشخص‌شده تنظیم می‌کند.
.TP 0.5i
.BI -topm\0 lines
آرگومان
.I lines
تعداد خطوط نشان‌دهنده حاشیه بالای ورودی قالب‌بندی‌شده nroff را مشخص می‌کند.
شمارش خطوط شامل هرگونه سربرگ جاری نیز می‌شود.
مقدار پیش‌فرض 7 است.
.TP 0.5i 
.BI -uelem\0 name
از
.I name
به عنوان نام عنصری استفاده می‌کند که کاراکترهای دارای خط زیرین را در بر می‌گیرد.
مقدار پیش‌فرض \fBI\fR است.
.\"
.SH "فایل نگاشت عنوان بخش (SECTION HEAD MAP FILE)"
.na
.LP
گزینه
.B \%-headmap
می‌تواند برای سفارشی‌سازی اینکه کدام برچسب‌های سربرگ \s-1HTML\s+1،
.BR "\s-1<H1>\s+1 ... \s-1<H6>\s+1" ،
در عناوین بخش‌های صفحه راهنما استفاده شوند به کار رود.
به‌طور معمول،
.B man2html
خطوطی را که هم‌تراز با حاشیه چپ هستند
.RB ( -leftm )
و دارای چاپ مجدد هستند (بررسی چاپ مجدد با گزینه
.B -sun
لغو می‌شود) به عنوان سربرگ بخش‌ها در نظر می‌گیرد.
با این حال، می‌توانید برچسب‌های سربرگ \s-1HTML\s+1 مورد استفاده برای هر عنوان بخش دلخواه را اضافه یا بازنویسی کنید.
.LP
برای نوشتن یک فایل نگاشت عنوان بخش، باید با آرایه‌های انجمنی (associative arrays) در
.BR perl (1)
آشنا باشید.
برای نوشتن فایل نگاشت نیازی نیست که در
.B perl
متخصص باشید، با این حال داشتن دانش در مورد
.B perl
به شما امکان می‌دهد هوشمندانه‌تر عمل کنید.
.\"
.SS "افزودن به نگاشت پیش‌فرض (Augmenting the Default Map)" 
.LP
برای افزودن به نگاشت پیش‌فرض تعریف‌شده توسط
.BR man2html ،
فایل نگاشت شما شامل خطوطی با ساختار زیر خواهد بود:
.sp
.if t .RS 4n
.B "$SectionHead{'<section head text>'} = '<html header tag>';"
.if t .RE
.sp
که در آن
.IP "\fB\%<section\ head\ text>\fR"
متن عنوان بخش صفحه راهنما است.
برای نمونه:
.B  \s-1SYNOPSIS\s+1
یا
.BR \s-1DESCRIPTION\s+1 .
.IP "\fB\%<html\ header\ tag>\fR"
برچسب سربرگ \s-1HTML\s+1 است که عنوان بخش در آن قرار می‌گیرد.
مقادیر مجاز عبارتند از:
.BR \s-1<H1>\s+1 ،
.BR \s-1<H2>\s+1 ،
.BR \s-1<H3>\s+1 ،
.BR \s-1<H4>\s+1 ،
.BR \s-1<H5>\s+1 ،
.BR \s-1<H6>\s+1 .
.SS "بازنویسی نگاشت پیش‌فرض (Overriding the Default Map)"
برای بازنویسی نگاشت پیش‌فرض با مقادیر دلخواه خود، فایل نگاشت شما دارای ساختار زیر خواهد بود:
.sp
.RS 4n
.ft B
.nf
.ne 6v
%SectionHead = (
         \&'<section head text>', '<html header tag>',
         \&'<section head text>', '<html header tag>',
         \&# ... More section head/tag pairs
         \&'<section head text>', '<html header tag>',
);
.fi
.ft
.RE
.SS "نگاشت پیش‌فرض (The Default Map)"
.LP
در زمان نگارش این مستند، این نگاشت پیش‌فرضی است که توسط
.BR man2html
استفاده می‌شود:
.RS 4n
.sp
.ft C
.nf
.ne 29v
%SectionHead = (
.ps -1
    \&'\\S.*OPTIONS.*'             => '<H2>',
    \&'AUTHORS?'                  => '<H2>',
    \&'BUGS'                      => '<H2>',
    \&'COMPATIBILITY'             => '<H2>',
    \&'DEPENDENCIES'              => '<H2>',
    \&'DESCRIPTION'               => '<H2>',
    \&'DIAGNOSTICS'               => '<H2>',
    \&'ENVIRONMENT'               => '<H2>',
    \&'ERRORS'                    => '<H2>',
    \&'EXAMPLES'                  => '<H2>',
    \&'EXTERNAL INFLUENCES'       => '<H2>',
    \&'FILES'                     => '<H2>',
    \&'LIMITATIONS'               => '<H2>',
    \&'NAME'                      => '<H2>',
    \&'NOTES?'                    => '<H2>',
    \&'OPTIONS'                   => '<H2>',
    \&'REFERENCES'                => '<H2>',
    \&'RETURN VALUE'              => '<H2>',
    \&'SECTION.*:'                => '<H2>',
    \&'SEE ALSO'                  => '<H2>',
    \&'STANDARDS CONFORMANCE'     => '<H2>',
    \&'STYLE CONVENTION'          => '<H2>',
    \&'SYNOPSIS'                  => '<H2>',
    \&'SYNTAX'                    => '<H2>',
    \&'WARNINGS'                  => '<H2>',
    \&'\\s+Section.*:'             => '<H3>',
.ps +1
);
$HeadFallback = '\s-1<H2>\s+1';  # Fallback tag if above is not found.
.fi
.ft
.RE
.LP
کد منبع
.B perl
برنامه
.B man2html
را برای آخرین نگاشت پیش‌فرض بررسی کنید.
.LP 
در صورت تمایل می‌توانید متغیر
.B \%$HeadFallback
را به مقدار دیگری تغییر دهید.
این مقدار به عنوان برچسب سربرگ یک بخش استفاده می‌شود اگر هیچ تطابقی در نگاشت
\%\fB%SectionHead\fR
پیدا نشود.
.SS "استفاده از عبارات منظم در فایل نگاشت (Using Regular Expressions in the Map File)"
.LP
شاید متوجه کاراکترهای نامتعارف در فایل نگاشت پیش‌فرض، مانند "\\s" یا "*" شده باشید.
ابزار
.B man2html
در واقع
.B "\%<section\ head\ text>"
را به عنوان یک عبارت منظم (regular expression) در
.B perl
در نظر می‌گیرد.
اگر با عبارات منظم
.B perl
آشنایی دارید، می‌توانید از تمام قابلیت‌های آن‌ها در فایل نگاشت خود استفاده کنید.
.LP
.I هشدار:
ابزار
.B man2html
از قبل عبارت منظم را با فاصله‌گذاری حاشیه سمت چپ که توسط گزینه
.B \%-leftm
مشخص شده به ابتدای خط متصل (anchor) می‌کند.
بنابراین، از کاراکتر `\fB\fR^' برای متصل کردن عبارت منظم خود به ابتدا استفاده نکنید.
با این حال، می‌توانید عبارت خود را با `\fB$\fR' پایان دهید تا به انتهای خط متصل شود.
.LP 
از آنجا که
.B "\%<section\ head\ text>"
در واقع یک عبارت منظم است، اگر می‌خواهید کاراکترها به صورت لغوی (literal) تفسیر شوند، باید مراقب کاراکترهای خاص باشید.
هر یک از کاراکترهای
.RB ` "[ ] ( ) . ^ { } $ * ? + \\ |" '
اگر می‌خواهید
.B perl
با آن‌ها «همان‌گونه که هستند» رفتار کند، باید با قرار دادن پیشوند کاراکتر
\&`\fB\\\fR'
اسکیپ شوند.
.LP
.I هشدار:
برای مشخص کردن محدوده
.BR "\%<section\ head\ text>"
باید به جای نقل‌قول دوتایی (double quotes) از نقل‌قول تکی (single quotes) استفاده شود.
این کار هر کاراکتر `\fB\\\fR' را برای اسکیپ کاراکترها یا زمانی که `\fB\\\fR' برای دنباله‌های تطبیق کاراکتر خاص
.B perl
(مانند \fB\\s\fR، \fB\\w\fR، \fB\\S\fR) استفاده می‌شود حفظ می‌کند.
.SS "نکات دیگر درباره فایل نگاشت (Other Tid-bits on the Map File)"
.LP
توضیحات (کامنت‌ها) را می‌توان با استفاده از کاراکتر '\fB#\fR' در فایل نگاشت درج کرد.
هر چیزی پس از کاراکتر '\fB#\fR' و شامل خود آن، تا انتهای خط نادیده گرفته می‌شود.
.LP 
شاید فکر کنید موارد فوق صرفاً برای مشخص کردن عناوین بخش‌های صفحات راهنما حجم زیادی از مطالب است.
با این حال، شگفت‌زده خواهید شد که خروجی \s-1HTML\s+1 با برچسب‌های سربرگ چقدر بهتر به نظر می‌رسد، حتی با اینکه سایر موارد درون برچسب
.B \s-1<PRE>\s+1
قرار دارند.
.\"
.SH "پیوند به دیگر صفحات راهنما (LINKING TO OTHER MANPAGES)"
.na
.LP 
ابزار
.B man2html
امکان پیوند دادن به سایر مراجع صفحات راهنما را فراهم می‌کند.
اگر گزینه
.B \%-cgiurl
مشخص شده باشد،
.B man2html
لنگرهایی (anchors) ایجاد می‌کند که به سایر صفحات راهنما پیوند دارند.
.LP 
نشانی \s-1URL\s+1 وارد شده با گزینه
.B \%-cgiurl
در واقع یک الگو است که \s-1URL\s+1 واقعی مورد استفاده برای پیوند به سایر صفحات راهنما را تعیین می‌کند.
متغیرهای زیر در زمان اجرا تعریف می‌شوند که می‌توان از آن‌ها در رشته الگو استفاده کرد:
.sp
.RS 4n
.IP \fB$title\fR
عنوان صفحه راهنمای ارجاع داده شده.
.IP \fB$section\fR
شماره بخش صفحه راهنمای ارجاع داده شده.
.IP \fB$subsection\fR
زیربخش صفحه راهنمای ارجاع داده شده.
.RE
.LP
هر متن دیگری در الگو «همان‌طور که هست» حفظ می‌شود.
.LP
.I هشدار:
ابزار
.B man2html
رشته الگو را به عنوان یک عبارت رشته‌ای
.B perl
ارزیابی می‌کند.
بنابراین ممکن است لازم باشد نام متغیرها را با
\&'\fB{\|}\fR' (مانند
.BR ${\|title\|}\| )
احاطه کنید تا
.B man2html
متغیر را به درستی تشخیص دهد.
.LP
.I نکته:
اگر برنامه \s-1CGI\s+1 فراخواننده
.B man2html
در واقع یک اسکریپت شل یا یک برنامه
.B perl
است، مطمئن شوید که کاراکتر '\fB$\fR' را در الگوی \s-1URL\s+1 به درستی اسکیپ کرده‌اید تا از جایگزینی متغیر توسط برنامه \s-1CGI\s+1 جلوگیری شود.
.LP
به‌طور معمول، \s-1URL\s+1 یک برنامه \s-1CGI\s+1 را فراخوانی می‌کند (از این رو نام گزینه cgiurl است)، اما این \s-1URL\s+1 می‌تواند به راحتی به اسنادی که به صورت ایستا تبدیل شده‌اند نیز پیوند دهد.
.SS "مثال ۱ (Example1):"
.LP 
رشته الگوی زیر برای فراخوانی یک برنامه \s-1CGI\s+1 جهت بازیابی صفحه راهنمای مربوطه مشخص شده است:
.LP
.nf
.B "/cgi-bin/man.cgi?section=${section}${subsection}&topic=${title}"
.fi
.LP 
اگر به صفحه راهنمای
.BR ls (1)
در بخش
.B "همچنین ببینید (SEE ALSO)"
ارجاع داده شود، الگوی بالا به \s-1URL\s+1 زیر ترجمه می‌شود:
.LP
.B "/cgi-bin/man.cgi?section=1&topic=ls"
.LP 
نشانه‌گذاری واقعی \s-1HTML\s+1 شبیه به زیر خواهد بود:
.LP
\fB<A\ HREF="/cgi-bin/man.cgi?section=1&topic=ls">ls(1)</A>\fR
.SS "مثال ۲ (Example2):"
.LP 
رشته الگوی زیر برای بازیابی صفحات راهنمای از پیش تبدیل‌شده مشخص شده است:
.LP
.B "http://foo.org/man$section/$title.$section$subsection.html"
.LP 
اگر به صفحه راهنمای
.BR mount (1M)
ارجاع داده شود، الگوی بالا به \s-1URL\s+1 زیر ترجمه می‌شود:
.LP
.B "http://foo.org/man1/mount.1M.html"
.LP 
نشانه‌گذاری واقعی \s-1HTML\s+1 شبیه به زیر خواهد بود:
.LP
\fB<A HREF="http://foo.org/man1/mount.1M.html">mount(1M)</A>\fR
.SS "-cgiurlexp"
گزینه
.B \%-cgiurlexp
شکل عمومی‌تری از گزینه
.B \%-cgiurl
است.
.B \%-cgiurlexp
امکان مشخص کردن یک عبارت عمومی پرل را فراهم می‌کند. برای مثال:
.LP
\fB$title=~/^db_/i?"$title.html":"/cgi-bin/man?$title+$section"\fR
.LP
یک
.I string
در
.B \%-cgiurl
را می‌توان با \fB-cgiurlexp\fR به صورت زیر بیان کرد:
.LP
\fBreturn "\fIstring\fB"\fR
.\"
.SH "جستجوی کلیدواژه (KEYWORD SEARCH)"
.na
.LP
ابزار
.B man2html
از طریق استفاده از گزینه
.B -k
این قابلیت را دارد که خروجی جستجوی کلیدواژه تولید شده توسط دستورهای \%\fBman\ -k\fR یا \%\fBapropos\fR را پردازش کند.
ابزار
.B man2html
یک سند \s-1HTML\s+1 از ورودی جستجوی کلیدواژه با قالب زیر تولید خواهد کرد:
.RS 4n 
.LP
.na
'ti -2n
'ta  2n
\(bu	تمام مراجع صفحات راهنما بر اساس بخش فهرست می‌شوند.
.ad
.LP
.na
'ti -2n
'ta  2n
\(bu	درون فهرست هر بخش، مراجع صفحات راهنما به ترتیب الفبایی (حساس به حروف بزرگ و کوچک) درون برچسب
.B \s-1<DL>\s+1
مرتب می‌شوند.
مراجع صفحات راهنما در بخش
.B \s-1<DT>\s+1
و متن خلاصه در بخش
.B \s-1<DD>\s+1
فهرست می‌شوند.
.ad
.LP
.na
'ti -2n
'ta  2n
\(bu	هر مرجع صفحه راهنمای فهرست‌شده، یک ابرپیوند به صفحه راهنمای اصلی است که توسط گزینه
.B \%-cgiurl
مشخص شده است.
.ad
.RE
.LP 
.na
این قابلیت پردازش جستجوی کلیدواژه، یک کارکرد افزوده بسیار خوب به رابط فرم‌های \s-1WWW\s+1 برای
.BR man (1)
می‌بخشد.
حتی اگر صفحات راهنما را از طریق برنامه دیگری به صورت ایستا به \s-1HTML\s+1 تبدیل کرده باشید، می‌توانید از
.B man2html
و "\fBman\ -k\fR" برای فراهم آوردن آسان قابلیت جستجوی کلیدواژه برای صفحات راهنمای \s-1HTML\s+1 خود استفاده کنید.
.SS "پردازش نتایج جستجوی کلیدواژه (Processing Keyword Search Results)"
.na
.LP 
متأسفانه استانداردی برای کنترل قالب نتایج جستجوی کلیدواژه وجود ندارد.
ابزار
.B man2html
تمام تلاش خود را برای مدیریت همه گونه‌های مختلف انجام می‌دهد.
با این حال، نتایج جستجوی کلیدواژه تولید شده توسط سیستم‌عامل
.I Solaris
به اندازه‌ای با سیستم‌های دیگر متفاوت است که یک گزینه خط فرمان ویژه
.RB ( -solaris )
باید برای مدیریت خروجی آن مشخص شود.
.SS "نمونه‌ای از نتایج خام جستجوی کلیدواژه در سولاریس:"
.LP
.ft C
.nf
.ne 10v
strcpy        strcpy (9f)  - copy a string from one location to another.
strcpy        string (3c)  - string operations
strncpy       strcpy (9f)  - copy a string from one location to another.
strncpy       string (3c)  - string operations
.fi
.ft
.LP 
اگر نتایج جستجوی کلیدواژه در سیستم شما به قالب زیر نمایش داده می‌شود:
.LP
.RS 4n
.B "<topic>  <actual_manpage> (#) - Description"
.RE
.LP
در این صورت لازم است علاوه بر گزینه
.B -k
گزینه
.B \%-solaris
را نیز مشخص کنید.
.SH "نکات تکمیلی (ADDITIONAL NOTES)"
.na
.LP
سیستم‌های مختلف صفحات راهنما را به روش‌های گوناگونی قالب‌بندی می‌کنند.
در اینجا فهرستی از گزینه‌های خط فرمان توصیه‌شده برای برخی سیستم‌ها آورده شده است:
.RS 4n
.LP
.ta 1i
.nf
.ne 3v
\fBConvex\fR:	<تنظیمات پیش‌فرض باید مناسب باشند>
\fBHP\fR:	\fB-leftm 1 -topm 8\fR
\fBSun\fR:	\fB-sun\fR (و \fB-solaris\fR هنگام استفاده از \fB-k\fR)
.fi
.RE
.LP
برخی از فواصل خطوط در خروجی قالب‌بندی‌شده nroff از بین می‌روند زیرا این فاصله‌گذاری در وسط شکستگی صفحه رخ می‌دهد.
این امر هنگامی که
.B man2html
متن را صفحه‌زدایی می‌کند، می‌تواند باعث ادغام متونی شود که نباید ادغام می‌شدند.
برای جلوگیری از این مشکل،
.B man2html
میزان تورفتگی حاشیه را دقیقاً قبل و بعد از شکستگی صفحه پیگیری می‌کند.
اگر عرض حاشیه خط بعد از شکستگی صفحه کمتر از خط قبل از شکستگی باشد، آنگاه
.B man2html
یک خط خالی در خروجی \s-1HTML\s+1 درج می‌کند.
.LP 
یک ارجاع متقابل در صفحه راهنما توسط شبه‌عبارت زیر شناسایی می‌شود:
\%\fB[A-z.-+_]+([0-9][A-z]?)\fR
.LP
ابزار
.B man2html
در هنگام قرار داشتن در حالت جستجوی کلیدواژه، فقط خطوط دارای "\fB - \fR" (جداکننده عادی بین مراجع صفحات راهنما و متن خلاصه) را تشخیص می‌دهد.
.LP 
ابزار
.B man2html
می‌تواند در یک اسکریپت/برنامه \s-1CGI\s+1 برای تبدیل صفحات راهنما در لحظه (on the fly) ادغام شود.
این دلیل وجود گزینه
.B \%-cgiurl
است.
.SH "محدودیت‌ها (LIMITATIONS)"
.na
.LP 
ترتیبی که نگاشت عنوان بخش در آن جستجو می‌شود تعریف نشده است.
بنابراین اگر دو یا چند
.B "\%<section\ head\ text>"
بتوانند با یک بخش صفحه راهنما تطابق پیدا کنند، هیچ راهی برای تعیین اینکه کدام برچسب نگاشت انتخاب می‌شود وجود ندارد.
.LP 
اگر
.B \%-seealso
مشخص شده باشد، همه ارجاعات متقابل پس از عنوان
.B "\%همچنین ببینید (SEE ALSO)"
شناسایی می‌شوند.
به عبارت دیگر، بخش‌های پس از
.B "\%SEE\ ALSO"
ممکن است شامل ارجاعات متقابل دارای ابرپیوند باشند.
.SH "اشکالات (BUGS)"
.na
.LP 
متنی که هم‌تراز با حاشیه سمت چپ است، اما در واقع عنوان بخش نیست، ممکن است به اشتباه عنوان بخش تشخیص داده شود.
این اشتباه زمانی که گزینه
.B \%-sun
فعال باشد محتمل‌تر است.
.SH "نسخه (VERSION)"
.na
این مستندات
.B man2html
نسخه 3.0.1 را توصیف می‌کند.
.SH "همچنین ببینید (SEE ALSO)"
.na
.BR man (1),
.BR nroff (1),
.BR perl (1)
.LP
.I http://www.oac.uci.edu/indiv/ehood/man2html.html
.SH "نویسنده (AUTHOR)"
.LP
.B Earl Hood
.br
.I ehood@medusa.acs.uci.edu
.\"
.SH "خطاها و از قلم‌افتادگی‌ها (ERRORS AND OMISSIONS)"
.na
نسخه Troff این سند ابتدا برای نسخه 2.1.0 توسط C. Jeffery Small
.RI ( jeff@cjsa.com )
از طریق رونوشت، قالب‌بندی مجدد، بازآرایی و بازنویسی جزئی محتوای فایل متنی اسکی
.BR doc/man2html.txt
ایجاد شد.