Skip to content

Commit

Permalink
rabbitmq-diagnostics(8): format examples correctly
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelklishin committed Feb 6, 2019
1 parent ed4f058 commit 7fe42d0
Showing 1 changed file with 20 additions and 58 deletions.
78 changes: 20 additions & 58 deletions docs/rabbitmq-diagnostics.8
Expand Up @@ -161,30 +161,24 @@ See
to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
memory_breakdown --unit gigabytes
.sp
.Dl rabbitmq-diagnostics memory_breakdown --unit gigabytes
.\" ------------------------------------
.It Cm server_version
.Pp
Reports target node's version.
.Pp
Example:
.Sp
.Dl
.Nm
server_version -q
.Dl rabbitmq-diagnostics server_version -q
.\" ------------------------------------
.It Cm erlang_version
.Pp
Reports target node's Erlang/OTP version.
.Pp
Example:
.Sp
.Dl
.Nm
erlang_version -q
.Dl rabbitmq-diagnostics erlang_version -q
.\" ------------------------------------
.It Cm maybe_stuck
.Pp
Expand All @@ -197,9 +191,7 @@ but is not necessarily an indication of a problem.
.Pp
Example:
.Sp
.Dl
.Nm
maybe_stuck -q
.Dl rabbitmq-diagnostics maybe_stuck -q
.\" ------------------------------------
.It Cm runtime_thread_stats Op Fl -sample-interval Ar interval
.Pp
Expand All @@ -212,9 +204,7 @@ microstate accounting support and have the runtime_tools package available.
.Pp
Example:
.Sp
.Dl
.Nm
runtime_thread_stats --sample-interval 15
.Dl rabbitmq-diagnostics runtime_thread_stats --sample-interval 15
.\" ------------------------------------
.It Cm tls_versions
.Pp
Expand All @@ -228,9 +218,7 @@ to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
tls_versions -q
.Dl rabbitmq-diagnostics tls_versions -q
.\" ------------------------------------
.It Cm erlang_cookie_hash
.Pp
Expand All @@ -244,9 +232,7 @@ to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
erlang_cookie_hash -q
.Dl rabbitmq-diagnostics erlang_cookie_hash -q
.\" ------------------------------------
.It Cm discover_peers
.Pp
Expand All @@ -258,9 +244,7 @@ to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
discover_peers --timeout 60
.Dl rabbitmq-diagnostics discover_peers --timeout 60
.\" ------------------------------------
.It Cm list_channels Op Ar channelinfoitem ...
See
Expand Down Expand Up @@ -314,9 +298,7 @@ to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
alarms
.Dl rabbitmq-diagnostics alarms
.\" ------------------------------------
.It Cm listeners
.Pp
Expand All @@ -330,9 +312,7 @@ to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
listeners
.Dl rabbitmq-diagnostics listeners
.\" ------------------------------------
.It Cm is_running
.Pp
Expand All @@ -341,9 +321,7 @@ the target node.
.Pp
Example:
.Sp
.Dl
.Nm
is_running
.Dl rabbitmq-diagnostics is_running
.\" ------------------------------------
.It Cm is_booting
.Pp
Expand All @@ -352,9 +330,7 @@ the target node.
.Pp
Example:
.Sp
.Dl
.Nm
is_booting
.Dl rabbitmq-diagnostics is_booting
.\" ------------------------------------

check_port_connectivity [-t <timeout>]
Expand All @@ -370,9 +346,7 @@ was used to stop the application, this check will fail.
.Pp
Example:
.Sp
.Dl
.Nm
check_running
.Dl rabbitmq-diagnostics check_running
.\" ------------------------------------
.It Cm check_local_alarms
.Pp
Expand All @@ -385,9 +359,7 @@ to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
check_local_alarms
.Dl rabbitmq-diagnostics check_local_alarms
.\" ------------------------------------
.It Cm check_alarms
.Pp
Expand All @@ -400,9 +372,7 @@ to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
check_alarms
.Dl rabbitmq-diagnostics check_alarms
.\" ------------------------------------
.It Cm check_port_connectivity
.Pp
Expand All @@ -418,9 +388,7 @@ to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
check_port_connectivity
.Dl rabbitmq-diagnostics check_port_connectivity
.\" ------------------------------------
.It Cm check_protocol_listener
.Pp
Expand All @@ -433,9 +401,7 @@ to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
check_protocol_listener mqtt
.Dl rabbitmq-diagnostics check_protocol_listener mqtt
.\" ------------------------------------
.It Cm check_port_listener
.Pp
Expand All @@ -449,9 +415,7 @@ to learn more.
.Pp
Example:
.Sp
.Dl
.Nm
check_port_listener 5672
.Dl rabbitmq-diagnostics check_port_listener 5672
.\" ------------------------------------
.It Cm status
See
Expand Down Expand Up @@ -545,7 +509,5 @@ then checks that every queue and channel on the node can emit basic stats.
.Pp
Example:
.Sp
.Dl
.Nm
node_health_check -n rabbit@hostname
.Dl rabbitmq-diagnostics node_health_check -n rabbit@hostname
.\" ------------------------------------

0 comments on commit 7fe42d0

Please sign in to comment.