emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

man pages references (Re: [PATCH] ox-ascii.el: Consistently add brackets


From: Max Nikulin
Subject: man pages references (Re: [PATCH] ox-ascii.el: Consistently add brackets around links)
Date: Thu, 26 Oct 2023 23:46:44 +0700
User-agent: Mozilla Thunderbird

On 25/10/2023 17:34, Ihor Radchenko wrote:
Max Nikulin writes:

Should be [man] (<http://man.he.net/?topic=man&section=all>)

Side note: it should be either just "man(1)" or "man(8)" without any URL
for plain text export, but it is another story.

I would not say "should". May? Yes. URL also makes sense in some
scenarios (when the intended reader is not on Linux).

URL makes sense when it is particular version or a page generated without intermediate roff format, but this case it is https:, not man: link. Compare (sorry, man.he.net is terribly obsolete)
http://storaged.org/doc/udisks2-api/latest/udisks.8.html#id-1.2.4.7
that has more links than the page generated from man page (debiman still recognizes much more cross-references than emacs man buffers)
https://manpages.debian.org/bookworm/udisks2/udisks.8.en.html#DEVICE_INFORMATION

"man(1)" references were used in paper documents when internet was not always available. In books references may be emphasized by italics or fixed width font.

I like formatting similar to "systemd-resolved(8) § /ETC/RESOLV.CONF"
https://wiki.archlinux.org/title/Systemd-resolved
It makes clear that links point to man pages and precise enough since specific sections are provided.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]