دستور man یک کتابچه راهنمای داخلی یا built-in manual برای استفاده از دستورات لینوکس است. man به کاربران اجازه می دهد تا راهنمای یک فرمان یا ابزاری که در ترمینال اجرا می شود را مشاهده کنند. man page یا manual page شامل توضیحات دستور، گزینه‌های قابل اجرا، flag ها، نمونه‌ها و سایر بخش های اطلاعاتی است.


در این آموزش با استفاده از دستور man در لینوکس آشنا می شوید.


ابتدا باید بدانید که syntax کلی دستور man بصورت زیر می باشد:

man [option] [section number] [command name]

Option - خروجی نتیجه جستجو.
section number - بخشی که در آن man page جستجو می شود.
command name - نام دستوری که می‌خواهید با man page در مورد آن بدانید.

به طور پیش فرض، man در تمام بخش های(section های) موجود manual کاربر جستجو و نگاه می کند و اولین مورد را نشان می دهد (حتی اگر page در چندین بخش وجود داشته باشد). section number در دستور manباعث می شود که یک section یا بخش خاص را جستجو کند.

9 بخش یا section از manual وجود دارد که با هم به آنها یک نگاهی کلی می اندازیم:
1. General commands: دستورات مورد استفاده در ترمینال.
2. فراخوانی سیستم: توابعی که kernel ارائه می دهد.
3. Library functions: توابع در کتابخانه های برنامه.
5. File formats and conventions: فرمت های فایل مانند etc/passwd.
6. Games: توضیحات دستوراتی که quote های دیتابیس را نمایش می دهند.
7. Miscellaneous: توضیحات مختلف، از جمله پکیج های ماکرو، پارامترهای بوت و موارد دیگر.
8. System administration commands: دستوراتی که بیشتر محفوظ برای root هستند.
9. Kernel Routines: اطلاعات در مورد داخلی کرنل.

How to Use man in Linux

در پنجره ترمینال، man را تایپ کنید و سپس نام دستور لینوکس را تایپ کنید که در مورد آن از man page اطلاعات می خواهید.
خروجی طولانی است. از چرخ اسکرول ماوس، کلیدهای جهت دار بالا و پایین یا کلیدهای PgDn و PgUp برای حرکت در آن استفاده کنید.
پس از اجرای دستور man، کلید H را فشار دهید تا بخش help و جدولی از کلیدها برای پیمایش در خروجی پیش رویتان را مشاهده کنید. برای خروج، Q را فشار دهید.
خروجی فرمان عناوین man page موجود برای دستور مشخص شده را نمایش می دهد.
لیست عناوین ممکن شامل:

Name: نام دستور
Synopsis: syntax دستور است.
Configuration: جزئیات پیکربندی یک دستگاه.
Description: توضیحات دستور:
Examples: مثال از نحوه استفاده از دستور.
Defaults: توابع پیش‌فرض دستور و نحوه لغو کردن آنها را نشان می دهد.
Options: لیستی از گزینه ها و flag هایی که دستور می پذیرد.
Exit Status: لیستی از مقادیر وضعیت خروج ممکن برای دستور.
Environment: لیست و شرحی از متغیرهای محیطی یا environment variableها که بر دستور تأثیر می گذارند.
Files: لیستی از فایل های استفاده شده توسط دستور.
See also: دستورات مربوط به موضوع توضیح داده شده.
Authors: افرادی که دستور را نوشته اند.
History: تاریخچه develop دستور
Notes: یادداشت های مختلف، از جمله مجوزهای مورد نیاز و غیره.
Bugs: هر گونه مشکل شناخته شده در این نسخه از برنامه.

گزینه -f تمام man page ها که با نام دستور مشخص شده مطابقت دارند را نمایش می دهد و بخش هایی را که دستور داده شده در آنها وجود دارد را نشان می دهد. در این خصوص از syntax زیر استفاده کنید:

man -f [command name]

مثلا:


خروجی لیستی از نتایجی است که با معیارهای سرچ مطابقت دارند. با چندین تطابق، عدد کنار نتیجه جستجو، section را نشان می دهد.
برای نمایش page از یک section خاص از manual، از سینتکس زیر استفاده کنید:

man [section number] [command name]

برای مثال:

man 3 sleep

خروجی فقط page از section 3 راهنما را نشان می دهد.
Man page ها طولانی هستند و گاهی اوقات پیمایش برای یافتن اطلاعات مورد نیازتان، دشواری به همراه دارند. دستور man به کاربران اجازه می دهد تا Man page را در مرورگر نمایش دهند تا اطلاعات را به راحتی پیدا کنند.
بدین منظور مراحل زیر را دنبال کنید:
اول مطمئن شوید که پکیج groff نصب است. برای نصب دستور زیر را اجرا کنید:

sudo apt-get install groff

پیش از اجرا و فراخوانی دستور man، مرورگری را باید انتخاب کنید که اگر مرورگرتان firefox است دستور زیر را اجرا کنید:

export BROWSER=firefox

اگر مرورگرتان کروم است دستور google-chrome و اگر کرومیوم است، دستور chromium-browser را جایگزین کنید.
از گزینه H- برای خواندن man page در مرورگر مورد نظر خود استفاده کنید:

man -Hfirefox vmstat

گزینه H- به groff دستور می دهد تا یک خروجی HTML تولید کند و آن خروجی را در مرورگر نمایش دهد.
گزینه f- به کاربران اجازه می دهد تا man page را سرچ کنند و توضیحات کوتاهی از دستور مشخص شده در ترمینال نمایش دهند. Syntax آن بصورت زیر است:

man -f [command name]

ویژگی a- به کاربران این امکان را می دهد که تمام صفحات manual موجود در هر section را یک به یک نمایش دهند.

man -a [command name]

گزینه k- به کاربران اجازه می دهد تا توضیحات کوتاه دستورات و نام manual page ها را برای یک کلمه کلیدی مشخص به عنوان یک regular expression جستجو کنند. syntax آن بصورت زیر است:

man -k [command name]

ویژگی w- محل manual page دستور مشخص شده را نشان می دهد. با افزودن گزینه a-، مکان همه فایل‌های مطابق با کلمه کلیدی نشان داده می شود. syntax آن هم بصورت زیر است:

man -w [command name]

در این مثال، ما از گزینه a- برای دیدن مکان‌های تمام man page های مرتبط استفاده کردیم. علاوه بر این، با استفاده از گزینه w- موقعیت فایل cat از پیش فرمت شده را نمایش می دهد. با گزینه a-، مکان همه فایل‌های cat از پیش فرمت‌شده مطابق با کلمه کلیدی را نمایش می دهد.