آشنایی با man pages لینوکس

خواه شما یک کاربر حرفه یی لینوکس باشید و خواه یک مبتدی، همواره مسائلی وجود دارند که از آن‌ها آگاهی نداشته و برای کسب اطلاعاتی موثق در مورد آن‌ها، نیاز به مستنداتی معتبر دارید که از جمله ی این مستندات معتبر لینوکسی، می‌توان به موارد زیر اشاره کرد:

• man pages لینوکس 
• GNU Info لینوکس
• کامند help و آپشن help--
• مستندات اختصاصی توزیع‌های لینوکسی مثلا مستندات توزیع Gentoo

در این فصل، نگاهی کلی به مستندات راهنمای لینوکس خواهیم انداخت؛ در این آموزش با مهم ترین آن ها یعنی برنامه ی man کار خود را آغاز کرده و در آموزش های بعدی به سایر موارد خواهیم پرداخت.

man pages

این گروه از مستندات به منزله پرکاربردترین مستندات سیستم عامل های بر پایه ی یونیکس همچون لینوکس هستند که به صورت پیش‌ فرض در اکثر توزیع‌های لینوکسی گنجانده شده اند به طوری که اطلاعاتی وسیع در مورد بسیاری از اپلیکیشن ها، فایل‌های کانفیگ، کرنل و غیره در اختیار کاربران قرار می دهند. جالب است بدانیم که man pages برای اولین بار در دهه ی ۱۹۷۰ برای اولین نسخه های سیستم عامل UNIX به کار گرفته شدند.

گرچه توضیحاتی که این دست از مستندات در اختیار کاربران مبتدی قرار می‌دهند تا حدودی گیج‌کننده اند، اما به محض این که به روش ارائه مستندات man pages عادت کنیم، می توانیم آن را به عنوان یکی از قابل اعتماد ترین مستندات لینوکس در نظر بگیریم.

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

به طور کلی، کاربرد دستور man بسیار ساده است:

man [option(s)] keyword(s)

همان‌طور که در دستور فوق مشاهده می شود، ابتدا کامند man را نوشته، پس از آن می‌توانیم آپشن یا آپشن های مد نظر خود را وارد کنیم -در ادامه با مفهوم آپشن بیشتر آشنا خواهیم شد- و در نهایت هم کلیدواژگانی که می‌خواهیم در مورد آن‌ها اطلاعاتی کسب کنیم را وارد کرده و اینتر می کنیم.

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

man ls

خروجی دستور فوق به صورت زیر خواهد بود:

LS(1)                            User Commands                           LS(1)

NAME
       ls - list directory contents

SYNOPSIS
       ls [OPTION]... [FILE]...

