From 5194ed95cfbb53428731227c28f49d5ec8e1e0da Mon Sep 17 00:00:00 2001 From: Yorhel Date: Wed, 15 Dec 2021 09:52:07 +0100 Subject: [PATCH] A few more about page tweaks --- www/index.pl | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/www/index.pl b/www/index.pl index 12d1b25..ccc6cf1 100755 --- a/www/index.pl +++ b/www/index.pl @@ -349,12 +349,13 @@ TUWF::get '/info/about' => sub {

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 - origin, and often only in a single language. Most didn't even tell you where - the manual actually originated from, making it very hard to determine - whether the manual you found actually applied to your situation and even + origin, and often only in a single language. Most didn't even tell you + where the manual actually originated from, making it very hard to + determine whether the manual you found applied to your situation and even harder to find a manual for a specific system. Additionally, some sites 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.

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 @@ -382,9 +383,11 @@ TUWF::get '/info/about' => sub {

/<name>[.<section>]
Will try to get the latest and most-close-to-upstream version of a man page (e.g. /socket or /socket.7). Note that this may fetch the man page - from any available system, so may result in confusing scenarios for - system-specific documentation.
+ href="/socket.7">/socket.7). Note that this will fetch the man page + from any of the available systems, so may result in confusing scenarios + for system-specific documentation. I try to at least keep the selection + algorithm stable and deterministic, but can't provide any + guarantees.
/man/<system>/<name>[.<section>]
Will get the latest version of a man page from the given system (e.g. /man/ubuntu-xenial/rsync)
@@ -497,15 +500,16 @@ TUWF::get '/info/about' => sub { Weekly dumps of the full database are available for download at http://dl.manned.org/dumps/.

- Be warned that the download server may not be terribly reliable, so it is - advisable to use a client that supports resumption of partial downloads. See - wget's -c or curl's -C. + Be warned that the download server may not be terribly fast or reliable, + so it is advisable to use a client that supports resumption of partial + downloads. See wget's -c or + curl's -C.

The database schema is "documented" at schema.sql 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 - major version bumps may occur. + major version bumps will occassionally occur.

Other systems

@@ -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 would be nice to have in the future: