Відмінності між версіями «Команда MAN»

Матеріал з Вікі ЦДУ
Перейти до: навігація, пошук
(Вступ)
(Linux: man)
 
Рядок 3: Рядок 3:
  
  
 +
MAN сторінки  - це велика документація, попередньо встановлена ​​майже у всіх значних UNIX подібних операційних системах, включаючи Arch Linux. Для їх відображення служить команда чоловік.
 +
Не дивлячись на свій масштаб, чоловік сторінки розроблені як самодостатні документи і внаслідок чого обмежені в можливості посилатися на інші людина сторінки під час обговорення пов'язаних тем. На противагу гіпертекстових Інформація файлів - спробі GNU замінити формат традиційних людина сторінок.
  
 +
== Доступ до MAN сторінок ==
 +
Щоб прочитати MAN сторінку просто введіть:
  
==== '''Вступ''' ====
+
$ man ім`я сторінки
  
Один з важливих рефлексів, який повинен розвинутися у кожного користувача Linux – це пошук інформації, якщо щось іде не так. Але незважаючи на той факт, що ми живемо в світі, пов'язаному з пошуковими системами, вікі і величезною кількістю іформації, завжди добре мати локальну інформацію в своїй системі. Це забезпечує простий і швидкий доступ до інформації, навіть за відсутності підключення до інтернету. Крім того, знайденій в інтернеті інформації не завжди можна довіряти, тоді як в посібниках все викладено чітко і послідовно. Філософія Unix , по спадку, Linux ) говорить про те, що система повинна бути добре документована. Тому кожна програма поширюється з відповідною man - сторінкою.
+
Керівництва відсортовані за кількома секціями:
 +
* Основні команди
 +
* Системні виклики (функції надані ядром )
 +
* Бібліотечні виклики (функції бібліотеки мови C)
 +
* Спеціальні файли ( зазвичай розташовані в каталозі / Dev ) і драйвери
 +
* Формат файлів і угоди
 +
* ігри
 +
* Різне ( включаючи угоди )
 +
* Команди для системного адміністрування ( зазвичай вимагають привілеїв root'а ) і демони
 +
На man сторінки зазвичай посилаються по їх імені з наступним номером секції в круглих дужках. Часто існують кілька man сторінок з однаковим ім'ям , такі як man ( 1 ) і man(7 ). У цьому випадку необхідно передати команді man номер секції з наступним ім'ям сторінки, наприклад:
  
==== '''''Використання man-сторінок''''' ====
+
$ man 5 passwd
  
Якщо ви використовуєте один з популярних дистрибутивів, то man-сторінки швидше за все вже встановлені як частина ядра системи разом з такими важливими речами як shell або система init. Щоб краще зрозуміти, як працює man, просто введіть команду man man. Саме так все і працює: якщо мені потрібна man-сторінка для ls, я вводжу man ls.
+
щоб прочитати по ''/etc/passwd'', зімість утиліти ''passwd''
  
Так як, більшість man-сторінок складаються більш ніж з однієї сторінки, для виведення використовується less, і сторінки можна перегортати за допомогою клавіш PgUp і PgDown, або Space і Esc + V. Вийти з man-сторінки можна в будь-який час за допомогою клавіші "q". Пошук в man-сторінці викликається за допомогою клавіши "/", кожне наступне знайдене входження можна переглянути за допомогою клавіши "n". Якщо ви знаєте, що вам потрібно, але не знаєте точну назву man-сторінки, вам допоможе apropos (1). Для пошуку команд замість аpropos можна використовувати man з ключем-k (man-k рядок) – буде теж саме.
+
Дуже короткі опис програм можна прочитати з man сторінок не виводячи з цілком за допомогою команди ''whatis''
+
 
==== '''''Структура man-сторінок''''' ====
+
Наприклад, для короткого опису ls, надрукуйте:
При першому погляді на man-документ його буває важко зрозуміти, тому що він не схожий на простий текст-пояснення (він їм і не є). Мани завжди строго структуровані і розбиті на розділи. Деякі з розділів присутні обов'язково, інші за необхідності:
+
$ whatis ls
NAME (ІМ'Я) – команда і те , що вона робить.
+
і ''whatis'' виведе ''"list directory contents."''
SYNOPSIS (ОГЛЯД) – синтаксис команди. Параметри без дужок є обов'язковими, а в квадратних дужках – ні (зазвичай це ключі) .
+
 
DESCRIPTION (ОПИС) – докладний опис як використовувати команду.
+
== Формат ==
OPTIONS (ОПЦІЇ) – перелік можливих ключів і їх опис .
+
Всі man сторінки строго слідують стандарного формату, який допомагає в навігації по ним. Деякі часто представлені секції:
 +
* NAME (ИМЯ) -Назва команди і короткий вираз, що описує її призначення
 +
* SYNOPSIS (СИНТАКСИС) - Список опцій і аргументів, які приймає команда або параметри функції та її заголовний файл
 +
* DESCRIPTION (ОПСИ) - Детальний опис призначення команди або функції і принципів роботи.
 +
* EXAMPLES (ПРИКЛАДИ) - Типові приклади, звичайно починаючи з простих до відносно складних.
 +
* OPTIONS (ОПЦІЇ) - Опис кожної з опцій, які приймає комнад, і що вони роблять.
 +
* EXIT STATUS (СТАТУС ВИХОДУ) - Значення різних кодів виходу.
 +
* FILES (ФАЙЛИ) - Файли пов'язані з командою або функцією.
 +
* BUGS (ПОМИЛКИ) -Проблеми з командою або функцією очікують рішення. Також відомі як відомі помилки (ВІДОМІ ПОМИЛКИ)
 +
* SEE ALSO (ДИВИСЬ ТАКОЖ) - Список пов'язаних команд і функцій
 +
* AUTHOR (АВТОР), HISTORY (ІСТОРІЯ), COPYRIGHT (ПРАВА), LICENSE (ЛІЦЕНЗІЯ), WARRANTY (ГАРАНТІЯ) -Інформація про програму, її минуле, умови використання та її авторів.
 +
 
 +
== Пошук документації ==
 +
 
 +
Хоча утиліта man позовляет користувачам проматрівать сторінки керівництв, виникає проблема, коли ви не знаєте точного імені бажаної людина сторінки! На щастя, ви можете скористатися опцією '''' або ''-apropos'' з приводу для пошуку в короткому описі сторінки керівництва заданого ключового слова. Наприклад, щоб знайти сторінку відноситься до "password":
 +
 
 +
$ man -k password
 +
або
 +
$ man --apropos password
 +
 
 +
Це еквівалентно викликом команди ''apropos''
 +
 
 +
$ apropos password
 +
Задане ключове слово, по-замовчуванням, інтерпретується як регулярний вираз.
 +
 
 +
== Кольорові Man сторінки ==
 +
Для деяких користувачів кольорові man сторінки дозволяють отримати більш чітке уявлення і легше переварити вміст. Враховуючи, що нові користувачі Linux змушені витрачати значно кількість часу для ознайомлення з основними користувацькими інструментами, створення комфортних умов для більшості є необхідним.
 +
Є два основних способи отримання цвених людина сторінок: використання ''most'', або за допомогою опцій для ''less''. Перший простіше в налаштуваннях на шкоду додаткових функцій властивих ''less''.
 +
 
 +
'''Перший спосіб: використовуючи "most"'''
 +
 
 +
Встановіть ''most'' з допомогою '''pacman''':
 +
# pacman -S most
 +
 
 +
Це програма подібна ''less'' і ''more'', а також з легкістю дозволяє відображати кольоровий текст.
 +
Відредагуйте ''/etc/man_db.conf'', розкоментуйте визначення переглядач з замініть його наступним чином:
 +
DEFINE    pager    most -s
 +
Протестуйте нові налаштування надрукувавши:
 +
$ man whatever_man_page
 +
Зміна кольору вимагає редагування ''~ /. Mostrc'' (створіть, якщо його не існує) або редагування ''/etc/most.conf'' для глобальних налаштувань. . Наприклад, ''~ / mostrc'':
 +
% Color settings
 +
color normal lightgray black
 +
color status yellow blue
 +
color underline yellow black
 +
color overstrike brightblue black
 +
 
 +
Наступний приклад демостріруєт настройку прив'язки клавіш схожу з ''less''(перейти на наступний рядок установленно для "J"):
 +
% less-like keybindings
 +
unsetkey "^K"
 +
unsetkey "g"
 +
unsetkey "G"
 +
unsetkey ":"
 +
 
 +
setkey next_file ":n"
 +
setkey find_file ":e"
 +
setkey next_file ":p"
 +
setkey toggle_options ":o"
 +
setkey toggle_case ":c"
 +
setkey delete_file ":d"
 +
setkey exit ":q"
 +
 
 +
setkey bob "g"
 +
setkey eob "G"
 +
setkey down "e"
 +
setkey down "E"
 +
setkey down "j"
 +
setkey down "^N"
 +
setkey up "y"
 +
setkey up "^Y"
 +
setkey up "k"
 +
setkey up "^P"
 +
setkey up "^K"
 +
setkey page_down "f"
 +
setkey page_down "^F"
 +
setkey page_up "b"
 +
setkey page_up "^B"
 +
setkey other_window "z"
 +
setkey other_window "w"
 +
setkey search_backward "?"
 +
setkey bob "p"
 +
setkey goto_mark "'"
 +
setkey find_file "E"
 +
setkey edit "v"
 +
 
 +
'''Другий спосіб: використання '''less''''''
 +
Як альтернатива, отримання приблизно таких же кольорових довідкових сторінок можливо за допомогою {CodeLine | менш}}. Цей метод має ту перевагу, що ''less'' має більший набір функцій, ніж ''most'', і цей спосіб може бути краще для досвідчених користувачів.  
 +
Додайте наступне в файл конфігурації оболонки (оболонки). Для '''Bash''' це ''~ / Bashrc.'':
 +
man() {
 +
env \
 +
LESS_TERMCAP_mb=$(printf "\e[1;37m") \
 +
LESS_TERMCAP_md=$(printf "\e[1;37m") \
 +
LESS_TERMCAP_me=$(printf "\e[0m") \
 +
LESS_TERMCAP_se=$(printf "\e[0m") \
 +
LESS_TERMCAP_so=$(printf "\e[1;47;30m") \
 +
LESS_TERMCAP_ue=$(printf "\e[0m") \
 +
LESS_TERMCAP_us=$(printf "\e[0;36m") \
 +
man "$@"
 +
}

Поточна версія на 12:12, 4 червня 2014

Linux: man

MAN сторінки - це велика документація, попередньо встановлена ​​майже у всіх значних UNIX подібних операційних системах, включаючи Arch Linux. Для їх відображення служить команда чоловік. Не дивлячись на свій масштаб, чоловік сторінки розроблені як самодостатні документи і внаслідок чого обмежені в можливості посилатися на інші людина сторінки під час обговорення пов'язаних тем. На противагу гіпертекстових Інформація файлів - спробі GNU замінити формат традиційних людина сторінок.

Доступ до MAN сторінок

Щоб прочитати MAN сторінку просто введіть:

$ man ім`я сторінки

