Fix #269: External image marks - (--remote --lua)
[geeqie.git] / doc / docbook / GuideReferenceLua.xml
index a032f50..cb6542d 100644 (file)
@@ -4,7 +4,9 @@
   <para>\r
     Lua scripts allow the functionality of Geeqie to be extended. Lua scripts may only be used in conjunction with the\r
     <link linkend="OverlayScreenDisplay">Overlay Screen Display</link>\r
-    .\r
+    and the\r
+    <programlisting xml:space="preserve">geeqie --remote --lua:</programlisting>\r
+    command line option.\r
   </para>\r
   <para />\r
   <para>Some knowledge of the Lua programming language is required.</para>\r
               <entry>Image:get_size()</entry>\r
               <entry>The file size in bytes</entry>\r
             </row>\r
+            <row>\r
+              <entry>Image:get_marks()</entry>\r
+              <entry>An integer representing the marks set for the file</entry>\r
+            </row>\r
             <row>\r
               <entry>Image:get_exif()</entry>\r
               <entry>A data structure containing the entire exif data</entry>\r
   </section>\r
   <section id="Warning">\r
     <title>Warning</title>\r
-    <warning><para>Lua is a powerful programming language. Errors in script files, besides having undesirable side-effects, may cause Geeqie to crash.</para></warning>\r
+    <warning>\r
+      <para>Lua is a powerful programming language. Errors in script files, besides having undesirable side-effects, may cause Geeqie to crash.</para>\r
+    </warning>\r
   </section>\r
-</section>
+</section>\r