From d80dd2291ff01d264dfa802b769fa19756f07821 Mon Sep 17 00:00:00 2001
From: Jo-Philipp Wich <jo@mein.io>
Date: Tue, 5 Nov 2019 09:31:27 +0100
Subject: documentation: update Lua API docs

Signed-off-by: Jo-Philipp Wich <jo@mein.io>
(cherry picked from commit 2ae6e3c6b3c3b65cd955bb10fb9065beebc5ffd2)
---
 documentation/api/modules/luci.sys.process.html | 75 +++++++++++++++++++++++++
 1 file changed, 75 insertions(+)

(limited to 'documentation/api/modules/luci.sys.process.html')

diff --git a/documentation/api/modules/luci.sys.process.html b/documentation/api/modules/luci.sys.process.html
index ffe09bdc20..d3664817cc 100644
--- a/documentation/api/modules/luci.sys.process.html
+++ b/documentation/api/modules/luci.sys.process.html
@@ -208,6 +208,13 @@ LuCI system utilities / process related functions.
 <h2>Functions</h2>
 <table class="function_list">
 
+	<tr>
+	<td class="name" nowrap><a href="#process.exec">exec</a>&nbsp;(commend, stdout, stderr, nowait)</td>
+	<td class="summary">
+ 
+Execute a process, optionally capturing stdio.</td>
+	</tr>
+
 	<tr>
 	<td class="name" nowrap><a href="#process.info">info</a>&nbsp;()</td>
 	<td class="summary">
@@ -259,6 +266,74 @@ Send a signal to a process identified by given pid.</td>
 
 
 
+<dt><a name="process.exec"></a><strong>exec</strong>&nbsp;(commend, stdout, stderr, nowait)</dt>
+<dd>
+
+ 
+Execute a process, optionally capturing stdio. 
+ 
+Executes the process specified by the given argv vector, e.g. 
+<code>{ "/bin/sh", "-c", "echo 1" }</code> and waits for it to terminate unless a true 
+value has been passed for the "nowait" parameter. 
+ 
+When a function value is passed for the stdout or stderr arguments, the passed 
+function is repeatedly called for each chunk read from the corresponding stdio 
+stream. The read data is passed as string containing at most 4096 bytes at a 
+time. 
+ 
+When a true, non-function value is passed for the stdout or stderr arguments, 
+the data of the corresponding stdio stream is read into an internal string 
+buffer and returned as "stdout" or "stderr" field respectively in the result 
+table. 
+ 
+When a true value is passed to the nowait parameter, the function does not 
+await process termination but returns as soon as all captured stdio streams 
+have been closed or - if no streams are captured - immediately after launching 
+the process. 
+
+
+
+<h3>Parameters</h3>
+<ul>
+	
+	<li>
+	  commend: Table containing the argv vector to execute
+	</li>
+	
+	<li>
+	  stdout: Callback function or boolean to indicate capturing (optional)
+	</li>
+	
+	<li>
+	  stderr: Callback function or boolean to indicate capturing (optional)
+	</li>
+	
+	<li>
+	  nowait: Don't wait for process termination when true (optional)
+	</li>
+	
+</ul>
+
+
+
+
+
+
+<h3>Return value:</h3>
+Table containing at least the fields "code" which holds the exit 
+            status of the invoked process or "-1" on error and "pid", which 
+            contains the process id assigned to the spawned process. When 
+            stdout and/or stderr capturing has been requested, it additionally 
+            contains "stdout" and "stderr" fields respectively, holding the 
+            captured stdio data as string.
+
+
+
+</dd>
+
+
+
+
 <dt><a name="process.info"></a><strong>info</strong>&nbsp;()</dt>
 <dd>
 
-- 
cgit v1.2.3