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