unix/dualinit

docs/config.md in master
Repositories | Summary | Log | Files | LICENSE

config.md (2585B) download


  1# Configuration Reference
  2
  3## Controlling
  4
  5### `include <path>`
  6
  7> includes an file
  8
  9| parameter | description           |
 10| --------- | --------------------- |
 11| path      | absolute path to init |
 12
 13---
 14
 15### `end`
 16
 17> ends a section
 18
 19## General Configuration
 20
 21### `section <name> <root>`
 22
 23> starts the definition of a section (has to be closed with `end`)
 24
 25| parameter | description                 |
 26| --------- | --------------------------- |
 27| name      | name of the section         |
 28| root      | path to the root of section |
 29
 30---
 31
 32### `mount`
 33
 34> starts a mount-section which has to be closed with `end`
 35
 36---
 37
 38### `share/rshare <dirs...>`
 39
 40> shares dictionaries `dirs` (recursive if `rshare`)
 41>
 42> alias for mount `- <dir> <dir> bind/rbind`
 43
 44| parameter | description               |
 45| --------- | ------------------------- |
 46| dirs      | dictionaries to be shared |
 47
 48---
 49
 50### `color <enable>`
 51
 52> defines if color should be enabled
 53
 54| parameter                | description                |
 55| ------------------------ | -------------------------- |
 56| enable (`true`\|`false`) | if color-output is enabled |
 57
 58---
 59
 60### `verbose <enable>`
 61
 62> defines if color should be enabled
 63
 64| parameter                | description                  |
 65| ------------------------ | ---------------------------- |
 66| enable (`true`\|`false`) | if verbose-output is enabled |
 67
 68---
 69
 70### `timeout <duration>`
 71
 72> set timeout to duration
 73
 74| parameter | description        |
 75| --------- | ------------------ |
 76| duration  | timeout in seconds |
 77
 78## Section Configuration
 79
 80### `mount`
 81
 82> starts a mount-section which has to be closed with `end`
 83
 84---
 85
 86### `share/rshare <dirs...>`
 87
 88> shares dictionaries `dirs` (recursive if `rshare`)
 89>
 90> alias for mount `- <dir> <dir> bind/rbind`
 91
 92| parameter | description               |
 93| --------- | ------------------------- |
 94| dirs      | dictionaries to be shared |
 95
 96---
 97
 98### `init <path> [args...]`
 99
100> defines the init with possible args (defaults to `/sbin/init`)
101
102| parameter | description                          |
103| --------- | ------------------------------------ |
104| path      | path to init                         |
105| args      | arguments you want to pass to `init` |
106
107## Mount Configuration
108
109### `<type> <source> <target> [options]`
110
111> defines a new mount-point
112
113| parameter | description                     |
114| --------- | ------------------------------- |
115| type      | partition-type                  |
116| source    | source                          |
117| target    | target relative to the new root |
118| options   | an optional option-list         |