This is an automated email from the git hooks/post-receive script.
git pushed a commit to branch efl
in repository laugh.
View the commit online.
commit 291adb9bb0e8b0434253bf8a23934aa5f3cad6bf
Author: melerva <[email protected]>
AuthorDate: Mon Sep 22 11:18:44 2025 -0400
Documented laugh module
---
doc/laugh1.adoc | 2 ++
doc/laugh7.adoc | 26 ++++++++++++++++++++++++++
doc/ref/laugh.adoc | 28 ++++++++++++++++++++++++++++
3 files changed, 56 insertions(+)
diff --git a/doc/laugh1.adoc b/doc/laugh1.adoc
index 73590ce..aecb99c 100644
--- a/doc/laugh1.adoc
+++ b/doc/laugh1.adoc
@@ -30,6 +30,7 @@ Everything after _APP_ is passed directly to the application.
== EXIT STATUS
+[horizontal]
*0*:: Success.
non-zero:: Failure.
@@ -37,4 +38,5 @@ May also exit with any code specified by the running app.
== SEE ALSO
+[horizontal]
laugh(7):: syntax and API documentation
diff --git a/doc/laugh7.adoc b/doc/laugh7.adoc
new file mode 100644
index 0000000..b7bee10
--- /dev/null
+++ b/doc/laugh7.adoc
@@ -0,0 +1,26 @@
+= laugh(7)
+:doctype: manpage
+:manmanual: LAUGH
+:mansource: LAUGH
+
+== Name
+
+laugh - the Lua Application Framework
+
+== Synopsis
+
+*laugh* runs /init.lua from the application folder or archive.
+
+== Standard Library
+
+All Lua 5.4 standard library functions are available, with the following changes:
+
+ - A loader is added to `package.searchers` so that `require` will search the application before it checks the regular filesystem.
+ - A new table is added, `package.nogc`, which is used by the mod_packagegc extension below.
+
+include::ref/laugh.adoc[leveloffset=+1]
+
+== See Also
+
+[horizontal]
+laugh(1):: the main binary
diff --git a/doc/ref/laugh.adoc b/doc/ref/laugh.adoc
new file mode 100644
index 0000000..184d464
--- /dev/null
+++ b/doc/ref/laugh.adoc
@@ -0,0 +1,28 @@
+== The `laugh` module
+
+Basic framework utilities.
+
+[source,lua]
+----
+local laugh = require('laugh')
+----
+
+=== Variables
+
+`laugh.version`::
+ A table containing the `major`, `minor`, and `patch` numbers for the
+ laugh(1) binary.
+
+=== Functions
+
+`laugh.loadfile (filename)`::
+ Identical to `loadfile` in standard Lua, except it searches the
+ application root instead of the filesystem.
+
+`laugh.open (filename [, mode])`::
+ Identical to `io.open` in standard Lua, except it searches the
+ application root instead of the filesystem.
+ The returned file handle uses PhysicsFS for all operations instead
+ of stdio.
+ Please note that at the moment, `:write` is not implemented on the
+ returned file handle. It is trivial to add, but not important.
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
