mqrs/README.md

53 lines
1.1 KiB
Markdown
Raw Normal View History

2021-06-20 17:12:05 +02:00
# mqrs
`mqrs` is a small cli application to handle POSIX message queues.
## Installation
2021-06-20 17:39:22 +02:00
To build `mqrs` a rust toolchain is necessary.
2021-06-20 17:12:05 +02:00
### Install Rust
Install the Rust toolchain from [rustup.rs](https://rustup.rs).
### Build `mqrs`
`mqrs` can be built for development:
2021-06-20 17:39:22 +02:00
```sh
cargo b
2021-06-20 17:12:05 +02:00
```
or for releasing:
2021-06-20 17:39:22 +02:00
```sh
cargo b --release
```
### Build the `mqrs` Debian package
```sh
cargo deb
2021-06-20 17:12:05 +02:00
```
### Install `mqrs`
When a Rust toolchain installed you can also install `mqrs`
directly without cloning it manually:
``` sh
2021-06-20 17:39:22 +02:00
cargo install --git https://git.onders.org/finga/mqrs.git mqrs
2021-06-20 17:12:05 +02:00
```
or from within the project:
2021-06-20 17:39:22 +02:00
```sh
cargo install mqrs
2021-06-20 17:12:05 +02:00
```
### Run `mqrs`
`mqrs` can either be run from the project directory with:
2021-06-20 17:39:22 +02:00
```sh
cargo b
2021-06-20 17:12:05 +02:00
```
or you can copy the produced binary somewhere else or link to them
from `target/{debug,release}/mqrs` depending on which
one you built.
## Using `mqrs`
`mqrs` supports five commands: `create`, `info`, `unlink`, `send` and
`receive`. 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.