2004-01-11 Joshua Daniel Franklin <joshuadfranklin@yahoo.com>

        * Makefile.in: Add new target for single-file User's Guide, use new
        cygwin.dsl for output.
        * cygwin.dsl: New file, DSSSL stylesheet for custom Cygwin output.
        * cygwin-api.in.sgml: Update to DocBook SGML 4.2 DTD.
        * cygwin-ug-net.in.sgml: Update to DocBook SGML 4.2 DTD.
        * cygwin-ug.in.sgml: Update to DocBook SGML 4.2 DTD.
        * cygwinenv.sgml: Correct some tags. Add description of default values
        to ntsec, export, and error_start items.
        * dll.sgml: Add explanation of cyg prefix for DLLs.
        * effectively.sgml: Use systemitem tag for names of Cygwin packages.
        * how-programming.texinfo: Add example to FAQ entry.
        * pathnames.sgml: Add discussion of /proc filesystem.
	* setup-net.sgml: Correct some typos and grammar.

1 files changed, 42 insertions, 30 deletions

diff --git a/winsup/doc/cygwinenv.sgml b/winsup/doc/cygwinenv.sgml
index c78299e5e..439a22169 100644
--- a/winsup/doc/cygwinenv.sgml
+++ b/winsup/doc/cygwinenv.sgml
@@ -8,7 +8,7 @@ by prefixing with <literal>no </literal>.</para>
 
 <itemizedlist Mark="bullet">
 <listitem>
-<para><FirstTerm>(no)binmode</FirstTerm> - if set, non-disk 
+<para><envar>(no)binmode</envar> - if set, non-disk 
 (e.g. pipe and COM ports) file opens default to binary mode 
 (no CRLF translation) instead of text mode.  Defaults to set (binary
 mode).  By default, devices are opened in binary mode, so this option
@@ -24,24 +24,24 @@ pipe to binary by default.
 always open in binary mode.</para></warning>
 </listitem>
 <listitem>
-<para><FirstTerm>check_case:level</FirstTerm> - Controls the behaviour of
+<para><envar>check_case:level</envar> - Controls the behaviour of
 Cygwin when a user tries to open or create a file using a case different from
 the case of the path as asved on the disk.
 <literal>level</literal> is one of <literal>relaxed</literal>,
 <literal>adjust</literal> and <literal>strict</literal>.</para>
 <itemizedlist Mark="bullet">
 <listitem>
-<para><FirstTerm>relaxed</FirstTerm> which is the default behaviour simply
+<para><envar>relaxed</envar> which is the default behaviour simply
 ignores case. That's the default for native Windows applications as well.</para>
 </listitem>
 <listitem>
-<para><FirstTerm>adjust</FirstTerm> behaves mostly invisible. The POSIX input
+<para><envar>adjust</envar> behaves mostly invisible. The POSIX input
 path is internally adjusted in case, so that the resulting DOS path uses the
 correct case throughout. You can see the result when changing the directory
 using a wrong case and calling <command>/bin/pwd</command> afterwards.</para>
 </listitem>
 <listitem>
-<para><FirstTerm>strict</FirstTerm> results in a error message if the case
+<para><envar>strict</envar> results in a error message if the case
 isn't correct. Trying to open a file <filename>Foo</filename> while a file
 <filename>fOo</filename> exists results in a "no such file or directory"
 error. Trying to create a file <filename>BAR</filename> while a file
@@ -52,7 +52,7 @@ case" error.</para>
 </listitem>
 
 <listitem>
-<para><FirstTerm>codepage:[ansi|oem]</FirstTerm> - Windows console 
+<para><envar>codepage:[ansi|oem]</envar> - Windows console 
 applications can use different character sets (codepages) for drawing
 characters.  The first setting, called "ansi", is the default.
 This character set contains various forms of latin characters used
@@ -68,22 +68,33 @@ Cygwin, you can use this option to select an appropriate codepage.
 </listitem>
 
 <listitem>
-<para><FirstTerm>(no)envcache</FirstTerm> - If set, environment variable
+<para><envar>(no)envcache</envar> - If set, environment variable
 conversions (between Win32 and POSIX) are cached.  Note that this is may
 cause problems if the mount table changes, as the cache is not invalidated
 and may contain values that depend on the previous mount table
 contents. Defaults to set.</para>
 </listitem>
 <listitem>
-<para><FirstTerm>(no)export</FirstTerm> - if set, the final values of these
-settings are re-exported to the environment as $CYGWIN again.</para>
+<para><envar>(no)export</envar> - if set, the final values of these
+settings are re-exported to the environment as <envar>CYGWIN</envar> again.
+Defaults to off.</para>
 </listitem>
 <listitem>
