diff options
Diffstat (limited to 'man/minecctl.xml')
| -rw-r--r-- | man/minecctl.xml | 280 |
1 files changed, 280 insertions, 0 deletions
diff --git a/man/minecctl.xml b/man/minecctl.xml new file mode 100644 index 0000000..c410d40 --- /dev/null +++ b/man/minecctl.xml @@ -0,0 +1,280 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!-- SPDX-License-Identifier: GPL-2.0 --> + +<refentry id="minecctl"> + + <refentryinfo> + <title>minecctl</title> + <productname>minecproxy</productname> + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>David</firstname> + <surname>Härdeman</surname> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>minecctl</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>minecctl</refname> + <refpurpose>Interact with Minecraft servers</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>minecctl</command> + <arg choice="opt" rep="repeat">OPTIONS</arg> + <arg choice="opt" rep="plain">COMMAND</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para> + <command>minecctl</command> may be used to communicate with, and + control, Minecraft servers. It can also be used to perform various + checks on <command>minecproxy</command> server configuration files. + </para> + <para> + Commands are usually performed on servers defined by corresponding + configuration files in the <command>minecproxy</command> configuration + directory, but server connection details can also be set manually + to control servers which have no configuration files (see options + <option>-p</option>, <option>-r</option> and <option>-m</option> below). + </para> + </refsect1> + + <refsect1> + <title>Commands</title> + <para>The following commands are understood:</para> + <variablelist> + + <varlistentry> + <term><command>list</command></term> + <listitem><para> + List all known servers (i.e. servers with configuration files). + </para></listitem> + </varlistentry> + + <varlistentry> + <term><command>lint</command></term> + <listitem><para> + Check the validity of all known server configuration files. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><command>status</command> <optional>SERVER</optional></term> + <listitem><para> + Show the current status of <replaceable>SERVER</replaceable> + (or all known servers if <replaceable>SERVER</replaceable> + is not specified). + </para></listitem> + </varlistentry> + + <varlistentry> + <term><command>ping</command> <optional>SERVER</optional></term> + <listitem><para> + Check if <replaceable>SERVER</replaceable> is running + (if <replaceable>SERVER</replaceable> is not specified, it must + be defined via command line options, see options <option>-r</option> + and <option>-m</option> below). + </para></listitem> + </varlistentry> + + <varlistentry> + <term><command>stop</command> <optional>SERVER</optional></term> + <listitem><para> + Stop <replaceable>SERVER</replaceable> + (if <replaceable>SERVER</replaceable> is not specified, it must + be defined via command line options, see option <option>-r</option> + below). Note that servers with active players will not be + stopped unless forced (i.e. if option <option>-f</option> is used). + </para></listitem> + </varlistentry> + + <varlistentry> + <term><command>stopall</command></term> + <listitem><para> + Similar to <command>stop</command> but stops <emphasis>all</emphasis> + known servers (including any server specified using the + <option>-r</option> option). Like <command>stop</command>, + servers with active players will not be stopped unless + option <option>-f</option> is used. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><command>pcount</command> <optional>SERVER</optional></term> + <listitem><para> + Get the current player count for <replaceable>SERVER</replaceable> + using either the <acronym>rcon</acronym> or + <application>minecraft</application> protocol + (if <replaceable>SERVER</replaceable> is not specified, it must + be defined via command line options, see options <option>-r</option> + and <option>-m</option> below). + </para></listitem> + </varlistentry> + + <varlistentry> + <term><command>console</command> <optional>SERVER</optional></term> + <listitem><para> + Provides an interactive <acronym>rcon</acronym> command + line for <replaceable>SERVER</replaceable> + (if <replaceable>SERVER</replaceable> is not specified, it must + be defined via command line options, see option <option>-r</option> + below). + </para></listitem> + </varlistentry> + + <varlistentry> + <term><command>cmd</command> <optional>SERVER</optional> <replaceable>CMD</replaceable></term> + <listitem><para> + Send <replaceable>CMD</replaceable> to + <replaceable>SERVER</replaceable> via the + <acronym>rcon</acronym> protocol + (if <replaceable>SERVER</replaceable> is not specified, it must + be defined via command line options, see option <option>-r</option> + below). Note that <replaceable>CMD</replaceable> will be interpreted + as a single command, so e.g. <quote><command>minecctl cmd + <replaceable>SERVER</replaceable> time set day</command></quote> + will be interpreted as a single command. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><command>cmds</command> <optional>SERVER</optional> <replaceable>CMDS</replaceable></term> + <listitem><para> + Similar to <command>cmd</command> above, but allows multiple commands + to be sent to the server. Use quotes to separate commands, e.g. + <quote><command>minecctl cmds <replaceable>SERVER</replaceable> + <quote>time set day</quote> + <quote>say Enjoy the sun</quote></command></quote>. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><optional>SERVER</optional> <replaceable>CMD</replaceable></term> + <listitem><para> + Shorthand for <quote><command>cmd <optional>SERVER</optional> + <replaceable>CMD</replaceable></command></quote>. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><optional>SERVER</optional></term> + <listitem><para> + Shorthand for + <quote><command>console <optional>SERVER</optional></command></quote>. + </para></listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1> + <title>Options</title> + <para>The following options are understood:</para> + <variablelist> + + <varlistentry> + <term><option>-p</option></term> + <term><option>--rcon-password=<replaceable>PASSWORD</replaceable></option></term> + <listitem><para> + Use <replaceable>PASSWORD</replaceable> when + connecting via <acronym>rcon</acronym> to a server. If not set, + the password (if any) from the <replaceable>SERVER</replaceable> + configuration file will be used. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-r</option></term> + <term><option>--rcon-address=<replaceable>ADDRESS</replaceable></option></term> + <listitem><para> + Use <replaceable>ADDRESS</replaceable> when connecting via + <acronym>rcon</acronym> to a server. If not set, the address + (if any) from the <replaceable>SERVER</replaceable> configuration + file will be used. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-m</option></term> + <term><option>--mc-address=<replaceable>ADDRESS</replaceable></option></term> + <listitem><para> + Use <replaceable>ADDRESS</replaceable> when connecting via + the <application>minecraft</application> protocol to a server + (only used for some commands such as <command>pcount</command>, + <command>status</command> and <command>ping</command>). + If not set, the address (if any) from the + <replaceable>SERVER</replaceable> configuration file will be used. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option></term> + <term><option>--cfgdir=<replaceable>DIR</replaceable></option></term> + <listitem><para> + Look for <replaceable>SERVER</replaceable> configuration files + in <replaceable>DIR</replaceable> instead of the default + directory (<filename class="directory">/etc/minecproxy/</filename>). + <!-- FIXME: Add replacement var --> + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-f</option></term> + <term><option>--force</option></term> + <listitem><para> + Normally <command>minecctl</command> will check the current + player count and refuse to stop a server with active players. + This option means that the given server(s) will be stopped + even if there are active players. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-v</option></term> + <term><option>--verbose</option></term> + <listitem><para> + Output extra logging information. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-d</option></term> + <term><option>--debug</option></term> + <listitem><para> + Output debugging information (implies <option>-v</option>). + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-h</option></term> + <term><option>--help</option></term> + <listitem><para> + Prints a list of valid options/commands and exits. + </para></listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>minecproxy</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>minecproxy.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>minecproxy.mcserver</refentrytitle><manvolnum>5</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> |