Mercurial > emacs
comparison man/programs.texi @ 28838:e3d33a77c205
(Documentation): Document woman.el features.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Tue, 09 May 2000 09:33:07 +0000 |
parents | 1f6ba3e73fe9 |
children | 764f858acd8a |
comparison
equal
deleted
inserted
replaced
28837:b0b7849d0c20 | 28838:e3d33a77c205 |
---|---|
1568 Makefile, Octave, Perl, Scheme and Texinfo. The relevant Info files | 1568 Makefile, Octave, Perl, Scheme and Texinfo. The relevant Info files |
1569 mostly must be obtained separately, typically from the appropriate GNU | 1569 mostly must be obtained separately, typically from the appropriate GNU |
1570 package. | 1570 package. |
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 |
1574 function, or system call, with the @kbd{M-x manual-entry} command. It | 1575 function, or system call, with the @kbd{M-x manual-entry} command. It |
1575 runs the @code{man} program to format the man page, and runs it | 1576 runs the @code{man} program to format the man page, and runs it |
1576 asynchronously if your system permits, so that you can keep on editing | 1577 asynchronously if your system permits, so that you can keep on editing |
1577 while the page is being formatted. (MS-DOS and MS-Windows 3 do not | 1578 while the page is being formatted. (MS-DOS and MS-Windows 3 do not |
1589 | 1590 |
1590 @findex Man-fontify-manpage | 1591 @findex Man-fontify-manpage |
1591 If you insert the text of a man page into an Emacs buffer in some | 1592 If you insert the text of a man page into an Emacs buffer in some |
1592 other fashion, you can use the command @kbd{M-x Man-fontify-manpage} to | 1593 other fashion, you can use the command @kbd{M-x Man-fontify-manpage} to |
1593 perform the same conversions that @kbd{M-x manual-entry} does. | 1594 perform the same conversions that @kbd{M-x manual-entry} does. |
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} | |
1599 command@footnote{The name of the command, @code{woman}, is an acronym | |
1600 for ``w/o (without) man'', since it doesn't use the @code{man} | |
1601 program.}. Unlike @kbd{M-x man}, it does not run any external programs | |
1602 to format and display the man pages, instead it does that entirely in | |
1603 Emacs 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. | |
1605 When invoked, @kbd{M-x woman} prompts for a name of a manual page and | |
1606 provides completion based on the list of manual pages that are installed | |
1607 on your machine; the list of available manual pages is computed | |
1608 automatically the first time you invoke @code{woman}. The word at point | |
1609 in the current buffer is used to suggest the default name of the manual | |
1610 page. | |
1611 | |
1612 With a numeric argument, @kbd{M-x woman} recomputes the list of the | |
1613 manual pages used for completion. This is useful if you add or delete | |
1614 manual pages. | |
1615 | |
1616 @vindex woman-manpath | |
1617 By default, @kbd{M-x woman} looks up the manual pages in directories | |
1618 listed by the @code{MANPATH} environment variable. (If @code{MANPATH} | |
1619 is not set, @code{woman} uses a suitable default value, which can be | |
1620 customized.) More precisely, @code{woman} looks for subdirectories that | |
1621 match the shell wildcard @file{man*} in each one of these directories, | |
1622 and tries to find the manual pages in those subdirectories. When first | |
1623 invoked, @kbd{M-x woman} converts the value of @code{MANPATH} to a list | |
1624 of directory names and stores that list in the @code{woman-manpath} | |
1625 variable. By changing the value of this variable, you can customize the | |
1626 list 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. | |
1631 This 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*} | |
1635 subdirectories. | |
1636 | |
1637 @findex woman-find-file | |
1638 Occasionally, you might need to display manual pages that are not in | |
1639 any of the directories listed by @code{woman-manpath} and | |
1640 @code{woman-path}. The @kbd{M-x woman-find-file} command prompts for a | |
1641 name of a manual page file, with completion, and then formats and | |
1642 displays 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} | |
1646 key to run the @code{woman-find-file} command on the current line's | |
1647 file. You can disable this by setting the variable | |
1648 @code{woman-dired-keys} to @code{nil}. @xref{Dired}. In addition, the | |
1649 Tar-mode @kbd{w} key is bound to @code{woman-find-file} on the current | |
1650 line's archive member. | |
1594 | 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 |
1596 better-organized manuals that you can browse with Info. @xref{Misc | 1653 better-organized manuals that you can browse with Info. @xref{Misc |
1597 Help}. Since this process is only partially completed, it is still | 1654 Help}. Since this process is only partially completed, it is still |
1598 useful to read manual pages. | 1655 useful to read manual pages. |