Керівництва відсортовані за кількома секціями:

  • Основні команди
  • Системні виклики (функції надані ядром )
  • Бібліотечні виклики (функції бібліотеки мови C)
  • Спеціальні файли ( зазвичай розташовані в каталозі / Dev ) і драйвери
  • Формат файлів і угоди
  • ігри
  • Різне ( включаючи угоди )
  • Команди для системного адміністрування ( зазвичай вимагають привілеїв root'а ) і демони

На man сторінки зазвичай посилаються по їх імені з наступним номером секції в круглих дужках. Часто існують кілька man сторінок з однаковим ім'ям , такі як man ( 1 ) і man(7 ). У цьому випадку необхідно передати команді man номер секції з наступним ім'ям сторінки, наприклад:

$ man 5 passwd

щоб прочитати по /etc/passwd, зімість утиліти passwd

Дуже короткі опис програм можна прочитати з man сторінок не виводячи з цілком за допомогою команди whatis

Наприклад, для короткого опису ls, надрукуйте:

$ whatis ls

і whatis виведе "list directory contents."

Формат

Всі man сторінки строго слідують стандарного формату, який допомагає в навігації по ним. Деякі часто представлені секції:

  • NAME (ИМЯ) -Назва команди і короткий вираз, що описує її призначення
  • SYNOPSIS (СИНТАКСИС) - Список опцій і аргументів, які приймає команда або параметри функції та її заголовний файл
  • DESCRIPTION (ОПСИ) - Детальний опис призначення команди або функції і принципів роботи.
  • EXAMPLES (ПРИКЛАДИ) - Типові приклади, звичайно починаючи з простих до відносно складних.
  • OPTIONS (ОПЦІЇ) - Опис кожної з опцій, які приймає комнад, і що вони роблять.
  • EXIT STATUS (СТАТУС ВИХОДУ) - Значення різних кодів виходу.
  • FILES (ФАЙЛИ) - Файли пов'язані з командою або функцією.
  • BUGS (ПОМИЛКИ) -Проблеми з командою або функцією очікують рішення. Також відомі як відомі помилки (ВІДОМІ ПОМИЛКИ)
  • SEE ALSO (ДИВИСЬ ТАКОЖ) - Список пов'язаних команд і функцій
  • AUTHOR (АВТОР), HISTORY (ІСТОРІЯ), COPYRIGHT (ПРАВА), LICENSE (ЛІЦЕНЗІЯ), WARRANTY (ГАРАНТІЯ) -Інформація про програму, її минуле, умови використання та її авторів.

Пошук документації

Хоча утиліта man позовляет користувачам проматрівать сторінки керівництв, виникає проблема, коли ви не знаєте точного імені бажаної людина сторінки! На щастя, ви можете скористатися опцією або -apropos з приводу для пошуку в короткому описі сторінки керівництва заданого ключового слова. Наприклад, щоб знайти сторінку відноситься до "password":

$ man -k password

або

$ man --apropos password

Це еквівалентно викликом команди apropos

$ apropos password 

Задане ключове слово, по-замовчуванням, інтерпретується як регулярний вираз.

Кольорові Man сторінки

Для деяких користувачів кольорові man сторінки дозволяють отримати більш чітке уявлення і легше переварити вміст. Враховуючи, що нові користувачі Linux змушені витрачати значно кількість часу для ознайомлення з основними користувацькими інструментами, створення комфортних умов для більшості є необхідним. Є два основних способи отримання цвених людина сторінок: використання most, або за допомогою опцій для less. Перший простіше в налаштуваннях на шкоду додаткових функцій властивих less.

Перший спосіб: використовуючи "most"

Встановіть most з допомогою pacman:

# pacman -S most

Це програма подібна less і more, а також з легкістю дозволяє відображати кольоровий текст. Відредагуйте /etc/man_db.conf, розкоментуйте визначення переглядач з замініть його наступним чином:

DEFINE     pager     most -s

Протестуйте нові налаштування надрукувавши:

$ man whatever_man_page

Зміна кольору вимагає редагування ~ /. Mostrc (створіть, якщо його не існує) або редагування /etc/most.conf для глобальних налаштувань. . Наприклад, ~ / mostrc:

% Color settings
color normal lightgray black
color status yellow blue
color underline yellow black
color overstrike brightblue black

Наступний приклад демостріруєт настройку прив'язки клавіш схожу з less(перейти на наступний рядок установленно для "J"):

% less-like keybindings
unsetkey "^K"
unsetkey "g"
unsetkey "G"
unsetkey ":"
setkey next_file ":n"
setkey find_file ":e"
setkey next_file ":p"
setkey toggle_options ":o"
setkey toggle_case ":c"
setkey delete_file ":d"
setkey exit ":q"
setkey bob "g"
setkey eob "G"
setkey down "e"
setkey down "E"
setkey down "j"
setkey down "^N"
setkey up "y"
setkey up "^Y"
setkey up "k"
setkey up "^P"
setkey up "^K"
setkey page_down "f"
setkey page_down "^F"
setkey page_up "b"
setkey page_up "^B"
setkey other_window "z"
setkey other_window "w"
setkey search_backward "?"
setkey bob "p"
setkey goto_mark "'"
setkey find_file "E"
setkey edit "v"

'Другий спосіб: використання less' Як альтернатива, отримання приблизно таких же кольорових довідкових сторінок можливо за допомогою {CodeLine | менш}}. Цей метод має ту перевагу, що less має більший набір функцій, ніж most, і цей спосіб може бути краще для досвідчених користувачів. Додайте наступне в файл конфігурації оболонки (оболонки). Для Bash це ~ / Bashrc.:

man() {
env \
LESS_TERMCAP_mb=$(printf "\e[1;37m") \
LESS_TERMCAP_md=$(printf "\e[1;37m") \
LESS_TERMCAP_me=$(printf "\e[0m") \
LESS_TERMCAP_se=$(printf "\e[0m") \
LESS_TERMCAP_so=$(printf "\e[1;47;30m") \
LESS_TERMCAP_ue=$(printf "\e[0m") \
LESS_TERMCAP_us=$(printf "\e[0;36m") \
man "$@"
}