Date: Sun, 24 Jun 2001 10:52:57 +0300 (IDT)
From: Eli Zaretskii <eliz AT is DOT elta DOT co DOT il>
X-Sender: eliz AT is
To: "Mark E." <snowball3 AT bigfoot DOT com>
cc: djgpp-workers AT delorie DOT com
Subject: Re: getconf docs
In-Reply-To: <3B34C6D9.5598.1E8692@localhost>
Message-ID: <Pine.SUN.3.91.1010624104907.13700G-100000@is>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
Reply-To: djgpp-workers AT delorie DOT com
Errors-To: nobody AT delorie DOT com
X-Mailing-List: djgpp-workers AT delorie DOT com
X-Unsubscribes-To: listserv AT delorie DOT com
Precedence: bulk


On Sat, 23 Jun 2001, Mark E. wrote:

> My attempt at documentation of getconf follows:

This is fine; thanks.  I have only a couple of minor comment:

> + Return values for configuration variables from the compilation environment
> + specified by @var{specification}.  Use @code{getconf} @code{-h} to list all
> + supported compilation environments.

When you say "Use @code{getconf} @code{-h} to list...", you mean that the 
user should type that at the shell prompt.  Whenever user input is 
concerned, that input needs to be in @samp in its entirety, like this:

  Use @samp{getconf -h} to list...

> + Write to standard error all recognized compilation environments and 
> + configuration variables.  Those configuration variables requiring a
> + path argument are listed with [path] after their names.

The last line should say

  @var{path} argument are listed with @code{[@var{path}]} after their names.