Skip to content

Commit

Permalink
Modified spec for !exit and !close in README
Browse files Browse the repository at this point in the history
  • Loading branch information
EnKrypt committed Sep 16, 2016
1 parent 941a36d commit c0f24cb
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ Commands below use the default delimiters without selecting any nicks. Parameter

* `!auth password` - If a password is set up for the bot, this command needs to be issued with the right pasword before a user can send other commands to it. A good way to use this command is by sending it as a private message to the bot so that others cannot look at the password as you send it.
* `!ping [param]` - Simple ping-pong to measure lag and response of the bot. The bot will pong back with `param` if given, else it simply responds with 'pong'.
* `!exit` - Make the bot force exit. Any shell instances attached to the bot with commands still running in them will continue to run. Note that if you do not have some other form of access to that host, you may not be able to get botato running on it again.
* `!info [version | updates]` - Displays basic information about the bot instance. Using the `version` flag only displays botato's version number. Using the `updates` flag only shows if you have pending updates waiting to be applied. Not supplying any arguments will show verbose information on all data relevant to the bot.
* `!address [global | local]`- Grabs the IP and MAC addresses from the client's network interfaces and displays it in the host network. `global` displays only the WAN facing IP address (if available). If no parameter is given, it displays details in verbose for both.
* `!update [version no.]` - Forces a manual update. If no parameter is given, the latest version is fetched.
Expand All @@ -153,7 +154,7 @@ Commands below use the default delimiters without selecting any nicks. Parameter
* `!visible name` - Same as above except it has the opposite effect i.e. it removes output suppression if applicable.
* `!stdin name characters` - Writes `characters` to the stdin of any command running in the identified shell instance. Useful for commands that require prompting such as `apt-get` or `sudo`.
* `!list nick` - Lists all the names of the shell instances running on the bot identified by `nick`. If any of those instances is also an interactive shell mode instance, it will be mentioned.
* `!exit [soft | hard] [name]` - To make a shell instance quit. Shell instances that are busy working on a task will not exit on a `soft` exit, whereas a `hard` exit forces the instance to close regardless. `soft` exit is useful only for closing interactive shell modes since a normal shell instance quits after its command is complete. If neither `soft` or `hard` is specified, `soft` is assumed. You can either specify a shell instance to quit with `name` or have all the shell instances in a bot quit if it is not provided. If no specific bot(s) are selected in the commend syntax, all the shell instances across all bots in the network will exit.
* `!close [soft | hard] [name]` - To make a shell instance quit. Shell instances that are busy working on a task will not exit on a `soft` exit, whereas a `hard` exit forces the instance to close regardless. `soft` exit is useful only for closing interactive shell modes since a normal shell instance quits after its command is complete. If neither `soft` or `hard` is specified, `soft` is assumed. You can either specify a shell instance to quit with `name` or have all the shell instances in a bot quit if it is not provided. If no specific bot(s) are selected in the commend syntax, all the shell instances across all bots in the network will exit.

# Contributing

Expand Down

0 comments on commit c0f24cb

Please sign in to comment.