mirror of
https://github.com/boostorg/iostreams.git
synced 2026-02-22 15:32:20 +00:00
131 lines
5.2 KiB
HTML
Executable File
131 lines
5.2 KiB
HTML
Executable File
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>Installation</TITLE>
|
|
<LINK REL='stylesheet' HREF='../../../boost.css'>
|
|
<LINK REL='stylesheet' HREF='theme/iostreams.css'>
|
|
</HEAD>
|
|
<BODY>
|
|
|
|
<!-- Begin Banner -->
|
|
|
|
<H1 CLASS='title'>Installation</H1>
|
|
<HR CLASS='banner'>
|
|
|
|
<!-- End Banner -->
|
|
|
|
<DL class='page-index'>
|
|
<DT><A HREF='#overview'>Overview</A>
|
|
<DT><A HREF='#bjam'>Building with Bjam</A>
|
|
</DL>
|
|
|
|
<A NAME='overview'></A>
|
|
<H2>Overview</H2>
|
|
|
|
<P>
|
|
Most components of the Iostreams Library are defined entirely in header files. These components can be used without linking to any library, provided the preprocessor symbol <CODE>BOOST_IOSTREAMS_NO_LIB</CODE> is defined.
|
|
</P>
|
|
|
|
<P>
|
|
In addition:
|
|
<OL>
|
|
<LI STYLE='margin:.5em'>
|
|
The <A HREF='classes/regex_filter.html'>regular expression Filters</A> rely on the <A HREF='http://www.boost.org/libs/regex'>Boost Regular Expression Library</A> (<A CLASS='bib_ref' HREF='bibliography.html#maddock'>[Maddock]</A>), which must be built separately. See <A HREF="http://www.boost.org/libs/regex/doc/install.html">here</A> for details.
|
|
</LI>
|
|
<LI STYLE='margin:.5em'>
|
|
The <A HREF='classes/mapped_file.html'>memory-mapped file Devices</A> rely on the implementation file <A CLASS='header' HREF='../src/mapped_file.cpp'><CODE><libs/iostreams/src/memmap.cpp></CODE></A>.
|
|
</LI>
|
|
<LI STYLE='margin:.5em'>
|
|
The <A HREF='classes/file_descriptor.html'>file descriptor file Devices</A> rely on the implementation file <A CLASS='header' HREF='../src/file_descriptor.cpp'><CODE><libs/iostreams/src/file_descriptor.cpp></CODE></A>.
|
|
</LI>
|
|
<LI STYLE='margin:.5em'>
|
|
The <A HREF='classes/zlib.html'>zlib</A> and <A HREF='classes/gzip.html'>gzip</A> Filters rely on the implementation file <A CLASS='header' HREF='../src/mapped_file.cpp'><CODE><libs/iostreams/src/zlib.cpp></CODE></A>, and depend on the non-boost library zlib (<A CLASS='bib_ref' HREF='bibliography.html#gailly'>[Gailly]</A>). See <A HREF='classes/zlib.html#installation'>here</A> for details on obtaining zlib binaries.
|
|
</LI>
|
|
<LI STYLE='margin:.5em'>
|
|
The <A HREF='classes/bzip2.html'>bzip2</A> Filters rely on the implementation file <A CLASS='header' HREF='../src/mapped_file.cpp'><CODE><libs/iostreams/src/bzip2.cpp></CODE></A>, and and depend on the non-boost library libbz2 (<A CLASS='bib_ref' HREF='bibliography.html#seward'>[Seward]</A>). See <A HREF='classes/bzip2.html#installation'>here</A> for details on obtaining libbz2 binaries.
|
|
</LI>
|
|
</OL>
|
|
</P>
|
|
|
|
Once the zlib and libbz2 binaries are obtained, the entire Iostreams Library can be built using the <A HREF='http://www.boost.org/tools/build/v1/build_system.htm'>Boost Build System</A>.
|
|
|
|
<A NAME='bjam'></A>
|
|
<H2>Building with Bjam</H2>
|
|
|
|
<P>
|
|
The <A HREF='../build/Jamfile'>Jamfile</A> included with the Iostreams Library is sensitive to the following environment variables.
|
|
</P>
|
|
|
|
<TABLE STYLE='margin-bottom:1em' BORDER='1' CELLPADDING='6' CELLSPACING='1'>
|
|
<TR>
|
|
<TH>Variable</TH><TH>Interpretation</TH><TH>Default</TH>
|
|
</TR>
|
|
<TR>
|
|
<TD><CODE>ZLIB_DYN_LINK</CODE></TD>
|
|
<TD>
|
|
Indicates that the <A HREF='classes/zlib.html'>zlib</A> and <A HREF='classes/gzip.html'>gzip</A> Filters should link to zlib dynamically.
|
|
</TD>
|
|
<TD ALIGN='center'>-</TD>
|
|
</TR>
|
|
<TR>
|
|
<TD><CODE>ZLIB_PATH</CODE></TD>
|
|
<TD>Search path for the zlib library file.</TD>
|
|
<TD ALIGN='center'>-</TD>
|
|
</TR>
|
|
<TR>
|
|
<TD><CODE>ZLIB_BINARY</CODE></TD>
|
|
<TD>Name of the zlib library file, minus file extension.</TD>
|
|
<TD ALIGN='center'><CODE>zlib</CODE></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD><CODE>LIBBZ2_PATH</CODE></TD>
|
|
<TD>Search path for the libbz library file.</TD>
|
|
<TD ALIGN='center'><CODE>-</CODE></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD><CODE>LIBBZ2_BINARY</CODE></TD>
|
|
<TD>Name of the libbz2 library file, minus file extension.</TD>
|
|
<TD ALIGN='center'><CODE>libbz</CODE></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD><CODE>NO_ZLIB</CODE></TD>
|
|
<TD>
|
|
Set to indicate that the <A HREF='classes/zlib.html'>zlib</A> and <A HREF='classes/gzip.html'>gzip</A> Filters should not be built.
|
|
</TD>
|
|
<TD ALIGN='center'>-</TD>
|
|
</TR>
|
|
<TR>
|
|
<TD><CODE>NO_LIBBZ2</CODE></TD>
|
|
<TD>
|
|
Set to indicate that the <A HREF='classes/zlib.html'>bzip2</A> Filters should not be built.
|
|
</TD>
|
|
<TD ALIGN='center'>-</TD>
|
|
</TR>
|
|
<TR>
|
|
<TD><CODE>NO_COMPRESSION</CODE></TD>
|
|
<TD>
|
|
Set to indicate that none of the <A HREF='compression.html'>compression Filters</A> should be built.
|
|
</TD>
|
|
<TD ALIGN='center'>-</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- End Footnotes -->
|
|
|
|
<!-- Begin Footer -->
|
|
|
|
<HR>
|
|
<P CLASS='copyright'>Revised
|
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
20 May, 2004
|
|
<!--webbot bot="Timestamp" endspan i-checksum="38504" -->
|
|
</P>
|
|
|
|
<P CLASS='copyright'>© Copyright Jonathan Turkanis, 2004</P>
|
|
<P CLASS='copyright'>
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at <A HREF='http://www.boost.org/LICENSE_1_0.txt'>http://www.boost.org/LICENSE_1_0.txt</A>)
|
|
</P>
|
|
|
|
<!-- End Footer -->
|
|
|
|
</BODY> |