Variable: woman-manpath

woman-manpath is a customizable variable defined in woman.el.gz.

Value

("/usr/man" "/usr/share/man" "/usr/local/man")

Documentation

List of DIRECTORY TREES to search for UN*X manual files.

Each element should be the name of a directory that contains subdirectories of the form man?, or more precisely subdirectories selected by the value of woman-manpath-man-regexp. Non-directory and unreadable files are ignored.

Elements can also be a cons cell indicating a mapping from PATH to manual trees: if such an element's car is equal to a path element of the environment variable PATH, the cdr of the cons cell is included in the directory tree search.

If not set then the environment variable MANPATH is used. If no such environment variable is found, the default list is determined by consulting the man configuration file if found, which is determined by the user option woman-man.conf-path. An empty substring of MANPATH denotes the default list.

Any environment variables (names must have the UN*X-style form $NAME, e.g. $HOME, $EMACSDATA, $emacs_dir) are evaluated first but each element must evaluate to a SINGLE directory name. Trailing /s are ignored. (Specific directories in woman-path are also searched.)

Microsoft platforms: I recommend including drive letters explicitly, e.g.

  ("C:/Cygwin/usr/man/" "C:/Cygwin/usr/local/man").

The MANPATH environment variable may be set using DOS semi-colon- separated or UN*X/Cygwin colon-separated syntax (but not mixed).

This variable was added, or its default value changed, in Emacs 23.1.

Source Code

;; Defined in /usr/src/emacs/lisp/woman.el.gz
(defcustom woman-manpath
  ;; Locales could also be added in woman-expand-directory-path.
  (or (woman-manpath-add-locales
       (woman-parse-colon-path (getenv "MANPATH")))
      '("/usr/man" "/usr/share/man" "/usr/local/man"))
  "List of DIRECTORY TREES to search for UN*X manual files.
Each element should be the name of a directory that contains
subdirectories of the form `man?', or more precisely subdirectories
selected by the value of `woman-manpath-man-regexp'.  Non-directory
and unreadable files are ignored.

Elements can also be a cons cell indicating a mapping from PATH
to manual trees: if such an element's car is equal to a path
element of the environment variable PATH, the cdr of the cons
cell is included in the directory tree search.

If not set then the environment variable MANPATH is used.  If no such
environment variable is found, the default list is determined by
consulting the man configuration file if found, which is determined by
the user option `woman-man.conf-path'.  An empty substring of MANPATH
denotes the default list.

Any environment variables (names must have the UN*X-style form $NAME,
e.g. $HOME, $EMACSDATA, $emacs_dir) are evaluated first but each
element must evaluate to a SINGLE directory name.  Trailing `/'s are
ignored.  (Specific directories in `woman-path' are also searched.)

Microsoft platforms:
I recommend including drive letters explicitly, e.g.

  (\"C:/Cygwin/usr/man/\" \"C:/Cygwin/usr/local/man\").

The MANPATH environment variable may be set using DOS semi-colon-
separated or UN*X/Cygwin colon-separated syntax (but not mixed)."
  :type '(repeat (choice string (cons string string)))
  :version "23.1"                    ; added woman-manpath-add-locales
  :group 'woman-interface)