Skip to content

Commit 7fe42d0

Browse files
rabbitmq-diagnostics(8): format examples correctly
1 parent ed4f058 commit 7fe42d0

File tree

1 file changed

+20
-58
lines changed

1 file changed

+20
-58
lines changed

docs/rabbitmq-diagnostics.8

Lines changed: 20 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -161,30 +161,24 @@ See
161161
to learn more.
162162
.Pp
163163
Example:
164-
.Sp
165-
.Dl
166-
.Nm
167-
memory_breakdown --unit gigabytes
164+
.sp
165+
.Dl rabbitmq-diagnostics memory_breakdown --unit gigabytes
168166
.\" ------------------------------------
169167
.It Cm server_version
170168
.Pp
171169
Reports target node's version.
172170
.Pp
173171
Example:
174172
.Sp
175-
.Dl
176-
.Nm
177-
server_version -q
173+
.Dl rabbitmq-diagnostics server_version -q
178174
.\" ------------------------------------
179175
.It Cm erlang_version
180176
.Pp
181177
Reports target node's Erlang/OTP version.
182178
.Pp
183179
Example:
184180
.Sp
185-
.Dl
186-
.Nm
187-
erlang_version -q
181+
.Dl rabbitmq-diagnostics erlang_version -q
188182
.\" ------------------------------------
189183
.It Cm maybe_stuck
190184
.Pp
@@ -197,9 +191,7 @@ but is not necessarily an indication of a problem.
197191
.Pp
198192
Example:
199193
.Sp
200-
.Dl
201-
.Nm
202-
maybe_stuck -q
194+
.Dl rabbitmq-diagnostics maybe_stuck -q
203195
.\" ------------------------------------
204196
.It Cm runtime_thread_stats Op Fl -sample-interval Ar interval
205197
.Pp
@@ -212,9 +204,7 @@ microstate accounting support and have the runtime_tools package available.
212204
.Pp
213205
Example:
214206
.Sp
215-
.Dl
216-
.Nm
217-
runtime_thread_stats --sample-interval 15
207+
.Dl rabbitmq-diagnostics runtime_thread_stats --sample-interval 15
218208
.\" ------------------------------------
219209
.It Cm tls_versions
220210
.Pp
@@ -228,9 +218,7 @@ to learn more.
228218
.Pp
229219
Example:
230220
.Sp
231-
.Dl
232-
.Nm
233-
tls_versions -q
221+
.Dl rabbitmq-diagnostics tls_versions -q
234222
.\" ------------------------------------
235223
.It Cm erlang_cookie_hash
236224
.Pp
@@ -244,9 +232,7 @@ to learn more.
244232
.Pp
245233
Example:
246234
.Sp
247-
.Dl
248-
.Nm
249-
erlang_cookie_hash -q
235+
.Dl rabbitmq-diagnostics erlang_cookie_hash -q
250236
.\" ------------------------------------
251237
.It Cm discover_peers
252238
.Pp
@@ -258,9 +244,7 @@ to learn more.
258244
.Pp
259245
Example:
260246
.Sp
261-
.Dl
262-
.Nm
263-
discover_peers --timeout 60
247+
.Dl rabbitmq-diagnostics discover_peers --timeout 60
264248
.\" ------------------------------------
265249
.It Cm list_channels Op Ar channelinfoitem ...
266250
See
@@ -314,9 +298,7 @@ to learn more.
314298
.Pp
315299
Example:
316300
.Sp
317-
.Dl
318-
.Nm
319-
alarms
301+
.Dl rabbitmq-diagnostics alarms
320302
.\" ------------------------------------
321303
.It Cm listeners
322304
.Pp
@@ -330,9 +312,7 @@ to learn more.
330312
.Pp
331313
Example:
332314
.Sp
333-
.Dl
334-
.Nm
335-
listeners
315+
.Dl rabbitmq-diagnostics listeners
336316
.\" ------------------------------------
337317
.It Cm is_running
338318
.Pp
@@ -341,9 +321,7 @@ the target node.
341321
.Pp
342322
Example:
343323
.Sp
344-
.Dl
345-
.Nm
346-
is_running
324+
.Dl rabbitmq-diagnostics is_running
347325
.\" ------------------------------------
348326
.It Cm is_booting
349327
.Pp
@@ -352,9 +330,7 @@ the target node.
352330
.Pp
353331
Example:
354332
.Sp
355-
.Dl
356-
.Nm
357-
is_booting
333+
.Dl rabbitmq-diagnostics is_booting
358334
.\" ------------------------------------
359335

360336
check_port_connectivity [-t <timeout>]
@@ -370,9 +346,7 @@ was used to stop the application, this check will fail.
370346
.Pp
371347
Example:
372348
.Sp
373-
.Dl
374-
.Nm
375-
check_running
349+
.Dl rabbitmq-diagnostics check_running
376350
.\" ------------------------------------
377351
.It Cm check_local_alarms
378352
.Pp
@@ -385,9 +359,7 @@ to learn more.
385359
.Pp
386360
Example:
387361
.Sp
388-
.Dl
389-
.Nm
390-
check_local_alarms
362+
.Dl rabbitmq-diagnostics check_local_alarms
391363
.\" ------------------------------------
392364
.It Cm check_alarms
393365
.Pp
@@ -400,9 +372,7 @@ to learn more.
400372
.Pp
401373
Example:
402374
.Sp
403-
.Dl
404-
.Nm
405-
check_alarms
375+
.Dl rabbitmq-diagnostics check_alarms
406376
.\" ------------------------------------
407377
.It Cm check_port_connectivity
408378
.Pp
@@ -418,9 +388,7 @@ to learn more.
418388
.Pp
419389
Example:
420390
.Sp
421-
.Dl
422-
.Nm
423-
check_port_connectivity
391+
.Dl rabbitmq-diagnostics check_port_connectivity
424392
.\" ------------------------------------
425393
.It Cm check_protocol_listener
426394
.Pp
@@ -433,9 +401,7 @@ to learn more.
433401
.Pp
434402
Example:
435403
.Sp
436-
.Dl
437-
.Nm
438-
check_protocol_listener mqtt
404+
.Dl rabbitmq-diagnostics check_protocol_listener mqtt
439405
.\" ------------------------------------
440406
.It Cm check_port_listener
441407
.Pp
@@ -449,9 +415,7 @@ to learn more.
449415
.Pp
450416
Example:
451417
.Sp
452-
.Dl
453-
.Nm
454-
check_port_listener 5672
418+
.Dl rabbitmq-diagnostics check_port_listener 5672
455419
.\" ------------------------------------
456420
.It Cm status
457421
See
@@ -545,7 +509,5 @@ then checks that every queue and channel on the node can emit basic stats.
545509
.Pp
546510
Example:
547511
.Sp
548-
.Dl
549-
.Nm
550-
node_health_check -n rabbit@hostname
512+
.Dl rabbitmq-diagnostics node_health_check -n rabbit@hostname
551513
.\" ------------------------------------

0 commit comments

Comments
 (0)