صفحه راهنما
صفحه راهنما (به انگلیسی: man page) ابزار مستندساز آنلاینی است که برای موجودیتی که عموماً سیستم‌عامل یونیکس یا شبه‌یونیکس می‌باشد وجود دارد. چنین موجودیت‌هایی شامل برنامه‌های کامپیوتری (کتابخانه‌ها فراخوان‌های سیستمی)، استانداردهای رسمی، اصطلاحات و قراردادها و حتی مفاهیم انتزاعی می‌باشند. کاربر می‌تواند با فراخوان دستور راهنما (به انگلیسی: man) صفحه راهنما را احضار کند.
کاربرد
[ویرایش] | این بخش مقاله نیازمند گسترش است. |
کاربر برای مطالعه صفحه راهنمای یک دستور در سیستم‌عامل یونیکس خواهد داشت:
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: ویرایشگر متن‌باز صفحه راهنما برای مک‌اواس‌ایکس
منابع
[ویرایش]- ویکی‌پدیا انگلیسی