Estoy escribiendo una página de manual para un programa que estoy empaquetando. ¿Cómo puedo mostrar el archivo de página de manual que creé para verificar si está bien? ¿Hay alguna manera de pasar mi archivo directamente al mancomando en lugar de hacer que busque las páginas de manual instaladas por nombre?
Intenté hacer cosas como man myprog.1y, man < myprog.1pero en ambos casos, recibí un error que decía que no se pudo encontrar la página del manual.
Respuestas:
man tiene una opción para leer un archivo local: -l
-l, --local-file
Activa el modo 'local'. Formatee y muestre archivos manuales locales en lugar de buscar en la colección de manuales del sistema. Cada argumento de página manual se interpretará como un archivo fuente nroff en el formato correcto. No se produce ningún archivo cat.
Si '-' aparece como uno de los argumentos, la entrada se tomará de stdin. Cuando no se utiliza esta opción, y man no puede encontrar la página requerida, antes de mostrar el mensaje de error, intenta actuar como si se hubiera proporcionado esta opción, utilizando el nombre como nombre de archivo y buscando una coincidencia exacta.
Para que pueda obtener una vista previa de su trabajo en progreso con:
man -l /path/to/manfile.1
He usado simplemente
man ./path/to/man.1
Debe incluir una barra diagonal en la ruta; de lo contrario, buscará en los directorios del sistema. Funciona en los sistemas Linux y OS X que tengo (este último no tiene -l).
$ cd /tmp
$ cp /usr/share/man/man1/ls.1 .
$ man ls.1
No manual entry for ls.1
$ man ./ls.1 # works
En Solaris, el -Mcambio a mananulará la ruta de búsqueda de las páginas de manual: -
man -M path/to/man myprog
Su archivo de página de manual debe residir en un subdirectorio apropiado correspondiente a la sección y al lenguaje de marcado, por ejemplo: path/to/man/man1/myprog.1para una página de manual de nroff en la sección 1.