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