OSDN Git Service

Add documentation catalogue and FAQ pages.
[mingw/website.git] / docrefs.html
1 <!DOCTYPE HTML><!--
2  *
3  * docrefs.html
4  *
5  * Catalogue of on-line MinGW documentation resources.
6  *
7  *
8  * $Id$
9  *
10  * Written by Keith Marshall <keith@users.osdn.me>
11  * Copyright (C) 2021, MinGW.OSDN Project
12  *
13  *
14  * Redistribution and use in source and 'compiled' forms (SGML, HTML,
15  * PDF, PostScript, RTF, etc) with or without modification, are permitted
16  * provided that the following conditions are met:
17  *
18  * 1. Redistributions of source code must retain the above copyright
19  *    notice, this list of conditions and the following disclaimer as
20  *    the first lines of this file, unmodified.
21  *
22  * 2. Redistributions in compiled form (transformed to other DTDs,
23  *    converted to PDF, PostScript, RTF and other formats) must
24  *    reproduce the above copyright notice, this list of conditions
25  *    and the following disclaimer in the documentation and/or other
26  *    materials provided with the distribution.
27  *
28  * THIS DOCUMENTATION IS PROVIDED BY THE MINGW.OSDN PROJECT "AS IS"
29  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
30  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE MINGW.OSDN PROJECT, OR
32  * ITS CONTRIBUTORS, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  * OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
39  * DAMAGE.
40  *
41  *
42  * Note: this page assumes browser support for the following numeric
43  * HTML entity codes:
44  *
45  *    &#8209;   non-breaking hyphen
46  *    &#8217;   typographic apostrophe
47  *    &#8220;   typographic left (opening) double quote
48  *    &#8221;   typographic right (closing) double quote
49  *
50 -->
51 <script class="masthead">
52  set_page("title", "MinGW Documentation Resources");
53  set_page("subtitle", "Catalogue of User Guides, Tutorials, and Reference Documentation");
54 </script><!-- masthead -->
55
56 <p>This page is currently in a transitional phase,
57 as information is transferred from the old Drupal hosted MinGWiki.
58 </p>
59
60 <h3>Frequently Asked Questions</h3>
61 <p>Below, you will find references to various tutorials,
62 MinGW User Guides, and more detailed reference documentation.
63 If you are uncertain about which reference may be most appropriate
64 to your needs, you may wish to
65 <a target="_blank" href="index.html?page=faq.html"
66 >consult the FAQ</a> first.
67 </p>
68
69 <div class="overlapped" id="tutorials">
70 <h3>Tutorials</h3>
71 </div><!-- tutorials -->
72
73 <div class="overlapped" id="guides">
74 <h3>User Guides</h3>
75 <dl class="toc overlapped" id="setup">
76 <h4>Setting Up the MinGW Compiler Suite</h4>
77 <dt><a target="_blank" href="index.html?page=setup.html">
78 HOWTO Set Up the MinGW (GCC) Compiler Suite &mdash; a Guide for New Users
79 </a></dt>
80 <dt><a target="_blank" href="index.html?page=install.html">
81 HOWTO Install the MinGW (GCC) Compiler Suite &mdash; Manual Method for Expert Users
82 </a></dt>
83 <dt><a target="_blank" href="index.html?page=pkginfo.html">
84 HOWTO Interpret the Names of Packages Distributed by MinGW.OSDN
85 </a></dt>
86 <dt><a target="_blank" href="index.html?page=pkgspec.html">
87 HOWTO Write Specifications for Packages to be Distributed by MinGW.OSDN
88 </a></dt>
89 </dl><!-- setup -->
90
91 <dl class="toc overlapped" id="build">
92 <h4>Compiling and Linking Programs</h4>
93 <dt><a target="_blank" href="index.html?page=usegcc.html">
94 HOWTO Build Application Programs with MinGW &mdash; A Guide for New Users
95 </a></dt>
96 <dt><a target="_blank" href="index.html?page=usegcj.html">
97 HOWTO Compile Java Programs with GCJ
98 </a></dt>
99 <dt><a target="_blank" href="index.html?page=@ref@.html">
100 HOWTO Export a Multiple Instance Supporting C++ Class from a DLL
101 </a></dt>
102 <dt><a target="_blank" href="index.html?page=@ref@.html">
103 HOWTO Work Around a Linker Lock-Up Problem in Windows&#8209;7
104 </a></dt>
105 </dl><!-- build -->
106
107 <dl class="toc overlapped" id="libs">
108 <h4 id="toc3">Using 3rd&#8209;Party Libraries with MinGW</h4>
109 <dt><a target="_blank" href="index.html?page=isystem.html">
110 HOWTO Specify the Include File Search Path for use with MinGW Compilers
111 </a></dt>
112 <dt><a target="_blank" href="index.html?page=libpath.html">
113 HOWTO Specify the MinGW Linker&#8217;s Search Path for Object Code Libraries
114 </a></dt>
115 <dt><a target="_blank" href="index.html?page=gccspecs.html">
116 HOWTO Customize MinGW Compiler Operation using the GCC &#8216;specs&#8217; File
117 </a></dt>
118 <dt><a target="_blank" href="index.html?page=@ref@.html">
119 HOWTO Compile the OpenGL Utility Toolkit (GLUT) for Win32 with MinGW
120 </a></dt>
121 <dt><a target="_blank" href="index.html?page=@ref@.html">
122 HOWTO Use Mark J. Kilgard's OpenGL Utility Toolkit (GLUT) with MinGW
123 </a></dt>
124 <dt><a target="_blank" href="index.html?page=@ref@.html">
125 HOWTO Compile and Use the Mpatrol Memory Leak Detection Library
126 </a></dt>
127 </dl><!-- libs -->
128
129 <dl class="toc overlapped" id="cross-compile">
130 <dt><a target="_blank" href="index.html?page=@ref@.html">
131 </a></dt>
132 <dt><a target="_blank" href="index.html?page=@ref@.html">
133 </a></dt>
134 </dl><!-- cross-compile -->
135
136 <div class="overlapped" id="references">
137 <h3>Reference Documentation</h3>
138 </div><!-- references -->
139
140 <!-- $RCSfile$: end of file -->