From 8c26d11db2960c40256e4882e345ef1a5b8fa1c2 Mon Sep 17 00:00:00 2001
From: Vincent Riquer <vincent+gitorious@riquer.fr>
Date: Thu, 16 May 2013 14:23:03 +0200
Subject: [PATCH] Document toys/createindex

---
 toys/README | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/toys/README b/toys/README
index d3d7af9..8a57574 100644
--- a/toys/README
+++ b/toys/README
@@ -1,3 +1,36 @@
+createindex
+===========
+Creates a nice index of your collection, similar to what oidua
+(http://oidua.suxbad.com/) does, but much faster, as it is using AtOM's DB
+instead of rescanning your whole collection.
+
+Options define what will be shown and may optionnally be followed by the column
+width (default: 50).
+
+Options:
+	-f:	Path
+	-b:	Average bitrate
+	-C:	Channels
+	-s:	Sample rate
+	-T:	Mofification time
+
+	-A:	Album artist
+	-l:	Album
+	-a:	Artist
+	-c:	Composer
+	-d:	Disc
+	-g:	Genre
+	-p:	Performer
+	-t:	Title
+	-y:	Year
+
+	-d <format>:	date-time format (see 'man date' for possible values)
+	-o -|<file>:	output file (path relative to Source) - mandatory - must
+			appear last.
+
+	-u:	update database first
+	-D:	debug
+
 checkextensions
 ===============
 Reports files whose extension does not match the (detected) mime-type.