man.el 73.8 KB
Newer Older
Mark Oteiza's avatar
Mark Oteiza committed
1
;;; man.el --- browse UNIX manual pages -*- lexical-binding: t -*-
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1993-1994, 1996-1997, 2001-2020 Free Software
Paul Eggert's avatar
Paul Eggert committed
4
;; Foundation, Inc.
5 6

;; Author: Barry A. Warsaw <bwarsaw@cen.com>
7
;; Maintainer: emacs-devel@gnu.org
8 9 10 11 12
;; Keywords: help
;; Adapted-By: ESR, pot

;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
14
;; it under the terms of the GNU General Public License as published by
15 16
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
17 18 19 20 21 22 23

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
24
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
25 26 27 28 29 30 31 32 33 34 35 36 37

;;; Commentary:

;; This code provides a function, `man', with which you can browse
;; UNIX manual pages.  Formatting is done in background so that you
;; can continue to use your Emacs while processing is going on.
;;
;; The mode also supports hypertext-like following of manual page SEE
;; ALSO references, and other features.  See below or do `?' in a
;; manual page buffer for details.

;; ========== Credits and History ==========
;; In mid 1991, several people posted some interesting improvements to
38
;; man.el from the standard Emacs 18.57 distribution.  I liked many of
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
;; these, but wanted everything in one single package, so I decided
;; to incorporate them into a single manual browsing mode.  While
;; much of the code here has been rewritten, and some features added,
;; these folks deserve lots of credit for providing the initial
;; excellent packages on which this one is based.

;; Nick Duffek <duffek@chaos.cs.brandeis.edu>, posted a very nice
;; improvement which retrieved and cleaned the manpages in a
;; background process, and which correctly deciphered such options as
;; man -k.

;; Eric Rose <erose@jessica.stanford.edu>, submitted manual.el which
;; provided a very nice manual browsing mode.

;; This package was available as `superman.el' from the LCD package
;; for some time before it was accepted into Emacs 19.  The entry
;; point and some other names have been changed to make it a drop-in
;; replacement for the old man.el package.

58
;; Francesco Potortì <pot@cnuce.cnr.it> cleaned it up thoroughly,
59 60 61 62 63 64
;; making it faster, more robust and more tolerant of different
;; systems' man idiosyncrasies.

;; ========== Features ==========
;; + Runs "man" in the background and pipes the results through a
;;   series of sed and awk scripts so that all retrieving and cleaning
65
;;   is done in the background.  The cleaning commands are configurable.
66 67 68 69 70 71 72 73 74 75 76
;; + Syntax is the same as Un*x man
;; + Functionality is the same as Un*x man, including "man -k" and
;;   "man <section>", etc.
;; + Provides a manual browsing mode with keybindings for traversing
;;   the sections of a manpage, following references in the SEE ALSO
;;   section, and more.
;; + Multiple manpages created with the same man command are put into
;;   a narrowed buffer circular list.

;; ============= TODO ===========
;; - Add a command for printing.
77
;; - The awk script deletes multiple blank lines.  This behavior does
78
;;   not allow one to understand if there was indeed a blank line at the
79 80 81 82
;;   end or beginning of a page (after the header, or before the
;;   footer).  A different algorithm should be used.  It is easy to
;;   compute how many blank lines there are before and after the page
;;   headers, and after the page footer.  But it is possible to compute
83
;;   the number of blank lines before the page footer by heuristics
84 85 86 87 88 89 90
;;   only.  Is it worth doing?
;; - Allow a user option to mean that all the manpages should go in
;;   the same buffer, where they can be browsed with M-n and M-p.


;;; Code:

91
(require 'ansi-color)
Rüdiger Sonderfeld's avatar
Rüdiger Sonderfeld committed
92
(require 'cl-lib)
93
(require 'button)
94 95 96 97

(defgroup man nil
  "Browse UNIX manual pages."
  :prefix "Man-"
98
  :group 'external
99 100 101
  :group 'help)

(defvar Man-notify)
102

103
(defcustom Man-filter-list nil
Lute Kamstra's avatar
Lute Kamstra committed
104
  "Manpage cleaning filter command phrases.
105 106
This variable contains a list of the following form:

107
  ((command-string phrase-string*)*)
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124

Each phrase-string is concatenated onto the command-string to form a
command filter.  The (standard) output (and standard error) of the Un*x
man command is piped through each command filter in the order the
commands appear in the association list.  The final output is placed in
the manpage buffer."
  :type '(repeat (list (string :tag "Command String")
		       (repeat :inline t
			       (string :tag "Phrase String"))))
  :group 'man)

(defvar Man-uses-untabify-flag t
  "Non-nil means use `untabify' instead of `Man-untabify-command'.")
(defvar Man-sed-script nil
  "Script for sed to nuke backspaces and ANSI codes from manpages.")

