ソースを参照

Update UserManual: Document new option

bel 8 年 前
コミット
bf8ec52e75
1 ファイル変更14 行追加3 行削除
  1. 14 3
      docs/UserManual.md

+ 14 - 3
docs/UserManual.md

@@ -235,8 +235,8 @@ are additional default index files, ordered before `index.cgi`.
 ### enable\_keep\_alive `no`
 ### enable\_keep\_alive `no`
 Enable connection keep alive, either `yes` or `no`.
 Enable connection keep alive, either `yes` or `no`.
 
 
-Experimental feature. Allows clients to reuse TCP connection for subsequent
-HTTP requests, which improves performance.
+Allows clients to reuse TCP connection for subsequent HTTP requests, 
+which improves performance.
 For this to work when using request handlers it is important to add the
 For this to work when using request handlers it is important to add the
 correct Content-Length HTTP header for each request. If this is forgotten the
 correct Content-Length HTTP header for each request. If this is forgotten the
 client will time out.
 client will time out.
@@ -393,7 +393,6 @@ Note: For consistency with other timeouts, the value is configured in
 milliseconds. However, the TCP socket layer usually only offers a timeout in 
 milliseconds. However, the TCP socket layer usually only offers a timeout in 
 seconds, so the value should be an integer multiple of 1000.
 seconds, so the value should be an integer multiple of 1000.
 
 
-
 ### lua\_preload\_file
 ### lua\_preload\_file
 This configuration option can be used to specify a Lua script file, which
 This configuration option can be used to specify a Lua script file, which
 is executed before the actual web page script (Lua script, Lua server page
 is executed before the actual web page script (Lua script, Lua server page
@@ -415,6 +414,18 @@ directly to the client. Lua script parts are delimited from the standard
 content by including them between <? and ?> tags.
 content by including them between <? and ?> tags.
 An example can be found in the test directory.
 An example can be found in the test directory.
 
 
+### lua\_background\_script
+Experimental feature, and subject to change.
+Run a Lua script in the background, independent from any connection.
+The script is started before network access to the server is available.
+It can be used to prepare the document root (e.g., update files, compress
+files, ...), check for external resources, remove old log files, etc.
+
+The Lua state remains open until the server is stopped.
+In the future, some callback functions will be available to notify the
+script on changes of the server state.
+
+
 ### websocket\_root
 ### websocket\_root
 In case civetweb is built with Lua and websocket support, Lua scripts may
 In case civetweb is built with Lua and websocket support, Lua scripts may
 be used for websockets as well. Since websockets use a different URL scheme
 be used for websockets as well. Since websockets use a different URL scheme