Como gerar um Unix MAN ?

Essa é sem duvida uma das perguntas mais
freqüentes entre administradores e usuários
de sistemas Unix*.

Existem diversos editores de manual, eu recomendo
por experiência própria o uso do Pod2man.

Pod2man é um script feito em perl, que e distribuído
juntamente com o pacote do perl, e é esse script
que tem a função de gerar todos os manuais do perl.

O Pod2man converte arquivos do tipo pod em manuais,
onde arquivos .pod seguem uma sintaxe, como eu poderia dizer
"Human-readable".

Exemplo de um arquivo ".pod"

[ricardo@ricardo(8:09am)] /tmp> cat blog.pod
=head1 NAME

Blog - Teste pod2man

=head1 SYNOPSIS

blog [te] ...

blog -h

=head1 DESCRIPTION

Como criar um man, usando Perl::Man através do pod2man.

=head1 OPTIONS

B<-t> tenha calma
B<-e> está acabando

=head1 EXAMPLES

Agora ... realmente esta no fim:

=head1 AUTHOR

Ricardo A. Reis ricardo dot areis at gmail dot com>

=head1 SEE ALSO

pod2man(<F4>)


Ao Final é descobrir em qual sessão o man
deve ser inserido, para que o mesmo seja
criado de forma correta.

Executando o próximo comando transformaremos um arquivo .pod
em um man no formato roff.

[ricardo@ricardo(8:09am)] /tmp> pod2man --section=8 --release="27 Setembro 2006"
--center="FreeBSD System Manager's Manual" --date="27 Setembro 2006" blog.pod > blog.8

Para visualizar é necessário passar o arquivo blog.8 pelo comando nroff, algo como:

[ricardo@ricardo(8:09am)] /tmp> nroff -mman blog.8 | more

BLOG(8) FreeBSD System Manager's Manual BLOG(8)

NAME

Blog - Teste pod2man


SYNOPSIS

blog [te] ...

blog -h

DESCRIPTION

Como criar um man, usando Perl::Man através do pod2man.

OPTIONS

-t tenha calma
-e está acabando

EXAMPLES

Agora ... realmente esta no fim:

AUTHOR

Ricardo A. Reis ricardo dot areis at gmail dot com>

SEE ALSO

pod2man(<F4>)


27 Setembro 2006 27 Setembro 2006 BLOG(8)


Pronto temos um man !!