diff --git a/CHANGELOG.md b/CHANGELOG.md index aa9fded..1df0bc5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ###### 0.7.0 - Add -w option for rcon command throttling + * Thanks HorlogeSkynet @ Github ###### 0.6.2 - Set default address to localhost diff --git a/INSTALL.md b/INSTALL.md index 859b037..6a3bec9 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,4 +1,4 @@ -Compiling and installing +Building and installing ------------------------ Only dependency is C library and POSIX getopt support. @@ -7,9 +7,9 @@ Compiling with GCC or CLANG: cc -std=gnu99 -Wpedantic -Wall -Wextra -Os -s -o mcrcon mcrcon.c -Note: on Window remember to link with winsockets by adding "-lws2_32" to your compiler command line. +Note: on Windows remember to link with winsock by adding `-lws2_32` to your compiler command line. -Or you can just run "make": +Or you can just run "**make**": make - compiles mcrcon make install - installs compiled binaries and manpage to the system @@ -19,4 +19,4 @@ Or you can just run "make": /usr/local/bin/mcrcon /usr/local/share/man/man1/mcrcon.1 -Makefile "install" and "uninstall" rules are disabled on windows. +Makefile "**install**" and "**uninstall**" rules are disabled on windows. diff --git a/README.md b/README.md index bd18792..300695a 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ See https://pkgs.org/download/mcrcon for available packages in various Linux dis - Gentoo Linux: https://packages.gentoo.org/packages/games-util/mcrcon - Arch Linux: https://aur.archlinux.org/packages/mcrcon/ -##### from sources: +##### building from sources: ```sh git clone https://github.com/Tiiffi/mcrcon.git cd mcrcon @@ -57,7 +57,9 @@ MCRCON_PASS - Rcon commands with spaces must be enclosed in quotes Example: - ```mcrcon -H my.minecraft.server -p password -w 2 "say Server is restarting!" save-all stop``` +> Send three commands ("say", "save-all", "stop") and wait five seconds between the commands. + + ```mcrcon -H my.minecraft.server -p password -w 5 "say Server is restarting!" save-all stop``` --- diff --git a/mcrcon.1 b/mcrcon.1 index 4ff3d0b..e39ec9e 100644 --- a/mcrcon.1 +++ b/mcrcon.1 @@ -37,7 +37,7 @@ Output version information Commands with spaces must be enclosed in quotes. .br mcrcon will start in terminal mode if no commands are given. -.SH ENVIRONMENTAL VARIABLES +.SH ENVIRONMENT VARIABLES Server address, port and password can be set with following environment variables: .PP \fBMCRCON_HOST @@ -58,9 +58,9 @@ Send "weather clear" command to server using custom port 1337 \fBmcrcon\fR -H my.minecraft.server -P 1337 -p password "weather clear" .RE .PP -Send three commands to server ("say", "save-all" and "stop"), and wait 2 seconds between them +Send three commands ("say", "save-all", "stop") and wait five seconds between the commands. .RS -\fBmcrcon\fR -H my.minecraft.server -p password -w 2 "say Server is restarting!" save-all stop +\fBmcrcon\fR -H my.minecraft.server -p password -w 5 "say Server is restarting!" save-all stop .RE .SH BUGS -Bugs can be reported to \fBtiiffi+mcrcon at gmail\fR or \fBhttps://github.com/Tiiffi/mcrcon/issues/\fR +Report bugs to \fBtiiffi+mcrcon at gmail\fR or \fBhttps://github.com/Tiiffi/mcrcon/issues/\fR