mirror of
https://github.com/Tiiffi/mcrcon.git
synced 2025-10-27 11:21:07 -04:00
manpage improvements.
This commit is contained in:
52
mcrcon.1
52
mcrcon.1
@ -1,7 +1,7 @@
|
||||
.\" Process this file with
|
||||
.\" groff -man -Tascii mcrcon.1
|
||||
.\"
|
||||
.TH MCRCON 1 "November 2016" "Version 0.0.5"
|
||||
.TH MCRCON 1 "November 2016" "Version 0.0.6"
|
||||
.SH NAME
|
||||
mcrcon \- sends rcon commands to a Minecraft server
|
||||
.SH SYNOPSIS
|
||||
@ -11,23 +11,43 @@ options
|
||||
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.
|
||||
mcrcon is Minecraft rcon client / terminal with bukkit coloring support.\n\n\n
|
||||
It is well suited for remote administration and 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 "".
|
||||
Print usage
|
||||
.IP -H
|
||||
Hostname or IP address to connect to.
|
||||
Server address
|
||||
.IP -P
|
||||
Port to connect to. Default is 25575.
|
||||
.IP -C
|
||||
Color off. Disables bukkit color printing.
|
||||
Port (default is 25575)
|
||||
.IP -p
|
||||
Rcon password
|
||||
.IP -t
|
||||
Interactive terminal mode
|
||||
.IP -s
|
||||
Silent mode (do not print received packets)
|
||||
.IP -c
|
||||
Disable colors
|
||||
.IP -r
|
||||
Output raw packets (for debugging and custom handling)
|
||||
.IP -v
|
||||
Output version information
|
||||
.PP
|
||||
Commands with arguments must enclosed in quotes.
|
||||
.SH EXAMPLES
|
||||
Make rcon connection in terminal mode using default port
|
||||
.RS
|
||||
\fBmcrcon\fR -H my.minecraft.server -p password
|
||||
.RE
|
||||
.PP
|
||||
Send "weather clear" command to server using custom port 1337
|
||||
.RS
|
||||
\fBmcrcon\fR -H my.minecraft.server -P 1337 -p password "weather clear"
|
||||
.RE
|
||||
.PP
|
||||
Send three commands to server (say, save-all and stop)
|
||||
.RS
|
||||
\fBmcrcon\fR -H my.minecraft.server -p password "say Server is restarting!" save-all stop
|
||||
.RE
|
||||
.SH BUGS
|
||||
Bugs can be reported to tiiffi@gmail.com or https://github.com/Tiiffi/mcrcon/issues/
|
||||
Bugs can be reported to \fBtiiffi_at_gmail_dot_com\fR or \fBhttps://github.com/Tiiffi/mcrcon/issues/\fR
|
||||
|
||||
Reference in New Issue
Block a user