public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
To: libc-alpha@sourceware.org, linux-man@vger.kernel.org
Subject: Learning man(7) (was: fork(2), _Fork(), POSIX.1-2024, and AS-safety)
Date: Sat, 17 May 2025 19:01:46 -0500	[thread overview]
Message-ID: <20250518000146.sh7pskbkisveuv4g@illithid> (raw)
In-Reply-To: <j5fti375euce3gnkjsg5fatz2vuzgx3zekxipx3q56fdkmlf4e@ylv2quyckhg2>


[-- Attachment #1.1: Type: text/plain, Size: 1281 bytes --]

[shameless promotion of (in part) my own work follows]

At 2025-05-17T21:16:34+0200, Alejandro Colomar wrote:
> > Next time I will remember to remind you on
> > linux-man@vger.kernel.org. I would offer to do the patch myself, but
> > I don't know roff. :)
> 
> I don't know roff either.  :)
> 
> But man(7) is pretty easy.  I learnt by editing existing text, which
> for a beginner is much easier than writing from scratch.  Just imitate
> what you see in the surroundings.

I've tried hard over the past several years to make man(7) easy to
acquire.  I'm attaching a PDF of the groff_man_style(7) man page
(rendered with the forthcoming groff 1.24), which attempts the
oft-questioned objective of serving as both tutorial and a reference.
I seldom receive feedback on it, which means either that it's flawless
or no one reads it.

I'm also attaching the page source, which on Debian-based systems at
least, should fire up gxditview(1) to view the page from neomutt(1).
(However, changes to the `SY` and `YS` macros in the forthcoming release
mean that a couple of spurious blank lines will appear in two places,
unless your installed groff happens to be from the Git trunk.)

I welcome a critical review of the document's contents.

Regards,
Branden

[-- Attachment #1.2: groff_man_style.7.pdf --]
[-- Type: application/pdf, Size: 158597 bytes --]

[-- Attachment #1.3: groff_man_style.7.man --]
[-- Type: application/x-troff-man, Size: 95744 bytes --]

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2025-05-18  0:01 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-17 10:49 fork(2), _Fork(), POSIX.1-2024, and AS-safety Alejandro Colomar
2025-05-17 18:11 ` Collin Funk
2025-05-17 19:16   ` Alejandro Colomar
2025-05-18  0:01     ` G. Branden Robinson [this message]
2025-05-23 16:22       ` Learning man(7) Zack Weinberg

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250518000146.sh7pskbkisveuv4g@illithid \
    --to=g.branden.robinson@gmail.com \
    --cc=libc-alpha@sourceware.org \
    --cc=linux-man@vger.kernel.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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox