Como eu exibo diretamente uma página man?

Question

Estou escrevendo uma página man para um programa que estou empacotando. Como posso exibir o arquivo de manpage que criei, para verificar se está tudo bem? Existe uma maneira de passar meu arquivo diretamente para o comando man em vez de fazer com que ele pesquise as páginas de manual instaladas pelo nome?

Eu tentei fazer coisas como man myprog.1 e man < myprog.1 , mas em ambos os casos recebi um erro dizendo que a página man não foi encontrada.

    

Answer 1

man tem a opção de ler um arquivo local: -l

-l, --local-file

Activate 'local' mode. Format and display local manual files instead of searching through the system's manual collection. Each manual page argument will be interpreted as an nroff source file in the correct format. No cat file is produced.

If '-' is listed as one of the arguments, input will be taken from stdin. When this option is not used, and man fails to find the page required, before displaying the error message, it attempts to act as if this option was supplied, using the name as a filename and looking for an exact match.

Assim, você pode visualizar seu trabalho em andamento com:

man -l /path/to/manfile.1

    

Answer 2

A maneira "antiga", para sistemas que pré-datam a opção -l , é

nroff -man filename | more -s

    

Answer 3

Eu usei simplesmente

man ./path/to/man.1

Você precisa incluir uma barra no caminho, caso contrário, ele procura nos diretórios do sistema. Funciona nos sistemas Linux e OS X que eu tenho (o último não tem -l ).

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

    

Answer 4

No Solaris, a opção -M para man substituirá o caminho de pesquisa das páginas de manual: -

man -M path/to/man myprog

Seu arquivo de manpage deve residir em um subdiretório apropriado correspondente à seção e à linguagem de marcação, por exemplo: path/to/man/man1/myprog.1 para uma nroff-manpage na seção 1.