bug#5568: Man-follow-manual-reference vs. perl man pages

bug#5568: Man-follow-manual-reference vs. perl man pages

[jidanni]

Many man pages have SEE ALSOs like

  SEE ALSO
         XML::Parser::Lite.
  perl v5.10.0 2009-08-23 XML::Parser::Lite::Tree(3pm)

However Man-follow-manual-reference can't figure out that kind of SEE
ALSO item.

bug#5568: Man-follow-manual-reference vs. perl man pages

[Juri Linkov]

> Many man pages have SEE ALSOs like
>
>   SEE ALSO
>          XML::Parser::Lite.
>   perl v5.10.0 2009-08-23 XML::Parser::Lite::Tree(3pm)
>
> However Man-follow-manual-reference can't figure out that kind of
> SEE ALSO item.

The references in this SEE ALSO section are in a non-standard format.
A reference should be a word followed by the section name in parentheses.
So these man pages should write references in the format
"XML::Parser::Lite(3pm)".

Of course, you can get what you want with the following patch:

=== modified file 'lisp/man.el'
--- lisp/man.el	2010-02-11 20:57:10 +0000
+++ lisp/man.el	2010-02-12 19:18:50 +0000
@@ -1135,7 +1135,7 @@ (defun Man-highlight-references (&option
 	(Man-highlight-references0 nil Man-apropos-regexp 1
 				   'Man-default-man-entry
 				   (or xref-man-type 'Man-xref-man-page)))
-    (Man-highlight-references0 Man-see-also-regexp Man-reference-regexp 1
+    (Man-highlight-references0 Man-see-also-regexp Man-hyphenated-reference-regexp 1
 			       'Man-default-man-entry
 			       (or xref-man-type 'Man-xref-man-page))
     (Man-highlight-references0 Man-synopsis-regexp Man-header-regexp 0 2

But it will also highlight every word in those SEE ALSO sections
that have lengthy text in several paragraphs.  Look for example
`M-x man XML::Twig RET' - there are 60 lines in the SEE ALSO section
where all words will be highlighted as a reference!

-- 
Juri Linkov
http://www.jurta.org/emacs/

bug#5568: Man-follow-manual-reference vs. perl man pages

[jidanni]

JL> Of course, you can get what you want with the following patch
Well I sure hope you commit it.

bug#5568: Man-follow-manual-reference vs. perl man pages

[Juri Linkov]

[-- Attachment #1: Type: text/plain, Size: 405 bytes --]

> JL> Of course, you can get what you want with the following patch
>
> Well I sure hope you commit it.

Sorry, no.  Please see on the screenshot below for `M-x man XML::Twig RET',
how every word becomes a reference when we try to ignore the requirement
of presence of a manpage section within parentheses.

BTW, I think we should handle HTTP links because they have a definite regexp
that we can match.


[-- Attachment #2: man-see-also.png --]
[-- Type: image/png, Size: 2488 bytes --]

[-- Attachment #3: Type: text/plain, Size: 45 bytes --]


-- 
Juri Linkov
http://www.jurta.org/emacs/

bug#5568: Man-follow-manual-reference vs. perl man pages

[jidanni]

JL> BTW, I think we should handle HTTP links because they have a definite regexp
JL> that we can match.
Hmm, maybe anything with :: in them too. However I suppose those perl guys
can't be bothered to put the
$ man encode|sed 's/ .*//;q'
Encode(3perl)
or some other hint there in the SEE ALSOs. I would remind them but I'm
banned for life from mailing *@perl.org because of my crabby personality
or something.