Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NickeZ committed Jun 10, 2017
1 parent b4c933e commit 729eb33
Showing 1 changed file with 41 additions and 2 deletions.
43 changes: 41 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ Rups also keeps your process alive by restarting it as soon as it dies.
A lot of the functionality is not implemented. This project should be
considered under development...

[![asciicast](https://asciinema.org/a/124007.png)](https://asciinema.org/a/124007)


## Install

Expand All @@ -28,3 +26,44 @@ considered under development...

1. Launch python through rups: `rups python`
2. Connect to python through a separate terminal: `telnet localhost 3000`

## Help

```
$ rups -h
Rups 0.1.0
Niklas Claesson <[email protected]>
Rust process server
USAGE:
rups [FLAGS] [OPTIONS] <command>...
FLAGS:
-f, --foreground print process output to stdout (server)
-h, --help Prints help information
-I, --interactive Connect stdin to process input (server)
--noautorestart do not restart the child process by default
-n, --noinfo suppress messages (clients)
-q, --quiet suppress messages (server)
-V, --version Prints version information
-w, --wait let user start process via telnet command
OPTIONS:
--autorestartcmd <autorestartcmd> Command to toggle autorestart of process
-b, --bind <bind>... Bind to address (default is 127.0.0.1:3000
-c, --chdir <chdir> Process working directory
--histsize <histsize> Set maximum telnet packets to remember
--holdoff <holdoff> wait n seconds between process restart
-k, --killcmd <killcmd> Command to send SIGKILL to process
-l, --logbind <logbind>... Bind to address for log output (ignore any received data)
-L, --logfile <logfile>... Output to logfile
-r, --restartcmd <restartcmd> Command to start the process
ARGS:
<command>...
All commands (killcmd, ...) take either a single letter or caret (^) + a single letter as arguments. For example '^x'
for Ctrl-X or 'x' for literal x.
EXAMPLES:
rups bash
Will launch bash as the child process using the default options.
```

## Demo

[![asciicast](https://asciinema.org/a/124007.png)](https://asciinema.org/a/124007)

0 comments on commit 729eb33

Please sign in to comment.