From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 127269 invoked by alias); 22 Jun 2015 14:40:33 -0000 Mailing-List: contact cygwin-patches-help@cygwin.com; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Post: List-Archive: List-Help: , Sender: cygwin-patches-owner@cygwin.com Mail-Followup-To: cygwin-patches@cygwin.com Received: (qmail 127258 invoked by uid 89); 22 Jun 2015 14:40:32 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=0.5 required=5.0 tests=AWL,BAYES_50,KAM_LAZY_DOMAIN_SECURITY,RCVD_IN_DNSWL_NONE autolearn=no version=3.3.2 X-HELO: rgout0203.bt.lon5.cpcloud.co.uk Received: from rgout0203.bt.lon5.cpcloud.co.uk (HELO rgout0203.bt.lon5.cpcloud.co.uk) (65.20.0.202) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Mon, 22 Jun 2015 14:40:23 +0000 X-OWM-Source-IP: 86.141.128.210(GB) X-OWM-Env-Sender: jonturney@btinternet.com X-CTCH-RefID: str=0001.0A090201.55881E54.006E,ss=1,re=0.000,recu=0.000,reip=0.000,cl=1,cld=1,fgs=0 X-Junkmail-Premium-Raw: score=27/50,refid=2.7.2:2015.6.17.153616:17:27.888,ip=86.141.128.210,rules=__HAS_FROM, __TO_MALFORMED_2, __TO_NO_NAME, __SUBJ_ALPHA_END, __HAS_MSGID, __SANE_MSGID, __HAS_X_MAILER, __IN_REP_TO, __REFERENCES, __ANY_URI, URI_ENDS_IN_HTML, INFO_TLD, __MAL_TELEKOM_URI, __CP_URI_IN_BODY, BODY_SIZE_10000_PLUS, __MIME_TEXT_ONLY, RDNS_GENERIC_POOLED, __URI_NS, __URI_NS_NXDOMAIN, SXL_IP_DYNAMIC[210.128.141.86.fur], HTML_00_01, HTML_00_10, RDNS_SUSP_GENERIC, RDNS_SUSP, REFERENCES X-CTCH-Spam: Unknown Received: from localhost.localdomain (86.141.128.210) by rgout02.bt.lon5.cpcloud.co.uk (8.6.122.06) (authenticated as jonturney@btinternet.com) id 5581A14B00BE59EE; Mon, 22 Jun 2015 15:40:19 +0100 From: Jon TURNEY To: cygwin-patches@cygwin.com Cc: Jon TURNEY Subject: [PATCH 2/5] winsup/doc: Add intro man pages from cygwin-doc Date: Mon, 22 Jun 2015 14:40:00 -0000 Message-Id: <1434983976-3612-3-git-send-email-jon.turney@dronecode.org.uk> In-Reply-To: <1434983976-3612-1-git-send-email-jon.turney@dronecode.org.uk> References: <1434983976-3612-1-git-send-email-jon.turney@dronecode.org.uk> X-SW-Source: 2015-q2/txt/msg00104.txt.bz2 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 2015-06-22 Jon Turney * Makefile.in (intro2man.stamp): Add. * intro.xml: New file. Signed-off-by: Jon TURNEY --- winsup/doc/ChangeLog | 5 ++ winsup/doc/Makefile.in | 8 +- winsup/doc/intro.xml | 196 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 208 insertions(+), 1 deletion(-) create mode 100644 winsup/doc/intro.xml diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog index 0a23870..1c944ad 100644 --- a/winsup/doc/ChangeLog +++ b/winsup/doc/ChangeLog @@ -1,5 +1,10 @@ 2015-06-22 Jon Turney + * Makefile.in (intro2man.stamp): Add. + * intro.xml: New file. + +2015-06-22 Jon Turney + * Makefile.in (install-info, cygwin-ug-net.info) (cygwin-api.info): Add. * cygwin-ug-net.xml: Add texinfo-node. diff --git a/winsup/doc/Makefile.in b/winsup/doc/Makefile.in index 9f6774b..e215580 100644 --- a/winsup/doc/Makefile.in +++ b/winsup/doc/Makefile.in @@ -54,6 +54,7 @@ all: Makefile Makefile.dep \ cygwin-api/cygwin-api.pdf \ utils2man.stamp \ api2man.stamp \ + intro2man.stamp \ cygwin-ug-net.info cygwin-api.info Makefile: $(srcdir)/Makefile.in @@ -83,7 +84,7 @@ install-html: cygwin-ug-net/cygwin-ug-net.html cygwin-api/cygwin-api.html $(INSTALL_DATA) cygwin-api/*.html $(DESTDIR)$(htmldir)/cygwin-api $(INSTALL_DATA) cygwin-api/cygwin-api.html $(DESTDIR)$(htmldir)/cygwin-api/index.html -install-man: utils2man.stamp api2man.stamp +install-man: utils2man.stamp api2man.stamp intro2man.stamp @$(MKDIRP) $(DESTDIR)$(man1dir) $(INSTALL_DATA) *.1 $(DESTDIR)$(man1dir) @$(MKDIRP) $(DESTDIR)$(man3dir) @@ -131,6 +132,11 @@ charmap: cp /usr/share/docbook2X/charmaps/texi.charmap charmap echo "ae (R)" >>charmap +intro2man.stamp: intro.xml man.xsl + -$(XMLTO) man -m ${srcdir}/man.xsl $< + @echo ".so intro.1" >cygwin.1 + @touch $@ + faq/faq.html : $(FAQ_SOURCES) -$(XMLTO) html -o faq -m $(srcdir)/html.xsl $(srcdir)/faq.xml -sed -i 's;;;g' faq/faq.html diff --git a/winsup/doc/intro.xml b/winsup/doc/intro.xml new file mode 100644 index 0000000..427e1eb --- /dev/null +++ b/winsup/doc/intro.xml @@ -0,0 +1,196 @@ + + + + + + + + Cygwin + + + intro + 1 + Cygwin + + + intro + Introduction to the Cygwin Environment + + + DESCRIPTION + Cygwin is a Linux-like environment for + Windows. It consists of two parts: + A DLL (cygwin1.dll) which acts as a Linux API + emulation layer providing substantial Linux API functionality. The + intro3 + man page gives an introduction to this API. + A collection of tools which provide Linux look and feel. This man + page describes the user environment. + + + AVAILABILITY + Cygwin is developed by volunteers collaborating + over the Internet. It is distributed through the website http://cygwin.com, where you can find + extensive documentation, including FAQ, User's Guide, and API + Reference. The Cygwin website should be considered + the authoritative source of information. The source code, released under + the GNU General Public License, Version 2, is also + available from the website or one of the mirrors. + + + COMPATIBILITY + Cygwin uses the GNU versions of many of the + standard UNIX command-line utilities (sed, + awk, etc.), so the user environment is more similar to + a Linux system than, for example, Sun Solaris. + The default login shell and /bin/sh for + Cygwin is bash, the GNU + "Bourne-Again Shell", but other shells such as tcsh + (an improved csh) are also available and can be + installed using Cygwin's setup. + + + NOTES + To port applications you will need to install the development tools, + which you can do by selecting gcc in + setup.exe (dependencies are automatically handled). + If you need a specific program or library, you can search for a + Cygwin package containing it at: + + http://cygwin.com/packages/ + + If you are a UNIX veteran who plans to use + Cygwin extensively, you will probably find it worth + your while to learn to use Cygwin-specific tools that + provide a UNIX-like interface to common operations. For example, + cygpath converts between UNIX and Win32-style + pathnames. The full documentation for these utilities is at: + + http://cygwin.com/cygwin-ug-net/using-utils.html + + The optional cygutils package also contains + utilities that help with common problems, such as + dos2unix and unix2dos for the + CRLF issue. + + + DOCUMENTATION + In addition to man pages and texinfo documentation, many + Cygwin packages provide system-independent + documentation in the /usr/share/doc/ directory and + Cygwin-specific documentation in + /usr/share/doc/Cygwin/ + For example, if you have both less and + cron installed, the command less + /usr/share/doc/Cygwin/cron.README would display the instructions + to set up cron on your system. + + + REPORTING BUGS + If you find a bug in Cygwin, please read + + http://cygwin.com/bugs.html + + and follow the instructions for reporting found there. If you are + able to track down the source of the bug and can provide a fix, there are + instructions for contributing patches at: + + http://cygwin.com/contrib.html + + + + SEE ALSO + + + intro + 3 + + + + + + + + intro + 3 + Cygwin + + + intro + Introduction to the Cygwin API + + + DESCRIPTION + Cygwin is a Linux-like environment for + Windows. It consists of two parts: + A DLL (cygwin1.dll) which acts as a Linux API + emulation layer providing substantial Linux API functionality. This page + describes the API provided by the DLL. + + A collection of tools which provide Linux look and feel. This + environment is described in the + intro1 + man page. + + + AVAILABILITY + Cygwin is developed by volunteers collaborating + over the Internet. It is distributed through the website http://cygwin.com. The website has + extensive documentation, including FAQ, User's Guide, and API + Reference. It should be considered the authoritative source of + information. The source code, released under the GNU General + Public License, Version 2, is also available from the website + or one of the mirrors. + + + COMPATIBILITY + Cygwin policy is to attempt to adhere to + POSIX/SUSv2 (Portable Operating System Interface for + UNIX / The Single UNIX Specification, Version 2) where possible. + SUSv2 is available online at: + + http://www.opengroup.org/onlinepubs/007908799/ + + For compatibility information about specific functions, see the API + Reference at: + + http://cygwin.com/cygwin-api/cygwin-api.html + + Where these standards are ambiguous, Cygwin tries to mimic + Linux. However, Cygwin uses + newlib instead of glibc as its C + Library, available at: + + http://sources.redhat.com/newlib/ + + Keep in mind that there are many underlying differences between UNIX + and Win32 (for example, a case-insensitive file system), making complete + compatibility an ongoing challenge. + + + REPORTING BUGS + If you find a bug in Cygwin, please read + + http://cygwin.com/bugs.html + + and follow the instructions for reporting found there. If you are + able to track down the source of the bug and can provide a fix, there are + instructions for contributing patches at: + + http://cygwin.com/contrib.html + + + + SEE ALSO + + + intro + 1 + + + + + + -- 2.1.4