1
2			powwow 1.2.16 README
3
4Powwow is a client program intended mainly for playing MUD.
5It implements (a subset of) the telnet protocol.
6
7Files you should have received:
8
9	README		This text.
10	Changelog 	What has changed since the last release.
11	powwow.doc	Complete documentation. READ this!
12	configure	A shell script that will create a Makefile
13			suitable for your system
14	*.[ch]		Sources.
15	tools/*		Additional standalone utilities.
16	powwow.help	Online help file (in plain ASCII).
17	powwow.6	Man page.
18	Config.demo	A demonstrative definition file for powwow
19	Hacking		Read this if you want to improve/destroy powwow
20			yourself.
21	README.follow	Documentation for the 'follow' mini-program.
22	README.term     How to make termpowwow
23
24COMPILING
25
26	powwow is built using GNU autoconf scripts, it should detect any
27	system dependancies it needs and set the appropriate flags.  Just
28	run:
29
30	./configure
31	make
32
33	To build the powwow binary.  It will run from any location, but there
34	are some settings set at compile time that will make more sense if
35	you use the "install" make target to install the binaries and
36	documentation together.  For example, POWWOWDIR will default to the
37	location that "make install" will put the online powwow documentation,
38	making the #help feature work out of the box without modifying any
39	settings or flags.
40
41	If you require changes to the build process, please e-mail the problems
42	(and hopefully solution) to me at bpk@hoopajoo.net.  Also please
43	include your system information (uname -a, etc)
44
45	There are also some other options that may be turned on or off or
46	forced using configure.  Try "configure --help" to see the full
47	list of compile-time configuration options.
48
49INSTALLING
50
51	If you want powwow's definition files to go in a specific directory,
52	set the environment variable POWWOWDIR to that directory. It will be
53	searched first for definition files at startup.
54
55	Put the file powwow.6 in a suitable directory if you want users on
56	your system to be able to read the long and comprehensive man page ;)
57
58	Powwow supports the MUME editing protocol.  It enables you to edit
59	texts locally with your favourite editor.  So far, only MUME supports
60	this protocol, but this might change in the future.
61
62	Powwow looks for the editor in the POWWOWEDITOR enviroment variable,
63	and if it doesn't exist, in EDITOR, and uses "emacs" as default.  For
64	text viewing, powwow looks for POWWOWPAGER, then PAGER, then uses
65	"more" as default.
66
67	If you are on a multi-window terminal (such as an X terminal or NCSA
68	telnet from a Mac or PC), powwow will let you start the editor in
69	another window and remain active.  You will then also be able to edit
70	several texts at the same time.  To achieve this, let the first
71	character of your editor/pager be '&' (which is then skipped).
72
73	Example: (Bourne shell syntax)
74
75	POWWOWEDITOR=vi		  Use vi as normal editor (same window as
76				  powwow)
77	POWWOWEDITOR='&emacs'	  Use emacs as editor in a separate window (if
78				  you are on an X terminal)
79	POWWOWEDITOR='&xterm -e vi'  Use vi in another X window
80	POWWOWPAGER='&xterm -e less' Use less as your file viewer in another
81				     X window
82
83	If you use a multi-window terminal and have emacsclient installed, it
84	is a good choice, since you only need one emacs window for all your
85	editing sessions and you don't have to start and exit emacs all the
86	time.  Set POWWOWEDITOR='&emacsclient' in that case, and make sure your
87	emacs has a running server (put (server-start) in your .emacs file or
88	type M-x server-start).
89
90	If you want to use the editing functions, you must execute the
91	"#identify" command to notify the server that the client supports the
92	protocol. This can also be done with an action; see the documentation
93	for details.
94
95	For editing Mudlle programs with emacs, there is a special mode that
96	helps you with indenting. To use it, put mudlle.el in a suitable
97	place, and add the two following lines to your .emacs file:
98
99	(setq load-path (append load-path '("mydirectory")))
100	(autoload 'mudlle-mode "mudlle.el" "Turns on mudlle editing mode" t)
101
102	where you replace mydirectory with the directory where mudlle.el can
103	be found. If you put the string -*-mudlle-*- in the first line of
104	a mudlle program (i.e. in a comment), then emacs will automatically
105	turn on mudlle mode for that file when you edit it.
106	The mudlle mode can be customized to some extent. See the source for
107	details.
108
109BUGS
110
111	If you have any problems with powwow, try to fix them yourself
112	(you have the source, right?) or at least isolate the bugs so
113	the maintainer has a fair chance of fixing them. Don't expect
114	a bug to be fixed, unless you explain it in detail (expecially
115	how to reproduce it) and supply the powwow and OS version,
116	as well as the compilation options.
117        Suggestions for improvements are also very welcome.
118
119AUTHORS OF CANCAN
120
121	Since powwow is based on cancan, we report also this.
122
123        Mattias Engdegård <f91-men@nada.kth.se> was the original author.
124	Many other people have contributed at least as much, including
125	Finn Arne Gangstad <finnag@pvv.unit.no>, David Gay <dgay@di.epfl.ch>,
126	Gary Dezern <gdezern@satelnet.org>
127	and Lai-Chang Woo <vivriel@scs.com.sg>.
128	It is unclear who the current maintainer is, but it seems to be
129	Finn Arne Gangstad. Ask around at MUME to find out more about cancan.
130
131AUTHORS OF POWWOW
132
133        Massimiliano Ghilardi <max@Linuz.sns.it>, alias Cosmos,
134	is the original author, and Gustav H�llberg <f92-gha@nada.kth.se>
135	contributed a lot of new features.
136
137	powwow moved to hoopajoo.net in 2005, and is now maintained by
138	Steve Slaven <bpk@hoopajoo.net>
139
140        The powwow WWW page is: http://hoopajoo.net/projects/powwow.html
141
142	If you forgot where you downloaded powwow from, you can get it from
143	the above address.
144
145	To learn more about MUME, have a look at http://www.mume.org
146	which also explains how to connect.
147
148COPYRIGHT
149
150	Powwow is placed under the terms of GPL (GNU General Public License)
151	The GPL License can be found in the file COPYING.
152
153