🐧 Как отобразить подсказки по командам Linux с помощью Eg

Автор cryptoparty На чтение 4 мин Опубликовано 16.04.2021

Изучение команд Linux с каждым днем становится все проще!

Если вы знаете, как правильно использовать справочные страницы man, значит, вы прошли половину пути к командной строке Linux.

Есть также несколько хороших альтернативных страниц руководства, которые помогут вам отображать шпаргалки по командам Linux.

В отличие от man эти инструменты будут отображать только краткие примеры для большинства команд и исключить все остальные теоретические части.

Сегодня обсудим еще одно полезное дополнение к этому списку.

Поприветствуйте, Eg, инструмент командной строки со шпаргалками для отображения полезных примеров команд Linux.

Eg предоставляет практические примеры многих команд Linux и Unix.

Если вы хотите быстро найти примеры конкретной команды Linux, не просматривая длинные справочные страницы, например, это отличный выбор.

Просто запустите, Eg и имя команды и получите краткие примеры данной команды прямо в окне Терминала.

Eg это бесплатная программа с открытым исходным кодом, написанная на языке Python, и ее код находится в свободном доступе на GitHub.

Для интересующихся, Eg происходит от латинского слова «Exempli Gratia», которое означает «для примера».

Содержание

Установка Eg на Linux
Отображение шпаргалок по командам Linux с помощью Eg
Список доступных команд
Как редактировать команды

Установка Eg на Linux

Eg можно установить с помощью диспетчера пакетов Pip.

Если Pip недоступен в вашей системе, установите его, как описано в приведенной ниже ссылке.

Узнайте, как установить Pip на Ubuntu

После установки Pip выполните следующую команду для установки Eg в вашей системе Linux:

$ pip install eg

Отображение шпаргалок по командам Linux с помощью Eg

Давайте начнем с отображения раздела справки.

Для этого запустите eg без каких-либо опций:

$ eg

Вывод:

usage: eg [-h] [-v] [-f CONFIG_FILE] [-e] [--examples-dir EXAMPLES_DIR]
          [-c CUSTOM_DIR] [-p PAGER_CMD] [-l] [--color] [-s] [--no-color]
          [program]

eg provides examples of common command usage.

positional arguments:
  program               The program for which to display examples.

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Display version information about eg
  -f CONFIG_FILE, --config-file CONFIG_FILE
                        Path to the .egrc file, if it is not in the default
                        location.
  -e, --edit            Edit the custom examples for the given command. If
                        editor-cmd is not set in your .egrc and $VISUAL and
                        $EDITOR are not set, prints a message and does
                        nothing.
  --examples-dir EXAMPLES_DIR
                        The location to the examples/ dir that ships with eg
  -c CUSTOM_DIR, --custom-dir CUSTOM_DIR
                        Path to a directory containing user-defined examples.
  -p PAGER_CMD, --pager-cmd PAGER_CMD
                        String literal that will be invoked to page output.
  -l, --list            Show all the programs with eg entries.
  --color               Colorize output.
  -s, --squeeze         Show fewer blank lines in output.
  --no-color            Do not colorize output.

Вы также можете вызвать раздел справки, используя эту команду:

$ eg --help

Теперь давайте посмотрим, как просмотреть примеры использования команд.

Чтобы отобразить шпаргалку команды Linux, например grep, выполните:

$ eg grep

Пример вывода:

grep
print all lines containing foo in input.txt
grep "foo" input.txt
print all lines matching the regex "^start" in input.txt
grep -e "^start" input.txt
print all lines containing bar by recursively searching a directory
grep -r "bar" directory
print all lines containing bar ignoring case
grep -i "bAr" input.txt
print 3 lines of context before and after each line matching "foo"
grep -C 3 "foo" input.txt
Basic Usage
Search each line in input_file for a match against pattern and print
matching lines:
grep "<pattern>" <input_file>
[...]

Как видно из вышеприведенного вывода, отображаются примеры команд для утилиты grep вместе с кратким описанием.

Нет необходимости просматривать длинные страницы руководства, не нужно ссылаться на какие-либо флаги.

Вы мгновенно получите примеры данной команды.

Вы даже можете получить примеры, самой команды eg:

$ eg eg

Список доступных команд

Разработчики и все другие участники проекта Eg добавили много примеров для каждой команды.

Вы можете просмотреть список всех доступных команд, используя команду:

$ eg --list

На момент написания этого руководства приведены примеры для 85 утилит командной строки.

Если вы хотите добавить к команде больше примеров, просто передайте флаг -e, чтобы отредактировать набор команд по умолчанию и добавить свои собственные команды.

Перед добавлением/редактированием пользовательских команд создайте каталог для сохранения.

Это каталог, в котором вы будете сохранять все свои пользовательские команды.

$ mkdir ~/.eg/

Затем отредактируйте, файл конфигурации:

$ nano ~/.egrc

Добавьте в него следующие строки:

[eg-config] custom-dir = ~/.eg/

Например, чтобы отредактировать примеры команды grep, запустите:

$ eg -e grep