Este es el comando txt2man que se puede ejecutar en el proveedor de alojamiento gratuito de OnWorks utilizando una de nuestras múltiples estaciones de trabajo en línea gratuitas, como Ubuntu Online, Fedora Online, emulador en línea de Windows o emulador en línea de MAC OS.
PROGRAMA:
NOMBRE
txt2man - convertir texto ASCII plano a formato de página de manual
SINOPSIS
txt2man [-hpTX] [-t mi título] [-P pnombre] [-r rel] [-s secta]
[-v vol] [-I txt] [-B txt] [-d datos] [Ifile]
DESCRIPCIÓN
txt2man convierte el texto de entrada al estándar nroff / troff hombre(7) macros utilizadas para formatear
Páginas de manual de Unix. Se pueden generar páginas agradables especialmente para comandos (sección 1 u 8) o
para referencia de funciones C (secciones 2, 3), con la capacidad de reconocer y formatear
nombres de comandos y funciones, banderas, tipos y argumentos.
txt2man también es capaz de reconocer y formatear secciones, párrafos, listas (estándar,
numerado, descripción, anidado), referencias cruzadas y bloques de visualización literal.
Si archivo de entrada Ifile se omite, se utiliza la entrada estándar. El resultado se muestra en estándar
salida.
Así es como se reconocen y procesan los patrones de texto:
secciones
Estos encabezados están definidos por una línea en mayúsculas, comenzando la columna 1. Si hay
uno o más espacios iniciales, en su lugar se generará una subsección.
Párrafos
Deben estar separados por una línea en blanco y alineados a la izquierda.
Etiqueta lista
La definición del artículo está separada de la descripción del artículo por al menos 2 espacios en blanco
espacios, incluso antes de una nueva línea, si la definición es demasiado larga. La definición será
enfatizado por defecto.
Bullet lista
Los elementos de la lista de viñetas se definen por la primera palabra que es "-" o "*" u "o".
Enumerado lista
La primera palabra debe ser un número seguido de un punto.
literal la visualización bloques
Este tipo de párrafo se utiliza para mostrar texto sin modificar, por ejemplo, código fuente. Eso
deben estar separados por una línea en blanco y sangrados. Se utiliza principalmente para formatear
código fuente sin modificar. Se imprimirá con fuente fija siempre que sea posible.
(trofo).
Cruz referencias
Una referencia cruzada (otra página de manual) se define por una palabra seguida de un número en
paréntesis.
Secciones especiales:
NOMBRE El nombre de la función o comando y una breve descripción se establecen en esta sección.
SINOPSIS
Esta sección recibe un tratamiento especial para identificar el nombre del comando, banderas y
argumentos y propagar los atributos correspondientes más adelante en el texto. Si a C le gusta
se reconoce la función (palabra seguida inmediatamente por un paréntesis abierto), txt2man
imprimirá el nombre de la función en negrita, los tipos en fuente normal y las variables en
fuente cursiva. Toda la sección se imprimirá utilizando una familia de fuentes fija (mensajería)
siempre que sea posible (troff).
Es una buena práctica incrustar la documentación en el código fuente, mediante comentarios o
variables de texto constante. txt2man permite hacer eso, manteniendo la fuente del documento
legible, utilizable incluso sin más formateo (es decir, para ayuda en línea) y fácil de escribir.
El resultado es un documento de alta calidad y que cumple con los estándares.
OPCIONES
-h La opción -h muestra ayuda.
-d datos
Set datos en el encabezado. Predeterminado a actual datos.
-P pnombre
Set pnombre como nombre del proyecto en el encabezado. Por defecto a uname -s.
-p Título de la sonda, nombre de la sección y volumen.
-t mi título
Set mi título como título de la página de manual generada.
-r rel Set rel como nombre del proyecto y lanzamiento.
-s secta
Set secta como sección en el encabezado, generalmente un valor de 1 a 8.
-v vol Set vol como nombre de volumen, es decir, "manual del usuario de Unix".
-I txt Escribir en cursiva txt en salida. Puede especificarse más de una vez.
-B txt Enfatizar (negrita) txt en salida. Puede especificarse más de una vez.
-T Vista previa de resultados de texto usando PAGER, generalmente Saber más(1).
-X Vista previa de resultados de X11 usando vistagxdit(1).
MEDIO AMBIENTE
PAGER nombre del comando de paginación, generalmente Saber más(1) o less(1). Si no se establece, vuelve a
Saber más(1).
EJEMPLO
Pruebe este comando para formatear este texto en sí:
$ txt2man -h 2> & 1 | txt2man -T
Sugerencias
Para obtener un buen formato general del documento de salida, mantenga los párrafos sangrados
correctamente. Si tiene secciones en negrita no deseadas, busque varios espacios entre palabras,
que se utilizan para identificar una lista de etiquetas (término seguido de una descripción). Elija también
cuidadosamente el nombre de la lnea de comando o parmetros de funcin, ya que se enfatizarn cada
hora en que se encuentran en el documento.
Use txt2man en línea usando los servicios de onworks.net
