aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--man/programs.texi57
1 files changed, 57 insertions, 0 deletions
diff --git a/man/programs.texi b/man/programs.texi
index a15450747f9..188772d3a1d 100644
--- a/man/programs.texi
+++ b/man/programs.texi
@@ -1570,6 +1570,7 @@ mostly must be obtained separately, typically from the appropriate GNU
1570package. 1570package.
1571 1571
1572@findex manual-entry 1572@findex manual-entry
1573@cindex manual pages
1573 You can read the ``man page'' for an operating system command, library 1574 You can read the ``man page'' for an operating system command, library
1574function, or system call, with the @kbd{M-x manual-entry} command. It 1575function, or system call, with the @kbd{M-x manual-entry} command. It
1575runs the @code{man} program to format the man page, and runs it 1576runs the @code{man} program to format the man page, and runs it
@@ -1592,6 +1593,62 @@ by setting the variable @code{Man-fontify-manpage-flag} to @code{nil}.
1592other fashion, you can use the command @kbd{M-x Man-fontify-manpage} to 1593other fashion, you can use the command @kbd{M-x Man-fontify-manpage} to
1593perform the same conversions that @kbd{M-x manual-entry} does. 1594perform the same conversions that @kbd{M-x manual-entry} does.
1594 1595
1596@findex woman
1597@cindex manual pages, on MS-DOS/MS-Windows
1598 An alternative way of reading manual pages is the @kbd{M-x woman}
1599command@footnote{The name of the command, @code{woman}, is an acronym
1600for ``w/o (without) man'', since it doesn't use the @code{man}
1601program.}. Unlike @kbd{M-x man}, it does not run any external programs
1602to format and display the man pages, instead it does that entirely in
1603Emacs Lisp. Thus, it is useful on systems such as MS-Windows, where the
1604@code{man} program and the programs it runs are not readily available.
1605When invoked, @kbd{M-x woman} prompts for a name of a manual page and
1606provides completion based on the list of manual pages that are installed
1607on your machine; the list of available manual pages is computed
1608automatically the first time you invoke @code{woman}. The word at point
1609in the current buffer is used to suggest the default name of the manual
1610page.
1611
1612 With a numeric argument, @kbd{M-x woman} recomputes the list of the
1613manual pages used for completion. This is useful if you add or delete
1614manual pages.
1615
1616@vindex woman-manpath
1617 By default, @kbd{M-x woman} looks up the manual pages in directories
1618listed by the @code{MANPATH} environment variable. (If @code{MANPATH}
1619is not set, @code{woman} uses a suitable default value, which can be
1620customized.) More precisely, @code{woman} looks for subdirectories that
1621match the shell wildcard @file{man*} in each one of these directories,
1622and tries to find the manual pages in those subdirectories. When first
1623invoked, @kbd{M-x woman} converts the value of @code{MANPATH} to a list
1624of directory names and stores that list in the @code{woman-manpath}
1625variable. By changing the value of this variable, you can customize the
1626list of directories where @code{woman} looks for manual pages.
1627
1628@vindex woman-path
1629 In addition, you can augment the list of directories searched by
1630@code{woman} by setting the value of the @code{woman-path} variable.
1631This variable should hold a list of specific directories which
1632@code{woman} should search, in addition to those in
1633@code{woman-manpath}. Unlike @code{woman-manpath}, the directories in
1634@code{woman-path} are searched for the manual pages, not for @file{man*}
1635subdirectories.
1636
1637@findex woman-find-file
1638 Occasionally, you might need to display manual pages that are not in
1639any of the directories listed by @code{woman-manpath} and
1640@code{woman-path}. The @kbd{M-x woman-find-file} command prompts for a
1641name of a manual page file, with completion, and then formats and
1642displays that file like @kbd{M-x woman} does.
1643
1644@vindex woman-dired-keys
1645 First time you invoke @kbd{M-x woman}, it defines the Dired @kbd{W}
1646key to run the @code{woman-find-file} command on the current line's
1647file. You can disable this by setting the variable
1648@code{woman-dired-keys} to @code{nil}. @xref{Dired}. In addition, the
1649Tar-mode @kbd{w} key is bound to @code{woman-find-file} on the current
1650line's archive member.
1651
1595 Eventually the GNU project hopes to replace most man pages with 1652 Eventually the GNU project hopes to replace most man pages with
1596better-organized manuals that you can browse with Info. @xref{Misc 1653better-organized manuals that you can browse with Info. @xref{Misc
1597Help}. Since this process is only partially completed, it is still 1654Help}. Since this process is only partially completed, it is still