memory-leaks

commit 5582ef6b2c5ef716f000586412198fdcfea19f97
parent 4a51236046112787ce446898e58df69aaadd7853
Author: Kévin Le Gouguec <kevin.legouguec@gmail.com>
Date:   Wed, 31 Dec 2025 17:39:39 +0100

Keep getting distracted

Diffstat:
A
guides/documentation/online.org
 | 
51
+++++++++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 51 insertions(+), 0 deletions(-)
diff --git a/guides/documentation/online.org b/guides/documentation/online.org
@@ -0,0 +1,51 @@
+I spend an inordinate amount of time making reference manuals
+available as local files, to avoid having to reach for the web.
+Motivations:
+
+- exploration feels faster: completion, search & load can take seconds
+  over HTTP;
+
+- narrowing interfaces down to a handful of tools (info, man, grep)
+  feels smoother, vs contending with every ecosystem's documentation
+  frameworks & styles.
+
+Fuss budget varies depending on the ecosystem.  Recording my
+peregrinations here; named this note =online= for the pun, as
+explained by [[https://en.wikipedia.org/wiki/Man_page#History][Wikipedia]]:
+
+#+begin_quote
+Man pages are often referred to as an /[[https://en.wikipedia.org/wiki/wiki/Online][online]]/ form of software
+documentation,[[https://en.wikipedia.org/wiki/Man_page#cite_note-online-man-1][¹]] even though the =man= command does not require
+internet access because man pages are available at a teletype line
+terminal when it is online.
+#+end_quote
+# SNAFU: that ¹ note should be ^{[[…][[1]​]]}, but pandoc fails to recognize
+#   (a) link descriptions with closing brackets:
+#       $ pandoc -f org <<< '[[http://perdu.com][[DESC]]]'
+#       <p><a href="http://perdu.com">[DESC</a>]</p>
+#   (b) superscripts after punctuation:
+#       $ pandoc -f org <<< 'a,^{[[http://perdu.com][DESC]]}'
+#       <p>a,^{<a href="http://perdu.com">DESC</a>}</p>
+* IETF RFCs
+Debian's doc-rfc metapackage installs documents built from
+<https://www.rfc-editor.org/retrieve/rsync/>.  Each RFC is available
+as a compressed text file, along with some JSON metadata (e.g. status,
+keywords).
+
+So OT1H there is a wealth of information installed locally, OTOH there
+is some inertia to browsing it: no naive grep because of compression;
+no keyword indexation…
+* POSIX
+opengroup.org provides [[https://pubs.opengroup.org/onlinepubs/9799919799/download/index.html][archives]] of the online HTML version.  I am
+intrigued by [[https://pubs.opengroup.org/onlinepubs/9799919799/help/about.html][the mention of "troff sources"]]; cannot seem to find them
+anywhere…
+* Python
+Debian's python3-doc package installs HTML & info versions of Python's
+online manuals.  The info version is well-indexed; however it includes
+some cross-reference artifacts:
+
+- "see the see =Foobar=. section." (emacs)
+- "see the =*note Foobar=: HEX. section." (info)
+* XDG
+<https://gitlab.freedesktop.org/xdg/xdg-specs> contains the DocBook
+sources for each spec.  =docbook= ∈ ~pandoc --list-input-formats~.