160 lines
4.5 KiB
Groff
160 lines
4.5 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
|
|
.TH HELP2MAN "1" "diciembre 2022" "GNU help2man 1.49.3" "Órdenes de usuario"
|
|
.SH NOMBRE
|
|
help2man \- genera una página de manual básica
|
|
.SH SINOPSIS
|
|
.B help2man
|
|
[\fI\,OPCIÓN\/\fR]... \fI\,EJECUTABLE\/\fR
|
|
.SH DESCRIPCIÓN
|
|
`help2man' genera una página de manual a partir de la salida de `\-\-help' y de `\-\-version'.
|
|
.TP
|
|
\fB\-n\fR, \fB\-\-name\fR=\fI\,CADENA\/\fR
|
|
descripción del párrafo NAME
|
|
.TP
|
|
\fB\-s\fR, \fB\-\-section\fR=\fI\,SECCIÓN\/\fR
|
|
número de sección de la página del manual (1, 6, 8)
|
|
.TP
|
|
\fB\-m\fR, \fB\-\-manual\fR=\fI\,TEXTO\/\fR
|
|
nombre del manual (órdenes de usuario, ...)
|
|
.TP
|
|
\fB\-S\fR, \fB\-\-source\fR=\fI\,TEXTO\/\fR
|
|
fuente del programa (FSF, Debian, ...)
|
|
.TP
|
|
\fB\-L\fR, \fB\-\-locale\fR=\fI\,CADENA\/\fR
|
|
selección local (predefinida "C")
|
|
.TP
|
|
\fB\-i\fR, \fB\-\-include\fR=\fI\,FICHERO\/\fR
|
|
incluir material de `FICHERO'
|
|
.HP
|
|
\fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,FICHERO\/\fR incluir material de `FICHERO' si existe
|
|
.TP
|
|
\fB\-o\fR, \fB\-\-output\fR=\fI\,FICHERO\/\fR
|
|
enviar salida a `FICHERO'
|
|
.TP
|
|
\fB\-p\fR, \fB\-\-info\-page\fR=\fI\,TEXTO\/\fR
|
|
nombre de la página del manual Texinfo
|
|
.TP
|
|
\fB\-N\fR, \fB\-\-no\-info\fR
|
|
suprimir el puntero al manual Texinfo
|
|
.TP
|
|
\fB\-l\fR, \fB\-\-libtool\fR
|
|
excluir `lt\-' del nombre del programa
|
|
.TP
|
|
\fB\-\-help\fR
|
|
imprimir esta ayuda y, a continuación, salir
|
|
.TP
|
|
\fB\-\-version\fR
|
|
imprimir el número de versión y, a continuación, salir
|
|
.PP
|
|
EJECUTABLE debería aceptar las opciones `\-\-help' y `\-\-version' y sacar el resultado por
|
|
la salida estándar, aunque se pueden especificar alternativas utilizando:
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\-option\fR=\fI\,CADENA\/\fR
|
|
CADENA para la opción de ayuda
|
|
.TP
|
|
\fB\-v\fR, \fB\-\-version\-option\fR=\fI\,CADENA\/\fR
|
|
CADENA para la opción de versión
|
|
.TP
|
|
\fB\-\-version\-string\fR=\fI\,CADENA\/\fR
|
|
CADENA para la versión
|
|
.TP
|
|
\fB\-\-no\-discard\-stderr\fR
|
|
incluir la salida estándar cuando se procese la opción output
|
|
.SH "FICHEROS DE INCLUSIÓN"
|
|
Puede añadirse material en la salida generada con las opciones
|
|
.B \-\-include
|
|
y
|
|
.B \-\-opt\-include.
|
|
El formato es muy simple:
|
|
|
|
[sección]
|
|
texto
|
|
|
|
/patrón/
|
|
texto
|
|
|
|
Los bloques de texto *roff literal se añaden a la salida, bien
|
|
al comienzo de la zona designada por
|
|
.BI [ sección ]
|
|
(insensible a mayúsculas y minúsculas), bien después de un párrafo que
|
|
coincida con
|
|
.BI / patrón /\fR.
|
|
|
|
Los patrones utilizan la sintaxis de las expresiones regulares de Perl y pueden
|
|
ir seguidos de los modificadores
|
|
.IR i ,
|
|
.I s
|
|
o
|
|
.I m
|
|
(véase
|
|
.BR perlre (1)).
|
|
|
|
Las líneas situadas antes de la primera sección o patrón que empiezan por
|
|
`\-' se procesan como opciones. El resto se ignora silenciosamente y puede
|
|
utilizarse como comentarios, claves RCS y cosas similares.
|
|
|
|
El orden en que salen las secciones (aquellas que estén incluidas) es:
|
|
|
|
NOMBRE
|
|
SINOPSIS
|
|
DESCRIPCIÓN
|
|
OPCIONES
|
|
\fIotras\fR
|
|
ENTORNO
|
|
FICHEROS
|
|
EJEMPLOS
|
|
AUTOR
|
|
INFORMAR DE ERRORES
|
|
COPYRIGHT
|
|
VÉASE TAMBIÉN
|
|
|
|
Todas las secciones
|
|
.B [NOMBRE]
|
|
o
|
|
.B [SINOPSIS]
|
|
que aparezcan en el fichero de inclusión reemplazan a las que se hubieran
|
|
generado automáticamente (aunque se puede evitar lo
|
|
anterior con
|
|
.B \-\-name
|
|
si hace falta).
|
|
|
|
Otras secciones se insertan delante de la salida generada automáticamente para
|
|
las secciones estándar indicadas arriba o incuidas en
|
|
.I otras
|
|
(arriba) en el orden en que se encuentran en el fichero «include».
|
|
|
|
Puede indicarse explícitamente dónde colocar el texto dentro de la sección
|
|
utilizando la sintaxis
|
|
.RI [< sección ],
|
|
.RI [= sección ]
|
|
o
|
|
.RI [> sección ]
|
|
para colocar el texto adicional antes, en lugar de, o después de la salida
|
|
predefinida, respectivamente.
|
|
.SH DISPONIBILIDAD
|
|
La última versión de esta distribución está disponible en línea desde:
|
|
|
|
ftp://ftp.gnu.org/gnu/help2man/
|
|
.SH "INFORMAR DE ERRORES"
|
|
Informar de errores a <bug\-help2man@gnu.org>.
|
|
.SH COPYRIGHT
|
|
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
|
|
Esto es software libre; consulte el código fuente para ver las condiciones
|
|
de copia. SIN NINGUNA garantía, ni siquiera COMERCIAL ni de ADECUACIÓN
|
|
PARA NINGÚN FIN PARTICULAR. Escrito por Brendan O'Dea <boo@debian.org>
|
|
.SH "VÉASE TAMBIÉN"
|
|
La documentación completa de
|
|
.B help2man
|
|
se mantiene como manual Texinfo. Si los programas
|
|
info .B
|
|
y
|
|
.B help2man
|
|
están adecuadamente instalados en su sistema, la orden
|
|
.IP
|
|
.B info help2man
|
|
.PP
|
|
debería darle acceso al manual completo.
|