From 05357ffef2e0c5c5715d868500bc001d6f39800a Mon Sep 17 00:00:00 2001 From: DJ Delorie Date: Wed, 19 Apr 2000 00:55:19 +0000 Subject: [PATCH] clean up SGML for latest version of jade/docbook --- winsup/cygwin/misc-std.sgml | 5 +++-- winsup/cygwin/posix.sgml | 14 ++++++++++++-- winsup/doc/Makefile.in | 10 ++++++---- winsup/doc/overview.sgml | 8 ++++---- winsup/doc/pathnames.sgml | 8 ++++++-- winsup/doc/setup-net.sgml | 4 ++-- winsup/doc/setup.sgml | 6 +++++- winsup/doc/setup2.sgml | 2 +- winsup/utils/utils.sgml | 6 ++++-- 9 files changed, 43 insertions(+), 20 deletions(-) diff --git a/winsup/cygwin/misc-std.sgml b/winsup/cygwin/misc-std.sgml index de47d14d2..01ac231cd 100644 --- a/winsup/cygwin/misc-std.sgml +++ b/winsup/cygwin/misc-std.sgml @@ -5,7 +5,7 @@ standards: -Networking +Networking (Standardized by POSIX 1.g, which is probably still in draft?) @@ -38,6 +38,7 @@ strsignal, strtosigno, swab, syslog, timezone, truncate, ttyslot, unlockpt, unsetenv, usleep, utimes, vfork, vhangup, wait3, wait4, wcscmp, wcslen, wprintf, writev + Implementation Notes initgroups does nothing @@ -59,7 +60,7 @@ An increment above REALTIME_PRIORITY_CLASS results in the process staying at that priority. Likewise, a decrement to IDLE_PRIORITY_CLASS has it stay at that priority. Note that in the Win32 API, there are 32 priorities. So currently we only give access -to four of these through nice. +to four of these through nice. seteuid and setegid always return 0 and set errno to diff --git a/winsup/cygwin/posix.sgml b/winsup/cygwin/posix.sgml index 5d00f5709..80e9c6e97 100644 --- a/winsup/cygwin/posix.sgml +++ b/winsup/cygwin/posix.sgml @@ -10,27 +10,32 @@ _exit, kill, sigemptyset, sigfillset, sigaddset, sigdelset, sigismember, sigaction, pthread_sigmask, sigprocmask, sigpending, sigsuspend, alarm, pause, sleep, pthread_kill, pthread_sigmask + Process Environment (Section 4) getpid, getppid, getuid, geteuid, getgid, getegid, setuid, setgid, getgroups, getlogin, getpgrp, setsid, setpgid, uname, time, times, getenv, ctermid, ttyname, isatty, sysconf + Files and Directories (Section 5) opendir, readdir, rewinddir, closedir, chdir, getcwd, open, creat, umask, link, mkdir, unlink, rmdir, rename, stat, fstat, access, chmod, fchmod, chown, utime, ftruncate, pathconf, fpathconf + Input and Output Primitives (Section 6) pipe, dup, dup2, close, read, write, fcntl, lseek, fsync + Device- and Class-Specific Functions (Section 7) cfgetispeed, cfgetospeed, cfsetispeed, cfsetospeed, tcdrain, tcflow, tcflush, tcgetattr, tcgetpgrp, tcsendbreak, tcsetattr, tcsetpgrp + Language-Specific Services for the C Programming Language (Section 8) abort, exit, fclose, fdopen, fflush, fgetc, fgets, fileno, fopen, @@ -39,32 +44,37 @@ getc, getchar, gets, perror, printf, putc, putchar, puts, remove, rewind, scanf, setlocale, siglongjmp, sigsetjmp, tmpfile, tmpnam, tzset + System Databases (Section 9) getgrgid, getgrnam, getpwnam, getpwuid + Synchronization (Section 11) sem_init, sem_destroy, sem_wait, sem_trywait, sem_post, pthread_mutex_init, pthread_mutex_destroy, pthread_mutex_lock, pthread_mutex_trylock, pthread_mutex_unlock + Memory Management (Section 12) mmap, mprotect, msync, munmap + Thread Management (Section 16) pthread_attr_init, pthread_attr_destroy, pthread_attr_setstacksize, pthread_attr_getstacksize, pthread_create, pthread_exit, pthread_self, pthread_equal + Thread-Specific Data Functions (Section 17) pthread_key_create, pthread_setspecific, pthread_getspecific, pthread_key_delete - + Implementation Details @@ -85,4 +95,4 @@ files. - \ No newline at end of file + diff --git a/winsup/doc/Makefile.in b/winsup/doc/Makefile.in index 74c0be821..988f388a6 100644 --- a/winsup/doc/Makefile.in +++ b/winsup/doc/Makefile.in @@ -11,6 +11,8 @@ SHELL = @SHELL@ srcdir = @srcdir@ VPATH = @srcdir@ +SGMLDIRS = -d $(srcdir) -d $(utils_source) -d $(cygwin_source) + DOC=faq.txt faq.info readme.txt readme.info HTMLDOC=faq.html readme.html @@ -46,25 +48,25 @@ cygwin-ug/cygwin-ug.html : cygwin-ug.sgml doctool -db2html $< cygwin-ug.sgml : cygwin-ug.in.sgml ./doctool Makefile - -./doctool -m -d $(srcdir) -d $(utils_source) -s $(srcdir) -o $@ $< + -./doctool -m $(SGMLDIRS) -s $(srcdir) -o $@ $< cygwin-ug-net/cygwin-ug-net.html : cygwin-ug-net.sgml doctool -db2html $< cygwin-ug-net.sgml : cygwin-ug-net.in.sgml ./doctool Makefile - -./doctool -m -d $(srcdir) -d $(utils_source) -s $(srcdir) -o $@ $< + -./doctool -m $(SGMLDIRS) -s $(srcdir) -o $@ $< cygwin-api/cygwin-api.html : cygwin-api.sgml -db2html $< cygwin-api.sgml : cygwin-api.in.sgml ./doctool Makefile - -./doctool -m -d $(srcdir) -d $(utils_source) -s $(srcdir) -o $@ $< + -./doctool -m $(SGMLDIRS) -s $(srcdir) -o $@ $< cygwin-api-int/cygwin-api-int.html : cygwin-api-int.sgml -db2html $< cygwin-api-int.sgml : cygwin-api.in.sgml ./doctool Makefile - -./doctool -i -m -d $(srcdir) -d $(utils_source) -s $(srcdir) -b cygwin-api-int -o $@ $< + -./doctool -i -m $(SGMLDIRS) -s $(srcdir) -b cygwin-api-int -o $@ $< ./doctool : doctool.c gcc -g $< -o $@ diff --git a/winsup/doc/overview.sgml b/winsup/doc/overview.sgml index ea476dd49..4b48094aa 100644 --- a/winsup/doc/overview.sgml +++ b/winsup/doc/overview.sgml @@ -1,6 +1,6 @@ Cygwin Overview -What is it? +What is it? The Cygwin tools are ports of the popular GNU development tools and utilities for Windows NT and 9x. They function through the @@ -20,7 +20,7 @@ from the bash shell (provided) or from the command.com. -Are the Cygwin tools free software? +Are the Cygwin tools free software? Yes. Parts are GNU software (gcc, gas, ld, etc...), parts are covered by the standard X11 license, some of it is public domain, @@ -38,7 +38,7 @@ sent to the project mailing list cygwin@sourceware.cygnus.com. -A brief history of the Cygwin project +A brief history of the Cygwin project The first thing done was to enhance the development tools (gcc, gdb, gas, et al) so that they could generate/interpret Win32 native @@ -72,7 +72,7 @@ the GNU configure mechanism. Self hosting was achieved as of the beta DOCTOOL-INSERT-ov-ex-unix DOCTOOL-INSERT-ov-ex-win -Highlights of Cygwin Functionality +Highlights of Cygwin Functionality DOCTOOL-INSERT-ov-hi-intro DOCTOOL-INSERT-ov-hi-win9xnt DOCTOOL-INSERT-ov-hi-perm diff --git a/winsup/doc/pathnames.sgml b/winsup/doc/pathnames.sgml index 2338b18ff..a302e7c96 100644 --- a/winsup/doc/pathnames.sgml +++ b/winsup/doc/pathnames.sgml @@ -109,7 +109,7 @@ largely on how closely you want to simulate a POSIX environment, whether you mix Windows and Cygwin programs, and how many drive letters you are using. If you want to be very POSIX-like (assuming "CygwinRoot" is the top directory of your Cygwin distribution), you may -want to do something like this: +want to do something like this: POSIX-like mount setup @@ -186,6 +186,8 @@ default printer with the command cat filename > PRN (make sure to end with a Form Feed). + + POSIX devices There is no need to create a POSIX /dev directory as it is simulated within Cygwin automatically. @@ -200,6 +202,8 @@ mounted by default, such as /dev/fd1. What do they really do? + + The .exe extension Executable program filenames end with .exe but the .exe need @@ -254,7 +258,7 @@ starting with "@" in a special way. If a file file to delimit strings containing blank space. Embedded double quotes must be repeated. In the following example compare the behaviors of the bash built-in -echo and of the program /bin/echo. +echo and of the program /bin/echo. Using @pathname diff --git a/winsup/doc/setup-net.sgml b/winsup/doc/setup-net.sgml index 184233026..b947129d6 100644 --- a/winsup/doc/setup-net.sgml +++ b/winsup/doc/setup-net.sgml @@ -16,7 +16,7 @@ grep, gzip, less, m4, sed, shellutils, tar, textutils, time Full source code is available for these tools. -Installing the binary release +Installing the binary release Important! Be sure to remove any older versions of the Cygwin tools from your PATH environment variable so you do @@ -77,7 +77,7 @@ instructions in the next section, else go directly to to complete your system setup. -Installing the source code +Installing the source code Before downloading the source code corresponding to the release, you should install the latest release of the tools (either the full diff --git a/winsup/doc/setup.sgml b/winsup/doc/setup.sgml index 2e6ce2857..f25b5c594 100644 --- a/winsup/doc/setup.sgml +++ b/winsup/doc/setup.sgml @@ -13,7 +13,9 @@ tcl, tix, tk findutils, gawk, grep, gzip, m4, sed, shellutils, tar, textutils, time -Installing the binary release + + +Installing the binary release Load the GNUPro CD-ROM and run the installer. It will take you through the installation process, starting with asking for @@ -35,6 +37,8 @@ drive letter is mounted as `/'. If you should ever want to uninstall the tools, you may do so via the "Add/Remove Programs" control panel. + + DOCTOOL-INSERT-setup-dir DOCTOOL-INSERT-setup-env DOCTOOL-INSERT-setup-reg diff --git a/winsup/doc/setup2.sgml b/winsup/doc/setup2.sgml index 7a24e5fa1..237c6eacb 100644 --- a/winsup/doc/setup2.sgml +++ b/winsup/doc/setup2.sgml @@ -269,7 +269,7 @@ set output-meta on # Ignore case while completing set completion-ignore-case on -The first three commands allow bash to display 8-bit characters, +The first three commands allow bash to display 8-bit characters, useful for languages with accented characters. The last line makes filename completion case insensitive, which can be convenient in a Windows environment. diff --git a/winsup/utils/utils.sgml b/winsup/utils/utils.sgml index e045e6abb..5fe8cc846 100644 --- a/winsup/utils/utils.sgml +++ b/winsup/utils/utils.sgml @@ -424,7 +424,7 @@ path location. text files in the same manner by default. Binary mode mounts are marked as "binmode" in the Flags column of mount output. By default, mounts are in text mode ("textmode" in the Flags -column). +column). The "-x" flag is used to instruct Cygwin that the mounted file is "executable". If the "-x" flag is used with a directory then @@ -433,7 +433,7 @@ extensions (.exe, .com, .bat, .cmd) are assumed to be executable by default. Files whose first two characters begin with '#!' are also considered to be executable. This option allows other files to be marked as executable and avoids the overhead of opening each -file to check for a '#!'. +file to check for a '#!'. @@ -467,6 +467,8 @@ default, the cygdrive-prefix applies only to the current user. In the same way, you can specify the "-b" flag such that all new automounted filesystems default to binary mode file accesses. + + Limitations Limitations: there is a hard-coded limit of 30 mount