diff options
| author | Michael Klishin <michael@clojurewerkz.org> | 2019-09-27 17:40:55 +0300 |
|---|---|---|
| committer | Michael Klishin <michael@clojurewerkz.org> | 2019-09-27 17:40:55 +0300 |
| commit | 61135759035f1f399d762ecdf4cb9e303d0f7767 (patch) | |
| tree | 4ce4107f76351e6088fc90cfd6af40563964062f /docs | |
| parent | d2255d3028f5468b895d3530694472b7d53e5872 (diff) | |
| download | rabbitmq-server-git-61135759035f1f399d762ecdf4cb9e303d0f7767.tar.gz | |
rabbitmq-diagnostics(8): correct fomatting of optional args
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmq-diagnostics.8 | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/docs/rabbitmq-diagnostics.8 b/docs/rabbitmq-diagnostics.8 index 5d314e5884..50d3e0eaf7 100644 --- a/docs/rabbitmq-diagnostics.8 +++ b/docs/rabbitmq-diagnostics.8 @@ -38,7 +38,7 @@ is a command line tool that provides commands used for diagnostics, monitoring and health checks of RabbitMQ nodes. See the -.Lk https://www.rabbitmq.com/documentation.html "RabbitMQ documentation guides" +.Lk https://rabbitmq.com/documentation.html "RabbitMQ documentation guides" to learn more about RabbitMQ diagnostics, monitoring and health checks. .Nm @@ -49,7 +49,7 @@ health checks are available to be used interactively and by monitoring tools. By default if it is not possible to connect to and authenticate with the target node (for example if it is stopped), the operation will fail. To learn more, see the -.Lk https://www.rabbitmq.com/monitoring.html "RabbitMQ Monitoring guide" +.Lk https://rabbitmq.com/monitoring.html "RabbitMQ Monitoring guide" . .\" ------------------------------------------------------------------ .Sh OPTIONS @@ -90,14 +90,14 @@ Default is .It Fl l , Fl -longnames Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the -.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide" +.Lk https://rabbitmq.com/clustering.html "RabbitMQ Clustering guide" .It Fl -erlang-cookie Ar cookie Shared secret to use to authenticate to the target node. Prefer using a local file or the .Ev RABBITMQ_ERLANG_COOKIE environment variable instead of specifying this option on the command line. To learn more, see the -.Lk https://www.rabbitmq.com/cli.html "RabbitMQ CLI Tools guide" +.Lk https://rabbitmq.com/cli.html "RabbitMQ CLI Tools guide" .El .\" ------------------------------------------------------------------ .Sh COMMANDS @@ -224,7 +224,7 @@ in Lists resource alarms, if any, in the cluster. .Pp See -.Lk https://www.rabbitmq.com/alarms.html "RabbitMQ Resource Alarms guide" +.Lk https://rabbitmq.com/alarms.html "RabbitMQ Resource Alarms guide" to learn more. .Pp Example: @@ -237,7 +237,7 @@ Health check that fails (returns with a non-zero code) if there are alarms in effect on any of the cluster nodes. .Pp See -.Lk https://www.rabbitmq.com/alarms.html "RabbitMQ Resource Alarms guide" +.Lk https://rabbitmq.com/alarms.html "RabbitMQ Resource Alarms guide" to learn more. .Pp Example: @@ -250,7 +250,7 @@ Health check that fails (returns with a non-zero code) if there are alarms in effect on the target node. .Pp See -.Lk https://www.rabbitmq.com/alarms.html "RabbitMQ Resource Alarms guide" +.Lk https://rabbitmq.com/alarms.html "RabbitMQ Resource Alarms guide" to learn more. .Pp Example: @@ -261,12 +261,13 @@ Example: .Pp Health check that fails (returns with a non-zero code) if any listener ports on the target node cannot accept a new TCP connection opened by -.Nm. +.Nm +.Pp The check only validates if a new TCP connection is accepted. It does not perform messaging protocol handshake or authenticate. .Pp See -.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide" +.Lk https://rabbitmq.com/networking.html "RabbitMQ Networking guide" to learn more. .Pp Example: @@ -280,7 +281,7 @@ is not listening on the specified port (there is no listener that uses that port). .Pp See -.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide" +.Lk https://rabbitmq.com/networking.html "RabbitMQ Networking guide" to learn more. .Pp Example: @@ -293,7 +294,7 @@ Health check that fails (returns with a non-zero code) if the target node does not have a listener for the specified protocol. .Pp See -.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide" +.Lk https://rabbitmq.com/networking.html "RabbitMQ Networking guide" to learn more. .Pp Example: @@ -350,7 +351,7 @@ Example: Runs a peer discovery on the target node and prints the discovered nodes, if any. .Pp See -.Lk https://www.rabbitmq.com/cluster-formation.html "RabbitMQ Cluster Formation guide" +.Lk https://rabbitmq.com/cluster-formation.html "RabbitMQ Cluster Formation guide" to learn more. .Pp Example: @@ -370,7 +371,7 @@ to authenticate CLI tools and peers. The value can be compared with the hash found in error messages of CLI tools. .Pp See -.Lk https://www.rabbitmq.com/clustering.html#erlang-cookie "RabbitMQ Clustering guide" +.Lk https://rabbitmq.com/clustering.html#erlang-cookie "RabbitMQ Clustering guide" to learn more. .Pp Example: @@ -473,14 +474,14 @@ what protocols and ports the node is listening on for client, CLI tool and peer connections. .Pp See -.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide" +.Lk https://rabbitmq.com/networking.html "RabbitMQ Networking guide" to learn more. .Pp Example: .Sp .Dl rabbitmq-diagnostics listeners .\" ------------------------------------ -.It Cm log_tail Oc Oo Fl -number Ar number | Fl N Ar number Oc Op Fl -timeout Ar milliseconds +.It Cm log_tail Fl -number Ar number | Fl N Ar number Op Fl -timeout Ar milliseconds .Pp Prints the last N lines of the log on the node .Pp @@ -488,7 +489,7 @@ Example: .Sp .Dl rabbitmq-diagnostics log_tail -number 100 .\" ------------------------------------ -.It Cm log_tail_stream Oc Oo Fl -duration Ar seconds | Fl d Ar seconds Oc Op Fl -timeout Ar milliseconds +.It Cm log_tail_stream Oo Fl -duration Ar seconds | Fl d Ar seconds Oc Op Fl -timeout Ar milliseconds .Pp Streams logs from a running node for a period of time .Pp @@ -525,7 +526,7 @@ terabytes .El .Pp See -.Lk https://www.rabbitmq.com/memory-use.html "RabbitMQ Memory Use guide" +.Lk https://rabbitmq.com/memory-use.html "RabbitMQ Memory Use guide" to learn more. .Pp Example: @@ -596,7 +597,7 @@ Note that RabbitMQ can be configured to only accept a subset of those versions, for example, SSLv3 is disabled by default. .Pp See -.Lk https://www.rabbitmq.com/ssl.html "RabbitMQ TLS guide" +.Lk https://rabbitmq.com/ssl.html "RabbitMQ TLS guide" to learn more. .Pp Example: @@ -641,7 +642,7 @@ in .Ss Virtual hosts .Bl -tag -width Ds .\" ------------------------------------ -.It Cm list_vhost_limits Oc Oo Fl -vhost Ar vhost Oc Oo Fl -global Oc Op Fl -no-table-headers +.It Cm list_vhost_limits Oo Fl -vhost Ar vhost Oc Oo Fl -global Oc Op Fl -no-table-headers .Pp See .Cm list_vhost_limits @@ -651,7 +652,7 @@ in .Ss Node configuration .Bl -tag -width Ds .\" ------------------------------------ -.It Cm log_location Oc Oo Fl -all | Fl a Oc Op Fl -timeout Ar milliseconds +.It Cm log_location Oo Fl -all | Fl a Oc Op Fl -timeout Ar milliseconds .Pp Shows log file location(s) on target node .Pp @@ -662,7 +663,7 @@ Example: .Ss Feature flags .Bl -tag -width Ds .\" ------------------------------------ -.It Cm list_feature_flags Oc Oo Ar column ... Oc Op Fl -timeout Ar milliseconds +.It Cm list_feature_flags Oo Ar column ... Oc Op Fl -timeout Ar milliseconds .Pp See .Cm list_feature_flags @@ -672,7 +673,7 @@ in .Ss Queues .Bl -tag -width Ds .\" ------------------------------------ -.It Cm quorum_status Ar queue Oc Op Fl -vhost Ar vhost +.It Cm quorum_status Ar queue Op Fl -vhost Ar vhost .Pp See .Cm quorum_status |
