added docs

2 files changed, 188 insertions, 0 deletions

diff --git a/Makefile.am b/Makefile.am
index 0a3505b..dafd7cd 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -6,6 +6,9 @@ memedit_CFLAGS = -W -Wall
 
 memedit_LDADD = $(READLINE_LIBS)
 
+man_MANS = memedit.1
+EXTRA_DIST = $(man_MANS)
+
 # only needed to recompile the commandlineparser
 memedit_parser.c memedit_parser.h: memedit_parser.gp
 	genparse -o memedit_parser memedit_parser.gp
diff --git a/memedit.1 b/memedit.1
new file mode 100644
index 0000000..5c1ae51
--- /dev/null
+++ b/memedit.1
@@ -0,0 +1,185 @@
+.TH "memedit" "1" "0.6.0" "Pengutronix" "Development Tools"
+.SH "NAME"
+.LP 
+memedit \- view and edit memory patterns 
+.SH "SYNTAX"
+.LP 
+memedit [\fIoption\fP] <\fIfilename\fP>
+.br 
+.SH "DESCRIPTION"
+.LP 
+This program allows you to quickly display and change 
+memory content for testing purpose as well as for various 
+other development tasks. 
+.SH "OPTIONS"
+.LP 
+.TP 
+\fB\-\-startfile | \-s\fR <\fIbatchfile\fP>
+Use <\fIbatchfile\fP> as startfile. 
+.br 
+This will execute all commands in  <\fIbatchfile\fP>
+during startup. Output is written to stdout.
+.br 
+You may set Variables, map memory regions, 
+load files, etc. Use of comments is possible anywhere in your 
+startfile: Everything starting with a "#" up to the end of 
+the line is treated as a comment. E.g.:
+.br 
+.br 
+#
+.br 
+# Some Register
+.br 
+#
+.br 
+SR0 = 0x0   # Some Control / Status Register
+.br 
+.br
+.TP 
+\fB\-\-help | \-h\fR
+Output help information and exit.
+.TP 
+\fB\-\-verbose | \-V \fR
+Generate more verbose Output.
+.TP 
+\fB\-\-version | \-v\fR
+Output version information and exit.
+.SH "COMMANDS"
+.LP 
+memedit was built with libreadline support. So you can 
+recall commands by typing \fIshift-up\fP/\fIshift-down\fP.
+See readline(3) for Details.
+
+memedit commands: 
+.TP 
+\fBo, open\fR <\fIfile\fP>
+open <file>
+
+.TP 
+\fBc, close\fR
+close currently opened file
+
+.TP 
+\fBmap\fR <\fIstart\fP> <\fIsize\fP>
+map memory starting at physical address <start>
+into working buffer
+
+.TP 
+\fBunmap\fR
+unmap memory from working buffer
+
+.TP 
+\fBmd\fR [[@]<start> [<length>]]
+mem display from current position
+or from <start> for <length>
+
+.TP 
+\fBmd.b\fR [[@]<start> [<length>]]
+see md - byte access
+
+.TP 
+\fBmd.w\fR [[@]<start> [<length>]]
+see md - word access
+
+.TP 
+\fBmd.l\fR [[@]<start> [<length>]]
+see md - long word access
+
+.TP 
+\fBmm\fR <offset> <val1> .. <valN>  
+modify from value <offset>
+
+.TP 
+\fBmm.b\fR [[@]<start> [<length>]]
+see mm - byte access
+
+.TP 
+\fBmm.w\fR [[@]<start> [<length>]]
+see mm - word access
+
+.TP 
+\fBmm.l\fR [[@]<start> [<length>]]
+see mm - long word access
+
+.TP 
+\fBe, env, printenv\fR  
+print all currently defined variables
+
+.TP 
+\fB<var> = <expr>\fR
+set variable <var> to <expr>
+
+.TP 
+\fB<var>\fR
+print variable <var>
+
+.TP 
+\fB<var1> add <var2>\fR  |  \fB<var1> + <var2>\fR
+add variables
+
+.TP 
+\fB<var1> sub <var2>\fR  |  \fB<var1> - <var2>\fR
+substract variables
+
+.TP 
+\fB<var1> mul <var2>\fR  |  \fB<var1> * <var2>\fR
+multiplicate variables
+
+
+.TP 
+\fB<var1> div <var2>\fR  |  \fB<var1> / <var2>\fR
+divide variables
+
+.TP 
+\fB<var1> mod <var2>\fR  |  \fB<var1> % <var2>\fR
+divide variables and return the remainder.
+
+.TP 
+\fB<var1> rshift <var2>\fR  |  \fB<var1> >> <var2>\fR
+shift right
+
+
+.TP 
+\fB<var1> lshift <var2>\fR  |  \fB<var1> shift <var2>\fR  |  \fB<var1> << <var2>\fR
+shift left
+
+.TP
+Variables can be entered as decimals (without prefix), hex (prefixed with 0x)
+oct (0o) or bin (0b). 
+
+.TP 
+\fBq, x, exit, quit\fR
+Leave application
+
+.TP 
+\fBh, help\fR                            
+show this help text
+
+.SH "FILES"
+.LP 
+\fI$PREFIX/bin/memedit\fP 
+.br 
+
+.SH "EXAMPLES"
+.LP 
+To run this program the standard way type:
+.LP 
+memedit /dev/mem
+.br
+memedit /tmp/foo
+.LP 
+Alternativly you can run it with a startfile:
+.LP 
+memedit \-s pxa\-regs /dev/mem 
+.SH "AUTHORS"
+.LP 
+Primary author: Benedikt Spranger <b.spranger@linutronix.de>
+.br 
+Maintainer:     Robert Schwebel <r.schwebel@pengutronix.de> 
+.br 
+Contributor:    Sascha Hauer <s.hauer@pengutronix.de>
+.br 
+Documentation:  Bjoern Buerger <b.buerger@pengutronix.de>
+.SH "SEE ALSO"
+.LP 
+fpga\-edit(1) readline(3)