winsup/doc/faq-resources.xml

   1 <!-- faq-resources.xml -->
   2 <qandaentry id="faq.resources.documentation">
   3 <question><para>Where's the documentation?</para></question>
   4 <answer>
   5
   6 <para>If you have installed Cygwin, you can find lots of documentation in
   7 <literal>/usr/share/doc/</literal>.  Some packages have Cygwin specific
   8 instructions in a file
   9 <literal>/usr/share/doc/Cygwin/<replaceable>package_name</replaceable>.README</literal>.
  10 In addition, many packages ship with standard documentation, which you can
  11 find in
  12 <literal>/usr/share/doc/<replaceable>package_name</replaceable></literal> or
  13 by using the <literal>man</literal> or <literal>info</literal> tools. (Hint:
  14 use <literal>cygcheck -l <replaceable>package_name</replaceable></literal> to
  15 list what man pages the package includes.)  Some older packages still keep
  16 their documentation in <literal>/usr/doc/</literal>
  17 instead of <literal>/usr/share/doc/</literal>.
  18 </para>
  19 <para>There are links to quite a lot of documentation on the main Cygwin
  20 project web page, <ulink url="http://cygwin.com/">http://cygwin.com/</ulink>,
  21 including this FAQ.  Be sure to at least read any 'Release Notes' or 'Readme'
  22 or 'read this' links on the main web page, if there are any.
  23 </para>
  24 <para>There is a comprehensive Cygwin User's Guide at <ulink
  25 url="http://cygwin.com/cygwin-ug-net/cygwin-ug-net.html">http://cygwin.com/cygwin-ug-net/cygwin-ug-net.html</ulink>
  26 and an API Reference at <ulink
  27 url="http://cygwin.com/cygwin-api/cygwin-api.html">http://cygwin.com/cygwin-api/cygwin-api.html</ulink>.
  28 </para>
  29 <para>You can find documentation for the individual GNU tools at <ulink
  30 url="http://www.fsf.org/manual/">http://www.fsf.org/manual/</ulink>.  (You
  31 should read GNU manuals from a local mirror, check <ulink
  32 url="http://www.fsf.org/server/list-mirrors.html">http://www.fsf.org/server/list-mirrors.html</ulink>
  33 for a list of them.)
  34 </para>
  35 </answer></qandaentry>
  36
  37 <qandaentry id="faq.resources.mailing-lists">
  38 <question><para>What Cygwin mailing lists can I join?</para></question>
  39 <answer>
  40 <para>Comprehensive information about the Cygwin mailing lists can be found at
  41 <ulink url="http://cygwin.com/lists.html" />.
  42 </para>
  43 </answer></qandaentry>
  44
  45 <qandaentry id="faq.resources.problems">
  46 <question><para>What if I have a problem? (Or: Why won't you/the mailing list answer my questions?)</para></question>
  47 <answer>
  48 <para>Comprehensive information about reporting problems with Cygwin can be found at <ulink url="http://cygwin.com/problems.html" />.
  49 </para>
  50 </answer></qandaentry>
  51