صفحه راهنما

صفحه راهنما (به انگلیسی: man page) ابزاری برای مستندسازی آنلاین است که معمولاً در سیستم‌عامل‌های یونیکس و شبه‌یونیکس مورد استفاده قرار می‌گیرد. چنین مستنداتی شامل برنامه‌های کامپیوتری، کتابخانه‌ها، فراخوان‌های سیستمی، استانداردهای رسمی، اصطلاحات، قراردادها و حتی مفاهیم انتزاعی هستند. کاربران می‌توانند با اجرای دستور صفحهٔ راهنما را مشاهده کنند.

 تاریخچه 
صفحات راهنما نخستین بار در نسخهٔ اولیهٔ یونیکس در دههٔ ۱۹۷۰ توسط کارکنان بل لبز معرفی شدند. هدف آن‌ها ارائهٔ مرجع سریع برای کاربران و برنامه‌نویسان بود تا بتوانند اطلاعات فنی مورد نیاز را مستقیماً در محیط خط فرمان دریافت کنند.

 کاربرد 
صفحات راهنما معمولاً شامل توضیح دستور یا برنامه، نحو (syntax)، گزینه‌ها و آرگومان‌های قابل استفاده، مثال‌ها، فایل‌های مرتبط و نویسندگان می‌باشند. این صفحات به‌ویژه برای کاربران تازه‌کار و مدیران سیستم، یک منبع مرجع سریع و دقیق محسوب می‌شوند.

 ساختار 
هر صفحهٔ راهنما معمولاً دارای بخش‌های استانداردی است که ممکن است شامل موارد زیر باشند:

 NAME – نام دستور یا تابع و توضیح کوتاه آن
 SYNOPSIS – نحو و قالب استفاده
 DESCRIPTION – توضیحات کامل دربارهٔ عملکرد
 OPTIONS – فهرست گزینه‌ها و پارامترها
 EXAMPLES – نمونه‌هایی از کاربرد دستور
 SEE ALSO – منابع و دستورات مرتبط

 جستارهای وابسته 

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

 منابع 
صفحه راهنما ابزار مستندساز آنلاینی است که برای موجودیتی که عموماً سیستم‌عامل یونیکس یا شبه‌یونیکس می‌باشد وجود دارد. چنین موجودیت‌هایی شامل برنامه‌های کامپیوتری (کتابخانه‌ها فراخوان‌های سیستمی)، استانداردهای رسمی، اصطلاحات و قراردادها و حتی مفاهیم انتزاعی می‌باشند. کاربر می‌تواند با فراخوان دستور راهنما صفحه راهنما را احضار کند.

 کاربرد 

کاربر برای مطالعه صفحه راهنمای یک دستور در سیستم‌عامل یونیکس خواهد داشت:

man <command_name>

برای سهولت در پیمایش خروجی، دستور راهنما عموماً از ابزار دیگری به نام less استفاده می‌کند.

 تاریخچه 

 بخش‌های راهنما 

راهنما به طور کلی به هشت بخش شماره‌گذاری شده تقسیم می‌شود، سازماندهی شده به صورت زیر (روی بی‌اس‌دی، یونیکس و لینوکس):

بخشتوضیحات۱فرمان‌های کلی۲فراخوان‌های سیستمی۳ توابع کتابخانه ای، به طور خاص کتابخانه استاندارد سی را پوشش می‌دهد۴ فایل‌های خاص (معمولاً دستگاه‌ها، آن‌هایی که در dev/ پیدا می‌شوند) و راه‌اندازها۵قالب‌های فایل و قراردادها۶بازی‌ها و محافظ صفحه نمایشها۷گوناگون۸مدیریت سیستم فرمان‌ها و daemonها

سامانه وی یونیکس با یک چینش متفاوت، از یک طرح مشابه شماره گذاری استفاده می‌کند:

بخشتوضیحات۱فرمان‌های کلی۱Mمدیریت سیستم فرمان‌ها و daemonها۲فراخوان‌های سیستمی۳توابع کتابخانه استاندارد سی۴قالب‌های فایل و قراردادها۵گوناگون۶بازی‌ها و محافظ صفحه نمایشها۷ فایل‌های خاص (معمولاً دستگاه‌ها، آن‌هایی که در dev/ پیدا می‌شوند) و راه‌اندازها

بعضی از بخش‌های زیر در بعضی از سیستم‌ها موجود هستند:

بخشتوضیحات۰فایل‌های هدر کتابخانه استاندارد سی۹روتین‌های کرنلn کلمات کلیدی تی‌سی‌ال/تی‌کیxسیستم پنجره ایکس

برخی از نسخه‌های man نسخه‌های قالب بندی شده ای را که از همه بیشتر مشاهده شده‌اند، را ذخیره می‌کنند.

برای دیدن گزینه‌های بیشتر man , وارد کنید فرمان man man.

 طرح 
تمام صفحات راهنما به دنبال یک طرح معمول که بهینه‌سازی شده برای ارائه روی یک صفحه نمایش متن اسکی ساده، که احتمالاً بدون هیچ گونه برجستگی یا کنترل فونت است هستند. بخش‌های حاضر شامل موارد زیر است:

 نام نام دستور یا تابع، و پس از آن توضیحاتی یک خطی از عملکرد دستور.
 خلاصه در مورد یک دستور، شما یک توصیف رسمی از چگونگی اجرا آن و چه گزینه‌های خط فرمانی را می‌گیرد، می‌بینید. برای توابع برنامه، فهرستی از پارامترها که هدر فایل شامل تعریف آن است. برای کاربران با تجربه، ممکن تمام مستنداتی باشد که آنها نیاز دارند.
 توضیحات شرح متنی عملکرد تابع یا دستور.
 نمونه‌ها بعضی از نمونه‌های کاربردی رایج.
 مشابه‌ها یک فهرست از دستورات یا توابع مرتبط.

سایر بخش‌ها ممکن است وجود داشته باشد، اما این‌ها استاندارد شده در سراسر صفحات راهنما نباشد. مثالهای متداول عبارتند از: گزینه‌ها، وضعیت خروج، محیط، اشکالات شناخته شده، فایل‌ها، نویسنده، گزارش اشکالات، تاریخچه و کپی رایت.

 نوشتن صفحات راهنما 

 تبدیل صفحات راهنما 

 جستارهای وابسته 
 فهرست ابزارهای یونیکس

 پیوند به بیرون 
 Unix Programmer's Manual of November 3, 1971 (همچنین ببینید original scans in PS and PDF format).
 History of UNIX Manpages متن اصلی تاریخچه صفحات راهنما یونیکس.
 Online man pages برای خیلی از نسخه‌های یونیکس، لینوکس، مکینتاش Darwin و سیستم عامل‌های مشابه.
 man: یک پیاده‌سازی متن‌باز؛ مورد استفاده در ردهت، فدورا، جنتو، اسلکور، مک اواس-ایکس و برخی دیگر.
 man-db: پیاده‌سازی جایگزین راهنما؛ مورد استفاده در دبیان/اوبونتو، سوزه و برخی دیگر.
 Practical UNIX Manuals: mdoc: راهنما برای نوشتن mdoc صفحات راهنما یونیکس.
 (man 1): قالب و صفحه نمایش برخط صفحات راهنما
 ManDrake: ویرایشگر متن‌باز صفحه راهنما برای مک‌اواس‌ایکس

 منابع 
 ویکی‌پدیا انگلیسی

رده:ابزارهای اس یو اس ۲۰۰۸ یونیکس
رده:ارتباطات فنی
رده:پلان ۹ از آزمایشگاه‌های بل
رده:راهنمای آنلاین
رده:یونیکس