DESCRIPTION
       List  information  about  the FILEs (the current directory by default).
       Sort entries alphabetically if none of -cftuvSUX nor --sort  is  speci‐
       fied.

       Mandatory  arguments  to  long  options are mandatory for short options
       too.

       -a, --all
              do not ignore entries starting with .

       -A, --almost-all
              do not list implied . and ..

       --author
              with -l, print the author of each file

       -b, --escape
              print C-style escapes for nongraphic characters

       --block-size=SIZE
              scale sizes by SIZE before printing them; e.g., '--block-size=M'
              prints sizes in units of 1,048,576 bytes; see SIZE format below

       -B, --ignore-backups
              do not list implied entries ending with ~

       -c     with -lt: sort by, and show, ctime (time of last modification of
              file status information); with -l: show ctime and sort by  name;
              otherwise: sort by ctime, newest first

       -C     list entries by columns

       --color[=WHEN]
              colorize  the output; WHEN can be 'always' (default if omitted),
              'auto', or 'never'; more info below

       -d, --directory
              list directories themselves, not their contents

       -D, --dired
              generate output designed for Emacs' dired mode

       -f     do not sort, enable -aU, disable -ls --color

       -F, --classify
              append indicator (one of */=>@|) to entries

       --file-type
              likewise, except do not append '*'

       --format=WORD
              across -x, commas -m, horizontal -x, long -l, single-column  -1,
              verbose -l, vertical -C

       --full-time
              like -l --time-style=full-iso

       -g     like -l, but do not list owner

       --group-directories-first
              group directories before files;

              can   be  augmented  with  a  --sort  option,  but  any  use  of
              --sort=none (-U) disables grouping
       -G, --no-group
              in a long listing, don't print group names

       -h, --human-readable
              with -l and/or -s, print human readable sizes (e.g., 1K 234M 2G)

       --si   likewise, but use powers of 1000 not 1024

       -H, --dereference-command-line
              follow symbolic links listed on the command line

       --dereference-command-line-symlink-to-dir
              follow each command line symbolic link

              that points to a directory

       --hide=PATTERN
              do not list implied entries matching shell  PATTERN  (overridden
              by -a or -A)

       --indicator-style=WORD
              append indicator with style WORD to entry names: none (default),
              slash (-p), file-type (--file-type), classify (-F)

       -i, --inode
              print the index number of each file

       -I, --ignore=PATTERN
              do not list implied entries matching shell PATTERN

       -k, --kibibytes
              default to 1024-byte blocks for disk usage

       -l     use a long listing format

       -L, --dereference
              when showing file information for a symbolic link, show informa‐
              tion  for  the file the link references rather than for the link
              itself

       -m     fill width with a comma separated list of entries

       -n, --numeric-uid-gid
              like -l, but list numeric user and group IDs

       -N, --literal
              print raw entry names (don't treat e.g. control characters  spe‐
              cially)

       -o     like -l, but do not list group information

       -p, --indicator-style=slash
              append / indicator to directories

       -q, --hide-control-chars
              print ? instead of nongraphic characters

       --show-control-chars
              show nongraphic characters as-is (the default, unless program is
              'ls' and output is a terminal)

       -Q, --quote-name
              enclose entry names in double quotes

       --quoting-style=WORD
              use quoting style WORD for entry names: literal, locale,  shell,
              shell-always, shell-escape, shell-escape-always, c, escape

       -r, --reverse
              reverse order while sorting
 -R, --recursive
              list subdirectories recursively

       -s, --size
              print the allocated size of each file, in blocks

       -S     sort by file size, largest first

       --sort=WORD
              sort  by  WORD instead of name: none (-U), size (-S), time (-t),
              version (-v), extension (-X)

       --time=WORD
              with -l, show time as WORD instead of default modification time:
              atime  or  access  or  use  (-u); ctime or status (-c); also use
              specified time as sort key if --sort=time (newest first)

       --time-style=STYLE
              with -l, show times using style STYLE: full-iso, long-iso,  iso,
              locale,  or  +FORMAT;  FORMAT  is interpreted like in 'date'; if
              FORMAT  is  FORMAT1FORMAT2,  then  FORMAT1  applies  to
              non-recent  files  and FORMAT2 to recent files; if STYLE is pre‐
              fixed with 'posix-', STYLE takes effect only outside  the  POSIX
              locale

       -t     sort by modification time, newest first

       -T, --tabsize=COLS
              assume tab stops at each COLS instead of 8

       -u     with  -lt:  sort by, and show, access time; with -l: show access
              time and sort by name; otherwise: sort by  access  time,  newest
              first

       -U     do not sort; list entries in directory order

       -v     natural sort of (version) numbers within text

       -w, --width=COLS
              set output width to COLS.  0 means no limit

       -x     list entries by lines instead of by columns

       -X     sort alphabetically by entry extension

       -Z, --context
              print any security context of each file

       -1     list one file per line.  Avoid '\n' with -q or -b

       --help display this help and exit

       --version
              output version information and exit

       The  SIZE  argument  is  an  integer and optional unit (example: 10K is
       10*1024).  Units are K,M,G,T,P,E,Z,Y  (powers  of  1024)  or  KB,MB,...
       (powers of 1000).

       Using  color  to distinguish file types is disabled both by default and
       with --color=never.  With --color=auto, ls emits color codes only  when
       standard  output is connected to a terminal.  The LS_COLORS environment
       variable can change the settings.  Use the dircolors command to set it.
 Exit status:
       0      if OK,

       1      if minor problems (e.g., cannot access subdirectory),

       2      if serious trouble (e.g., cannot access command-line argument).

