Как вручную установить файл справочной страницы?

Как установить файл справочной системы для всей системы?

Например, если у меня есть файл справочной страницы examplecommand.1, как мне установить его, чтобы я мог просто набрать man examplecommand посмотреть это?

Источник

3 ответа

Решение

  1. Сначала выясните, к какому разделу относится ваша справочная страница. Если это команда, она, вероятно, принадлежит разделу 1, Вы можете прочитать справочную страницу для man команда Значок Manpage чтобы увидеть описание различных разделов и их соответствующих номеров.

  2. Скопируйте свою страницу руководства на /usr/local/share/man/man1/ (менять 1 на ваш номер раздела, если это будет необходимо). Вы также можете установить его в /usr/share/man/man1/, но лучше всего использовать local каталог для файлов, которые устанавливаются без использования менеджера пакетов APT:

    sudo cp examplecommand.1 /usr/local/share/man/man1/

  3. Запустить mandb команда. Это обновит man внутренняя база данных:

    sudo mandb

  4. Это оно! Вы должны иметь возможность просматривать справочную страницу, выполнив:

    man 1 examplecommand

Рекомендации:

Источник

Если вам нужно только установить man-страницу локально:

Если MANPATH не установлен или содержит пустой компонент (т.е. начинается с :заканчивается :или содержит ::), затем <path>/share/man будет автоматически искать man-страницы всякий раз, когда <path>/bin это часть PATHдля всех значений<path>,

Это обеспечивает очень простой способ добавления справочных страниц для локально установленного программного обеспечения. Есть некоторые детали в man manpath а также /etc/manpath.config, но я не вижу упоминания об общем отображении из <path>/bin в <path>/share/man,

Источник

Для двоичного файла приложения, который был скопирован в ~/.local/bin, копируя его .1 файл man в ~/.local/share/man/man1 работал у меня на Ubuntu 18.04. Мне пришлось создать последний каталог. Теперь я могу получить доступ к странице руководства, используя man <app_name>.

Источник

Ответ @ntc2 выше - это то, на что должны смотреть люди. Я хотел добавить дополнительный комментарий, который не помещался в разделе комментариев:

Подход @ntc2 обеспечивает путь для людей, которым нужно только установить свой PATH (что они уже ожидают) для локальных двоичных файлов.

Тем не менее, я не думаю, что общее отображение <path>/bin -> <path>/share/man существует для всех путей в $PATH, Кажется, что это конкретное отображение избегается, когда $PATH речь идет $HOME/bin, При выполнении strace(1) на man с MANPATH=:/nonexistingdirЯ вижу следующие поиски:

Для любого элемента в $PATH это не $HOME/bin

  • <path>/bin -> <path>/man
  • <path>/bin -> <path>/bin/man
  • <path>/bin -> <path>/share/man
  • <path>/bin -> <path>/bin/share/man

За $HOME/bin

  • $HOME/bin -> $HOME/man

Я понятия не имею, почему это пропускает других. Это в системе Debian Buster. Это может отличаться в других системах.

Для меня это означает, что самый безопасный путь для установки man-страниц <path>/man, поскольку он гарантированно будет найден, если он находится в $PATH,

Источник
Другие вопросы по тегам