Mailing-List: contact cygwin-developers-help AT sourceware DOT cygnus DOT com; run by ezmlm
List-Subscribe: <mailto:cygwin-developers-subscribe AT sources DOT redhat DOT com>
List-Archive: <http://sources.redhat.com/ml/cygwin-developers/>
List-Post: <mailto:cygwin-developers AT sources DOT redhat DOT com>
List-Help: <mailto:cygwin-developers-help AT sources DOT redhat DOT com>, <http://sources.redhat.com/ml/#faqs>
Sender: cygwin-developers-owner AT sources DOT redhat DOT com
Delivered-To: mailing list cygwin-developers AT sources DOT redhat DOT com
From: "edward" <tailbert AT yahoo DOT com>
To: "List, Cygwin Developers" <cygwin-developers AT cygwin DOT com>
Subject: SGML modifications?
Date: Thu, 21 Dec 2000 16:05:33 -0500
Message-ID: <FMEOJCMLNIMPBKAPFPIHGEPKCFAA.tailbert@yahoo.com>
MIME-Version: 1.0
Content-Type: multipart/mixed;
	boundary="----=_NextPart_000_0000_01C06B67.D90C2830"
X-Priority: 3 (Normal)
X-MSMail-Priority: Normal
X-Mailer: Microsoft Outlook IMO, Build 9.0.2416 (9.0.2910.0)
X-MimeOLE: Produced By Microsoft MimeOLE V5.50.4133.2400
Importance: Normal
X-Apparently-From: Swiftnsavv AT aol DOT com

This is a multi-part message in MIME format.

------=_NextPart_000_0000_01C06B67.D90C2830
Content-Type: text/plain;
	charset="iso-8859-1"
Content-Transfer-Encoding: 7bit

Hello CygPeeps,

I would like to start going through the winsup/doc/sgml files and update
them as follows.

1) Make the sgml fully conformant (no missing closing tags, etc).

	In order to do this, I prefer to reformat the sgml files to the format I've
enclosed below. It definitely helps tracking down tags, as well as making
things a bit easier to update.

2) Use consistent case/usage as much as possible.

	For example, in cygwinenv.sgml, the default state of each environment
variable is stated clearly at the end of each entry.

