diff options
Diffstat (limited to 'docs/src/config-file.dox')
| -rw-r--r-- | docs/src/config-file.dox | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/src/config-file.dox b/docs/src/config-file.dox new file mode 100644 index 00000000000..6490aca20e6 --- /dev/null +++ b/docs/src/config-file.dox @@ -0,0 +1,34 @@ +/*! @page config_file WiredTiger Home Directory Configuration File + +If a file named \c WiredTiger.config appears in the WiredTiger home +directory, it is read as a configuration string. Configuration values +specified in the config argument to the wiredtiger_open function +override configuration values specified in the \c WiredTiger.config file. + +The file is minimally parsed in order to build configuration strings +for the WiredTiger configuration parser: +<ul> + +<li>A backslash (<b><tt>\\</tt></b>) followed by any character other +than a newline character leaves both characters untouched; otherwise, +if a backslash is followed by a newline character, both the backslash +and the newline character are discarded. + +<li>Any text between double-quote pairs (<b><tt>"</tt></b>) is left +untouched, including newline and white-space characters. Backslash +characters escape double-quote characters: a backslash escaped +double-quote character can neither start or end a quoted string. + +<li>Comments are discarded. If the first non-white-space character +following an unquoted and unescaped newline character is a hash mark +(<b><tt>#</tt></b>), all characters up to the next newline character are +discarded. The ending newline character cannot be escaped or quoted, +once a comment line is identified, all characters to the next newline +are simply discarded. + +<li>Otherwise, all lines are concatenated and the newline characters +replaced with commas. + +</ul> + +*/ |