From:	"Mark E." <snowball3 AT bigfoot DOT com>
To:	djgpp-workers AT delorie DOT com
Date:	Sat, 23 Jun 2001 16:42:01 -0400
MIME-Version:	1.0
Subject:	getconf docs
Message-ID:	<3B34C6D9.5598.1E8692@localhost>
X-mailer:	Pegasus Mail for Win32 (v3.12c)
Reply-To:	djgpp-workers AT delorie DOT com

Hello Space Rangers,

My attempt at documentation of getconf follows:

Index: utils.tex
===================================================================
RCS file: /cvs/djgpp/djgpp/src/utils/utils.tex,v
retrieving revision 1.16
diff -c -r1.16 utils.tex
*** utils.tex	2001/06/14 13:15:40	1.16
--- utils.tex	2001/06/23 20:40:40
***************
*** 54,59 ****
--- 54,61 ----
  
  * djasm::       The DJGPP 16-bit assembler.
  
+ * getconf::     Get system-dependent configuration values.
+ 
  @end menu
  
  @c -----------------------------------------------------------------------------
***************
*** 642,648 ****
  redirect the output to a file or a printer.
  
  @c -----------------------------------------------------------------------------
! @node update, djasm, texi2ps, Top
  @chapter update
  
  @code{update} is a fancy copy-if-needed program.  Basically, it compares
--- 644,650 ----
  redirect the output to a file or a printer.
  
  @c -----------------------------------------------------------------------------
! @node update, getconf, texi2ps, Top
  @chapter update
  
  @code{update} is a fancy copy-if-needed program.  Basically, it compares
***************
*** 717,724 ****
  then you can omit the @samp{&& touch @var{copied_to}} bit in
  the above command strings.
  
  @c -----------------------------------------------------------------------------
! @node djasm, , update, Top
  @chapter djasm
  @lowersections
  
--- 719,764 ----
  then you can omit the @samp{&& touch @var{copied_to}} bit in
  the above command strings.
  
+ @c -----------------------------------------------------------------------------
+ @node getconf, djasm, update, Top
+ @chapter getconf
+ 
+ @code{getconf} writes the value of configuration dependent variables to
+ standard output.
+ 
+ Usage: @code{getconf} [@code{-v} @var{specification}] [@code{-h}] 
+ [@var{system_variable}] [@var{path_variable} @var{path}]
+ 
+ @table @code
+ 
+ @item -v @var{specification}
+ 
+ Return values for configuration variables from the compilation environment
+ specified by @var{specification}.  Use @code{getconf} @code{-h} to list all
+ supported compilation environments.
+ 
+ @item -h
+ 
+ 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.
+ 
+ @end table
+ 
+ When @var{system_variable} is given, the value of @var{system_variable}
+ is written to standard output.  When @var{path_variable} is given, the
+ value of @var{path_variable} for the given pathname @var{path} is written to
+ standard output.
+ 
+ Examples:
+ @example
+ getconf PATH
+ getconf -v POSIX_V6_ILP32_OFF32 PATH
+ getconf NAME_MAX c:/djgpp
+ @end example
+ 
  @c -----------------------------------------------------------------------------
! @node djasm, , getconf, Top
  @chapter djasm
  @lowersections
  

- Raw text -