3) (distant #3 right now, since I am not familiar with the code), update
docs to reflect current/future implementation.

I've enclosed an example of the mods I would like to make to cygwinenv.sgml.
I'll continue with the rest of the sgml files conditional on feedback from
everyone.

Cheers,
edward.

------=_NextPart_000_0000_01C06B67.D90C2830
Content-Type: application/octet-stream;
	name="cygwinenv.sgml"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: attachment;
	filename="cygwinenv.sgml"

<sect1 id=3D"using-cygwinenv">=0A=
<title>The <EnVar>CYGWIN</EnVar>environment variable</title>=0A=
=0A=
<para>=0A=
  The <EnVar>CYGWIN</EnVar> environment variable is used to configure=0A=
  many global settings for the Cygwin runtime system. It contains the=0A=
  options listed below, separated by blank characters. Many options=0A=
  can be turned off by prefixing with <literal>no</literal>.=0A=
</para>=0A=
=0A=
<itemizedlist Mark=3D"bullet">=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)binmode</FirstTerm> - If set, non-disk (e.g. pipe=0A=
      and COM ports) file opens default to binary mode (no=0A=
      CR/LF/Ctrl-Z translations) instead of text mode. This option=0A=
      must be set before starting a Cygwin shell to have an effect on=0A=
      redirection. Defaults to set (binary mode). =0A=
    </para>=0A=
    <warning>=0A=
      <title>Warning!</title>=0A=
      <para>=0A=
        If set in 12/98 b20.1, all files always open in binary=0A=
        mode.=0A=
      </para>=0A=
    </warning>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)envcache</FirstTerm> - If set, environment=0A=
      variable conversions (between Win32 and POSIX) are cached. Note=0A=
      that this is may cause problems if the mount table changes, as=0A=
      the cache is not invalidated and may contain values that depend=0A=
      on the previous mount table contents. Defaults to set.=0A=
    </para>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)export</FirstTerm> - If set, the final values of=0A=
      these settings are re-exported to the environment as $CYGWIN=0A=
      again. Defaults to not set.=0A=
    </para>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>error_start:filepath</FirstTerm> - If set, runs=0A=
      <filename>filepath</filename> when cygwin encounters a fatal=0A=
      error. This is useful for debugging.=0A=
      <filename>filepath</filename> is usually set to the path to=0A=
      the <filename>gdb</filename> program.=0A=
    </para>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)glob[:ignorecase]</FirstTerm> - If set, command=0A=
      line arguments containing UNIX-style file wildcard characters=0A=
      (brackets, question mark, asterisk, escaped with \) are expanded=0A=
      into lists of files that match those wildcards. This is=0A=
      applicable only to programs running from a DOS command line=0A=
      prompt. Defaults to set.=0A=
    </para>=0A=
    <para>=0A=
      This option also accepts an optional=0A=
      <literal>[no]ignorecase</literal> modifer. If supplied, wildcard=0A=
      matching is case insensitive. The default is=0A=
      <literal>noignorecase</literal>.=0A=
    </para>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)ntea</FirstTerm> - If set, use the full NT=0A=
      Extended Attributes to store UNIX-like inode information. This=0A=
      option only operates under Windows NT. Defaults to not set.=0A=
    </para>=0A=
    <warning>=0A=
      <title>Warning!</title>=0A=
      <para>=0A=
        This may create additional <emphasis>large</emphasis> files on=0A=
        non-NTFS partitions.=0A=
      </para>=0A=
    </warning>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)ntsec</FirstTerm> - If set, use the NT security=0A=
      model to set UNIX-like permissions on files and processes. The=0A=
      file permissions can only be set on NTFS partitions. FAT doesn't=0A=
      support the NT file security. For more information, read the=0A=
      documentation in <citation>ntsec.sgml</citation>. Defaults to=0A=
      not set.=0A=
    </para>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)smbntsec</FirstTerm> - If set, use `ntsec' on=0A=
      remote drives as well (this is the default). If you encounter=0A=
      problems with NT shares or Samba drives, setting this to=0A=
      `nosmbntsec' could help. In that case the permission and=0A=
      owner/group information is faked as on FAT partitions. A reason=0A=
      for a non working ntsec on remote drives could be insufficient=0A=
      permissions of the users. Since the needed user rights are=0A=
      somewhat dangerous (SeRestorePrivilege) it's not always an=0A=
      option to grant those rights to users. However, this shouldn't=0A=
      be a problem in NT domain environments. Defaults to set.=0A=
    </para>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)reset_com</FirstTerm> - If set, serial ports are=0A=
      reset to 9600-8-N-1 with no flow control when used. This is done=0A=
      at open time and when handles are inherited. Defaults to set.=0A=
    </para>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)strip_title</FirstTerm> - If set, strips the=0A=
      directory part off the window title, if any. Defaults to not=0A=
      set.=0A=
    </para>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)title</FirstTerm> - If set, the title bar=0A=
      reflects the name of the program currently running. Note that=0A=
      under Win9x the title bar is always enabled and it is stripped=0A=
      by default, but this is because of the way Win9x works. In order=0A=
      not to strip, specify <literal>title</literal> or <literal>title=0A=
      nostrip_title</literal>. Defaults to not set. =0A=
    </para>=0A=
  </listitem>=0A=
=0A=
  <listitem>=0A=
    <para>=0A=
      <FirstTerm>(no)tty</FirstTerm> - If set, Cygwin enables extra=0A=
      support (i.e., termios) for UNIX-like ttys. It is not compatible=0A=
      with some Windows programs. Note that this has been changed such=0A=
      that ^D works as expected instead of ^Z, and is settable via=0A=
      stty. This option must be specified before starting a Cygwin=0A=
      shell and it cannot be changed in the shell. Defaults to not=0A=
      set, in which case the tty is opened in text mode with ^Z as=0A=
      EOF.=0A=
    </para>=0A=
  </listitem>=0A=
=0A=
</itemizedlist>=0A=
=0A=
</sect1>=0A=

------=_NextPart_000_0000_01C06B67.D90C2830--