[Python-modules-commits] r28057 - in packages/fedmsg/trunk/debian (13 files)

olasd at users.alioth.debian.org olasd at users.alioth.debian.org
Sat Mar 8 21:21:30 UTC 2014 

    Date: Saturday, March 8, 2014 @ 21:21:29
  Author: olasd
Revision: 28057

Add handmade manpages instead of the sordid help2man hack

Added:
  packages/fedmsg/trunk/debian/manpages/
  packages/fedmsg/trunk/debian/manpages/fedmsg-announce.1
  packages/fedmsg/trunk/debian/manpages/fedmsg-collectd.1
  packages/fedmsg/trunk/debian/manpages/fedmsg-config.1
  packages/fedmsg/trunk/debian/manpages/fedmsg-gateway.1
  packages/fedmsg/trunk/debian/manpages/fedmsg-hub.1
  packages/fedmsg/trunk/debian/manpages/fedmsg-irc.1
  packages/fedmsg/trunk/debian/manpages/fedmsg-logger.1
  packages/fedmsg/trunk/debian/manpages/fedmsg-relay.1
  packages/fedmsg/trunk/debian/manpages/fedmsg-tail.1
  packages/fedmsg/trunk/debian/manpages/fedmsg-trigger.1
  packages/fedmsg/trunk/debian/python-fedmsg.manpages
Modified:
  packages/fedmsg/trunk/debian/rules

