blob: 6aafdaea9a70581b513608ef0795fa0726c799cd [file]
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH QPID-RECEIVE "1" "October 2018" "qpid-receive (qpid-cpp) version 1.40.0" "User Commands"
.SH NAME
qpid-receive \- AMQP Message Receiver
.SH SYNOPSIS
qpid-receive [OPTIONS] -a [ --address ] ADDRESS
.SH DESCRIPTION
Receives AMQP messages from AMQP sources.
.SH OPTIONS
.TP
\fB\-b\fR [ \fB\-\-broker\fR ] URL (127.0.0.1)
url of broker to connect to
.TP
\fB\-a\fR [ \fB\-\-address\fR ] ADDRESS
address to receive from
.TP
\fB\-\-connection\-options\fR OPTIONS
options for the connection
.TP
\fB\-\-timeout\fR TIMEOUT (0)
timeout in seconds to wait before
exiting
.TP
\fB\-f\fR [ \fB\-\-forever\fR ]
ignore timeout and wait forever
.TP
\fB\-m\fR [ \fB\-\-messages\fR ] N (0)
Number of messages to receive; 0 means
receive indefinitely
.TP
\fB\-\-ignore\-duplicates\fR
Detect and ignore duplicates (by
checking 'sn' header)
.TP
\fB\-\-verify\-sequence\fR
Verify there are no gaps in the message
sequence (by checking 'sn' header)
.TP
\fB\-\-check\-redelivered\fR
Fails with exception if a duplicate is
not marked as redelivered (only
relevant when ignore\-duplicates is
selected)
.TP
\fB\-\-capacity\fR N (1000)
Pre\-fetch window (0 implies no
pre\-fetch)
.TP
\fB\-\-ack\-frequency\fR N (100)
Ack frequency (0 implies none of the
messages will get accepted)
.TP
\fB\-\-tx\fR N (0)
batch size for transactions (0 implies
transaction are not used)
.TP
\fB\-\-rollback\-frequency\fR N (0)
rollback frequency (0 implies no
transaction will be rolledback)
.TP
\fB\-\-print\-content\fR yes|no (1)
print out message content
.TP
\fB\-\-print\-object\-type\fR yes|no (0)
print a description of the content's
object type if relevant
.TP
\fB\-\-print\-headers\fR yes|no (0)
print out message headers
.TP
\fB\-\-failover\-updates\fR
Listen for membership updates
distributed via amq.failover
.TP
\fB\-\-report\-total\fR
Report total throughput and latency
statistics
.TP
\fB\-\-report\-every\fR N (0)
Report throughput and latency
statistics every N messages.
.TP
\fB\-\-report\-header\fR yes|no (1)
Headers on report.
.TP
\fB\-\-ready\-address\fR ADDRESS
send a message to this address when
ready to receive
.TP
\fB\-\-receive\-rate\fR N (0)
Receive at rate of N messages/second. 0
means receive as fast as possible.
.TP
\fB\-\-reply\-to\fR REPLY\-TO
specify reply\-to address on response
messages
.TP
\fB\-\-ignore\-reply\-to\fR
Do not send replies even if reply\-to is
set
.TP
\fB\-\-help\fR
print this usage statement
.SS "Logging options:"
.TP
\fB\-t\fR [ \fB\-\-trace\fR ]
Enables all logging
.TP
\fB\-\-log\-enable\fR RULE (notice+)
Enables logging for selected levels and
components. RULE is in the form
\&'LEVEL[+\-][:PATTERN]'
LEVEL is one of:
.TP
trace debug info notice warning error
critical
PATTERN is a logging category name, or
a namespace\-qualified function name or
name fragment. Logging category names
are:
.TP
Security Broker Management Protocol
System HA Messaging Store Network Test
Client Application Model Unspecified
For example:
\&'\-\-log\-enable warning+'
logs all warning, error and critical
messages.
\&'\-\-log\-enable trace+:Broker'
logs all category 'Broker' messages.
\&'\-\-log\-enable debug:framing'
logs debug messages from all functions
with 'framing' in the namespace or
function name.
This option can be used multiple times
.TP
\fB\-\-log\-disable\fR RULE
Disables logging for selected levels
and components. RULE is in the form
\&'LEVEL[+\-][:PATTERN]'
LEVEL is one of:
.TP
trace debug info notice warning error
critical
PATTERN is a logging category name, or
a namespace\-qualified function name or
name fragment. Logging category names
are:
.TP
Security Broker Management Protocol
System HA Messaging Store Network Test
Client Application Model Unspecified
For example:
\&'\-\-log\-disable warning\-'
disables logging all warning, notice,
info, debug, and trace messages.
\&'\-\-log\-disable trace:Broker'
disables all category 'Broker' trace
messages.
\&'\-\-log\-disable debug\-:qmf::'
disables logging debug and trace
messages from all functions with
\&'qmf::' in the namespace.
This option can be used multiple times
.TP
\fB\-\-log\-time\fR yes|no (1)
Include time in log messages
.TP
\fB\-\-log\-level\fR yes|no (1)
Include severity level in log messages
.TP
\fB\-\-log\-source\fR yes|no (0)
Include source file:line in log
messages
.TP
\fB\-\-log\-thread\fR yes|no (0)
Include thread ID in log messages
.TP
\fB\-\-log\-function\fR yes|no (0)
Include function signature in log
messages
.TP
\fB\-\-log\-hires\-timestamp\fR yes|no (0)
Use hi\-resolution timestamps in log
messages
.TP
\fB\-\-log\-category\fR yes|no (1)
Include category in log messages
.TP
\fB\-\-log\-prefix\fR STRING
Prefix to prepend to all log messages
.SS "Logging sink options:"
.TP
\fB\-\-log\-to\-stderr\fR yes|no (1)
Send logging output to stderr
.TP
\fB\-\-log\-to\-stdout\fR yes|no (0)
Send logging output to stdout
.TP
\fB\-\-log\-to\-file\fR FILE
Send log output to FILE.
.TP
\fB\-\-log\-to\-syslog\fR yes|no (0)
Send logging output to syslog;
customize using \fB\-\-syslog\-name\fR and
\fB\-\-syslog\-facility\fR
.TP
\fB\-\-syslog\-name\fR NAME
Name to use in syslog messages
.TP
\fB\-\-syslog\-facility\fR LOG_XXX (LOG_DAEMON)
Facility to use in syslog messages
.PP
Address must be specified!
.SH AUTHOR
The Apache Qpid Project, dev@qpid.apache.org
.SH "REPORTING BUGS"
Please report bugs to users@qpid.apache.org