Mercurial > emacs
comparison man/woman.texi @ 76839:4a7ae61207d2
* woman.el (woman-Cyg-to-Win): Don't convert cons cells
corresponding to MANPATH_MAP entries.
(woman-man.conf-path, woman-parse-man.conf): Doc fix.
(woman-parse-man.conf): Use more discriminating man.conf name.
(woman-parse-man.conf): Parse MANPATH_MAP entries.
(woman-manpath): Doc fix and type fix.
(woman-cached-data): Check for MANPATH_MAP entries.
(woman-expand-directory-path): Treat MANPATH_MAP entries.
* woman.texi (Topic, Interface Options): Explain changes semantics of
woman-manpath in order to consider MANPATH_MAP entries.
author | David Kastrup <dak@gnu.org> |
---|---|
date | Sat, 31 Mar 2007 15:22:14 +0000 |
parents | 3d45362f1d38 |
children | b3d988b9d686 |
comparison
equal
deleted
inserted
replaced
76838:53f6b50e0fb3 | 76839:4a7ae61207d2 |
---|---|
384 @code{man} command, as follows. If the environment variable | 384 @code{man} command, as follows. If the environment variable |
385 @code{MANPATH} is set, which seems to be the standard mechanism under | 385 @code{MANPATH} is set, which seems to be the standard mechanism under |
386 UNIX, then WoMan parses that. Otherwise, if WoMan can find a | 386 UNIX, then WoMan parses that. Otherwise, if WoMan can find a |
387 configuration file named (by default) @file{man.conf} (or something very | 387 configuration file named (by default) @file{man.conf} (or something very |
388 similar), which seems to be the standard mechanism under GNU/Linux, then | 388 similar), which seems to be the standard mechanism under GNU/Linux, then |
389 it parses that. To be precise, ``something very similar'' means having | 389 it parses that. To be precise, ``something very similar'' means |
390 two name components separated by a dot and respectively containing | 390 starting with @samp{man} and ending with @samp{.conf} and possibly more |
391 @samp{man} and beginning with @samp{conf}, e.g.@: @file{manual.configuration}. | 391 lowercase letters, e.g.@: @file{manual.configuration}. |
392 The search path and/or precise full path name for this file are set by | 392 The search path and/or precise full path name for this file are set by |
393 the value of the customizable user option @code{woman-man.conf-path}. | 393 the value of the customizable user option @code{woman-man.conf-path}. |
394 If all else fails, WoMan uses a plausible default man search path. | 394 If all else fails, WoMan uses a plausible default man search path. |
395 | 395 |
396 If the above default configuration does not work correctly for any | 396 If the above default configuration does not work correctly for any |
405 be directories that contain @emph{directories of} man files, whereas the | 405 be directories that contain @emph{directories of} man files, whereas the |
406 elements of @code{woman-path} must be directories that contain man files | 406 elements of @code{woman-path} must be directories that contain man files |
407 @emph{directly}. Secondly, the last directory component of each element | 407 @emph{directly}. Secondly, the last directory component of each element |
408 of @code{woman-path} is treated as a regular (Emacs) match expression | 408 of @code{woman-path} is treated as a regular (Emacs) match expression |
409 rather than a fixed name, which allows collections of related | 409 rather than a fixed name, which allows collections of related |
410 directories to be specified succinctly. | 410 directories to be specified succinctly. Also, elements of |
411 @code{woman-manpath} can be conses, indicating a mapping from | |
412 @samp{PATH} environment variable components to man directory | |
413 hierarchies. | |
411 | 414 |
412 For topic completion to work, WoMan must build a list of all the manual | 415 For topic completion to work, WoMan must build a list of all the manual |
413 files that it can access, which can be very slow, especially if a | 416 files that it can access, which can be very slow, especially if a |
414 network is involved. For this reason, it caches various amounts of | 417 network is involved. For this reason, it caches various amounts of |
415 information, after which retrieving it from the cache is very fast. If | 418 information, after which retrieving it from the cache is very fast. If |
941 @item woman-manpath | 944 @item woman-manpath |
942 A list of strings representing @emph{directory trees} to search for Unix | 945 A list of strings representing @emph{directory trees} to search for Unix |
943 manual files. Each element should be the name of a directory that | 946 manual files. Each element should be the name of a directory that |
944 contains subdirectories of the form @file{man?}, or more precisely | 947 contains subdirectories of the form @file{man?}, or more precisely |
945 subdirectories selected by the value of @code{woman-manpath-man-regexp}. | 948 subdirectories selected by the value of @code{woman-manpath-man-regexp}. |
946 Non-directory and unreadable files are ignored. | 949 Non-directory and unreadable files are ignored. This can also contain |
950 conses, with the car indicating a @code{PATH} variable component mapped | |
951 to the directory tree given in the cdr. | |
947 | 952 |
948 @cindex @code{MANPATH}, environment variable | 953 @cindex @code{MANPATH}, environment variable |
949 If not set then the environment variable @code{MANPATH} is used. If no | 954 If not set then the environment variable @code{MANPATH} is used. If no |
950 such environment variable is found, the default list is determined by | 955 such environment variable is found, the default list is determined by |
951 consulting the man configuration file if found. By default this is | 956 consulting the man configuration file if found. By default this is |