Skip to content

Commit d8b5b4c

Browse files
committed
documentation: extend documentation on configuration files
[ci skip]
1 parent 3023728 commit d8b5b4c

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

documentation/configuration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,7 @@ smile_r=:o=image/surprise.png
8484
# -- sticking out tongue
8585
smilie_r=:p=image/tongue_out.png
8686
```
87+
88+
Furthermore, the file `pmdb.conf.example.worldofplayers` contains a complete
89+
configuration file ready for use for private messages from the World of Players
90+
forum.

documentation/directories.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,11 @@ pmdb uses [templates](templates.md) to generate HTML files. Those templates are
2121
stored within the `templates` sub-directory of the main directory, e.g.
2222
`/home/name/.pmdb/templates` on Unix-like systems or
2323
`C:\Users\name\.pmdb\templates` on Windows systems.
24+
25+
## Configuration file
26+
27+
pmdb's configuration file is named `pmdb.conf` and located inside the main
28+
directory. This means its location could be `/home/name/.pmdb/pmdb.conf` on
29+
Unix-like systems or `C:\Users\name\.pmdb\pmdb.conf` on Windows systems, for
30+
example. For more information on the file and its contents
31+
see [configuration.md](configuration.md).

0 commit comments

Comments
 (0)