diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog index 384b85179..0795510a5 100644 --- a/winsup/doc/ChangeLog +++ b/winsup/doc/ChangeLog @@ -1,3 +1,23 @@ +2004-12-24 Joshua Daniel Franklin + + * 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 * cygserver.sgml: Cleanup minor markup problem. diff --git a/winsup/doc/cygserver.sgml b/winsup/doc/cygserver.sgml index 101e29b84..27e538b2a 100644 --- a/winsup/doc/cygserver.sgml +++ b/winsup/doc/cygserver.sgml @@ -11,7 +11,7 @@ The implemented services so far are: - + Control slave tty/pty handle dispersal from tty owner to other processes without compromising the owner processes' security. XSI IPC Message Queues. diff --git a/winsup/doc/cygwin-api.in.sgml b/winsup/doc/cygwin-api.in.sgml index d141935f6..08589402e 100644 --- a/winsup/doc/cygwin-api.in.sgml +++ b/winsup/doc/cygwin-api.in.sgml @@ -1,15 +1,6 @@ -1998Red Hat, Inc."> - - ]> + + diff --git a/winsup/doc/cygwin-ug-net.in.sgml b/winsup/doc/cygwin-ug-net.in.sgml index 634c9acab..c56ad8e14 100644 --- a/winsup/doc/cygwin-ug-net.in.sgml +++ b/winsup/doc/cygwin-ug-net.in.sgml @@ -1,17 +1,6 @@ -1999,2000,2001 - Red Hat, Inc."> - - ]> + + diff --git a/winsup/doc/cygwin-ug.in.sgml b/winsup/doc/cygwin-ug.in.sgml index 7727b1767..284d56bd1 100644 --- a/winsup/doc/cygwin-ug.in.sgml +++ b/winsup/doc/cygwin-ug.in.sgml @@ -1,6 +1,7 @@ -1999,2000,2001 - Red Hat, Inc."> + +1999,2000,2001 + Red Hat, Inc."> The <EnVar>CYGWIN</EnVar> environment +<sect1 id="using-cygwinenv"><title>The <envar>CYGWIN</envar> environment variable -The CYGWIN environment variable is used to configure +The CYGWIN environment variable is used to configure many global settings for the Cygwin runtime system. It contains the options listed below, separated by blank characters. Many options can be turned off by prefixing with no . - + (no)binmode - if set, non-disk (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. level is one of relaxed, adjust and strict. - + relaxed which is the default behaviour simply ignores case. That's the default for native Windows applications as well. @@ -111,15 +111,15 @@ If supplied, wildcard matching is case insensitive. The default is noi (no)ntea - 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. -Warning! This may create additional -large files on non-NTFS partitions. +Warning! This may create additional +large files on non-NTFS partitions. (no)ntsec - 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. Defaults to set. For more information, read -the documentation in . +the documentation in . (no)smbntsec - if set, use ntsec on remote diff --git a/winsup/doc/dll.sgml b/winsup/doc/dll.sgml index 803469367..d5578ff19 100644 --- a/winsup/doc/dll.sgml +++ b/winsup/doc/dll.sgml @@ -35,7 +35,7 @@ information needed to tell the OS how your program interacts with This page gives only a few simple examples of gcc's DLL-building capabilities. To begin an exploration of the many additional options, see the gcc documentation and website, currently at -http://gcc.gnu.org/ +http://gcc.gnu.org/ Let's go through a simple example of how to build a dll. @@ -100,7 +100,7 @@ The name of your library is ${module}, prefixed with cyg for the DLL and lib for the import library. Cygwin DLLs use the cyg prefix to differentiate them from native-Windows MinGW DLLs, see -the MinGW website for more details. +the MinGW website for more details. ${old_libs} are all your object files, bundled together in static libs or single object files and the ${dependency_libs} are import libs you @@ -113,7 +113,7 @@ need to link against, e.g If you have an existing DLL already, you need to build a Cygwin-compatible import library. If you have the source to compile -the DLL, see for details on having +the DLL, see for details on having gcc build one for you. If you do not have the 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 diff --git a/winsup/doc/effectively.sgml b/winsup/doc/effectively.sgml index 3812bf3e3..fd0c0d447 100644 --- a/winsup/doc/effectively.sgml +++ b/winsup/doc/effectively.sgml @@ -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 Support Tools), Windows 2000 (the Resource Kit Tools), and XP (the Windows Support Tools). Additionally, many independent sites such as -download.com, -simtel.net, -and sysinternals.com +download.com, +simtel.net, +and sysinternals.com provide command-line utilities. A few Windows tools, such as find.exe and sort.exe, may conflict with the Cygwin versions; make sure that you use the full path (/usr/bin/find) or that your Cygwin -bin directory comes first in your PATH. +bin directory comes first in your PATH. Pathnames @@ -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 translated. Cygwin provides the cygpath utility for converting between Windows and POSIX paths. A complete description of its -options and examples of its usage are in , +options and examples of its usage are in , including a shell script for starting Windows Explorer in any directory. The same format works for most Windows programs, for example @@ -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 command or script. Next would be to run bash with the default DOS box. To make Cygwin more Unix compatible in this case, -set CYGWIN=tty (see ). +set CYGWIN=tty (see ). Alternatively, the optional rxvt package provides a native-Windows version of the popular X11 terminal emulator (it is not -necessary to set CYGWIN=tty with rxvt). +necessary to set CYGWIN=tty with rxvt). Using rxvt.exe provides the most Unix-like environment, but expect some compatibility problems with Windows programs. @@ -116,9 +116,9 @@ Windows 95, 98, and ME) for automating dialup connections. Users who frequently change their network configuration can script these changes with netsh.exe (Windows 2000 and XP). For proxy users, the open source - + NTLM Authorization Proxy Server or the no-charge - + Hummingbird SOCKS Proxy may allow you to use Cygwin network programs in your environment. @@ -137,7 +137,7 @@ for interacting with Windows. One of the hassles of Unix-Windows interoperability is the different line -endings on text files. As mentioned in , +endings on text files. As mentioned in , Unix tools such as tr can convert between CRLF and LF endings, but cygutils provides several dedicated programs: conv, d2u, dos2unix, @@ -178,7 +178,7 @@ There are several options for printing from Cygwin, including the lpr found in cygutils (not to be confused with the native Windows lpr.exe). The easiest way to use cygutils' lpr is to specify a default device name in the -PRINTER environment variable. You may also specify a device +PRINTER environment variable. You may also specify a device on the command line with the -d or -P options, which will override the environment variable setting. @@ -202,7 +202,7 @@ text files for printing. The ghostscript package also provides some translation from PostScript to various native printer languages. Additionally, a native Windows application for printing PostScript, gsprint, is -available from the Ghostscript +available from the Ghostscript website. diff --git a/winsup/doc/filemodes.sgml b/winsup/doc/filemodes.sgml index b0bac2eef..5f34aac84 100644 --- a/winsup/doc/filemodes.sgml +++ b/winsup/doc/filemodes.sgml @@ -11,7 +11,7 @@ needs to open and read files. It can thus be relatively slow. Under NT, file permissions default to the same behavior as Windows 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 -the "ntea" option to the CYGWIN environment variable. +the "ntea" option to the CYGWIN environment variable. When the "ntea" feature is activated, Cygwin will start with basic 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 EA DATA. SF file 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 -Cygwin. Finally, note that specifying "ntea" in CYGWIN has no +Cygwin. Finally, note that specifying "ntea" in CYGWIN has no effect under Windows 9x. Under NT, the test "[ -w filename]" is only true if filename is diff --git a/winsup/doc/legal.sgml b/winsup/doc/legal.sgml index 531128e33..71ff3f96d 100644 --- a/winsup/doc/legal.sgml +++ b/winsup/doc/legal.sgml @@ -1,30 +1,30 @@ - + Copyright © 1998, 1999, 2000, 2001, 2002, 2003 Red Hat, Inc. - + diff --git a/winsup/doc/ntsec.sgml b/winsup/doc/ntsec.sgml index c9421fd23..c366fd21f 100644 --- a/winsup/doc/ntsec.sgml +++ b/winsup/doc/ntsec.sgml @@ -1,14 +1,14 @@ NT security and usage of <literal>ntsec</literal> The setting of UNIX like object permissions is controlled by the -CYGWIN environment +CYGWIN environment variable setting (no)ntsec which is set to ntsec by default. The design goal of ntsec is to get a more UNIX-like permission structure based upon the security features of Windows NT. To describe the changes, I will first give a short overview in -. +. discusses the changes in ntsec related to privileges on processes. diff --git a/winsup/doc/overview.sgml b/winsup/doc/overview.sgml index a6380ea33..12d906c5d 100644 --- a/winsup/doc/overview.sgml +++ b/winsup/doc/overview.sgml @@ -6,7 +6,7 @@ Cygwin is a Linux-like environment for Windows. It consists of a DLL (cygwin1.dll), which acts as an emulation layer providing substantial POSIX (Portable Operating +url="http://www.pasc.org/#POSIX">POSIX (Portable Operating System Interface) system call functionality, and a collection of tools, which provide a Linux look and feel. The Cygwin DLL works with all x86 versions of Windows since Windows 95. @@ -30,19 +30,19 @@ DOCTOOL-INSERT-ov-ex-unix Are the Cygwin tools free software? -Yes. Parts are GNU software +Yes. Parts are GNU software (gcc, gas, ld, etc.), parts are covered by the standard -X11 license, +X11 license, some of it is public domain, some of it was written by Red Hat and placed under -the GNU General Public +the GNU General Public License (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 information on how the GNU GPL may affect your use of these tools. If you intend to port a proprietary application using the Cygwin library, you may want the Cygwin proprietary-use license. For more information about the proprietary-use license, please go to -http://www.redhat.com/software/tools/cygwin/ +http://www.redhat.com/software/tools/cygwin/ . Customers of the native Win32 GNUPro should feel free to submit bug reports and ask questions through the normal channels. All other questions should be sent to the project mailing list @@ -55,9 +55,9 @@ questions should be sent to the project mailing list 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® Applications" which can be found at the +url="http://www.usenix.org/publications/library/proceedings/usenix-nt98/technical.html"> 2nd USENIX Windows NT Symposium Online Proceedings. @@ -96,7 +96,7 @@ the GNU configure mechanism. Self hosting was achieved as of the beta The entire Cygwin toolset was available as a monolithic install. In April 2000, the project announced a - + New Cygwin Net Release which provided the native Win32 program setup.exe to install and upgrade each package separately. Since then, the Cygwin DLL and setup.exe diff --git a/winsup/doc/overview2.sgml b/winsup/doc/overview2.sgml index 560bd8205..d2c2bac82 100644 --- a/winsup/doc/overview2.sgml +++ b/winsup/doc/overview2.sgml @@ -12,7 +12,7 @@ To install a basic Cygwin environment, run the setup.exe program and click Next at each page. The default settings are correct for most users. If you want to know more about what each option means, see -. Use setup.exe +. Use setup.exe 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 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 that cause Cygwin to behave differently than most UNIX-like operating systems; these are described in more detail in -. +. Any time you want to update or install a Cygwin package, use the @@ -55,9 +55,9 @@ graphical setup.exe program. By default, setup.exe only installs a minimal set of packages, so look around and choose your favorite utilities on the package selection screen. You may also search for specfic tools on the Cygwin -website's Setup Package +website's Setup Package Search For more information about what each option in -setup.exe means, see . +setup.exe means, see . Another option is to install everything by clicking on the diff --git a/winsup/doc/pathnames.sgml b/winsup/doc/pathnames.sgml index 5c804f539..ed98d27a8 100644 --- a/winsup/doc/pathnames.sgml +++ b/winsup/doc/pathnames.sgml @@ -33,7 +33,7 @@ program. For those people coming from a Windows background, the subdirectories somewhere else. The mapping is stored in the current user's Cygwin -mount table in the Windows registry so that the +mount table in the Windows registry so that the information will be retrieved next time the user logs in. Because it 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 @@ -82,7 +82,7 @@ e: on /cygdrive/e type user (binmode,noumount) You can also use the mount command to add new mount points, and the umount to delete -them. See and for more +them. See and for more information on how to use these utilities to set up your Cygwin POSIX file system. @@ -94,13 +94,13 @@ path /cygdrive. For example, if Cygwin accesses mount table, then Z:\ would be automatically converted to /cygdrive/Z. The default prefix of /cygdrive may be changed (see the - for more information). + for more information). It is possible to assign some special attributes to each mount point. Automatically mounted partitions are displayed as "auto" mounts. Mounts can also be marked as either "textmode" or "binmode" -- whether text files are read in the same manner as binary files by -default or not (see for more +default or not (see for more information on text and binary modes. @@ -109,10 +109,10 @@ information on text and binary modes. The cygpath program provides the ability to translate between Win32 and POSIX pathnames in shell scripts. See - for the details. + for the details. -The HOME, PATH, and -LD_LIBRARY_PATH environment variables are automatically +The HOME, PATH, and +LD_LIBRARY_PATH environment variables are automatically converted from Win32 format to POSIX format (e.g. from c:\cygwin\bin to /bin, if there was a mount from that Win32 path to that POSIX path) when a Cygwin diff --git a/winsup/doc/setup-net.sgml b/winsup/doc/setup-net.sgml index 2b787b6ef..dcbdffdb2 100644 --- a/winsup/doc/setup-net.sgml +++ b/winsup/doc/setup-net.sgml @@ -3,8 +3,8 @@ Internet Setup To install the Cygwin net release, go to http://cygwin.com/ and click on "Install Cygwin Now!". This will +url="http://cygwin.com/">http://cygwin.com/ and click on "Install Cygwin Now!". This will download a GUI installer called setup.exe which can be run to download a complete cygwin installation via the internet. Follow the instructions on each screen to install Cygwin. @@ -15,7 +15,7 @@ The setup.exe installer is designed to be easy for new users to understand while remaining flexible for the experienced. The volunteer development team is constantly working on setup.exe; before requesting a new feature, -check the wishlist in the CVS README +check the wishlist in the CVS README . It may already be present in the CVS version! @@ -25,13 +25,13 @@ most installations, you can get a working minimal Cygwin environment installed by simply clicking the Next button at each page. The only exception to this is choosing a Cygwin mirror, which you can choose by experimenting with those listed at - + http://cygwin.com/mirrors.html . For more details about each of page of the setup.exe installation, read on below. 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 -to make use of +to make use of other resources. @@ -129,7 +129,7 @@ authorization for proxy servers. 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 are geographically distributed around the world; check the list at http://cygwin.com/mirrors.html +url="http://cygwin.com/mirrors.html">http://cygwin.com/mirrors.html to find one near you. You can select multiple mirrors by holding down CTRL and clicking on each one. If you have the URL of an unlisted mirror (for example, if your organization has an internal Cygwin @@ -144,7 +144,7 @@ small text file called setup.bz2 that contains a list of packages available from that site along with some basic information about each package which setup.exe parses and uses to create the chooser window. For details about the format of this file, see -the +the setup.exe homepage. @@ -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 interested in what is being done, see the Cygwin Package Contributor's Guide at http://cygwin.com/setup.html +url="http://cygwin.com/setup.html">http://cygwin.com/setup.html When the last post-install script is completed, setup.exe will display a box announcing the completion. A few packages, such as the OpenSSH server, require some manual site-specific configuration. diff --git a/winsup/doc/setup2.sgml b/winsup/doc/setup2.sgml index a5a5c1663..bd1e8dec0 100644 --- a/winsup/doc/setup2.sgml +++ b/winsup/doc/setup2.sgml @@ -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 regtool program included in the Cygwin package. (For more information about regtool or the other Cygwin -utilities, see or use each the +utilities, see or use each the --help option of each util.) You should always be careful when using regtool since damaging your system registry can result in an unusable system. This example sets memory limit to 1024 MB: diff --git a/winsup/doc/textbinary.sgml b/winsup/doc/textbinary.sgml index 2e4dcd8a5..24b2a4c96 100644 --- a/winsup/doc/textbinary.sgml +++ b/winsup/doc/textbinary.sgml @@ -33,7 +33,7 @@ other programs (such as cat, cmp, The Cygwin system gives us some flexibility in deciding how files are to be opened when the mode is not specified explicitly. The rules are evolving, this section gives the design goals. - + If the file appears to reside on a file system that is mounted (i.e. if its pathname starts with a directory displayed by @@ -48,11 +48,11 @@ applies. Pipes and non-file devices are opened in binary mode, -except if the CYGWIN environment variable contains +except if the CYGWIN environment variable contains nobinmode. -Warning!In b20.1 of 12/98, a file will be opened +Warning!In b20.1 of 12/98, a file will be opened in binary mode if any of the following conditions hold: - + binary mode is specified in the open call CYGWIN contains binmode @@ -61,7 +61,7 @@ in binary mode if any of the following conditions hold: the file is not a disk file - + @@ -78,7 +78,7 @@ non-Cygwin shells the commands cat filename | program and program < filename are not equivalent when filename is on a text-mounted partition. - + Example diff --git a/winsup/utils/utils.sgml b/winsup/utils/utils.sgml index 9aed11b44..8011c0a34 100644 --- a/winsup/utils/utils.sgml +++ b/winsup/utils/utils.sgml @@ -34,7 +34,7 @@ dealing with Cygwin programs. If you are familiar with dpkg or rpm, cygcheck is similar in many ways. (The major difference is that setup.exe handles installing and uninstalling -packages; see for more information.) +packages; see for more information.) The -c option checks the version and status of @@ -287,7 +287,7 @@ ACL. For directories getfacl displays additionally the default ACL. With no options specified, getfacl displays 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 -see in the Cygwin User's Guide. +see in the Cygwin User's Guide. The format for ACL output is as follows: # file: filename @@ -465,7 +465,7 @@ The -o option allows for special cases (such as multiple domains) where the GIDs might match otherwise. The -s option omits the NT Security Identifier (SID). For more information on -SIDs, see in the Cygwin User's Guide. The +SIDs, see in the Cygwin User's Guide. The -u option causes mkgroup to enumerate the users for each group, placing the group members in the gr_mem (last) field. Note that this can greatly increase @@ -543,7 +543,7 @@ file ownership. The -m option bypasses the current mount table so that, for example, two users who have a Windows home directory of H: could mount them differently. The -s option omits the NT Security Identifier (SID). For more information on -SIDs, see in the Cygwin User's Guide. The +SIDs, see in the Cygwin User's Guide. The -p option causes mkpasswd to use the specified prefix instead of the account home dir or /home/ . For example, this command: @@ -591,7 +591,7 @@ Display information about mounted filesystems, or mount a filesystem The mount program is used to map your drives and shares onto Cygwin's simulated POSIX directory tree, much like as is done by mount commands on typical UNIX systems. Please see - for more information on the concepts + for more information on the concepts behind the Cygwin POSIX file system and strategies for using mounts. To remove mounts, use umount @@ -1066,7 +1066,7 @@ For each file given as parameter, setfacl will either replace its complete ACL (-s, -f), or it will add, modify, or delete ACL entries. For more information on Cygwin and Windows ACLs, see -see in the Cygwin User's Guide. +see in the Cygwin User's Guide. @@ -1490,7 +1490,7 @@ mounts in the current user's registry area (-U), or all mounts in the system-wide registry area (-S) (with Administrator privileges). -See for more information on the mount +See for more information on the mount table.