Browse files

docs

  • Loading branch information...
1 parent 5d96057 commit ff39e22a3038d017aaf46786e0a6c58fc8f2f721 @gamato gamato committed Mar 5, 2013
Showing with 21 additions and 14 deletions.
  1. +14 −5 INSTALL
  2. +7 −9 README
View
19 INSTALL
@@ -4,7 +4,7 @@
Skytools modules use some other code to run, so you need to install the
following dependencies on the system where you want to build and run
-skytool applications.
+skytools based applications.
=== Build dependencies ===
@@ -64,17 +64,27 @@ The following configure options are available:
--prefix::
Path prefix where to install skytools files (default: /usr/local)
-
+
--with-python::
Name or full path of the Python executable to use. (default: python)
-
+
--with-pgconfig::
Name or full path to pg_config (default: pg_config)
--with-asciidoc::
If asciidoc should be used to re-generate manpages. Required when
building from GIT as the generated pages are not in repo.
+== Building without Makefile ==
+
+It is possible to build and install Python part of Skytools only.
+This is useful when no required build / devel tools (dependencies)
+are available (typically on Windows platform).
+
+Commands to run vary across platforms but usually go like this:
+
+ $ [sudo] python setup_pkgloader.py install
+ $ [sudo] python setup_skytools.py install [--sk3-subdir]
== Documentation ==
@@ -104,12 +114,11 @@ that simple anymore.
But simple nonetheless: install PgQ on the machine where you want to
run it, provider being the straightforward choice. Then install
londiste only on the box from where you want to launch the replication
-process, a good default begin the subscriber box this time.
+process, a good default being the subscriber box this time.
You can then install londiste on provider from the subscriber box with
the +londiste.py+ command line tool.
== Usage ==
Please refer to the documentation.
-
View
16 README
@@ -11,7 +11,7 @@ It contains the following modules:
=== PgQ ===
-PgQ is a queuing system written in PL/pgsql, Python and C code. It is
+PgQ is a queuing system written in PL/pgSQL, Python and C code. It is
based on snapshot-based event handling ideas from Slony-I, and is
written for general usage.
@@ -53,16 +53,15 @@ Replication tool written in Python, using PgQ as event transport.
Features:
- Tables can be added one-by-one into set.
-- Initial COPY for one table does not block event replay for other
- tables.
+- Initial COPY for one table does not block event replay for other tables.
- Can compare tables on both sides.
Documentation:
- Londiste script usage: doc/londiste3.txt
(also available as `man 1 londiste`)
-- Londiste HOWTOS: doc/howto/
+- Londiste HOWTOs: doc/howto/
=== walmgr ===
@@ -76,8 +75,7 @@ database server.
== Source tree contents ==
doc/::
- Documentation in asciidoc format. Source for both html
- and man pages.
+ Documentation in AsciiDoc format. Source for both html and man pages.
python/::
Python modules and primary executables - walmgr, londiste, qadmin, pgqadm.
@@ -108,7 +106,7 @@ sql/londiste/::
sql/ticker/::
PgQ ticker written in C.
-
+
scripts/::
Python scripts with lesser priority.
@@ -117,7 +115,7 @@ lib/::
debian/::
Debian packaging. This is for creating private packages,
- official Debian packages uses it's own packagin code.
+ official Debian packages use their own packaging code.
misc/::
Random scripts used for building.
@@ -135,4 +133,4 @@ Londiste 3 in parallel with Londiste 2.
5. Apply londiste.sql - this will throw error on CREATE SCHEMA, but should otherwise apply fine.
6. Start pgqd.
-The files mentined above are installed under $PREFIX/share/skytools3/ directory.
+The files mentioned above are installed under $PREFIX/share/skytools3/ directory.

0 comments on commit ff39e22

Please sign in to comment.