Permalink
Browse files

Improve the markdown and pandoc-generated HTML docs.

  • Loading branch information...
Shawn
Shawn committed Jan 5, 2018
1 parent 68caa38 commit c72d6b05b687a25f7c41095f36f6ffa5ce5ab822
Showing with 942 additions and 718 deletions.
  1. +8 −3 BUGS.md
  2. +2 −0 CHANGES187.md
  3. +17 −15 FAQ.md
  4. +0 −82 I18N
  5. +97 −0 I18N.md
  6. +48 −33 INSTALL.md
  7. +47 −30 README.SQL.md
  8. +85 −187 README.SSL.md
  9. +18 −16 README.md
  10. +25 −21 UPGRADING.md
  11. +26 −17 htmldocs/BUGS.html
  12. +23 −11 htmldocs/CHANGES187.html
  13. +67 −32 htmldocs/FAQ.html
  14. +62 −0 htmldocs/I18N.html
  15. +57 −38 htmldocs/INSTALL.html
  16. +5 −2 htmldocs/Makefile
  17. +154 −0 htmldocs/README.SQL.html
  18. +67 −159 htmldocs/README.SSL.html
  19. +34 −32 htmldocs/README.html
  20. +48 −40 htmldocs/UPGRADING.html
  21. +34 −0 htmldocs/index.html
  22. +18 −0 htmldocs/index.md
