Recentemente ministrei um workshop sobre ferramentas Linux e tenho recomendado aos alunos que consultem as páginas de manual dos comandos caso encontrem erros.
No entanto, notei que o comando em si nunca retorna uma mensagem para ver a página de manual com o mancomando.
A maioria dos comandos aconselha usar a --helpopção, usar a infopágina, uma sinopse sobre o uso ou apenas imprimir a mensagem de erro.
Estou me perguntando por que nenhum comando pede ao usuário para consultar a página de manual? Não seria esse o primeiro lugar a procurar quando está sendo usado incorretamente?
Responder1
Láéuma razão objetiva para isso.
--helpé um sinalizador integrado ao próprio utilitário - incorporado ao executável binário ou, se for um script, incorporado ao script.
As páginas de manual são armazenadas separadamente no sistema de arquivos do próprio executável.
As páginas de manual podem estar faltando e o próprio executável ainda acessível.
Como desenvolvedor de utilitários, direcionar aos usuários um recurso de documentação queposso ou não possoestar presente em seu sistema faz menos sentido do que incorporar as informações no próprio código.
Não só isso, masa versão do executável e a versão da página de manual podem ou não estar alinhadas.
Eu encontrei isso, por exemplo, quando uma versão do Postgres foi enviada com um determinado pacote e uma versão diferente do Postgres também foi instalada no sistema. man psql mostraria informações paraumversão, mas não era a versão que você realmente obteve executando o psql. Se não houvesse --helpsinalizador, eu teria um grande mistério por que certas opções não funcionavam de acordo com a página de manual.
Responder2
Isto está sujeito a opinião porque provavelmente não existem estatísticas sobre como os conselhos nas mensagens de erro são apresentados.
A ligação predominante que vi é imprimir a mensagem de uso (que pode ter mais de uma linha), talvez porque fosse desnecessário dizer a alguém para ler a página de manual. Dizer a alguém para ler a --helpmensagem é redundante, e apenas uma pequena fração aconselha a leitura da página de informações.
Todos os programas que desenvolvi fornecem uma mensagem de uso (geralmente várias linhas).