summaryrefslogtreecommitdiff
path: root/doc/python/helpers.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/python/helpers.txt')
-rw-r--r--doc/python/helpers.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/python/helpers.txt b/doc/python/helpers.txt
new file mode 100644
index 00000000..6a11e405
--- /dev/null
+++ b/doc/python/helpers.txt
@@ -0,0 +1,25 @@
+helpers
+
+----
+
+This document describes the 'helpers' module. The 'helpers' module provides
+methods to make writing python scripts easier.
+
+----
+
+Methods
+
+----
+
+execute(path)
+
+Forks and executes a process.
+
+ path: The executable to execute. The $PATH is searched so the full
+ path to the executable is not generally needed.
+
+Example:
+ execute("xterm")
+
+----
+