Gerar man page em tempo real?

2

Estou trabalhando em uma estrutura de script de linha de comando. Nós gostaríamos de gerar man pages para nossos comandos. No entanto, eles são bastante dinâmicos, dependendo da sua instalação. Então, idealmente, poderíamos interceptar a chamada do homem e escrever a página do manual naquele momento ou simplesmente canalizá-la diretamente para o monitor do homem.

Sou bastante novo em man pages e como eles funcionam. Isso é possível?

    
por DevelopingChris 24.12.2013 / 20:46

2 respostas

2

Eu nunca ouvi falar desse método empregado e o aconselharia a fazer algo que possa parecer fazer sentido a partir de sua perspectiva como desenvolvedor, mas na verdade é menos ideal ou obscuro para seus usuários e / ou administradores que acabarão sendo os usuários / suporte de sua estrutura de aplicativos.

Este é um erro constante que eu vejo desenvolvedores fazerem onde eles criam algo que torna sua vida mais fácil, mas são apenas soluções personalizadas que os administradores / usuários precisam se familiarizar.

Eu procuraria criar um método que gerasse automaticamente suas páginas de manual e fizesse parte da instalação com script fornecida por você ou como parte do gerenciador de pacotes de sistemas em que seu software fosse implantado.

Existem vários métodos para fazer exatamente isso. Pode parecer menos ideal, mas está mais de acordo com a forma como os usuários de seu software provavelmente esperam que seu software funcione.

Este tutorial deve ajudá-lo a entender os formatos de página do manual, eles são bem diretos e podem ser modificados facilmente durante a instalação.

por 24.12.2013 / 21:32
1

Isso soa como uma ideia horrível!

As páginas de manual devem documentar claramente todos os recursos e sua disponibilidade, especialmente para algo como uma linguagem de script de nível superior!

Simplesmente, ter todo o material extra omitido é não se importar com as implicações de os usuários passarem de uma instalação para a próxima. (Também promoverá monoculturas e, possivelmente, todos os tipos de lock-ins de fornecedores).

E se você não se importa com o bem-estar de seus usuários, por que fornecer um man manual compatível página em primeiro lugar?

    
por 24.12.2013 / 21:53