All of
 help / color / mirror / Atom feed
From: Andries Brouwer <>
To: Michael Still <>
Cc: Andries Brouwer <>,
	Alan Cox <>,
	Sam Ravnborg <>,
	Linus Torvalds <>,
	Linux Kernel Mailing List <>,
Subject: Re: [PATCH] docbook: Added support for generating man files
Date: Sat, 19 Jul 2003 09:19:19 +0200	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>; from on Sat, Jul 19, 2003 at 12:47:31PM +1000

On Sat, Jul 19, 2003 at 12:47:31PM +1000, Michael Still wrote:
> On Sat, 19 Jul 2003, Andries Brouwer wrote:
> > Please put all legalities in comments - behind .\" we do not have to read
> > them, but they are there if anyone cares.
> Ok. After having done some more poking, I can't see a way of doing this 
> with docbook2man -- there doesn't appear to be any way of emitting 
> comments. There strike me as two options here: write a script to convert 
> SGML to man pages, or perhaps just insert a single sentence into the 
> "About this Document" section which explains where to look for copyright 
> information.
> Any thoughts?

You do this in two steps: first construct an sgml document, then invoke

So, first you have to figure out what the proper docbook markup is
for such material. According to me it is <docinfo>...</docinfo>,
to be placed inside <refentry> before <refmeta>.
So you do that - example script fragments appended below.

Next, the docbook2man stage. My presently installed docbook2man says

sgml('<DOCINFO>', sub { push_output('nul'); });
sgml('</DOCINFO>', sub { pop_output(); });

That is, it does not produce any output for a docinfo section.
I consider that a bug in docbook2man - it should output nroff comments.
Probably this bug will be fixed sooner or later.
(I'll cc Steve Cheng who is listed as maintainer.)
In the meantime I do not worry too much about this missing copyright.

By the way, you start copying at <legalnotice>, but I consider that
the least interesting part. The fact that these docs were written
by Alan Cox is much more interesting. In other words, it might be
a good idea to enlarge this <docinfo> section a bit.


In split-man:

  elsif($mode == 2){
      $refdata = "$refdata\n<docinfo>\n$front\n$blurb\n</docinfo>\n"
    $refdata = "$refdata$_";

Here $front is the original one - do not delete <legalnotice>.
And $blurb is your text:

    If you have comments on the formatting of this manpage, then please contact
    Michael Still (mikal\

  reply	other threads:[~2003-07-19  7:04 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2003-07-18 20:48 [PATCH] docbook: Added support for generating man files Sam Ravnborg
2003-07-18 21:23 ` Sam Ravnborg
2003-07-18 21:54   ` Alan Cox
2003-07-18 22:36     ` Michael Still
2003-07-18 22:48       ` Andries Brouwer
2003-07-19  2:47         ` Michael Still
2003-07-19  7:19           ` Andries Brouwer [this message]
2003-07-19  7:25             ` Michael Still
2003-07-19  7:40               ` Sam Ravnborg

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:

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

  git send-email \ \ \ \ \ \ \ \ \

* 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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.