public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Michael Kerrisk <mtk-manpages@gmx.net>
To: lkml <linux-kernel@vger.kernel.org>
Cc: emogenet@google.com
Subject: man-pages-2.52 and man-pages-2.53 are released
Date: Thu, 07 Jun 2007 08:31:49 +0200	[thread overview]
Message-ID: <4667A655.1040909@gmx.net> (raw)

"A foolish consistency is the hobgoblin of little minds, adored by little
statesmen and philosophers and divines"

         Ralph Waldo Emerson (1803-1882)

But damn it, those man pages were a mess!

Perhaps for the first time in their 14-year history, the sections in all of
the pages on man-pages are now in the same order...  The standard order
(with many sections being optional) is now:

            NAME
            SYNOPSIS
            DESCRIPTION
            RETURN VALUE
            ERRORS
            ENVIRONMENT
            FILES
            VERSIONS
            CONFORMING TO
            NOTES
            BUGS
            EXAMPLE
            SEE ALSO

So, I just released man-pages-2.52 and man-pages-2.53.  As well as that
change, there are a very large number of changes to achieve greater
consistency across man pages; full details can be found in the change logs.

In the upcoming man-pages-2.54 release, a new man-pages.7 page will
describe the conventions that should be followed when writing pages for
man-pages.

These releases are now available for download at:

    http://www.kernel.org/pub/linux/docs/manpages
    or ftp://ftp.kernel.org/pub/linux/docs/manpages
    or mirrors: ftp://ftp.XX.kernel.org/pub/linux/docs/manpages

and soon at:

    ftp://ftp.win.tue.nl/pub/linux-local/manpages

Cheers,

Michael

-- 
Michael Kerrisk
maintainer of Linux man pages Sections 2, 3, 4, 5, and 7

Want to help with man page maintenance?  Grab the latest tarball at
http://www.kernel.org/pub/linux/docs/manpages/
read the HOWTOHELP file and grep the source files for 'FIXME'.


                 reply	other threads:[~2007-06-07 13:12 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=4667A655.1040909@gmx.net \
    --to=mtk-manpages@gmx.net \
    --cc=emogenet@google.com \
    --cc=linux-kernel@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