From 85c552c8833fb83a347e04ff46f79de470e33e4a Mon Sep 17 00:00:00 2001
From: mfranz <mfranz>
Date: Mon, 29 Sep 2008 15:06:03 +0000
Subject: [PATCH] add documentation

---
 Input/Keyboard/multikey.xml | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/Input/Keyboard/multikey.xml b/Input/Keyboard/multikey.xml
index 6d8113889..98fc3e248 100644
--- a/Input/Keyboard/multikey.xml
+++ b/Input/Keyboard/multikey.xml
@@ -1,5 +1,18 @@
 <?xml version="1.0"?>
 
+<!--
+	This file defines vi-like key sequences which are started with the ':'-key.
+	It's evaluated by $FG_ROOT/Nasal/multikey.nas.
+
+	- <Esc> always aborts.
+	- <Return>/<Enter> executes and terminates the command mode, given that
+	  <binding>s exist (use "null" if there's nothing else to do) and <no-exit/>
+	  isn't defined.
+	- Keys with defined <exit/> property execute their bindings immediately.
+	- Format placeholder values are available to Nasal code via arg[].
+	- Nasal code can set the dialog title by assignment to the _ variable.
+-->
+
 <PropertyList>
 	<nasal>
 		<script>
@@ -20,6 +33,7 @@
 	<key n="58">
 		<name>:</name>
 		<desc>User command</desc>
+		<!-- reserved for user extensions -->
 	</key>
 
 	<!-- environment -->