Получение подсказок

Перейдите к следующему слайду, нажав кнопку Вправо

Как получить справку по команде

в терминалах Linux и macOS

Подготовлено онлайн-курсом

https://dvmn.org

$ help
GNU bash, version 4.4.12(1)-release (x86_64-pc-linux-gnu)
These shell commands are defined internally.  Type `help' to see this list.
Type `help name' to find out more about the function `name'.
Use `info bash' to find out more about the shell in general.
Use `man -k' or `info' to find out more about commands not in this list.
...

help

Получение подсказки по терминалу в целом

$ help echo
echo: echo [-neE] [arg ...]
    Write arguments to the standard output.
    
    Display the ARGs, separated by a single space character 
    and followed by a newline, on the standard output.
...

help

Получение подсказки по определенной команде, относящейся к bash, т.е. только терминалу, а не установленным позже программам. Например, команды man и tree устанавливаются отдельно

$ <команда> --help
Usage: <подсказка>

Аргумент --help

У некоторых команд есть режим подсказки. Чтобы его вызвать, нужно написать --help после имени команды.

$ chmod --help
Usage: chmod [OPTION]... MODE[,MODE]... FILE...
  or:  chmod [OPTION]... OCTAL-MODE FILE...
  or:  chmod [OPTION]... --reference=RFILE FILE...
Change the mode of each FILE to MODE.
With --reference, change the mode of each FILE to that of RFILE.

Аргумент --help

Это пример использования аргумента --help

$ chmod --help
Usage: chmod [OPTION]... MODE[,MODE]... FILE...
  or:  chmod [OPTION]... OCTAL-MODE FILE...
  or:  chmod [OPTION]... --reference=RFILE FILE...
Change the mode of each FILE to MODE.
With --reference, change the mode of each FILE to that of RFILE.

Аргумент --help

Это пример использования аргумента --help

название команды

подсказка по команде (результат)

$ ssh --help
usage: ssh [-46AaCfGgKkMNnqsTtVvXxYy] [-B bind_interface]
           [-b bind_address] [-c cipher_spec] [-D [bind_address:]port]
           [-E log_file] [-e escape_char] [-F configfile] [-I pkcs11]
           [-i identity_file] [-J [user@]host[:port]] [-L address]
           [-l login_name] [-m mac_spec] [-O ctl_cmd] [-o option] [-p port]
           [-Q query_option] [-R address] [-S ctl_path] [-W host:port]
           [-w local_tun[:remote_tun]] destination [command]

Аргумент --help

Это ещё один пример использования --help

$ chmod -h
Usage: chmod [OPTION]... MODE[,MODE]... FILE...
  or:  chmod [OPTION]... OCTAL-MODE FILE...
  or:  chmod [OPTION]... --reference=RFILE FILE...
Change the mode of each FILE to MODE.
With --reference, change the mode of each FILE to that of RFILE.

Аргумент -h

Иногда аргумент --help можно написать в короткой форме: -h

$ man echo

man

Получение развёрнутого мануала по команде (в данном случае команда echo)

$ info echo

info

Получение развёрнутого мануала по команде (в данном случае команда echo)

$ whatis whatis
whatis (1)           - display one-line manual page descriptions

~$ whatis echo
echo (1)             - display a line of text

~$ whatis ls
ls (1)               - list directory contents

whatis

Короткое описание того, что делает команда

Какой способ выбрать?

Все способы равноправны. 
Если не получилось одним, попробуйте другой.

Такое количество путей получить справку возникло по историческим причинам.

Создано для онлайн-курса https://dvmn.org