AUTHOR
       Written by Richard M. Stallman and David MacKenzie.

REPORTING BUGS
       GNU coreutils online help: <http://www.gnu.org/software/coreutils/>
       Report ls translation bugs to <http://translationproject.org/team/>

COPYRIGHT
       Copyright © 2016 Free Software Foundation, Inc.   License  GPLv3+:  GNU
       GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
       This  is  free  software:  you  are free to change and redistribute it.
       There is NO WARRANTY, to the extent permitted by law.

SEE ALSO
       Full documentation at: <http://www.gnu.org/software/coreutils/ls>
       or available locally via: info '(coreutils) ls invocation'

GNU coreutils 8.25               February 2016                           LS(1)

به طور کلی، man pages به ۹ فصل مختلف تقسیم‌بندی می شوند. کاربرد شماره ی فصول به این شکل است که برنامه ی man را مجبور می‌سازد تا اطلاعات مرتبط با جستجوی کاربر در آن فصل به‌خصوص را نشان دهد چرا که معمولاً این احتمال وجود دارد که یک کلیدواژه در چندین فصل مختلف توضیح داده شده باشد:

man 3 printf

دستور فوق، برنامه ی man را مجبور می‌کند که به دنبال کلیدواژه یی تحت عنوان printf در فصل 3 بگردد. دستور زیر هم man مجبور می‌کند تا کلیدواژه ی printf را در کلیه ی فصول بیابد:

man -a printf

به طور کلی، ۹ فصل کامند man عبارتند از:

Executable programs or shell commands
System calls (functions provided by the kernel)
Library calls (functions within program libraries)
Special files (usually found in /dev)
File formats and conventions eg /etc/passwd
Games
Miscellaneous (including macro packages and conventions)
System administration commands (usually only for root)
Kernel routines [Non standard]

از آنجا که ممکن است برخی جستجوها حاوی اطلاعات گسترده یی باشند که نمایش آن‌ها در قالب یک صفحه امکان‌پذیر نباشد، خروجی دستور man از طریق یک برنامه ی Pager رندر می شود. برنامه‌های Pager این امکان را در اختیار ما می‌دهند تا به جای آن که حجم گسترده یی از اطلاعات در معرض دیدمان قرار گیرد و برای مشاهده ی بخش‌های بعدی مجبور شویم اسکرول کنیم، در هر لحظه، یک صفحه از اطلاعات را بتوانیم در قالبی مناسب و خوانا مشاهده کنیم. برنامه ی پیجری که معمولاً در اکثر توزیع‌های لینوکسی استفاده می‌شود less نام دارد.

در چنین شرایطی، برای رفتن به صفحه ی بعد باید کلید Spacebar را بفشاریم و برای بازگشت به صفحات قبلی هم کلید b. با فشردن کلید q روی کیبورد هم از حالت man خارج خواهیم شد.

آشنایی با دستور whatis

نسخه یی خلاصه و مفید از man pages، دستوری است تحت عنوان whatis که همان طور که از نامش پیدا است، به معرفی کامندهای مختلف می پردازد. به طور مثال، برای آگاهی از کاربرد دستور ls، دستور زیر را وارد ترمینال می کنیم:

whatis ls

به عنوان خروجی دستور فوق داریم:

ls (1)               - list directory contents

همان طور که مشاهده می شود، توضیحی خیلی خلاصه در قالب یک خط از دستور ls در معرض دیدمان قرار می گیرد که این توضیحات برگرفته از توضیحات man pages دستور ls هستند.