This is woman.info, produced by makeinfo version 4.0 from c:/NTEmacs/WoMan/woman.texinfo. INFO-DIR-SECTION GNU Emacs Lisp START-INFO-DIR-ENTRY * WoMan: (woman). Browse UN*X Manual Pages `Wo (without) Man'. END-INFO-DIR-ENTRY This file documents WoMan: A program to browse UN*X manual pages `wo (without) man'. Copyright (C) 2000 Francis J. Wright This manual and the software that it describes are subject to the GNU General Public License that is distributed with GNU Emacs - see the file `COPYING'. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying and provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions.  File: woman.info, Node: Formatting Options, Next: Faces, Prev: Interface Options, Up: Customization Formatting Options ================== These options control the layout that WoMan uses to format the man page. `woman-fill-column' An integer specifying the right margin for formatted text. Default is 65. `woman-fill-frame' A boolean value. If non-nil then most of the frame width is used, overriding the value of `woman-fill-column'. Default is nil. `woman-default-indent' An integer specifying the default prevailing indent for the `-man' macros. Default is 5. Set this variable to 7 to emulate Linux man formatting. `woman-bold-headings' A boolean value. If non-nil then embolden section and subsection headings. Default is t. [Heading emboldening is _not_ standard `man' behaviour.] `woman-ignore' A boolean value. If non-nil then unrecognised requests etc. are ignored. Default is t. This gives the standard `ROFF' behaviour. If `nil' then they are left in the buffer, which may aid debugging. `woman-preserve-ascii' A boolean value. If non-nil then preserve ASCII characters in the WoMan buffer. Otherwise, non-ASCII characters (that display as ASCII) may remain, which is irrelevant unless the buffer is to be saved to a file. Default is nil. `woman-emulation' WoMan emulation, currently either `NROFF' or `TROFF'. Default is `NROFF'. `TROFF' emulation is experimental and largely untested.  File: woman.info, Node: Faces, Next: Special symbols, Prev: Formatting Options, Up: Customization Faces ===== These options control the display faces that WoMan uses to format the man page. `woman-fontify' A boolean value. If non-nil then WoMan assumes that face support is available. It defaults to a non-nil value if the display supports either colours or different fonts. `woman-italic-face' Face for italic font in man pages. Default: italic, underlined, foreground red. This is overkill! `TROFF' uses just italic; `NROFF' uses just underline. You should probably select either italic or underline as you prefer, but not both, although italic and underline work together perfectly well! `woman-bold-face' Face for bold font in man pages. Default: bold, foreground blue. `woman-unknown-face' Face for all unknown fonts in man pages. Default: foreground brown. Brown is a good compromise: it is distinguishable from the default but not enough so as to make font errors look terrible. (Files that use non-standard fonts seem to do so badly or in idiosyncratic ways!) `woman-addition-face' Face for all additions made by WoMan to man pages. Default: foreground orange.  File: woman.info, Node: Special symbols, Prev: Faces, Up: Customization Special symbols =============== This section currently applies _only_ to Microsoft Windows. WoMan provides partial experimental support for special symbols, initially only for MS-Windows and only for MS-Windows fonts. This includes both non-ASCII characters from the main text font and use of a separate symbol font. Later, support will be added for other font types (e.g. `bdf' fonts) and for the X Window System. In Emacs 20.7, the current support works partially under Windows 9x but may not work on any other platform. `woman-use-extended-font' A boolean value. If non-nil then WoMan may use non-ASCII characters from the default font. Default is `t'. `woman-use-symbol-font' A boolean value. If non-nil then WoMan may use the symbol font. Default is `nil', mainly because it may change the line spacing (at least in NTEmacs 20). `woman-symbol-font' A string describing the symbol font to use for special characters. It should be compatible with, and the same size as, the default text font. Under MS-Windows, the default is "-*-Symbol-normal-r-*-*-*-*-96-96-p-*-ms-symbol"  File: woman.info, Node: Log, Next: Technical, Prev: Customization, Up: Top The *WoMan-Log* Buffer ********************** This is modelled on the Emacs byte-compiler. It logs all files formatted by WoMan and the time taken. If WoMan finds anything that it cannot handle then it writes a warning to this buffer. If the variable `woman-show-log' is non-nil (by default it is `nil') then WoMan automatically displays this buffer. *Note Interface Options: Interface Options. Many WoMan warnings can be completely ignored, because they are reporting the fact that WoMan has ignored requests that it is correct for WoMan to ignore. In some future version this level of paranoia may be reduced, but not until WoMan is deemed more reliable. At present, all warnings should be treated with some suspicion. Uninterpreted escape sequences are also logged (in some cases). By resetting the variable `woman-ignore' to `nil' (by default it is `t'), uninterpreted `ROFF' requests can optionally be left in the formatted buffer to indicate precisely where they occurred. *Note Interface Options: Interface Options.  File: woman.info, Node: Technical, Next: Bugs, Prev: Log, Up: Top Technical Details ***************** Horizontal and vertical spacing and resolution ============================================== WoMan currently assumes 10 characters per inch horizontally, hence a horizontal resolution of 24 basic units, and 5 lines per inch vertically, hence a vertical resolution of 48 basic units. (`NROFF' uses 240 per inch.) Vertical spacing and blank lines ================================ The number of consecutive blank lines in the formatted buffer should be either 0 or 1. A blank line should leave a space like .sp 1. Current policy is to output vertical space only immediately before text is output.  File: woman.info, Node: Bugs, Next: Acknowledgements, Prev: Technical, Up: Top Reporting Bugs ************** If WoMan fails completely, or formats a file incorrectly (i.e. obviously wrongly or significantly differently from `man') or inelegantly, then please a. check that you are running the latest version of `woman.el' available from my web site (http://centaur.maths.qmw.ac.uk/WoMan/), and b. check that the problem is not already described in the file `woman.status', also available from my web site (http://centaur.maths.qmw.ac.uk/WoMan/). If both of the above are true then please email me the entry from the `*WoMan-Log*' buffer relating to the problem file, together with a brief description of the problem. Please indicate where you got the man source file from, but do not send it to me unless I ask you to! Thanks. (At present WoMan has no automated bug-reporting facility.)  File: woman.info, Node: Acknowledgements, Next: Command Index, Prev: Bugs, Up: Top Acknowledgements **************** For Heather, Kathryn and Madelyn, the women in my life (although they will probably never use it)! I also thank the following for helpful suggestions, bug reports, code fragments, general interest, etc.: Jari Aalto, Dean Andrews, Juanma Barranquero, Karl Berry, Jim Chapman, Frederic Corne, Peter Craft, Charles Curley, Jim Davidson, Kevin D'Elia, John Fitch, Hans Frosch, Guy Gascoigne-Piggford, Brian Gorka, Nicolai Henriksen, Thomas Herchenroeder, Alexander Hinds, Stefan Hornburg, Theodore Jump, Paul Kinnucan, Jonas Linde, Andrew McRae, Howard Melman, Dennis Pixton, T. V. Raman, Bruce Ravel, Benjamin Riefenstahl, Kevin Ruland, Tom Schutter, Wei-Xue Shi, Fabio Somenzi, Karel Sprenger, Chris Szurgot, Paul A. Thompson, Arrigo Triulzi, Geoff Voelker, Eli Zaretskii,  File: woman.info, Node: Command Index, Next: Variable Index, Prev: Acknowledgements, Up: Top Command Index ************* * Menu: * beginning-of-buffer: Convenience. * describe-mode: Convenience. * digit-argument: Convenience. * end-of-buffer: Convenience. * man: Changing. * man-follow: References. * Man-follow-manual-reference: References. * Man-goto-section: Navigation. * Man-goto-see-also-section: Navigation. * Man-kill: Changing. * Man-next-section: Navigation. * Man-previous-section: Navigation. * Man-quit: Changing. * negative-argument: Convenience. * scroll-down: Navigation. * scroll-up: Navigation. * woman: Changing. * woman-decode-buffer: Filename. * woman-dired-find-file: Filename. * woman-find-file: Filename. * woman-mouse-2: References. * WoMan-next-manpage: Changing. * WoMan-previous-manpage: Changing. * woman-reformat-last-file: Changing. * woman-tar-extract-file: Filename.  File: woman.info, Node: Variable Index, Next: Keystroke Index, Prev: Command Index, Up: Top Variable Index ************** * Menu: * w32-downcase-file-names: Finding. * woman-addition-face: Faces. * woman-bold-face: Faces. * woman-bold-headings: Formatting Options. * woman-cache-filename: Interface Options. * woman-cache-level: Interface Options. * woman-default-indent: Formatting Options. * woman-dired-keys: Interface Options. * woman-emulation: Formatting Options. * woman-file-compression-regexp: Interface Options. * woman-fill-column: Formatting Options. * woman-fill-frame: Formatting Options. * woman-fontify: Faces. * woman-ignore: Formatting Options. * woman-imenu: Interface Options. * woman-imenu-generic-expression: Interface Options. * woman-imenu-title: Interface Options. * woman-italic-face: Faces. * woman-man.conf-path: Interface Options. * woman-manpath: Interface Options. * woman-manpath-man-regexp: Interface Options. * woman-path: Interface Options. * woman-post-format-hook: Customization. * woman-pre-format-hook: Customization. * woman-preserve-ascii: Formatting Options. * woman-show-log: Customization. * woman-symbol-font: Special symbols. * woman-topic-at-point: Interface Options. * woman-topic-at-point-default: Interface Options. * woman-uncompressed-file-regexp: Interface Options. * woman-unknown-face: Faces. * woman-use-extended-font: Special symbols. * woman-use-own-frame: Interface Options. * woman-use-symbol-font: Special symbols.  File: woman.info, Node: Keystroke Index, Next: Concept Index, Prev: Variable Index, Up: Top Keystroke Index *************** * Menu: * -: Convenience. * .: Convenience. * 0 .. 9: Convenience. * <: Convenience. * >: Convenience. * ?: Convenience. * DEL: Navigation. * g: Navigation. * k: Changing. * m: Changing. * M-n: Changing. * M-p: Changing. * mouse-2: References. * n: Navigation. * p: Navigation. * q: Changing. * r: References. * R: Changing. * RET: References. * s: Navigation. * SPC: Navigation. * w: Changing.  File: woman.info, Node: Concept Index, Prev: Keystroke Index, Up: Top Concept Index ************* * Menu: * acknowledgements: Acknowledgements. * autoloading: Autoloading. * automatic interface: Automatic. * background: Background. * bindings, preloading: Auto Bindings. * browsing man pages: Browsing. * buffer, log: Log. * bugs, reporting: Bugs. * cache, topic: Cache. * case-sensitivity: Finding. * changing current man page: Changing. * command line access: Command Line. * contents menu: Imenu. * convenience key bindings: Convenience. * current man page, changing: Changing. * customization: Customization. * customization, preloading: Auto Customization. * directory separator character: Interface Options. * faces <1>: Fonts. * faces: Faces. * filename interface: Filename. * finding man pages: Finding. * following references: References. * fonts: Fonts. * formatting man pages: Finding. * formatting options: Formatting Options. * horizontal spacing: Technical. * imenu support: Imenu. * installation: Installation. * interface options: Interface Options. * introduction: Introduction. * key bindings, convenience: Convenience. * key bindings, preloading: Auto Bindings. * log buffer: Log. * man pages, browsing: Browsing. * man pages, finding: Finding. * man pages, formatting: Finding. * MANPATH, directory separator: Interface Options. * MANPATH, environment variable: Interface Options. * menu bindings, preloading: Auto Bindings. * navigation: Navigation. * point, word at: Word at point. * preloading customization: Auto Customization. * preloading menu and key bindings: Auto Bindings. * references: References. * reporting bugs: Bugs. * resolution: Technical. * search path: Search Path. * setup: Installation. * spacing, horizontal and vertical: Technical. * special symbols: Special symbols. * technical details: Technical. * topic cache: Cache. * topic interface: Topic. * using, browsing man pages: Browsing. * using, finding man pages: Finding. * using, formatting man pages: Finding. * vertical spacing: Technical. * word at point: Word at point.