summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRasmus Eskola <fruitiex@gmail.com>2013-08-10 20:01:57 +0300
committerRasmus Eskola <fruitiex@gmail.com>2013-08-10 20:01:57 +0300
commit68bef9fd0fec08263c407356f08a9fc11b1a4ee8 (patch)
tree45101c17bcc50107a6a9cbcaadaf394fa64e8f32
parentc1036f7ad6c104ea6a6fb3e9ad25d5b14c9ba150 (diff)
README: add weechat alias and todo
-rw-r--r--README.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/README.md b/README.md
index 278f5e3..78daff2 100644
--- a/README.md
+++ b/README.md
@@ -27,15 +27,24 @@ Usage
Upon loading the module for the first time, you have to specify a path to your
log files with the LogPath command. (can also be specified by passing the
LogPath as an argument when loading)
-
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.
After the module is loaded and LogPath is set, you can request for logs with:
-
/msg *backlog <window-name> <num-lines>
-
-Currently the module can only be loaded on a per-network basis.
+A handy alias for weechat:
+ /alias bl msg *backlog $channel $1
+Now you can:
+ /bl 42
+to request 42 lines from the current window or just:
+ /bl
+to request the default amount (150) of lines from the current window.
+
+TODO
+----
+- Currently the module can only be loaded on a per-network basis.
+- Autodetect LogPath if possible
+- Optimize?