webmcp

changeset 268:599b8463b985

Added missing file libraries/extos/extos.autodoc.lua (accidentally not been tracked)
author jbe
date Fri Mar 20 15:47:36 2015 +0100 (2015-03-20)
parents 56d237b81c18
children 4858cffe1aa1
files libraries/extos/extos.autodoc.lua
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/libraries/extos/extos.autodoc.lua	Fri Mar 20 15:47:36 2015 +0100
     1.3 @@ -0,0 +1,73 @@
     1.4 +
     1.5 +--[[--
     1.6 +data_out,               -- string containing stdout data, or nil in case of error
     1.7 +data_err,               -- string containing error or stderr data
     1.8 +status =                -- exit code, or negative code in case of abnormal termination
     1.9 +extos.pfilter{
    1.10 +  data_in  = data_in,   -- string containing stdin data
    1.11 +  filename = filename,  -- executable
    1.12 +  arg1     = arg1,      -- first (non-zero) argument to executable
    1.13 +  arg2     = arg2,      -- second argument to executable
    1.14 +  ...
    1.15 +}
    1.16 +
    1.17 +Executes the executable given by "filename", passing optional arguments. A given string may be fed into the program as stdin. On success 3 values are returned: A string containing all stdout data of the sub-process, a string containing all stderr data of the sub-process, and a status code. The status code is negative, if the program didn't terminate normally. By convention a status code of zero indicates success, while positive status codes indicate error conditions. If program execution was not possible at all, then nil is returned as first value and an error string as second value.
    1.18 +
    1.19 +--]]--
    1.20 +-- implemented in extos.c as
    1.21 +-- static int extos_pfilter(lua_State *L)
    1.22 +--//--
    1.23 +
    1.24 +
    1.25 +--[[--
    1.26 +directory_entries =  -- table of directory entries
    1.27 +extos.listdir{
    1.28 +  path = path        -- path name
    1.29 +}
    1.30 +
    1.31 +This function returns a table containing strings representing each entry in a directory. On error nil and an error message is returned.
    1.32 +
    1.33 +--]]--
    1.34 +-- implemented in extos.c as
    1.35 +-- static int extos_listdir(lua_State *L)
    1.36 +--//--
    1.37 +
    1.38 +
    1.39 +--[[--
    1.40 +passhash =     -- encrypted password
    1.41 +extos.crypt{
    1.42 +  key = key,   -- password to be one-way encrypted
    1.43 +  salt = salt  -- salt to be used for encryption, optionally starting with "$N$", where N is a digit
    1.44 +}
    1.45 +
    1.46 +This function is a wrapper for the C function char *crypt(const char *key, const char *salt).
    1.47 +
    1.48 +--]]--
    1.49 +-- implemented in extos.c as
    1.50 +-- static int extos_crypt(lua_State *L)
    1.51 +--//--
    1.52 +
    1.53 +
    1.54 +--[[--
    1.55 +seconds =
    1.56 +extos.hires_time()
    1.57 +
    1.58 +Returns a unix time stamp representing current time with high resolution.
    1.59 +
    1.60 +--]]--
    1.61 +-- implemented in extos.c as
    1.62 +-- static int extos_hires_time(lua_State *L)
    1.63 +--//--
    1.64 +
    1.65 +
    1.66 +--[[--
    1.67 +seconds =
    1.68 +extos.monotonic_hires_time()
    1.69 +
    1.70 +Returns the number of (SI) seconds since loading the library with high resolution.
    1.71 +
    1.72 +--]]--
    1.73 +-- implemented in extos.c as
    1.74 +-- static int extos_monotonic_hires_time(lua_State *L)
    1.75 +--//--
    1.76 +

Impressum / About Us