Switch to `twine check` in tox testenv:dist
[mudpy.git] / doc / source / clients.rst
1 =========
2  clients
3 =========
4
5 .. Copyright (c) 2004-2018 Jeremy Stanley <fungi@yuggoth.org>.
6    Permission to use, copy, modify, and distribute this software is
7    granted under terms provided in the LICENSE file distributed with
8    this software.
9
10 mudpy handles input, output and formatting of UTF-8 encoded,
11 multi-byte and wide characters, when coupled with a supporting
12 client. By default, however, only printable single-byte ASCII
13 characters are accepted or displayed unless the client negotiates
14 IETF RFC 856 *binary mode* first. If mudpy needs to send text
15 containing extended characters to a non-binary (7-bit) client, it
16 will first replace those characters with a question mark (``?``).
17
18 For example, the following is the recommended ``.telnetrc`` file for
19 interacting with mudpy in binary mode with the Netkit and Inetutils
20 Telnet clients::
21
22   example.mudpy.org set binary
23   example.mudpy.org unset echo
24   example.mudpy.org unset escape
25   example.mudpy.org unset flushoutput
26   example.mudpy.org unset interrupt
27   example.mudpy.org unset quit
28   example.mudpy.org unset eof
29   example.mudpy.org unset localchars