From 99391c9b90880c60b1ce76c963615673a2fd2bb1 Mon Sep 17 00:00:00 2001 From: Arvid Norberg Date: Sun, 27 Aug 2006 18:29:49 +0000 Subject: [PATCH] updated build documentation and moopolice link --- docs/manual.html | 304 ++++++++++++++++++++++----------------------- docs/manual.rst | 38 +++--- docs/projects.html | 2 +- docs/projects.rst | 2 +- 4 files changed, 173 insertions(+), 173 deletions(-) diff --git a/docs/manual.html b/docs/manual.html index 446e6f051..52208ac8a 100755 --- a/docs/manual.html +++ b/docs/manual.html @@ -24,153 +24,153 @@

Table of contents

@@ -406,8 +406,23 @@ boost.program-options symbols.

building with autotools

First of all, you need to install automake and autoconf. Many unix/linux systems comes with these preinstalled.

-
-

Step 1: Running configure

+
+

Step 1: Generating the build system

+

No build system is present if libtorrent is checked out from CVS - it +needs to be generated first. If you're building from a released tarball, +you may skip directly to Step 2: Running configure.

+

Execute the following commands, in the given order, to generate +the build system:

+
    +
  • aclocal -I m4
    • +
  • autoheader
    • +
  • libtoolize --copy --force
    • +
  • automake --add-missing --copy --gnu
    • +
  • autoconf
    • +
+
+
+

Step 2: Running configure

In your shell, change directory to the libtorrent directory and run ./configure. This will look for libraries and C++ features that libtorrent is dependent on. If something is missing or can't be found it will print an @@ -466,8 +481,8 @@ with the following option:

The above option make use of -DNDEBUG, which is used throughout libtorrent.

-
-

Step 2: Building libtorrent

+
+

Step 3: Building libtorrent

Once the configure script is run successfully, you just type make and libtorrent, the examples and the tests will be built.

When libtorrent is built it may be a good idea to run the tests, you do this @@ -480,21 +495,6 @@ make clean make

-
-

generating the build system

-

No build system is present if libtorrent is checked out from CVS - it -needs to be generated first.

-

Execute the following commands to generate the build system:

-
    -
  • autoheader
    • -
  • aclocal -I m4
    • -
  • libtoolize --copy --force
    • -
  • automake --add-missing --copy --gnu
    • -
  • autoconf
    • -
-

After generating the build system, run configure and build -libtorrent. This was described earlier.

-

building with other build systems

@@ -689,8 +689,8 @@ class session: public boost::noncopyable

Once it's created, the session object will spawn the main thread that will do all the work. The main thread will be idle as long it doesn't have any torrents to participate in.

-
-

session()

+
+

session()

 session(fingerprint const& print = libtorrent::fingerprint("LT", 0, 1, 0, 0));
@@ -708,8 +708,8 @@ The other constructor, that takes a port range and an interface as well as the f
 will automatically try to listen on a port on the given interface. For more information about
 the parameters, see listen_on() function.
-
-

~session()

+
+

~session()

The destructor of session will notify all trackers that our torrents have been shut down. If some trackers are down, they will time out. All this before the destructor of session returns. So, it's advised that any kind of interface (such as windows) are closed before @@ -1207,8 +1207,8 @@ public: sha1_hash const& hash_for_piece(unsigned int index) const; }; -

-

torrent_info()

+
+

torrent_info()

 torrent_info();
@@ -1766,8 +1766,8 @@ sha1_hash info_hash() const;

info_hash() returns the info-hash for the torrent.

-
-

set_max_uploads() set_max_connections()

+
+

set_max_uploads() set_max_connections()

 void set_max_uploads(int max_uploads) const;
@@ -1815,8 +1815,8 @@ std::vector<char> const& metadata() const;
 .torrent file. This buffer will be valid as long as the torrent is still running. When hashed,
 it will produce the same hash as the info-hash.
-
-

status()

+
+

status()

 torrent_status status() const;
@@ -2348,8 +2348,8 @@ public:
 };
-
-

ip_filter()

+
+

ip_filter()

 ip_filter()
diff --git a/docs/manual.rst b/docs/manual.rst
index 4887f01f1..8d83ca45e 100755
--- a/docs/manual.rst
+++ b/docs/manual.rst
@@ -297,7 +297,24 @@ building with autotools
 First of all, you need to install ``automake`` and ``autoconf``. Many
 unix/linux systems comes with these preinstalled.
 
-Step 1: Running configure
+Step 1: Generating the build system
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+No build system is present if libtorrent is checked out from CVS - it
+needs to be generated first. If you're building from a released tarball,
+you may skip directly to `Step 2: Running configure`_.
+
+Execute the following commands, in the given order, to generate
+the build system:
+
+*  aclocal -I m4
+*  autoheader
+*  libtoolize --copy --force
+*  automake --add-missing --copy --gnu
+*  autoconf
+
+
+Step 2: Running configure
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In your shell, change directory to the libtorrent directory and run
@@ -362,7 +379,7 @@ with the following option::
 
 The above option make use of -DNDEBUG, which is used throughout libtorrent.
 
-Step 2: Building libtorrent
+Step 3: Building libtorrent
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Once the configure script is run successfully, you just type ``make`` and
@@ -378,23 +395,6 @@ invariant checks), you have to rerun the configure script and rebuild, like this
   make clean
   make
 
-generating the build system
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-No build system is present if libtorrent is checked out from CVS - it
-needs to be generated first.
-
-Execute the following commands to generate the build system:
-
-*  autoheader
-*  aclocal -I m4
-*  libtoolize --copy --force
-*  automake --add-missing --copy --gnu
-*  autoconf
-
-After generating the build system, run configure and build
-libtorrent. This was described earlier.
-
 building with other build systems
 ---------------------------------
   
diff --git a/docs/projects.html b/docs/projects.html
index 3ac427141..71849120e 100644
--- a/docs/projects.html
+++ b/docs/projects.html
@@ -54,7 +54,7 @@ Inline emphasis start-string without end-string.

MooPolice

-

MooPolice is a windows bittorrent +

MooPolice is a windows bittorrent client with a quite unique look.

moopolice_thumb.gif
diff --git a/docs/projects.rst b/docs/projects.rst index b935bbf17..14b16057f 100644 --- a/docs/projects.rst +++ b/docs/projects.rst @@ -86,7 +86,7 @@ project listed here, let me_ know. .. _`electric sheep`: http://electricsheep.org .. _qBittorrent: http://www.qbittorrent.org/ .. _btg: http://developer.berlios.de/projects/btg/ -.. _MooPolice: http://www.massaroddel.de/MooPolice/ +.. _MooPolice: http://www.moopolice.de .. _BitsCast: http://www.bitscast.com/software/ .. _BitSlug: http://bitslug.sourceforge.net/ .. _BitBuddy: http://www.btvampire.com