Permalink
Browse files

More minor README tweaks.

  • Loading branch information...
1 parent 5efd802 commit fe63b3330a4c9b10051f6400ebaea18f2ee61920 @talvo talvo committed Aug 21, 2015
Showing with 34 additions and 38 deletions.
  1. +1 −2 FAQ
  2. +1 −1 I18N
  3. +4 −5 INSTALL
  4. +8 −9 README
  5. +10 −10 README.SQL
  6. +10 −11 README.SSL
View
@@ -47,8 +47,7 @@ There are several options:
* Ask on M*U*S*H, a game where the PennMUSH developers and many other
talented folk hang out. mush.pennmush.org 4201
* Ask on the community portal, at http://community.pennmush.org
- * File an issue with the devs (See the link below for the google code
- bug tracker).
+ * File an issue with the devs (See the link below for the github bug tracker)
2. How do I report a bug?
View
@@ -11,7 +11,7 @@ by the game into another language. (Helpfiles aren't currently translated.)
Several languages are currently supported to one degree or another.
If your favorite language isn't (or if you want to increase the
level of support), and you're fluent in it, you can help out!
-See http://javelin.pennmush.org/translation.html.
+Contact the PennMUSH devs for more info.
Localization (the process of making a MUSH conform to a given "locale")
is controlled by the LANG or LC_ALL environment variables, which have
View
@@ -20,8 +20,7 @@ resources will be written with UNIX is mind.)
You may also want to take a look at the Managing PennMUSH book at
http://community.pennmush.org and at Javelin's Guide for PennMUSH
-Gods, at http://javelin.pennmush.org/~alansz/guide.html or by ftp from
-pennmush.org, /pub/PennMUSH/Guide
+Gods, at http://download.pennmush.org/Guide/guide-single.html
============================================================================
A. Important background
@@ -101,8 +100,8 @@ B. Installation from source
% ./configure
Useful arguments to configure:
- a. --disable-sql: Don't compile in SQL support. See README.SQL for more sql-related
- config options.
+ a. --disable-sql: Don't compile in SQL support. See README.SQL for
+ more sql-related config options.
b. --disable-nls: Turn off translation support if you don't need it.
c. --disable-info_slave: Don't use an external process to do hostname
lookups. This option is required on Windows.
@@ -154,7 +153,7 @@ A pre-built binary is frequently available for win32 users who don't
want to customize their MUSH server, and don't feel like compiling it
themselves. This binary distribution may not contain the src, hdrs,
or hints directories and may be missing several key files (like
-Configure) from the pennmush directory. It does include the options.h
+configure) from the pennmush directory. It does include the options.h
that it was built with, as an aid to those who decide later that they
want to customize the server; they are useful as a baseline to work
from.
View
@@ -44,11 +44,10 @@ maintain this code.
In January of 1992, Amberyl began working on the PernMUSH 1.15 code
release, for TinyKrynn. She took over the code, which no one was
-supporting, and is continuing to work on extending this code, as well
-as improving its compatibility with TinyMUSH 2.0. She changed the name
-to PennMUSH (named for her school, the University of Pennsylvania), to
-avoid the confusion that resulted from PernMUSH actually running
-TinyMUSH 2.0.
+supporting, and worked on extending this code, as well as improving its
+compatibility with TinyMUSH 2.0. She changed the name to PennMUSH (named for
+her school, the University of Pennsylvania), to avoid the confusion that
+resulted from PernMUSH actually running TinyMUSH 2.0.
In January of 1995, Amberyl passed on her mantle to Javelin (aka
Paul@Dune, Alan Schwartz), who continuted as the maintainer of the
@@ -88,7 +87,7 @@ should be numbered version 2.007 or higher.
If you are planning on modifying the source code to PennMUSH, you'll
probably want Javelin's Guide for PennMUSH Gods, which should be
available where you got this code, or, in hypertext, as
-http://pennmush.org/~alansz/guide.html. More recent versions
+http://download.pennmush.org/Guide/guide-single.html. More recent versions
may be available at http://community.pennmush.org.
Enjoy!
@@ -112,14 +111,14 @@ There are three places one could get help with a problem:
PennMUSH you found the problem on.
If the problem resulted in a crash and a core dump, a stack trace
- of the core dump (see the section above) should also be included.
+ of the core dump should also be included.
- If we need additional stuff (like a log of the Configure or make),
+ If we need additional stuff (like a log of the configure or make),
we'll ask for it, but if you know that it's relevant, you can send
it along, too.
You can also search to see if anyone else has already reported the
- issue,' see what issues have been fixed for upcoming releases, and
+ issue, see what issues have been fixed for upcoming releases, and
much more at the site.
2. The PennMUSH community portal is at http://community.pennmush.org
View
@@ -58,15 +58,15 @@ II.a. MySQL
If you want to avoid linking these libraries on systems where they
are present, pass the --without-mysql switch to configure.
- If you installed Mysql from a binary package (e.g. rpm or apt), you
+ If you installed MySQL from a binary package (e.g. rpm or apt), you
should be sure that your system also has the development package
(usually mysql-dev, mysql-devel or libmysqlclient-dev).
- If you think you have mysql libraries and header files but configure
+ If you think you have MySQL libraries and header files but configure
isn't finding them, they may be in an unusual location on your
system, with mysql_config not in your default path. Find its
location ('where mysql_config' if the program works for you, 'find /
- -name mysql_config' otherwise, and call configure with
+ -name mysql_config' otherwise), and call configure with
--with-mysql=/path/to/mysql_config
II.b. PostgresQL
@@ -82,16 +82,16 @@ II.b. PostgresQL
you should be sure that your system also has the development package
(usually postgresql-dev, or libpq or similar)
- If you think you have postgresql libraries and header files but
+ If you think you have PostgresQL libraries and header files but
configure isn't finding them, they may be in an unusual location on
your system, with pg_config not in your default path. Find its
location ('where pg_config' if the program works for you, 'find /
- -name pg_config' otherwise, and call configure with
+ -name pg_config' otherwise), and call configure with
--with-postgresql=/path/to/pg_config
II.c Sqlite
- The configure script distrubted with PennMUSH looks for sqlite3
+ The configure script distributed with PennMUSH looks for sqlite3
headers and libraries in /usr, /usr/local and /opt. If it's
somewhere else on your system, call configure with
--with-sqlite3=/path/to/sqlite3
@@ -102,12 +102,12 @@ II.c Sqlite
The path is the directory that contains the hdrs/ and lib/
directories that hold the sqlite3 headers and library respectively.
-III. Mush configuration overview
+III. MUSH configuration overview
mush.cnf includes these directives that configure the SQL support:
sql_platform provides the name of the SQL database server software
- that will be used for connections. It current takes one of four
+ that will be used for connections. It currently takes one of four
values: "disabled" (no SQL), "mysql", "postgresql", or "sqlite3".
If not specified, it defaults to disabled.
@@ -124,13 +124,13 @@ III. Mush configuration overview
tables. This must be specified and there is no default.
sql_username provides a username to connect to the SQL server
- with. If no specified, a null username will be used, which many SQL
+ with. If not specified, a null username will be used, which many SQL
servers treat as "the user running this (pennmush) process".
sql_password provides the password for the user. It defaults to no
password.
- For sqlite3, which uses a local file instead of connected to a
+ For sqlite3, which uses a local file instead of connecting to a
database server, sql_database gives the name of the database file,
sql_host must be localhost, and the username and password are
currently ignored.
View
@@ -3,8 +3,10 @@
As of version 1.7.7p17, PennMUSH supports SSL connections when linked
-with the OpenSSL library (http://www.openssl.org). The following
-features are supported:
+with the OpenSSL library (http://www.openssl.org). As of version 1.8.4p9,
+OpenSSL is a required.
+
+The following features are supported:
* Encrypted sessions using SSLv2, SSLv3, and TLSv1 protocols
with ephemeral Diffie-Hellman keying.
@@ -13,9 +15,6 @@ features are supported:
* Use of digest routines in the crytpo library for encrypting
passwords and the digest() function.
-As of version 1.8.4p9, OpenSSL is a required, not just optional
-library.
-
This document explains how to use SSL with PennMUSH, and covers
the following issues:
@@ -72,37 +71,37 @@ II.a. What to install
OpenSSL can also be compiled on Windows, and you could add its
libraries to the PennMUSH project file and link it in that way.
Noltar has done this succesfully; it requires compiling both OpenSSL
- and PennMUSH in /MD (multithread dll) mode.
+ and PennMUSH in /MD (multithread dll) mode. See win32/README for more info.
II.b Persistent SSL connections
Normally, encrypted connections will be booted when a running game
restarts, because the internal OpenSSL state cannot be saved to disc
and restored later. To allow persistant ssl connections via a proxy
process, pass --enable-ssl_slave to configure when you run it. This
- is experimental code (And thus not enabled by default) and does not
+ is experimental code (and thus not enabled by default) and does not
work on Windows.
It requires the libevent 2.X library and headers to be
installed. Get it through your OS's package system or at
http://monkey.org/~provos/libevent/ . Note that some popular OSes
- only seem to have packages for an older 1.X release of libevent (As
+ only seem to have packages for an older 1.X release of libevent (as
of p5, Debian and derived distributions like Ubuntu, possibly
others). You'll have to install libevent2 from source if that's the
case, and make sure the obsolete native package is removed to avoid
conflicts.
- To use the ssl slave, a full @shutdown and restart of the mush has
+ To use the ssl_slave, a full @shutdown and restart of the mush has
to take place after the mush source has been configured to enable
it, and compiled. Then players can connect via SSL capable clients
exactly as they did before, with the only change being that they
won't get booted on a @shutdown/reboot. It's transparent to the
player and the game.
- Once the ssl slave proxy becomes more widely tested and debugged, it
+ Once the ssl_slave proxy becomes more widely tested and debugged, it
will be enabled by default.
-III. Mush configuration overview
+III. MUSH configuration overview
mush.cnf includes five directives that configure the SSL support:

0 comments on commit fe63b33

Please sign in to comment.