summaryrefslogtreecommitdiffstats
path: root/apps/system/install/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'apps/system/install/README.txt')
-rwxr-xr-xapps/system/install/README.txt26
1 files changed, 26 insertions, 0 deletions
diff --git a/apps/system/install/README.txt b/apps/system/install/README.txt
new file mode 100755
index 0000000000..66e9b0939a
--- /dev/null
+++ b/apps/system/install/README.txt
@@ -0,0 +1,26 @@
+
+Install Program
+===============
+
+ Source: NuttX
+ Author: Uros Platise
+ Date: 7. May 2011
+
+This application installs XIP application by placing it directly into
+the program memory (flash) area into free area and creates a start-up
+script into selected directory (i.e. /usr/bin/progname).
+
+Usage:
+ install [--stack RequiredStackSpace] [--priority Priority]
+ source-file destination-directory
+
+If stackspace is not given default stack space of 4096 Bytes is used.
+If priority is not given system default is used.
+
+Additional options:
+
+ --remove destination-file i.e. install --remove /usr/bin/myapp
+ --force to replace existing installation
+ --start <page> install app at or after <page>
+ --margin <pages> leave some free space after the kernel
+ Default is 16 pages so kernel may grow.