Workaround the erase problems with AT45DB

[tinyos-2.x.git] / tools / tinyos / misc / tos-storage-stm25p.1

diff --git a/tools/tinyos/misc/tos-storage-stm25p.1 b/tools/tinyos/misc/tos-storage-stm25p.1
index 21253e7976274393da0a65172150b797e7f3755a..a7f04a0c5385e480ed52a446a3f3504ab399fc01 100644 (file)
--- a/tools/tinyos/misc/tos-storage-stm25p.1
+++ b/tools/tinyos/misc/tos-storage-stm25p.1
@@ -5,20 +5,28 @@
 tos-storage-stm25p - Generate storage volume description code
 .SH SYNOPSIS
 
-\fBtos-storage-stm25p\fR
+\fBtos-storage-stm25p\fR \fIplatform-directory\fR
 .SH DESCRIPTION
 
 \fBtos-storage-stm25p\fR reads a user specification describing the layout
 of storage volumes on an ST M25P80 flash chip, and generates code
 describing that layout for use by the TinyOS 2.0 storage subsystem.  The
-user specification is in XML and is read from standard input. The code is
-written to standard output.
+user specification is in XML and is read from standard input. With all options,
+the code for a header file is written to standard output.  With the 
+optional \fB-t\fR flag specified, a VolumeMapC.nc file is generated that provides 
+interfaces to all the storage volume abstractions defined in the XML file.
+
+The mandatory \fIplatform-directory\fR argument should specify the platform 
+directory for the current compilation target; this is necessary for the correct 
+handling of file include statements in the XML input.
 
 This program is normally invoked automatically by the TinyOS build system
 when your application directory contains a \fBvolumes-stm25p.xml\fR file.
 .SH EXAMPLES
 
-  tos-storage-stm25p <volumes-stm25p.xml >build/telosb/StorageVolumes.h
+  tos-storage-stm25p -t /opt/tinyos-2.x/tos/platforms/telosb \\
+      <volumes-stm25p.xml >build/telosb/StorageVolumes.h
 .SH SEE ALSO
 
-.IR tos-storage-stm25p (1)
+.IR tos-storage-pxa27xp30 (1)
+.IR tos-storage-at45db (1)