From mboxrd@z Thu Jan  1 00:00:00 1970
X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org
X-Spam-Level: 
X-Spam-Status: No, score=-1.1 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI autolearn=ham
	autolearn_force=no version=3.4.4
Received: (qmail 12579 invoked from network); 9 Sep 2020 04:11:30 -0000
Received: from alyss.skarnet.org (95.142.172.232)
  by inbox.vuxu.org with ESMTPUTF8; 9 Sep 2020 04:11:30 -0000
Received: (qmail 11362 invoked by uid 89); 9 Sep 2020 04:11:47 -0000
Mailing-List: contact supervision-help@list.skarnet.org; run by ezmlm
Sender: <supervision@list.skarnet.org>
Precedence: bulk
List-Post: <mailto:supervision@list.skarnet.org>
List-Help: <mailto:supervision-help@list.skarnet.org>
List-Unsubscribe: <mailto:supervision-unsubscribe@list.skarnet.org>
List-Subscribe: <mailto:supervision-subscribe@list.skarnet.org>
List-Id: <supervision.list.skarnet.org>
Received: (qmail 11355 invoked from network); 9 Sep 2020 04:11:47 -0000
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
        d=gmail.com; s=20161025;
        h=user-agent:from:to:subject:date:message-id:mime-version;
        bh=53OCzrcGDP6Rv/zAN0mh31kO2zC+AB57rB4b972Zzj4=;
        b=TQThNhFnBn10qztoLwBhLljSD9kUuyo/4SVN3nAspZETEX4Y+zMy5KAJZ0Hcx5Zxt0
         w38XUvRZPjWgd5kh3CTBlmJQS3xfRH02D4Hx/UBCd9GI5/BvQHnDCpomGSYSH5F0xmwz
         tBzRlzwh9U0glOUEaS74IP1gq7OEJe/feHtlWi3K0ZpsRUD5vOehCbEPKJFnmlrndlv0
         4wZYmjFPQofauGxDkDYVI6c6SPaYI8gBqSAogLWxOIH8/xnzKxX4qwdMry6KnZh362aK
         ZlsS/un6fbVOAxOnfC6RlkHQXv0+X9E9XNF6Kgy78KdbUCs8dnbXGaWWGtu7QNxWBmga
         dxqw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
        d=1e100.net; s=20161025;
        h=x-gm-message-state:user-agent:from:to:subject:date:message-id
         :mime-version;
        bh=53OCzrcGDP6Rv/zAN0mh31kO2zC+AB57rB4b972Zzj4=;
        b=VJfcY+NarX5ah6YAMZ6wGt3PfYm5mGfDML1QTo9LEIuI4eJBG0DD6vQvAHoCy32LEC
         J9pP+uKOGIfT3ch8bNvxe71l/EUW40LmLFxsfb2ctDhe4oObcS/CRXyXrMPN5eELmdhD
         q9XLIRq6T96lDJK/ROBiGOuDX91WPyQqOjmMNmXGwJNy+t5YTV5fx+0T5+GXm5s+lSdW
         yv1OrjenmxSEzJTHGRJptdKojEhj+3Q1foNR3ZEakOU0MfutqTBAZcJCWRsFoiChGfOX
         F6w5gxLa6LoDzzWGmslJrEaFYD05T1FdjUGz68/ge/rbJZQveaRLrB1IBl/ejq7xsojC
         q1IQ==
X-Gm-Message-State: AOAM532MW9x5mIb1dlbFPlDT91b5XgEQzsED35WhQRgmn9QV0n+GVO4N
	PPJesG7xhsKh7x/hNAIgexc1CvkqqXs=
X-Google-Smtp-Source: ABdhPJyDieQSGryArC8nUg6yiU6V4Y2XfEYdhnKHduGhBsxW6aD1hzBPK4MYsS7T0DR8twQzce9ciQ==
X-Received: by 2002:a17:902:aa0a:b029:d0:89f4:6224 with SMTP id be10-20020a170902aa0ab02900d089f46224mr2311087plb.12.1599624678704;
        Tue, 08 Sep 2020 21:11:18 -0700 (PDT)
User-agent: mu4e 1.4.13; emacs 27.1
From: Alexis <flexibeast@gmail.com>
To: supervision@list.skarnet.org
Subject: s6-man-pages update
Date: Wed, 09 Sep 2020 14:11:14 +1000
Message-ID: <875z8nd1y5.fsf@ada>
MIME-Version: 1.0
Content-Type: text/plain; format=flowed


Hi again all,

i've now completed the linting pass for the s6 man pages. The few 
remaining lint issues are either commented in the sources, or 
aren't actually an issue in this context.

As per Laurent's request, i've also added a Makefile to facilitate 
installation; details in the repo README:

    https://github.com/flexibeast/s6-man-pages/

The main thing still left to do is work out how to deal with 
certain types of links.

Laurent, you wrote:

> I think  that solely depends on  the number of such  links. If 
> there
> are just a few,  it's fine. If there are a lot of  links in a 
> page, it
> would make  reading pretty unwieldy. Because  I think there are 
> a few
> pages with too many links, maybe it would be best, for 
> consistency, to
> just use footnotes?
>
> < a CDB file[1] cdbfile then exits 0.
> <
> < (...)
> <
> < SEE ALSO
> <
> < [1]: http://en.wikipedia.org/wiki/Cdb_(software)
>
> Maybe mdoc even has a mechanism for footnotes? I don't know.

As far as i'm aware, mdoc has no built-in mechanism for footnotes 
(certainly the word isn't used in the mdoc(7) man page).

Most of the links in the man pages are cross-references to other 
pages in the s6-man-pages collection, so they're already handled 
by the Xr macro. The remaining links aren't particularly numerous, 
and can basically be divided into two groups:

* links to other skarnet.org documentation which does not yet have 
  man pages: s6-networking (s6-tcpserver-access, s6-tcpserver, 
  s6-tcpserver4, s6-tcpserver6), execline (execline and execlineb, 
  maybe others as well?), and skalibs stuff. For an example of a 
  page referring to s6-networking software, 
  cf. s6-connlimit.1.in. If that documentation was available as 
  man pages, these could just be made cross-references too. 

* links to non-skarnet.org sites, such as djb's site. These 
  certainly seem amenable to use of the footnoting style you 
  described above.


Alexis.