diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/embedded-scripts.txt | 21 |
1 files changed, 8 insertions, 13 deletions
diff --git a/docs/embedded-scripts.txt b/docs/embedded-scripts.txt index 1b0c5b591..7a273d698 100644 --- a/docs/embedded-scripts.txt +++ b/docs/embedded-scripts.txt | |||
| @@ -3,13 +3,9 @@ Embedded Shell Scripts in BusyBox | |||
| 3 | 3 | ||
| 4 | BusyBox allows applets to be implemented as shell scripts. Since | 4 | BusyBox allows applets to be implemented as shell scripts. Since |
| 5 | this obviously requires a shell to interpret the scripts the feature | 5 | this obviously requires a shell to interpret the scripts the feature |
| 6 | depends on having a shell (specifically, ash) built into the binary. | 6 | depends on having a shell built into the binary. Either ash or hush |
| 7 | Support for embedded scripts also has to be enabled. | 7 | will do. If both are present ash will be used. Support for embedded |
| 8 | 8 | scripts also has to be enabled. | |
| 9 | To embed scripts in BusyBox you must enable these configuration options: | ||
| 10 | |||
| 11 | ASH | ||
| 12 | ASH_EMBEDDED_SCRIPTS | ||
| 13 | 9 | ||
| 14 | It's unlikely that your applet will be implemented as a pure shell | 10 | It's unlikely that your applet will be implemented as a pure shell |
| 15 | script: it will probably need some external commands. If these are | 11 | script: it will probably need some external commands. If these are |
| @@ -75,10 +71,9 @@ code for the native applet: | |||
| 75 | 71 | ||
| 76 | The only difference is that the applet is specified as being of type | 72 | The only difference is that the applet is specified as being of type |
| 77 | APPLET_SCRIPTED. It would also be useful to include details of any | 73 | APPLET_SCRIPTED. It would also be useful to include details of any |
| 78 | dependencies the script has. We can assume that ash is available. | 74 | dependencies the script has. No external commands are used by our mu |
| 79 | No external commands are used by our mu script, but it does depend on | 75 | script, but it does depend on optional shell features. We can ensure |
| 80 | optional shell features. We can ensure these are selected by adding | 76 | these are selected by adding this to the configuration: |
| 81 | this to the configuration: | ||
| 82 | 77 | ||
| 83 | //config:config MU_DEPENDENCIES | 78 | //config:config MU_DEPENDENCIES |
| 84 | //config: bool "Enable dependencies for mu" | 79 | //config: bool "Enable dependencies for mu" |
| @@ -87,8 +82,8 @@ this to the configuration: | |||
| 87 | //config: select ASH_RANDOM_SUPPORT | 82 | //config: select ASH_RANDOM_SUPPORT |
| 88 | //config: select FEATURE_SH_MATH | 83 | //config: select FEATURE_SH_MATH |
| 89 | //config: help | 84 | //config: help |
| 90 | //config: mu is implemented as a shell script. It requires ash | 85 | //config: mu is implemented as a shell script. It requires support |
| 91 | //config: support for $RANDOM and arithmetic. | 86 | //config: for $RANDOM and arithmetic. |
| 92 | 87 | ||
| 93 | The configuration data should be placed in a C file in an appropriate | 88 | The configuration data should be placed in a C file in an appropriate |
| 94 | subdirectory. There isn't any C code, though! In this case the file | 89 | subdirectory. There isn't any C code, though! In this case the file |