Na cadeia de caracteres de uso do meu script de shell personalizado, também exibirei --help e --version?

Question

Atualmente, estou desenvolvendo um script de shell chamado up , que mostra uma string de uso na linha de comando quando chamado com --help . A saída é assim:

$ up --help
usage: up [-n levels][--help][--versions][basename]...

Isso parece correto, mas estou me perguntando se realmente preciso mostrar as opções --help e --version , porque elas são um padrão amplamente aceito e só parecem adicionar ruído à string de uso.

    

Answer 1

Isso depende inteiramente de você, mas a maioria dos programas faz algo assim

program --help

Usage: program [<options>][<arguments> ...]

Options:
--help         show this message, then exit
--something    after some spaces for alignment, an explenation follows.

Você deve conferir o getopt que a maioria dos programas (que também está disponível nas linguagens de programação) e os scripts usam. Dessa forma, as pessoas que usam seu script não ficarão confusas.

Finalmente, você deve adicionar todas suas opções, mesmo que pareçam triviais para você estar completo. Então, eu adicionaria os dois --help e --version na seção Options do uso.