Merge pull request #2126 from rabbitmq/ac-polish-manpages

rabbitmqctl & rabbitmq-diagnostics manpage polishing

2 files changed, 18 insertions, 26 deletions

diff --git a/docs/rabbitmq-diagnostics.8 b/docs/rabbitmq-diagnostics.8
index 0eb0be08cb..754506c1bd 100644
--- a/docs/rabbitmq-diagnostics.8
+++ b/docs/rabbitmq-diagnostics.8
@@ -274,7 +274,7 @@ Example:
 .Sp
 .Dl rabbitmq-diagnostics check_port_connectivity
 .\" ------------------------------------
-.It Cm check_port_listener
+.It Cm check_port_listener Ar port
 .Pp
 Health check that fails (returns with a non-zero code) if the target node
 is not listening on the specified port (there is no listener that
@@ -288,7 +288,7 @@ Example:
 .Sp
 .Dl rabbitmq-diagnostics check_port_listener 5672
 .\" ------------------------------------
-.It Cm check_protocol_listener
+.It Cm check_protocol_listener Ar protocol
 .Pp
 Health check that fails (returns with a non-zero code) if the target node
 does not have a listener for the specified protocol.
@@ -338,7 +338,7 @@ Example:
 .Sp
 .Dl rabbitmq-diagnostics command_line_arguments -n rabbit@hostname
 .\" ------------------------------------
-.It Cm consume_event_stream
+.It Cm consume_event_stream Oo Fl -duration Ar seconds | Fl d Ar seconds Oc Oo Fl -pattern Ar pattern Oc Op Fl -timeout Ar milliseconds
 .Pp
 Streams internal events from a running node. Output is jq-compatible.
 .Pp
@@ -568,7 +568,7 @@ Example:
 .Sp
 .Dl rabbitmq-diagnostics runtime_thread_stats --sample-interval 15
 .\" ------------------------------------
-.It Cm schema_info Oc Oo Fl -no_table_headers Oc Oo Ar column ... Oc Op Fl -timeout Ar milliseconds
+.It Cm schema_info Oo Fl -no_table_headers Oc Oo Ar column ... Oc Op Fl -timeout Ar milliseconds
 .Pp
 See
 .Cm schema_info
diff --git a/docs/rabbitmqctl.8 b/docs/rabbitmqctl.8
index d71f298fa3..41ba2a7c81 100644
--- a/docs/rabbitmqctl.8
+++ b/docs/rabbitmqctl.8
@@ -856,25 +856,6 @@ virtual hosts to which the user named
 has been granted access, and the topic permissions the user has in these virtual hosts:
 .sp
 .Dl rabbitmqctl list_topic_user_permissions janeway
-.El
-.\" ------------------------------------------------------------------
-.\" ## Parameter management
-.\" ------------------------------------------------------------------
-.Ss Parameter Management
-Certain features of RabbitMQ (such as the Federation plugin) are
-controlled by dynamic, cluster-wide
-.Em parameters.
-There are 2 kinds of parameters: parameters scoped to a virtual host and
-global parameters.
-Each vhost-scoped parameter consists of a component name, a name and a
-value.
-The component name and name are strings, and the value is a valid JSON document.
-A global parameter consists of a name and value.
-The name is a string and the value is an arbitrary Erlang data structure.
-Parameters can be set, cleared and listed.
-In general you should refer to the documentation for the feature in
-question to see how to set parameters.
-.Bl -tag -width Ds
 .\" ------------------------------------------------------------------
 .It Cm list_vhosts Op Ar vhostinfoitem ...
 .Pp
@@ -1512,9 +1493,20 @@ broker:
 .\" ## Runtime Parameters and Policies
 .\" ------------------------------------------------------------------
 .Ss Runtime Parameters and Policies
-Some settings must be identical on all cluster nodes and are likely
-to change at runtime. They are controlled via a mechanism
-called runtime parameters.
+Certain features of RabbitMQ (such as the Federation plugin) are
+controlled by dynamic, cluster-wide
+.Em parameters.
+There are 2 kinds of parameters: parameters scoped to a virtual host and
+global parameters.
+Each vhost-scoped parameter consists of a component name, a name and a
+value.
+The component name and name are strings, and the value is a valid JSON document.
+A global parameter consists of a name and value.
+The name is a string and the value is an arbitrary Erlang data structure.
+Parameters can be set, cleared and listed.
+In general you should refer to the documentation for the feature in
+question to see how to set parameters.
+.Pp
 Policies is a feature built on top of runtime parameters.
 Policies are used to control and modify the behaviour of queues and
 exchanges on a cluster-wide basis.