More explanation of log and state files

[goircd.git] / README

diff --git a/README b/README
index cc1a576edc67c1db9f8e0f3376c709ce0c093602..144d9382e230c7fe06025f86cf007de28b51c2fb 100644 (file)
--- a/README
+++ b/README
@@ -5,6 +5,7 @@ DESCRIPTION
 
 goircd is very simple IRC server, written on Go.
 It is heavily inspired by miniircd daemon written on Python.
 
 goircd is very simple IRC server, written on Go.
 It is heavily inspired by miniircd daemon written on Python.

+GoVPN is free software: see the file COPYING for copying conditions.

 It does not aim to replace full featured mass scalable IRC networks:
 
 * It can not connect to other servers. Just standalone installation
 It does not aim to replace full featured mass scalable IRC networks:
 
 * It can not connect to other servers. Just standalone installation


@@ -75,6 +76,21 @@ file and using the -passwords argument. Format of passwords file is:
 You can force rereading of passwords file without server interruption by
 sending HUP signal to him.
 
 You can force rereading of passwords file without server interruption by
 sending HUP signal to him.
 

+LOG FILES
+
+Log files are not opened all the time, but only during each message
+saving. That is why you can safely rename them for rotation purposes.
+
+STATE FILES
+
+Each state file has the name equals to room's one. It contains two plain
+text lines: room's topic and room's authentication key (empty if none
+specified). For example:
+
+    % cat states/meinroom
+    This is meinroom's topic
+    secretkey
+

 LICENCE
 
 This program is free software: you can redistribute it and/or modify
 LICENCE
 
 This program is free software: you can redistribute it and/or modify