GNU/Linux >> Tutoriales Linux >  >> Linux

¿Cómo agregar entradas a la página de manual para las propias herramientas eléctricas?

No tengo idea de cómo puedo hacer que mis scripts especializados de cosecha propia (escritos principalmente en Bash y Perl) estén disponibles a través del man páginas.

¿Qué procedimiento tendría que seguir? ¿Hay algún formato particular en el que deba escribirse la documentación para que yo pueda hacer esto?

Respuesta aceptada:

Descubrí que usar POD de Perl es mucho más fácil que escribir páginas de manual directamente, y puede crear una página de manual desde el archivo POD con pod2man utilidad (parte del paquete base de Perl). Dado que algunos de sus ejecutables ya están escritos en Perl, puede agregar formato POD directamente a sus scripts y se pueden convertir directamente en archivos POD. También he visto varios proyectos que usan el formato POD a pesar de que su código está escrito en otros idiomas, debido a la simplicidad de POD.

Para agregar un directorio adicional de páginas de manual, puede configurar el $MANPATH Variable ambiental. Prefijo $MANPATH con un : para agregarlo a la lista de rutas man ya configuradas. Usa el manpath Comando para ver las rutas man definidas actualmente.


Linux
  1. ¿Cómo agregar su propia extensión de archivo personalizada a PhotoRec para la recuperación de datos?

  2. ¿Cómo agregar una nueva línea al final de un archivo?

  3. ¿Cómo saber si la página de manual que estoy viendo es la correcta?

  4. ¿Cómo puedo agregar un pie de página al final de cada página de un archivo postscript o pdf en Linux?

  5. Buscar una opción específica en una página man

20 herramientas de productividad para la terminal Linux

Cómo encontrar la página man más larga en Linux

Cómo agregar texto al comienzo del archivo en Linux

Cómo agregar una aplicación al Dock en el sistema operativo elemental

Cómo agregar navegación personalizada a la página de inicio de ONLYOFFICE

Las 20 mejores herramientas de bioinformática para el sistema Linux