Man page - help2man(1)

Packages contains this manual

Available languages:

en fr pt_BR es it pl vi nb eo ko ta da hu sv hr ja uk fi ru ro sr el zh_CN de

Manual

HELP2MAN

NOME
SINOPSE
DESCRIƇƃO
ARQUIVOS INCLUSOS
DISPONIBILIDADE
AUTOR
RELATANDO PROBLEMAS
DIREITOS AUTORAIS
VEJA TAMBƉM

NOME

help2man - gera uma pƔgina de manual simples

SINOPSE

help2man [ OPƇƃO ]... EXECUTƁVEL

DESCRIƇƃO

"help2man" gera uma pƔgina de manual (man page) a partir da saƭda das opƧƵes "--help" e "--version".
-n , --name = TEXTO

descriĆ§Ć£o para o parĆ”grafo NOME

-s , --section = SEƇƃO

nĆŗmero da seĆ§Ć£o para a pĆ”gina do manual (1, 6, 8)

-m , --manual = TEXTO

nome do manual (Comandos do usuƔrio, ...)

-S , --source = TEXTO

origem do programa (FSF, Debian, ...)

-L , --locale = TEXTO

seleciona a localidade (padrĆ£o: "C")

-i , --include = ARQUIVO

inclui o material de "ARQUIVO"

-I , --opt-include = ARQUIVO

inclui o material de "ARQUIVO", se ele existir

-o , --output = ARQUIVO

envia a saĆ­da para ARQUIVO

-p , --info-page = TEXTO

nome do manual Texinfo

-N , --no-info

suprime o apontador para o manual Texinfo

-l , --libtool

exclui a parte "lt-" do nome do programa

--help

emite esta ajuda e sai

--version

emite o nĆŗmero da versĆ£o e sai

O EXECUTƁVEL deveria aceitar as opƧƵes "--help" e "--version" e produzir a saĆ­da para a saĆ­da padrĆ£o, embora alternativas podem ser especificadas usando:
-h , --help-option = TEXTO

o texto para a opĆ§Ć£o de ajuda

-v , --version-option = TEXTO

o texto para a opĆ§Ć£o de versĆ£o

--version-string = TEXTO

o texto da versĆ£o

--no-discard-stderr

inclui o texto no erro padrĆ£o ao analisar a saĆ­da das opƧƵes

ARQUIVOS INCLUSOS

Materiais adicionais podem ser incluƭdos na saƭda gerada com as opƧƵes --include e --opt-include . O formato Ʃ simples:

[seĆ§Ć£o]
texto

/padrĆ£o/
texto

Blocos de texto *roff literais sĆ£o inseridos na saĆ­da ou no inĆ­cio de uma dada [ seĆ§Ć£o ] (indiferente Ć  maiusculizaĆ§Ć£o), ou apĆ³s um parĆ”grafo que coincida com o / padrĆ£o / .

Os padrƵes usam a sintaxe Perl de expressĆ£o regular e podem ser seguidos pelos modificadores i , s ou m (veja perlre (1)).

As linhas antes da primeira seĆ§Ć£o ou de um padrĆ£o que comece com "-" sĆ£o processados como opƧƵes. Qualquer outra coisa Ć© ignorada silenciosamente e pode ser usada para comentĆ”rios, palavras-chaves RCS e coisas do tipo.

A ordem da saƭda das seƧƵes Ʃ:

NOME
SINOPSE
DESCRIƇƃO
OPƇƕES
outra
AMBIENTE
ARQUIVOS
EXEMPLOS
AUTOR
RELATANDO PROBLEMAS
DIREITOS AUTORAIS
VEJA TAMBƉM

Quaisquer seƧƵes [NAME] ou [SINOPSIS] que apareƧam no arquivo de inclusĆ£o substituirĆ” o que seria produzido automaticamente (embora vocĆŖ ainda possa sobrepor o primeiro com --name se necessĆ”rio).

Outras seƧƵes sĆ£o acrescentadas antes da saĆ­da produzida automaticamente para as seƧƵes padrƵes citadas acima ou inclusas na posiĆ§Ć£o outra (acima) na ordem em que elas forem encontradas no arquivo de inclusĆ£o.

A localizaĆ§Ć£o do texto dentro da seĆ§Ć£o pode ser requisitada explicitamente usando a sintaxe [< seĆ§Ć£o ], [= seĆ§Ć£o ] ou [> seĆ§Ć£o ] para colocar o texto adicionar antes, sobre ou apĆ³s a saĆ­da padrĆ£o, respectivamente.

DISPONIBILIDADE

A Ćŗltima versĆ£o desta distribuiĆ§Ć£o estĆ” disponĆ­vel on-line em:

ftp://ftp.gnu.org/gnu/help2man/

AUTOR

Escrito por Brendan Oā€™Dea <bod@debian.org>

RELATANDO PROBLEMAS

Relate problemas para <bug-help2man@gnu.org>.

DIREITOS AUTORAIS

Copyright Ā© 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021, 2022 Free Software Foundation, Inc.
Este Ć© um software livre; veja o cĆ³digo-fonte para as condiƧƵes de cĆ³pia. NƃO HƁ GARANTIAS; nem mesmo para COMERCIALIZAƇƃO ou ADAPTAƇƃO PARA UM FIM ESPECƍFICO.

VEJA TAMBƉM

A documentaĆ§Ć£o completa para help2man Ć© mantida como um manual Texinfo. Se info e os programas help2man estiverem instalados apropriadamente em sua mĆ”quina, o comando

info help2man

deveria lhe fornecer acesso ao manual completo.