diff options
Diffstat (limited to 'documentation/api/modules/luci.sys.user.html')
| -rw-r--r-- | documentation/api/modules/luci.sys.user.html | 412 |
1 files changed, 0 insertions, 412 deletions
diff --git a/documentation/api/modules/luci.sys.user.html b/documentation/api/modules/luci.sys.user.html deleted file mode 100644 index b2307ad385..0000000000 --- a/documentation/api/modules/luci.sys.user.html +++ /dev/null @@ -1,412 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<head> - <title>Reference</title> - <link rel="stylesheet" href="../luadoc.css" type="text/css" /> - <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/--> -</head> - -<body> -<div id="container"> - -<div id="product"> - <div id="product_logo"></div> - <div id="product_name"><big><b></b></big></div> - <div id="product_description"></div> -</div> <!-- id="product" --> - -<div id="main"> - -<div id="navigation"> - - -<h1>LuaDoc</h1> -<ul> - - <li><a href="../index.html">Index</a></li> - -</ul> - - -<!-- Module list --> - -<h1>Modules</h1> -<ul> - - <li> - <a href="../modules/luci.dispatcher.html">luci.dispatcher</a> - </li> - - <li> - <a href="../modules/luci.http.html">luci.http</a> - </li> - - <li> - <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a> - </li> - - <li> - <a href="../modules/luci.http.date.html">luci.http.date</a> - </li> - - <li> - <a href="../modules/luci.http.mime.html">luci.http.mime</a> - </li> - - <li> - <a href="../modules/luci.i18n.html">luci.i18n</a> - </li> - - <li> - <a href="../modules/luci.ip.html">luci.ip</a> - </li> - - <li> - <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a> - </li> - - <li> - <a href="../modules/luci.json.html">luci.json</a> - </li> - - <li> - <a href="../modules/luci.jsonc.html">luci.jsonc</a> - </li> - - <li> - <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a> - </li> - - <li> - <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a> - </li> - - <li> - <a href="../modules/luci.model.uci.html">luci.model.uci</a> - </li> - - <li> - <a href="../modules/luci.rpcc.html">luci.rpcc</a> - </li> - - <li> - <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a> - </li> - - <li> - <a href="../modules/luci.sys.html">luci.sys</a> - </li> - - <li> - <a href="../modules/luci.sys.init.html">luci.sys.init</a> - </li> - - <li> - <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a> - </li> - - <li> - <a href="../modules/luci.sys.net.html">luci.sys.net</a> - </li> - - <li> - <a href="../modules/luci.sys.process.html">luci.sys.process</a> - </li> - - <li><strong>luci.sys.user</strong></li> - - <li> - <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a> - </li> - - <li> - <a href="../modules/luci.util.html">luci.util</a> - </li> - - <li> - <a href="../modules/nixio.html">nixio</a> - </li> - - <li> - <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a> - </li> - - <li> - <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a> - </li> - - <li> - <a href="../modules/nixio.File.html">nixio.File</a> - </li> - - <li> - <a href="../modules/nixio.README.html">nixio.README</a> - </li> - - <li> - <a href="../modules/nixio.Socket.html">nixio.Socket</a> - </li> - - <li> - <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a> - </li> - - <li> - <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a> - </li> - - <li> - <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a> - </li> - - <li> - <a href="../modules/nixio.bin.html">nixio.bin</a> - </li> - - <li> - <a href="../modules/nixio.bit.html">nixio.bit</a> - </li> - - <li> - <a href="../modules/nixio.crypto.html">nixio.crypto</a> - </li> - - <li> - <a href="../modules/nixio.fs.html">nixio.fs</a> - </li> - -</ul> - - - -<!-- File list --> - - - - - - - -</div><!-- id="navigation" --> - -<div id="content"> - -<h1>Class <code>luci.sys.user</code></h1> - -<p> - -LuCI system utilities / user related functions. -</p> - - - - - - - -<h2>Functions</h2> -<table class="function_list"> - - <tr> - <td class="name" nowrap><a href="#getuser">getuser</a> (uid)</td> - <td class="summary"> - -Retrieve user information for given uid.</td> - </tr> - - <tr> - <td class="name" nowrap><a href="#user.checkpasswd">checkpasswd</a> (username, pass)</td> - <td class="summary"> - -Test whether given string matches the password of a given system user.</td> - </tr> - - <tr> - <td class="name" nowrap><a href="#user.getpasswd">getpasswd</a> (username)</td> - <td class="summary"> - -Retrieve the current user password hash.</td> - </tr> - - <tr> - <td class="name" nowrap><a href="#user.setpasswd">setpasswd</a> (username, password)</td> - <td class="summary"> - -Change the password of given user.</td> - </tr> - -</table> - - - - - - -<br/> -<br/> - - -<h2><a name="functions"></a>Functions</h2> -<dl class="function"> - - - -<dt><a name="getuser"></a><strong>getuser</strong> (uid)</dt> -<dd> - - -Retrieve user information for given uid. - - - -<h3>Parameters</h3> -<ul> - - <li> - uid: Number containing the Unix user id - </li> - -</ul> - - - - - - -<h3>Return value:</h3> -Table containing the following fields: - { "uid", "gid", "name", "passwd", "dir", "shell", "gecos" } - - - -</dd> - - - - -<dt><a name="user.checkpasswd"></a><strong>checkpasswd</strong> (username, pass)</dt> -<dd> - - -Test whether given string matches the password of a given system user. - - - -<h3>Parameters</h3> -<ul> - - <li> - username: String containing the Unix user name - </li> - - <li> - pass: String containing the password to compare - </li> - -</ul> - - - - - - -<h3>Return value:</h3> -Boolean indicating whether the passwords are equal - - - -</dd> - - - - -<dt><a name="user.getpasswd"></a><strong>getpasswd</strong> (username)</dt> -<dd> - - -Retrieve the current user password hash. - - - -<h3>Parameters</h3> -<ul> - - <li> - username: String containing the username to retrieve the password for - </li> - -</ul> - - - - - - -<h3>Return values:</h3> -<ol> - - <li>String containing the hash or nil if no password is set. - - <li>Password database entry - -</ol> - - - -</dd> - - - - -<dt><a name="user.setpasswd"></a><strong>setpasswd</strong> (username, password)</dt> -<dd> - - -Change the password of given user. - - - -<h3>Parameters</h3> -<ul> - - <li> - username: String containing the Unix user name - </li> - - <li> - password: String containing the password to compare - </li> - -</ul> - - - - - - -<h3>Return value:</h3> -Number containing 0 on success and >= 1 on error - - - -</dd> - - -</dl> - - - - - -</div> <!-- id="content" --> - -</div> <!-- id="main" --> - -<div id="about"> - <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> -</div> <!-- id="about" --> - -</div> <!-- id="container" --> -</body> -</html> |