Skip to content

Commit

Permalink
Regenerate man page and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Edwin Hoksberg committed Feb 4, 2020
1 parent 7f1ad96 commit b8dfb9b
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 23 deletions.
57 changes: 39 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,52 @@ You can find the latest release including binaries [here](https://github.com/Edw
## Usage
```
NAME:
beanstalkd-cli
beanstalkd-cli
USAGE:
A simple cli interface for managing beanstalkd queues.
Homepage: https://github.com/edwinhoksberg/beanstalkd-cli
A simple cli interface for managing beanstalkd queues.
Homepage: https://github.com/edwinhoksberg/beanstalkd-cli
VERSION:
1.2.7 [5e2ef1289d916807f5a4f787dc9634b9753fa4cb]
1.3.2 [7f1ad96f65246471eae3c07454ad8c77e6a0792f]
AUTHOR:
Edwin Hoksberg <[email protected]>
Edwin Hoksberg <[email protected]>
COMMANDS:
monitor Monitor the beanstalkd queues
flush Completely remove all jobs from a tube
pop Remove a job from a queue and display it
put Write a job to a queue
peek Display a job from the queue without removing it
help, h Shows a list of commands or help for one command
monitor
Monitor the beanstalkd queues
flush Completely remove all jobs from a tube
pop Remove a job from a queue and display it
put Write a job to a queue
peek Display a job from the queue without removing it
help, h
Shows a list of commands or help for one command
GLOBAL OPTIONS:
--verbose set this to enable debug logging
--quiet set this to disable logging
--server value The server name where beanstalkd is running (default: "127.0.0.1")
--port value The port on which beanstalkd is listening (default: 11300)
--help, -h show help
--version, -v print the version
--verbose
set this to enable debug logging
--quiet
set this to disable logging
--server value
The server name where beanstalkd is running (default: "127.0.0.1")
--port value
The port on which beanstalkd is listening (default: 11300)
--help, -h
show help
--version, -v
print the version
```

## Development
Expand All @@ -43,5 +61,8 @@ This program is written in [Go](https://golang.org/), using these dependencies:
- [urfave/cli](https://github.com/urfave/cli) - cli is a simple, fast, and fun package for building command line apps in Go.
- [mpdroog/beanstalkd](https://github.com/mpdroog/beanstalkd) - A golang beanstalkd client.

## Compile from source
This program uses Go modules which makes it easy to compile it anywhere on your system without the need for GOPATH. Just run `make build` in the project directory and it should compile without any problems.

## License
[MIT](LICENSE.md)
10 changes: 5 additions & 5 deletions beanstalkd-cli.man
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH BEANSTALKD-CLI "1" "March 2018" "beanstalkd-cli version 1.2.7 [a7b7f2db5f5b9dd3a1978c107dbd96547394429c]" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.12.
.TH BEANSTALKD-CLI "1" "February 2020" "beanstalkd-cli version 1.3.2 [7f1ad96f65246471eae3c07454ad8c77e6a0792f]" "User Commands"
.SH NAME
beanstalkd-cli \- manual page for beanstalkd-cli version 1.2.7 [a7b7f2db5f5b9dd3a1978c107dbd96547394429c]
beanstalkd-cli \- manual page for beanstalkd-cli version 1.3.2 [7f1ad96f65246471eae3c07454ad8c77e6a0792f]
.SH DESCRIPTION
.SS "NAME:"
.IP
beanstalkd\-cli \- A new cli application
beanstalkd\-cli
.SS "USAGE:"
.IP
A simple cli interface for managing beanstalkd queues.
.IP
Homepage: https://github.com/edwinhoksberg/beanstalkd\-cli
.SS "VERSION:"
.IP
1.2.7 [a7b7f2db5f5b9dd3a1978c107dbd96547394429c]
1.3.2 [7f1ad96f65246471eae3c07454ad8c77e6a0792f]
.SS "AUTHOR:"
.IP
Edwin Hoksberg <[email protected]>
Expand Down

0 comments on commit b8dfb9b

Please sign in to comment.