initial commitHEADmaster

1 files changed, 33 insertions, 0 deletions

diff --git a/renu.1 b/renu.1
new file mode 100644
index 0000000..ec0ad21
--- /dev/null
+++ b/renu.1
@@ -0,0 +1,33 @@
+.TH RENU 1 renu\-VERSION
+.SH NAME
+renu \- recursive menu
+.SH SYNOPSIS
+.B renu
+.RB [FILE]
+.SH DESCRIPTION
+Create a recursive menu described in FILE.
+.PP
+The FILE should have a specific format, each line representing an option.
+.SS Menu (m name)
+This line represents the start of a menu.
+All the lines that follow, until another menu line is found, represent the entries of this menu.
+The default name the program will open is 'def'.
+.SS Empty line
+.SS Comment (# ...)
+If the line starts with a # or is empty, it is ignored and regarded as a comment.
+.SS Submenu (s entry name)
+The submenu line will open the menu with the specified name, once selected.
+Entry is the displayed name.
+The line takes two arguments.
+.SS Print (p entry [value])
+This option will print the value once selected.
+The value is an optional argument and, if empty, entry will be printed.
+.SS Run (r entry command)
+This line takes two arguments.
+The option will run the command as if it were run with sh -c "command".
+.SS Arguments
+Each line uses one or more arguments.
+The arguments are separated by spaces, thus if you want to have spaces
+in the arguments, you should either escape the space or use double quotes.
+You can escape a character using backslash ('\\').
+Note that the double quotes ('"') and backslashes ('\\') inside the argument always have to be escaped.