docs/api/modules/luci.sys.init.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   5     <title>Reference</title>
   6     <link rel="stylesheet" href="../luadoc.css" type="text/css" />
   7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  14         <div id="product_logo"></div>
  15         <div id="product_name"><big><b></b></big></div>
  16         <div id="product_description"></div>
  17 </div> <!-- id="product" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.html">luci.http</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.date.html">luci.http.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.mime.html">luci.http.mime</a>
  55         </li>
  56
  57         <li>
  58                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  59         </li>
  60
  61         <li>
  62                 <a href="../modules/luci.ip.html">luci.ip</a>
  63         </li>
  64
  65         <li>
  66                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  67         </li>
  68
  69         <li>
  70                 <a href="../modules/luci.json.html">luci.json</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  87         </li>
  88
  89         <li>
  90                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  91         </li>
  92
  93         <li>
  94                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  95         </li>
  96
  97         <li>
  98                 <a href="../modules/luci.sys.html">luci.sys</a>
  99         </li>
 100
 101         <li><strong>luci.sys.init</strong></li>
 102
 103         <li>
 104                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/luci.util.html">luci.util</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/nixio.html">nixio</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.File.html">nixio.File</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.README.html">nixio.README</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 149         </li>
 150
 151         <li>
 152                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 153         </li>
 154
 155         <li>
 156                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 157         </li>
 158
 159         <li>
 160                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 161         </li>
 162
 163         <li>
 164                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 165         </li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 177         </li>
 178
 179 </ul>
 180
 181
 182
 183 <!-- File list -->
 184
 185
 186
 187
 188
 189
 190
 191 </div><!-- id="navigation" -->
 192
 193 <div id="content">
 194
 195 <h1>Class <code>luci.sys.init</code></h1>
 196
 197 <p>
 198
 199 LuCI system utilities / init related functions.
 200 </p>
 201
 202
 203
 204
 205
 206
 207
 208 <h2>Functions</h2>
 209 <table class="function_list">
 210
 211         <tr>
 212         <td class="name" nowrap><a href="#init.disable">disable</a>&nbsp;(name)</td>
 213         <td class="summary">
 214
 215 Disable the given init script
 216  </td>
 217         </tr>
 218
 219         <tr>
 220         <td class="name" nowrap><a href="#init.enable">enable</a>&nbsp;(name)</td>
 221         <td class="summary">
 222
 223 Enable the given init script
 224  </td>
 225         </tr>
 226
 227         <tr>
 228         <td class="name" nowrap><a href="#init.enabled">enabled</a>&nbsp;(name)</td>
 229         <td class="summary">
 230
 231 Test whether the given init script is enabled
 232  </td>
 233         </tr>
 234
 235         <tr>
 236         <td class="name" nowrap><a href="#init.index">index</a>&nbsp;(name)</td>
 237         <td class="summary">
 238
 239 Get the index of he given init script
 240  </td>
 241         </tr>
 242
 243         <tr>
 244         <td class="name" nowrap><a href="#init.names">names</a>&nbsp;()</td>
 245         <td class="summary">
 246
 247 Get the names of all installed init scripts
 248  </td>
 249         </tr>
 250
 251         <tr>
 252         <td class="name" nowrap><a href="#init.start">start</a>&nbsp;(name)</td>
 253         <td class="summary">
 254
 255 Start the given init script
 256  </td>
 257         </tr>
 258
 259         <tr>
 260         <td class="name" nowrap><a href="#init.stop">stop</a>&nbsp;(name)</td>
 261         <td class="summary">
 262
 263 Stop the given init script
 264  </td>
 265         </tr>
 266
 267 </table>
 268
 269
 270
 271
 272
 273
 274 <br/>
 275 <br/>
 276
 277
 278 <h2><a name="functions"></a>Functions</h2>
 279 <dl class="function">
 280
 281
 282
 283 <dt><a name="init.disable"></a><strong>disable</strong>&nbsp;(name)</dt>
 284 <dd>
 285
 286
 287 Disable the given init script
 288
 289
 290
 291 <h3>Parameters</h3>
 292 <ul>
 293
 294         <li>
 295           name: Name of the init script
 296         </li>
 297
 298 </ul>
 299
 300
 301
 302
 303
 304
 305 <h3>Return value:</h3>
 306 Boolean indicating success
 307
 308
 309
 310 </dd>
 311
 312
 313
 314
 315 <dt><a name="init.enable"></a><strong>enable</strong>&nbsp;(name)</dt>
 316 <dd>
 317
 318
 319 Enable the given init script
 320
 321
 322
 323 <h3>Parameters</h3>
 324 <ul>
 325
 326         <li>
 327           name: Name of the init script
 328         </li>
 329
 330 </ul>
 331
 332
 333
 334
 335
 336
 337 <h3>Return value:</h3>
 338 Boolean indicating success
 339
 340
 341
 342 </dd>
 343
 344
 345
 346
 347 <dt><a name="init.enabled"></a><strong>enabled</strong>&nbsp;(name)</dt>
 348 <dd>
 349
 350
 351 Test whether the given init script is enabled
 352
 353
 354
 355 <h3>Parameters</h3>
 356 <ul>
 357
 358         <li>
 359           name: Name of the init script
 360         </li>
 361
 362 </ul>
 363
 364
 365
 366
 367
 368
 369 <h3>Return value:</h3>
 370 Boolean indicating whether init is enabled
 371
 372
 373
 374 </dd>
 375
 376
 377
 378
 379 <dt><a name="init.index"></a><strong>index</strong>&nbsp;(name)</dt>
 380 <dd>
 381
 382
 383 Get the index of he given init script
 384
 385
 386
 387 <h3>Parameters</h3>
 388 <ul>
 389
 390         <li>
 391           name: Name of the init script
 392         </li>
 393
 394 </ul>
 395
 396
 397
 398
 399
 400
 401 <h3>Return value:</h3>
 402 Numeric index value
 403
 404
 405
 406 </dd>
 407
 408
 409
 410
 411 <dt><a name="init.names"></a><strong>names</strong>&nbsp;()</dt>
 412 <dd>
 413
 414
 415 Get the names of all installed init scripts
 416
 417
 418
 419
 420
 421
 422
 423
 424 <h3>Return value:</h3>
 425 Table containing the names of all inistalled init scripts
 426
 427
 428
 429 </dd>
 430
 431
 432
 433
 434 <dt><a name="init.start"></a><strong>start</strong>&nbsp;(name)</dt>
 435 <dd>
 436
 437
 438 Start the given init script
 439
 440
 441
 442 <h3>Parameters</h3>
 443 <ul>
 444
 445         <li>
 446           name: Name of the init script
 447         </li>
 448
 449 </ul>
 450
 451
 452
 453
 454
 455
 456 <h3>Return value:</h3>
 457 Boolean indicating success
 458
 459
 460
 461 </dd>
 462
 463
 464
 465
 466 <dt><a name="init.stop"></a><strong>stop</strong>&nbsp;(name)</dt>
 467 <dd>
 468
 469
 470 Stop the given init script
 471
 472
 473
 474 <h3>Parameters</h3>
 475 <ul>
 476
 477         <li>
 478           name: Name of the init script
 479         </li>
 480
 481 </ul>
 482
 483
 484
 485
 486
 487
 488 <h3>Return value:</h3>
 489 Boolean indicating success
 490
 491
 492
 493 </dd>
 494
 495
 496 </dl>
 497
 498
 499
 500
 501
 502 </div> <!-- id="content" -->
 503
 504 </div> <!-- id="main" -->
 505
 506 <div id="about">
 507         <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>
 508 </div> <!-- id="about" -->
 509
 510 </div> <!-- id="container" -->
 511 </body>
 512 </html>