From 2a8488f7a8f95d65c5e5c1f183b7fe923bcb8c66 Mon Sep 17 00:00:00 2001
From: finga <finga@onders.org>
Date: Sat, 26 Jun 2021 23:10:28 +0200
Subject: [PATCH] Add manpage

The manpage gets also installed with the debian package.
---
 Cargo.toml |   3 +-
 mqrs.1     | 192 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 194 insertions(+), 1 deletion(-)
 create mode 100644 mqrs.1

diff --git a/Cargo.toml b/Cargo.toml
index a3a6393..61c7b1f 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mqrs"
-version = "0.1.0-dev"
+version = "0.1.0"
 authors = ["finga <mqrs@onders.org>"]
 edition = "2018"
 license = "GPL-3.0-or-later"
@@ -18,4 +18,5 @@ extended-description = "`mqrs` is a small cli application to handle POSIX messag
 assets = [
        ["target/release/mqrs", "usr/bin/", "755"],
        ["README.md", "usr/share/doc/cargo-deb/README.md", "644"],
+       ["mqrs.1", "/usr/share/man/man1/mqrs.1", "644"],
 ]
diff --git a/mqrs.1 b/mqrs.1
new file mode 100644
index 0000000..f4af9fc
--- /dev/null
+++ b/mqrs.1
@@ -0,0 +1,192 @@
+.\" Manpage for mqrs
+.TH man 1 "26 June 2021" "0.1.0" "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 POSIX message queues. Supported commands are
+.B create\
+,
+.B info\
+,
+.B unlink\
+,
+.B send
+and
+.B recv
+.
+All commands do not have to be specified fully. If the 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
+.TP 8
+.B \-V, \-\-version
+Prints version information
+.SH SUBCOMMANDS
+.SS 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
+.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 \-p, \-\-permissions \fI<permissions>\fP
+Permissions (octal) to create the queue with
+.RE
+.SS 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 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 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 in "<timeout>[s]" (default) or "<timeout>ms"
+.RE
+.SS 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
+Use priority PRIO, PRIO >= 0 [default: 0]
+.TP 8
+.B \-o, \-\-timeout \fI<timeout>\fP
+Timeout in "<timeout>[s]" (default) or "<timeout>ms"
+.RE
+.SS unlink [FLAGS] \fI<QUEUE>\fP
+Deletes 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 SEE ALSO
+mq_overview(7)
+.SH BUGS
+No known bugs.
+.SH AUTHOR
+finga (mqrs@onders.org)