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/11/26 20:12:45 UTC
svn commit: r1545787 - in /qpid/dispatch/trunk: CMakeLists.txt
doc/man/README doc/man/qdrouterd.conf.5 etc/qdrouterd.conf
Author: jross
Date: Tue Nov 26 19:12:45 2013
New Revision: 1545787
URL: http://svn.apache.org/r1545787
Log:
QPID-5367: Add license and other improvements to the qdrouterd.conf man page; remove documentation from qdrouterd.conf and reference the man page; add install logic
Added:
qpid/dispatch/trunk/doc/man/README
Modified:
qpid/dispatch/trunk/CMakeLists.txt
qpid/dispatch/trunk/doc/man/qdrouterd.conf.5
qpid/dispatch/trunk/etc/qdrouterd.conf
Modified: qpid/dispatch/trunk/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/CMakeLists.txt?rev=1545787&r1=1545786&r2=1545787&view=diff
==============================================================================
--- qpid/dispatch/trunk/CMakeLists.txt (original)
+++ qpid/dispatch/trunk/CMakeLists.txt Tue Nov 26 19:12:45 2013
@@ -132,6 +132,7 @@ 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
Added: qpid/dispatch/trunk/doc/man/README
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/man/README?rev=1545787&view=auto
==============================================================================
--- qpid/dispatch/trunk/doc/man/README (added)
+++ qpid/dispatch/trunk/doc/man/README Tue Nov 26 19:12:45 2013
@@ -0,0 +1,44 @@
+# A really quick guide to nroff and man-page macros
+
+## The title heading
+
+ .TH <name> <section>
+ .TH somefile.conf 5
+ .TH somedaemon 8
+
+## Section headings
+
+ .SH <text>
+ .SH OPTIONS
+ .SH "SOMETHING ELSE"
+
+## Subsection headings
+
+ .SS <text>
+
+## Indented paragraphs for named items
+
+ .IP <item-name>
+ <item-text>
+
+## Paragraph breaks
+
+ .P
+
+## Bold and italic
+
+ .B "some bold text"
+ .I "some italic text"
+ Some \fBbold text\fP
+ Some \fIitalic text\fP
+
+## Things to keep in mind
+
+ - Arguments containing spaces must be quoted: "some arg"
+ - Dot macros must start on their own line
+
+## More information
+
+ - http://linux.die.net/man/7/man-pages
+ - http://linux.die.net/man/7/man
+ - http://www.fnal.gov/docs/products/ups/ReferenceManual/html/manpages.html
Modified: qpid/dispatch/trunk/doc/man/qdrouterd.conf.5
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/man/qdrouterd.conf.5?rev=1545787&r1=1545786&r2=1545787&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/man/qdrouterd.conf.5 (original)
+++ qpid/dispatch/trunk/doc/man/qdrouterd.conf.5 Tue Nov 26 19:12:45 2013
@@ -1,11 +1,30 @@
-.TH QDROUTERD.CONF 5 "QPID DISPATCH" "Apache Qpid" \" -*- nroff -*-
+.\" -*- 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
+qdrouterd.conf \- Configuration file for the Qpid Dispatch router
+.\" XXX .SH DESCRIPTION
+.\" when loaded, reloaded (sighup?)
+.\" XXX .SH SYNTAX
.SH OPTIONS
-.SS "container - Container settings"
+.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
@@ -14,7 +33,7 @@ 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 - SSL profiles"
+.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
@@ -39,14 +58,14 @@ password-file is to supply the password
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, connector - Connection settings"
+.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 - Router settings"
+.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
@@ -57,16 +76,16 @@ router operates with an uplink into an i
routers are typically used as connection concentrators or as security
firewalls for access into the interior network.
.IP router-id
-Each router is assigned a router-id that is unique. For interior
+Each router \fIis\fP assigned a router-id that is unique. For interior
router mode only.
-\" XXX .SH EXAMPLES
+.\" XXX .SH EXAMPLES
.SH FILES
.I /etc/qpid-dispatch/qdrouterd.conf
-.br
.SH SEE ALSO
.BR qdrouterd (8),
.BR qdstat (8),
.BR qdstat.conf (5)
.SH AUTHOR
-Apache Qpid, http://qpid.apache.org/
+Apache Qpid <http://qpid.apache.org/>
.SH COPYRIGHT
+Copyright 2013 The Apache Software Foundation
Modified: qpid/dispatch/trunk/etc/qdrouterd.conf
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/etc/qdrouterd.conf?rev=1545787&r1=1545786&r2=1545787&view=diff
==============================================================================
--- qpid/dispatch/trunk/etc/qdrouterd.conf (original)
+++ qpid/dispatch/trunk/etc/qdrouterd.conf Tue Nov 26 19:12:45 2013
@@ -17,112 +17,25 @@
## under the License
##
+# See the qdrouterd.conf (5) manual page for information about this
+# file's format and options.
-##
-## Container section - Configures the general operation of the AMQP container.
-##
container {
- ##
- ## worker-threads - The number of threads that will be created to
- ## process message traffic and other application work (timers, non-amqp
- ## file descriptors, etc.)
- ##
- ## The number of threads should be related to the number of available
- ## processor cores. To fully utilize a quad-core system, set the
- ## number of threads to 4.
- ##
worker-threads: 4
-
- ##
- ## 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.
- ##
container-name: Qpid.Dispatch.Router.A
}
-
-##
-## SSL Profile section - Zero or more SSL profiles may be defined here and
-## then referenced later in listeners (for incoming connections) or
-## connectors (for outgoing connectors).
-##
ssl-profile {
- ##
- ## name - The name of the profile to be referenced later.
- ##
name: ssl-profile-name
-
- ##
- ## cert-db - The path to the database that contains the public
- ## certificates of trusted certificate authorities (CAs).
- ##
- ## cert-db: /path/to/trusted-ca.db
-
- ##
- ## 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.
- ##
- ## cert-file: /path/to/cert-file.pem
-
- ##
- ## key-file - The path to the file containing the PEM-formatted private
- ## key for the above certificate.
- ##
- ## key-file: /path/to/private-key-file.pem
-
- ##
- ## 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.
- ##
- ## password-file: /path/to/password-file
-
- ##
- ## 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.
- ##
- ## password: <password>
}
-
-##
-## Listeners and Connectors
-##
listener {
addr: 0.0.0.0
port: amqp
sasl-mechanisms: ANONYMOUS
}
-
-##
-## Router section - Configure the AMQP router function.
-##
router {
- ##
- ## Router Mode:
- ##
- ## standalone - Standalone router. 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.
- ## interior - Interior router. The router operates in cooreration with other
- ## interior routers in an interconnected network.
- ## edge - Edge router. 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.
- ##
mode: standalone
-
- ##
- ## For Interior router mode only.
- ##
- ## router-id - Each router is assigned a router-id that is unique.
- ##
router-id: Router.A
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org