295 |
develop WoMan to take advantage of developments in Emacs itself. At |
develop WoMan to take advantage of developments in Emacs itself. At |
296 |
present, WoMan uses several display faces to support bold and italic |
present, WoMan uses several display faces to support bold and italic |
297 |
text, to indicate other fonts, etc. The default faces are also |
text, to indicate other fonts, etc. The default faces are also |
298 |
coloured, but the choice of faces is customizable. WoMan provides menu |
colored, but the choice of faces is customizable. WoMan provides menu |
299 |
support for navigation and mouse support for following references, in |
support for navigation and mouse support for following references, in |
300 |
addition to the navigation facilities provided by @code{man} mode. |
addition to the navigation facilities provided by @code{man} mode. |
301 |
WoMan has (this) texinfo documentation! |
WoMan has (this) texinfo documentation! |
344 |
@var{version} is your Emacs version), provided you have write access to |
@var{version} is your Emacs version), provided you have write access to |
345 |
it. If you use a directory that is not included by default in your |
it. If you use a directory that is not included by default in your |
346 |
Emacs load path then you need to add something like this to your |
Emacs load path then you need to add something like this to your |
347 |
@file{.emacs} initialisation file: |
@file{.emacs} initialization file: |
348 |
|
|
349 |
@lisp |
@lisp |
350 |
(add-to-list 'load-path "my-lisp") |
(add-to-list 'load-path "my-lisp") |
365 |
@heading Setup |
@heading Setup |
366 |
|
|
367 |
Setup that is either necessary or desirable consists of adding a small |
Setup that is either necessary or desirable consists of adding a small |
368 |
amount of Emacs Lisp code to your @file{.emacs} initialisation file. It |
amount of Emacs Lisp code to your @file{.emacs} initialization file. It |
369 |
may be necessary (or at least convenient) to make WoMan autoload (if you |
may be necessary (or at least convenient) to make WoMan autoload (if you |
370 |
are not running GNU Emacs 21 or later) and to set the search path used |
are not running GNU Emacs 21 or later) and to set the search path used |
371 |
by the @code{woman} interface. You may also find it convenient to make |
by the @code{woman} interface. You may also find it convenient to make |
453 |
|
|
454 |
(By default, WoMan will automatically define the dired keys @kbd{W} and |
(By default, WoMan will automatically define the dired keys @kbd{W} and |
455 |
@kbd{w} when it loads, but only if they are not already defined. This |
@kbd{w} when it loads, but only if they are not already defined. This |
456 |
behaviour is controlled by the user option @code{woman-dired-keys}. |
behavior is controlled by the user option @code{woman-dired-keys}. |
457 |
Note that the @code{dired-x} (dired extra) package binds |
Note that the @code{dired-x} (dired extra) package binds |
458 |
@code{dired-copy-filename-as-kill} to the key @kbd{w}, although @kbd{W} |
@code{dired-copy-filename-as-kill} to the key @kbd{w}, although @kbd{W} |
459 |
appears to be unused. The @code{dired-x} package will over-write the |
appears to be unused. The @code{dired-x} package will over-write the |
488 |
If you really want to square the man-woman circle then you can! If you |
If you really want to square the man-woman circle then you can! If you |
489 |
run the GNU command interpreter @code{bash} then you might care to |
run the GNU command interpreter @code{bash} then you might care to |
490 |
define the following @code{bash} function in your @code{bash} |
define the following @code{bash} function in your @code{bash} |
491 |
initialisation file @file{.bashrc}: |
initialization file @file{.bashrc}: |
492 |
|
|
493 |
@example |
@example |
494 |
man() @{ gnudoit -q '(raise-frame (selected-frame)) (woman' \"$1\" ')' ; @} |
man() @{ gnudoit -q '(raise-frame (selected-frame)) (woman' \"$1\" ')' ; @} |
1396 |
@item woman-bold-headings |
@item woman-bold-headings |
1397 |
A boolean value. If non-@code{nil} then embolden section and subsection |
A boolean value. If non-@code{nil} then embolden section and subsection |
1398 |
headings. Default is @code{t}. [Heading emboldening is @emph{not} standard |
headings. Default is @code{t}. [Heading emboldening is @emph{not} standard |
1399 |
@code{man} behaviour.] |
@code{man} behavior.] |
1400 |
|
|
1401 |
@item woman-ignore |
@item woman-ignore |
1402 |
A boolean value. If non-@code{nil} then unrecognised requests etc. are |
A boolean value. If non-@code{nil} then unrecognised requests etc. are |
1403 |
ignored. Default is @code{t}. This gives the standard @code{ROFF} behaviour. |
ignored. Default is @code{t}. This gives the standard @code{ROFF} behavior. |
1404 |
If @code{nil} then they are left in the buffer, which may aid debugging. |
If @code{nil} then they are left in the buffer, which may aid debugging. |
1405 |
|
|
1406 |
@item woman-preserve-ascii |
@item woman-preserve-ascii |
1428 |
@item woman-fontify |
@item woman-fontify |
1429 |
A boolean value. If non-@code{nil} then WoMan assumes that face support is |
A boolean value. If non-@code{nil} then WoMan assumes that face support is |
1430 |
available. It defaults to a non-@code{nil} value if the display supports |
available. It defaults to a non-@code{nil} value if the display supports |
1431 |
either colours or different fonts. |
either colors or different fonts. |
1432 |
|
|
1433 |
@item woman-italic-face |
@item woman-italic-face |
1434 |
Face for italic font in man pages. Default: italic, underlined, |
Face for italic font in man pages. Default: italic, underlined, |
1496 |
@cindex log buffer |
@cindex log buffer |
1497 |
@cindex buffer, log |
@cindex buffer, log |
1498 |
|
|
1499 |
This is modelled on the Emacs byte-compiler. It logs all files |
This is modeled on the Emacs byte-compiler. It logs all files |
1500 |
formatted by WoMan and the time taken. If WoMan finds anything that it |
formatted by WoMan and the time taken. If WoMan finds anything that it |
1501 |
cannot handle then it writes a warning to this buffer. If the variable |
cannot handle then it writes a warning to this buffer. If the variable |
1502 |
@code{woman-show-log} is non-@code{nil} (by default it is @code{nil}) then |
@code{woman-show-log} is non-@code{nil} (by default it is @code{nil}) then |