From 033416a15fe60fe10387119e0e63bb9ed9e8aedd Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Sat, 25 Jul 2009 23:34:13 -0400
Subject: Documentation overhaul.

---
 doc/manual/7_LuaInterface.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 doc/manual/7_LuaInterface.md

(limited to 'doc/manual/7_LuaInterface.md')

diff --git a/doc/manual/7_LuaInterface.md b/doc/manual/7_LuaInterface.md
new file mode 100644
index 00000000..f1e343d9
--- /dev/null
+++ b/doc/manual/7_LuaInterface.md
@@ -0,0 +1,27 @@
+# Lua Interface
+
+After startup, Textadept relinquishes control to Lua. At this point, having a
+Manual is pointless since all of Textadept's functionality is dynamic from here
+on out. This is where the most important resource for help comes in: the
+[LuaDoc][LuaDoc]. It contains not only documentation for Textadept's Lua API,
+but documentation for all of its modules and features as well. It is more up to
+date than a manual like this could ever be.
+
+[LuaDoc]: ../index.html
+
+## Global Variables
+
+The following global variables not mentioned in the LuaDoc are available in
+Textadept's Lua state:
+
+* `arg`: Table containing the command line arguments passed to Textadept.
+* `_HOME`: Path to the directory containing Textadept.
+* `WIN32`: If Textadept is running on Windows, this flag is `true`.
+* `MAC`: If Textadept is running on Mac OSX, this flag is `true`.
+* `_CHARSET`: The character set encoding of the filesystem. This is used in
+  [File I/O][file_io].
+* `RESETTING`: If [`textadept.reset()`][textadept_reset] has been called, this
+  flag is `true` while the Lua state is being re-initialized.
+
+[file_io]: ../modules/textadept.io.html
+[textadept_reset]: ../modules/textadept.html#reset
-- 
cgit v1.2.3