Как мне напрямую отобразить страницу руководства?

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

Я пытался делать такие вещи , как man myprog.1и , man < myprog.1но в обоих случаях я получил сообщение об ошибке говорящее , что страница не может быть найден.

man имеет возможность прочитать локальный файл: -l

-l, --local-file

Активировать локальный режим. Отформатируйте и отобразите локальные файлы руководства вместо поиска в системной коллекции руководств. Каждый аргумент страницы руководства будет интерпретирован как исходный файл nroff в правильном формате. Файл cat не создается.

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

Таким образом, вы можете просмотреть свою работу в процессе с:

man -l /path/to/manfile.1

Способ «старой школы» для систем, которые предшествуют этому -lварианту,

nroff -man filename | more -s

Я использовал просто

man ./path/to/man.1

Вы должны включить косую черту в путь, иначе он ищет системные каталоги. Работает на Linux и OS X системах у меня (последний не имеет -l).

$ cd /tmp
$ cp /usr/share/man/man1/ls.1 .
$ man ls.1
No manual entry for ls.1
$ man ./ls.1     # works

В Solaris -Mпереключатель manпереопределит путь поиска для страниц man:

man -M path/to/man myprog

Ваш man-файл должен находиться в соответствующем подкаталоге, соответствующем разделу и языку разметки, например: path/to/man/man1/myprog.1для nroff-manpage в разделе 1.