326 lines
5.4 KiB
Groff
326 lines
5.4 KiB
Groff
.\" Manpage for mqrs
|
|
.TH man 1 "7 July 2021" "0.1.1" "mqrs man page"
|
|
.SH NAME
|
|
mqrs \- Handle POSIX message queues
|
|
.SH SYNOPSIS
|
|
.B mqrs [\-h] [\-\-help] [\-v] [\-\-verbose] [\-V] [\-\-version] [SUBCOMMAND]
|
|
.SH DESCRIPTION
|
|
.B mqrs
|
|
is a small cli program to handle message queues. Depending on which
|
|
backend you want to use there are different subsets of
|
|
subcommands. Following backends are supported:
|
|
.B posix\
|
|
and
|
|
.B sysv\
|
|
.
|
|
|
|
If a command is clearly distinguishable from all the others, it does
|
|
not have to be completed further.
|
|
.SH OPTIONS
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output, multiple -v options increase the verbosity
|
|
(max. 3)
|
|
.TP 8
|
|
.B \-V, \-\-version
|
|
Prints version information
|
|
.SH POSIX MESSAGE QUEUE SUBCOMMANDS
|
|
The POSIX backend supports six commands:
|
|
.B create\
|
|
,
|
|
.B info\
|
|
,
|
|
.B list\
|
|
,
|
|
.B unlink\
|
|
,
|
|
.B send
|
|
and
|
|
.B recv
|
|
.
|
|
.SS posix create [FLAGS] [OPTIONS] \fI<QUEUE>\fP
|
|
Create a new POSIX message queue.
|
|
.TP 8
|
|
.SS ARGS
|
|
.RS
|
|
.TP 8
|
|
.B \fI<QUEUE>\fP
|
|
Name of the new queue
|
|
.RE
|
|
.TP 8
|
|
.SS FLAGS
|
|
.RS
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output
|
|
.TP 8
|
|
.SS OPTIONS
|
|
.RS
|
|
.TP 8
|
|
.B \-c, \-\-capacity \fI<capacity>\fP
|
|
Maximum number of messages in the queue
|
|
.TP 8
|
|
.B \-s, \-\-msgsize \fI<msgsize>\fP
|
|
Message size in bytes
|
|
.TP 8
|
|
.B \-m, \-\-mode \fI<mode>\fP
|
|
Permissions (octal) to create the queue with
|
|
.RE
|
|
.SS posix help [SUBCOMMAND]
|
|
Prints this message or the help of the given subcommand.
|
|
.TP 8
|
|
.SS ARGS
|
|
.RS
|
|
.TP 8
|
|
.B \fI<SUBCOMMAND>\fP
|
|
Show help for \fISUBCOMMAND\fP
|
|
.RE
|
|
.SS posix info [FLAGS] \fI<QUEUE>\fP
|
|
Print further information about an existing message queue.
|
|
.TP 8
|
|
.SS ARGS
|
|
.RS
|
|
.TP 8
|
|
.B \fI<QUEUE>\fP
|
|
Name of the queue
|
|
.RE
|
|
.TP 8
|
|
.SS FLAGS
|
|
.RS
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output
|
|
.RE
|
|
.SS posix list [FLAGS]
|
|
Print a list of all existing POSIX message queues.
|
|
.TP 8
|
|
.SS FLAGS
|
|
.RS
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output
|
|
.TP 8
|
|
.B \-a, \-\-all
|
|
Print all available information
|
|
.RE
|
|
.SS posix recv [FLAGS] [OPTIONS] \fI<QUEUE>\fP
|
|
Receive and print one or more messages message from a message queue.
|
|
.TP 8
|
|
.SS ARGS
|
|
.RS
|
|
.TP 8
|
|
.B \fI<QUEUE>\fP
|
|
Name of the queue
|
|
.RE
|
|
.TP 8
|
|
.SS FLAGS
|
|
.RS
|
|
.TP 8
|
|
.B \-f, \-\-follow
|
|
Print messages as they are received
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-n, \-\-non\-blocking
|
|
Do not block
|
|
.TP 8
|
|
.B \-t, \-\-timestamp
|
|
Print a timestamp before each message
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output
|
|
.RE
|
|
.TP 8
|
|
.SS OPTIONS
|
|
.RS
|
|
.TP 8
|
|
.B \-d, \-\-deadline \fI<deadline>\fP
|
|
Deadline until messages are received (format: "%Y-%m-%d %H:%M:%S")
|
|
.TP 8
|
|
.B \-o, \-\-timeout \fI<timeout>\fP
|
|
Timeout as for example in "5h 23min 42ms"
|
|
.RE
|
|
.SS posix send [FLAGS] [OPTIONS] \fI<QUEUE>\fP \fI<MESSAGE>\fP
|
|
Send a message to a message queue.
|
|
.TP 8
|
|
.SS ARGS
|
|
.RS
|
|
.TP 8
|
|
.B \fI<QUEUE>\fP
|
|
Name of the queue
|
|
.TP 8
|
|
.B \fI<MESSAGE>\fP
|
|
Message to be sent to the queue
|
|
.RE
|
|
.TP 8
|
|
.SS FLAGS
|
|
.RS
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-n, \-\-non\-blocking
|
|
Do not block
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output
|
|
.RE
|
|
.TP 8
|
|
.SS OPTIONS
|
|
.RS
|
|
.TP 8
|
|
.B \-d, \-\-deadline \fI<deadline>\fP
|
|
Deadline until messages are received (format: "%Y-%m-%d %H:%M:%S")
|
|
.TP 8
|
|
.B \-p, \-\-priority \fI<priority>\fP
|
|
Set a different priority than default, priority >= 0 [default: 0]
|
|
.TP 8
|
|
.B \-o, \-\-timeout \fI<timeout>\fP
|
|
Timeout as for example in "5h 23min 42ms"
|
|
.RE
|
|
.SS posix unlink [FLAGS] \fI<QUEUE>\fP
|
|
Delete an existing POSIX message queue.
|
|
.TP 8
|
|
.SS ARGS
|
|
.RS
|
|
.TP 8
|
|
.B \fI<QUEUE>\fP
|
|
Name of the queue
|
|
.RE
|
|
.TP 8
|
|
.SS FLAGS
|
|
.RS
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output
|
|
.RE
|
|
.SH SYSV IPC MESSAGE QUEUE SUBCOMMANDS
|
|
The SysV IPC backend supports four commands:
|
|
.B create\
|
|
,
|
|
.B info\
|
|
,
|
|
.B list
|
|
and
|
|
.B unlink\
|
|
.
|
|
.SS sysv create [FLAGS] [OPTIONS] \fI<KEY>\fP
|
|
Create a new SysV IPC message queue.
|
|
.TP 8
|
|
.SS ARGS
|
|
.RS
|
|
.TP 8
|
|
.B \fI<KEY>\fP
|
|
Key of the new queue
|
|
.RE
|
|
.TP 8
|
|
.SS FLAGS
|
|
.RS
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output
|
|
.TP 8
|
|
.SS OPTIONS
|
|
.RS
|
|
.TP 8
|
|
.B \-m, \-\-mode \fI<mode>\fP
|
|
Permissions (octal) to create the queue with (default: 0644)
|
|
.RE
|
|
.SS sysv help [SUBCOMMAND]
|
|
Prints this message or the help of the given subcommand.
|
|
.TP 8
|
|
.SS ARGS
|
|
.RS
|
|
.TP 8
|
|
.B \fI<SUBCOMMAND>\fP
|
|
Show help for \fISUBCOMMAND\fP
|
|
.RE
|
|
.SS sysv info [FLAGS] [OPTIONS]
|
|
Print further information about an existing message queue. Exactly of
|
|
the OPTION arguments is mandatory.
|
|
.TP 8
|
|
.SS FLAGS
|
|
.RS
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output
|
|
.RE
|
|
.TP 8
|
|
.SS OPTIONS
|
|
.RS
|
|
.TP 8
|
|
.B \-i, \-\-id \fI<id>\fP
|
|
Id of the queue
|
|
.TP 8
|
|
.B \-k, \-\-key \fI<key>\fP
|
|
Key of the queue
|
|
.RE
|
|
.SS sysv list [FLAGS]
|
|
Print a list of all existing SysV IPC message queues.
|
|
.TP 8
|
|
.SS FLAGS
|
|
.RS
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output
|
|
.RE
|
|
.SS sysv unlink [FLAGS] [OPTIONS]
|
|
Delete an existing SysV IPC message queue. It is mandatory to pass
|
|
exactly one OPTION.
|
|
.TP 8
|
|
.SS ARGS
|
|
.RS
|
|
.TP 8
|
|
.B \fI<KEY>\fP
|
|
Key of the new queue
|
|
.RE
|
|
.TP 8
|
|
.SS FLAGS
|
|
.RS
|
|
.TP 8
|
|
.B \-h, \-\-help
|
|
Prints help information
|
|
.TP 8
|
|
.B \-v, \-\-verbose
|
|
Produce verbose output
|
|
.TP 8
|
|
.SS OPTIONS
|
|
.RS
|
|
.TP 8
|
|
.B \-i, \-\-id \fI<id>\fP
|
|
Id of the queue
|
|
.TP 8
|
|
.B \-k, \-\-key \fI<key>\fP
|
|
Key of the queue
|
|
.RE
|
|
.SH SEE ALSO
|
|
mq_overview(7), sysvipc(7)
|
|
.SH BUGS
|
|
No known bugs.
|
|
.SH AUTHOR
|
|
finga (mqrs@onders.org)
|