summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorlinton-dawson <pushkarkukde@gmail.com>2018-10-01 02:35:02 +0530
committerHaru <haru@dotalux.com>2018-10-21 23:49:47 +0200
commit77fb75d9d424003907b8fb6910277efbef51f07f (patch)
tree5a4c71579f2b24b85c62a1c84ddd0e9485122716 /doc
parentb196e2b794bb96c1584c885f50e63326678ae89e (diff)
downloadhercules-77fb75d9d424003907b8fb6910277efbef51f07f.tar.gz
hercules-77fb75d9d424003907b8fb6910277efbef51f07f.tar.bz2
hercules-77fb75d9d424003907b8fb6910277efbef51f07f.tar.xz
hercules-77fb75d9d424003907b8fb6910277efbef51f07f.zip
global_configuration.md
Diffstat (limited to 'doc')
-rw-r--r--doc/global_configuration.md (renamed from doc/global_configuration.txt)30
1 files changed, 19 insertions, 11 deletions
diff --git a/doc/global_configuration.txt b/doc/global_configuration.md
index a000a4572..92d6ed150 100644
--- a/doc/global_configuration.txt
+++ b/doc/global_configuration.md
@@ -1,6 +1,6 @@
//===== Hercules Documentation ===============================
-//= Global configuration reference
-//===== By: ==================================================
+# Global configuration reference
+> //=====By: ==================================================
//= Panikon (Hercules Dev. Team)
//===== Current Version: =====================================
//= 20140616
@@ -8,12 +8,13 @@
//= Global configurations found in conf/global/
//============================================================
-- What are global configurations?
+
+## What are global configurations?
Global configurations are configurations that can be shared between servers,
but can also be set independently in each server.
-- How do they work?
+## How do they work?
They work by using an include system that is available with libconfig:
@@ -26,9 +27,10 @@ They work by using an include system that is available with libconfig:
@include "filename"
- Any backslashes or double quotes in the filename must be escaped as '\\' and
- '\"', respectively."
- From libconfig's documentation
+ Any backslashes or double quotes in the filename must be escaped as `\\` and
+ `\"`, respectively.
+
+ *From libconfig's documentation.*
So each file that is included is actually inside each one of the main
configuration files and thus a change in the first will be a change in the
@@ -36,7 +38,8 @@ latter.
Note: the @include directive is read by the server executable, so any path
should be from were it is and NOT from where the main configuration file is!
-- How do I stop using global configurations?
+
+## How do I stop using global configurations?
To stop using global configurations is very simple, all you have to do is copy
the contents that are inside the global configuration file and put them
@@ -44,9 +47,11 @@ _exactly_ where the include directive were in the main configuration file.
E.g.
Find in any file:
- @include "conf/global/sql_connection.conf"
+ `@include "conf/global/sql_connection.conf"`
Replace it with:
- sql_connection: {
+
+
+ sql_connection: {
// [INTER] You can specify the codepage to use in your mySQL tables here.
// (Note that this feature requires MySQL 4.1+)
//default_codepage: ""
@@ -65,5 +70,8 @@ E.g.
db_database: "ragnarok"
//codepage:""
}
+
If the main configuration file belongs to the map server, for instance, you
- don't need to include default_codepage and case_sensitive.
+don't need to include default_codepage and case_sensitive.
+
+