From 062156a0061f5ff4bb4171761fadc77baf42fb84 Mon Sep 17 00:00:00 2001 From: Thasan Date: Tue, 13 Jan 2015 08:16:46 +0200 Subject: [PATCH] Adding Usage section to readme.md --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc3c7e2..fb36eac 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,26 @@ Add ```-lws2_32``` to compiler command line on Mingw GCC. --- -More info [here](http://forums.bukkit.org/threads/admin-rcon-mcrcon-remote-connection-client-for-minecraft-servers.70910/). \ No newline at end of file +More info [here](http://forums.bukkit.org/threads/admin-rcon-mcrcon-remote-connection-client-for-minecraft-servers.70910/). + +####Usage: +Usage: mcrcon [OPTIONS]... [COMMANDS]... +Sends rcon commands to minecraft server. + +``` +Option: + -h Prints usage. + -s Silent mode. Do not print data received from rcon. + -t Terminal mode. Acts as interactive terminal. + -p Rcon password. Default: "". + -H Host address or ip. + -P Port. Default: 25575. + -c Do not print colors. Disables bukkit color printing. + -r Print everything in raw mode. + Good for debugging and custom handling of the output. +``` +Invidual commands must be separated with spaces. + +Example: + ```mcrcon -c -H 192.168.1.42 -P 9999 -p password cmd1 "cmd2 with spaces"``` +