From 449eac6358b9f907975f4583772f5c552aed45b7 Mon Sep 17 00:00:00 2001 From: Tiiffi Date: Sun, 13 Nov 2016 14:16:14 +0200 Subject: [PATCH] Added manpage to the project. --- mcrcon.1 | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 mcrcon.1 diff --git a/mcrcon.1 b/mcrcon.1 new file mode 100644 index 0000000..7c16312 --- /dev/null +++ b/mcrcon.1 @@ -0,0 +1,33 @@ +.\" Process this file with +.\" groff -man -Tascii mcrcon.1 +.\" +.TH MCRCON 1 "November 2016" "Version 0.0.5" +.SH NAME +mcrcon \- sends rcon commands to a Minecraft server +.SH SYNOPSIS +.B mcrcon [ +options +.B ] [ +commands +.B ] +.SH DESCRIPTION +.B mcrcon +Mcrcon is Minecraft rcon client / terminal with bukkit coloring support. +It is well suited for remote administration and to be used as part of automated server maintenance scripts. +.SH OPTIONS +.IP -h +Print usage instructions. +.IP -s +Silent mode. Do not print data received from rcon. +.IP -t +Terminal mode. Act as an interactive terminal. +.IP -p +Rcon password. Default is "". +.IP -H +Hostname or IP address to connect to. +.IP -P +Port to connect to. Default is 25575. +.IP -C +Color off. Disables bukkit color printing. +.SH BUGS +Bugs can be reported to tiiffi@gmail.com or https://github.com/Tiiffi/mcrcon/issues/