emacs/lisp/woman.el

53 ;; use the more obscure ?roff requests directly.  Current test results
56 ;; WoMan supports the use of compressed man files via
72 ;; Recommended use
82 ;; variable is set then WoMan will use it; otherwise you may need to
128 ;; If you use Microsoft COMMAND.COM then you can create a file called
147 ;; `woman-use-topic-at-point' to t; thanks to Benjamin Riefenstahl for
150 ;; The variable `woman-use-topic-at-point' can be rebound locally,
156 ;;  		    (let ((woman-use-topic-at-point t))
178 ;; variables, e.g. in `.emacs' and should NOT require the use of the
182 ;; it is better to use the built-in WoMan imenu support).
195 ;; buffer.  For further documentation of the use of imenu, such as
202 ;; are slightly different from the expression that I currently use.
210 ;; name hierarchy.  If you just want .SH in the imenu then use:
258 ;; (Probably not a good idea.  If you use it, be careful!)
303 ;; `w32-downcase-file-names' to `t' and use all lower case when
310 ;; slow the first time that it is run in an Emacs session, while it
323 ;; disc (if one is in use) the next time it is run in a new Emacs
378 ;; (although they will probably never use it)!
496 	;; Try to use Cygwin mount table via `cygpath.exe'.
663 expanded and cached.  However, the last component (only) of each
738   "*The title to use if WoMan adds a Contents menu to the menubar.
743 (defcustom woman-use-topic-at-point-default nil
744   ;; `woman-use-topic-at-point' may be let-bound when woman is loaded,
747   "*Default value for `woman-use-topic-at-point'."
752 (defcustom woman-use-topic-at-point woman-use-topic-at-point-default
753   "*Control use of the word at point as the default topic.
787 The SysV standard man pages use two character suffixes, and this is
812 (defcustom woman-use-own-frame		; window-system
815   "*If non-nil then use a dedicated frame for displaying WoMan windows.
861 Otherwise, to save time, some backslashes and spaces may be
921 ;; but not enough so to make font errors look terrible.  (Files that use
973   ;; Set the symbol font only if `woman-use-symbol-font' is true, to
976   (defcustom woman-use-extended-font t
977     "*If non-nil then may use non-ASCII characters from the default font."
981   (defcustom woman-use-symbol-font nil
982     "*If non-nil then may use the symbol font.
994     "*A string describing the symbol font to use for special characters.
1007 (defvar woman-use-extended-font nil)
1008 (defvar woman-use-symbol-font nil)
1033   (nth woman-adjust woman-justify-list)	; use vector?
1052   "Left margin stack for nested use of `.RS/.RE'.")
1054   "Prevailing indent stack for nested use of `.RS/.RE'.")
1079 (make-variable-buffer-local 'imenu--last-menubar-index-alist)
1129   "Delete subexpression SUBEXP of buffer text matched by last search."
1185   ;; Must use substituted paths because values of env vars may change!
1239 `woman-use-topic-at-point' is non-nil.  Return nil if no file can
1262 	(and (if (boundp 'woman-use-topic-at-point)
1263 		 woman-use-topic-at-point
1265 	       (setq woman-use-topic-at-point woman-use-topic-at-point-default))
1288        ;; Complete topic more carefully, i.e. use the completion
1416       (if (woman-not-member dir path)	; use each directory only once!
1465   ;; Instead we use sorting to merge stuff efficiently.  -- dak
1521 	(if (woman-not-member dir path)	; use each directory only once!
1580 ;; There is currently no `tar-mode-hook' so use ...
1588 (defvar woman-last-file-name nil
1589   "The full pathname of the last file formatted by WoMan.")
1591 (defun woman-reformat-last-file ()
1592   "Reformat last file, e.g. after changing fill column."
1594   (if woman-last-file-name
1595       (woman-find-file woman-last-file-name t)
1608   (setq woman-last-file-name
1656     (if woman-use-own-frame
1697   ;; Delete last text line (footer) and all following blank lines:
1786   (define-key woman-mode-map "R" 'woman-reformat-last-file)
1837    ["Reformat Last Man Page" woman-reformat-last-file t]
1849     ["View Source" (view-file woman-last-file-name) woman-last-file-name]
1851     ["Extended Font" woman-toggle-use-extended-font
1853      :active t :style toggle :selected woman-use-extended-font]
1854     ["Symbol Font" woman-toggle-use-symbol-font
1856      :active t :style toggle :selected woman-use-symbol-font]
1859      :active woman-use-symbol-font]
1869 (defun woman-toggle-use-extended-font ()
1870   "Toggle `woman-use-extended-font' and reformat, for menu use."
1872   (setq woman-use-extended-font (not woman-use-extended-font))
1873   (woman-reformat-last-file))
1875 (defun woman-toggle-use-symbol-font ()
1876   "Toggle `woman-use-symbol-font' and reformat, for menu use."
1878   (setq woman-use-symbol-font (not woman-use-symbol-font))
1879   (woman-reformat-last-file))
1882   "Reset `woman-emulation' to VALUE and reformat, for menu use."
1885   (woman-reformat-last-file))
1917   (use-local-map woman-mode-map)
1925   (setq imenu--last-menubar-index-alist nil)
2002 (defvar WoMan-Man-start-time nil
2003   "Used to record formatting time used by the `man' command.")
2007 ;; Functions").  Counting the formatting time is useful for
2008 ;; developping, but less applicable for daily use.  The advice for
2016 ;; Otherwise use Man and record start of formatting time."
2021 ;;     (setq WoMan-Man-start-time (current-time))
2027 ;;   "Report formatting time."
2028 ;;   (let* ((time (current-time))
2029 ;; 	 (time (+ (* (- (car time) (car WoMan-Man-start-time)) 65536)
2030 ;; 		  (- (cadr time) (cadr WoMan-Man-start-time)))))
2031 ;;     (message "Man formatting done in %d seconds" time)))
2149   (let ((start-time (current-time))	; (HIGH LOW MICROSEC)
2150 	time)				; HIGH * 2**16 + LOW seconds
2159     (setq time (current-time)
2160 	  time (+ (* (- (car time) (car start-time)) 65536)
2161 		  (- (cadr time) (cadr start-time))))
2162     (message "WoMan formatting buffer...done in %d seconds" time)
2163     (WoMan-log-end time))
2244   ;; Suitable for use in format-alist.
2271     (and woman-use-symbol-font
2571 Remember condition for use by a subsequent `.el'.
2575   ;; \{ ... \} for multi-line use.
2705 	;; then use the WoMan search mechanism to find the filename ...
2979    (input-string ascii-string extended-font-string . use-symbol-font)
2985  * `use-symbol-font' is t to indicate use of the symbol font or nil,
2986     i.e. omitted, to indicate use of the default font.
2995   "Replace text matched by last search with NEWTEXT and return t.
3004 \(This must be done AFTER translation, which may use special characters.)"
3015 			   (if woman-use-symbol-font
3019 			 (if woman-use-extended-font
3304   ;; .IX -- Index macro, for Sun internal use -- IGNORE!
3392     ;; Set font after last request up to eob:
3469   "Translate up to marker TO.  Do this last of all transformations."
4139 ;; text filling function, so that is what I use here.
4268       ;; last (mimic man). The hack in w-t-p would only work for two
4269       ;; consecutive IPs, and would use the first.
4402 If no argument then use value of optional arg PREVIOUS if non-nil,
4612 	      " at " (current-time-string) "\n")
4637 (defun WoMan-log-end (time)
4639 TIME specifies the time it took to format the man page, to be printed
4641   (WoMan-log-1 (format "Formatting time %d seconds." time) 'end))