A few more about page tweaks

This commit is contained in:
Yorhel 2021-12-15 09:52:07 +01:00
parent 2d1dca24e5
commit 5194ed95cf

View file

@ -349,12 +349,13 @@ TUWF::get '/info/about' => sub {
<p> <p>
The state of online indices of manual pages used to be a sad one. Existing The state of online indices of manual pages used to be a sad one. Existing
sites used to only offer you a single version of a man page: From one sites used to only offer you a single version of a man page: From one
origin, and often only in a single language. Most didn't even tell you where origin, and often only in a single language. Most didn't even tell you
the manual actually originated from, making it very hard to determine where the manual actually originated from, making it very hard to
whether the manual you found actually applied to your situation and even determine whether the manual you found applied to your situation and even
harder to find a manual for a specific system. Additionally, some sites harder to find a manual for a specific system. Additionally, some sites
rendered the manuals in an unreadable way, didn't correctly handle special rendered the manuals in an unreadable way, didn't correctly handle special
formatting - like tables - or didn't correctly display non-ASCII characters. formatting - like tables - or didn't correctly display non-ASCII
characters.
</p><p> </p><p>
Nowadays there are many good alternatives, but Manned.org was one of the Nowadays there are many good alternatives, but Manned.org was one of the
sites created in order to improve that situation. This site aims to index sites created in order to improve that situation. This site aims to index
@ -382,9 +383,11 @@ TUWF::get '/info/about' => sub {
<dt><code>/&lt;name>[.&lt;section>]</code></dt><dd> <dt><code>/&lt;name>[.&lt;section>]</code></dt><dd>
Will try to get the latest and most-close-to-upstream version of a man Will try to get the latest and most-close-to-upstream version of a man
page (e.g. <a href="/socket">/socket</a> or <a page (e.g. <a href="/socket">/socket</a> or <a
href="/socket.7">/socket.7</a>). Note that this may fetch the man page href="/socket.7">/socket.7</a>). Note that this will fetch the man page
from any available system, so may result in confusing scenarios for from any of the available systems, so may result in confusing scenarios
system-specific documentation.</dd> for system-specific documentation. I try to at least keep the selection
algorithm stable and deterministic, but can't provide any
guarantees.</dd>
<dt><code>/man/&lt;system>/&lt;name>[.&lt;section>]</code></dt><dd> <dt><code>/man/&lt;system>/&lt;name>[.&lt;section>]</code></dt><dd>
Will get the latest version of a man page from the given system (e.g. <a Will get the latest version of a man page from the given system (e.g. <a
href="/man/ubuntu-xenial/rsync">/man/ubuntu-xenial/rsync</a>)</dd> href="/man/ubuntu-xenial/rsync">/man/ubuntu-xenial/rsync</a>)</dd>
@ -497,15 +500,16 @@ TUWF::get '/info/about' => sub {
Weekly dumps of the full database are available for download at Weekly dumps of the full database are available for download at
<a href="http://dl.manned.org/dumps/">http://dl.manned.org/dumps/</a>. <a href="http://dl.manned.org/dumps/">http://dl.manned.org/dumps/</a>.
<br /><br /> <br /><br />
Be warned that the download server may not be terribly reliable, so it is Be warned that the download server may not be terribly fast or reliable,
advisable to use a client that supports resumption of partial downloads. See so it is advisable to use a client that supports resumption of partial
<a href="/wget">wget's -c</a> or <a href="/curl">curl's -C</a>. downloads. See <a href="/wget">wget's -c</a> or
<a href="/curl">curl's -C</a>.
<br /><br /> <br /><br />
The database schema is "documented" at <a The database schema is "documented" at <a
href="https://code.blicky.net/yorhel/manned/src/branch/master/sql/schema.sql">schema.sql</a> href="https://code.blicky.net/yorhel/manned/src/branch/master/sql/schema.sql">schema.sql</a>
in the git repo. Note that these dumps don't constitute a stable API and, in the git repo. Note that these dumps don't constitute a stable API and,
while this won't happen frequently, incompatible schema changes or Postgres while this won't happen frequently, incompatible schema changes or Postgres
major version bumps may occur. major version bumps will occassionally occur.
</p> </p>
<h2 id="other-systems">Other systems</h2> <h2 id="other-systems">Other systems</h2>
@ -529,6 +533,7 @@ TUWF::get '/info/about' => sub {
This site isn't nearly as awesome yet as it could be. Here's some ideas that This site isn't nearly as awesome yet as it could be. Here's some ideas that
would be nice to have in the future: would be nice to have in the future:
<ul> <ul>
<li>Better browsing and discovery features.</li>
<li>Improved, more intelligent, search,</li> <li>Improved, more intelligent, search,</li>
<li><a href="/apropos.1">apropos(1)</a> emulation(?),</li> <li><a href="/apropos.1">apropos(1)</a> emulation(?),</li>
<li>Diffs between various versions of a man page,</li> <li>Diffs between various versions of a man page,</li>