From 99bc7aba7a885c8f3b03cd269b9cd488843ec287 Mon Sep 17 00:00:00 2001 From: Jonathan Robie Date: Mon, 4 Jan 2010 22:31:21 +0000 Subject: Converting wiki documentation to DocBook. This initial checkin is incomplete, and does not yet build. git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@895806 13f79535-47bb-0310-9956-ffa450edef68 --- qpid/doc/book/src/Book.xml | 49 ++++++++++++ qpid/doc/book/src/Book_Info.xml | 28 +++++++ qpid/doc/book/src/Download.xml | 142 ++++++++++++++++++++++++++++++++++ qpid/doc/book/src/Getting_Started.xml | 78 +++++++++++++++++++ qpid/doc/book/src/Introduction.xml | 83 ++++++++++++++++++++ qpid/doc/book/src/schemas.xml | 5 ++ 6 files changed, 385 insertions(+) create mode 100644 qpid/doc/book/src/Book.xml create mode 100644 qpid/doc/book/src/Book_Info.xml create mode 100644 qpid/doc/book/src/Download.xml create mode 100644 qpid/doc/book/src/Getting_Started.xml create mode 100644 qpid/doc/book/src/Introduction.xml create mode 100644 qpid/doc/book/src/schemas.xml diff --git a/qpid/doc/book/src/Book.xml b/qpid/doc/book/src/Book.xml new file mode 100644 index 0000000000..7b14c9b218 --- /dev/null +++ b/qpid/doc/book/src/Book.xml @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + diff --git a/qpid/doc/book/src/Book_Info.xml b/qpid/doc/book/src/Book_Info.xml new file mode 100644 index 0000000000..1eb52baf60 --- /dev/null +++ b/qpid/doc/book/src/Book_Info.xml @@ -0,0 +1,28 @@ + + + + + Apache Qpid + + 1 + 0 + Apache Qpid + 6 + + This is the user documentation for Apache Qpid. It describes how to download and install###. + + + + + + + + + &YEAR; + The Apache Software Foundation + + + + + diff --git a/qpid/doc/book/src/Download.xml b/qpid/doc/book/src/Download.xml new file mode 100644 index 0000000000..055174ef8d --- /dev/null +++ b/qpid/doc/book/src/Download.xml @@ -0,0 +1,142 @@ + + + +Download Apache Qpid + +
Production Releases + +These releases are well tested and appropriate for production use. 0.5 is the latest release of Qpid. + +Qpid supports the latest version of AMQP 0-10, and some components also the AMQP 0-8 and 0-9, earlier versions. The Java Broker and Client provide protocol negotiation. Other versions can be found at http://www.apache.org/dist/qpid/ + +For details on cross component compatibility among releases, see: AMQP Release Compatibility for Qpid|AMQP compatibility + +If you have any questions about these releases, please mail the user list (qpid-user@incubator.apache.org). + +
+ +
0.5 Release + +
Multiple Component Packages + + + + + + +
Component Download AMQP 0-10 AMQP 0-8/0-9
Full release & keys http://www.apache.org/dist/qpid/0.5/ Y Y
C+\+ broker & client http://www.apache.org/dist/qpid/0.5/qpid-cpp-0.5.tar.gz Y
Java broker, client & tools http://www.apache.org/dist/qpid/0.5/qpid-java-0.5.tar.gz client Y
+
+ +
Single Component Package + + + +Broker + + + + +
Language Download AMQP 0-10 AMQP 0-8/0-9
Java http://www.apache.org/dist/qpid/0.5/qpid-java-broker-0.5.tar.gz Y
+ + + +Client + + + + + + + + +
Language Download AMQP 0-10 AMQP 0-8/0-9
C# (.NET, WCF, Excel) 0-10 client (C+\+ Broker Compatible) http://www.apache.org/dist/qpid/0.5/qpid-dotnet-0-10-0.5.zip Y
C# (.NET) 0-8 client (Java Broker Compatible) http://www.apache.org/dist/qpid/0.5/qpid-dotnet-0-8-0.5.zip Y
Java http://www.apache.org/dist/qpid/0.5/qpid-java-client-0.5.tar.gz Y Y
Python http://www.apache.org/dist/qpid/0.5/qpid-python-0.5.tar.gz Y Y
Ruby http://www.apache.org/dist/qpid/0.5/qpid-ruby-0.5.tar.gz Y Y
+ + + +C+\+ broker management + + + + + +
Component Download AMQP 0-10
cmd line (packaged with python) http://www.apache.org/dist/qpid/0.5/qpid-python-0.5.tar.gz Y
QMan JMX bridge, WS-DM http://www.apache.org/dist/qpid/0.5/qpid-management-client-0.5.tar.gz Y
+ + + +Java broker management + + + + + +
Component Download
Eclipse RCP client Linux x86 +Linux x86_64 +Mac OS X +Windows x86 +
Command line interface http://www.apache.org/dist/qpid/0.5/qpid-management-tools-qpid-cli-0.5.tar.gz
+
+
+ + +
QpidComponents.org + +http://QpidComponents.org provides further components for Apache Qpid, including both persistence and management tools. These components are open source, but are not developed as part of the Apache Qpid project due to licensing or other restrictions. + +
+ + +
Contributed C++ Packages + +
Pre-built Linux Packages + +
Fedora 8, 9, 10 + +On Fedora, Qpid can be installed using yum. Because Java RPMs are not yet available in Fedora repos, the Java client is not in these distributions. + +To install the server: + +# yum install qpidd + +To install C+\+ and Python clients: + +# yum install qpidc-devel + + +# yum install amqp python-qpid + +To install documentation: + +# yum install rhm-docs + +To install persistence using an external store module: + +# yum install rhm + +
+
+ + +
Windows Installer + +The Windows installer is available from http://www.apache.org/dist/qpid/0.5-windows/qpidc-0.5.msi. It is built from the 0.5 C+\+ broker and client source distribution listed above. It has been tested for Windows XP SP2 and above. + +The Windows executables require the Visual C+\+ 2008 SP1 run-time components. If the Visual C+\+ 2008 SP1 runtime is not available, the Qpid broker will not execute. If you intend to run the broker and Visual C+\+ 2008 is not installed, you must install the Visual C+\+ 2008 SP1 Redistributable. Please see http://www.microsoft.com/downloads/details.aspx?familyid=A5C84275-3B97-4AB7-A40D-3802B2AF5FC2&displaylang=en for download and installation instructions. + +If you intend to develop Qpid client applications using this kit, you should install Boost version 1.35 (please be sure to select VC9 support when installing) in addition to Visual Studio 2008 SP1. + +
+
+ +
Source Code Repository + +The latest version of the code is always available in the Source Repository. + +
+ + + + diff --git a/qpid/doc/book/src/Getting_Started.xml b/qpid/doc/book/src/Getting_Started.xml new file mode 100644 index 0000000000..f48ab31ba5 --- /dev/null +++ b/qpid/doc/book/src/Getting_Started.xml @@ -0,0 +1,78 @@ + + +
+Downloading Apache Qpid + +
+ +
+Getting Started +To get started with Apache Qpid, follow the steps below. + + +Download the software [Download] + + Start a broker. + + Instructions for [running a Qpid Java broker (AMQP 0-8, 0-9) | Getting Started Guide] + Instructions for [running a Qpid C++ broker (AMQP 0-10) | RASC] + [Management tools | MgmtC++] (AMQP 0-10, works with the Qpid C++ broker) + + + + Run an example program from the downloaded software, or from the following URLs (these are svn URLs, which you can use to browse the examples or check them out): + + C++ (AMQP 0-10): + + Examples: [https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/ | https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/] + [Running the C++ Examples | https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/README.txt] + + + + Java JMS (AMQP 0-10): + + Examples: [https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/ | https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/] + [Script for Running the Java JMS Examples | https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/src/main/java/runSample.sh] + + + + Python (AMQP 0-10): + + Examples: [https://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/ | https://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/] + [Running the Python Examples | https://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/README] + + + + Ruby (AMQP 0-10): + + Examples: [https://svn.apache.org/repos/asf/qpid/trunk/qpid/ruby/examples/ | https://svn.apache.org/repos/asf/qpid/trunk/qpid/ruby/examples/] + + + + .NET (AMQP 0-10): + + Examples: [http://svn.apache.org/viewvc/qpid/trunk/qpid/dotnet/client-010/examples/ | http://svn.apache.org/viewvc/qpid/trunk/qpid/dotnet/client-010/examples/] + [.NET Tutorial | http://cwiki.apache.org/confluence/display/qpid/.NET+User+Guide] + + + + + + Read the API Guides and Documentation + + [C++ Client API (AMQP 0-10) | http://qpid.apache.org/docs/api/cpp/html/index.html] + [JNDI Configuration for Java JMS | http://cwiki.apache.org/confluence/display/qpid/How+to+Use+JNDI] + [Python Client API (AMQP 0-10) | http://qpid.apache.org/docs/api/python/html/index.html] + [Documentation] + + + + Get your Questions Answered + + Read the [FAQ|FAQ] + Ask a question on the user list mailto:users-subscribe@qpid.apache.org + + + +
+ \ No newline at end of file diff --git a/qpid/doc/book/src/Introduction.xml b/qpid/doc/book/src/Introduction.xml new file mode 100644 index 0000000000..3f1a82c75a --- /dev/null +++ b/qpid/doc/book/src/Introduction.xml @@ -0,0 +1,83 @@ + +Apache Qpid: Open Source AMQP Messaging + +Enterprise Messaging systems let programs communicate by exchanging messages, much as people communicate by exchanging email. Unlike email, enterprise messaging systems provide guaranteed delivery, speed, security, and freedom from spam. Until recently, there was no open standard for Enterprise Messaging systems, so programmers either wrote their own, or used expensive proprietary systems. + +AMQP Advanced Message Queuing Protocol is the first open standard for Enterprise Messaging. It is designed to support messaging for just about any distributed or business application. Routing can be configured flexibly, easily supporting common messaging paradigms like point-to-point, fanout, publish-subscribe, and request-response. + +Apache Qpid implements the latest AMQP specification, providing transaction management, queuing, distribution, security, management, clustering, federation and heterogeneous multi-platform support and a lot more. And Apache Qpid is extremely fast. Apache Qpid aims to be 100% AMQP Compliant. + +
+AMQP Messaging Brokers + +Qpid provides two AMQP messaging brokers: + + + Implemented in C++ - high performance, low latency, and RDMA support. + Implemented in Java - Fully JMS compliant, runs on any Java platform. + + +Both AMQP messaging brokers support clients in multiple languages, as long as the messaging client and the messaging broker use the same version of AMQP. See Download to see which messaging clients work with each broker. + +
+ +
+AMQP Client APIs: C++, Java, JMS, Ruby, Python, and C# + +Qpid provides AMQP Client APIs for the following languages: + + + C++ + Java, fully conformant with JMS 1.1 + C# .NET, 0-10 using WCF + Ruby + Python + + +
+ +
+Operating Systems and Platforms: + +The Qpid C++ broker runs on the following operating systems: + + + Linux systems + Windows + Solaris (coming soon) + + +The Qpid Java broker runs on: + + + Any Java platform + + +Qpid clients can be run on the following operating systems and platforms: + + + Java: + + any platform, production proven on Windows, Linux, Solaris + + + + + C++: + + Linux + Windows + Solaris (coming soon) + + + + C# + + .NET + + + + + +
+ \ No newline at end of file diff --git a/qpid/doc/book/src/schemas.xml b/qpid/doc/book/src/schemas.xml new file mode 100644 index 0000000000..8e6e68ccd4 --- /dev/null +++ b/qpid/doc/book/src/schemas.xml @@ -0,0 +1,5 @@ + + + + + -- cgit v1.2.1