El comando hombre on Linux está incrustado en la memoria muscular de cada desarrollador y usuario de Linux. Es utilizado literalmente por todo el mundo; desde desarrolladores principiantes y aficionados hasta profesionales y expertos en Linux.
Se utiliza para leer la página del manual de la línea de comandos para un comando de Linux, un archivo de configuración o cualquier otra característica. Las páginas del manual generalmente se instalan junto con la instalación de un software en Linux. Existe una sintaxis definida para las páginas de manual, que se analiza mediante el comando.
Creemos una página de manual para el siguiente script bash que he escrito:
#! / bin / bash if ["$ 1" == "h"]; luego echo "Hola" fi si ["$ 1" = "b"]; luego repite "Bye" fiEste script solo hace dos cosas: imprime "Hola" si se especifica la opción "h" como argumento, e imprime "Adiós" si se especifica la opción "b" como argumento.
Creemos una página de manual para este programa. Usar empuje o cualquier editor de su elección para crear un archivo de texto.
prueba vim.1La extensión ".1" significa que esta página de manual es para un comando ejecutable. No es una obligación, sino una convención ampliamente seguida al escribir páginas de manual. La página de manual para man (hombre hombre !) enumera las categorías:
1 Programas ejecutables o comandos de shell 2 Llamadas al sistema (funciones proporcionadas por el kernel) 3 Llamadas a la biblioteca (funciones dentro de las bibliotecas de programas) 4 Archivos especiales (generalmente se encuentran en / dev) 5 Formatos de archivo y convenciones, por ejemplo, / etc / passwd 6 Juegos 7 Varios ( incluyendo macropaquetes y convenciones), p. ej. man (7), groff (7) 8 Comandos de administración del sistema (generalmente solo para root) 9 Rutinas del kernel [No estándar]Se crea una página de manual utilizando el lenguaje de marcado roff muy antiguo. Tiene comandos (marcadores de lectura) para varios títulos y secciones.
.TH- Este debería ser el primer comando en el archivo man. Se utiliza para especificar el título del título de la página de manual..SH- Encabezado de la sección..B- Se utiliza para mostrar el texto junto a él en negrita..TP- Se utiliza para mostrar información sobre un argumento (bandera) del comando..BR- Se utiliza para mostrar el texto en negrita y en la fuente romana normal.
A continuación se muestra la página de manual de mi programa creada utilizando solo los comandos roff anteriores (simples).
.TH test.sh 1 .SH NAME test.sh \ - Imprimir Hola o adiós .SH SINOPSIS .B test.sh [h] [b] .SH DESCRIPCIÓN .B test.sh Este es un script de muestra que solo hace 2 cosas . Imprime "Hola" si el argumento es 'h' o imprime "Adiós" si el argumento es 'b' .SH OPCIONES .TP .BR h Imprimir Hola .TP .BR b Imprimir AdiósGuarda el archivo presionando primero el ESC clave, y luego escriba : wq para guardar el archivo y salir de la consola vim.
Pruebe la página de manual que acabamos de crear usando el siguiente comando:
hombre ./test.1
Para obtener más información sobre hombre uso, ejecutar man-pages man comando en su terminal.
? Propina
Esta es la sintaxis básica para escribir páginas de manual. Para facilitar las cosas, puede utilizar herramientas como txt2man para convertir un archivo en algún formato de lenguaje de marcado a formato roff.