-<para><FirstTerm>error_start:filepath</FirstTerm> - if set, runs <filename>filepath</filename>
-when cygwin encounters a fatal error.  This is useful for debugging.
-<filename>filepath</filename> is usually set to the path to the <filename>gdb</filename>
-program.</para>
-<para><FirstTerm>(no)glob[:ignorecase]</FirstTerm> - if set, command line arguments
+<para><envar>error_start:filepath</envar> - if set, runs 
+<filename>filepath</filename> when cygwin encounters a fatal error.  This is
+useful for debugging.  <filename>filepath</filename> is usually set to the path
+to the <command>gdb</command> or <command>dumper</command> program.
+There is no default set.</para>
+</listitem>
+<listitem>
+<para><envar>forkchunk:32768</envar> - causes <function>fork()</function>
+to copy memory some number of bytes at a time, in the above example 
+32768 bytes (32Kb) at a time. The default is to copy as many bytes as 
+possible, which is preferable in most cases but may slow some older systems
+down.
+</listitem>
+<listitem>
+<para><envar>(no)glob[:ignorecase]</envar> - if set, command line arguments
 containing UNIX-style file wildcard characters (brackets, question mark,
 asterisk, escaped with \) are expanded into lists of files that match 
 those wildcards.
@@ -93,40 +104,41 @@ Default is set.</para>
 If supplied, wildcard matching is case insensitive.  The default is <literal>noignorecase</literal></para>
 </listitem>
 <listitem>
-<para><FirstTerm>(no)ntea</FirstTerm> - if set, use the full NT Extended
+<para><envar>(no)ntea</envar> - if set, use the full NT Extended
 Attributes to store UNIX-like inode information.
 This option only operates under Windows NT. Defaults to not set. </para>
 <Warning><Title>Warning!</Title> <para>This may create additional
 <emphasis>large</emphasis> files on non-NTFS partitions.</para></Warning>
 </listitem>
 <listitem>
-<para><FirstTerm>(no)ntsec</FirstTerm> - if set, use the NT security
+<para><envar>(no)ntsec</envar> - if set, use the NT security
 model to set UNIX-like permissions on files and processes. The
 file permissions can only be set on NTFS partitions. FAT doesn't
-support the NT file security. For more information, read the documentation
-in <citation>ntsec.sgml</citation>.</para>
+support the NT file security. Defaults to set. For more information, read
+the documentation in <Xref Linkend="ntsec">.</para>
 </listitem>
 <listitem>
-<para><FirstTerm>(no)smbntsec</FirstTerm> - if set, use `ntsec' on remote
+<para><envar>(no)smbntsec</envar> - if set, use <envar>ntsec</envar> on remote
 drives as well (this is the default). If you encounter problems with NT shares
-or Samba drives, setting this to `nosmbntsec' could help. In that case the
-permission and owner/group information is faked as on FAT partitions.
-A reason for a non working ntsec on remote drives could be insufficient
-permissions of the users. Since the needed user rights are somewhat dangerous
-(SeRestorePrivilege) it's not always an option to grant that rights to users.
-However, this shouldn't be a problem in NT domain environments.</para>
+or Samba drives, setting this to <envar>nosmbntsec</envar> could help. In that
+case the permission and owner/group information is faked as on FAT partitions.
+A reason for a non working <envar>ntsec</envar> on remote drives could be
+insufficient permissions of the users. Since the needed user rights are
+somewhat dangerous (SeRestorePrivilege) it's not always an option to grant that
+rights to users.  However, this shouldn't be a problem in NT domain
+environments.</para>
 </listitem>
 <listitem>
-<para><FirstTerm>(no)reset_com</FirstTerm> - if set, serial ports are reset
+<para><envar>(no)reset_com</envar> - if set, serial ports are reset
 to 9600-8-N-1 with no flow control when used. This is done at open
 time and when handles are inherited.  Defaults to set.</para>
 </listitem>
 <listitem>
-<para><FirstTerm>(no)strip_title</FirstTerm> - if set, strips the directory
+<para><envar>(no)strip_title</envar> - if set, strips the directory
 part off the window title, if any.  Default is not set.</para>
 </listitem>
 <listitem>
-<para><FirstTerm>(no)title</FirstTerm> - if set, the title bar
+<para><envar>(no)title</envar> - if set, the title bar
 reflects the name of the program currently running.  Default is not
 set.  Note that under Win9x the title bar is always enabled and it is
 stripped by default, but this is because of the way Win9x works.  In
@@ -134,7 +146,7 @@ order not to strip, specify <literal>title</literal> or <literal>title
 nostrip_title</literal>.</para>
 </listitem>
 <listitem>
-<para><FirstTerm>(no)tty</FirstTerm> - if set, Cygwin enables extra support
+<para><envar>(no)tty</envar> - if set, Cygwin enables extra support
 (i.e., termios) for UNIX-like ttys. 
 It is not compatible with some Windows programs.
 Defaults to not set, in which case the tty is opened in text mode 
@@ -144,7 +156,7 @@ This option must be specified before starting a Cygwin shell
 and it cannot be changed in the shell.</para>
 </listitem>
 <listitem>
-<para><FirstTerm>(no)winsymlinks</FirstTerm> - if set, Cygwin creates
+<para><envar>(no)winsymlinks</envar> - if set, Cygwin creates
 symlinks as Windows shortcuts with a special header and the R/O attribute
 set. If not set, Cygwin creates symlinks as plain files with a magic number,
 a path and the system attribute set. Defaults to set.</para>