Added: packages/fedmsg/trunk/debian/manpages/fedmsg-announce.1
===================================================================
--- packages/fedmsg/trunk/debian/manpages/fedmsg-announce.1	                        (rev 0)
+++ packages/fedmsg/trunk/debian/manpages/fedmsg-announce.1	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,94 @@
+.TH FEDMSG-ANNOUNCE 1
+
+.SH NAME
+fedmsg\-announce \- send an announcement to the fedmsg bus
+
+.SH SYNOPSIS
+.B fedmsg\-announce
+.RB [ \-\-link
+.IR URL ]
+.RI [ "<common fedmsg options>" ]
+.PP
+.B fedmsg\-announce
+.RB [ \-h | \-\-help ]
+
+.SH DESCRIPTION
+.B fedmsg\-announce
+emits an announcement message to the fedmsg bus.
+.PP
+This command expects its message to come from its standard input.
+.PP
+Technically this command is a simpler version of
+.BR fedmsg\-logger (1)
+that emits on a special topic. It is expected that routing_policy is
+specified such that only restricted parties can issue fedmsg
+announcements.
+
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Print an help message and exit
+.TP
+.BR \-\-link " URL"
+Specify a link to go along with the announcement.
+
+.SH COMMON FEDMSG OPTIONS
+.TP
+.BR "\-\-io\-threads " IO_THREADS
+Number of io threads for 0mq to use
+.TP
+.BR "\-\-topic\-prefix " TOPIC_PREFIX
+Prefix for the topic of each message sent.
+.TP
+.BR "\-\-post\-init\-sleep " POST_INIT_SLEEP
+Number of seconds to sleep after initializing.
+.TP
+.BR "\-\-config\-filename " CONFIG_FILENAME
+Config file to use.
+.TP
+.BR \-\-print\-config
+Simply print out the configuration and exit. No action taken.
+.TP
+.BR "\-\-timeout " TIMEOUT
+Timeout in seconds for any blocking zmq operations.
+.TP
+.BR "\-\-high\-water\-mark " HIGH_WATER_MARK
+Limit on the number of messages in the queue before
+blocking.
+.TP
+.BR "\-\-linger " ZMQ_LINGER
+Number of milliseconds to wait before timing out connections.
+
+.SH EXAMPLES
+.IP
+echo "Debian jessie has been released." | fedmsg-announce --link https://www.debian.org/News/
+
+.SH SEE ALSO
+.PP
+.BR fedmsg\-logger (1)
+
+.SH AUTHORS
+.TP
+.BR "The Fedora Infrastructure team" " <\&messaging\-sig at lists\&.fedoraproject\&.org\&>"
+.RB "Wrote the " fedmsg " software\&."
+.TP
+.BR "Nicolas Dandrimont" " <\&olasd at debian\&.org\&>"
+Wrote this manpage for the Debian system\&.
+
+.SH COPYRIGHT
+.br
+Copyright \(co 2014 Nicolas Dandrimont
+.br
+.PP
+This manual page was written for the Debian system (and may be used by
+others)\&.
+.PP
+You can redistribute it and/or modify it under the terms of the GNU
+Lesser General Public License as published by the Free Software
+Foundation; either version 2.1 of the License, or (at your option) any
+later version.
+.PP
+On Debian systems, a copy of the license can be found in the
+.I /usr/share/common-licenses/LGPL-2.1
+file.
+.sp

Added: packages/fedmsg/trunk/debian/manpages/fedmsg-collectd.1
===================================================================
--- packages/fedmsg/trunk/debian/manpages/fedmsg-collectd.1	                        (rev 0)
+++ packages/fedmsg/trunk/debian/manpages/fedmsg-collectd.1	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,73 @@
+.TH FEDMSG-COLLECTD 1 
+.SH NAME
+fedmsg\-collectd \- collectd plugin for monitoring the fedmsg bus
+
+.SH SYNOPSIS
+.B fedmsg\-collectd
+.RB [ \-\-collectd\-interval
+.IR COLLECTD_INTERVAL ]
+.RI [ "<common fedmsg options>" ]
+.PP
+.B fedmsg\-collectd
+.RB [ \-h | \-\-help ]
+
+
+.SH DESCRIPTION
+Print machine-readable information for collectd to monitor the fedmsg bus.
+
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Print an help message and exit
+.TP
+.BR "\-\-collectd\-interval " COLLECTD_INTERVAL
+Number of seconds to sleep between collectd updates.
+
+.SH COMMON FEDMSG OPTIONS
+.TP
+.BR "\-\-io\-threads " IO_THREADS
+Number of io threads for 0mq to use
+.TP
+.BR "\-\-topic\-prefix " TOPIC_PREFIX
+Prefix for the topic of each message sent.
+.TP
+.BR "\-\-post\-init\-sleep " POST_INIT_SLEEP
+Number of seconds to sleep after initializing.
+.TP
+.BR "\-\-config\-filename " CONFIG_FILENAME
+Config file to use.
+.TP
+.BR \-\-print\-config
+Simply print out the configuration and exit. No action taken.
+.TP
+.BR "\-\-timeout " TIMEOUT
+Timeout in seconds for any blocking zmq operations.
+.TP
+.BR "\-\-high\-water\-mark " HIGH_WATER_MARK
+Limit on the number of messages in the queue before
+blocking.
+.TP
+.BR "\-\-linger " ZMQ_LINGER
+Number of milliseconds to wait before timing out connections.
+
+.SH "AUTHORS"
+.TP
+.BR "The Fedora Infrastructure team" " <\&messaging\-sig at lists\&.fedoraproject\&.org\&>"
+.RB "Wrote the " fedmsg " software\&."
+.TP
+.BR "Nicolas Dandrimont" " <\&olasd at debian\&.org\&>"
+Wrote this manpage for the Debian system\&.
+
+.SH "COPYRIGHT"
+.br
+Copyright \(co 2014 Nicolas Dandrimont
+.br
+.PP
+This manual page was written for the Debian system (and may be used by others)\&.
+.PP
+You can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
+.PP
+On Debian systems, a copy of the license can be found in the
+.I /usr/share/common-licenses/LGPL-2.1
+file.
+.sp

Added: packages/fedmsg/trunk/debian/manpages/fedmsg-config.1
===================================================================
--- packages/fedmsg/trunk/debian/manpages/fedmsg-config.1	                        (rev 0)
+++ packages/fedmsg/trunk/debian/manpages/fedmsg-config.1	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,71 @@
+.TH FEDMSG-CONFIG 1
+.SH NAME
+fedmsg-config \- query or print the parsed fedmsg configuration
+
+.SH SYNOPSIS
+.B fedmsg\-config
+.RB [ \-\-query
+.IR CONFIG_KEY ]
+.RB [ \-\-config\-filename
+.IR CONFIG_FILENAME ]
+.RB [ \-\-disable\-defaults ]
+.PP
+.B fedmsg\-config
+.RB [ \-h | \-\-help ]
+
+.SH DESCRIPTION
+Query or print the parsed fedmsg\-config.
+.PP
+.B fedmsg\-config
+is a simple utility that prints out the contents of the fully parsed fedmsg config as a JSON dictionary. It also allows the user to query a specific key of the config.
+
+.SH QUERY OPERATIONS
+The tool allows you to query a specific configuration key with the
+.BI "\-\-query " CONFIG_KEY
+option.
+.PP
+In query mode, the configuration key has the following syntax:
+.BI "fedmsg\-config \-\-query " foo.bar.baz
+prints the value of
+.I config["foo"]["bar"]["baz"]
+to the standard output.
+.PP
+If the configuration value is an atomic value, it is printed directly. If the
+value is a list, each item of that list gets printed line by line. Else, the
+value is printed as a JSON dictionary.
+
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Print an help message and exit
+.TP
+.BR "\-\-query " CONFIG_KEY
+Dump a given key from the parsed config instead of dumping all of it.
+.TP
+.BR "\-\-config\-filename " CONFIG_FILENAME
+Config file to use.
+.TP
+.BR \-\-disable\-defaults
+Disable the configuration defaults.
+
+.SH "AUTHORS"
+.TP
+.BR "The Fedora Infrastructure team" " <\&messaging\-sig at lists\&.fedoraproject\&.org\&>"
+.RB "Wrote the " fedmsg " software\&."
+.TP
+.BR "Nicolas Dandrimont" " <\&olasd at debian\&.org\&>"
+Wrote this manpage for the Debian system\&.
+
+.SH "COPYRIGHT"
+.br
+Copyright \(co 2014 Nicolas Dandrimont
+.br
+.PP
+This manual page was written for the Debian system (and may be used by others)\&.
+.PP
+You can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
+.PP
+On Debian systems, a copy of the license can be found in the
+.I /usr/share/common-licenses/LGPL-2.1
+file.
+.sp

Added: packages/fedmsg/trunk/debian/manpages/fedmsg-gateway.1
===================================================================
--- packages/fedmsg/trunk/debian/manpages/fedmsg-gateway.1	                        (rev 0)
+++ packages/fedmsg/trunk/debian/manpages/fedmsg-gateway.1	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,88 @@
+.TH FEDMSG-GATEWAY 1
+
+.SH NAME
+fedmsg\-gateway \- rebroadcast messages to a special fedmsg bus endpoint
+
+.SH SYNOPSIS
+.B fedmsg\-gateway
+.RB [ \-\-daemon ]
+.RI [ "<common fedmsg options>" ]
+.PP
+.B fedmsg\-gateway
+.RB [ \-h | \-\-help ]
+
+.SH DESCRIPTION
+.B fedmsg\-gateway
+is a repeater that rebroadcasts all the messages it receives to a
+special, "public" endpoint.  This is used to get messages from inside
+Fedora Infrastructure out to users.  Its communication is
+unidirectional: it does not relay messages from "outside the bus" back
+in.
+.PP
+The special zmq endpoint is specified by the presence of
+.I fedmsg.consumers.gateway.port
+in the config.
+.PP
+This service is what makes consuming messages outside a VPN/firewalled
+bus environment possible.
+
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Print an help message and exit
+.TP
+.B \-\-daemon
+Run in the background as a daemon.
+
+.SH COMMON FEDMSG OPTIONS
+.TP
+.BR "\-\-io\-threads " IO_THREADS
+Number of io threads for 0mq to use
+.TP
+.BR "\-\-topic\-prefix " TOPIC_PREFIX
+Prefix for the topic of each message sent.
+.TP
+.BR "\-\-post\-init\-sleep " POST_INIT_SLEEP
+Number of seconds to sleep after initializing.
+.TP
+.BR "\-\-config\-filename " CONFIG_FILENAME
+Config file to use.
+.TP
+.BR \-\-print\-config
+Simply print out the configuration and exit. No action taken.
+.TP
+.BR "\-\-timeout " TIMEOUT
+Timeout in seconds for any blocking zmq operations.
+.TP
+.BR "\-\-high\-water\-mark " HIGH_WATER_MARK
+Limit on the number of messages in the queue before
+blocking.
+.TP
+.BR "\-\-linger " ZMQ_LINGER
+Number of milliseconds to wait before timing out connections.
+
+.SH AUTHORS
+.TP
+.BR "The Fedora Infrastructure team" " <\&messaging\-sig at lists\&.fedoraproject\&.org\&>"
+.RB "Wrote the " fedmsg " software\&."
+.TP
+.BR "Nicolas Dandrimont" " <\&olasd at debian\&.org\&>"
+Wrote this manpage for the Debian system\&.
+
+.SH COPYRIGHT
+.br
+Copyright \(co 2014 Nicolas Dandrimont
+.br
+.PP
+This manual page was written for the Debian system (and may be used by
+others)\&.
+.PP
+You can redistribute it and/or modify it under the terms of the GNU
+Lesser General Public License as published by the Free Software
+Foundation; either version 2.1 of the License, or (at your option) any
+later version.
+.PP
+On Debian systems, a copy of the license can be found in the
+.I /usr/share/common-licenses/LGPL-2.1
+file.
+.sp

Added: packages/fedmsg/trunk/debian/manpages/fedmsg-hub.1
===================================================================
--- packages/fedmsg/trunk/debian/manpages/fedmsg-hub.1	                        (rev 0)
+++ packages/fedmsg/trunk/debian/manpages/fedmsg-hub.1	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,107 @@
+.TH FEDMSG-HUB 1
+
+.SH NAME
+fedmsg-hub \- all-purpose fedmsg consuming daemon
+
+.SH SYNOPSIS
+.B fedmsg\-hub
+.RB [ \-\-with\-consumers
+.IR EXPLICIT_HUB_CONSUMERS ]
+.RB [ \-\-websocket\-server\-port
+.IR MOKSHA.LIVESOCKET.WEBSOCKET.PORT ]
+.RB [ \-\-daemon ]
+.RI [ "<common fedmsg options>" ]
+.PP
+.B fedmsg\-hub
+.RB [ \-h | \-\-help ]
+
+.SH DESCRIPTION
+.PP
+.B fedmsg\-hub
+is the all\-purpose daemon for consuming messages on the fedmsg bus.
+This should be run on every host
+that has services which declare their own consumers.
+
+.B fedmsg\-hub
+will listen to every endpoint discovered in the fedmsg config and
+forward messages in-process to the locally-declared consumers.  It is a
+thin wrapper over a
+.BR moksha\-hub (1)
+.PP
+Other commands like
+.BR fedmsg\-irc (1)
+are just specialized, restricted versions of
+.BR fedmsg\-hub .
+.B fedmsg\-hub
+also houses the functions to run a websocket server.
+
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Print an help message and exit
+.TP
+.BR "-\-with\-consumers " EXPLICIT_HUB_CONSUMERS
+A comma\-delimited list of conumers to run.
+.TP
+.BR "\-\-websocket\-server\-port " MOKSHA.LIVESOCKET.WEBSOCKET.PORT
+Port on which to host the websocket server.
+.TP
+.BR \-\-daemon
+Run in the background as a daemon.
+
+.SH COMMON FEDMSG OPTIONS
+.TP
+.BR "\-\-io\-threads " IO_THREADS
+Number of io threads for 0mq to use
+.TP
+.BR "\-\-topic\-prefix " TOPIC_PREFIX
+Prefix for the topic of each message sent.
+.TP
+.BR "\-\-post\-init\-sleep " POST_INIT_SLEEP
+Number of seconds to sleep after initializing.
+.TP
+.BR "\-\-config\-filename " CONFIG_FILENAME
+Config file to use.
+.TP
+.BR \-\-print\-config
+Simply print out the configuration and exit. No action taken.
+.TP
+.BR "\-\-timeout " TIMEOUT
+Timeout in seconds for any blocking zmq operations.
+.TP
+.BR "\-\-high\-water\-mark " HIGH_WATER_MARK
+Limit on the number of messages in the queue before
+blocking.
+.TP
+.BR "\-\-linger " ZMQ_LINGER
+Number of milliseconds to wait before timing out connections.
+
+.SH SEE ALSO
+.PP
+.BR fedmsg\-irc (1)
+
+.SH AUTHORS
+.TP
+.BR "The Fedora Infrastructure team" " <\&messaging\-sig at lists\&.fedoraproject\&.org\&>"
+.RB "Wrote the " fedmsg " software\&."
+.TP
+.BR "Nicolas Dandrimont" " <\&olasd at debian\&.org\&>"
+Wrote this manpage for the Debian system\&.
+
+.SH COPYRIGHT
+.br
+Copyright \(co 2014 Nicolas Dandrimont
+.br
+.PP
+This manual page was written for the Debian system (and may be used by
+others)\&.
+.PP
+You can redistribute it and/or modify it under the terms of the GNU
+Lesser General Public License as published by the Free Software
+Foundation; either version 2.1 of the License, or (at your option) any
+later version.
+.PP
+On Debian systems, a copy of the license can be found in the
+.I /usr/share/common-licenses/LGPL-2.1
+file.
+.sp

Added: packages/fedmsg/trunk/debian/manpages/fedmsg-irc.1
===================================================================
--- packages/fedmsg/trunk/debian/manpages/fedmsg-irc.1	                        (rev 0)
+++ packages/fedmsg/trunk/debian/manpages/fedmsg-irc.1	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,84 @@
+.TH FEDMSG-IRC 1
+
+.SH NAME
+fedmsg\-irc \- relay messages from the fedmsg bus to any number of IRC channels
+
+.SH SYNOPSIS
+.B fedmsg\-irc
+.RB [ \-\-daemon ]
+.RI [ "<common fedmsg options>" ]
+.PP
+.B fedmsg\-irc
+.RB [ \-h | \-\-help ]
+
+.SH DESCRIPTION
+.PP
+.B fedmsg\-irc
+is a daemon that relays the messages received on the fedmsg bus to the IRC channels configured in the
+.I irc
+fedmsg configuration key.
+
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Print an help message and exit
+.TP
+.BR \-\-daemon
+Run in the background as a daemon.
+
+.SH COMMON FEDMSG OPTIONS
+.TP
+.BR "\-\-io\-threads " IO_THREADS
+Number of io threads for 0mq to use
+.TP
+.BR "\-\-topic\-prefix " TOPIC_PREFIX
+Prefix for the topic of each message sent.
+.TP
+.BR "\-\-post\-init\-sleep " POST_INIT_SLEEP
+Number of seconds to sleep after initializing.
+.TP
+.BR "\-\-config\-filename " CONFIG_FILENAME
+Config file to use.
+.TP
+.BR \-\-print\-config
+Simply print out the configuration and exit. No action taken.
+.TP
+.BR "\-\-timeout " TIMEOUT
+Timeout in seconds for any blocking zmq operations.
+.TP
+.BR "\-\-high\-water\-mark " HIGH_WATER_MARK
+Limit on the number of messages in the queue before
+blocking.
+.TP
+.BR "\-\-linger " ZMQ_LINGER
+Number of milliseconds to wait before timing out connections.
+
+.SH SEE ALSO
+.PP
+.BR fedmsg\-irc (1)
+
+.SH "AUTHORS"
+.TP
+.BR "The Fedora Infrastructure team" " <\&messaging\-sig at lists\&.fedoraproject\&.org\&>"
+.RB "Wrote the " fedmsg " software\&."
+.TP
+.BR "Nicolas Dandrimont" " <\&olasd at debian\&.org\&>"
+Wrote this manpage for the Debian system\&.
+
+.SH "COPYRIGHT"
+.br
+Copyright \(co 2014 Nicolas Dandrimont
+.br
+.PP
+This manual page was written for the Debian system (and may be used by
+others)\&.
+.PP
+You can redistribute it and/or modify it under the terms of the GNU
+Lesser General Public License as published by the Free Software
+Foundation; either version 2.1 of the License, or (at your option) any
+later version.
+.PP
+On Debian systems, a copy of the license can be found in the
+.I /usr/share/common-licenses/LGPL-2.1
+file.
+.sp

Added: packages/fedmsg/trunk/debian/manpages/fedmsg-logger.1
===================================================================
--- packages/fedmsg/trunk/debian/manpages/fedmsg-logger.1	                        (rev 0)
+++ packages/fedmsg/trunk/debian/manpages/fedmsg-logger.1	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,177 @@
+.TH FEDMSG-LOGGER 1
+
+.SH NAME
+fedmsg-logger \- simply emit messages from the command-line to the fedmsg bus
+
+.SH SYNOPSIS
+.B fedmsg\-logger
+.RB [ \-\-message
+.IR LOGGER_MESSAGE ]
+.RB [ \-\-json\-input ]
+.RB [ \-\-topic
+.IR TOPIC ]
+.RB [ \-\-modname
+.IR MODNAME ]
+.RB [ \-\-cert\-prefix
+.IR CERT_PREFIX ]
+.RI [ "<common fedmsg options>" ]
+.PP
+.B fedmsg\-logger
+.RB [ \-h | \-\-help ]
+
+.SH DESCRIPTION
+.B fedmsg\-logger
+is a simple command-line utility to send messages to the fedmsg bus. It
+is an ephemeral command, that doesn't bind a 0mq endpoint directly. It
+sends its messages to a
+.BR fedmsg\-relay (1)
+daemon that binds a persistent endpoint that the outside world can
+subscribe to.  If the
+.BR fedmsg\-relay (1)
+service is not running at the address specified in the config, then
+.B fedmsg\-logger
+will hang until that service becomes available.
+.PP
+If
+.B \-\-message
+is not specified, this command accepts messages from stdin.
+
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Print an help message and exit
+.TP
+.BR "\-\-message " LOGGER_MESSAGE
+The message to send.
+.TP
+.BR \-\-json\-input
+Take each line of input as JSON.
+.TP
+.BR "\-\-topic " TOPIC
+The topic to which the messages are sent. Defaults to
+.I log
+if unset.
+.TP
+.BR "\-\-modname " MODNAME
+The module name to which the messages are sent. Defaults to
+.I logger
+if unset.
+.TP
+.BR "\-\-cert\-prefix " CERT_PREFIX
+Specify a different cert from
+.\"FIXME this path is wrong in Debian.
+.I /etc/pki/fedmsg
+
+.SH COMMON FEDMSG OPTIONS
+.TP
+.BR "\-\-io\-threads " IO_THREADS
+Number of io threads for 0mq to use
+.TP
+.BR "\-\-topic\-prefix " TOPIC_PREFIX
+Prefix for the topic of each message sent.
+.TP
+.BR "\-\-post\-init\-sleep " POST_INIT_SLEEP
+Number of seconds to sleep after initializing.
+.TP
+.BR "\-\-config\-filename " CONFIG_FILENAME
+Config file to use.
+.TP
+.BR \-\-print\-config
+Simply print out the configuration and exit. No action taken.
+.TP
+.BR "\-\-timeout " TIMEOUT
+Timeout in seconds for any blocking zmq operations.
+.TP
+.BR "\-\-high\-water\-mark " HIGH_WATER_MARK
+Limit on the number of messages in the queue before
+blocking.
+.TP
+.BR "\-\-linger " ZMQ_LINGER
+Number of milliseconds to wait before timing out connections.
+
+.SH TOPIC CONSTRUCTION
+.PP
+The full topic to which the messages are sent is constructed from the
+.B topic_prefix
+and
+.B environment
+set in the fedmsg configuration, and the
+.BR "\-\-topic " TOPIC
+and
+.BR "\-\-modname " MODNAME
+options this way:
+.IP
+.BR <topic_prefix> . <environment> . MODNAME . TOPIC
+
+.SH CAVEATS
+.PP
+Note that when using
+.BR \-\-json\-input ,
+you must send valid JSON, including the use of double quotes as opposed
+to single quotes:
+.IP
+{"a": 1} is valid JSON.
+.IP
+{'a': 1} is invalid JSON.
+
+.SH EXAMPLES
+.PP
+Send a message from standard input in JSON format:
+.nf
+.RS
+echo '{"a": 1}' | fedmsg-logger --json-input
+.RE
+.fi
+.PP
+Send a message to the
+.I git.repo.update
+topic
+.nf
+.RS
+echo "Hai there." | fedmsg-logger --modname=git --topic=repo.update
+.RE
+.fi
+.PP
+Send a simple message:
+.nf
+.RS
+fedmsg-logger --message="This is a message."
+.RE
+.fi
+.PP
+Send a JSON-format message:
+.nf
+.RS
+fedmsg-logger --message='{"a": 1}' --json-input
+.RE
+.fi
+
+.SH SEE ALSO
+.PP
+.BR fedmsg\-relay "(1), " fedmsg\-announce (1)
+
+.SH "AUTHORS"
+.TP
+.BR "The Fedora Infrastructure team" " <\&messaging\-sig at lists\&.fedoraproject\&.org\&>"
+.RB "Wrote the " fedmsg " software\&."
+.TP
+.BR "Nicolas Dandrimont" " <\&olasd at debian\&.org\&>"
+Wrote this manpage for the Debian system\&.
+
+.SH "COPYRIGHT"
+.br
+Copyright \(co 2014 Nicolas Dandrimont
+.br
+.PP
+This manual page was written for the Debian system (and may be used by
+others)\&.
+.PP
+You can redistribute it and/or modify it under the terms of the GNU
+Lesser General Public License as published by the Free Software
+Foundation; either version 2.1 of the License, or (at your option) any
+later version.
+.PP
+On Debian systems, a copy of the license can be found in the
+.I /usr/share/common-licenses/LGPL-2.1
+file.
+.sp

Added: packages/fedmsg/trunk/debian/manpages/fedmsg-relay.1
===================================================================
--- packages/fedmsg/trunk/debian/manpages/fedmsg-relay.1	                        (rev 0)
+++ packages/fedmsg/trunk/debian/manpages/fedmsg-relay.1	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,92 @@
+.TH FEDMSG-RELAY 1
+
+.SH NAME
+fedmsg-relay \- relay connections from active loggers to the fedmsg bus
+
+.SH SYNOPSIS
+.B fedmsg\-relay
+.RB [ \-\-daemon ]
+.RI [ "<common fedmsg options>" ]
+.PP
+.B fedmsg\-relay
+.RB [ \-h | \-\-help ]
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Print an help message and exit
+.TP
+.BR \-\-daemon
+Run in the background as a daemon.
+
+.SH COMMON FEDMSG OPTIONS
+.TP
+.BR "\-\-io\-threads " IO_THREADS
+Number of io threads for 0mq to use
+.TP
+.BR "\-\-topic\-prefix " TOPIC_PREFIX
+Prefix for the topic of each message sent.
+.TP
+.BR "\-\-post\-init\-sleep " POST_INIT_SLEEP
+Number of seconds to sleep after initializing.
+.TP
+.BR "\-\-config\-filename " CONFIG_FILENAME
+Config file to use.
+.TP
+.BR \-\-print\-config
+Simply print out the configuration and exit. No action taken.
+.TP
+.BR "\-\-timeout " TIMEOUT
+Timeout in seconds for any blocking zmq operations.
+.TP
+.BR "\-\-high\-water\-mark " HIGH_WATER_MARK
+Limit on the number of messages in the queue before
+blocking.
+.TP
+.BR "\-\-linger " ZMQ_LINGER
+Number of milliseconds to wait before timing out connections.
+
+.SH DESCRIPTION
+.PP
+.B fedmsg\-relay
+is a service which binds to two ports, listens for
+messages on one and emits them on the other.
+.BR fedmsg\-logger (1)
+requires that an instance of
+.B fedmsg\-relay
+be running somewhere and that it's inbound address be listed in the
+config as one of the entries in
+.IR relay_inbound .
+.PP
+.B fedmsg\-relay
+becomes a necessity for ephemeral senders, that cannot bind consistently
+to and serve message from a persistent port.
+
+.SH SEE ALSO
+.PP
+.BR fedmsg\-logger (1)
+
+.SH AUTHORS
+.TP
+.BR "The Fedora Infrastructure team" " <\&messaging\-sig at lists\&.fedoraproject\&.org\&>"
+.RB "Wrote the " fedmsg " software\&."
+.TP
+.BR "Nicolas Dandrimont" " <\&olasd at debian\&.org\&>"
+Wrote this manpage for the Debian system\&.
+
+.SH COPYRIGHT
+.br
+Copyright \(co 2014 Nicolas Dandrimont
+.br
+.PP
+This manual page was written for the Debian system (and may be used by
+others)\&.
+.PP
+You can redistribute it and/or modify it under the terms of the GNU
+Lesser General Public License as published by the Free Software
+Foundation; either version 2.1 of the License, or (at your option) any
+later version.
+.PP
+On Debian systems, a copy of the license can be found in the
+.I /usr/share/common-licenses/LGPL-2.1
+file.
+.sp

Added: packages/fedmsg/trunk/debian/manpages/fedmsg-tail.1
===================================================================
--- packages/fedmsg/trunk/debian/manpages/fedmsg-tail.1	                        (rev 0)
+++ packages/fedmsg/trunk/debian/manpages/fedmsg-tail.1	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,122 @@
+.TH FEDMSG-TAIL 1
+
+.SH NAME
+fedmsg-tail \- listen to the fedmsg bus and print the received messages
+
+.SH SYNOPSIS
+.B fedmsg\-tail
+.RB [ \-\-topics | \-\-terse | \-\-pretty | \-\-really\-pretty ]
+.RB [ \-\-topic
+.IR TOPIC ]
+.RB [ \-\-exclude
+.IR REGEXP ]
+.RB [ \-\-include
+.IR REGEXP ]
+.RB [ \-\-users
+.IR USERS ]
+.RB [ \-\-packages
+.IR PACKAGES ]
+.RI [ "<common fedmsg options>" ]
+.PP
+.B fedmsg\-tail
+.RB [ \-h | \-\-help ]
+
+.SH DESCRIPTION
+.PP
+.B fedmsg\-tail
+connects to all the configured enpoints on the bus, filters the messages
+according to the filter options, and pretty-prints them to the standard
+output according to the formatting options.
+
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Print an help message and exit
+
+.PP
+.B FILTERING
+.TP
+.BR "\-\-topic " TOPIC
+The topic pattern to listen for. Everything by default.
+.TP
+.BR "\-\-exclude " REGEXP
+Only show topics that do not match the supplied regexp.
+.TP
+.BR "\-\-include " REGEXP
+Only show topics that match the supplied regexp.
+.TP
+.BR "\-\-users " USERS
+A comma\-separated list of usernames. Show only the messages related to
+these users.
+.TP
+.BR "\-\-packages " PACKAGES
+A comma\-separated list of packages. Show only the messages related to
+these packages.
+
+.PP
+.B FORMATTING
+.TP
+.BR \-\-topics
+Displays only the topics of the message instead of everything.
+.TP
+.BR \-\-terse
+Print "english" representations of messages only.
+.TP
+.BR \-\-pretty
+Pretty print the JSON messages.
+.TP
+.BR \-\-really\-pretty
+Extra-pretty print the JSON messages.
+
+.SH COMMON FEDMSG OPTIONS
+.TP
+.BR "\-\-io\-threads " IO_THREADS
+Number of io threads for 0mq to use
+.TP
+.BR "\-\-topic\-prefix " TOPIC_PREFIX
+Prefix for the topic of each message sent.
+.TP
+.BR "\-\-post\-init\-sleep " POST_INIT_SLEEP
+Number of seconds to sleep after initializing.
+.TP
+.BR "\-\-config\-filename " CONFIG_FILENAME
+Config file to use.
+.TP
+.BR \-\-print\-config
+Simply print out the configuration and exit. No action taken.
+.TP
+.BR "\-\-timeout " TIMEOUT
+Timeout in seconds for any blocking zmq operations.
+.TP
+.BR "\-\-high\-water\-mark " HIGH_WATER_MARK
+Limit on the number of messages in the queue before
+blocking.
+.TP
+.BR "\-\-linger " ZMQ_LINGER
+Number of milliseconds to wait before timing out connections.
+
+.SH AUTHORS
+.TP
+.BR "The Fedora Infrastructure team" " <\&messaging\-sig at lists\&.fedoraproject\&.org\&>"
+.RB "Wrote the " fedmsg " software\&."
+.TP
+.BR "Nicolas Dandrimont" " <\&olasd at debian\&.org\&>"
+Wrote this manpage for the Debian system\&.
+
+.SH COPYRIGHT
+.br
+Copyright \(co 2014 Nicolas Dandrimont
+.br
+.PP
+This manual page was written for the Debian system (and may be used by
+others)\&.
+.PP
+You can redistribute it and/or modify it under the terms of the GNU
+Lesser General Public License as published by the Free Software
+Foundation; either version 2.1 of the License, or (at your option) any
+later version.
+.PP
+On Debian systems, a copy of the license can be found in the
+.I /usr/share/common-licenses/LGPL-2.1
+file.
+.sp

Added: packages/fedmsg/trunk/debian/manpages/fedmsg-trigger.1
===================================================================
--- packages/fedmsg/trunk/debian/manpages/fedmsg-trigger.1	                        (rev 0)
+++ packages/fedmsg/trunk/debian/manpages/fedmsg-trigger.1	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,102 @@
+.TH FEDMSG-TRIGGER 1
+
+.SH NAME
+fedmsg-trigger \- run a command when messages arrive on the fedmsg bug
+
+.SH SYNOPSIS
+.PP
+.B fedmsg\-trigger
+.RB [ \-\-topic
+.IR TOPIC ]
+.RB [ \-\-exclude
+.IR REGEXP ]
+.RB [ \-\-include
+.IR REGEXP ]
+.BI "\-\-command " COMMAND
+.RI [ "<common fedmsg options>" ]
+.PP
+.B fedmsg\-trigger
+.RB [ \-h | \-\-help ]
+
+
+.SH DESCRIPTION
+.PP
+.B fedmsg-trigger
+runs the command
+.I COMMAND
+every time a message matching the filtering options is received on the
+fedmsg bus. It passes the contents of the received message on the
+standard input of the command.
+
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Print an help message and exit
+.TP
+.BR "\-\-command " COMMAND
+Command to run when a message matches our criteria.
+
+.PP
+.B FILTERING
+.TP
+.BR "\-\-topic " TOPIC
+The topic pattern to listen for. Everything by default.
+.TP
+.BR "\-\-exclude " REGEXP
+Only show topics that do not match the supplied regexp.
+.TP
+.BR "\-\-include " REGEXP
+Only show topics that match the supplied regexp.
+
+.SH COMMON FEDMSG OPTIONS
+.TP
+.BR "\-\-io\-threads " IO_THREADS
+Number of io threads for 0mq to use
+.TP
+.BR "\-\-topic\-prefix " TOPIC_PREFIX
+Prefix for the topic of each message sent.
+.TP
+.BR "\-\-post\-init\-sleep " POST_INIT_SLEEP
+Number of seconds to sleep after initializing.
+.TP
+.BR "\-\-config\-filename " CONFIG_FILENAME
+Config file to use.
+.TP
+.BR \-\-print\-config
+Simply print out the configuration and exit. No action taken.
+.TP
+.BR "\-\-timeout " TIMEOUT
+Timeout in seconds for any blocking zmq operations.
+.TP
+.BR "\-\-high\-water\-mark " HIGH_WATER_MARK
+Limit on the number of messages in the queue before
+blocking.
+.TP
+.BR "\-\-linger " ZMQ_LINGER
+Number of milliseconds to wait before timing out connections.
+
+.SH AUTHORS
+.TP
+.BR "The Fedora Infrastructure team" " <\&messaging\-sig at lists\&.fedoraproject\&.org\&>"
+.RB "Wrote the " fedmsg " software\&."
+.TP
+.BR "Nicolas Dandrimont" " <\&olasd at debian\&.org\&>"
+Wrote this manpage for the Debian system\&.
+
+.SH COPYRIGHT
+.br
+Copyright \(co 2014 Nicolas Dandrimont
+.br
+.PP
+This manual page was written for the Debian system (and may be used by
+others)\&.
+.PP
+You can redistribute it and/or modify it under the terms of the GNU
+Lesser General Public License as published by the Free Software
+Foundation; either version 2.1 of the License, or (at your option) any
+later version.
+.PP
+On Debian systems, a copy of the license can be found in the
+.I /usr/share/common-licenses/LGPL-2.1
+file.
+.sp

Added: packages/fedmsg/trunk/debian/python-fedmsg.manpages
===================================================================
--- packages/fedmsg/trunk/debian/python-fedmsg.manpages	                        (rev 0)
+++ packages/fedmsg/trunk/debian/python-fedmsg.manpages	2014-03-08 21:21:29 UTC (rev 28057)
@@ -0,0 +1,10 @@
+debian/manpages/fedmsg-announce.1
+debian/manpages/fedmsg-collectd.1
+debian/manpages/fedmsg-config.1
+debian/manpages/fedmsg-gateway.1
+debian/manpages/fedmsg-hub.1
+debian/manpages/fedmsg-irc.1
+debian/manpages/fedmsg-logger.1
+debian/manpages/fedmsg-relay.1
+debian/manpages/fedmsg-tail.1
+debian/manpages/fedmsg-trigger.1

Modified: packages/fedmsg/trunk/debian/rules
===================================================================
--- packages/fedmsg/trunk/debian/rules	2014-03-08 16:26:53 UTC (rev 28056)
+++ packages/fedmsg/trunk/debian/rules	2014-03-08 21:21:29 UTC (rev 28057)
@@ -18,14 +18,6 @@
 	chmod +x debian/tmp/usr/share/fedmsg/initsys/sysv/*
 	rm debian/tmp/usr/lib/python2*/dist-packages/fedmsg*.egg-info/SOURCES.txt
 
-override_dh_installman:
-	mkdir -p debian/tmp/manpages
-	set -e; \
-	for s in $(shell ls debian/tmp/usr/bin); do \
-		PYTHONPATH="$(shell pwd)" help2man -n "Manpages for the fedmsg suite" --version-string="$(UPSTREAM)" debian/tmp/usr/bin/$$s > debian/tmp/manpages/$$s.1; \
-	done
-	dh_installman -ppython-fedmsg debian/tmp/manpages/*
-
 override_dh_install:
 	dh_install --fail-missing

More information about the Python-modules-commits mailing list