HELP2MAN(1) Órdenes de usuario HELP2MAN(1)

help2man - genera una página de manual básica

help2man [OPCIÓN]... EJECUTABLE

`help2man' genera una página de manual a partir de la salida de `--help' y de `--version'.

descripción del párrafo NAME
número de sección de la página del manual (1, 6, 8)
nombre del manual (órdenes de usuario, ...)
fuente del programa (FSF, Debian, ...)
selección local (predefinida "C")
incluir material de `FICHERO'

-I, --opt-include=FICHERO incluir material de `FICHERO' si existe

enviar salida a `FICHERO'
nombre de la página del manual Texinfo
suprimir el puntero al manual Texinfo
excluir `lt-' del nombre del programa
imprimir esta ayuda y, a continuación, salir
imprimir el número de versión y, a continuación, salir

EJECUTABLE debería aceptar las opciones `--help' y `--version' y sacar el resultado por la salida estándar, aunque se pueden especificar alternativas utilizando:

CADENA para la opción de ayuda
CADENA para la opción de versión
CADENA para la versión
incluir la salida estándar cuando se procese la opción output

Puede añadirse material en la salida generada con las opciones --include y --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 [sección] (insensible a mayúsculas y minúsculas), bien después de un párrafo que coincida con /patrón/.

Los patrones utilizan la sintaxis de las expresiones regulares de Perl y pueden ir seguidos de los modificadores i, s o m (véase 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
otras
ENTORNO
FICHEROS
EJEMPLOS
AUTOR
INFORMAR DE ERRORES
COPYRIGHT
VÉASE TAMBIÉN

Todas las secciones [NOMBRE] o [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 --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 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 [<sección], [=sección] o [>sección] para colocar el texto adicional antes, en lugar de, o después de la salida predefinida, respectivamente.

La última versión de esta distribución está disponible en línea desde:


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

Informar de errores a <bug-help2man@gnu.org>.

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.
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>

La documentación completa de help2man se mantiene como manual Texinfo. Si los programas info .B y help2man están adecuadamente instalados en su sistema, la orden

info help2man

debería darle acceso al manual completo.

abril 2022 GNU help2man 1.49.2