You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jr...@apache.org on 2013/12/02 13:36:32 UTC
svn commit: r1546978 - in /qpid/dispatch/trunk: CMakeLists.txt
doc/CMakeLists.txt doc/man/qdrouterd.8.in doc/man/qdrouterd.conf.5
doc/man/qdrouterd.conf.5.in
Author: jross
Date: Mon Dec 2 12:36:32 2013
New Revision: 1546978
URL: http://svn.apache.org/r1546978
Log:
QPID-5367: Add a man page for qdrouterd; move cmake logic for docs to its own file
Added:
qpid/dispatch/trunk/doc/CMakeLists.txt
qpid/dispatch/trunk/doc/man/qdrouterd.8.in
qpid/dispatch/trunk/doc/man/qdrouterd.conf.5.in
Removed:
qpid/dispatch/trunk/doc/man/qdrouterd.conf.5
Modified:
qpid/dispatch/trunk/CMakeLists.txt
Modified: qpid/dispatch/trunk/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/CMakeLists.txt?rev=1546978&r1=1546977&r2=1546978&view=diff
==============================================================================
--- qpid/dispatch/trunk/CMakeLists.txt (original)
+++ qpid/dispatch/trunk/CMakeLists.txt Mon Dec 2 12:36:32 2013
@@ -132,7 +132,6 @@ file(GLOB headers "include/qpid/dispatch
install(FILES ${headers} DESTINATION ${INCLUDE_INSTALL_DIR}/qpid/dispatch)
install(FILES include/qpid/dispatch.h DESTINATION ${INCLUDE_INSTALL_DIR}/qpid)
install(FILES etc/qdrouterd.conf DESTINATION ${SYSCONF_INSTALL_DIR}/qpid-dispatch)
-install(FILES doc/man/qdrouterd.conf.5 DESTINATION share/man/man5)
##
## Python modules installation
@@ -160,5 +159,6 @@ install(FILES ${DOC_FILES}
##
## Build Tests
##
+add_subdirectory(doc)
add_subdirectory(router)
add_subdirectory(tests)
Added: qpid/dispatch/trunk/doc/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/CMakeLists.txt?rev=1546978&view=auto
==============================================================================
--- qpid/dispatch/trunk/doc/CMakeLists.txt (added)
+++ qpid/dispatch/trunk/doc/CMakeLists.txt Mon Dec 2 12:36:32 2013
@@ -0,0 +1,24 @@
+##
+## Licensed to the Apache Software Foundation (ASF) under one
+## or more contributor license agreements. See the NOTICE file
+## distributed with this work for additional information
+## regarding copyright ownership. The ASF licenses this file
+## to you under the Apache License, Version 2.0 (the
+## "License"); you may not use this file except in compliance
+## with the License. You may obtain a copy of the License at
+##
+## http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing,
+## software distributed under the License is distributed on an
+## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+## KIND, either express or implied. See the License for the
+## specific language governing permissions and limitations
+## under the License.
+##
+
+configure_file(man/qdrouterd.8.in ${CMAKE_CURRENT_BINARY_DIR}/man/qdrouterd.8)
+configure_file(man/qdrouterd.conf.5.in ${CMAKE_CURRENT_BINARY_DIR}/man/qdrouterd.conf.5)
+
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/qdrouterd.8 DESTINATION ${MAN_INSTALL_DIR}/man8)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/qdrouterd.conf.5 DESTINATION ${MAN_INSTALL_DIR}/man5)
Added: qpid/dispatch/trunk/doc/man/qdrouterd.8.in
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/man/qdrouterd.8.in?rev=1546978&view=auto
==============================================================================
--- qpid/dispatch/trunk/doc/man/qdrouterd.8.in (added)
+++ qpid/dispatch/trunk/doc/man/qdrouterd.8.in Mon Dec 2 12:36:32 2013
@@ -0,0 +1,50 @@
+.\" -*- nroff -*-
+.\"
+.\" Licensed to the Apache Software Foundation (ASF) under one
+.\" or more contributor license agreements. See the NOTICE file
+.\" distributed with this work for additional information
+.\" regarding copyright ownership. The ASF licenses this file
+.\" to you under the Apache License, Version 2.0 (the
+.\" "License"); you may not use this file except in compliance
+.\" with the License. You may obtain a copy of the License at
+.\"
+.\" http://www.apache.org/licenses/LICENSE-2.0
+.\"
+.\" Unless required by applicable law or agreed to in writing,
+.\" software distributed under the License is distributed on an
+.\" "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.\" KIND, either express or implied. See the License for the
+.\" specific language governing permissions and limitations
+.\" under the License
+.\"
+.TH QDROUTERD 8
+.SH NAME
+qdrouterd \- AMQP message router
+.SH SYNOPSIS
+qdrouterd [OPTIONS]
+.SH DESCRIPTION
+The Qpid Dispatch router (qdrouterd) is a network daemon that directs
+AMQP 1.0 messages between endpoints, such as messaging clients and
+servers.
+.PP
+See <http://qpid.apache.org/components/dispatch-router/> for more
+information.
+.SH OPTIONS
+.IP "-c, --config=PATH"
+Load the configuration from PATH. The default is
+\fI/etc/qpid-dispatch/qdrouterd.conf\fP.
+.IP "-I, --include=PATH"
+Load the daemon's Python library code from PATH. The default is
+\fI${CMAKE_INSTALL_PREFIX}/lib/qpid-dispatch/python\fP.
+.IP "-h, --help"
+Display a brief usage message and exit.
+.SH FILES
+.I /etc/qpid-dispatch/qdrouterd.conf
+.SH SEE ALSO
+.BR qdrouterd.conf (5),
+.BR qdstat (8),
+.BR qdstat.conf (5)
+.SH AUTHOR
+Apache Qpid <http://qpid.apache.org/>
+.SH COPYRIGHT
+Copyright 2013 The Apache Software Foundation
Added: qpid/dispatch/trunk/doc/man/qdrouterd.conf.5.in
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/man/qdrouterd.conf.5.in?rev=1546978&view=auto
==============================================================================
--- qpid/dispatch/trunk/doc/man/qdrouterd.conf.5.in (added)
+++ qpid/dispatch/trunk/doc/man/qdrouterd.conf.5.in Mon Dec 2 12:36:32 2013
@@ -0,0 +1,91 @@
+.\" -*- nroff -*-
+.\"
+.\" Licensed to the Apache Software Foundation (ASF) under one
+.\" or more contributor license agreements. See the NOTICE file
+.\" distributed with this work for additional information
+.\" regarding copyright ownership. The ASF licenses this file
+.\" to you under the Apache License, Version 2.0 (the
+.\" "License"); you may not use this file except in compliance
+.\" with the License. You may obtain a copy of the License at
+.\"
+.\" http://www.apache.org/licenses/LICENSE-2.0
+.\"
+.\" Unless required by applicable law or agreed to in writing,
+.\" software distributed under the License is distributed on an
+.\" "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.\" KIND, either express or implied. See the License for the
+.\" specific language governing permissions and limitations
+.\" under the License
+.\"
+.TH QDROUTERD.CONF 5
+.SH NAME
+qdrouterd.conf \- Configuration file for the Qpid Dispatch router
+.\" XXX .SH DESCRIPTION
+.\" when loaded, reloaded (sighup?)
+.\" XXX .SH SYNTAX
+.SH OPTIONS
+.SS "'container' section"
+.IP container-name
+The name of the AMQP container. If not specified, the container name
+will be set to a value of the container's choosing. The automatically
+assigned container name is not guaranteed to be persistent across
+restarts of the container.
+.IP worker-threads
+The number of threads that will be created to process message traffic
+and other application work (timers, non-amqp file descriptors, etc.)
+.SS "'ssl-profile' section"
+.IP
+Zero or more SSL profiles may be defined and then referenced later in
+listeners (for incoming connections) or connectors (for outgoing
+connectors).
+.IP name
+The name of the profile to be referenced later.
+.IP cert-db
+The path to the database that contains the public certificates of
+trusted certificate authorities (CAs).
+.IP cert-file
+The path to the file containing the PEM-formatted public certificate
+to be used on the local end of any connections using this profile.
+.IP key-file
+The path to the file containing the PEM-formatted private key for the
+above certificate.
+.IP password-file
+If the above private key is password protected, this is the path to a
+file containing the password that unlocks the certificate key.
+.IP password
+An alternative to storing the password in a file referenced by
+password-file is to supply the password right here in the
+configuration file. This option can be used by supplying the password
+in the 'password' option. Don't use both password and password-file
+in the same profile.
+.SS "'listener' and 'connector' sections"
+.IP addr
+The listener or connector IP address
+.IP port
+The listener or connector port
+.IP sasl-mechanisms
+A list of accepted SASL mechanisms
+.SS "'router' section"
+.IP mode
+One of "standalone", "interior", or "edge". In standalone mode, the
+router operates as a single component. It does not participate in the
+routing protocol and therefore will not coorperate with other routers.
+In interior mode, the router operates in cooreration with other
+interior routers in an interconnected network. In edge mode, the
+router operates with an uplink into an interior router network. Edge
+routers are typically used as connection concentrators or as security
+firewalls for access into the interior network.
+.IP router-id
+Each router \fIis\fP assigned a router-id that is unique. For interior
+router mode only.
+.\" XXX .SH EXAMPLES
+.SH FILES
+.I /etc/qpid-dispatch/qdrouterd.conf
+.SH SEE ALSO
+.BR qdrouterd (8),
+.BR qdstat (8),
+.BR qdstat.conf (5)
+.SH AUTHOR
+Apache Qpid <http://qpid.apache.org/>
+.SH COPYRIGHT
+Copyright 2013 The Apache Software Foundation
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org