Document <link:timeout>

[user/henk/code/inspircd.git] / docs / inspircd.conf.example

diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example
index 3945a2ece945bb9941bab1a76f524fd40e7e93d0..b8ca698a67dbec686f6f5da2989aaf8aaae5396e 100644 (file)
--- a/docs/inspircd.conf.example
+++ b/docs/inspircd.conf.example
@@ -417,6 +417,11 @@
 #                 apply to autoconnected servers as well as manually  #
 #                 connected ones.                                     #
 #                                                                     #
+# timeout       - If this is defined, then outbound connections will  #
+#                 time out if they are not connected within this many #
+#                 seconds. If this is not defined, the default of ten #
+#                 seconds is used.                                    #
+#                                                                     #
 # to u:line a server (give it extra privilages required for running   #
 # services, Q, etc) you must include the <uline server> tag as shown  #
 # in the example below. You can have as many of these as you like.    #
@@ -449,6 +454,7 @@
        allowmask="69.58.44.0/24"
         autoconnect="300"
        failover="hub.other.net"
+       timeout="15"
         sendpass="outgoing!password"
         recvpass="incoming!password">
 
@@ -465,11 +471,12 @@
 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #   These options let you define the path to your motd and rules      #
-#   files. These should be absolute paths.                            #
+#   files. If these are relative paths, they are relative to the      #
+#   configurtion directory.                                           #
 #                                                                     #
 
-<files  motd="/home/cc/inspircd/conf/inspircd.motd"
-        rules="/home/cc/inspircd/conf/inspircd.rules">
+<files  motd="inspircd.motd"
+        rules="inspircd.rules">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
@@ -515,11 +522,12 @@
 # Define the path to the PID file here. The PID file can be used to   #
 # rehash the ircd from the shell or to terminate the ircd from the    #
 # shell using shell scripts, perl scripts etc, and to monitor the     #
-# ircd's state via cron jobs. This is IMPORTANT and you must define   #
-# it or the ircd will refuse to start.                                #
+# ircd's state via cron jobs. If this is a relative path, it will be  #
+# relative to the configuration directory, and if it is not defined,  #
+# the default of 'inspircd.pid' is used.                              #
 #                                                                     #
 
-<pid file="/path/to/inspircd.pid">
+#<pid file="/path/to/inspircd.pid">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
@@ -998,7 +1006,6 @@
 # Optional - If you specify to use the m_filter or m_filter_pcre      #
 # modules, then specfiy below the path to the filter.conf file.       #
 #                                                                     #
-#<filter file="/path/to/inspircd/filter.conf">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Foobar module: does nothing - historical relic
@@ -1022,7 +1029,7 @@
 # Optional - If you specify to use the m_helpop.so module, then       #
 # specify below the path to the helpop.conf file.                     #
 #                                                                     #
-#<helpop file="/path/to/inspircd/helpop.conf">
+#<helpop file="helpop.conf">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Hostchange module: Allows a different style of cloaking