summaryrefslogtreecommitdiffstats
path: root/winsup/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* winsup/doc: Update ancient README about building documentationJon TURNEY2015-06-232-21/+6
| | | | | | | | | | | | | Update list of pre-requisites, everything else is obsolete. Future work: Ensure that the list of pre-requisites in FAQ 6.21 "How do I build Cygwin" remains synchronized with this list. 2015-06-22 Jon Turney <jon.turney@dronecode.org.uk> * README: Update. Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
* winsup/doc: Use xidepend to generate the source list for FAQ targets as wellJon TURNEY2015-06-232-4/+6
| | | | | | | | 2015-06-22 Jon Turney <jon.turney@dronecode.org.uk> * Makefile.in (FAQ_SOURCES): Remove and generate with xidepend. Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
* winsup/doc: Remove 'Usage' prefix from synopsesJon TURNEY2015-06-232-44/+48
| | | | | | | | | | Remove redundant 'Usage' prefix from synopses. 2015-06-22 Jon Turney <jon.turney@dronecode.org.uk> * utils.xml: Remove 'Usage' prefix from synopses. Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
* winsup/doc: Add intro man pages from cygwin-docJon TURNEY2015-06-233-1/+209
| | | | | | | | | | | | | | | | | | | | | | 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>
* winsup/doc: Create info pages from cygwin documentationJon TURNEY2015-06-235-6/+53
| | | | | | | | | | | | | | | | | | | | | | | | | 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 &reg; 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>
* ChangeLog entries for Cygwin's alternate signal stack implementationCorinna Vinschen2015-06-201-0/+5
| | | | Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* Add alternate signal stack to docsCorinna Vinschen2015-06-202-1/+11
| | | | | | | * new-features.xml (ov-new2.1): Add alterante signal stack info. * posix.xml (std-susv4): Move sigaltstack here. Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* winsup/doc: Fix command to create man3 install directoryJon TURNEY2015-06-192-1/+6
| | | | | | | | | | | | 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>
* winsup/doc: Add man.xsl customization stylesheetJon TURNEY2015-06-183-4/+22
| | | | | | | | | 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>
* winsup/doc: Make and install cygwin-api function manpagesJon TURNEY2015-06-182-2/+16
| | | | | | | | | | | | | | 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>
* winsup/doc: Convert cygwin-api function documentation to refentry elementsJon TURNEY2015-06-185-68/+258
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* winsup/doc: Generate ANSI rather than K&R style function prototypesJon TURNEY2015-06-183-0/+12
| | | | | | | | | | | | | | 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>
* winsup/doc: Rename cygwin.xsl as html.xslJon TURNEY2015-06-183-8/+12
| | | | | | | | | | 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>
* Add sethostname to API listCorinna Vinschen2015-06-172-0/+5
| | | | Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* Add sethostnameCorinna Vinschen2015-06-172-1/+18
| | | | | | | | | | | | * net.cc (sethostname): New function. * common.din (sethostname): Export * include/cygwin/version.h (CYGWIN_VERSION_DLL_MAJOR): Bump to 2001. (CYGWIN_VERSION_DLL_MINOR): Set to 0. * new-features.xml (ov-new): Rename from ov-new1.7. (ov-new2.1): Add new section. Document sethostname. Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* winsup/doc: Make and install manpages for utilsJon TURNEY2015-06-162-3/+20
| | | | | | | | | | | | | | | | 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>
* winsup/doc: Convert utils.xml to using refentry elementsJon TURNEY2015-06-164-209/+625
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* winsup/doc: Fix an issue with parallel makeJon TURNEY2015-06-162-0/+6
| | | | | | | | | | | | | | 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>
* winsup/doc: Make it easier to extend xidepend to more targetsJon TURNEY2015-06-163-9/+15
| | | | | | | | | | | | | | | | | 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>
* winsup/doc: Use fo.xsl to customize PDF generation from DocBook XMLJon TURNEY2015-06-162-2/+8
| | | | | | | | | | | | | 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>
* winsup/doc: Some preparatory XML fixesJon TURNEY2015-06-163-29/+34
| | | | | | | | | | | | | | | | | | | 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>
* winsup/doc: Fix xidepend to handle relative pathnamesJon TURNEY2015-06-162-0/+5
| | | | | | | | | | | | | | | | | | | 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>
* winsup/doc: Remove tarball target from .PHONYJon TURNEY2015-06-162-1/+5
| | | | | | | | Left over after 4885352e. 2015-06-12 Jon Turney <jon.turney@dronecode.org.uk> * Makefile.in (.PHONY): Remove tarball target.
* Improve strace to log most Windows debug eventsJon TURNEY2015-06-111-0/+1
| | | | | | | | | | | | | | | | | | | | 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>
* winsup/doc: Remove ancient unused Makefile rules to make documentation tarballJon TURNEY2015-06-082-11/+5
| | | | | | | | | | | | | 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>
* Remove mention of installing everythingJon TURNEY2015-06-013-12/+6
| | | | | | | | | | | | | | 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>
* Fix more typos in ntsec.xmlYaakov Selkowitz2015-04-291-4/+4
| | | | Signed-off-by: Yaakov Selkowitz <yselkowi@redhat.com>
* cygserver.xml: Add new section. How to install Cygserver.Mike DePaulo2015-04-272-0/+18
| | | | | | | * cygserver.xml (install-cygserver): Add new section. How to install Cygserver. Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* Fix inconsistencies in docs regarding fstab and executable file detectionDavid Macek2015-04-231-7/+6
| | | | | | | | | | | | | 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>
* Bump Cygwin version to 2.0.0.Corinna Vinschen2015-04-232-1/+6
| | | | | | | | | | * 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>
* Add FAQ entry on how Cygwin counters install and update MITM attacksDavid A. Wheeler2015-04-232-1/+127
| | | | | | | | | * 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>
* Fix documentation of cygwin_internal()'s return type.Jon TURNEY2015-04-232-1/+5
| | | | | | * misc-funcs.xml (cygwin_internal): Correct return type. Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
* Document GNU basename.Corinna Vinschen2015-04-232-0/+23
| | | | | | | * new-features.xml (ov-new1.7.36): Add new section. Document GNU basename. Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* cygwin: add GNU basename(3)Yaakov Selkowitz2015-04-232-1/+10
| | | | | | | | | | 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.
* Fix winsup/doc to install into prefixJon TURNEY2015-03-162-0/+5
| | | | | | | | | | | | 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>
* Fix more typos in ntsec.xmlCorinna Vinschen2015-03-122-2/+7
| | | | Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* Fix typos in ntsec.xmlCorinna Vinschen2015-03-122-4/+10
| | | | Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* whitespace fixCorinna Vinschen2015-03-101-1/+0
|
* Change CVS->GIT in docsCorinna Vinschen2015-03-103-8/+14
| | | | Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
* mv .cvsignore to .gitignoreCorinna Vinschen2015-03-091-0/+0
| | | | Signed-off-by: Corinna Vinschen <vinschen@redhat.com>
* * posix.xml (std-bsd): Add issetugid.Corinna Vinschen2015-03-042-0/+5
|
* * new-features.xml (ov-new1.7.35): Add SIGSYS change.Corinna Vinschen2015-03-032-0/+9
|
* * new-features.xml (ov-new1.7.35): Add new section.Corinna Vinschen2015-03-032-0/+54
|
* * utils.xml (getfacl): Adjust options to option nmame change.Corinna Vinschen2015-02-282-6/+8
|
* Applied the "chgrp `id -g`" improvements suggested by Corinna for the FAQWarren Young2015-02-252-0/+21
| | | | item about SSH keys not working in 1.7.34+.
* * ntsec.xml (ntsec-mapping): Match the description of the defaultCorinna Vinschen2015-02-252-35/+14
| | | | values for db_home, db_shell, and db_gecos to the latest changes.
* Added chgrp None ~/.ssh/* hack to FAQ item 4.40Warren Young2015-02-252-0/+25
|
* Applied Andrey's and my improvments to FAQ item 4.2, discussed on the main ML.Warren Young2015-02-172-48/+112
|
* * setup-files.xml (setup-files): Drop hint to set HOME in WindowsCorinna Vinschen2015-02-163-13/+19
| | | | | | environment. * setup-env.xml (setup-env-ov): Discourage setting HOME in the Windows environment.
* * posix.xml (std-gnu): Add missing __mempcpy.Corinna Vinschen2015-02-152-0/+5
|
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-15 20:17:17 +0000