Документирование функций bash

Question

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

Я знаю, что могу сделать это, переопределив man функцией, которая проверяет мои собственные функции.Есть ли другой способ?

Answer 1

Если у вас созданы справочные страницы (что само по себе является задачей), то вы можете поместить их в систему где-нибудь, например /usr/local/man (или где угодно, на самом деле), а затем отредактировать всю систему $MANPATH переменная, чтобы включить это местоположение.Тогда страницы справочника будут доступны.

Answer 2

Реальные функции оболочки не документированы отдельными man страницами, а встроенной командой help. Вы должны переопределить это. Но даже я бы не стал там искать информацию.

Просто создайте обычные справочные страницы и добавьте их в /usr/local/man/manX или /usr/local/share/man/manX - все, что уже есть в вашем дистрибутиве. Проверьте /etc/manpath.config, что этот каталог там уже упоминался. Таким образом, никто не должен вмешиваться в свои файлы запуска с переменной среды MANPATH.

Каждая man-страница должна также содержать четко видимый раздел, объясняющий, что это функция , а не команда и в чем разница.

После этого включается социальная часть: сообщайте всем по каждый раз об этой документации. Под каждые я имею в виду каждые , а не только подходит . : -)