Imported Upstream version 2.8.3
[platform/upstream/man-db.git] / man / es / man5 / manpath.man5
1 .\" Man page for format of the manpath.config data file
2 .\"
3 .\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
4 .\"
5 .\" You may distribute under the terms of the GNU General Public
6 .\" License as specified in the file COPYING that comes with the
7 .\" man-db distribution.
8 .\"
9 .\" Sat Oct 29 13:09:31 GMT 1994  Wilf. (G.Wilford@ee.surrey.ac.uk) 
10 .\" 
11 .TH MANPATH 5 "%date%" "%version%" "%manpath_config_file%"
12 .SH NOMBRE
13 manpath \- formato del fichero %manpath_config_file%
14 .SH DESCRIPCIÓN
15 El fichero de configuración de rutas de manual se usa por los útiles de las 
16 páginas
17 de manual para obtener las rutas a los manuales para cada usuario a la
18 hora de ejecutar dichos útiles, para indicar que jerarquías de páginas
19 de manuales (rutas a los manuales o "manpaths") se deben tratar como
20 `globales' y para asignarles directorios a usar para almacenar los
21 ficheros cat.
22
23 Si la variable de entorno
24 .RB $ MANPATH
25 ya ha sido definida, la información contenida en %manpath_config_file% no
26 tendrá precedencia sobre ella.
27 .SH FORMATO
28 Los siguientes tipos de campo estan reconocidos actualmente:
29 .TP
30 .BI # \ comentario
31 Las líneas en blanco o las que comienzan con 
32 .B #
33 serán tratadas como comentarios y no serán procesadas.
34 .TP
35 .BI MANDATORY_MANPATH \ elemento_de_ruta_de_manual
36 Las líneas de esta forma indican rutas de manual que cualquier
37 .RB $ MANPATH
38 generado automáticamente debe contener. Esto incluirá típicamente 
39 .IR /usr/man .
40 .TP
41 .BI MANPATH_MAP \ elemento_de_ruta\ elemento_de_ruta_de_manual
42 Las líneas de esta forma definen las correspondencias entre
43 .RB $ PATH 
44
45 .RB $ MANPATH .
46 Para cada
47 .I elemento_de_ruta
48 que se encuentre en el 
49 .RB $ PATH
50 del usuario, se añadira
51 .I elemento_de_ruta_de_manual 
52 al 
53 .RB $ MANPATH . 
54 .TP
55 \fBMANDB_MAP \fIelemento_de_ruta_de_manual \fR\|[\| \fIelemento_de_ruta_de_cat\fR \|]
56 Las líneas de esta forma indican qué rutas de manual se deben tratar como 
57 `globales' y opcionalmente, donde se deben almacenar sus ficheros cat.
58 Este tipo de fichero es particularmente importante si
59 .B man 
60 es un programa setuid, ya que esto indica cuáles jerarquías de páginas de 
61 manual se deben acceder como el usuario setuid y cuáles como el usuario
62 que ejecuta el programa.
63
64 Las jerarquías de páginas de manual `globales' suelen ser aquellas
65 almacenadas bajo
66 .I /usr
67 como
68 .IR /usr/man , 
69 .I /usr/local/man
70 y
71 .IR /usr/X11R6/man .
72
73 Si las páginas cat de un 
74 .I elemento_de_ruta_de_manual
75 no deben ser almacenadas, o se deben almacenar en su lugar tradicional,
76 .I elemento_de_ruta_de_cat
77 puede omitirse.
78
79 El almacenamiento en el lugar tradicional para cat puede ser imposible
80 para jerarquías de páginas de manual montadas para sólo lectura, y a causa
81 de esto es posible especificar cualquier jerarquía de directorios válida
82 para su almacenamiento. Para cumplir el
83 .B FSSTND de Linux
84 la palabra clave
85 .RB ` FSSTND ' 
86 puede usarse en lugar de un directorio real.
87
88 Desafortunadamente, es necesario especificar
89 .B todas
90 las rutas `globales' del árbol de rutas de manual, incluyendo las
91 rutas para sistemas alternativos como
92 .I /usr/man/sun
93 y cualesquiera rutas para
94 .B NLS locale
95 como
96 .IR /usr/man/de_DE.88591 . 
97
98 Como la información se procesa línea a línea en el orden en que fue escrita,
99 es necesario que cualquier ruta de manual que sea una subjerarquía de otra
100 jerarquía aparezca primero en el listado, de otro modo se asociarán de
101 forma incorrecta.
102 Un ejemplo es que
103 .I /usr/man/de_DE.88591
104 debe aparecer primero que
105 .IR /usr/man .
106 .SH BUGS
107 A menos que las reglas descritas se sigan estrictamente, los útiles para
108 las páginas de manual no funcionarán como se desea. Las reglas son muy
109 complicadas.