Mario Fetka
74 lines
2.4 KiB
Groff
74 lines
2.4 KiB
Groff
.TH BONGO-QUEUETOOL 1 "July 2026" "Bongo @BONGO_V_STR@" "Bongo administration"
|
|
.SH NAME
|
|
bongo-queuetool \- manage the Bongo Queue agent
|
|
.SH SYNOPSIS
|
|
.B bongo-queuetool
|
|
.RI [ options ]
|
|
.I COMMAND
|
|
.RI [ command-options ]
|
|
.SH DESCRIPTION
|
|
.B bongo-queuetool
|
|
manages the operation of the Bongo Queue. It takes a
|
|
.I COMMAND
|
|
on execution to specify its action.
|
|
.SH OPTIONS
|
|
.TP
|
|
.BR \-h ", " \-\^\-help
|
|
Show help message and exit.
|
|
.TP
|
|
.BI "\-\^\-host=" HOSTNAME
|
|
Host of Bongo queue. Defaults to localhost.
|
|
.TP
|
|
.BI "\-\^\-port=" PORT
|
|
Port of Bongo queue. Defaults to 8670.
|
|
.TP
|
|
.BR \-\^\-debug
|
|
Enable debugging output.
|
|
.SH "QUEUE MANAGEMENT COMMANDS"
|
|
.TP
|
|
.BR flush " (f)"
|
|
Flush the mail queue.
|
|
.TP
|
|
.BR space " [" details "]"
|
|
Print the number of Queue spool bytes usable after subtracting the configured
|
|
free-space reserve. The optional
|
|
.B details
|
|
form also brackets the Queue query with backing-filesystem samples and prints
|
|
the reserve and allocation-unit size for diagnostics.
|
|
.TP
|
|
.BR collected-count " [" USER "]"
|
|
Print the number of pending messages accepted by the external collector.
|
|
With
|
|
.IR USER ,
|
|
also print that local user's pending count. These values enforce the global
|
|
and per-user collector backpressure limits.
|
|
.TP
|
|
.BR show " (s) " QUEUE-ID
|
|
Write the routing envelope of one queue entry to standard output.
|
|
.TP
|
|
.BR message " (m) " QUEUE-ID
|
|
Write the exact queued message bytes to standard output.
|
|
.TP
|
|
.BR delete " (d) " QUEUE-ID
|
|
Permanently remove one queue entry and its message data.
|
|
.SH "QUEUE RECOVERY AND DIAGNOSTIC COMMANDS"
|
|
.TP
|
|
.BI "hold-local " MESSAGE-FILE " [" TARGET ]
|
|
Create a queue entry and print its queue ID. The default isolated diagnostic
|
|
target is 999. An explicit target is intended for bounded recovery tests which
|
|
must exercise a normal Queue class; it must be between 0 and 999. The message
|
|
remains held until it is explicitly delivered or deleted.
|
|
.TP
|
|
.BI "deliver-local " "QUEUE-ID SENDER RECIPIENT " [ MAILBOX ]
|
|
Copy an existing queued message directly to a local Store mailbox. The
|
|
original queue entry is retained so its bytes can be inspected or the
|
|
delivery can be repeated during recovery. The default mailbox is
|
|
.BR INBOX .
|
|
.PP
|
|
These commands require Queue system authentication. Treat message output as
|
|
private mail content. Delete diagnostic entries when the check is complete.
|
|
.SH "AUTHOR"
|
|
This man page was written by Jonny Lamb <jonnylamb@jonnylamb.com>.
|
|
.SH "SEE ALSO"
|
|
bongo-admin(1), bongo-manager(1)
|