Add pidfile option to run.py.

[irc/quakenet/qwebirc.git] / config.py.example

diff --git a/config.py.example b/config.py.example
index e8c9a7beec0a1635db5c07a7d6088413c5fb1826..ac727d9d0c2d0a076bce0d2bce192e152c14e6df 100644 (file)
--- a/config.py.example
+++ b/config.py.example
@@ -8,6 +8,9 @@
 # both!)
 # If in doubt always re-compile and restart.
 
+# The following line is required, don't remove it!
+from qwebirc.config_options import *
+
 # IRC OPTIONS
 # ---------------------------------------------------------------------
 #
@@ -22,9 +25,13 @@ IRCSERVER, IRCPORT = "irc.myserver.com", 6667
 REALNAME = "http://moo.com/"
 
 # OPTION: IDENT
-#        ident to use on irc, set to the literal value None to use a
-#        hexadecimal version of the IP address, e.g.:
-#        IDENT = None
+#        ident to use on irc, possible values include:
+#        - a string, e.g. IDENT = "webchat"
+#        - the literal value IDENT_HEX, this will set the ident to the
+#          a hexadecimal version of the users IP address, e.g
+#          IDENT = IDENT_HEX
+#        - the literal value IDENT_NICKNAME, this will use the users
+#          supplied nickname as their ident.
 IDENT = "webchat"
 
 # OPTION: WEBIRC_MODE