Mon Mar 31 19:51:40 CST 2003
Joshua Daniel Franklin <joshuadfranklin@yahoo.com>

cygwin-doc
------------------------------------------
History:

2003-09-04 Joshua Daniel Franklin
	-version 1.3-6

	-(Joshua Daniel Franklin)
	Move docs to /usr/share/* to conform

2003-08-27 Joshua Daniel Franklin
	-version 1.3-5

	-(Joshua Daniel Franklin)
	Add section "Using Cygwin Effectively with Windows"

2003-05-08 Joshua Daniel Franklin
	-version 1.3-4

	-(Joshua Daniel Franklin)
	Add one-HTML-file and PDF versions of the User's Guide
	
	-(Pierre Humblet) 
	* utils.sgml: Update mkpasswd and mkgroup documentation
	<http://cygwin.com/ml/cygwin-patches/2003-q2/msg00017.html>

	-(BB)
	* gcc.sgml: Add hellogui.c sample program
	<http://cygwin.com/ml/cygwin/2003-04/msg00692.html>

	-(Joshua Daniel Franklin)
	Add .SH NAME section in man pages.
	Thanks to Andy Lindsay <andy_cyg at ananam dot com>
	<http://cygwin.com/ml/cygwin/2003-04/msg01224.html>

2003-03-31 Joshua Daniel Franklin
	-version 1.3-3

	-(Joshua Daniel Franklin) 
	* setup-net.sgml: Add documentation for setup.exe
	Thanks to Rob Collins, Christopher Faylor, Pierre Humblet, Elfyn 
	McBratney, Hannu E K Nevalainen, Igor Pechtchanski, and Randall Schulz
	<http://www.cygwin.com/ml/cygwin/2003-03/msg01569.html>

	-Generate info files with docbook2X on Debian (see cygwin-info/README)

	-(Christopher Faylor) Fix typo in 'mount' documentation
	Thanks to Dwight Wilcox for noticing this.
	<http://cygwin.com/ml/cygwin/2003-03/msg00831.html>

	-(Joshua Daniel Franklin) 
	* setup-net.sgml: Add "setup-maxmem" section 
	* setup2.sgml: New section "setup-maxmem" to document heap_chunk_in_mb
	<http://cygwin.com/ml/cygwin-patches/2003-q1/msg00168.html>

	-(Pierre A. Humblet) Document '-c' option to mkgroup and mkpasswd
	<http://cygwin.com/ml/cygwin-patches/2003-q1/msg00310.html

	-(Joshua Daniel Franklin) 
        * cygwinenv.sgml: Add section for "CYGWIN codepage:[ansi|oem]"
        * dll.sgml: Add pointer to GCC website for more information
        * utils.sgml: Update regtool for -K,--key-separator option
	<http://cygwin.com/ml/cygwin-patches/2003-q1/msg00125.html>

2003-01-20 Joshua Daniel Franklin
	-version 1.3-2
	-fixed postinstall script bug (refered to version 1.2 instead of 1.3)
2003-01-13 Joshua Daniel Franklin
	-version 1.3-1
	-updated from latest cygwin CVS
	-easier build configuration
2002-10-17 Joshua Daniel Franklin
	-version 1.2-1
	-added texinfo versions of the User's Guide and API Reference
	-began using bzip2 compression on installed files
2002-08-04 Joshua Daniel Franklin
	-version 1.1-2
	-fixed typos in install scripts 
2002-07-31 Joshua Daniel Franklin
	-version 1.1-1
	-first inclusion of newlib-man and cygwin-users-guide
2002-04-13 Joshua Daniel Franklin
	-version 1.0-1
	-first release, cygwin-man only

-------------------------------------------

The cygwin-doc package has 4 separate and mutually exclusive parts:
cygwin-info, cygwin-man, cygwin-users-guide, and newlib-man. 
Each has a separate directory. They build separately. With the exception
of cygwin-users-guide (for reasons described below), everything you
need to build custom versions is contained in this package or in the
build requirement listed below. See the individual README files for
more information.

-------------------------------------------

(cygwin-info)
BUILD REQUIREMENTS:

ash
bzip2
cygwin
make
texinfo

BUILD INSTRUCTIONS:

Type 'make' or 'make all' to build.  To install, 'make install'.

The cygwin.texi file was written by hand to provide an entry point.
The other texi files were produced with docbook2X from the official
Cygwin SGML DocBook found in CVS. I do not have a working docbook2X
installation, so currently I merge by hand any changes in the CVS
into the texi files.

-------------------------------------------

(cygwin-man)
BUILD REQUIREMENTS:

ash
bzip2
cygwin
fileutils
make
perl 
textutils

BUILD INSTRUCTIONS:

Type 'make' or 'make all' to build the man pages. If you only want to
build one section, try 'make man1' or 'make man3'. To install, 
'make install'. That's all you really need to know.

If you have the cygwin CVS on your machine, you can edit the 
CYGWIN_SRC line in the Makefile and run 'make upgrade'. This will 
_replace_ the SGML files with ones from the your copy of the CVS.

The two intro pages (intro.1 and intro.3) were written by hand by me.
The rest of the cygwin man pages are autogenerated from the SGML files
found in CVS. I wrote perl scripts do this in my spare time over a few
evenings. They are not robust. They will not work for other SGML files.
(In fact, note that separate scripts are necessary for the API man pages
and the utils.) Changes to the SGML files will probably break the scripts.

-------------------------------------------

(cygwin-users-guide)
The packages required to build the Cygwin user's guide are unfortunately
not yet part of the Cygwin distribution. For a time, there were testing
packages available for DocBook on Cygwin, but they are no longer available.
For a limited time only, they can be downloaded by adding as a mirror:

http://ns1.iocc.com/~joshua/cygwin/docbook/

and selecting "cygwin-doc-build" from the "Doc" category.
This will pull in all required packages. (Warning: this includes
some large packages, including binutils, gcc, perl, and tetex).

Then, run /usr/bin/cygwin-doc-build and follow the instructions.

-------------------------------------------

(newlib-man)
BUILD REQUIREMENTS:

ash
bzip2
cygwin
fileutils
make
perl 

BUILD INSTRUCTIONS:

Type 'make' or 'make all' to build the man pages. All the pages are in
section 3. To install, 'make install'.

If you have updated versions of the lib?.info* files on your machine, 
such as from the newlib CVS, you can edit the appropriate lines in 
getnewlibinfo.pl and run 'make upgrade'. This will _replace_ the info files
with ones from your copy of the CVS.

I wrote the perl scripts do this in my spare time over a few
evenings. They are not robust. They will not work for other info files.
They will probably kill your pets and cause earthquakes. You are warned.
