summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 2efb628..08d3a56 100644
--- a/README.md
+++ b/README.md
@@ -30,8 +30,11 @@ path as an argument when loading the module)
LogPath /path/to/your/logs/$USER_$NETWORK_$WINDOW_*.log
-$USER will be replaced with your ZNC username, $NETWORK with the current
-network and $WINDOW with the requested channel/window name.
+**$USER** will be replaced with your ZNC username, **$NETWORK** with the current
+network and **$WINDOW** with the requested channel/window name. The last found
+asterisk character **'\*'** in the string is assumed to be a date, and the order in
+which the files are read is determined by a simple alphabetical sort. (ie.
+date format order must be year-month-date)
After the module is loaded and LogPath is set, you can request for logs with: