diff options
| author | Arseny Kapoulkine <arseny.kapoulkine@gmail.com> | 2014-11-18 09:30:19 -0800 |
|---|---|---|
| committer | Arseny Kapoulkine <arseny.kapoulkine@gmail.com> | 2014-11-18 09:30:19 -0800 |
| commit | 1a06d7d3de3d2f30eaf3d56b7b2d0fa3446d46d8 (patch) | |
| tree | 56951240c5b8027380dd6833708cd0c43a4ec23e /docs/manual/install.html | |
| parent | 3c048bbb5e64605cc4e3aa15e0a536eaf00f3c6f (diff) | |
docs: Regenerated documentation
Also fix documentation jam rules for Windows.
Diffstat (limited to 'docs/manual/install.html')
| -rw-r--r-- | docs/manual/install.html | 118 |
1 files changed, 58 insertions, 60 deletions
diff --git a/docs/manual/install.html b/docs/manual/install.html index 5675651..af662c1 100644 --- a/docs/manual/install.html +++ b/docs/manual/install.html @@ -4,15 +4,15 @@ <title>Installation</title> <link rel="stylesheet" href="../pugixml.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="../manual.html" title="pugixml 1.4"> -<link rel="up" href="../manual.html" title="pugixml 1.4"> -<link rel="prev" href="../manual.html" title="pugixml 1.4"> +<link rel="home" href="../manual.html" title="pugixml 1.5"> +<link rel="up" href="../manual.html" title="pugixml 1.5"> +<link rel="prev" href="../manual.html" title="pugixml 1.5"> <link rel="next" href="dom.html" title="Document object model"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table width="100%"><tr> <td> -<a href="http://pugixml.org/">pugixml 1.4</a> manual | +<a href="http://pugixml.org/">pugixml 1.5</a> manual | <a href="../manual.html">Overview</a> | <b>Installation</b> | Document: @@ -28,48 +28,48 @@ <hr> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="manual.install"></a><a class="link" href="install.html" title="Installation">Installation</a> +<a name="manual.install"></a><a class="link" href="install.html" title="Installation"> Installation</a> </h2></div></div></div> <div class="toc"><dl class="toc"> -<dt><span class="section"><a href="install.html#manual.install.getting">Getting pugixml</a></span></dt> +<dt><span class="section"><a href="install.html#manual.install.getting"> Getting pugixml</a></span></dt> <dd><dl> -<dt><span class="section"><a href="install.html#manual.install.getting.source">Source distributions</a></span></dt> -<dt><span class="section"><a href="install.html#manual.install.getting.subversion">Subversion repository</a></span></dt> -<dt><span class="section"><a href="install.html#manual.install.getting.git">Git repository</a></span></dt> +<dt><span class="section"><a href="install.html#manual.install.getting.source"> Source distributions</a></span></dt> +<dt><span class="section"><a href="install.html#manual.install.getting.git"> Git repository</a></span></dt> +<dt><span class="section"><a href="install.html#manual.install.getting.subversion"> Subversion repository</a></span></dt> </dl></dd> -<dt><span class="section"><a href="install.html#manual.install.building">Building pugixml</a></span></dt> +<dt><span class="section"><a href="install.html#manual.install.building"> Building pugixml</a></span></dt> <dd><dl> -<dt><span class="section"><a href="install.html#manual.install.building.embed">Building pugixml as +<dt><span class="section"><a href="install.html#manual.install.building.embed"> Building pugixml as a part of another static library/executable</a></span></dt> -<dt><span class="section"><a href="install.html#manual.install.building.static">Building pugixml as +<dt><span class="section"><a href="install.html#manual.install.building.static"> Building pugixml as a standalone static library</a></span></dt> -<dt><span class="section"><a href="install.html#manual.install.building.shared">Building pugixml as +<dt><span class="section"><a href="install.html#manual.install.building.shared"> Building pugixml as a standalone shared library</a></span></dt> -<dt><span class="section"><a href="install.html#manual.install.building.header">Using - pugixml in header-only mode</a></span></dt> -<dt><span class="section"><a href="install.html#manual.install.building.config">Additional configuration +<dt><span class="section"><a href="install.html#manual.install.building.header"> Using pugixml in header-only + mode</a></span></dt> +<dt><span class="section"><a href="install.html#manual.install.building.config"> Additional configuration options</a></span></dt> </dl></dd> -<dt><span class="section"><a href="install.html#manual.install.portability">Portability</a></span></dt> +<dt><span class="section"><a href="install.html#manual.install.portability"> Portability</a></span></dt> </dl></div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="manual.install.getting"></a><a class="link" href="install.html#manual.install.getting" title="Getting pugixml">Getting pugixml</a> +<a name="manual.install.getting"></a><a class="link" href="install.html#manual.install.getting" title="Getting pugixml"> Getting pugixml</a> </h3></div></div></div> <p> pugixml is distributed in source form. You can either download a source distribution - or checkout the Subversion repository. + or clone the Git repository. </p> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="manual.install.getting.source"></a><a class="link" href="install.html#manual.install.getting.source" title="Source distributions">Source distributions</a> +<a name="manual.install.getting.source"></a><a class="link" href="install.html#manual.install.getting.source" title="Source distributions"> Source distributions</a> </h4></div></div></div> <p> You can download the latest source distribution via one of the following links: </p> -<pre class="programlisting"><a href="https://github.com/zeux/pugixml/releases/download/v1.4/pugixml-1.4.zip" target="_top">https://github.com/zeux/pugixml/releases/download/v1.4/pugixml-1.4.zip</a> -<a href="https://github.com/zeux/pugixml/releases/download/v1.4/pugixml-1.4.tar.gz" target="_top">https://github.com/zeux/pugixml/releases/download/v1.4/pugixml-1.4.tar.gz</a> +<pre class="programlisting"><a href="https://github.com/zeux/pugixml/releases/download/v1.5/pugixml-1.5.zip" target="_top">https://github.com/zeux/pugixml/releases/download/v1.5/pugixml-1.5.zip</a> +<a href="https://github.com/zeux/pugixml/releases/download/v1.5/pugixml-1.5.tar.gz" target="_top">https://github.com/zeux/pugixml/releases/download/v1.5/pugixml-1.5.tar.gz</a> </pre> <p> The distribution contains library source, documentation (the manual you're @@ -80,56 +80,54 @@ line endings. Otherwise the files in both archives are identical. </p> <p> - If you need an older version, you can download it from the <a href="http://code.google.com/p/pugixml/downloads/list" target="_top">version + If you need an older version, you can download it from the <a href="https://github.com/zeux/pugixml/releases" target="_top">version archive</a>. </p> </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="manual.install.getting.subversion"></a><a class="link" href="install.html#manual.install.getting.subversion" title="Subversion repository">Subversion repository</a> +<a name="manual.install.getting.git"></a><a class="link" href="install.html#manual.install.getting.git" title="Git repository"> Git repository</a> </h4></div></div></div> <p> - The Subversion repository is located at <a href="http://pugixml.googlecode.com/svn/" target="_top">http://pugixml.googlecode.com/svn/</a>. - There is a Subversion tag "release-{version}" for each version; - also there is the "latest" tag, which always points to the latest - stable release. + The Git repository is located at <a href="https://github.com/zeux/pugixml/" target="_top">https://github.com/zeux/pugixml/</a>. + There is a Git tag "v{version}" for each version; also there + is the "latest" tag, which always points to the latest stable + release. </p> <p> For example, to checkout the current version, you can use this command: </p> -<pre class="programlisting">svn checkout http://pugixml.googlecode.com/svn/tags/release-1.4 pugixml</pre> -<p> - To checkout the latest version, you can use this command: - </p> -<pre class="programlisting">svn checkout http://pugixml.googlecode.com/svn/tags/latest pugixml</pre> +<pre class="programlisting">git clone https://github.com/zeux/pugixml +cd pugixml +git checkout v1.5 +</pre> <p> The repository contains library source, documentation, code examples and full unit test suite. </p> <p> - Use latest version tag if you want to automatically get new versions via - <code class="literal">svn update</code>. Use other tags if you want to switch to - new versions only explicitly (for example, using <code class="literal">svn switch</code> - command). Also please note that Subversion trunk contains the work-in-progress - version of the code; while this means that you can get new features and - bug fixes from trunk without waiting for a new release, this also means - that occasionally the code can be broken in some configurations. + Use latest version tag if you want to automatically get new versions. Use + other tags if you want to switch to new versions only explicitly. Also + please note that the master branch contains the work-in-progress version + of the code; while this means that you can get new features and bug fixes + from master without waiting for a new release, this also means that occasionally + the code can be broken in some configurations. </p> </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="manual.install.getting.git"></a><a class="link" href="install.html#manual.install.getting.git" title="Git repository">Git repository</a> +<a name="manual.install.getting.subversion"></a><a class="link" href="install.html#manual.install.getting.subversion" title="Subversion repository"> Subversion repository</a> </h4></div></div></div> <p> - The Subversion repository is mirrored by a Git repository at <a href="https://github.com/zeux/pugixml" target="_top">https://github.com/zeux/pugixml</a>. - The mirror is frequently updated and has the same structure in terms of - tags and contents as Subversion repository. + You can access the Git repository via Subversion using <a href="https://github.com/zeux/pugixml" target="_top">https://github.com/zeux/pugixml</a> + URL. For example, to checkout the current version, you can use this command: </p> +<pre class="programlisting">svn checkout https://github.com/zeux/pugixml/tags/v1.5 pugixml</pre> </div> </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="manual.install.building"></a><a class="link" href="install.html#manual.install.building" title="Building pugixml">Building pugixml</a> +<a name="manual.install.building"></a><a class="link" href="install.html#manual.install.building" title="Building pugixml"> Building pugixml</a> </h3></div></div></div> <p> pugixml is distributed in source form without any pre-built binaries; you @@ -139,7 +137,7 @@ The complete pugixml source consists of three files - one source file, <code class="filename">pugixml.cpp</code>, and two header files, <code class="filename">pugixml.hpp</code> and <code class="filename">pugiconfig.hpp</code>. <code class="filename">pugixml.hpp</code> is the primary header which you need to include in order to use pugixml classes/functions; - <code class="filename">pugiconfig.hpp</code> is a supplementary configuration file (see <a class="xref" href="install.html#manual.install.building.config" title="Additional configuration options">Additional configuration + <code class="filename">pugiconfig.hpp</code> is a supplementary configuration file (see <a class="xref" href="install.html#manual.install.building.config" title="Additional configuration options"> Additional configuration options</a>). The rest of this guide assumes that <code class="filename">pugixml.hpp</code> is either in the current directory or in one of include directories of your projects, so that <code class="computeroutput"><span class="preprocessor">#include</span> <span class="string">"pugixml.hpp"</span></code> @@ -149,7 +147,7 @@ </p> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="manual.install.building.embed"></a><a class="link" href="install.html#manual.install.building.embed" title="Building pugixml as a part of another static library/executable">Building pugixml as +<a name="manual.install.building.embed"></a><a class="link" href="install.html#manual.install.building.embed" title="Building pugixml as a part of another static library/executable"> Building pugixml as a part of another static library/executable</a> </h4></div></div></div> <p> @@ -184,7 +182,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="manual.install.building.static"></a><a class="link" href="install.html#manual.install.building.static" title="Building pugixml as a standalone static library">Building pugixml as +<a name="manual.install.building.static"></a><a class="link" href="install.html#manual.install.building.static" title="Building pugixml as a standalone static library"> Building pugixml as a standalone static library</a> </h4></div></div></div> <p> @@ -194,7 +192,7 @@ are project files for Apple XCode3, Code::Blocks, Codelite, Microsoft Visual Studio 2005, 2008, 2010, and configuration scripts for CMake and premake4. You're welcome to submit project files/build scripts for other software; - see <a class="xref" href="../manual.html#manual.overview.feedback" title="Feedback">Feedback</a>. + see <a class="xref" href="../manual.html#manual.overview.feedback" title="Feedback"> Feedback</a>. </p> <p> There are two projects for each version of Microsoft Visual Studio: one @@ -247,7 +245,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="manual.install.building.shared"></a><a class="link" href="install.html#manual.install.building.shared" title="Building pugixml as a standalone shared library">Building pugixml as +<a name="manual.install.building.shared"></a><a class="link" href="install.html#manual.install.building.shared" title="Building pugixml as a standalone shared library"> Building pugixml as a standalone shared library</a> </h4></div></div></div> <p> @@ -282,10 +280,10 @@ </p></td></tr> </table></div> </div> -<div class="section"> +<a name="PUGIXML_HEADER_ONLY"></a><div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="manual.install.building.header"></a><a name="PUGIXML_HEADER_ONLY"></a><a class="link" href="install.html#manual.install.building.header" title="Using pugixml in header-only mode">Using - pugixml in header-only mode</a> +<a name="manual.install.building.header"></a><a class="link" href="install.html#manual.install.building.header" title="Using pugixml in header-only mode"> Using pugixml in header-only + mode</a> </h4></div></div></div> <p> It's possible to use pugixml in header-only mode. This means that all source @@ -324,7 +322,7 @@ <p> Note that it is safe to compile <code class="filename">pugixml.cpp</code> if <code class="computeroutput"><span class="identifier">PUGIXML_HEADER_ONLY</span></code> is defined - so if you want to i.e. use header-only mode only in Release - configuration, you can include pugixml.cpp in your project (see <a class="xref" href="install.html#manual.install.building.embed" title="Building pugixml as a part of another static library/executable">Building pugixml as + configuration, you can include pugixml.cpp in your project (see <a class="xref" href="install.html#manual.install.building.embed" title="Building pugixml as a part of another static library/executable"> Building pugixml as a part of another static library/executable</a>), and conditionally enable header-only mode in <code class="filename">pugiconfig.hpp</code>, i.e.: </p> @@ -336,7 +334,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="manual.install.building.config"></a><a class="link" href="install.html#manual.install.building.config" title="Additional configuration options">Additional configuration +<a name="manual.install.building.config"></a><a class="link" href="install.html#manual.install.building.config" title="Additional configuration options"> Additional configuration options</a> </h4></div></div></div> <p> @@ -358,7 +356,7 @@ as character type) and UTF-16/32 style interface (the in-memory text encoding is assumed to be UTF-16/32, depending on <code class="computeroutput"><span class="keyword">wchar_t</span></code> size, most functions use <code class="computeroutput"><span class="keyword">wchar_t</span></code> - as character type). See <a class="xref" href="dom.html#manual.dom.unicode" title="Unicode interface">Unicode interface</a> for more details. + as character type). See <a class="xref" href="dom.html#manual.dom.unicode" title="Unicode interface"> Unicode interface</a> for more details. </p> <p> <a name="PUGIXML_NO_XPATH"></a><code class="literal">PUGIXML_NO_XPATH</code> define disables XPath. @@ -388,7 +386,7 @@ is used instead. For example, to specify fixed calling convention, you can define <code class="computeroutput"><span class="identifier">PUGIXML_FUNCTION</span></code> to i.e. <code class="computeroutput"><span class="identifier">__fastcall</span></code>. Another - example is DLL import/export attributes in MSVC (see <a class="xref" href="install.html#manual.install.building.shared" title="Building pugixml as a standalone shared library">Building pugixml as + example is DLL import/export attributes in MSVC (see <a class="xref" href="install.html#manual.install.building.shared" title="Building pugixml as a standalone shared library"> Building pugixml as a standalone shared library</a>). </p> <div class="note"><table border="0" summary="Note"> @@ -406,7 +404,7 @@ <a name="PUGIXML_MEMORY_PAGE_SIZE"></a><code class="literal">PUGIXML_MEMORY_PAGE_SIZE</code>, <a name="PUGIXML_MEMORY_OUTPUT_STACK"></a><code class="literal">PUGIXML_MEMORY_OUTPUT_STACK</code> and <a name="PUGIXML_MEMORY_XPATH_PAGE_SIZE"></a><code class="literal">PUGIXML_MEMORY_XPATH_PAGE_SIZE</code> can be used to customize certain important sizes to optimize memory usage - for the application-specific patterns. For details see <a class="xref" href="dom.html#manual.dom.memory.tuning" title="Memory consumption tuning">Memory consumption tuning</a>. + for the application-specific patterns. For details see <a class="xref" href="dom.html#manual.dom.memory.tuning" title="Memory consumption tuning"> Memory consumption tuning</a>. </p> <p> <a name="PUGIXML_HAS_LONG_LONG"></a><code class="literal">PUGIXML_HAS_LONG_LONG</code> define enables @@ -422,7 +420,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="manual.install.portability"></a><a class="link" href="install.html#manual.install.portability" title="Portability">Portability</a> +<a name="manual.install.portability"></a><a class="link" href="install.html#manual.install.portability" title="Portability"> Portability</a> </h3></div></div></div> <p> pugixml is written in standard-compliant C++ with some compiler-specific @@ -502,7 +500,7 @@ <hr> <table width="100%"><tr> <td> -<a href="http://pugixml.org/">pugixml 1.4</a> manual | +<a href="http://pugixml.org/">pugixml 1.5</a> manual | <a href="../manual.html">Overview</a> | <b>Installation</b> | Document: |