1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.2.
.TH HELP2MAN "1" "abril de 2022" "GNU help2man 1.49.2" "Comandos de usuário"
.SH NOME
help2man \- gera uma página de manual simples
.SH SINOPSE
.B help2man
[\fI\,OPÇÃO\/\fR]... \fI\,EXECUTÁVEL\/\fR
.SH DESCRIÇÃO
"help2man" gera uma página de manual (man page) a partir da saída das opções
"\-\-help" e "\-\-version".
.TP
\fB\-n\fR, \fB\-\-name\fR=\fI\,TEXTO\/\fR
descrição para o parágrafo NOME
.TP
\fB\-s\fR, \fB\-\-section\fR=\fI\,SEÇÃO\/\fR
número da seção para a página do manual (1, 6, 8)
.TP
\fB\-m\fR, \fB\-\-manual\fR=\fI\,TEXTO\/\fR
nome do manual (Comandos do usuário, ...)
.TP
\fB\-S\fR, \fB\-\-source\fR=\fI\,TEXTO\/\fR
origem do programa (FSF, Debian, ...)
.TP
\fB\-L\fR, \fB\-\-locale\fR=\fI\,TEXTO\/\fR
seleciona a localidade (padrão: "C")
.TP
\fB\-i\fR, \fB\-\-include\fR=\fI\,ARQUIVO\/\fR
inclui o material de "ARQUIVO"
.TP
\fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,ARQUIVO\/\fR
inclui o material de "ARQUIVO", se ele existir
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,ARQUIVO\/\fR
envia a saída para ARQUIVO
.TP
\fB\-p\fR, \fB\-\-info\-page\fR=\fI\,TEXTO\/\fR
nome do manual Texinfo
.TP
\fB\-N\fR, \fB\-\-no\-info\fR
suprime o apontador para o manual Texinfo
.TP
\fB\-l\fR, \fB\-\-libtool\fR
exclui a parte "lt\-" do nome do programa
.TP
\fB\-\-help\fR
emite esta ajuda e sai
.TP
\fB\-\-version\fR
emite o número da versão e sai
.PP
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:
.TP
\fB\-h\fR, \fB\-\-help\-option\fR=\fI\,TEXTO\/\fR
o texto para a opção de ajuda
.TP
\fB\-v\fR, \fB\-\-version\-option\fR=\fI\,TEXTO\/\fR
o texto para a opção de versão
.TP
\fB\-\-version\-string\fR=\fI\,TEXTO\/\fR
o texto da versão
.TP
\fB\-\-no\-discard\-stderr\fR
inclui o texto no erro padrão ao analisar a
saída das opções
.SH "ARQUIVOS INCLUSOS"
Materiais adicionais podem ser incluídos na saída gerada com as opções
.B \-\-include
e
.BR \-\-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
.BI [ seção ]
(indiferente à maiusculização), ou após um parágrafo que coincida com o
.BI / padrão /\fR.
Os padrões usam a sintaxe Perl de expressão regular e podem ser seguidos
pelos modificadores
.IR i ,
.I s
ou
.I m
(veja
.BR 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
\fIoutra\fR
AMBIENTE
ARQUIVOS
EXEMPLOS
AUTOR
RELATANDO PROBLEMAS
DIREITOS AUTORAIS
VEJA TAMBÉM
Quaisquer seções
.B [NAME]
ou
.B [SINOPSIS]
que apareçam no arquivo de inclusão substituirá o que seria
produzido automaticamente (embora você ainda possa sobrepor
o primeiro com
.B \-\-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
.I 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
.RI [< seção ],
.RI [= seção ]
ou
.RI [> seção ]
para colocar o texto adicionar antes, sobre ou após a saída
padrão, respectivamente.
.SH DISPONIBILIDADE
A última versão desta distribuição está disponível on-line em:
ftp://ftp.gnu.org/gnu/help2man/
.SH AUTOR
Escrito por Brendan O'Dea <bod@debian.org>
.SH "RELATANDO PROBLEMAS"
Relate problemas para <bug\-help2man@gnu.org>.
.SH "DIREITOS AUTORAIS"
Copyright \(co 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.
.br
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.
.SH "VEJA TAMBÉM"
A documentação completa para
.B help2man
é mantida como um manual Texinfo. Se
.B info
e os programas
.B help2man
estiverem instalados apropriadamente em sua máquina, o comando
.IP
.B info help2man
.PP
deveria lhe fornecer acesso ao manual completo.
|
