mirrored from git://git.sv.gnu.org/emacs.git
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
man.el
2110 lines (1907 loc) · 80.5 KB
/
man.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
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
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; man.el --- browse UNIX manual pages -*- lexical-binding: t -*-
;; Copyright (C) 1993-1994, 1996-1997, 2001-2024 Free Software
;; Foundation, Inc.
;; Author: Barry A. Warsaw <bwarsaw@cen.com>
;; Maintainer: emacs-devel@gnu.org
;; Keywords: help
;; Adapted-By: ESR, pot
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; 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
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; 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
;; man.el from the standard Emacs 18.57 distribution. I liked many of
;; 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.
;; Francesco Potortì <pot@cnuce.cnr.it> cleaned it up thoroughly,
;; 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
;; is done in the background. The cleaning commands are configurable.
;; + 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.
;; - The awk script deletes multiple blank lines. This behavior does
;; not allow one to understand if there was indeed a blank line at the
;; 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
;; the number of blank lines before the page footer by heuristics
;; 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:
(require 'ansi-color)
(require 'cl-lib)
(defgroup man nil
"Browse UNIX manual pages."
:prefix "Man-"
:group 'external
:group 'help)
(defcustom Man-prefer-synchronous-call nil
"Whether to call the Un*x \"man\" program synchronously.
When this is non-nil, call the \"man\" program synchronously
(rather than asynchronously, which is the default behavior)."
:type 'boolean
:group 'man
:version "30.1")
(defcustom Man-support-remote-systems nil
"Whether to call the Un*x \"man\" program on remote systems.
When this is non-nil, call the \"man\" program on the remote
system determined by `default-directory'."
:type 'boolean
:version "30.1")
(defcustom Man-filter-list nil
"Manpage cleaning filter command phrases.
This variable contains a list of the following form:
((command-string phrase-string*)*)
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
"Non-nil means make up the manpage with fonts."
:type 'boolean
:group 'man)
(defface Man-overstrike
'((t (:inherit bold)))
"Face to use when fontifying overstrike."
:group 'man
:version "24.3")
(defface Man-underline
'((t (:inherit underline)))
"Face to use when fontifying underlining."
:group 'man
:version "24.3")
(defface Man-reverse
'((t (:inherit highlight)))
"Face to use when fontifying reverse video."
:group 'man
:version "24.3")
(defvar Man-ansi-color-basic-faces-vector
[nil Man-overstrike nil Man-underline Man-underline nil nil Man-reverse]
"The value used here for `ansi-color-basic-faces-vector'.")
(defvar Man-ansi-color-map
(with-no-warnings
(let ((ansi-color-faces-vector
[ default Man-overstrike default Man-underline
Man-underline default default Man-reverse ]))
(ansi-color-make-color-map)))
"The value formerly used here for `ansi-color-map'.
This variable is obsolete. To customize the faces used by ansi-color,
set `Man-ansi-color-basic-faces-vector'.")
(make-obsolete-variable 'Man-ansi-color-map
'Man-ansi-color-basic-faces-vector "28.1")
(defcustom Man-notify-method 'friendly
"Selects the behavior when manpage is ready.
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)
thrifty -- reuse an existing manpage window if possible (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 thrifty)
(const polite) (const quiet) (const meek))
:group 'man)
(defcustom Man-width nil
"Number of columns for which manual pages should be formatted.
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."
:type '(choice (const :tag "Window width" nil)
(const :tag "Frame width" t)
(integer :tag "Fixed width" :value 65))
:group 'man)
(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)
(defcustom Man-frame-parameters nil
"Frame parameter list for creating a new frame for a manual page."
:type '(repeat (cons :format "%v"
(symbol :tag "Parameter")
(sexp :tag "Value")))
:group 'man)
(defcustom Man-downcase-section-letters-flag t
"Non-nil means letters in sections are converted to lower case.
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
"Non-nil means the manpage list is treated as circular for traversal."
: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" . ""))
"Association list of bogus sections to real section numbers.
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)
;; FIXME see comments at ffap-c-path.
(defcustom Man-header-file-path
(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")))))
"C Header file search path used in Man."
:version "24.1" ; add multiarch
:type '(repeat string)
:group 'man)
(defcustom Man-name-local-regexp (concat "^" (regexp-opt '("NOM" "NAME")) "$")
"Regexp that matches the text that precedes the command's name.
Used in `bookmark-set' to get the default bookmark name."
:version "24.1"
:type 'regexp :group 'bookmark)
(defcustom manual-program "man"
"Program used by `man' to produce man pages."
:type 'string
:group 'man)
(defcustom Man-untabify-command "pr"
"Program used by `man' for untabifying."
:type 'string
:group 'man)
(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)
(defcustom Man-sed-command "sed"
"Program used by `man' to process sed scripts."
:type 'string
:group 'man)
(defcustom Man-awk-command "awk"
"Program used by `man' to process awk scripts."
:type 'string
:group 'man)
;; 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")
(defcustom Man-mode-hook nil
"Hook run when Man mode is enabled."
:type 'hook
:group 'man)
(defcustom Man-cooked-hook nil
"Hook run after removing backspaces but before `Man-mode' processing."
:type 'hook
:group 'man)
(defvar Man-name-regexp "[-[:alnum:]_+[@][-[:alnum:]_.:+]*"
"Regular expression describing the name of a manpage (without section).")
(defvar Man-section-regexp "[0-9][a-zA-Z0-9+]*\\|[LNln]"
"Regular expression describing a manpage section within parentheses.")
(defvar Man-page-header-regexp
(if (string-match "-solaris2\\." system-configuration)
(concat "^[-[:alnum:]_].*[ \t]\\(" Man-name-regexp
"(\\(" Man-section-regexp "\\))\\)$")
(concat "^[ \t]*\\(" Man-name-regexp
"(\\(" Man-section-regexp "\\))\\).*\\1"))
"Regular expression describing the heading of a page.")
(defvar Man-heading-regexp "^\\([[:upper:]][[:upper:]0-9 /-]+\\)$"
"Regular expression describing a manpage heading entry.")
(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\\)"
"Regular expression for SEE ALSO heading (or your equivalent).
This regexp should not start with a `^' character.")
;; 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 for.*$"
"Regular expression describing first heading on a manpage.
This regular expression should start with a `^' character.")
(defvar Man-reference-regexp
(concat "\\(" Man-name-regexp
"\\(\\([-‐]\n\\)?[ \t]+" Man-name-regexp "\\)*\\)[ \t]*(\\("
Man-section-regexp "\\))")
"Regular expression describing a reference to another manpage.")
(defvar Man-apropos-regexp
(concat "\\[\\(" Man-name-regexp "\\)\\][ \t]*(\\(" Man-section-regexp "\\))")
"Regular expression describing a reference to manpages in \"man -k output\".")
(defvar Man-synopsis-regexp "SYNOPSIS"
"Regular expression for SYNOPSIS heading (or your equivalent).
This regexp should not start with a `^' character.")
(defvar Man-files-regexp "FILES\\>"
;; Add \> so as not to match mount(8)'s FILESYSTEM INDEPENDENT MOUNT OPTIONS.
"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).")
(defvar Man-file-name-regexp "[^<>\", \t\n]+"
"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.")
;; This includes the section as an optional part to catch hyphenated
;; references to manpages.
(defvar Man-hyphenated-reference-regexp
(concat "\\(" Man-name-regexp "\\)\\((\\(" Man-section-regexp "\\))\\)?")
"Regular expression describing a reference in the SEE ALSO section.")
(defcustom Man-switches ""
"Switches passed to the man command, as a single string.
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)
(defvar Man-specified-section-option
(if (string-match "-solaris[0-9.]*$" system-configuration)
"-s"
"")
"Option that indicates a specified a manual section name.")
(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.")
(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)
;; other variables and keymap initializations
(defvar-local Man-original-frame nil)
(defvar-local Man-arguments nil)
(put 'Man-arguments 'permanent-local t)
(defvar-local Man--sections nil)
(defvar-local Man--refpages nil)
(defvar-local Man-page-list nil)
(defvar-local Man-current-page 0)
(defvar-local Man-page-mode-string "1 of 1")
(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.")
(defvar Man-topic-history nil "Topic read history.")
(defvar Man-mode-syntax-table
(let ((table (copy-syntax-table (standard-syntax-table))))
(modify-syntax-entry ?. "w" table)
(modify-syntax-entry ?_ "w" table)
(modify-syntax-entry ?: "w" table) ; for PDL::Primitive in Perl man pages
table)
"Syntax table used in Man mode buffers.")
(defvar-keymap Man-mode-map
:doc "Keymap for Man mode."
:suppress t
:parent (make-composed-keymap button-buffer-map special-mode-map)
"n" #'Man-next-section
"p" #'Man-previous-section
"M-n" #'Man-next-manpage
"M-p" #'Man-previous-manpage
"." #'beginning-of-buffer
"r" #'Man-follow-manual-reference
"g" #'Man-goto-section
"s" #'Man-goto-see-also-section
"k" #'Man-kill
"u" #'Man-update-manpage
"m" #'man
;; Not all the man references get buttons currently. The text in the
;; manual page can contain references to other man pages
"RET" #'man-follow
: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]
["Quit" quit-window t]))
;; buttons
(define-button-type 'Man-abstract-xref-man-page
'follow-link t
'help-echo "mouse-2, RET: display this man page"
'func nil
'action #'Man-xref-button-action)
(defun Man-xref-button-action (button)
(let ((target (button-get button 'Man-target-string)))
(funcall
(button-get button 'func)
(cond ((null target)
(button-label button))
((functionp target)
(funcall target (button-start button)))
(t target)))))
(define-button-type 'Man-xref-man-page
:supertype 'Man-abstract-xref-man-page
'func 'man-follow)
(define-button-type 'Man-xref-header-file
'action (lambda (button)
(let ((w (button-get button 'Man-target-string)))
(unless (Man-view-header-file w)
(error "Cannot find header file: %s" w))))
'follow-link t
'help-echo "mouse-2: display this header file")
(define-button-type 'Man-xref-normal-file
'action (lambda (button)
(let ((f (concat (file-remote-p default-directory)
(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))))
'follow-link t
'help-echo "mouse-2: display this file")
;; ======================================================================
;; utilities
(defun Man-default-directory ()
"Return a default directory according to `Man-support-remote-systems'."
;; Ensure that `default-directory' exists and is readable.
;; We assume, that this function is always called inside the `man'
;; command, so that we can check `current-prefix-arg' for reverting
;; `Man-support-remote-systems'.
(let ((result default-directory)
(remote (if current-prefix-arg
(not Man-support-remote-systems)
Man-support-remote-systems)))
;; Use a local directory if remote isn't possible.
(when (and (file-remote-p default-directory)
(not (and remote
;; TODO:: Test that remote processes are supported.
)))
(setq result (expand-file-name "~/")))
;; Check, whether the directory is accessible.
(if (file-accessible-directory-p result)
result
(expand-file-name (concat (file-remote-p result) "~/")))))
(defun Man-shell-file-name ()
"Return a proper shell file name, respecting remote directories."
(or ; This works also in the local case.
(connection-local-value shell-file-name)
"/bin/sh"))
(defun Man-header-file-path ()
"Return the C header file search path that Man should use.
Normally, this is the value of the user option `Man-header-file-path',
but when the man page is formatted on a remote system (see
`Man-support-remote-systems'), this function tries to figure out the
list of directories where the remote system has the C header files."
(let ((remote-id (file-remote-p default-directory)))
(if (null remote-id)
;; The local case.
Man-header-file-path
;; The remote case. Use connection-local variables.
(mapcar
(lambda (elt) (concat remote-id elt))
(with-connection-local-variables
(or (and (local-variable-p 'Man-header-file-path (current-buffer))
Man-header-file-path)
(setq-connection-local
Man-header-file-path
(let ((arch (with-temp-buffer
(when (zerop (ignore-errors
(process-file "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"))))))))))))
(defun Man-init-defvars ()
"Used for initializing variables based on display's color support.
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)
((eq 0 (call-process Man-sed-command nil nil nil Man-sysv-sed-script))
Man-sysv-sed-script)
((eq 0 (call-process Man-sed-command nil nil nil Man-berkeley-sed-script))
Man-berkeley-sed-script)
(t
nil))))
(setq Man-filter-list
;; Avoid trailing nil which confuses customize.
(apply 'list
(cons
Man-sed-command
(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 "'")
"")
;; Use octal numbers. Otherwise, \032 (Ctrl-Z) would
;; suspend remote connections.
"-e '/^[\\o001-\\o032][\\o001-\\o032]*$/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"
"'"
)))
(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
(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.
((not (fboundp 'make-process)) " %s")
((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)))))))
(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 " ")))
(setq flist (cdr flist))))
command))
(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))
(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
translate the section (see the `Man-downcase-section-letters-flag'
and the `Man-section-translations-alist' variables)."
(let ((name "")
(section "")
(slist Man-section-translations-alist))
(setq ref (Man-translate-cleanup ref))
(cond
;; "chmod(2V)" case ?
((string-match (concat "^" Man-reference-regexp "$") ref)
(setq name (replace-regexp-in-string "[\n\t ]" "" (match-string 1 ref))
section (match-string 4 ref)))
;; "2v chmod" case ?
((string-match (concat "^\\(" Man-section-regexp
"\\) +\\(" Man-name-regexp "\\)$") ref)
(setq name (match-string 2 ref)
section (match-string 1 ref))))
(if (string= name "")
;; see Bug#66390
(mapconcat 'identity
(mapcar #'shell-quote-argument
(split-string ref "\\s-+"))
" ") ; 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))))
(defun Man-support-local-filenames ()
"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)
(with-connection-local-variables
(or (and (local-variable-p 'Man-support-local-filenames (current-buffer))
Man-support-local-filenames)
(setq-connection-local
Man-support-local-filenames
(with-temp-buffer
(let ((default-directory (Man-default-directory)))
(ignore-errors
(process-file 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))
;; ======================================================================
;; default man entry: get word near point
(defun Man-default-man-entry (&optional pos)
"Guess default manual entry based on the text near position POS.
POS defaults to `point'."
(let (word start column distance)
(save-excursion
(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.
(setq start (point))
;; Otherwise look at char before POS.
(goto-char pos)
(if (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:")))
;; 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")
;; Record the distance traveled.
(setq distance (- column (current-column)))
(when (looking-back
(concat "([ \t]*\\(?:" Man-section-regexp "\\)[ \t]*)")
(line-beginning-position))
;; 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.
(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)
;; Note: This code gets executed iff our entry is after POS.
(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-search "-" (substring 1st-part 0 -1))
(setq word (string-replace "-" "" word))))
;; Make sure the section number gets included by the code below.
(goto-char (match-end 1)))
(when (string-match "[-._‐]+$" word)
(setq word (substring word 0 (match-beginning 0))))
;; 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)))))))
;; ======================================================================
;; Top level command and background process sentinel
;; This alias was originally for compatibility with older versions.
;; Some users got used to having it, so we will not remove it.
;;;###autoload
(defalias 'manual-entry 'man)
(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).")
(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
foo(sec)[, bar(sec) [, ...]] [other stuff] - description"
(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)))
(defun Man-completion-table (string pred action)
(cond
;; 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)))
((equal string "-k")
;; Let SPC (minibuffer-complete-word) insert the space.
(complete-with-action action '("-k ") string pred))
(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))))
(unless (and Man-completion-cache
(string-prefix-p (car Man-completion-cache) prefix))
(with-temp-buffer
;; In case inherited doesn't exist.
(setq default-directory (Man-default-directory))
;; Actually for my `man' the arg is a regexp.
;; POSIX says it must be ERE and "man-db" seems to agree,
;; whereas under macOS it seems to be BRE-style and doesn't
;; accept backslashes at all. Let's not bother to