newlib-cygwin/winsup/doc
Jon TURNEY 646745cbf3 winsup/doc: Convert utils.xml to using refentry elements
Convert utils.xml from using a sect2 element to using a refentry element for
each utility program.  This makes it possible to generate manpage-style output
for those elements.

Note that the chunked html now generates a page for each utility, rather than
one containing all utilities.

A small customization to TOC generation for HTML and PDF is needed to ensure
that it appears as before, containing an entry for each utility command.

Future work: synopsis and options sections could use more detailed markup than
just wrapping the whole thing in <screen>

2015-06-12  Jon Turney  <jon.turney@dronecode.org.uk>

	* utils.xml : Convert from using a sect2 element to using a
	refentry element for each utility program.
	* cygwin.xsl: Customize autotoc to include refentries.
	* fo.xsl: Ditto.

Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
2015-06-16 18:28:40 +01:00
..
.gitignore mv .cvsignore to .gitignore 2015-03-09 21:40:26 +01:00
ChangeLog winsup/doc: Convert utils.xml to using refentry elements 2015-06-16 18:28:40 +01:00
Makefile.in winsup/doc: Fix an issue with parallel make 2015-06-16 10:29:28 +01:00
README whitespace fix 2015-03-10 16:07:07 +01:00
Wishlist . 2013-05-23 19:03:19 +00:00
aclocal.m4 update to newer autoconf 2006-05-24 16:59:03 +00:00
bodysnatcher.pl Generating faq/faq.body automatically from faq/faq.html whenever latter 2013-05-02 00:10:15 +00:00
configure * Makefile.in: Create install targets. 2014-10-22 20:04:42 +00:00
configure.ac * Makefile.in: Create install targets. 2014-10-22 20:04:42 +00:00
cygserver.xml cygserver.xml: Add new section. How to install Cygserver. 2015-04-27 11:32:25 +02:00
cygwin-api.xml * cygwin-api.xml: Include misc-funcs.xml. 2014-08-14 20:47:14 +00:00
cygwin-ug-net.xml winsup/doc: Some preparatory XML fixes 2015-06-16 10:20:06 +01:00
cygwin.xsl winsup/doc: Convert utils.xml to using refentry elements 2015-06-16 18:28:40 +01:00
cygwinenv.xml * Throughout, replace http with https as far as cygwin.com and 2015-02-03 13:48:43 +00:00
dll.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
effectively.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
faq-api.xml * Throughout, replace http with https as far as cygwin.com and 2015-02-03 13:48:43 +00:00
faq-copyright.xml * Throughout, replace http with https as far as cygwin.com and 2015-02-03 13:48:43 +00:00
faq-programming.xml Change CVS->GIT in docs 2015-03-10 14:19:42 +01:00
faq-resources.xml * Throughout, replace http with https as far as cygwin.com and 2015-02-03 13:48:43 +00:00
faq-setup.xml Add FAQ entry on how Cygwin counters install and update MITM attacks 2015-04-23 21:57:11 +02:00
faq-using.xml Applied the "chgrp `id -g`" improvements suggested by Corinna for the FAQ 2015-02-25 17:41:23 +00:00
faq-what.xml * Throughout, replace http with https as far as cygwin.com and 2015-02-03 13:48:43 +00:00
faq.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
fhandler-tut.txt * fhandler-tut.txt: Update description to cygwin 1.5.13 2005-04-20 04:26:34 +00:00
filemodes.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
fo.xsl winsup/doc: Convert utils.xml to using refentry elements 2015-06-16 18:28:40 +01:00
gcc.xml * gcc.xml (gcc-64): Fix example. 2013-07-25 09:09:14 +00:00
gdb.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
highlights.xml * Throughout, replace http with https as far as cygwin.com and 2015-02-03 13:48:43 +00:00
legal.xml * Throughout, replace http with https as far as cygwin.com and 2015-02-03 13:48:43 +00:00
logon-funcs.xml * cygwin-api.xml: Move chapter tags from path.xml back here. 2014-08-14 20:15:49 +00:00
misc-funcs.xml Fix documentation of cygwin_internal()'s return type. 2015-04-23 21:57:09 +02:00
new-features.xml Bump Cygwin version to 2.0.0. 2015-04-23 21:58:33 +02:00
ntsec.xml Fix more typos in ntsec.xml 2015-04-29 12:55:03 -05:00
ov-ex-unix.xml Remove mention of installing everything 2015-06-01 17:13:32 +01:00
ov-ex-win.xml Remove mention of installing everything 2015-06-01 17:13:32 +01:00
overview.xml * Throughout, replace http with https as far as cygwin.com and 2015-02-03 13:48:43 +00:00
path.xml * cygwin-api.xml: Move chapter tags from path.xml back here. 2014-08-14 20:15:49 +00:00
pathnames.xml Fix inconsistencies in docs regarding fstab and executable file detection 2015-04-23 22:02:47 +02:00
posix.xml cygwin: add GNU basename(3) 2015-04-23 21:57:08 +02:00
programming.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
setup-env.xml * setup-files.xml (setup-files): Drop hint to set HOME in Windows 2015-02-16 10:23:01 +00:00
setup-files.xml * setup-files.xml (setup-files): Drop hint to set HOME in Windows 2015-02-16 10:23:01 +00:00
setup-locale.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
setup-maxmem.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
setup-net.xml Change CVS->GIT in docs 2015-03-10 14:19:42 +01:00
specialnames.xml * new-features.sgml (ov-new1.7.22): New section. Document dropped 2013-07-15 14:00:32 +00:00
textbinary.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
ug-info.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
using.xml * Makefile.in: Throughout use parenthesis instead of braces where 2014-08-14 19:44:29 +00:00
utils.xml winsup/doc: Convert utils.xml to using refentry elements 2015-06-16 18:28:40 +01:00
windres.xml Modernized user guide, API reference, and FAQ generation. Overall 2013-05-01 23:30:25 +00:00
xidepend winsup/doc: Make it easier to extend xidepend to more targets 2015-06-16 10:28:49 +01:00

README

The cygwin-doc source files are kept in CVS. Please see
https://cygwin.com/cvs.html for more information.

BUILD REQUIREMENTS:

bash
bzip2
coreutils
cygwin
dblatex
docbook-xml45
docbook-xsl
gzip
make
texinfo
perl
xmlto

OTHER NOTES:

You may use docbook2X to convert the DocBook files into info pages.
I have not been able to get a working docbook2X installation on Cygwin,
so currently I convert the files on a machine running GNU/Linux.

A few handmade files (cygwin.texi, intro.3, etc.) are found in the
cygwin-doc-x.y-z-src.tar.bz2 package. It also contains the utilities for
building the cygwin-doc-x.y-z "binary" package--simply run each step in
the cygwin-doc-x.y-z.sh script.