aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-11-11 21:01:16 -0500
committerJoey Hess <joey@kodama.kitenet.net>2008-11-11 21:01:16 -0500
commit2ab3132d3b88afa4b23dec3bf2a38f185e7f2fed (patch)
tree7fac81537b72abbac89ca96a2c69673f211ca0a4
parentecd4f0ee553cc3e11491f236763d6cc7cd6dd8a1 (diff)
downloadikiwiki-2ab3132d3b88afa4b23dec3bf2a38f185e7f2fed.tar
ikiwiki-2ab3132d3b88afa4b23dec3bf2a38f185e7f2fed.tar.gz
document other files in .ikiwiki
-rw-r--r--doc/tips/inside_dot_ikiwiki.mdwn25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/tips/inside_dot_ikiwiki.mdwn b/doc/tips/inside_dot_ikiwiki.mdwn
index b649636dc..1f76ce4bd 100644
--- a/doc/tips/inside_dot_ikiwiki.mdwn
+++ b/doc/tips/inside_dot_ikiwiki.mdwn
@@ -63,3 +63,28 @@ To remove that user:
I've not written actual utilities to do this yet because I've only needed
to do it rarely, and the data I've wanted has been different each time.
--[[Joey]]
+
+## the session database
+
+`.ikiwiki/sessions.db` is the session database. See the [[cpan CGI::Session]]
+documentation for more details.
+
+## lockfiles
+
+In case you're curious, here's what the various lock files do.
+
+* `.ikiwiki/lockfile` is the master ikiwiki lock file. Ikiwiki takes this
+ lock before reading/writing state.
+* `.ikiwiki/commitlock` is locked as a semophore, to disable the commit hook
+ from doing anything.
+* `.ikiwiki/cgilock` is locked by the cgi wrapper, to ensure that only
+ one ikiwiki process is run at a time to handle cgi requests.
+
+## plugin state files
+
+Some plugins create other files to store their state.
+
+* `.ikiwiki/aggregate` is a plain text database used by the aggregate plugin
+ to record feeds and known posts.
+* `.ikiwiki/xapian/` is created by the search plugin, and contains xapian-omega
+ configuration and the xapian database.