NOMBRE
manpath - formato del archivo /etc/manpath.config
DESCRIPCIÓN
El archivo de configuración de manpath lo emplean las utilidades de páginas de manual para evaluar las manpath de los usuarios en tiempo de ejecución, para indicar qué jerarquías de páginas de manual (manpaths) van a tratarse como jerarquías del sistema y para asignarles directorios que se utilizarán para almacenar archivos cat.
Si la variable de entorno $MANPATH ya está establecida, la información contenida en /etc/manpath.config no la anulará.
RUTA DE BÚSQUEDA
Por defecto, man-db busca en la variable $PATH del usuario. Por cada path_element encontrado, agrega manpath_element a la ruta de búsqueda.
Si no hay una línea MANPATH_MAP en el archivo de configuración para un path_element en particular, entonces agrega todos los path_element/../man, path_element/man, path_element/../share/man y path_element/share/man que existan como directorios a la ruta de búsqueda.
Después agrega todas las entradas MANDATORY_MANPATH del archivo de configuración a la ruta de búsqueda.
Por último, si se utiliza la opción --systems, o si la variable de entorno $SYSTEM está establecida, entonces esta debería consistir en una secuencia de nombres de sistemas operativos separados por comas o por el signo de dos puntos. Esto actúa como una plantilla, expandiendo la ruta de búsqueda otra vez para permitir acceso a páginas de manual de otros sistemas operativos: por cada nombre de sistema, man-db busca ese nombre como un subdirectorio de cada entrada en la ruta de búsqueda, y lo agrega a la ruta de búsqueda, si existe. El nombre de sistema man agrega la ruta de búsqueda normal sin subdirectorios. Por ejemplo, si la ruta de búsqueda hubiera sido /usr/share/man:/usr/local/man, y $SYSTEM está establecida a newOS:man, entonces la ruta de búsqueda final será /usr/share/man/newOS:/usr/share/man:/usr/local/man/newOS:/usr/local/man.
La variable de entorno $MANPATH anula las rutas de búsqueda por defecto de la página de manual de man-db. La mayoría de los usuarios no deberían necesitar establecerla. Su sintaxis es similar a la variable de entorno $PATH: consiste en una secuencia de nombres de directorio separados por el símbolo de dos puntos. Anula la ruta de búsqueda por defecto descrita arriba.
Si el valor de $MANPATH comienza con el signo de dos puntos, la ruta de búsqueda predeterminada se le agrega al principio. Si el valor de $MANPATH termina con el signo de dos puntos, la ruta de búsqueda predeterminada se le agrega al final. Si el valor de $MANPATH contiene el signo de dobles dos puntos (::), la ruta de búsqueda predeterminada es agregada enmedio del valor, entre los signos de dos puntos.
FORMATO
Los siguientes
tipos de campos son actualmente reconocidos:
# comentario
Las líneas en blanco o las que comienzan con un # serán tratadas como comentarios e ignoradas.
MANDATORY_MANPATH elemento_rutaman
Las líneas de esta forma indican rutas de manual que todo $MANPATH generado automáticamente debería contener. Típicamente incluye /usr/man.
MANPATH_MAP elemento_ruta elemento_rutaman
Las líneas de esta forma establecen asociaciones entre $PATH y $MANPATH. Por cada elemento_ruta encontrado en la $PATH del usuario, un elemento_rutaman se añadirá al $MANPATH.
MANDB_MAP elemento_rutaman [ elemento_rutacat ]
Las líneas de esta forma indican qué rutas de manual van a tratarse como rutas de manual del sistema y opcionalmente dónde deberían almacenarse sus archivos cat. Este tipo de campo es particularmente importante si man es un porgrama setuid, pues (cuando en el archivo de configuración del sistema /etc/manpath.config en vez del archivo de configuración por cada usuario .manpath) indica a qué jerarquías de páginas de manual acceder como usuario setuid y a cuáles como el usuario que invoca.
Las jerarquías de página de manual de sistema normalmente son aquellas que están almacenadas bajo /usr, tales como /usr/man, /usr/local/man y /usr/X11R6/man.
Si las páginas cat de un elemento_rutaman concreto no van a almacenarse o van a almacenarse en la ubicación tradicional, elemento_rutacat puede omitirse.
La ubicación tradicional de cat sería imposible para jerarquías de páginas de manual montadas para solo lectura, por lo que es posible especificar cualquier jerarquía de directorios para su almacenamento. Para respetar el Linux FSSTND puede utilizarse la palabra clave FSSTND en lugar de un directorio real.
Desafortunadamente, es necesario especificar todas las rutas de árboles de man del sistema, incluso las rutas de sistemas operativos alternativos como /usr/man/sun y cualesquier rutas de localización NLS como /usr/man/es_ES.88591.
Como la información se analiza línea a línea en el orden de escritura, es necesario para cualquier ruta de manual que sea una sub-jerarquía de otra jerarquía, estar listada antes; de otro modo, se detectará una coincidencia incorrecta. Un ejemplo es que /usr/man/de_DE.88591 debe venir antes que /usr/man.
DEFINE clave valor
Las líneas de esta forma definen variables de configuración diversas; véase el archivo de configuración predeterminado para aquellas variables utilizadas para las utilidades del paginador del manual, que incluyen rutas predefinidas a varios programas (tales como grep y tbl), y conjuntos predefinidos de argumentos para dichos programas.
SECTION sección ...
Las líneas de esta forma definen el orden de búsqueda de las secciones del manual. Si no hay ninguna directiva SECTION en el archivo de configuración, la predeterminada es:
SECTION 1 n l 8 3 0 2 3type 5 4 9 6 7
Si hay múltiples directivas SECTION, sus listas de secciones serán concatenadas.
Si una extensión determinada no está en esta lista (digamos, 1mh) se mostrará con el resto de la sección a la que pertenece. El efecto de esto es que solo hace falta enlistar extensiones explícitamente si se desea forzar un orden determinado. Las secciones con extensiones normalmente deberían ser adyacentes a su sección principal (p.e. «1 1mh 8 ...»).
SECTIONS se acepta como nombre alternativo para esta directiva.
MINCATWIDTH anchura
Si la anchura del terminal es menor que anchura, las páginas cat no se crean (si faltan) ni se muestran. La predeterminada es 80.
MAXCATWIDTH anchura
Si la anchura del terminal es mayor que anchura, las páginas cat no se crean (si falta) ni se muestran. La predeterminada es 80.
CATWIDTH anchura
If width is non-zero, cat pages will always be formatted for a terminal of the given width, regardless of the width of the terminal actually being used. This overrides MINCATWIDTH and MAXCATWIDTH.
NOCACHE
Esta opción evita que man(1) cree páginas cat automáticamente.
DEFECTOS
A menos que las reglas anteriores se respeten escrupulosamente, las utilidades del paginador del manual no funcionarán como es debido. Las reglas son tremendamente complicadas.
https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db