bug-coreutils
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Patch] Adding examples to the man pages


From: Paul Eggert
Subject: Re: [Patch] Adding examples to the man pages
Date: Sun, 20 Mar 2005 00:32:40 -0800
User-agent: Gnus/5.1006 (Gnus v5.10.6) Emacs/21.4 (gnu/linux)

"Dr. David Alan Gilbert" <address@hidden> writes:

> help2man hasn;t done any bold/italicising of the parameters;
> I guess that is OK, but it is not particularly nice and doesn't
> follow the recommendations for man pages.  Is there something
> I'm missing to get help2man to do a nicer job?

Sorry, I don't know; I don't use help2man much.  Looking at the source
code, though, indented example lines beginning with "$ " are set in a
constant-width font.  So perhaps you could format it this way:

Examples:

  $ basename /usr/bin/sort
  sort
  $ basename include/stdio.h .h
  stdio

That's enough examples for basename, I think; you don't need others.

If you want fancier formatting of examples you may need to ask the
author of help2man.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]