Move build information into an html file.

This commit is contained in:
chris_kohlhoff 2005-10-15 00:31:54 +00:00
parent 36fb65d8d2
commit c88978489d
8 changed files with 270 additions and 220 deletions

View File

@ -1,153 +1,5 @@
asio version 0.3.3 - Installation instructions
1. Supported Platforms
2. Requirements
3. Before using asio
4. Building the tests on Linux or UNIX
5. Building the tests on Win32
5.1. Building with MSVC
5.2. Building with Borland C++
5.3. Building with MinGW
5.4. Building with MinGW and MSYS
1. Supported Platforms
======================
The asio toolkit has been tested with the following compiler/platform
combinations:
- Redhat Linux 7.3 using gcc 2.95.3
- Redhat Linux 7.3 using gcc 3.2.1
- Redhat Linux 7.3 using gcc 3.4.1
- Fedora Core release 3 running Linux 2.6 kernel using gcc 3.4.2
- Debian Sarge running Linux 2.6 kernel using gcc 3.3.5
- SuSE Linux Enterprise Server 8.1 on AMD64 using gcc 3.2.2
- Microsoft Windows 2000 using MSVC 6 sp5
- Microsoft Windows 2000 using MSVC 7.1 (Visual Studio .NET 2003)
- Microsoft Windows 2000 using Borland C++ Builder 6 patch 4 (bcc32 5.6.4)
- Microsoft Windows 2000 using MinGW 3.1.0-1 (gcc 3.2.3)
- Sun Solaris 8 using gcc 2.95.3
- Sun Solaris 9 using gcc 3.3.2
- Mac OS X 10.4.2 using gcc 3.3
2. Requirements
===============
The asio toolkit requires Boost 1.33.0 or later. There is no need to build any
of the Boost libraries to use asio, as only the header files are required.
(Note: with MSVC you may need to add -DBOOST_DATE_TIME_NO_LIB to your project
settings to disable autolinking of the Boost.Date_Time library.)
3. Before using asio
====================
The asio toolkit consists only of header files, and so there is no need to
build any libraries before using asio in your own applications. You simply need
to add the following directories to your compiler include path:
- asio's `include' directory
- the boost directory (e.g. the one called boost_1_33_0)
4. Building the tests on Linux or UNIX
======================================
If the boost directory (e.g. the directory called boost_1_33_0)
is in the same directory as the asio source kit, then you may configure asio by
simply going:
./configure
in the root directory of the asio source kit. Note that configure will always
use the most recent boost version it knows about (i.e. 1.33.0) in preference to
earlier versions, if there is more than one version present.
If the boost directory is in some other location, then you need to specify this
directory when running configure:
./configure --with-boost=<BOOSTDIR>
When specifying the boost directory in this way you should ensure that you use
an absolute path.
To build, simply run `make' in the root directory of the asio source kit. To
test that asio is working correctly, run `make check' after a successful build.
5. Building the tests on Win32
==============================
5.1. Building with MSVC
To build using the MSVC 6 or 7.1 command line compiler, perform the following
steps:
- If you are using a version of boost other than 1.33.0, or if the boost
directory (i.e. the directory called boost_1_33_0) is not in the same
directory as the asio source kit, then specify the location of boost by
running a command similar to `set BOOSTDIR=path_to_boost'. Ensure that
you specify an absolute path.
- Change to the asio `src' directory.
- Execute the command `nmake -f Makefile.msc'.
- Execute the command `nmake -f Makefile.msc check' to run a suite of tests
to confirm that asio is working correctly.
5.2. Building with Borland C++
To build using the Borland C++ Builder 6 command line compiler, perform the
following steps:
- If you are using a version of boost other than 1.33.0, or if the boost
directory (i.e. the directory called boost_1_33_0) is not in the same
directory as the asio source kit, then specify the location of boost by
running a command similar to `set BOOSTDIR=path_to_boost'. Ensure that
you specify an absolute path.
- Change to the asio `src' directory.
- Execute the command `make -f Makefile.bor'.
- Execute the command `make -f Makefile.bor check' to run a suite of tests to
confirm that asio is working correctly.
5.3. Building with MinGW
To build using the MinGW g++ compiler from the command line, perform the
following steps:
- If you are using a version of boost other than 1.33.0, or if the boost
directory (i.e. the directory called boost_1_33_0) is not in the same
directory as the asio source kit, then specify the location of boost by
running a command similar to `set BOOSTDIR=path_to_boost'. Ensure that
you specify an absolute path.
- Change to the asio `src' directory.
- Execute the command `mingw32-make -f Makefile.mgw'.
5.4. Building with MinGW and MSYS
If the boost directory (e.g. the directory called boost_1_33_0) is in the same
directory as the asio source kit, then you may configure asio by simply going:
sh configure
in the root directory of the asio source kit. Note that configure will always
use the most recent boost version it knows about (i.e. 1.33.0) in preference to
earlier versions, if there is more than one version present.
If the boost directory is in some other location, then you need to specify this
directory when running configure:
sh configure --with-boost=<BOOSTDIR>
When specifying the boost directory in this way you should ensure that you use
an absolute path in a UNIX-style format, e.g. `/c/mydir/boost_1_33_0'.
To build, simply run `make' in the root directory of the asio source kit.
See doc/index.html for information on:
- External dependencies
- Using asio
- Supported platforms
- How to build the tests and examples

View File

@ -88,5 +88,6 @@ AC_OUTPUT([
src/doc/design.dox
src/doc/examples.dox
src/doc/index.html
src/doc/building.html
src/doc/reference.dox
src/doc/tutorial.dox])

View File

@ -3,6 +3,7 @@ Makefile.in
design.dox
examples.dox
index.html
building.html
reference.dox
tutorial.dox
asio.doxytags

View File

@ -2,6 +2,7 @@ if HAVE_DOXYGEN
noinst_DATA = \
../../doc/index.html \
../../doc/building.html \
../../doc/asio.css \
../../doc/reference/asio.css \
../../doc/reference/index.html \
@ -15,6 +16,7 @@ noinst_DATA = \
doc: \
delete_doc \
../../doc/index.html \
../../doc/building.html \
../../doc/asio.css \
../../doc/reference/asio.css \
../../doc/reference/index.html \
@ -32,6 +34,10 @@ delete_doc:
mkdir -p ../../doc
cp $(srcdir)/index.html ../../doc/index.html
../../doc/building.html: building.html.in
mkdir -p ../../doc
cp $(srcdir)/building.html ../../doc/building.html
../../doc/asio.css: asio.css
mkdir -p ../../doc
cp $(srcdir)/asio.css ../../doc/asio.css
@ -70,6 +76,7 @@ delete_doc:
EXTRA_DIST = \
../../doc/index.html \
../../doc/building.html \
../../doc/asio.css \
../../doc/reference/index.html \
../../doc/design/index.html \

View File

@ -21,6 +21,7 @@ DIV.sidebar {
border: 1px solid #84b0c7;
text-align: center;
margin: 2px;
margin-bottom: 20px;
padding: 2px;
line-height: 140%;
}

187
asio/src/doc/building.html.in Executable file
View File

@ -0,0 +1,187 @@
<html>
<head>
<title>asio C++ library: Building the Tests and Examples</title>
<link href="asio.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<div class="qindex">
<table border="0" width="100%">
<tr>
<td align="left">
<b>asio @VERSION@</b>
</td>
<td align="right">
<a class="qindex" href="index.html">Home</a> |
<a class="qindex" href="reference/index.html">Reference</a> |
<a class="qindex" href="tutorial/index.html">Tutorial</a> |
<a class="qindex" href="examples/index.html">Examples</a> |
<a class="qindex" href="design/index.html">Design</a>
</td>
</tr>
</table>
</div>
<h1>Building the Tests and Examples</h1>
<h2>Building on Linux or UNIX</h2>
<p>
If the boost directory (e.g. the directory called <tt>boost_1_33_0</tt>)
is in the same directory as the asio source kit, then you may configure
asio by simply going:
</p>
<blockquote>
<tt>./configure</tt>
</blockquote>
<p>
in the root directory of the asio source kit. Note that configure will
always use the most recent boost version it knows about (i.e. 1.33.0) in
preference to earlier versions, if there is more than one version
present.
</p>
<p>
If the boost directory is in some other location, then you need to
specify this directory when running configure:
</p>
<blockquote>
<tt>./configure --with-boost=&lt;BOOSTDIR&gt;</tt>
</blockquote>
<p>
When specifying the boost directory in this way you should ensure that
you use an absolute path.
</p>
<p>
To build, simply run <tt>make</tt> in the root directory of the asio
source kit. To test that asio is working correctly, run <tt>make
check</tt> after a successful build.
</p>
<h2>Building on Win32</h2>
<h3>Building with MSVC</h3>
<p>
To build using the MSVC 7.1 command line compiler, perform the following
steps in a Command Prompt window:
</p>
<ul>
<li>
If you are using a version of boost other than 1.33.0, or if the boost
directory (i.e. the directory called <tt>boost_1_33_0</tt>) is not in
the same directory as the asio source kit, then specify the location of
boost by running a command similar to <tt>set
BOOSTDIR=<i>path_to_boost</i></tt>. Ensure that you specify an absolute
path.
</li>
<li>
Change to the asio <tt>src</tt> directory.
</li>
<li>
Execute the command <tt>nmake -f Makefile.msc</tt>.
</li>
<li>
Execute the command <tt>nmake -f Makefile.msc check</tt> to run a suite
of tests to confirm that asio is working correctly.
</li>
</ul>
<h3>Building with Borland C++</h3>
<p>
To build using the Borland C++ Builder 6 command line compiler, perform
the following steps in a Command Prompt window:
</p>
<ul>
<li>
If you are using a version of boost other than 1.33.0, or if the boost
directory (i.e. the directory called <tt>boost_1_33_0</tt>) is not in
the same directory as the asio source kit, then specify the location of
boost by running a command similar to <tt>set
BOOSTDIR=<i>path_to_boost</i></tt>. Ensure that you specify an absolute
path.
</li>
<li>
Change to the asio <tt>src</tt> directory.
</li>
<li>
Execute the command <tt>make -f Makefile.bor</tt>.
</li>
<li>
Execute the command <tt>make -f Makefile.bor check</tt> to run a suite
of tests to confirm that asio is working correctly.
</li>
</ul>
<h3>Building with MinGW</h3>
<p>
To build using the MinGW g++ compiler from the command line, perform the
following steps in a Command Prompt window:
</p>
<ul>
<li>
If you are using a version of boost other than 1.33.0, or if the boost
directory (i.e. the directory called <tt>boost_1_33_0</tt>) is not in
the same directory as the asio source kit, then specify the location of
boost by running a command similar to <tt>set
BOOSTDIR=<i>path_to_boost</i></tt>. Ensure that you specify an absolute
path using <i>forward slashes</i> (i.e.
<tt>c:/projects/boost_1_33_0</tt> rather than
<tt>c:\projects\boost_1_33_0</tt>).
</li>
<li>
Change to the asio <tt>src</tt> directory.
</li>
<li>
Execute the command <tt>make -f Makefile.mgw</tt>.
</li>
<li>
Execute the command <tt>make -f Makefile.mgw check</tt> to run a suite
of tests to confirm that asio is working correctly.
</li>
</ul>
<div class="qindex">
<table border="0" width="100%">
<tr>
<td align="left">
<b>asio @VERSION@</b>
</td>
<td align="right">
<a class="qindex" href="index.html">Home</a> |
<a class="qindex" href="reference/index.html">Reference</a> |
<a class="qindex" href="tutorial/index.html">Tutorial</a> |
<a class="qindex" href="examples/index.html">Examples</a> |
<a class="qindex" href="design/index.html">Design</a>
</td>
</tr>
</table>
</div>
</body>
</html>

View File

@ -23,21 +23,21 @@
</table>
</div>
<h1>asio C++ library</h1>
<p>
<table border="0" cellpadding="3" cellspacing="3" width="100%">
<tr>
<td valign="top">
<table border="0" cellpadding="3" cellspacing="3" width="100%"><tr>
<td valign="top">
<p>
asio is a cross-platform C++ library for network programming that provides
developers with a consistent asynchronous I/O model using a modern C++ approach.
</p>
<p>
asio is a cross-platform C++ library for network programming that provides
developers with a consistent asynchronous I/O model using a modern C++
approach.
</p>
<h2>License</h2>
<p>
asio is released under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost
Software License</a>.
asio is released under the
<a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>.
</p>
<h2>Dependencies</h2>
<p>
asio requires <a href="http://www.boost.org">Boost</a> version 1.33. There
@ -51,15 +51,32 @@ developers with a consistent asynchronous I/O model using a modern C++ approach.
required. OpenSSL is not necessary to use the rest of asio.
</p>
<h2>Using asio</h2>
<p>
asio consists only of header files, and so there is no need to build any
libraries before using asio in your own applications. You simply need to
add the following directories to your compiler include path:
</p>
<ul>
<li>asio's <tt>include</tt> directory</li>
<li>the boost directory (e.g. the one called <tt>boost_1_33_0</tt>)</li>
</ul>
<h2>Supported Platforms</h2>
<p>
asio supports the following platforms and compilers:
<ul>
<li>
Win32 using Visual C++ 7.1, Borland C++Builder 6 and MinGW.
Win32 using Visual C++ 7.1.
</li>
<li>
Linux using g++ 3.3 or later.
Win32 using Borland C++Builder 6 patch 4.
</li>
<li>
Win32 using MinGW.
</li>
<li>
Linux (2.4 or 2.6 kernels) using g++ 3.3 or later.
</li>
<li>
Solaris using g++ 3.3 or later.
@ -70,36 +87,33 @@ developers with a consistent asynchronous I/O model using a modern C++ approach.
</ul>
</p>
</td>
</td>
<td valign="top">
<div class="sidebar">
<table border="0" width="100%"><tr><td>
<h2>Getting Started</h2>
<ul>
<li><a href="tutorial/index.html">Tutorial</a>
<li><a href="examples/index.html">Annotated examples</a>
</ul>
</td></tr></table>
</div>
<td valign="top">
<div class="sidebar">
<table border="0" width="100%"><tr><td>
<h2>Getting Started</h2>
<ul>
<li><a href="tutorial/index.html">Tutorial</a>
<li><a href="examples/index.html">Annotated examples</a>
<li><a href="building.html">Building the tests and examples</a>
</ul>
</td></tr></table>
</div>
<div class="sidebar">
<table border="0" width="100%"><tr><td>
<h2>Related Links</h2>
<ul>
<li><a href="http://asio.sourceforge.net">asio homepage</a>
<li><a href="http://sourceforge.net/projects/asio/">asio project page</a>
<li><a href="http://sourceforge.net/project/showfiles.php?group_id=122478">Download latest releases</a>
<li><a href="http://www.boost.org">Boost homepage</a>
</ul>
</td></tr></table>
</div>
</td>
<p>
<div class="sidebar">
<table border="0" width="100%"><tr><td>
<h2>Related Links</h2>
<ul>
<li><a href="http://asio.sourceforge.net">asio homepage</a>
<li><a href="http://sourceforge.net/projects/asio/">asio project page</a>
<li><a href="http://sourceforge.net/project/showfiles.php?group_id=122478">Download latest releases</a>
<li><a href="http://www.boost.org">Boost homepage</a>
</ul>
</td></tr></table>
</div>
</td>
</tr>
</table>
</tr></table>
<div class="qindex">
<table border="0" width="100%">
<tr>
@ -116,4 +130,5 @@ developers with a consistent asynchronous I/O model using a modern C++ approach.
</tr>
</table>
</div>
</body></html>
</body>
</html>

View File

@ -11,11 +11,7 @@
<td><input type="checkbox"></td>
</tr>
<tr>
<td>Update version number in README</td>
<td><input type="checkbox"></td>
</tr>
<tr>
<td>Update version number in INSTALL</td>
<td>Update version number and date in README</td>
<td><input type="checkbox"></td>
</tr>
<tr>
@ -24,33 +20,18 @@
<td><input type="checkbox"></td>
</tr>
<tr>
<td>Unpack/build/test distribution using g++ 3.2.1 with adjacent
boost directory</td>
<td>Unpack/build/test distribution on Mac OS X using g++ 4.0 with
adjacent boost directory</td>
<td><input type="checkbox"></td>
</tr>
<tr>
<td>Unpack/build/test distribution using g++ 3.2.1 using the
<td>Unpack/build/test distribution on Linux using g++ 3.4 using the
`--with-boost' configure option</td>
<td><input type="checkbox"></td>
</tr>
<tr>
<td>Unpack/build/test distribution using g++ 2.95.3 with adjacent
boost directory</td>
<td><input type="checkbox"></td>
</tr>
<tr>
<td>Unpack/build/test distribution using g++ 2.95.3 using the
`--with-boost' configure option</td>
<td><input type="checkbox"></td>
</tr>
<tr>
<td>Unpack/build/test distribution using bcc32 5.6.4 with adjacent
boost directory</td>
<td><input type="checkbox"></td>
</tr>
<tr>
<td>Unpack/build/test distribution using MSVC 6 with adjacent boost
directory</td>
<td>Unpack/build/test distribution on Solaris using g++ 3.3 with
adjacent boost directory</td>
<td><input type="checkbox"></td>
</tr>
<tr>
@ -59,7 +40,12 @@
<td><input type="checkbox"></td>
</tr>
<tr>
<td>Unpack/build/test distribution using MinGW-3.1.0 with adjacent
<td>Unpack/build/test distribution using bcc32 5.6.4 with adjacent
boost directory</td>
<td><input type="checkbox"></td>
</tr>
<tr>
<td>Unpack/build/test distribution using MinGW-4.1.0 with adjacent
boost directory</td>
<td><input type="checkbox"></td>
</tr>