libs/newlib-cygwin
libs
/
newlib-cygwin
mirror of git://sourceware.org/git/newlib-cygwin.git
4
0
Fork 0
Code Issues Projects Releases Wiki Activity

* .sgml: Cleanup markup for XML validity.

This commit is contained in:
Joshua Daniel Franklin 2004-12-24 21:58:38 +00:00
parent e1736c2f13
commit c98b30eadc
18 changed files with 109 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
winsup/doc/ChangeLog
View File

@ -1,3 +1,23 @@
2004-12-24 Joshua Daniel Franklin <joshuadfranklin@yahoo.com>
* cygserver.sgml: Cleanup markup for XML validity.
* cygwin-api.in.sgml: Cleanup markup for XML validity.
* cygwin-ug-net.in.sgml: Cleanup markup for XML validity.
* cygwin-ug.in.sgml: Cleanup markup for XML validity.
* cygwinenv.sgml: Cleanup markup for XML validity.
* dll.sgml: Cleanup markup for XML validity.
* effectively.sgml: Cleanup markup for XML validity.
* filemodes.sgml: Cleanup markup for XML validity.
* legal.sgml: Cleanup markup for XML validity.
* ntsec.sgml: Cleanup markup for XML validity.
* overview.sgml: Cleanup markup for XML validity.
* overview2.sgml: Cleanup markup for XML validity.
* pathnames.sgml: Cleanup markup for XML validity.
* setup-net.sgml: Cleanup markup for XML validity.
* setup2.sgml: Cleanup markup for XML validity.
* textbinary.sgml: Cleanup markup for XML validity.
* utils.sgml: Cleanup markup for XML validity.
2004-12-02 Joshua Daniel Franklin <joshuadfranklin@yahoo.com> 2004-12-02 Joshua Daniel Franklin <joshuadfranklin@yahoo.com>
* cygserver.sgml: Cleanup minor markup problem. * cygserver.sgml: Cleanup minor markup problem.

2
winsup/doc/cygserver.sgml
View File

@ -11,7 +11,7 @@
<para> <para>
The implemented services so far are: The implemented services so far are:
</para> </para>
<itemizedlist Mark="bullet"> <itemizedlist mark="bullet">
<listitem><para>Control slave tty/pty handle dispersal from tty owner to other <listitem><para>Control slave tty/pty handle dispersal from tty owner to other
processes without compromising the owner processes' security.</para></listitem> processes without compromising the owner processes' security.</para></listitem>
<listitem><para>XSI IPC Message Queues.</para></listitem> <listitem><para>XSI IPC Message Queues.</para></listitem>

15
winsup/doc/cygwin-api.in.sgml
View File

@ -1,15 +1,6 @@
<!doctype book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ <?xml version="1.0"?>
<!ENTITY cygnus-copyright "<YEAR>1998</YEAR><HOLDER>Red Hat, Inc.</HOLDER>"> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
<!ENTITY cygnus-code-copyright " "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"[]>
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Copyright (C) 1998,2001 Red Hat, Inc.
This is copyrighted software that may only
be reproduced, modified, or distributed
under license from Red Hat, Inc.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
">
]>
<book id="cygwin-api"> <book id="cygwin-api">

17
winsup/doc/cygwin-ug-net.in.sgml
View File

@ -1,17 +1,6 @@
<!doctype book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ <?xml version="1.0"?>
<!ENTITY cygnus-copyright <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"<YEAR>1999,2000,2001</YEAR> "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"[]>
<HOLDER>Red Hat, Inc.</HOLDER>">
<!ENTITY cygnus-code-copyright "
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Copyright (C) 1998,1999,2000,2001,2002,2003 Red Hat, Inc.
This is copyrighted software that may only
be reproduced, modified, or distributed
under license from Red Hat, Inc.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
">
]>
<book id="cygwin-ug-net"> <book id="cygwin-ug-net">

7
winsup/doc/cygwin-ug.in.sgml
View File

