boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2024-12-26 23:30:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Regenerate after RST changes

Browse Source
This commit is contained in:
Glen Fernandes 2022-12-14 20:19:41 -05:00
parent fc705aefc2
commit f51f30728a
2 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
getting_started/unix-variants.html
View File

@ -61,14 +61,14 @@
<div class="section" id="get-boost"> <div class="section" id="get-boost">
<h1><a class="toc-backref" href="#id20">1&nbsp;&nbsp;&nbsp;Get Boost</a></h1> <h1><a class="toc-backref" href="#id20">1&nbsp;&nbsp;&nbsp;Get Boost</a></h1>
<p>The most reliable way to get a copy of Boost is to download a <p>The most reliable way to get a copy of Boost is to download a
distribution from <a class="reference external" href="http://www.boost.org/users/history/version_1_81_0.html">SourceForge</a>:</p> distribution from <a class="reference external" href="http://www.boost.org/users/history/version_1_82_0.html">SourceForge</a>:</p>
<ol class="arabic"> <ol class="arabic">
<li><p class="first">Download <a class="reference external" href="http://www.boost.org/users/history/version_1_81_0.html"><tt class="docutils literal">boost_1_81_0</tt><tt class="docutils literal">.tar.bz2</tt></a>.</p> <li><p class="first">Download <a class="reference external" href="http://www.boost.org/users/history/version_1_82_0.html"><tt class="docutils literal">boost_1_82_0</tt><tt class="docutils literal">.tar.bz2</tt></a>.</p>
</li> </li>
<li><p class="first">In the directory where you want to put the Boost installation, <li><p class="first">In the directory where you want to put the Boost installation,
execute</p> execute</p>
<pre class="literal-block"> <pre class="literal-block">
tar --bzip2 -xf <em>/path/to/</em><tt class="docutils literal">boost_1_81_0</tt>.tar.bz2 tar --bzip2 -xf <em>/path/to/</em><tt class="docutils literal">boost_1_82_0</tt>.tar.bz2
</pre> </pre>
</li> </li>
</ol> </ol>
@ -81,7 +81,7 @@ creators usually choose to break Boost up into several packages,
reorganize the directory structure of the Boost distribution, reorganize the directory structure of the Boost distribution,
and/or rename the library binaries.<a class="footnote-reference" href="#packagers" id="id2"><sup>1</sup></a> If you have and/or rename the library binaries.<a class="footnote-reference" href="#packagers" id="id2"><sup>1</sup></a> If you have
any trouble, we suggest using an official Boost distribution any trouble, we suggest using an official Boost distribution
from <a class="reference external" href="http://www.boost.org/users/history/version_1_81_0.html">SourceForge</a>.</p> from <a class="reference external" href="http://www.boost.org/users/history/version_1_82_0.html">SourceForge</a>.</p>
</div> </div>
<!-- Copyright David Abrahams 2006. Distributed under the Boost --> <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying --> <!-- Software License, Version 1.0. (See accompanying -->
@ -91,7 +91,7 @@ from <a class="reference external" href="http://www.boost.org/users/history/vers
<h1><a class="toc-backref" href="#id21">2&nbsp;&nbsp;&nbsp;The Boost Distribution</a></h1> <h1><a class="toc-backref" href="#id21">2&nbsp;&nbsp;&nbsp;The Boost Distribution</a></h1>
<p>This is a sketch of the resulting directory structure:</p> <p>This is a sketch of the resulting directory structure:</p>
<pre class="literal-block"> <pre class="literal-block">
<strong>boost_1_81_0</strong><strong>/</strong> .................<em>The “boost root directory”</em> <strong>boost_1_82_0</strong><strong>/</strong> .................<em>The “boost root directory”</em>
<strong>index.htm</strong> .........<em>A copy of www.boost.org starts here</em> <strong>index.htm</strong> .........<em>A copy of www.boost.org starts here</em>
<strong>boost</strong><strong>/</strong> .........................<em>All Boost Header files</em> <strong>boost</strong><strong>/</strong> .........................<em>All Boost Header files</em>
``&nbsp;`` ``&nbsp;``
@ -136,7 +136,7 @@ anything you can use in these directories.</p>
</div> </div>
<p>It's important to note the following:</p> <p>It's important to note the following:</p>
<ol class="arabic" id="boost-root-directory"> <ol class="arabic" id="boost-root-directory">
<li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal">/usr/local/</tt><tt class="docutils literal">boost_1_81_0</tt>) is <li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal">/usr/local/</tt><tt class="docutils literal">boost_1_82_0</tt>) is
sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and
mailing lists .</p> mailing lists .</p>
</li> </li>
@ -244,7 +244,7 @@ int main()
<p>Now, in the directory where you saved <tt class="docutils literal">example.cpp</tt>, issue the <p>Now, in the directory where you saved <tt class="docutils literal">example.cpp</tt>, issue the
following command:</p> following command:</p>
<pre class="literal-block"> <pre class="literal-block">
c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_81_0</tt> example.cpp -o example c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_82_0</tt> example.cpp -o example
</pre> </pre>
<p>To test the result, type:</p> <p>To test the result, type:</p>
<pre class="literal-block"> <pre class="literal-block">
@ -275,7 +275,7 @@ you'll need to acquire library binaries.</p>
<p>Issue the following commands in the shell (don't type <tt class="docutils literal">$</tt>; that <p>Issue the following commands in the shell (don't type <tt class="docutils literal">$</tt>; that
represents the shell's prompt):</p> represents the shell's prompt):</p>
<pre class="literal-block"> <pre class="literal-block">
<strong>$</strong> cd <em>path/to/</em><tt class="docutils literal">boost_1_81_0</tt> <strong>$</strong> cd <em>path/to/</em><tt class="docutils literal">boost_1_82_0</tt>
<strong>$</strong> ./bootstrap.sh --help <strong>$</strong> ./bootstrap.sh --help
</pre> </pre>
<p>Select your configuration options and invoke <tt class="docutils literal">./bootstrap.sh</tt> again <p>Select your configuration options and invoke <tt class="docutils literal">./bootstrap.sh</tt> again
@ -424,7 +424,7 @@ b2 <strong>--build-dir=</strong><a class="reference internal" href="#id11"><em>b
please see the <a class="reference external" href="../../tools/build/doc/html/index.html#bbv2.overview.invocation">Boost.Build documentation</a>.</p> please see the <a class="reference external" href="../../tools/build/doc/html/index.html#bbv2.overview.invocation">Boost.Build documentation</a>.</p>
<p>For example, your session might look like this:</p> <p>For example, your session might look like this:</p>
<pre class="literal-block"> <pre class="literal-block">
$ cd ~/<tt class="docutils literal">boost_1_81_0</tt> $ cd ~/<tt class="docutils literal">boost_1_82_0</tt>
$ b2 <strong>--build-dir=</strong>/tmp/build-boost <strong>toolset=</strong>gcc stage $ b2 <strong>--build-dir=</strong>/tmp/build-boost <strong>toolset=</strong>gcc stage
</pre> </pre>
<p>That will build static and shared non-debug multi-threaded variants of the libraries. To build all variants, pass the additional option, “<tt class="docutils literal"><span class="pre">--build-type=complete</span></tt>”.</p> <p>That will build static and shared non-debug multi-threaded variants of the libraries. To build all variants, pass the additional option, “<tt class="docutils literal"><span class="pre">--build-type=complete</span></tt>”.</p>
@ -540,14 +540,14 @@ project.</li>
<ol class="upperalpha"> <ol class="upperalpha">
<li><p class="first">You can specify the full path to each library:</p> <li><p class="first">You can specify the full path to each library:</p>
<pre class="literal-block"> <pre class="literal-block">
$ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_81_0</tt> example.cpp -o example <strong>\</strong> $ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_82_0</tt> example.cpp -o example <strong>\</strong>
<strong>~/boost/stage/lib/libboost_regex-gcc34-mt-d-1_36.a</strong> <strong>~/boost/stage/lib/libboost_regex-gcc34-mt-d-1_36.a</strong>
</pre> </pre>
</li> </li>
<li><p class="first">You can separately specify a directory to search (with <tt class="docutils literal"><span class="pre">-L</span></tt><em>directory</em>) and a library name to search for (with <tt class="docutils literal"><span class="pre">-l</span></tt><em>library</em>,<a class="footnote-reference" href="#lowercase-l" id="id15"><sup>2</sup></a> dropping the filename's leading <tt class="docutils literal">lib</tt> and trailing <li><p class="first">You can separately specify a directory to search (with <tt class="docutils literal"><span class="pre">-L</span></tt><em>directory</em>) and a library name to search for (with <tt class="docutils literal"><span class="pre">-l</span></tt><em>library</em>,<a class="footnote-reference" href="#lowercase-l" id="id15"><sup>2</sup></a> dropping the filename's leading <tt class="docutils literal">lib</tt> and trailing
suffix (<tt class="docutils literal">.a</tt> in this case):</p> suffix (<tt class="docutils literal">.a</tt> in this case):</p>
<pre class="literal-block"> <pre class="literal-block">
$ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_81_0</tt> example.cpp -o example <strong>\</strong> $ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_82_0</tt> example.cpp -o example <strong>\</strong>
<strong>-L~/boost/stage/lib/ -lboost_regex-gcc34-mt-d-1_36</strong> <strong>-L~/boost/stage/lib/ -lboost_regex-gcc34-mt-d-1_36</strong>
</pre> </pre>
<p>As you can see, this method is just as terse as method A for one <p>As you can see, this method is just as terse as method A for one

26
getting_started/windows.html
View File

@ -61,7 +61,7 @@ not supported—they may or may not work.</p>
<div class="section" id="get-boost"> <div class="section" id="get-boost">
<h1><a class="toc-backref" href="#id28">1&nbsp;&nbsp;&nbsp;Get Boost</a></h1> <h1><a class="toc-backref" href="#id28">1&nbsp;&nbsp;&nbsp;Get Boost</a></h1>
<p>The most reliable way to get a copy of Boost is to <p>The most reliable way to get a copy of Boost is to
download <a class="reference external" href="http://www.boost.org/users/history/version_1_81_0.html"><tt class="docutils literal">boost_1_81_0</tt><tt class="docutils literal">.7z</tt></a> or <a class="reference external" href="http://www.boost.org/users/history/version_1_81_0.html"><tt class="docutils literal">boost_1_81_0</tt><tt class="docutils literal">.zip</tt></a> and unpack it to install a complete Boost download <a class="reference external" href="http://www.boost.org/users/history/version_1_82_0.html"><tt class="docutils literal">boost_1_82_0</tt><tt class="docutils literal">.7z</tt></a> or <a class="reference external" href="http://www.boost.org/users/history/version_1_82_0.html"><tt class="docutils literal">boost_1_82_0</tt><tt class="docutils literal">.zip</tt></a> and unpack it to install a complete Boost
distribution.<a class="footnote-reference" href="#zip" id="id2"><sup>1</sup></a></p> distribution.<a class="footnote-reference" href="#zip" id="id2"><sup>1</sup></a></p>
<!-- Copyright David Abrahams 2006. Distributed under the Boost --> <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying --> <!-- Software License, Version 1.0. (See accompanying -->
@ -71,7 +71,7 @@ distribution.<a class="footnote-reference" href="#zip" id="id2"><sup>1</sup></a>
<h1><a class="toc-backref" href="#id29">2&nbsp;&nbsp;&nbsp;The Boost Distribution</a></h1> <h1><a class="toc-backref" href="#id29">2&nbsp;&nbsp;&nbsp;The Boost Distribution</a></h1>
<p>This is a sketch of the resulting directory structure:</p> <p>This is a sketch of the resulting directory structure:</p>
<pre class="literal-block"> <pre class="literal-block">
<strong>boost_1_81_0</strong><strong>\</strong> .................<em>The “boost root directory”</em> <strong>boost_1_82_0</strong><strong>\</strong> .................<em>The “boost root directory”</em>
<strong>index.htm</strong> .........<em>A copy of www.boost.org starts here</em> <strong>index.htm</strong> .........<em>A copy of www.boost.org starts here</em>
<strong>boost</strong><strong>\</strong> .........................<em>All Boost Header files</em> <strong>boost</strong><strong>\</strong> .........................<em>All Boost Header files</em>
<strong>lib</strong><strong>\</strong> .....................<em>precompiled library binaries</em> <strong>lib</strong><strong>\</strong> .....................<em>precompiled library binaries</em>
@ -116,7 +116,7 @@ anything you can use in these directories.</p>
</div> </div>
<p>It's important to note the following:</p> <p>It's important to note the following:</p>
<ol class="arabic" id="boost-root-directory"> <ol class="arabic" id="boost-root-directory">
<li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_81_0</tt>) is <li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_82_0</tt>) is
sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and
mailing lists .</p> mailing lists .</p>
</li> </li>
@ -254,7 +254,7 @@ cd <em>path</em>\<em>to</em>\<em>some</em>\<em>directory</em>
</pre> </pre>
<p>followed by Return. For example,</p> <p>followed by Return. For example,</p>
<pre class="literal-block"> <pre class="literal-block">
cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_81_0</tt> cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_82_0</tt>
</pre> </pre>
<p class="last">Long commands can be continued across several lines by typing a <p class="last">Long commands can be continued across several lines by typing a
caret (<tt class="docutils literal">^</tt>) at the end of all but the last line. Some examples caret (<tt class="docutils literal">^</tt>) at the end of all but the last line. Some examples
@ -279,7 +279,7 @@ select <em>Properties</em> from the resulting pop-up menu</p>
<li><p class="first">In <em>Configuration Properties</em> &gt; <em>C/C++</em> &gt; <em>General</em> &gt; <em>Additional Include <li><p class="first">In <em>Configuration Properties</em> &gt; <em>C/C++</em> &gt; <em>General</em> &gt; <em>Additional Include
Directories</em>, enter the path to the Boost root directory, for example</p> Directories</em>, enter the path to the Boost root directory, for example</p>
<blockquote> <blockquote>
<p><tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_81_0</tt></p> <p><tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_82_0</tt></p>
</blockquote> </blockquote>
</li> </li>
<li><p class="first">In <em>Configuration Properties</em> &gt; <em>C/C++</em> &gt; <em>Precompiled Headers</em>, change <li><p class="first">In <em>Configuration Properties</em> &gt; <em>C/C++</em> &gt; <em>Precompiled Headers</em>, change
@ -317,7 +317,7 @@ Visual Studio compiler. In that window, set the <a class="reference internal" h
directory</a> to a suitable location for creating some temporary directory</a> to a suitable location for creating some temporary
files and type the following command followed by the Return key:</p> files and type the following command followed by the Return key:</p>
<pre class="literal-block"> <pre class="literal-block">
cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_81_0</tt> <em>path</em>\<em>to</em>\example.cpp cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_82_0</tt> <em>path</em>\<em>to</em>\example.cpp
</pre> </pre>
<p>To test the result, type:</p> <p>To test the result, type:</p>
<pre class="literal-block"> <pre class="literal-block">
@ -486,8 +486,8 @@ b2 <strong>--build-dir=</strong><a class="reference internal" href="#id13"><em>b
please see the <a class="reference external" href="../../tools/build/doc/html/index.html#bbv2.overview.invocation">Boost.Build documentation</a>.</p> please see the <a class="reference external" href="../../tools/build/doc/html/index.html#bbv2.overview.invocation">Boost.Build documentation</a>.</p>
<p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id15"><sup>3</sup></a></p> <p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id15"><sup>3</sup></a></p>
<pre class="literal-block"> <pre class="literal-block">
C:\WINDOWS&gt; cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_81_0</tt> C:\WINDOWS&gt; cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_82_0</tt>
<tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_81_0</tt>&gt; b2 <strong>^</strong> <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_82_0</tt>&gt; b2 <strong>^</strong>
More? <strong>--build-dir=</strong>&quot;C:\Documents and Settings\dave\build-boost&quot; <strong>^</strong> More? <strong>--build-dir=</strong>&quot;C:\Documents and Settings\dave\build-boost&quot; <strong>^</strong>
More? <strong>--build-type=complete</strong> <strong>msvc</strong> stage More? <strong>--build-type=complete</strong> <strong>msvc</strong> stage
</pre> </pre>
@ -626,7 +626,7 @@ earlier:</p>
select <em>Properties</em> from the resulting pop-up menu</li> select <em>Properties</em> from the resulting pop-up menu</li>
<li>In <em>Configuration Properties</em> &gt; <em>Linker</em> &gt; <em>Additional Library <li>In <em>Configuration Properties</em> &gt; <em>Linker</em> &gt; <em>Additional Library
Directories</em>, enter the path to the Boost binaries, Directories</em>, enter the path to the Boost binaries,
e.g. <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_81_0</tt><tt class="docutils literal">\lib\</tt>.</li> e.g. <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_82_0</tt><tt class="docutils literal">\lib\</tt>.</li>
<li>From the <em>Build</em> menu, select <em>Build Solution</em>.</li> <li>From the <em>Build</em> menu, select <em>Build Solution</em>.</li>
</ol> </ol>
<p><a class="reference internal" href="#test-your-program"><em>skip to the next step</em></a></p> <p><a class="reference internal" href="#test-your-program"><em>skip to the next step</em></a></p>
@ -636,10 +636,10 @@ e.g. <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boos
<p>For example, we can compile and link the above program from the <p>For example, we can compile and link the above program from the
Visual C++ command-line by simply adding the <strong>bold</strong> text below to Visual C++ command-line by simply adding the <strong>bold</strong> text below to
the command line we used earlier, assuming your Boost binaries are the command line we used earlier, assuming your Boost binaries are
in <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_81_0</tt><tt class="docutils literal">\lib</tt>:</p> in <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_82_0</tt><tt class="docutils literal">\lib</tt>:</p>
<pre class="literal-block"> <pre class="literal-block">
cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_81_0</tt> example.cpp <strong>^</strong> cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_82_0</tt> example.cpp <strong>^</strong>
<strong>/link /LIBPATH:</strong><strong>C:\Program Files\boost\</strong><strong>boost_1_81_0</strong><strong>\lib</strong> <strong>/link /LIBPATH:</strong><strong>C:\Program Files\boost\</strong><strong>boost_1_82_0</strong><strong>\lib</strong>
</pre> </pre>
</div> </div>
<div class="section" id="library-naming"> <div class="section" id="library-naming">
@ -864,7 +864,7 @@ mailing list</a>.</p>
<colgroup><col class="label" /><col /></colgroup> <colgroup><col class="label" /><col /></colgroup>
<tbody valign="top"> <tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>We recommend <tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>We recommend
downloading <a class="reference external" href="http://www.boost.org/users/history/version_1_81_0.html"><tt class="docutils literal">boost_1_81_0</tt><tt class="docutils literal">.7z</tt></a> and using <a class="reference external" href="http://www.7-zip.org">7-Zip</a> to decompress downloading <a class="reference external" href="http://www.boost.org/users/history/version_1_82_0.html"><tt class="docutils literal">boost_1_82_0</tt><tt class="docutils literal">.7z</tt></a> and using <a class="reference external" href="http://www.7-zip.org">7-Zip</a> to decompress
it. We no longer recommend .zip files for Boost because they are twice it. We no longer recommend .zip files for Boost because they are twice
as large as the equivalent .7z files. We don't recommend using Windows' as large as the equivalent .7z files. We don't recommend using Windows'
built-in decompression as it can be painfully slow for large archives.</td></tr> built-in decompression as it can be painfully slow for large archives.</td></tr>