(defcustom Man-fontify-manpage-flag t
125
  "Non-nil means make up the manpage with fonts."
126 127 128
  :type 'boolean
  :group 'man)

129 130
(defface Man-overstrike
  '((t (:inherit bold)))
131
  "Face to use when fontifying overstrike."
132
  :group 'man
133
  :version "24.3")
134

135 136
(defface Man-underline
  '((t (:inherit underline)))
137
  "Face to use when fontifying underlining."
138
  :group 'man
139
  :version "24.3")
140

141 142
(defface Man-reverse
  '((t (:inherit highlight)))
143
  "Face to use when fontifying reverse video."
144
  :group 'man
145
  :version "24.3")
146 147 148 149 150 151

(defvar Man-ansi-color-map (let ((ansi-color-faces-vector
				  [ default Man-overstrike default Man-underline
				    Man-underline default default Man-reverse ]))
			     (ansi-color-make-color-map))
  "The value used here for `ansi-color-map'.")
152

153 154
;; Use the value of the obsolete user option Man-notify, if set.
(defcustom Man-notify-method (if (boundp 'Man-notify) Man-notify 'friendly)
155
  "Selects the behavior when manpage is ready.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
This variable may have one of the following values, where (sf) means
that the frames are switched, so the manpage is displayed in the frame
where the man command was called from:

newframe   -- put the manpage in its own frame (see `Man-frame-parameters')
pushy      -- make the manpage the current buffer in the current window
bully      -- make the manpage the current buffer and only window (sf)
aggressive -- make the manpage the current buffer in the other window (sf)
friendly   -- display manpage in the other window but don't make current (sf)
polite     -- don't display manpage, but prints message and beep when ready
quiet      -- like `polite', but don't beep
meek       -- make no indication that the manpage is ready

Any other value of `Man-notify-method' is equivalent to `meek'."
  :type '(radio (const newframe) (const pushy) (const bully)
		(const aggressive) (const friendly)
		(const polite) (const quiet) (const meek))
  :group 'man)

Juri Linkov's avatar
Juri Linkov committed
175
(defcustom Man-width nil
176
  "Number of columns for which manual pages should be formatted.
177 178 179
If nil, use the width of the window where the manpage is displayed.
If non-nil, use the width of the frame where the manpage is displayed.
The value also can be a positive integer for a fixed width."
Juri Linkov's avatar
Juri Linkov committed
180 181
  :type '(choice (const :tag "Window width" nil)
                 (const :tag "Frame width" t)
182
                 (integer :tag "Fixed width" :value 65))
Juri Linkov's avatar
Juri Linkov committed
183 184
  :group 'man)

185 186 187 188 189 190 191 192 193 194 195 196
(defcustom Man-width-max 80
  "Maximum number of columns allowed for the width of manual pages.
It defines the maximum width for the case when `Man-width' is customized
to a dynamically calculated value depending on the frame/window width.
If the width calculated for `Man-width' is larger than the maximum width,
it will be automatically reduced to the width defined by this variable.
When nil, there is no limit on maximum width."
  :type '(choice (const :tag "No limit" nil)
                 (integer :tag "Max width" :value 80))
  :version "27.1"
  :group 'man)

197
(defcustom Man-frame-parameters nil
198
  "Frame parameter list for creating a new frame for a manual page."
199 200 201
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
202 203 204
  :group 'man)

(defcustom Man-downcase-section-letters-flag t
205
  "Non-nil means letters in sections are converted to lower case.
206 207 208 209 210 211 212 213 214
Some Un*x man commands can't handle uppercase letters in sections, for
example \"man 2V chmod\", but they are often displayed in the manpage
with the upper case letter.  When this variable is t, the section
letter (e.g., \"2V\") is converted to lowercase (e.g., \"2v\") before
being sent to the man background process."
  :type 'boolean
  :group 'man)

(defcustom Man-circular-pages-flag t
215
  "Non-nil means the manpage list is treated as circular for traversal."
216 217 218 219 220 221 222 223 224 225
  :type 'boolean
  :group 'man)

(defcustom Man-section-translations-alist
  (list
   '("3C++" . "3")
   ;; Some systems have a real 3x man section, so let's comment this.
   ;; '("3X" . "3")                        ; Xlib man pages
   '("3X11" . "3")
   '("1-UCB" . ""))
226
  "Association list of bogus sections to real section numbers.
227 228 229 230 231 232 233 234
Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
their references which Un*x `man' does not recognize.  This
association list is used to translate those sections, when found, to
the associated section number."
  :type '(repeat (cons (string :tag "Bogus Section")
		       (string :tag "Real Section")))
  :group 'man)

235
;; FIXME see comments at ffap-c-path.
236
(defcustom Man-header-file-path
237 238 239 240 241 242 243 244 245 246
  (let ((arch (with-temp-buffer
                (when (eq 0 (ignore-errors
                              (call-process "gcc" nil '(t nil) nil
                                            "-print-multiarch")))
                  (goto-char (point-min))
                  (buffer-substring (point) (line-end-position)))))
        (base '("/usr/include" "/usr/local/include")))
    (if (zerop (length arch))
        base
      (append base (list (expand-file-name arch "/usr/include")))))
247
  "C Header file search path used in Man."
248
  :version "24.1"                       ; add multiarch
249 250 251
  :type '(repeat string)
  :group 'man)

252 253
(defcustom Man-name-local-regexp (concat "^" (regexp-opt '("NOM" "NAME")) "$")
  "Regexp that matches the text that precedes the command's name.
254
Used in `bookmark-set' to get the default bookmark name."
255
  :version "24.1"
256
  :type 'regexp :group 'bookmark)
257

258 259 260 261
(defcustom manual-program "man"
  "Program used by `man' to produce man pages."
  :type 'string
  :group 'man)
262

263 264 265 266
(defcustom Man-untabify-command "pr"
  "Program used by `man' for untabifying."
  :type 'string
  :group 'man)
267

268 269 270 271
(defcustom Man-untabify-command-args (list "-t" "-e")
  "List of arguments to be passed to `Man-untabify-command' (which see)."
  :type '(repeat string)
  :group 'man)
272

273 274 275 276
(defcustom Man-sed-command "sed"
  "Program used by `man' to process sed scripts."
  :type 'string
  :group 'man)
277

278 279 280 281
(defcustom Man-awk-command "awk"
  "Program used by `man' to process awk scripts."
  :type 'string
  :group 'man)
282

283 284 285 286 287 288 289 290 291 292
;; This is for people who have UTF-8 encoded man pages in non-UTF-8
;; locales, or who use Cygwin 'man' command from a native MS-Windows
;; build of Emacs.
(defcustom Man-coding-system nil
  "Coding-system to decode output from the commands run by `man'.
If this is nil, `man' will use `locale-coding-system'."
  :type 'coding-system
  :group 'man
  :version "26.1")

293 294 295 296
(defcustom Man-mode-hook nil
  "Hook run when Man mode is enabled."
  :type 'hook
  :group 'man)
297

298 299 300 301
(defcustom Man-cooked-hook nil
  "Hook run after removing backspaces but before `Man-mode' processing."
  :type 'hook
  :group 'man)
302

303
(defvar Man-name-regexp "[-[:alnum:]_­+][-[:alnum:]_.:­+]*"
304 305
  "Regular expression describing the name of a manpage (without section).")

306
(defvar Man-section-regexp "[0-9][a-zA-Z0-9+]*\\|[LNln]"
307 308 309
  "Regular expression describing a manpage section within parentheses.")

(defvar Man-page-header-regexp
310
  (if (string-match "-solaris2\\." system-configuration)
311
      (concat "^[-[:alnum:]_].*[ \t]\\(" Man-name-regexp
312 313 314 315 316
	      "(\\(" Man-section-regexp "\\))\\)$")
    (concat "^[ \t]*\\(" Man-name-regexp
	    "(\\(" Man-section-regexp "\\))\\).*\\1"))
  "Regular expression describing the heading of a page.")

317
(defvar Man-heading-regexp "^\\([[:upper:]][[:upper:]0-9 /-]+\\)$"
318 319
  "Regular expression describing a manpage heading entry.")

320
(defvar Man-see-also-regexp "\\(SEE ALSO\\|VOIR AUSSI\\|SIEHE AUCH\\|VÉASE TAMBIÉN\\|VEJA TAMBÉM\\|VEDERE ANCHE\\|ZOBACZ TAKŻE\\|İLGİLİ BELGELER\\|参照\\|参见 SEE ALSO\\|參見 SEE ALSO\\)"
321 322 323
  "Regular expression for SEE ALSO heading (or your equivalent).
This regexp should not start with a `^' character.")

Juri Linkov's avatar
Juri Linkov committed
324 325 326 327
;; This used to have leading space [ \t]*, but was removed because it
;; causes false page splits on an occasional NAME with leading space
;; inside a manpage.  And `Man-heading-regexp' doesn't have [ \t]* anyway.
(defvar Man-first-heading-regexp "^NAME$\\|^[ \t]*No manual entry fo.*$"
328 329 330 331
  "Regular expression describing first heading on a manpage.
This regular expression should start with a `^' character.")

(defvar Man-reference-regexp
332
  (concat "\\(" Man-name-regexp
333
	  "\\(\\([-‐]\n\\)?[ \t]+" Man-name-regexp "\\)*\\)[ \t]*(\\("
334
	  Man-section-regexp "\\))")
335 336
  "Regular expression describing a reference to another manpage.")

Masatake YAMATO's avatar
Masatake YAMATO committed
337
(defvar Man-apropos-regexp
338
  (concat "\\[\\(" Man-name-regexp "\\)\\][ \t]*(\\(" Man-section-regexp "\\))")
Masatake YAMATO's avatar
Masatake YAMATO committed
339 340
  "Regular expression describing a reference to manpages in \"man -k output\".")

341 342 343 344
(defvar Man-synopsis-regexp "SYNOPSIS"
  "Regular expression for SYNOPSIS heading (or your equivalent).
This regexp should not start with a `^' character.")

345 346
(defvar Man-files-regexp "FILES\\>"
  ;; Add \> so as not to match mount(8)'s FILESYSTEM INDEPENDENT MOUNT OPTIONS.
347 348 349 350 351 352
  "Regular expression for FILES heading (or your equivalent).
This regexp should not start with a `^' character.")

(defvar Man-include-regexp "#[ \t]*include[ \t]*"
  "Regular expression describing the #include (directive of cpp).")

353
(defvar Man-file-name-regexp "[^<>\", \t\n]+"
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
  "Regular expression describing <> in #include line (directive of cpp).")

(defvar Man-normal-file-prefix-regexp "[/~$]"
  "Regular expression describing a file path appeared in FILES section.")

(defvar Man-header-regexp
  (concat "\\(" Man-include-regexp "\\)"
          "[<\"]"
          "\\(" Man-file-name-regexp "\\)"
          "[>\"]")
  "Regular expression describing references to header files.")

(defvar Man-normal-file-regexp
  (concat Man-normal-file-prefix-regexp Man-file-name-regexp)
  "Regular expression describing references to normal files.")

370
;; This includes the section as an optional part to catch hyphenated
Juanma Barranquero's avatar
Juanma Barranquero committed
371
;; references to manpages.
372 373 374 375
(defvar Man-hyphenated-reference-regexp
  (concat "\\(" Man-name-regexp "\\)\\((\\(" Man-section-regexp "\\))\\)?")
  "Regular expression describing a reference in the SEE ALSO section.")

376
(defcustom Man-switches ""
377
  "Switches passed to the man command, as a single string.
378 379 380 381
For example, the -a switch lets you see all the manpages for a
specified subject, if your `man' program supports it."
  :type 'string
  :group 'man)
382 383 384 385 386 387 388

(defvar Man-specified-section-option
  (if (string-match "-solaris[0-9.]*$" system-configuration)
      "-s"
    "")
  "Option that indicates a specified a manual section name.")

Juri Linkov's avatar
Juri Linkov committed
389 390 391 392 393 394
(defvar Man-support-local-filenames 'auto-detect
  "Internal cache for the value of the function `Man-support-local-filenames'.
`auto-detect' means the value is not yet determined.
Otherwise, the value is whatever the function
`Man-support-local-filenames' should return.")

Rüdiger Sonderfeld's avatar
Rüdiger Sonderfeld committed
395 396 397 398 399 400
(defcustom man-imenu-title "Contents"
  "The title to use if man adds a Contents menu to the menubar."
  :version "24.4"
  :type 'string
  :group 'man)

401 402

;; other variables and keymap initializations
403 404 405 406 407 408
(defvar Man-original-frame)
(make-variable-buffer-local 'Man-original-frame)
(defvar Man-arguments)
(make-variable-buffer-local 'Man-arguments)
(put 'Man-arguments 'permanent-local t)

409 410 411 412
(defvar Man--sections nil)
(make-variable-buffer-local 'Man--sections)
(defvar Man--refpages nil)
(make-variable-buffer-local 'Man--refpages)
413
(defvar Man-page-list nil)
414
(make-variable-buffer-local 'Man-page-list)
415
(defvar Man-current-page 0)
416
(make-variable-buffer-local 'Man-current-page)
417
(defvar Man-page-mode-string "1 of 1")
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
(make-variable-buffer-local 'Man-page-mode-string)

(defconst Man-sysv-sed-script "\
/\b/ {	s/_\b//g
	s/\b_//g
        s/o\b+/o/g
        s/+\bo/o/g
	:ovstrk
	s/\\(.\\)\b\\1/\\1/g
	t ovstrk
	}
/\e\\[[0-9][0-9]*m/ s///g"
  "Script for sysV-like sed to nuke backspaces and ANSI codes from manpages.")

(defconst Man-berkeley-sed-script "\
/\b/ {	s/_\b//g\\
	s/\b_//g\\
        s/o\b+/o/g\\
        s/+\bo/o/g\\
	:ovstrk\\
	s/\\(.\\)\b\\1/\\1/g\\
	t ovstrk\\
	}\\
/\e\\[[0-9][0-9]*m/ s///g"
  "Script for berkeley-like sed to nuke backspaces and ANSI codes from manpages.")

444 445
(defvar Man-topic-history nil "Topic read history.")

446
(defvar Man-mode-syntax-table
447 448 449
  (let ((table (copy-syntax-table (standard-syntax-table))))
    (modify-syntax-entry ?. "w" table)
    (modify-syntax-entry ?_ "w" table)
450
    (modify-syntax-entry ?: "w" table)	; for PDL::Primitive in Perl man pages
451 452 453
    table)
  "Syntax table used in Man mode buffers.")

454 455 456
(defvar Man-mode-map
  (let ((map (make-sparse-keymap)))
    (suppress-keymap map)
457 458
    (set-keymap-parent map
      (make-composed-keymap button-buffer-map special-mode-map))
459 460 461 462 463 464 465 466 467 468

    (define-key map "n"    'Man-next-section)
    (define-key map "p"    'Man-previous-section)
    (define-key map "\en"  'Man-next-manpage)
    (define-key map "\ep"  'Man-previous-manpage)
    (define-key map "."    'beginning-of-buffer)
    (define-key map "r"    'Man-follow-manual-reference)
    (define-key map "g"    'Man-goto-section)
    (define-key map "s"    'Man-goto-see-also-section)
    (define-key map "k"    'Man-kill)
469
    (define-key map "u"    'Man-update-manpage)
470 471 472 473
    (define-key map "m"    'man)
    ;; Not all the man references get buttons currently.  The text in the
    ;; manual page can contain references to other man pages
    (define-key map "\r"   'man-follow)
Rüdiger Sonderfeld's avatar
Rüdiger Sonderfeld committed
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494

    (easy-menu-define nil map
      "`Man-mode' menu."
      '("Man"
        ["Next Section" Man-next-section t]
        ["Previous Section" Man-previous-section t]
        ["Go To Section..." Man-goto-section t]
        ["Go To \"SEE ALSO\" Section" Man-goto-see-also-section
         :active (cl-member Man-see-also-regexp Man--sections
                            :test #'string-match-p)]
        ["Follow Reference..." Man-follow-manual-reference
         :active Man--refpages
         :help "Go to a manpage referred to in the \"SEE ALSO\" section"]
        "--"
        ["Next Manpage" Man-next-manpage
         :active (> (length Man-page-list) 1)]
        ["Previous Manpage" Man-previous-manpage
         :active (> (length Man-page-list) 1)]
        "--"
        ["Man..." man t]
        ["Kill Buffer" Man-kill t]
495
        ["Quit" quit-window t]))
496 497
    map)
  "Keymap for Man mode.")
498

499
;; buttons
500
(define-button-type 'Man-abstract-xref-man-page
501
  'follow-link t
502 503
  'help-echo "mouse-2, RET: display this man page"
  'func nil
504 505
  'action #'Man-xref-button-action)

Lute Kamstra's avatar
Lute Kamstra committed
506
(defun Man-xref-button-action (button)
507
  (let ((target (button-get button 'Man-target-string)))
Lute Kamstra's avatar
Lute Kamstra committed
508
    (funcall
509 510 511 512 513 514
     (button-get button 'func)
     (cond ((null target)
	    (button-label button))
	   ((functionp target)
	    (funcall target (button-start button)))
	   (t target)))))
515

Lute Kamstra's avatar
Lute Kamstra committed
516
(define-button-type 'Man-xref-man-page
517 518 519
  :supertype 'Man-abstract-xref-man-page
  'func 'man-follow)

520 521

(define-button-type 'Man-xref-header-file
Juanma Barranquero's avatar
Juanma Barranquero committed
522 523 524 525
    'action (lambda (button)
              (let ((w (button-get button 'Man-target-string)))
                (unless (Man-view-header-file w)
                  (error "Cannot find header file: %s" w))))
526
    'follow-link t
Juanma Barranquero's avatar
Juanma Barranquero committed
527
    'help-echo "mouse-2: display this header file")
528 529 530 531 532 533 534 535 536 537

(define-button-type 'Man-xref-normal-file
  'action (lambda (button)
	    (let ((f (substitute-in-file-name
		      (button-get button 'Man-target-string))))
	      (if (file-exists-p f)
		  (if (file-readable-p f)
		      (view-file f)
		    (error "Cannot read a file: %s" f))
		(error "Cannot find a file: %s" f))))
538
  'follow-link t
Kim F. Storm's avatar
Kim F. Storm committed
539
  'help-echo "mouse-2: display this file")
540

541 542 543 544 545

;; ======================================================================
;; utilities

(defun Man-init-defvars ()
546
  "Used for initializing variables based on display's color support.
547 548 549 550 551 552 553 554
This is necessary if one wants to dump man.el with Emacs."

  ;; Avoid possible error in call-process by using a directory that must exist.
  (let ((default-directory "/"))
    (setq Man-sed-script
	  (cond
	   (Man-fontify-manpage-flag
	    nil)
555
	   ((eq 0 (call-process Man-sed-command nil nil nil Man-sysv-sed-script))
556
	    Man-sysv-sed-script)
557
	   ((eq 0 (call-process Man-sed-command nil nil nil Man-berkeley-sed-script))
558 559 560 561 562 563 564 565 566
	    Man-berkeley-sed-script)
	   (t
	    nil))))

  (setq Man-filter-list
	;; Avoid trailing nil which confuses customize.
	(apply 'list
	 (cons
	  Man-sed-command
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
	  (if (eq system-type 'windows-nt)
	      ;; Windows needs ".." quoting, not '..'.
	      (list
	       "-e \"/Reformatting page.  Wait/d\""
	       "-e \"/Reformatting entry.  Wait/d\""
	       "-e \"/^[ \t][ \t]*-[ \t][0-9]*[ \t]-[ \t]*Formatted:.*[0-9]$/d\""
	       "-e \"/^[ \t]*Page[ \t][0-9]*.*(printed[ \t][0-9\\/]*)$/d\""
	       "-e \"/^Printed[ \t][0-9].*[0-9]$/d\""
	       "-e \"/^[ \t]*X[ \t]Version[ \t]1[01].*Release[ \t][0-9]/d\""
	       "-e \"/^[A-Za-z].*Last[ \t]change:/d\""
	       "-e \"/[ \t]*Copyright [0-9]* UNIX System Laboratories, Inc.$/d\""
	       "-e \"/^[ \t]*Rev\\..*Page [0-9][0-9]*$/d\"")
	    (list
	     (if Man-sed-script
		 (concat "-e '" Man-sed-script "'")
	       "")
	     "-e '/^[\001-\032][\001-\032]*$/d'"
	     "-e '/\e[789]/s///g'"
	     "-e '/Reformatting page.  Wait/d'"
	     "-e '/Reformatting entry.  Wait/d'"
	     "-e '/^[ \t]*Hewlett-Packard[ \t]Company[ \t]*-[ \t][0-9]*[ \t]-/d'"
	     "-e '/^[ \t]*Hewlett-Packard[ \t]*-[ \t][0-9]*[ \t]-.*$/d'"
	     "-e '/^[ \t][ \t]*-[ \t][0-9]*[ \t]-[ \t]*Formatted:.*[0-9]$/d'"
	     "-e '/^[ \t]*Page[ \t][0-9]*.*(printed[ \t][0-9\\/]*)$/d'"
	     "-e '/^Printed[ \t][0-9].*[0-9]$/d'"
	     "-e '/^[ \t]*X[ \t]Version[ \t]1[01].*Release[ \t][0-9]/d'"
	     "-e '/^[A-Za-z].*Last[ \t]change:/d'"
	     "-e '/^Sun[ \t]Release[ \t][0-9].*[0-9]$/d'"
	     "-e '/[ \t]*Copyright [0-9]* UNIX System Laboratories, Inc.$/d'"
	     "-e '/^[ \t]*Rev\\..*Page [0-9][0-9]*$/d'"
	     )))
	 ;; Windows doesn't support multi-line commands, so don't
	 ;; invoke Awk there.
	 (unless (eq system-type 'windows-nt)
	   (cons
	    Man-awk-command
	    (list
	     "'\n"
	     "BEGIN { blankline=0; anonblank=0; }\n"
	     "/^$/ { if (anonblank==0) next; }\n"
	     "{ anonblank=1; }\n"
	     "/^$/ { blankline++; next; }\n"
	     "{ if (blankline>0) { print \"\"; blankline=0; } print $0; }\n"
	     "'"
	     )))
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
	 (if (not Man-uses-untabify-flag)
	     ;; The outer list will be stripped off by apply.
	     (list (cons
		    Man-untabify-command
		    Man-untabify-command-args))
	   )))
)

(defsubst Man-make-page-mode-string ()
  "Formats part of the mode line for Man mode."
  (format "%s page %d of %d"
	  (or (nth 2 (nth (1- Man-current-page) Man-page-list))
	      "")
	  Man-current-page
	  (length Man-page-list)))

(defsubst Man-build-man-command ()
  "Builds the entire background manpage and cleaning command."
  (let ((command (concat manual-program " " Man-switches
Juri Linkov's avatar
Juri Linkov committed
631 632 633 634 635 636 637
                         (cond
                          ;; Already has %s
                          ((string-match "%s" manual-program) "")
                          ;; Stock MS-DOS shells cannot redirect stderr;
                          ;; `call-process' below sends it to /dev/null,
                          ;; so we don't need `2>' even with DOS shells
                          ;; which do support stderr redirection.
Eli Zaretskii's avatar
Eli Zaretskii committed
638
                          ((not (fboundp 'make-process)) " %s")
639 640 641 642 643 644 645
                          ((concat " %s 2>" null-device
                                   ;; Some MS-Windows ports of Groff
                                   ;; try to read stdin after exhausting
                                   ;; the command-line arguments; make
                                   ;; them exit if/when they do.
                                   (if (eq system-type 'windows-nt)
                                       (concat " <" null-device)))))))
646 647 648 649 650 651 652 653 654 655 656
	(flist Man-filter-list))
    (while (and flist (car flist))
      (let ((pcom (car (car flist)))
	    (pargs (cdr (car flist))))
	(setq command
	      (concat command " | " pcom " "
		      (mapconcat (lambda (phrase)
				   (if (not (stringp phrase))
				       (error "Malformed Man-filter-list"))
				   phrase)
				 pargs " ")))
657
        (setq flist (cdr flist))))
658 659
    command))

660 661 662 663 664 665 666 667 668 669 670 671

(defun Man-translate-cleanup (string)
  "Strip leading, trailing and middle spaces."
  (when (stringp string)
    ;;  Strip leading and trailing
    (if (string-match "^[ \t\f\r\n]*\\(.+[^ \t\f\r\n]\\)" string)
        (setq string (match-string 1 string)))
    ;; middle spaces
    (setq string (replace-regexp-in-string "[\t\r\n]" " " string))
    (setq string (replace-regexp-in-string "  +" " " string))
    string))

672 673 674
(defun Man-translate-references (ref)
  "Translates REF from \"chmod(2V)\" to \"2v chmod\" style.
Leave it as is if already in that style.  Possibly downcase and
675 676
translate the section (see the `Man-downcase-section-letters-flag'
and the `Man-section-translations-alist' variables)."
677
  (let ((name "")
678 679 680
        (section "")
        (slist Man-section-translations-alist))
    (setq ref (Man-translate-cleanup ref))
681 682 683
    (cond
     ;; "chmod(2V)" case ?
     ((string-match (concat "^" Man-reference-regexp "$") ref)
684
      (setq name (replace-regexp-in-string "[\n\t ]" "" (match-string 1 ref))
685
	    section (match-string 4 ref)))
686 687 688
     ;; "2v chmod" case ?
     ((string-match (concat "^\\(" Man-section-regexp
			    "\\) +\\(" Man-name-regexp "\\)$") ref)
689 690
      (setq name (match-string 2 ref)
	    section (match-string 1 ref))))
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
    (if (string= name "")
	ref				; Return the reference as is
      (if Man-downcase-section-letters-flag
	  (setq section (downcase section)))
      (while slist
	(let ((s1 (car (car slist)))
	      (s2 (cdr (car slist))))
	  (setq slist (cdr slist))
	  (if Man-downcase-section-letters-flag
	      (setq s1 (downcase s1)))
	  (if (not (string= s1 section)) nil
	    (setq section (if Man-downcase-section-letters-flag
			      (downcase s2)
			    s2)
		  slist nil))))
      (concat Man-specified-section-option section " " name))))

Juri Linkov's avatar
Juri Linkov committed
708
(defun Man-support-local-filenames ()
709 710 711 712 713 714 715 716 717 718 719 720
  "Return non-nil if the man command supports local filenames.
Different man programs support this feature in different ways.
The default Debian man program (\"man-db\") has a `--local-file'
\(or `-l') option for this purpose.  The default Red Hat man
program has no such option, but interprets any name containing
a \"/\" as a local filename.  The function returns either `man-db'
`man', or nil."
  (if (eq Man-support-local-filenames 'auto-detect)
      (setq Man-support-local-filenames
            (with-temp-buffer
              (let ((default-directory
                      ;; Ensure that `default-directory' exists and is readable.
721 722
                      (if (file-accessible-directory-p default-directory)
                          default-directory
723 724 725 726 727 728 729 730 731 732 733
                        (expand-file-name "~/"))))
                (ignore-errors
                  (call-process manual-program nil t nil "--help")))
              (cond ((search-backward "--local-file" nil 'move)
                     'man-db)
                    ;; This feature seems to be present in at least ver 1.4f,
                    ;; which is about 20 years old.
                    ;; I don't know if this version has an official name?
                    ((looking-at "^man, versione? [1-9]")
                     'man))))
    Man-support-local-filenames))
Juri Linkov's avatar
Juri Linkov committed
734

735 736

;; ======================================================================
737
;; default man entry: get word near point
738

739 740 741
(defun Man-default-man-entry (&optional pos)
  "Guess default manual entry based on the text near position POS.
POS defaults to `point'."
742
  (let (word start column distance)
743
    (save-excursion
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
      (when pos (goto-char pos))
      (setq pos (point))
      ;; The default title is the nearest entry-like object before or
      ;; after POS.
      (if (and (skip-chars-backward " \ta-zA-Z0-9+")
	       (not (zerop (skip-chars-backward "(")))
	       ;; Try to handle the special case where POS is on a
	       ;; section number.
	       (looking-at
		(concat "([ \t]*\\(" Man-section-regexp "\\)[ \t]*)"))
	       ;; We skipped a valid section number backwards, look at
	       ;; preceding text.
	       (or (and (skip-chars-backward ",; \t")
			(not (zerop (skip-chars-backward "-a-zA-Z0-9._+:"))))
		   ;; Not a valid entry, move POS after closing paren.
		   (not (setq pos (match-end 0)))))
	  ;; We have a candidate, make `start' record its starting
	  ;; position.
762
	  (setq start (point))
763 764
	;; Otherwise look at char before POS.
	(goto-char pos)
765
	(if (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:")))
766 767 768 769 770
	    ;; Our candidate is just before or around POS.
	    (setq start (point))
	  ;; Otherwise record the current column and look backwards.
	  (setq column (current-column))
	  (skip-chars-backward ",; \t")
Paul Eggert's avatar
Paul Eggert committed
771
	  ;; Record the distance traveled.
772 773
	  (setq distance (- column (current-column)))
	  (when (looking-back
774 775
		 (concat "([ \t]*\\(?:" Man-section-regexp "\\)[ \t]*)")
                 (line-beginning-position))
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
	    ;; Skip section number backwards.
	    (goto-char (match-beginning 0))
	    (skip-chars-backward " \t"))
	  (if (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:")))
	      (progn
		;; We have a candidate before POS ...
		(setq start (point))
		(goto-char pos)
		(if (and (skip-chars-forward ",; \t")
			 (< (- (current-column) column) distance)
			 (looking-at "[-a-zA-Z0-9._+:]"))
		    ;; ... but the one after POS is better.
		    (setq start (point))
		  ;; ... and anything after POS is worse.
		  (goto-char start)))
	    ;; No candidate before POS.
	    (goto-char pos)
	    (skip-chars-forward ",; \t")
	    (setq start (point)))))
      ;; We have found a suitable starting point, try to skip at least
      ;; one character.
797 798 799 800 801 802
      (skip-chars-forward "-a-zA-Z0-9._+:")
      (setq word (buffer-substring-no-properties start (point)))
      ;; If there is a continuation at the end of line, check the
      ;; following line too, eg:
      ;;     see this-
      ;;     command-here(1)
803
      ;; Note: This code gets executed iff our entry is after POS.
804 805 806 807 808 809 810 811 812 813 814 815 816
      (when (looking-at
             (concat
              "‐?[ \t\r\n]+\\([-a-zA-Z0-9._+:]+\\)(" Man-section-regexp ")"))
        (let ((1st-part word))
          (setq word (concat word (match-string-no-properties 1)))
          ;; If they use -Tascii, we cannot know whether a hyphen at
          ;; EOL is or isn't part of the referenced manpage name.
          ;; Heuristics: if the part of the manpage before the hyphen
          ;; doesn't include a hyphen, we consider the hyphen to be
          ;; added by troff, and remove it.
          (or (not (eq (string-to-char (substring 1st-part -1)) ?-))
              (string-match-p "-" (substring 1st-part 0 -1))
              (setq word (replace-regexp-in-string "-" "" word))))
817 818
	;; Make sure the section number gets included by the code below.
	(goto-char (match-end 1)))
819
      (when (string-match "[-._‐]+$" word)
820
	(setq word (substring word 0 (match-beginning 0))))
821 822 823 824 825 826 827 828 829 830 831 832 833
      ;; The following was commented out since the preceding code
      ;; should not produce a leading "*" in the first place.
;;;       ;; If looking at something like *strcat(... , remove the '*'
;;;       (when (string-match "^*" word)
;;; 	(setq word (substring word 1)))
	(concat
	 word
	 (and (not (string-equal word ""))
	      ;; If looking at something like ioctl(2) or brc(1M),
	      ;; include the section number in the returned value.
	      (looking-at
	       (concat "[ \t]*([ \t]*\\(" Man-section-regexp "\\)[ \t]*)"))
	      (format "(%s)" (match-string-no-properties 1)))))))
834 835 836 837 838 839 840 841 842


;; ======================================================================
;; Top level command and background process sentinel

;; For compatibility with older versions.
;;;###autoload
(defalias 'manual-entry 'man)

843 844 845 846 847
(defvar Man-completion-cache nil
  ;; On my machine, "man -k" is so fast that a cache makes no sense,
  ;; but apparently that's not the case in all cases, so let's add a cache.
  "Cache of completion table of the form (PREFIX . TABLE).")

848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
(defvar Man-man-k-use-anchor
  ;; man-db or man-1.*
  (memq system-type '(gnu gnu/linux gnu/kfreebsd))
  "If non-nil prepend ^ to the prefix passed to \"man -k\" for completion.
The value should be nil if \"man -k ^PREFIX\" may omit some man
pages whose names start with PREFIX.

Currently, the default value depends on `system-type' and is
non-nil where the standard man programs are known to behave
properly.  Setting the value to nil always gives correct results
but computing the list of completions may take a bit longer.")

(defun Man-parse-man-k ()
  "Parse \"man -k\" output and return the list of page names.

The current buffer should contain the output of a command of the
form \"man -k keyword\", which is traditionally also available with
apropos(1).

While POSIX man(1p) is a bit vague about what to expect here,
this function tries to parse some commonly used formats, which
can be described in the following informal way, with square brackets
indicating optional parts and whitespace being interpreted
somewhat loosely.

foo[, bar [, ...]] [other stuff] (sec) - description
874
foo(sec)[, bar(sec) [, ...]] [other stuff] - description"
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
  (goto-char (point-min))
  ;; See man-tests for data about which systems use which format (hopefully we
  ;; will be able to simplify the code if/when some of those formats aren't
  ;; used any more).
  (let (table)
    (while (search-forward-regexp "^\\([^ \t,\n]+\\)\\(.*?\\)\
\\(?:[ \t]\\(([^ \t,\n]+?)\\)\\)?\\(?:[ \t]+- ?\\(.*\\)\\)?$" nil t)
      (let ((section (match-string 3))
	    (description (match-string 4))
	    (bound (match-end 2)))
        (goto-char (match-end 1))
	(while
            (progn
              ;; The first regexp grouping may already match the section
              ;; tacked on to the name, which is ok since for the formats we
              ;; claim to support the third (non-shy) grouping does not
              ;; match in this case, i.e., section is nil.
              (push (propertize (concat (match-string 1) section)
                                'help-echo description)
                    table)
              (search-forward-regexp "\\=, *\\([^ \t,]+\\)" bound t)))))
    (nreverse table)))

898 899
(defun Man-completion-table (string pred action)
  (cond
900 901 902 903
   ;; This ends up returning t for pretty much any string, and hence leads to
   ;; spurious "complete but not unique" messages.  And since `man' doesn't
   ;; require-match anyway, there's not point being clever.
   ;;((eq action 'lambda) (not (string-match "([^)]*\\'" string)))
904 905 906
   ((equal string "-k")
    ;; Let SPC (minibuffer-complete-word) insert the space.
    (complete-with-action action '("-k ") string pred))
907 908 909 910 911 912 913
   (t
    (let ((table (cdr Man-completion-cache))
          (section nil)
          (prefix string))
      (when (string-match "\\`\\([[:digit:]].*?\\) " string)
        (setq section (match-string 1 string))
        (setq prefix (substring string (match-end 0))))
914
      (unless (and Man-completion-cache
915 916
                   (string-prefix-p (car Man-completion-cache) prefix))
        (with-temp-buffer
917 918 919
          (setq default-directory "/") ;; in case inherited doesn't exist
          ;; Actually for my `man' the arg is a regexp.
          ;; POSIX says it must be ERE and "man-db" seems to agree,
920
          ;; whereas under macOS it seems to be BRE-style and doesn't
921 922 923 924
          ;; accept backslashes at all.  Let's not bother to
          ;; quote anything.
          (let ((process-environment (copy-sequence process-environment)))
            (setenv "COLUMNS" "999") ;; don't truncate long names
925 926 927 928
            ;; manual-program might not even exist.  And since it's
            ;; run differently in Man-getpage-in-background, an error
            ;; here may not necessarily mean that we'll also get an
            ;; error later.
929 930 931 932 933 934 935 936 937
	    (ignore-errors
	      (call-process manual-program nil '(t nil) nil
			    "-k" (concat (when (or Man-man-k-use-anchor
						   (string-equal prefix ""))
					   "^")
					 prefix))))
	  (setq table (Man-parse-man-k)))
	;; Cache the table for later reuse.
	(setq Man-completion-cache (cons prefix table)))
938 939
      ;; The table may contain false positives since the match is made
      ;; by "man -k" not just on the manpage's name.
940 941 942 943 944 945 946
      (if section
          (let ((re (concat "(" (regexp-quote section) ")\\'")))
            (dolist (comp (prog1 table (setq table nil)))
              (if (string-match re comp)
                  (push (substring comp 0 (match-beginning 0)) table)))
            (completion-table-with-context (concat section " ") table
                                           prefix pred action))
947 948 949 950 951
        ;; If the current text looks like a possible section name,
        ;; then add a completion entry that just adds a space so SPC
        ;; can be used to insert a space.
        (if (string-match "\\`[[:digit:]]" string)
            (push (concat string " ") table))
952 953 954 955 956 957 958 959 960 961
        (let ((res (complete-with-action action table string pred)))
          ;; In case we're completing to a single name that exists in
          ;; several sections, the longest prefix will look like "foo(".
          (if (and (stringp res)
                   (string-match "([^(]*\\'" res)
                   ;; In case the paren was already in `prefix', don't
                   ;; remove it.
                   (> (match-beginning 0) (length prefix)))
              (substring res 0 (match-beginning 0))
            res)))))))
962

963 964 965
;;;###autoload
(defun man (man-args)
  "Get a Un*x manual page and put it in a buffer.
966 967
This command is the top-level command in the man package.
It runs a Un*x command to retrieve and clean a manpage in the
968
background and places the results in a `Man-mode' browsing
969 970 971 972 973
buffer.  The variable `Man-width' defines the number of columns in
formatted manual pages.  The buffer is displayed immediately.
The variable `Man-notify-method' defines how the buffer is displayed.
If a buffer already exists for this man page, it will be displayed
without running the man command.
974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996

For a manpage from a particular section, use either of the
following.  \"cat(1)\" is how cross-references appear and is
passed to man as \"1 cat\".

    cat(1)
    1 cat

To see manpages from all sections related to a subject, use an
\"all pages\" option (which might be \"-a\" if it's not the
default), then step through with `Man-next-manpage' (\\<Man-mode-map>\\[Man-next-manpage]) etc.
Add to `Man-switches' to make this option permanent.

    -a chmod

An explicit filename can be given too.  Use -l if it might
otherwise look like a page name.

    /my/file/name.1.gz
    -l somefile.1

An \"apropos\" query with -k gives a buffer of matching page
names or descriptions.  The pattern argument is usually an
Paul Eggert's avatar
Paul Eggert committed
997
\"grep -E\" style regexp.
998 999 1000

    -k pattern"

1001 1002
  (interactive
   (list (let* ((default-entry (Man-default-man-entry))
1003 1004
		;; ignore case because that's friendly for bizarre
		;; caps things like the X11 function names and because
1005
		;; "man" itself is case-insensitive on the command line
1006 1007 1008 1009
		;; so you're accustomed not to bother about the case
		;; ("man -k" is case-insensitive similarly, so the
		;; table has everything available to complete)
		(completion-ignore-case t)
1010
		Man-completion-cache    ;Don't cache across calls.
1011
		(input (completing-read
1012
			(format "Manual entry%s"
1013
				(if (string= default-entry "")
1014 1015
				    ": "
				  (format " (default %s): " default-entry)))
1016 1017
                        'Man-completion-table
			nil nil nil 'Man-topic-history default-entry)))
1018
	   (if (string= input "")
1019
	       (error "No man args given")
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
	     input))))

  ;; Possibly translate the "subject(section)" syntax into the
  ;; "section subject" syntax and possibly downcase the section.
  (setq man-args (Man-translate-references man-args))

  (Man-getpage-in-background man-args))

;;;###autoload
(defun man-follow (man-args)
  "Get a Un*x manual page of the item under point and put it in a buffer."
  (interactive (list (Man-default-man-entry)))
  (if (or (not man-args)
	  (string= man-args ""))
      (error "No item under point")
    (man man-args)))

1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
(defvar Man-columns nil)

(defun Man-columns ()
  (let ((width (cond
                ((and (integerp Man-width) (> Man-width 0))
                 Man-width)
                (Man-width
                 (let ((window (get-buffer-window nil t)))
                   (frame-width (and window (window-frame window)))))
                (t
                 (window-width (get-buffer-window nil t))))))
    (when (and (integerp Man-width-max)
               (> Man-width-max 0))
      (setq width (min width Man-width-max)))
    width))

1053
(defmacro Man-start-calling (&rest body)
1054
  "Start the man command in `body' after setting up the environment."
1055 1056 1057 1058 1059 1060
  `(let ((process-environment (copy-sequence process-environment))
	;; The following is so Awk script gets \n intact
	;; But don't prevent decoding of the outside.
	(coding-system-for-write 'raw-text-unix)
	;; We must decode the output by a coding system that the
	;; system's locale suggests in multibyte mode.
1061 1062 1063 1064
	(coding-system-for-read
         (or coding-system-for-read  ; allow overriding with "C-x RET c"
             Man-coding-system
             locale-coding-system))
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
	;; Avoid possible error by using a directory that always exists.
	(default-directory
	  (if (and (file-directory-p default-directory)
		   (not (find-file-name-handler default-directory
						'file-directory-p)))
	      default-directory
	    "/")))
    ;; Prevent any attempt to use display terminal fanciness.
    (setenv "TERM" "dumb")
    ;; In Debian Woody, at least, we get overlong lines under X
    ;; unless COLUMNS or MANWIDTH is set.  This isn't a problem on
    ;; a tty.  man(1) says:
    ;;        MANWIDTH
    ;;               If $MANWIDTH is set, its value is used as the  line
    ;;               length  for which manual pages should be formatted.
    ;;               If it is not set, manual pages  will  be  formatted
    ;;               with  a line length appropriate to the current ter-
    ;;               minal (using an ioctl(2) if available, the value of
    ;;               $COLUMNS,  or falling back to 80 characters if nei-
    ;;               ther is available).
    (when (or window-system
	      (not (or (getenv "MANWIDTH") (getenv "COLUMNS"))))
1087 1088
      ;; Since the page buffer is displayed beforehand,
      ;; we can select its window and get the window/frame width.
1089 1090
      (setq-local Man-columns (Man-columns))
      (setenv "COLUMNS" (number-to-string Man-columns)))
1091 1092 1093 1094 1095 1096
    ;; Since man-db 2.4.3-1, man writes plain text with no escape
    ;; sequences when stdout is not a tty.	In 2.5.0, the following
    ;; env-var was added to allow control of this (see Debian Bug#340673).
    (setenv "MAN_KEEP_FORMATTING" "1")
    ,@body))

1097
(defun Man-getpage-in-background (topic)
1098 1099
  "Use TOPIC to build and fire off the manpage and cleaning command.
Return the buffer in which the manpage will appear."
1100 1101 1102 1103 1104 1105 1106 1107
  (let* ((man-args topic)
	 (bufname (concat "*Man " man-args "*"))
	 (buffer  (get-buffer bufname)))
    (if buffer
	(Man-notify-when-ready buffer)
      (require 'env)
      (message "Invoking %s %s in the background" manual-program man-args)
      (setq buffer (generate-new-buffer bufname))
1108
      (with-current-buffer buffer
1109
	(Man-notify-when-ready buffer)
1110
	(setq buffer-undo-list t)
1111
	(setq Man-original-frame (selected-frame))
1112 1113 1114 1115 1116 1117 1118 1119
	(setq Man-arguments man-args)
	(Man-mode)
	(setq mode-line-process
	      (concat " " (propertize (if Man-fontify-manpage-flag
					  "[formatting...]"
					"[cleaning...]")
				      'face 'mode-line-emphasis)))
	(Man-start-calling
Eli Zaretskii's avatar
Eli Zaretskii committed
1120
	 (if (fboundp 'make-process)
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
	     (let ((proc (start-process
			  manual-program buffer
			  (if (memq system-type '(cygwin windows-nt))
			      shell-file-name
			    "sh")
			  shell-command-switch
			  (format (Man-build-man-command) man-args))))
	       (set-process-sentinel proc 'Man-bgproc-sentinel)
	       (set-process-filter proc 'Man-bgproc-filter))
	   (let* ((inhibit-read-only t)
		  (exit-status
		   (call-process shell-file-name nil (list buffer nil) nil
				 shell-command-switch
				 (format (Man-build-man-command) man-args)))
		  (msg ""))
	     (or (and (numberp exit-status)
		      (= exit-status 0))
		 (and (numberp exit-status)
		      (setq msg
			    (format "exited abnormally with code %d"
				    exit-status)))
		 (setq msg exit-status))
	     (if Man-fontify-manpage-flag
		 (Man-fontify-manpage)
	       (Man-cleanup-manpage))
	     (Man-bgproc-sentinel bufname msg))))))
    buffer))
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174

(defun Man-update-manpage ()
  "Reformat current manpage by calling the man command again synchronously."
  (interactive)
  (when (eq Man-arguments nil)
    ;;this shouldn't happen unless it is not in a Man buffer."
    (error "Man-arguments not initialized"))
  (let ((old-pos (point))
	(text (current-word))
	(old-size (buffer-size))
	(inhibit-read-only t)
	(buffer-read-only nil))
     (erase-buffer)
     (Man-start-calling
      (call-process shell-file-name nil (list (current-buffer) nil) nil
		    shell-command-switch
		    (format (Man-build-man-command) Man-arguments)))
     (if Man-fontify-manpage-flag
	 (Man-fontify-manpage)
       (Man-cleanup-manpage))
     (goto-char old-pos)
     ;;restore the point, not strictly right.
     (unless (or (eq text nil) (= old-size (buffer-size)))
       (let ((case-fold-search nil))
	 (if (> old-size (buffer-size))
	     (search-backward text nil t))
	 (search-forward text nil t)))))
1175

1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
(defvar Man--window-state-change-timer nil)

(defun Man--window-state-change (window)
  (unless (integerp Man-width)
    (when (timerp Man--window-state-change-timer)
      (cancel-timer Man--window-state-change-timer))
    (setq Man--window-state-change-timer
          (run-with-idle-timer 1 nil #'Man-fit-to-window window))))

(defun Man-fit-to-window (window)
  "Adjust width of the buffer to fit columns into WINDOW boundaries."
  (when (window-live-p window)
    (with-current-buffer (window-buffer window)
      (when (and (derived-mode-p 'Man-mode)
                 (not (eq Man-columns (Man-columns))))
        (let ((proc (get-buffer-process (current-buffer))))
          (unless (and proc (not (eq (process-status proc) 'exit)))
            (Man-update-manpage)))))))

1195 1196 1197
(defun Man-notify-when-ready (man-buffer)
  "Notify the user when MAN-BUFFER is ready.
See the variable `Man-notify-method' for the different notification behaviors."
1198
  (let ((saved-frame (with-current-buffer man-buffer
1199
		       Man-original-frame)))
1200
    (pcase Man-notify-method
1201
      ('newframe
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
       ;; Since we run asynchronously, perhaps while Emacs is waiting
       ;; for input, we must not leave a different buffer current.  We
       ;; can't rely on the editor command loop to reselect the
       ;; selected window's buffer.
       (save-excursion
         (let ((frame (make-frame Man-frame-parameters)))
           (set-window-buffer (frame-selected-window frame) man-buffer)
           (set-window-dedicated-p (frame-selected-window frame) t)
           (or (display-multi-frame-p frame)
               (select-frame frame)))))
1212
      ('pushy
1213
       (switch-to-buffer man-buffer))
1214
      ('bully
1215 1216 1217 1218
       (and (frame-live-p saved-frame)
            (select-frame saved-frame))
       (pop-to-buffer man-buffer)
       (delete-other-windows))
1219
      ('aggressive
1220 1221 1222
       (and (frame-live-p saved-frame)
            (select-frame saved-frame))
       (pop-to-buffer man-buffer))
1223
      ('friendly
1224 1225 1226
       (and (frame-live-p saved-frame)
            (select-frame saved-frame))
       (display-buffer man-buffer 'not-this-window))
1227
      ('polite
1228 1229
       (beep)
       (message "Manual buffer %s is ready" (buffer-name man-buffer)))
1230
      ('quiet
1231 1232 1233 1234
       (message "Manual buffer %s is ready" (buffer-name man-buffer)))
      (_ ;; meek
       (message ""))
      )))
1235 1236

(defun Man-softhyphen-to-minus ()
1237
  ;; \255 is SOFT HYPHEN in Latin-N.  Versions of Debian man, at
1238 1239 1240 1241
  ;; least, emit it even when not in a Latin-N locale.
  (unless (eq t (compare-strings "latin-" 0 nil
				 current-language-environment 0 6 t))
    (goto-char (point-min))
1242
    (while (search-forward "­" nil t) (replace-match "-"))))
1243 1244 1245 1246 1247 1248

(defun Man-fontify-manpage ()
  "Convert overstriking and underlining to the correct fonts.
Same for the ANSI bold and normal escape sequences."
  (interactive)
  (goto-char (point-min))
1249
  ;; Fontify ANSI escapes.
1250
  (let ((ansi-color-apply-face-function #'ansi-color-apply-text-property-face)
1251 1252
	(ansi-color-map Man-ansi-color-map))
    (ansi-color-apply-on-region (point-min) (point-max)))
1253
  ;; Other highlighting.
1254 1255 1256 1257 1258
  (let ((buffer-undo-list t))
    (if (< (buffer-size) (position-bytes (point-max)))
	;; Multibyte characters exist.
	(progn
	  (goto-char (point-min))
1259
	  (while (and (search-forward "__\b\b" nil t) (not (eobp)))
1260
	    (backward-delete-char 4)
1261 1262
            (put-text-property (point) (1+ (point))
                               'font-lock-face 'Man-underline))
1263 1264 1265
	  (goto-char (point-min))
	  (while (search-forward "\b\b__" nil t)
	    (backward-delete-char 4)
1266 1267
            (put-text-property (1- (point)) (point)
                               'font-lock-face 'Man-underline))))
1268
    (goto-char (point-min))
1269
    (while (and (search-forward "_\b" nil t) (not (eobp)))
1270
      (backward-delete-char 2)
1271
      (put-text-property (point) (1+ (point)) 'font-lock-face 'Man-underline))
1272 1273 1274
    (goto-char (point-min))
    (while (search-forward "\b_" nil t)
      (backward-delete-char 2)
1275
      (put-text-property (1- (point)) (point) 'font-lock-face 'Man-underline))
1276 1277 1278
    (goto-char (point-min))
    (while (re-search-forward "\\(.\\)\\(\b+\\1\\)+" nil t)
      (replace-match "\\1")
1279
      (put-text-property (1- (point)) (point) 'font-lock-face 'Man-overstrike))
1280 1281 1282
    (goto-char (point-min))
    (while (re-search-forward "o\b\\+\\|\\+\bo" nil t)
      (replace-match "o")
1283
      (put-text-property (1- (point)) (point) 'font-lock-face 'bold))
1284 1285 1286
    (goto-char (point-min))
    (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t)
      (replace-match "+")
1287
      (put-text-property (1- (point)) (point) 'font-lock-face 'bold))
1288
    ;; When the header is longer than the manpage name, groff tries to
Paul Eggert's avatar
Paul Eggert committed
1289
    ;; condense it to a shorter line interspersed with ^H.  Remove ^H with
1290
    ;; their preceding chars (but don't put Man-overstrike).  (Bug#5566)
1291 1292
    (goto-char (point-min))
    (while (re-search-forward ".\b" nil t) (backward-delete-char 2))
1293 1294 1295 1296 1297 1298 1299 1300
    (goto-char (point-min))
    ;; Try to recognize common forms of cross references.
    (Man-highlight-references)
    (Man-softhyphen-to-minus)
    (goto-char (point-min))
    (while (re-search-forward Man-heading-regexp nil t)
      (put-text-property (match-beginning 0)
			 (match-end 0)
1301
			 'font-lock-face 'Man-overstrike))))
1302

1303
(defun Man-highlight-references (&optional xref-man-type)
1304
  "Highlight the references on mouse-over.
1305
References include items in the SEE ALSO section,
1306 1307 1308 1309
header file (#include <foo.h>), and files in FILES.
If optional argument XREF-MAN-TYPE is non-nil, it used as the
button type for items in SEE ALSO section.  If it is nil, the
default type, `Man-xref-man-page' is used for the buttons."
1310 1311 1312 1313
  ;; `Man-highlight-references' is used from woman.el, too.
  ;; woman.el doesn't set `Man-arguments'.
  (unless Man-arguments
    (setq Man-arguments ""))
Masatake YAMATO's avatar
Masatake YAMATO committed
1314 1315
  (if (string-match "-k " Man-arguments)
      (progn
1316 1317
	(Man-highlight-references0 nil Man-reference-regexp 1
				   'Man-default-man-entry
1318 1319
				   (or xref-man-type 'Man-xref-man-page))
	(Man-highlight-references0 nil Man-apropos-regexp 1
1320
				   'Man-default-man-entry
1321
				   (or xref-man-type 'Man-xref-man-page)))
Lute Kamstra's avatar
Lute Kamstra committed
1322
    (Man-highlight-references0 Man-see-also-regexp Man-reference-regexp 1
1323
			       'Man-default-man-entry
1324 1325 1326 1327 1328
			       (or xref-man-type 'Man-xref-man-page))
    (Man-highlight-references0 Man-synopsis-regexp Man-header-regexp 0 2
			       'Man-xref-header-file)
    (Man-highlight-references0 Man-files-regexp Man-normal-file-regexp 0 0
			       'Man-xref-normal-file)))
1329

Masatake YAMATO's avatar
Masatake YAMATO committed
1330
(defun Man-highlight-references0 (start-section regexp button-pos target type)
1331
  ;; Based on `Man-build-references-alist'
1332 1333
  (when (or (null start-section)        ;; Search regardless of sections.
            ;; Section header is in this chunk.
1334
            (Man-find-section start-section))
Masatake YAMATO's avatar
Masatake YAMATO committed
1335 1336 1337 1338 1339 1340 1341 1342
    (let ((end (if start-section
		   (progn
		     (forward-line 1)
		     (back-to-indentation)
		     (save-excursion
		       (Man-next-section 1)
		       (point)))
		 (goto-char (point-min))
1343
		 nil)))
1344
      (while (re-search-forward regexp end t)
1345 1346 1347
	;; An overlay button is preferable because the underlying text
	;; may have text property highlights (Bug#7881).
	(make-button
1348 1349 1350
	 (match-beginning button-pos)
	 (match-end button-pos)
	 'type type
Masatake YAMATO's avatar
Masatake YAMATO committed
1351
	 'Man-target-string (cond
Lute Kamstra's avatar
Lute Kamstra committed
1352
			     ((numberp target)
Masatake YAMATO's avatar
Masatake YAMATO committed
1353 1354
			      (match-string target))
			     ((functionp target)
1355
			      target)
Masatake YAMATO's avatar
Masatake YAMATO committed
1356
			     (t nil)))))))
1357

1358 1359 1360 1361 1362 1363 1364
(defun Man-cleanup-manpage (&optional interactive)
  "Remove overstriking and underlining from the current buffer.
Normally skip any jobs that should have been done by the sed script,
but when called interactively, do those jobs even if the sed
script would have done them."
  (interactive "p")
  (if (or interactive (not Man-sed-script))
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
      (progn
	(goto-char (point-min))
	(while (search-forward "_\b" nil t) (backward-delete-char 2))
	(goto-char (point-min))
	(while (search-forward "\b_" nil t) (backward-delete-char 2))
	(goto-char (point-min))
	(while (re-search-forward "\\(.\\)\\(\b\\1\\)+" nil t)
	  (replace-match "\\1"))
	(goto-char (point-min))
	(while (re-search-forward "\e\\[[0-9]+m" nil t) (replace-match ""))
	(goto-char (point-min))
	(while (re-search-forward "o\b\\+\\|\\+\bo" nil t) (replace-match "o"))
	))
  (goto-char (point-min))
  (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t) (replace-match "+"))
1380
  ;; When the header is longer than the manpage name, groff tries to
Paul Eggert's avatar
Paul Eggert committed
1381
  ;; condense it to a shorter line interspersed with ^H.  Remove ^H with
1382
  ;; their preceding chars (but don't put Man-overstrike).  (Bug#5566)
1383 1384
  (goto-char (point-min))
  (while (re-search-forward ".\b" nil t) (backward-delete-char 2))
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
  (Man-softhyphen-to-minus))

(defun Man-bgproc-filter (process string)
  "Manpage background process filter.
When manpage command is run asynchronously, PROCESS is the process
object for the manpage command; when manpage command is run
synchronously, PROCESS is the name of the buffer where the manpage
command is run.  Second argument STRING is the entire string of output."
  (save-excursion
    (let ((Man-buffer (process-buffer process)))
      (if (null (buffer-name Man-buffer)) ;; deleted buffer
	  (set-process-buffer process nil)

	(with-current-buffer Man-buffer
	  (let ((inhibit-read-only t)
	        (beg (marker-position (process-mark process))))
	    (save-excursion
	      (goto-char beg)
	      (insert string)
	      (save-restriction
		(narrow-to-region
		 (save-excursion
		   (goto-char beg)
1408 1409 1410
                   ;; Process whole sections (Bug#36927).
                   (Man-previous-section 1)
                   (point))
1411 1412 1413 1414 1415
		 (point))
		(if Man-fontify-manpage-flag
		    (Man-fontify-manpage)
		  (Man-cleanup-manpage)))
	      (set-marker (process-mark process) (point-max)))))))))
1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426

(defun Man-bgproc-sentinel (process msg)
  "Manpage background process sentinel.
When manpage command is run asynchronously, PROCESS is the process
object for the manpage command; when manpage command is run
synchronously, PROCESS is the name of the buffer where the manpage
command is run.  Second argument MSG is the exit message of the
manpage command."
  (let ((Man-buffer (if (stringp process) (get-buffer process)
		      (process-buffer process)))
	(delete-buff nil)
1427
	message)
1428 1429 1430 1431 1432

    (if (null (buffer-name Man-buffer)) ;; deleted buffer
	(or (stringp process)
	    (set-process-buffer process nil))

1433
      (with-current-buffer Man-buffer
1434
	(save-excursion
1435 1436
	  (let ((case-fold-search nil)
                (inhibit-read-only t))
1437 1438 1439
	    (goto-char (point-min))
	    (cond ((or (looking-at "No \\(manual \\)*entry for")
		       (looking-at "[^\n]*: nothing appropriate$"))
1440 1441 1442
		   (setq message (buffer-substring (point)
						   (progn
						     (end-of-line) (point)))
Juri Linkov's avatar