X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=modules%2Fluci-base%2Fluasrc%2Fsys.luadoc;h=3c7f69c6e9ecf40af11ddef78e6c8b59faed025a;hb=ae8b68cfe85296eb37436621895cdddac66b3ca7;hp=72a16a1ab015bdfa22db7654692df778c670cd45;hpb=cd24ad05a4a87e5bb37a64a26a72e609b523c640;p=oweals%2Fluci.git diff --git a/modules/luci-base/luasrc/sys.luadoc b/modules/luci-base/luasrc/sys.luadoc index 72a16a1ab..3c7f69c6e 100644 --- a/modules/luci-base/luasrc/sys.luadoc +++ b/modules/luci-base/luasrc/sys.luadoc @@ -1,8 +1,7 @@ ---[[ LuCI Linux and POSIX system utilities. - -module "luci.sys" ]] +module "luci.sys" ---[[ Execute a given shell command and return the error code @@ -19,7 +18,7 @@ Execute a given shell command and capture its standard output @class function @name exec @param command Command to call -@return String containg the return the output of the command +@return String containing the return the output of the command ]] ---[[ @@ -39,7 +38,7 @@ exists. @class function @name getenv @param var Name of the environment variable to retrieve (optional) -@return String containg the value of the specified variable +@return String containing the value of the specified variable @return Table containing all variables if no variable name is given ]] @@ -151,6 +150,16 @@ Returns a two-dimensional table of IPv6 address hints. [ "ip", "name" ] ]] +---[[ +Returns a two-dimensional table of host hints. + +@class function +@name net.host_hints +@return Table of table containing known hosts from various sources, + indexed by mac address. Each subtable contains at least one + of the fields "name", "ipv4" or "ipv6". +]] + ---[[ Returns conntrack information @@ -270,7 +279,7 @@ LuCI system utilities / user related functions. ]] ---[[ -Retrieve user informations for given uid. +Retrieve user information for given uid. @class function @name getuser @@ -296,7 +305,7 @@ Test whether given string matches the password of a given system user. @name user.checkpasswd @param username String containing the Unix user name @param pass String containing the password to compare -@return Boolean indicating wheather the passwords are equal +@return Boolean indicating whether the passwords are equal ]] ---[[