From: Max Nikulin <manikulin@gmail.com>
To: emacs-orgmode@gnu.org
Subject: man pages references (Re: [PATCH] ox-ascii.el: Consistently add brackets around links)
Date: Thu, 26 Oct 2023 23:46:44 +0700 [thread overview]
Message-ID: <uhe55o$17kr$1@ciao.gmane.io> (raw)
In-Reply-To: <8734xzdm8g.fsf@localhost>
On 25/10/2023 17:34, Ihor Radchenko wrote:
> Max Nikulin writes:
>
>>> Should be [man] (<http://man.he.net/?topic=man§ion=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.
next prev parent reply other threads:[~2023-10-26 16:48 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-20 17:21 [RFC][PATCH] Allow to export to ascii custom link types as notes Max Nikulin
2023-10-22 9:13 ` Ihor Radchenko
2023-10-22 17:05 ` Max Nikulin
2023-10-23 9:17 ` Ihor Radchenko
2023-10-23 11:00 ` Max Nikulin
2023-10-23 12:09 ` Ihor Radchenko
2023-10-24 8:11 ` Max Nikulin
2023-10-24 10:40 ` Ihor Radchenko
2023-10-24 15:06 ` [PATCH] ox-ascii.el: Consistently add brackets around links (was: Re: [RFC][PATCH] Allow to export to ascii custom link types as notes) Max Nikulin
2023-10-25 10:34 ` Ihor Radchenko
2023-10-26 16:46 ` Max Nikulin [this message]
2023-11-05 12:08 ` man pages references (Re: [PATCH] ox-ascii.el: Consistently add brackets around links) Ihor Radchenko
2023-10-27 14:36 ` [RFC][PATCH] Allow to export to ascii custom link types as notes Max Nikulin
2023-10-25 15:16 ` [RFC][PATCH v2] " Max Nikulin
2023-11-07 9:30 ` Ihor Radchenko
2023-11-07 11:48 ` Max Nikulin
2023-11-07 11:58 ` Ihor Radchenko
2023-11-08 10:23 ` Max Nikulin
2023-11-08 10:45 ` Ihor Radchenko
2023-11-08 10:57 ` Max Nikulin
2023-11-08 11:16 ` Ihor Radchenko
2023-11-09 11:12 ` Max Nikulin
2023-11-11 11:17 ` Ihor Radchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='uhe55o$17kr$1@ciao.gmane.io' \
--to=manikulin@gmail.com \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).