View
11 BUGS.md
@@ -1,5 +1,7 @@
Bugs that aren't our fault, but might bite people:
==================================================
% Bugs and Issues
Bugs that aren't our fault, but might bite people
=================================================
* You might experience crashes because the default executable stack
size is too small. An 8 megabyte stack is more than ample. On unix,
@@ -33,6 +35,9 @@ Bugs that aren't our fault, but might bite people:
and macros visible to Penn, let us know! Some functions known to
cause this include `posix_fadvise()` and `posix_fallocate()`.
Bugs that are our fault
=======================
You can browse the bug and suggestion database at
<https://github.com/pennmush/pennmush/issues> to see more.
<https://github.com/pennmush/pennmush/issues> to see the list.
View
@@ -1,4 +1,6 @@
% PennMUSH 1.8.7 Changes
%
% Last release: ??? ?? 20??
This is the most current changes file for PennMUSH. Please look it over; each version contains new things which might significantly affect the function of your server. Changes are reported in reverse chronological order (most recent first)
View
32 FAQ.md
@@ -1,8 +1,7 @@
Frequently asked questions about the PennMUSH Server, 1.8.7
===========================================================
% Frequently asked questions about the PennMUSH Server, 1.8.7
What's the release history since 1.50pl10?
------------------------------------------
==========================================
PennMUSH has been around for a long time. The above-mentioned 1.50p10
(1.5.0p10) release was made in 1995, and Penn wasn't new then.
@@ -31,7 +30,7 @@ the active development team is Raevnos, Walker, Mike, Intrevis, and Rince.
The current version is 1.8.7.
How do I ask for help with a problem?
----------------------------------------
=====================================
There are several options:
@@ -40,7 +39,7 @@ There are several options:
* File an issue with the devs (See the link below for the github bug tracker)
How do I report a bug?
----------------------
======================
Visit the [issue tracker](https://github.com/pennmush/pennmush/issues).
@@ -51,7 +50,7 @@ the bug, send it along. If you don't, and the bug caused a crash with
a core dump, you can send along a stack trace.
How do I request a new feature?
----------------------------------
===============================
Visit the [issue tracker](https://github.com/pennmush/pennmush/issues).
@@ -61,7 +60,7 @@ with a patch implementing them tend to get accepted faster than those
that don't unless it's a trivial addition.
Where can I get more information about admin'ing and hacking MUSH?
------------------------------------------------------------------
==================================================================
Read
[Javelin's God for PennMUSH Gods](http://download.pennmush.org/Guide/),
@@ -78,13 +77,13 @@ The source code has
browsed.
Where can I hear about new releases?
------------------------------------
====================================
New releases of the PennMUSH code are announced on `M*U*S*H`
(mush.pennmush.org 4201).
Why doesn't %t or space() work right for Pueblo clients?
--------------------------------------------------------
========================================================
Actually, it does. Pueblo is built around an HTML browser. In HTML,
multiple whitespace is ignored and treated as a single space. This is
@@ -93,12 +92,15 @@ spaces, you must put your text in `<PRE>..</PRE>` blocks,
e.g. `tagwrap(PRE,this %t has %t tabs %t and %b%b spaces`).
What signals does PennMUSH understand?
--------------------------------------
======================================
PennMUSH understands the following signals, and performs the listed action:
* -HUP ( 1) Performs a silent @readcache
* -USR1 (16) Performs an @shutdown/reboot
* -USR2 (17) Performs an @dump
* -INT ( 2) Performs an @shutdown
* -TERM (15) Performs an @shutdown/panic
Name Number Description
---- ------ -----------
HUP 1 Performs a silent `@readcache`
USR1 16 Performs an `@shutdown/reboot`
USR2 17 Performs an `@dump`
INT 2 Performs an `@shutdown`
TERM 15 Performs an `@shutdown/panic`
View
82 I18N

This file was deleted.

Oops, something went wrong.
View
97 I18N.md
@@ -0,0 +1,97 @@
% Internationalization in PennMUSH
Introduction
============
PennMUSH 1.7.3 and later have extensive support for running in
non-English environments. There are two parts to this. First, what the
mush considers to be valid characters, what's upper-case, what's
lower-case, how they are sorted, and so on. The second is translating
the messages produced 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! 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 the form "la_DI", where la is a language code
and DI is a dialect. For example, "en_US" stands for English, United
States dialect. The language codes are usually the same as a country's
top level domain in URLs. Spanish is 'es', Russian is 'ru', and so on.
You need to have appropriate locale files installed in your operating
system to have everything work right (specifically, to get the
right character sets). How you do this is system-specific; Unix/linux
users should start with `man -k locale` to find their system
commands (often `man locale` or `man locale-gen` will be helpful).
There are two places where you have to use LANG: when you're
compiling the MUSH (in order to compile the message translation files)
and when you start up the MUSH (in order to set the locale for
the running server).
Current State
=============
Nobody currently owns the translation project and the translation
files have not been updated in years. There might be many examples of
messages that are not included in the available listings. If you're
interested in taking over the project, contact the dev team!
Compiling the MUSH
==================
Files with messages for translation are included with the source
code in pennmush/po; they have the .pox extension. You can get
the very latest versions of these files from the PennMUSH Git repository.
These files have to be compiled to an efficient internal form before
starting up the mush. This means you should set your LANG environment
variable before you compile your server.
To do this using the common bash shell, `export LANG=en_US`, or
whatever your setting is. If that doesn't work, consult the
documentation for the shell you're using.
The message files are compiled during the `make install` step, which
runs 1make localized1 in the the po directory. (Technically, a pox
file for your LANG is merged with `po/pennmush.pot` to produce a po file
for your LANG, and then that is compiled into
`po/<LANG>/LC_MESSAGES/pennmush.mo`, which is loaded by the server.)
You can disable translation support entirely if so desired by passing
`--disable-nls` to the configure script.
Starting up the MUSH
====================
The LANG environment variable that controls what language the mush
uses is normally set in the pennmush/game/restart script. There's an
example for using French in the script already that can be used as a
starting point.
Your server account might be set up with a non-english language as the
default. If so, and you don't set LANG in the restart script, that
default language will be used.
You may also wish to change the `only_ascii_in_names` config option in
mush.cnf, to allow accented characters in object names.
Development
===========
Generally, the rules that the devteam use to decide what strings
should be made translatable in the source code (tagged with T()) are:
* tag in-game messages (stuff shown to players) with T(), except:
* panic messages
* very technical output like `@list alloc` and `@stats/table`
* don't tag log messages with `T()`
* don't tag console messages with `T()`
Oops, something went wrong.

0 comments on commit c72d6b0

Please sign in to comment.