v2:
intro.1 and cygwin.1 are identical. Make cygwin.1 a link to intro.1
Update dates in static man pages
v3:
Use doclifter to convert intro.[13] to DocBook XML
Clean up markup and fix a couple of spelling mistakes.
Build and install manpages from XML
v4:
Update to refer to GPLv3+, SUSv4
Simplify ulinks where anchor text is the same as the URL
2015-06-22 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (intro2man.stamp): Add.
* intro.xml: New file.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
v2:
Updated to use docbook2x-texi not docbook2texi, since source is now docbook XML.
Tweak DocBook XML so info directory entry has a description.
v3:
Use a custom charmap to handle ®
v4:
Proper build avoidance
texinfo node references may not contain ':', so provide alternate text for a few
xref targets
2015-06-22 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (install-info, cygwin-ug-net.info)
(cygwin-api.info): Add.
* cygwin-ug-net.xml: Add texinfo-node.
* cygwin-api.xml: Ditto.
* ntsec.xml (db_home): Add texinfo-node for titles containing a
':' which are the targets of an xref.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
Fix a cut and paste error in the command to create the man3 install directory,
added in 94f16969
2015-06-19 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (install-man): Fix command to create man3 install
directory.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
2015-06-17 Jon Turney <jon.turney@dronecode.org.uk>
* man.xsl: New file.
* Makefile.in (utils2man.stamp, api2man.stamp): Use it.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
Use 'xmlto man' to make manpages for utils
This will generate multiple .1 files as an output, but we don't know what they
will be called, so use a timestamp for build avoidance
2015-06-17 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (api2man.stamp): Add rules to build and install
manpages for cygwin-api.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
Convert cygwin-api from using a sect2 element to using a refentry element for
each function. This makes it possible to generate manpage-style output for
those elements.
Note that the chunked html now generates a page for each function, rather than
one containing all functions.
Also:
Remove pointless and incorrect date
Move introductory paragraph from the first section to the start of the chapter
Add a funcsynopsisinfo element with the header file to be included to each
function prototype
Remove extern "C" which doesn't process into all formats successfully
2015-06-17 Jon Turney <jon.turney@dronecode.org.uk>
* cygwin-api.xml: Move introductory paragraph here.
* logon-funcs.xml: Convert from using a sect2 element to using a
refentry element for each function.
* misc-funcs.xml: Ditto.
* path.xml: Ditto.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
Since K&R style prototypes appear to be the default for HTML and FO, customize
the stylesheets rendering of funcsynopsis elements to generate ANSI style
prototypes instead.
2015-06-17 Jon Turney <jon.turney@dronecode.org.uk>
* fo.xsl: Render funcsynopsis elements as ANSI style function
prototypes.
* html.xsl: Ditto.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
For clarity, rename cygwin.xsl as html.xsl, because that's what it is
2015-06-17 Jon Turney <jon.turney@dronecode.org.uk>
* html.xsl: Renamed from cygwin.xsl.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
Use 'xmlto man' to make manpages for utils
(docbook2x-man could also be used, but since we already use xmlto...)
This will generate multiple .1 files as an output, but we don't know what they
will be called, so use a timestamp file for build avoidance when the
dependencies haven't changed.
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (install-man, utils2man.stamp): Add rules to build
and install manpages for utils.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
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>
The cygwin-ug-net-nochunks.html.gz target does not ensure that the
cygwin-ug-net/ directory exists, so it can fail if run on it's own, or if the
cygwin-ug-net/cygwin-ug-net.html target has not yet created it in a parallel
make.
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (cygwin-ug-net/cygwin-ug-net-nochunks.html.gz):
Ensure cygwin-ug-net directory exists.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
Change xidepend to create a variable containing all the XIncluded sources, which
can be used as a dependency, rather than writing the dependency target itself.
Future work: Makefile.dep should depend on xidepend, but xidepend should not be
passed to itself.
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* xidepend: Write a Makefile fragment defining variables
containing all the XIncluded sources, rather than a dependency on
those sources.
* Makefile.in: Use that variable to express the dependency.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
fo.xsl doesn't seem to be used since c2f50c40 switched back from xsltproc to
xmlto
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in (cygwin-ug-net/cygwin-ug-net.pdf)
(cygwin-api/cygwin-api.pdf): Use fo.xsl to customized DocBook
XML->PDF conversion.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
Remove the inconsistent .exe suffix in strace and umount usage lines.
Tidy up some trailing whitespace.
Tabs inside <screen> are not consistently formatted by all formatters, replace
with spaces.
Remove pointlesss and incorrect date
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* cygwin-ug-net.xml: Remove incorrect unused date.
* utils.xml : Remove .exe suffix inconsistently added in a few
places. Tidy up some trailing whitespace.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
It seems that xidepend doesn't work correctly if we are ./configure'd using a
relative pathname to the srcdir:
$ make
cd ../../../../src/winsup/doc && ./xidepend ../../../../src/winsup/doc/cygwin-ug-net.xml ../../../../src/winsup/doc/cygwin-api.xml >"/wip/cygwin/build/x86_64-unknown-cygwin/winsup/doc/Makefile.dep"
grep: ../../../../src/winsup/doc/cygwin-ug-net.xml: No such file or directory
grep: ../../../../src/winsup/doc/cygwin-api.xml: No such file or directory
Although it might be better to fix this by making xidepend use pathnames, rather
than ignoring them and assuming everything is in the current directory...
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* xidepend: Fix to handle relative pathnames.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
Not sure if this is wanted, but on a couple of occasions recently I have been
presented with strace output which contains an exception at an address in an
unknown module (i.e. not in the cygwin DLL or the main executable), so here is a
patch which adds some more information, including DLL load addresses, to help
interpret such straces.
v2:
Use NtQueryObject() for HANDLE -> filename conversion
Add new '-e' option to toggle this additional logging
2015-06-07 Jon Turney <jon.turney@dronecode.org.uk>
* strace.cc (proc_child): Log process and thread create and exit,
and DLL load and unload.
(GetFileNameFromHandle): New function.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
This used to be used by cygwin-doc to make a tarball which would be used with a
ssh script to run docbook tools on a linux host since they weren't available on
Cygwin or something crazy like that...
2015-06-04 Jon Turney <jon.turney@dronecode.org.uk>
* Makefile.in: Remove ancient unused rules to make a documentation
tarball.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
An estimate of the size of installing of "hundreds of megabytes" is wildly out
of date. Just remove mention of installing everything, since it is nearly
always not a good idea.
2015-06-01 Jon Turney <jon.turney@dronecode.org.uk>
* ov-ex-unix.xml: Remove unhelpful mention of and inaccurate size
estimate for installing everything.
* ov-ex-win.xml: Ditto.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
The inline list of mount options seemed redundant, so the paragraph now points
to the list below it.
List of executable extensions updated according to fhandler_disk_file.cc. List
of executable magic numbers updated according to path.h (has_exec_chars).
* pathnames.xml: Fix inconsistencies in docs regarding fstab and
executable file detection
Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* include/cygwin/version.h (CYGWIN_VERSION_DLL_MAJOR): Bump to 2000.
(CYGWIN_VERSION_DLL_MINOR): Set to 0.
* new-features.xml (ov-new2.0): Rename from ov-new1.7.36 and change
version number to 2.0.
Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* faq-setup.xml: Document how Cygwin secures installation and
update against man-in-the-middle (MITM) attacks. Note that
setup embeds a public key to check the signature of setup.ini,
and that setup.ini includes SHA-512 cryptographic hashes.
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
winsup/cygwin/
* common.din (__gnu_basename): Export.
* path.cc (__gnu_basename): New function.
winsup/doc/
* posix.xml (std-gnu): Add basename.
(std-notes): Add note about two forms of basename.
By default, docdir and htmldir are defined in terms of prefix, so make sure to
define it, so their values are prefix-relative.
Without this, 'make install' installs the documentation into /share/doc/ unless
configured otherwise.
* Makefile.in (prefix): Define.
Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
sourceware.org URLs are concerned.
* Throughout, simplify ulink expressions if the visible text is the
URL anyway.
* faq-programming.xml (faq.programming.dll-relocatable): Remove.
* faq-setup.xml (faq.setup.name-with-space): Change for 1.7.34.
(faq.setup.home): Ditto.
* faq-using.xml (faq.using.printing): Clarify old links and availability
of a2ps and file.
(faq.using.xemacs): Drop outdated version info and pointers to native
XEmacs.
(faq.using.ntemacs): Remove.
* faq-what.xml (faq.what.what): Rephrase to reflect reality.
(faq.what.supported): Ditto.
(faq.what.who): Rephrase slightly.
* legal.xml: Bump copyright.
* setup-net.xml (internet-setup): Fix references to setup executables.
(cygwin-ug-net/cygwin-ug-net.pdf): Create subdir to allow building PDF
even if subdir is missing.
(cygwin-api/cygwin-api.pdf): Ditto.
* configure.ac: Add AC_PROG_INSTALL rule.
* configure: Regenerate.
* new-features.xml (ov-new1.7.33): Add installation of docs.
Jon TURNEY
Corinna Vinschen
Yaakov Selkowitz
Mike DePaulo
David Macek
David A. Wheeler
Warren Young