From bf0d7d8c08527d7150027e1bc3ae2c8499c4ca97 Mon Sep 17 00:00:00 2001 From: David Härdeman Date: Tue, 7 Jul 2020 20:08:57 +0200 Subject: Add some man pages --- man/minecproxy.conf.xml | 209 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 209 insertions(+) create mode 100644 man/minecproxy.conf.xml (limited to 'man/minecproxy.conf.xml') diff --git a/man/minecproxy.conf.xml b/man/minecproxy.conf.xml new file mode 100644 index 0000000..65eaeac --- /dev/null +++ b/man/minecproxy.conf.xml @@ -0,0 +1,209 @@ + + + + + + + + minecproxy.conf + minecproxy + + + Developer + David + Härdeman + + + + + + minecproxy.conf + 5 + + + + minecproxy.conf + Basic settings for minecproxy + + + + minecproxy.conf + + + + Description + + minecproxy.conf provides the ability to + control some basics of minecproxy. + The file is expected to be in the main configuration directory + of minecproxy (see + minecproxy1) + and uses a plain text ini-style format simlar to what + systemd uses. + + + The file has a single section titled [MinecProxy], and comments + can be prefixed with #. The defaults should + be fine for the majority of users, meaning that no further + configuration is necessary and this file can be omitted. + + + + + Options + The following options are understood: + + + + + + Instead of constanly announcing the configured + Minecraft servers, listen to + the multicase messages sent by Minecraft + clients when they are looking for servers (i.e. joining + a certain multicast group) and only then start sending announce + messages on the local network. This cuts down on the network + traffic (this feature should be considered + experimental). + + + + + + + The name of the network interface (e.g. eth0 + to use when listening for IGMP messages + (default: all). + + + + + + + The number of seconds to wait between sending successive + announce messages on the local network. + + + + + + + The number of seconds to wait between performing + connection attempts when a client is connecting to a proxy + type server (see + minecproxy.mcserver5 + for a discussion of server types). Mostly useful when + minecproxy is in the process of starting + up a server. + + + + + + + How many connection attempts to perform (with a wait + of seconds in + between each attempt) before giving up. + + + + + + + Takes a boolean argument specifying whether to set the + TCP_DEFER_ACCEPT option on proxy + sockets. Said option allows minecproxy + to defer accepting connections until the client starts + sending data, which conserves resources (see + tcp7 + for further details). + + + + + + + Takes a boolean argument specifying whether to set the + IP_FREEBIND option on proxy + sockets. Said option allows minecproxy + to listen to addresses which are not configured at + the time minecproxy is started, which + allows minecproxy to be started before + the network has been configured, at the cost of not being + able to catch incorrectly defined addresses (see + ip7 + for further details). + + + + + + + Takes a boolean argument specifying whether to set the + SO_KEEPALIVE option on proxy + sockets. Said option allows minecproxy + to detect dead clients earlier, which might conserve resources (see + tcp7 + for further details). + + + + + + + Takes a boolean argument specifying whether to set the + IPTOS_LOWDELAY option on proxy + sockets. Said option informs the kernel that delays + should be minimized, as the Minecraft + traffic is interactive (see + ip7 + for further details). + + + + + + + Takes a boolean argument specifying whether to set the + TCP_NODELAY option on proxy + sockets. Said option allows packets to be forwarded as soon + as possible, which should benefit interactive traffic, such + as Minecraft connections (see + tcp7 + for further details). + + + + + + + + Example + + + + + + + See Also + + minecproxy1, + minecctl1, + minecproxy.mcserver5 + + + + -- cgit v1.2.3