Como criar um arquivo man para Linux e FreeBSD

Alguem sabe como criar um arquivo man para linux e freebsd, Se desse para criar um tutorial simples para iniciante seria bom. Eh verdade que o arquivo man ter o formato .man? MAN File Extension - What is a .man file and how do I open it? Da para colocar links para o site official de um app no arquivo man?

Falta tutorial em portugues de como fazer isso.

É bem simples na verdade, você precisa de um arquivo tipo texto puro com essa sintaxe:

NAME
    O nome do comando ou ferramenta e uma descrição simples  (uma linha)
SYNOPSIS
    Uma descrição técnicado comando e a lista de switches
DESCRIPTION
    Uma descrição textual explicando cada switch
EXAMPLES
    Os exemplos 
SEE ALSO
    comandosrelacionados 
BUGS
    link com os bugs conhecidos da versão 
AUTHOR
   Seu email, github ou qualquer coisa que permita o usuário te contatar 
COPYRIGHT
    Mesmo sendo foss você precisa dar informações dos autores do software e da manpage

O arquivo deve ser salvo com o seguinte padrão: “comando.1”

Depois você compacta:

gzip comando.1

E por fim instala:

cp comando.1.gz /usr/local/share/man/man1/

E pronto agora você pode:

man comando
2 Curtidas

funciona no FreeBSD?

1 Curtida

Qualquer *nix que use o man padrão