Document commandline parameters and environment variables

git-svn-id: svn://katsu.triplehelix.org/dgamelaunch/trunk@620 db0b04b0-f4d1-0310-9a6d-de3e77497b0e

diff --git a/README b/README
index 1ebbcf99e18a8d1c6eb541e2f22bdcde61d7f1b8..5dcef0b1a334124bc2503ec1bd4b370b12a040bb 100644 (file)
--- a/README
+++ b/README
@@ -117,6 +117,33 @@ If you have problems with dgamelaunch's display make sure that your chroot's
 populated.
 
 
+COMMANDLINE PARAMETERS
+======================
+
+ -a            Ignored.
+ -e            Ignored.
+ -f file       Read configuration from file.
+ -h            Ignored.
+ -i user       Autologin and run the register -command hook for "user"
+               (with password "user").
+ -p            Ignored.
+ -q            Be quiet, suppress errors.
+ -s            Show players currently playing.
+ -W user:msg   Send message "msg" to all players. The message seems
+               to come from "user".
+ -S            Free the shared memory block.
+ -D            Show contents of the shared memory block.
+
+
+ENVIRONMENT VARIABLES
+=====================
+
+ Linux telnetd allows importing the USER environment variables via telnet,
+ while FreeBSD does not.  FreeBSD, on the other hand, does allow the LOGNAME
+ environment variable.  Dgamelaunch will first check USER, then LOGNAME,
+ for "username:password", and tries autologin if either exists.
+
+
 ERROR CODES
 ===========