1
2 TinyFugue is Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2002, 2003, 2004, 2005, 2006-2007 Ken Keys.
3
4 PCRE regexp package is Copyright 1997-1999 University of Cambridge.
5 See src/pcre-2.08/LICENCE for details.
6
7=======
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22
23=======
24
25
26 INSTALLING TINYFUGUE
27
28TinyFugue can be installed and run on UNIX-like systems, Mac OS X, OS/2,
29and Win32. For instructions, see the README file in the appropriate
30directory. For information on unofficial versions of TF for other
31operating systems, see the TF web page at http://tinyfugue.sourceforge.net/.
32
33Note that the .tar.gz and .tar.Z distributions contain LF line delimiters,
34intended for UNIX, and the .zip distribution contains CR LF delimiters,
35intended for OS/2. It is possible to convert line delimiters, but it's
36easier to just get a distribution that already has the correct delimiters.
37
38
39"Make" options
40--------------
41
42Options are not available on all systems. To use an option, give it as
43an argument to the installation program (e.g., "make clean").
44
45 all Compile, but do not install (the "install" option should be
46 run later to install the files).
47 install Compile (if you haven't already) and install. The default
48 installation locations depend on the operating system.
49 clean Remove object files and other junk from source directory.
50 uninstall Remove tf executable, help files, and library from their
51 installed locations.
52
53
54Public Installation
55-------------------
56
57Some features of TF can be disabled for secure public installation, by
58using one of these /restrict commands in %{TFLIBDIR}/local.tf:
59
60 /restrict SHELL Prevents all access to shell or external commands.
61 Disables TF builtins "/sh" and "/quote !", and
62 uncompression during /load and /help.
63
64 /restrict FILE Prevents reading and writing of files. Disables
65 TF builtins "/load", "/save", "/saveworld", "/log",
66 and "/quote '", and sockmload feature.
67 Implies /restrict shell.
68
69 /restrict WORLD Prevents the user from defining new worlds and
70 connecting to undefined worlds. TF builtins
71 /addworld and the "/world <host> <port>" semantics
72 are disabled. Implies /restrict file.
73
74
75Terminal Handling
76-----------------
77
78If the default terminal handling option does not work, tf can be
79configured to use vt100 codes or nothing at all. See the README
80file in the subdirectory corresponding to your operating system.
81
82
83Compression
84-----------
85
86If you are short on disk space, you can compress the helpfile and
87library files (except stdlib.tf). Make sure the COMPRESS_SUFFIX
88and COMPRESS_READ macros are set correctly; set them in the
89%{TFLIBDIR}/local.tf file if needed. Note that compresion can not
90be used if /restrict is used.
91
92
93Firewalls
94---------
95
96TF can be made to connect through a generic proxy server by setting
97the %proxy_host variable at runtime. See "/help proxy".
98
99Also see the README file in the subdirectory corresponding to your
100operating system to see if tf has transparent firewall support on your
101system.
102
103
104Last Resort
105-----------
106
107If you have an installation problem or other system-specific problem
108that is not described in this README or the README in the subdirectory
109for your system, contact the person who supports TF on your system. If
110you have a problem that is not system-related, ask for support on
111http://tinyfugue.sourceforge.net/ or contact the author by email at
112kenkeys@users.sourceforge.net. Please provide the following information:
113
114 The version of TF (type "/version" in tf).
115 The operating system version (on unix, type "uname -a" in the shell).
116 If tf won't compile, send the output of configure and make (in plaintext
117 form, please).
118 If you have a bug or core, give ALL error messages from tf.
119 If you have a bug or core, describe what you did or what happened
120 before the problem, and if the problem is repeatable.
121 If you have a core file, do NOT send it.
122
123
124Porting
125-------
126
127I have no personal interest in Mac OS 9, DOS, Windows 95, Windows NT, or
128Amiga, so I don't plan on porting to them. However, I am willing to
129work with someone who wants to try and is willing to follow my
130guidelines (this is how the OS/2 version was created, and why it is an
131official version which continues to grow). Basically, this means
132keeping the platform-specific code seperate and to a minimum, and not
133adding new features.
134
135