@ -1,6 +1,7 @@
<!doctype book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ <?xml version="1.0"?>
<!ENTITY cygnus-copyright "<YEAR>1999,2000,2001</YEAR> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"[
<HOLDER>Red Hat, Inc.</HOLDER>"> <!ENTITY cygnus-copyright "<year>1999,2000,2001</year>
<holder>Red Hat, Inc.</holder>">
<!ENTITY cygnus-code-copyright " <!ENTITY cygnus-code-copyright "
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Copyright (C) 1998, 1999, 2000, 2001 Red Hat, Inc. Copyright (C) 1998, 1999, 2000, 2001 Red Hat, Inc.

14
winsup/doc/cygwinenv.sgml
View File

@ -1,12 +1,12 @@
<sect1 id="using-cygwinenv"><title>The <EnVar>CYGWIN</EnVar> environment <sect1 id="using-cygwinenv"><title>The <envar>CYGWIN</envar> environment
variable</title> variable</title>
<para>The <EnVar>CYGWIN</EnVar> environment variable is used to configure <para>The <envar>CYGWIN</envar> environment variable is used to configure
many global settings for the Cygwin runtime system. It contains the options many global settings for the Cygwin runtime system. It contains the options
listed below, separated by blank characters. Many options can be turned off listed below, separated by blank characters. Many options can be turned off
by prefixing with <literal>no </literal>.</para> by prefixing with <literal>no </literal>.</para>
<itemizedlist Mark="bullet"> <itemizedlist mark="bullet">
<listitem> <listitem>
<para><envar>(no)binmode</envar> - 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 (e.g. pipe and COM ports) file opens default to binary mode
@ -27,7 +27,7 @@ Cygwin when a user tries to open or create a file using a case different from
the case of the path as saved on the disk. the case of the path as saved on the disk.
<literal>level</literal> is one of <literal>relaxed</literal>, <literal>level</literal> is one of <literal>relaxed</literal>,
<literal>adjust</literal> and <literal>strict</literal>.</para> <literal>adjust</literal> and <literal>strict</literal>.</para>
<itemizedlist Mark="bullet"> <itemizedlist mark="bullet">
<listitem> <listitem>
<para><envar>relaxed</envar> 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> ignores case. That's the default for native Windows applications as well.</para>
@ -111,15 +111,15 @@ If supplied, wildcard matching is case insensitive. The default is <literal>noi
<para><envar>(no)ntea</envar> - 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. Attributes to store UNIX-like inode information.
This option only operates under Windows NT. Defaults to not set. </para> This option only operates under Windows NT. Defaults to not set. </para>
<Warning><Title>Warning!</Title> <para>This may create additional <warning><title>Warning!</title> <para>This may create additional
<emphasis>large</emphasis> files on non-NTFS partitions.</para></Warning> <emphasis>large</emphasis> files on non-NTFS partitions.</para></warning>
</listitem> </listitem>
<listitem> <listitem>
<para><envar>(no)ntsec</envar> - 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 model to set UNIX-like permissions on files and processes. The
file permissions can only be set on NTFS partitions. FAT doesn't file permissions can only be set on NTFS partitions. FAT doesn't
support the NT file security. Defaults to set. For more information, read support the NT file security. Defaults to set. For more information, read
the documentation in <Xref Linkend="ntsec">.</para> the documentation in <xref linkend="ntsec"></xref>.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><envar>(no)smbntsec</envar> - if set, use <envar>ntsec</envar> on remote <para><envar>(no)smbntsec</envar> - if set, use <envar>ntsec</envar> on remote

6
winsup/doc/dll.sgml
View File

@ -35,7 +35,7 @@ information needed to tell the OS how your program interacts with
<para>This page gives only a few simple examples of gcc's DLL-building <para>This page gives only a few simple examples of gcc's DLL-building
capabilities. To begin an exploration of the many additional options, capabilities. To begin an exploration of the many additional options,
see the gcc documentation and website, currently at see the gcc documentation and website, currently at
<ulink URL="http://gcc.gnu.org/">http://gcc.gnu.org/</ulink> <ulink url="http://gcc.gnu.org/">http://gcc.gnu.org/</ulink>
</para> </para>
<para>Let's go through a simple example of how to build a dll. <para>Let's go through a simple example of how to build a dll.
@ -100,7 +100,7 @@ The name of your library is <literal>${module}</literal>, prefixed with
<literal>cyg</literal> for the DLL and <literal>lib</literal> for the <literal>cyg</literal> for the DLL and <literal>lib</literal> for the
import library. Cygwin DLLs use the <literal>cyg</literal> prefix to import library. Cygwin DLLs use the <literal>cyg</literal> prefix to
differentiate them from native-Windows MinGW DLLs, see differentiate them from native-Windows MinGW DLLs, see
<ulink URL="http://mingw.org">the MinGW website</ulink> for more details. <ulink url="http://mingw.org">the MinGW website</ulink> for more details.
<literal>${old_libs}</literal> are all <literal>${old_libs}</literal> are all
your object files, bundled together in static libs or single object your object files, bundled together in static libs or single object
files and the <literal>${dependency_libs}</literal> are import libs you files and the <literal>${dependency_libs}</literal> are import libs you
@ -113,7 +113,7 @@ need to link against, e.g
<para>If you have an existing DLL already, you need to build a <para>If you have an existing DLL already, you need to build a
Cygwin-compatible import library. If you have the source to compile Cygwin-compatible import library. If you have the source to compile
the DLL, see <Xref Linkend="dll-build"> for details on having the DLL, see <xref linkend="dll-build"></xref> for details on having
<filename>gcc</filename> build one for you. If you do not have the <filename>gcc</filename> build one for you. If you do not have the
source or a supplied working import library, you can get most of source or a supplied working import library, you can get most of
the way by creating a .def file with these commands (you might need to the way by creating a .def file with these commands (you might need to

24
winsup/doc/effectively.sgml
View File

@ -24,14 +24,14 @@ better coverage, which Windows 2000 and XP expanded.
Microsoft also provides free downloads for Windows NT 4.0 (the Resource Kit Microsoft also provides free downloads for Windows NT 4.0 (the Resource Kit
Support Tools), Windows 2000 (the Resource Kit Tools), and XP (the Support Tools), Windows 2000 (the Resource Kit Tools), and XP (the
Windows Support Tools). Additionally, many independent sites such as Windows Support Tools). Additionally, many independent sites such as
<ulink URL="http://download.com.com">download.com</ulink>, <ulink url="http://download.com.com">download.com</ulink>,
<ulink URL="http://simtel.net">simtel.net</ulink>, <ulink url="http://simtel.net">simtel.net</ulink>,
and <ulink URL="http://sysinternals.com">sysinternals.com</ulink> and <ulink url="http://sysinternals.com">sysinternals.com</ulink>
provide command-line utilities. A few Windows tools, such as provide command-line utilities. A few Windows tools, such as
<command>find.exe</command> and <command>sort.exe</command>, <command>find.exe</command> and <command>sort.exe</command>,
may conflict with the Cygwin versions; make sure that you use the full may conflict with the Cygwin versions; make sure that you use the full
path (<command>/usr/bin/find</command>) or that your Cygwin path (<command>/usr/bin/find</command>) or that your Cygwin
<literal>bin</literal> directory comes first in your <EnVar>PATH</EnVar>. <literal>bin</literal> directory comes first in your <envar>PATH</envar>.
</para> </para>
<sect2> <title>Pathnames</title> <sect2> <title>Pathnames</title>
@ -41,7 +41,7 @@ Windows programs do not understand POSIX pathnames, so any arguments
that reference the filesystem must be in Windows (or DOS) format or that reference the filesystem must be in Windows (or DOS) format or
translated. Cygwin provides the <command>cygpath</command> utility for translated. Cygwin provides the <command>cygpath</command> utility for
converting between Windows and POSIX paths. A complete description of its converting between Windows and POSIX paths. A complete description of its
options and examples of its usage are in <Xref Linkend="cygpath">, options and examples of its usage are in <xref linkend="cygpath"></xref>,
including a shell script for starting Windows Explorer in any directory. including a shell script for starting Windows Explorer in any directory.
The same format works for most Windows programs, for example The same format works for most Windows programs, for example
<screen> <screen>
@ -82,10 +82,10 @@ Windows verses Unix compatibility behavior. To be most compatible with
Windows programs, use a DOS prompt, running only the occasional Cygwin Windows programs, use a DOS prompt, running only the occasional Cygwin
command or script. Next would be to run <command>bash</command> with command or script. Next would be to run <command>bash</command> with
the default DOS box. To make Cygwin more Unix compatible in this case, the default DOS box. To make Cygwin more Unix compatible in this case,
set <EnVar>CYGWIN=tty</EnVar> (see <Xref Linkend="using-cygwinenv">). set <envar>CYGWIN=tty</envar> (see <xref linkend="using-cygwinenv"></xref>).
Alternatively, the optional <systemitem>rxvt</systemitem> package provides Alternatively, the optional <systemitem>rxvt</systemitem> package provides
a native-Windows version of the popular X11 terminal emulator (it is not a native-Windows version of the popular X11 terminal emulator (it is not
necessary to set <EnVar>CYGWIN=tty</EnVar> with <command>rxvt</command>). necessary to set <envar>CYGWIN=tty</envar> with <command>rxvt</command>).
Using <command>rxvt.exe</command> provides the most Unix-like environment, Using <command>rxvt.exe</command> provides the most Unix-like environment,
but expect some compatibility problems with Windows programs. but expect some compatibility problems with Windows programs.
</para> </para>
@ -116,9 +116,9 @@ Windows 95, 98, and ME) for automating dialup connections.
Users who frequently change their network Users who frequently change their network
configuration can script these changes with <command>netsh.exe</command> configuration can script these changes with <command>netsh.exe</command>
(Windows 2000 and XP). For proxy users, the open source (Windows 2000 and XP). For proxy users, the open source
<ulink URL="http://apserver.sourceforge.net"> <ulink url="http://apserver.sourceforge.net">
NTLM Authorization Proxy Server</ulink> or the no-charge NTLM Authorization Proxy Server</ulink> or the no-charge
<ulink URL="http://www.hummingbird.com/products/nc/socks/index.html"> <ulink url="http://www.hummingbird.com/products/nc/socks/index.html">
Hummingbird SOCKS Proxy</ulink> may allow you to use Cygwin network Hummingbird SOCKS Proxy</ulink> may allow you to use Cygwin network
programs in your environment. programs in your environment.
</para> </para>
@ -137,7 +137,7 @@ for interacting with Windows.
<para> <para>
One of the hassles of Unix-Windows interoperability is the different line One of the hassles of Unix-Windows interoperability is the different line
endings on text files. As mentioned in <Xref Linkend="using-textbinary">, endings on text files. As mentioned in <xref linkend="using-textbinary"></xref>,
Unix tools such as <command>tr</command> can convert between CRLF and LF Unix tools such as <command>tr</command> can convert between CRLF and LF
endings, but <systemitem>cygutils</systemitem> provides several dedicated programs: endings, but <systemitem>cygutils</systemitem> provides several dedicated programs:
<command>conv</command>, <command>d2u</command>, <command>dos2unix</command>, <command>conv</command>, <command>d2u</command>, <command>dos2unix</command>,
@ -178,7 +178,7 @@ There are several options for printing from Cygwin, including the
<command>lpr</command> found in <systemitem>cygutils</systemitem> (not to be confused with the <command>lpr</command> found in <systemitem>cygutils</systemitem> (not to be confused with the
native Windows <command>lpr.exe</command>). The easiest way to use <systemitem>cygutils</systemitem>' native Windows <command>lpr.exe</command>). The easiest way to use <systemitem>cygutils</systemitem>'
<command>lpr</command> is to specify a default device name in the <command>lpr</command> is to specify a default device name in the
<EnVar>PRINTER</EnVar> environment variable. You may also specify a device <envar>PRINTER</envar> environment variable. You may also specify a device
on the command line with the <literal>-d</literal> or <literal>-P</literal> on the command line with the <literal>-d</literal> or <literal>-P</literal>
options, which will override the environment variable setting. options, which will override the environment variable setting.
</para> </para>
@ -202,7 +202,7 @@ text files for printing. The <systemitem>ghostscript</systemitem> package also
provides some translation provides some translation
from PostScript to various native printer languages. Additionally, a native from PostScript to various native printer languages. Additionally, a native
Windows application for printing PostScript, <command>gsprint</command>, is Windows application for printing PostScript, <command>gsprint</command>, is
available from the <ulink URL="http://www.cs.wisc.edu/~ghost/">Ghostscript available from the <ulink url="http://www.cs.wisc.edu/~ghost/">Ghostscript
website</ulink>. website</ulink>.
</para> </para>

4
winsup/doc/filemodes.sgml
View File

@ -11,7 +11,7 @@ needs to open and read files. It can thus be relatively slow.</para>
<para>Under NT, file permissions default to the same behavior as Windows <para>Under NT, file permissions default to the same behavior as Windows
9x but there is optional functionality in Cygwin that can make file 9x but there is optional functionality in Cygwin that can make file
systems behave more like on UNIX systems. This is turned on by adding systems behave more like on UNIX systems. This is turned on by adding
the "ntea" option to the <EnVar>CYGWIN</EnVar> environment variable.</para> the "ntea" option to the <envar>CYGWIN</envar> environment variable.</para>
<para>When the "ntea" feature is activated, Cygwin will start with basic <para>When the "ntea" feature is activated, Cygwin will start with basic
permissions as determined above, but can store POSIX file permissions in NT permissions as determined above, but can store POSIX file permissions in NT
@ -24,7 +24,7 @@ have a large number of files on the partition in question, slowing the
system to a crawl. In addition, the <filename>EA DATA. SF</filename> file system to a crawl. In addition, the <filename>EA DATA. SF</filename> file
can only be deleted outside of Windows because of its "in use" status. For can only be deleted outside of Windows because of its "in use" status. For
these reasons, the use of NT Extended Attributes is off by default in these reasons, the use of NT Extended Attributes is off by default in
Cygwin. Finally, note that specifying "ntea" in <EnVar>CYGWIN</EnVar> has no Cygwin. Finally, note that specifying "ntea" in <envar>CYGWIN</envar> has no
effect under Windows 9x. </para> effect under Windows 9x. </para>
<para>Under NT, the test "[ -w filename]" is only true if filename is <para>Under NT, the test "[ -w filename]" is only true if filename is

22
winsup/doc/legal.sgml
View File

@ -1,30 +1,30 @@
<LegalNotice id="legal"> <legalnotice id="legal">
<para>Copyright &copy; 1998, 1999, 2000, 2001, 2002, 2003 Red Hat, Inc.</para> <para>Copyright &copy; 1998, 1999, 2000, 2001, 2002, 2003 Red Hat, Inc.</para>
<!-- <!--
<Para>GNUPro&trade;, the GNUPro&trade; logo, and the Red Hat <para>GNUPro&trade;, the GNUPro&trade; logo, and the Red Hat
logo are trademarks of Red Hat, Inc. All other brand and product logo are trademarks of Red Hat, Inc. All other brand and product
names are trademarks of their respective owners.</Para> names are trademarks of their respective owners.</para>
<Para>Permission is granted to make and distribute verbatim copies of <para>Permission is granted to make and distribute verbatim copies of
this documentation provided the copyright notice and this permission this documentation provided the copyright notice and this permission
notice are preserved on all copies.</Para> notice are preserved on all copies.</para>
<Para>Permission is granted to copy and distribute modified versions <para>Permission is granted to copy and distribute modified versions
of this documentation under the conditions for verbatim copying, of this documentation under the conditions for verbatim copying,
provided that the entire resulting derived work is distributed under provided that the entire resulting derived work is distributed under
the terms of a permission notice identical to this one.</Para> the terms of a permission notice identical to this one.</para>
<Para>Permission is granted to copy and distribute translations of <para>Permission is granted to copy and distribute translations of
this documentation into another language, under the above conditions this documentation into another language, under the above conditions
for modified versions, except that this permission notice may be for modified versions, except that this permission notice may be
stated in a translation approved by the Free Software stated in a translation approved by the Free Software
Foundation.</Para> Foundation.</para>
<Para>This documentation has been prepared by Red Hat, Inc. <para>This documentation has been prepared by Red Hat, Inc.
Technical Publications.</para> Technical Publications.</para>
--> -->
</LegalNotice> </legalnotice>

4
winsup/doc/ntsec.sgml
View File

@ -1,14 +1,14 @@
<sect1 id="ntsec"><title>NT security and usage of <literal>ntsec</literal></title> <sect1 id="ntsec"><title>NT security and usage of <literal>ntsec</literal></title>
<para>The setting of UNIX like object permissions is controlled by the <para>The setting of UNIX like object permissions is controlled by the
<link linkend="using-cygwinenv"><EnVar>CYGWIN</EnVar> environment <link linkend="using-cygwinenv"><envar>CYGWIN</envar> environment
variable</link> setting <literal>(no)ntsec</literal> which is set to variable</link> setting <literal>(no)ntsec</literal> which is set to
<literal>ntsec</literal> by default.</para> <literal>ntsec</literal> by default.</para>
<para>The design goal of <literal>ntsec</literal> is to get a more UNIX-like <para>The design goal of <literal>ntsec</literal> is to get a more UNIX-like
permission structure based upon the security features of Windows NT. permission structure based upon the security features of Windows NT.
To describe the changes, I will first give a short overview in To describe the changes, I will first give a short overview in
<xref linkend="ntsec-common">. <xref linkend="ntsec-common"></xref>.
</para> </para>
<para><link linkend="ntsec-processes" endterm="ntsec-processes.title"></link> <para><link linkend="ntsec-processes" endterm="ntsec-processes.title"></link>
discusses the changes in ntsec related to privileges on processes.</para> discusses the changes in ntsec related to privileges on processes.</para>

16
winsup/doc/overview.sgml
View File

@ -6,7 +6,7 @@
Cygwin is a Linux-like environment for Windows. It consists of a DLL Cygwin is a Linux-like environment for Windows. It consists of a DLL
(<filename>cygwin1.dll</filename>), which acts as an emulation layer (<filename>cygwin1.dll</filename>), which acts as an emulation layer
providing substantial <ulink providing substantial <ulink
URL="http://www.pasc.org/#POSIX">POSIX</ulink> (Portable Operating url="http://www.pasc.org/#POSIX">POSIX</ulink> (Portable Operating
System Interface) system call functionality, and a collection of tools, System Interface) system call functionality, and a collection of tools,
which provide a Linux look and feel. The Cygwin DLL works with all x86 which provide a Linux look and feel. The Cygwin DLL works with all x86
versions of Windows since Windows 95. versions of Windows since Windows 95.
@ -30,19 +30,19 @@ DOCTOOL-INSERT-ov-ex-unix
<sect1 id="are-free"><title>Are the Cygwin tools free software?</title> <sect1 id="are-free"><title>Are the Cygwin tools free software?</title>
<para>Yes. Parts are <ulink URL="http://www.gnu.org/">GNU</ulink> software <para>Yes. Parts are <ulink url="http://www.gnu.org/">GNU</ulink> software
(<command>gcc</command>, <command>gas</command>, <command>ld</command>, etc.), (<command>gcc</command>, <command>gas</command>, <command>ld</command>, etc.),
parts are covered by the standard parts are covered by the standard
<ulink URL="http://www.x.org/Downloads_terms.html">X11 license</ulink>, <ulink url="http://www.x.org/Downloads_terms.html">X11 license</ulink>,
some of it is public domain, some of it was written by Red Hat and placed under some of it is public domain, some of it was written by Red Hat and placed under
the <ulink URL="http://www.gnu.org/licenses/gpl.html">GNU General Public the <ulink url="http://www.gnu.org/licenses/gpl.html">GNU General Public
License</ulink> (GPL). None of it is shareware. You don't have to pay anyone to License</ulink> (GPL). None of it is shareware. You don't have to pay anyone to
use it but you should be sure to read the copyright section of the FAQ for more use it but you should be sure to read the copyright section of the FAQ for more
information on how the GNU GPL may affect your use of these information on how the GNU GPL may affect your use of these
tools. If you intend to port a proprietary application using the Cygwin tools. If you intend to port a proprietary application using the Cygwin
library, you may want the Cygwin proprietary-use license. library, you may want the Cygwin proprietary-use license.
For more information about the proprietary-use license, please go to For more information about the proprietary-use license, please go to
<ulink URL="http://www.redhat.com/software/tools/cygwin/">http://www.redhat.com/software/tools/cygwin/ <ulink url="http://www.redhat.com/software/tools/cygwin/">http://www.redhat.com/software/tools/cygwin/
</ulink>. Customers of the native Win32 GNUPro should feel free to submit bug </ulink>. Customers of the native Win32 GNUPro should feel free to submit bug
reports and ask questions through the normal channels. All other reports and ask questions through the normal channels. All other
questions should be sent to the project mailing list questions should be sent to the project mailing list
@ -55,9 +55,9 @@ questions should be sent to the project mailing list
<note> <note>
<para> <para>
A more complete historical look Cygwin is Geoffrey J. Noer's 1998 paper, A more complete historical look Cygwin is Geoffrey J. Noer's 1998 paper,
"Cygwin32: A Free Win32 Porting Layer for UNIX® Applications" which can be "Cygwin32: A Free Win32 Porting Layer for UNIX&reg; Applications" which can be
found at the <ulink found at the <ulink
URL="http://www.usenix.org/publications/library/proceedings/usenix-nt98/technical.html"> url="http://www.usenix.org/publications/library/proceedings/usenix-nt98/technical.html">
2nd USENIX Windows NT Symposium Online Proceedings</ulink>. 2nd USENIX Windows NT Symposium Online Proceedings</ulink>.
</para> </para>
</note> </note>
@ -96,7 +96,7 @@ the GNU configure mechanism. Self hosting was achieved as of the beta
<para> <para>
The entire Cygwin toolset was available as a monolithic install. In The entire Cygwin toolset was available as a monolithic install. In
April 2000, the project announced a April 2000, the project announced a
<ulink URL="http://www.cygwin.com/ml/cygwin/2000-04/msg00269.html"> <ulink url="http://www.cygwin.com/ml/cygwin/2000-04/msg00269.html">
New Cygwin Net Release</ulink> which provided the native Win32 program New Cygwin Net Release</ulink> which provided the native Win32 program
<command>setup.exe</command> to install and upgrade each package <command>setup.exe</command> to install and upgrade each package
separately. Since then, the Cygwin DLL and <command>setup.exe</command> separately. Since then, the Cygwin DLL and <command>setup.exe</command>

8
winsup/doc/overview2.sgml
View File

@ -12,7 +12,7 @@ To install a basic Cygwin environment, run the
<command>setup.exe</command> program and click <literal>Next</literal> <command>setup.exe</command> program and click <literal>Next</literal>
at each page. The default settings are correct for most users. If you at each page. The default settings are correct for most users. If you
want to know more about what each option means, see want to know more about what each option means, see
<Xref Linkend="internet-setup">. Use <command>setup.exe</command> <xref linkend="internet-setup"></xref>. Use <command>setup.exe</command>
any time you want to update or install a Cygwin package. If you are any time you want to update or install a Cygwin package. If you are
installing Cygwin for a specific purpose, use it to install the tools installing Cygwin for a specific purpose, use it to install the tools
that you need. For example, if you want to compile C++ programs, you that you need. For example, if you want to compile C++ programs, you
@ -47,7 +47,7 @@ If you are an experienced UNIX user who misses a powerful command-line
environment, you will enjoy Cygwin. Note that there are some workarounds environment, you will enjoy Cygwin. Note that there are some workarounds
that cause Cygwin to behave differently than most UNIX-like operating that cause Cygwin to behave differently than most UNIX-like operating
systems; these are described in more detail in systems; these are described in more detail in
<xref linkend="using-effectively">. <xref linkend="using-effectively"></xref>.
</para> </para>
<para> <para>
Any time you want to update or install a Cygwin package, use the Any time you want to update or install a Cygwin package, use the
@ -55,9 +55,9 @@ graphical <command>setup.exe</command> program. By default,
<command>setup.exe</command> only installs a minimal set of packages, <command>setup.exe</command> only installs a minimal set of packages,
so look around and choose your favorite utilities on the package so look around and choose your favorite utilities on the package
selection screen. You may also search for specfic tools on the Cygwin selection screen. You may also search for specfic tools on the Cygwin
website's <ulink URL="http://cygwin.com/packages/">Setup Package website's <ulink url="http://cygwin.com/packages/">Setup Package
Search</ulink> For more information about what each option in Search</ulink> For more information about what each option in
<command>setup.exe</command> means, see <xref linkend="internet-setup">. <command>setup.exe</command> means, see <xref linkend="internet-setup"></xref>.
</para> </para>
<para> <para>
Another option is to install everything by clicking on the Another option is to install everything by clicking on the

14
winsup/doc/pathnames.sgml
View File

@ -33,7 +33,7 @@ program. For those people coming from a Windows background, the
subdirectories somewhere else.</para> subdirectories somewhere else.</para>
<para>The mapping is stored in the current user's Cygwin <para>The mapping is stored in the current user's Cygwin
<FirstTerm>mount table</FirstTerm> in the Windows registry so that the <firstterm>mount table</firstterm> in the Windows registry so that the
information will be retrieved next time the user logs in. Because it information will be retrieved next time the user logs in. Because it
is sometimes desirable to have system-wide as well as user-specific is sometimes desirable to have system-wide as well as user-specific
mounts, there is also a system-wide mount table that all Cygwin users mounts, there is also a system-wide mount table that all Cygwin users
@ -82,7 +82,7 @@ e: on /cygdrive/e type user (binmode,noumount)
<para>You can also use the <command>mount</command> command to add <para>You can also use the <command>mount</command> command to add
new mount points, and the <command>umount</command> to delete new mount points, and the <command>umount</command> to delete
them. See <Xref Linkend="mount"> and <Xref Linkend="umount"> for more them. See <xref linkend="mount"></xref> and <xref linkend="umount"></xref> for more
information on how to use these utilities to set up your Cygwin POSIX information on how to use these utilities to set up your Cygwin POSIX
file system.</para> file system.</para>
@ -94,13 +94,13 @@ path <filename>/cygdrive</filename>. For example, if Cygwin accesses
mount table, then <filename>Z:\</filename> would be automatically mount table, then <filename>Z:\</filename> would be automatically
converted to <filename>/cygdrive/Z</filename>. The default converted to <filename>/cygdrive/Z</filename>. The default
prefix of <filename>/cygdrive</filename> may be changed (see the prefix of <filename>/cygdrive</filename> may be changed (see the
<Xref Linkend="mount"> for more information).</para> <xref linkend="mount"></xref> for more information).</para>
<para>It is possible to assign some special attributes to each mount <para>It is possible to assign some special attributes to each mount
point. Automatically mounted partitions are displayed as "auto" point. Automatically mounted partitions are displayed as "auto"
mounts. Mounts can also be marked as either "textmode" or "binmode" mounts. Mounts can also be marked as either "textmode" or "binmode"
-- whether text files are read in the same manner as binary files by -- whether text files are read in the same manner as binary files by
default or not (see <Xref Linkend="using-textbinary"> for more default or not (see <xref linkend="using-textbinary"></xref> for more
information on text and binary modes.</para> information on text and binary modes.</para>
</sect2> </sect2>
@ -109,10 +109,10 @@ information on text and binary modes.</para>
<para>The <command>cygpath</command> program provides the ability to <para>The <command>cygpath</command> program provides the ability to
translate between Win32 and POSIX pathnames in shell scripts. See translate between Win32 and POSIX pathnames in shell scripts. See
<Xref Linkend="cygpath"> for the details.</para> <xref linkend="cygpath"></xref> for the details.</para>
<para>The <EnVar>HOME</EnVar>, <EnVar>PATH</EnVar>, and <para>The <envar>HOME</envar>, <envar>PATH</envar>, and
<EnVar>LD_LIBRARY_PATH</EnVar> environment variables are automatically <envar>LD_LIBRARY_PATH</envar> environment variables are automatically
converted from Win32 format to POSIX format (e.g. from converted from Win32 format to POSIX format (e.g. from
<filename>c:\cygwin\bin</filename> to <filename>/bin</filename>, if <filename>c:\cygwin\bin</filename> to <filename>/bin</filename>, if
there was a mount from that Win32 path to that POSIX path) when a Cygwin there was a mount from that Win32 path to that POSIX path) when a Cygwin

16
winsup/doc/setup-net.sgml
View File

@ -3,8 +3,8 @@
<sect1 id="internet-setup"> <sect1 id="internet-setup">
<title>Internet Setup</title> <title>Internet Setup</title>
<para>To install the Cygwin net release, go to <ulink <para>To install the Cygwin net release, go to <ulink
URL="http://cygwin.com/">http://cygwin.com/</ulink> and click on <ulink url="http://cygwin.com/">http://cygwin.com/</ulink> and click on <ulink
URL="http://cygwin.com/setup.exe">"Install Cygwin Now!"</ulink>. This will url="http://cygwin.com/setup.exe">"Install Cygwin Now!"</ulink>. This will
download a GUI installer called <command>setup.exe</command> which can download a GUI installer called <command>setup.exe</command> which can
be run to download a complete cygwin installation via the internet. be run to download a complete cygwin installation via the internet.
Follow the instructions on each screen to install Cygwin. Follow the instructions on each screen to install Cygwin.
@ -15,7 +15,7 @@ The <command>setup.exe</command> installer is designed to be easy
for new users to understand while remaining flexible for the for new users to understand while remaining flexible for the
experienced. The volunteer development team is constantly working experienced. The volunteer development team is constantly working
on <command>setup.exe</command>; before requesting a new feature, on <command>setup.exe</command>; before requesting a new feature,
check the wishlist in the <ulink URL="http://sources.redhat.com/cgi-bin/cvsweb.cgi/setup/README?cvsroot=cygwin-apps&amp;rev=2">CVS <literal>README</literal> check the wishlist in the <ulink url="http://sources.redhat.com/cgi-bin/cvsweb.cgi/setup/README?cvsroot=cygwin-apps&amp;rev=2">CVS <literal>README</literal>
</ulink>. It may already be present in the CVS version! </ulink>. It may already be present in the CVS version!
</para> </para>
@ -25,13 +25,13 @@ most installations, you can get a working minimal Cygwin environment
installed by simply clicking the <literal>Next</literal> button installed by simply clicking the <literal>Next</literal> button
at each page. The only exception to this is choosing a Cygwin mirror, at each page. The only exception to this is choosing a Cygwin mirror,
which you can choose by experimenting with those listed at which you can choose by experimenting with those listed at
<ulink URL="http://cygwin.com/mirrors.html"> <ulink url="http://cygwin.com/mirrors.html">
http://cygwin.com/mirrors.html http://cygwin.com/mirrors.html
</ulink>. For more details about each of page of the </ulink>. For more details about each of page of the
<command>setup.exe</command> installation, read on below. <command>setup.exe</command> installation, read on below.
Please note that this guide assumes that you have a basic understanding Please note that this guide assumes that you have a basic understanding
of Unix (or a Unix-like OS). If you are new to Unix, you will also want of Unix (or a Unix-like OS). If you are new to Unix, you will also want
to make use of <ulink URL="http://www.google.com/search?q=new+to+unix"> to make use of <ulink url="http://www.google.com/search?q=new+to+unix">
other resources</ulink>. other resources</ulink>.
</para> </para>
@ -129,7 +129,7 @@ authorization for proxy servers.
Since there is no way of knowing from where you will be downloading Since there is no way of knowing from where you will be downloading
Cygwin, you need to choose at least one mirror site. Cygwin mirrors Cygwin, you need to choose at least one mirror site. Cygwin mirrors
are geographically distributed around the world; check the list at <ulink are geographically distributed around the world; check the list at <ulink
URL="http://cygwin.com/mirrors.html">http://cygwin.com/mirrors.html</ulink> url="http://cygwin.com/mirrors.html">http://cygwin.com/mirrors.html</ulink>
to find one near you. You can select multiple mirrors by holding down to find one near you. You can select multiple mirrors by holding down
<literal>CTRL</literal> and clicking on each one. If you have the URL of <literal>CTRL</literal> and clicking on each one. If you have the URL of
an unlisted mirror (for example, if your organization has an internal Cygwin an unlisted mirror (for example, if your organization has an internal Cygwin
@ -144,7 +144,7 @@ small text file called <literal>setup.bz2</literal> that contains a list
of packages available from that site along with some basic information about of packages available from that site along with some basic information about
each package which <command>setup.exe</command> parses and uses to create the each package which <command>setup.exe</command> parses and uses to create the
chooser window. For details about the format of this file, see chooser window. For details about the format of this file, see
the <ulink URL="http://sources.redhat.com/cygwin-apps/setup.html"> the <ulink url="http://sources.redhat.com/cygwin-apps/setup.html">
setup.exe homepage</ulink>. setup.exe homepage</ulink>.
</para> </para>
<para> <para>
@ -228,7 +228,7 @@ scripts to finish correctly setting up installed packages. Since each
script is run separately, several windows may pop up. If you are script is run separately, several windows may pop up. If you are
interested in what is being done, see the Cygwin Package Contributor's interested in what is being done, see the Cygwin Package Contributor's
Guide at <ulink Guide at <ulink
URL="http://cygwin.com/setup.html">http://cygwin.com/setup.html</ulink> url="http://cygwin.com/setup.html">http://cygwin.com/setup.html</ulink>
When the last post-install script is completed, <command>setup.exe</command> When the last post-install script is completed, <command>setup.exe</command>
will display a box announcing the completion. A few packages, such as will display a box announcing the completion. A few packages, such as
the OpenSSH server, require some manual site-specific configuration. the OpenSSH server, require some manual site-specific configuration.

2
winsup/doc/setup2.sgml
View File

@ -73,7 +73,7 @@ and set it to the desired memory limit in decimal MB. It is preferred to do
this in Cygwin using the <command>regtool</command> program included in the this in Cygwin using the <command>regtool</command> program included in the
Cygwin package. Cygwin package.
(For more information about <command>regtool</command> or the other Cygwin (For more information about <command>regtool</command> or the other Cygwin
utilities, see <Xref Linkend="using-utils"> or use each the utilities, see <xref linkend="using-utils"></xref> or use each the
<literal>--help</literal> option of each util.) You should always be careful <literal>--help</literal> option of each util.) You should always be careful
when using <command>regtool</command> since damaging your system registry can when using <command>regtool</command> since damaging your system registry can
result in an unusable system. This example sets memory limit to 1024 MB: result in an unusable system. This example sets memory limit to 1024 MB:

12
winsup/doc/textbinary.sgml
View File

@ -33,7 +33,7 @@ other programs (such as <command>cat</command>, <command>cmp</command>,
<para>The Cygwin system gives us some flexibility in deciding how files <para>The Cygwin system gives us some flexibility in deciding how files
are to be opened when the mode is not specified explicitly. are to be opened when the mode is not specified explicitly.
The rules are evolving, this section gives the design goals.</para> The rules are evolving, this section gives the design goals.</para>
<OrderedList Numeration="Loweralpha"> <orderedlist numeration="loweralpha">
<listitem> <listitem>
<para>If the file appears to reside on a file system that is mounted <para>If the file appears to reside on a file system that is mounted
(i.e. if its pathname starts with a directory displayed by (i.e. if its pathname starts with a directory displayed by
@ -48,11 +48,11 @@ applies.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Pipes and non-file devices are opened in binary mode, <para>Pipes and non-file devices are opened in binary mode,
except if the <EnVar>CYGWIN</EnVar> environment variable contains except if the <envar>CYGWIN</envar> environment variable contains
<literal>nobinmode</literal>.</para> <literal>nobinmode</literal>.</para>
<warning><Title>Warning!</Title><para>In b20.1 of 12/98, a file will be opened <warning><title>Warning!</title><para>In b20.1 of 12/98, a file will be opened
in binary mode if any of the following conditions hold:</para> in binary mode if any of the following conditions hold:</para>
<OrderedList Numeration="arabic" Spacing="Compact"> <orderedlist numeration="arabic" spacing="compact">
<listitem><para>binary mode is specified in the open call</para> <listitem><para>binary mode is specified in the open call</para>
</listitem> </listitem>
<listitem><para><envar>CYGWIN</envar> contains <literal>binmode</literal></para> <listitem><para><envar>CYGWIN</envar> contains <literal>binmode</literal></para>
@ -61,7 +61,7 @@ in binary mode if any of the following conditions hold:</para>
</listitem> </listitem>
<listitem><para>the file is not a disk file</para> <listitem><para>the file is not a disk file</para>
</listitem> </listitem>
</OrderedList> </orderedlist>
</warning> </warning>
</listitem> </listitem>
@ -78,7 +78,7 @@ non-Cygwin shells the commands <command> cat filename | program </command>
and <command> program &lt; filename </command> are not equivalent when and <command> program &lt; filename </command> are not equivalent when
<filename>filename</filename> is on a text-mounted partition. </para> <filename>filename</filename> is on a text-mounted partition. </para>
</listitem> </listitem>
</OrderedList> </orderedlist>
</sect2> </sect2>
<sect2><title>Example</title> <sect2><title>Example</title>

14
winsup/utils/utils.sgml
View File

@ -34,7 +34,7 @@ dealing with Cygwin programs. If you are familiar with
<command>dpkg</command> or <command>rpm</command>, <command>dpkg</command> or <command>rpm</command>,
<command>cygcheck</command> is similar in many ways. (The major difference <command>cygcheck</command> is similar in many ways. (The major difference
is that <command>setup.exe</command> handles installing and uninstalling is that <command>setup.exe</command> handles installing and uninstalling
packages; see <xref linkend="internet-setup"> for more information.) packages; see <xref linkend="internet-setup"></xref> for more information.)
</para> </para>
<para> <para>
The <literal>-c</literal> option checks the version and status of The <literal>-c</literal> option checks the version and status of
@ -287,7 +287,7 @@ ACL. For directories <command>getfacl</command> displays additionally the
default ACL. With no options specified, <command>getfacl</command> displays default ACL. With no options specified, <command>getfacl</command> displays
the filename, the owner, the group, and both the ACL and the default ACL, if the filename, the owner, the group, and both the ACL and the default ACL, if
it exists. For more information on Cygwin and Windows ACLs, see it exists. For more information on Cygwin and Windows ACLs, see
see <Xref Linkend="ntsec"> in the Cygwin User's Guide. see <xref linkend="ntsec"></xref> in the Cygwin User's Guide.
The format for ACL output is as follows: The format for ACL output is as follows:
<screen> <screen>
# file: filename # file: filename
@ -465,7 +465,7 @@ The <literal>-o</literal> option allows for special cases
(such as multiple domains) where the GIDs might match otherwise. (such as multiple domains) where the GIDs might match otherwise.
The <literal>-s</literal> The <literal>-s</literal>
option omits the NT Security Identifier (SID). For more information on option omits the NT Security Identifier (SID). For more information on
SIDs, see <Xref Linkend="ntsec"> in the Cygwin User's Guide. The SIDs, see <xref linkend="ntsec"></xref> in the Cygwin User's Guide. The
<literal>-u</literal> option causes <command>mkgroup</command> to <literal>-u</literal> option causes <command>mkgroup</command> to
enumerate the users for each group, placing the group members in the enumerate the users for each group, placing the group members in the
gr_mem (last) field. Note that this can greatly increase gr_mem (last) field. Note that this can greatly increase
@ -543,7 +543,7 @@ file ownership. The <literal>-m</literal> option bypasses the current
mount table so that, for example, two users who have a Windows home mount table so that, for example, two users who have a Windows home
directory of H: could mount them differently. The <literal>-s</literal> directory of H: could mount them differently. The <literal>-s</literal>
option omits the NT Security Identifier (SID). For more information on option omits the NT Security Identifier (SID). For more information on
SIDs, see <Xref Linkend="ntsec"> in the Cygwin User's Guide. The SIDs, see <xref linkend="ntsec"></xref> in the Cygwin User's Guide. The
<literal>-p</literal> option causes <command>mkpasswd</command> to <literal>-p</literal> option causes <command>mkpasswd</command> to
use the specified prefix instead of the account home dir or <literal>/home/ use the specified prefix instead of the account home dir or <literal>/home/
</literal>. For example, this command: </literal>. For example, this command:
@ -591,7 +591,7 @@ Display information about mounted filesystems, or mount a filesystem
<para>The <command>mount</command> program is used to map your drives <para>The <command>mount</command> program is used to map your drives
and shares onto Cygwin's simulated POSIX directory tree, much like as is and shares onto Cygwin's simulated POSIX directory tree, much like as is
done by mount commands on typical UNIX systems. Please see done by mount commands on typical UNIX systems. Please see
<Xref Linkend="mount-table"> for more information on the concepts <xref linkend="mount-table"></xref> for more information on the concepts
behind the Cygwin POSIX file system and strategies for using behind the Cygwin POSIX file system and strategies for using
mounts. To remove mounts, use <command>umount</command></para> mounts. To remove mounts, use <command>umount</command></para>
@ -1066,7 +1066,7 @@ For each file given as parameter, <command>setfacl</command> will
either replace its complete ACL (<literal>-s</literal>, <literal>-f</literal>), either replace its complete ACL (<literal>-s</literal>, <literal>-f</literal>),
or it will add, modify, or delete ACL entries. or it will add, modify, or delete ACL entries.
For more information on Cygwin and Windows ACLs, see For more information on Cygwin and Windows ACLs, see
see <Xref Linkend="ntsec"> in the Cygwin User's Guide. see <xref linkend="ntsec"></xref> in the Cygwin User's Guide.
</para> </para>
<para> <para>
@ -1490,7 +1490,7 @@ mounts in the current user's registry area (<literal>-U</literal>),
or all mounts in the system-wide registry area (<literal>-S</literal>) or all mounts in the system-wide registry area (<literal>-S</literal>)
(with Administrator privileges).</para> (with Administrator privileges).</para>
<para>See <Xref Linkend="mount"> for more information on the mount <para>See <xref linkend="mount"></xref> for more information on the mount
table.</para> table.</para>
</sect2> </sect2>