From: H. Peter Anvin <hpa@zytor.com>
Date: Wed, 20 Feb 2008 00:25:26 +0000 (-0800)
Subject: Document hierarchial menus so far...
X-Git-Tag: syslinux-3.62-pre11~8
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8f6e112074e1b189bb229583e29270248be36989;p=platform%2Fupstream%2Fsyslinux.git

Document hierarchial menus so far...
---

diff --git a/NEWS b/NEWS
index fa728b6..5f11094 100644
--- a/NEWS
+++ b/NEWS
@@ -16,6 +16,10 @@ Changes in 3.62:
 	  high memory, removing the size limit and freeing up 64K of
 	  low memory.
 	* Get rid of 4096-entry limit in the simple menu system.
+	* New hierarchial submenu support: see MENU BEGIN, MENU END,
+	  MENU GOTO in doc/menu.doc.
+	* MENU QUIT allows creating a menu entry for returning to the
+	  command line.
 
 Changes in 3.61:
 	* EXTLINUX: fix crash when accessing an empty file.
diff --git a/doc/menu.doc b/doc/menu.doc
index 5fba0f2..d3c211f 100644
--- a/doc/menu.doc
+++ b/doc/menu.doc
@@ -93,7 +93,7 @@ MENU DISABLE
 	for example:
 	
 	# Entries for network boots
-	LABEL
+	LABEL -
 		MENU LABEL Network:
 		MENU DISABLE
 	
@@ -115,7 +115,7 @@ MENU DISABLE
 	MENU SEPARATOR
 
 	# Entries for local boots
-	LABEL
+	LABEL -
 		MENU LABEL Local:
 		MENU DISABLE
 
@@ -152,6 +152,7 @@ Help text ...
 ENDTEXT
 
 	(Only valid after a LABEL statement.)
+
 	Specifies a help text that should be displayed when a particular
 	selection is highlighted.
 
@@ -193,6 +194,37 @@ MENU BACKGROUND background
 	format.
 
 
+MENU BEGIN [tagname]
+MENU END
+
+	Begin/end a submenu.  The entries between MENU BEGIN and MENU
+	END form a submenu, which is marked with a > mark on the right
+	hand of the screen.  Submenus inherit the properties of their
+	parent menus, but can override them, and can thus have their
+	own backgrounds, master passwords, titles, timeouts, messages
+	and so forth.
+
+
+MENU GOTO tagname
+
+	(Only valid after a LABEL statement.)
+
+	This label will transfer to the named submenu instead of
+	booting anything.  To transfer to the top-level menu, specify
+	"menu goto .top".
+
+
+MENU QUIT
+
+	(Only valid after a LABEL statement.)
+
+	This label quits the menu system.
+
+	WARNING: if MENU MASTER PASSWD or ALLOWOPTIONS 0 is set, this
+	will still allow exiting to the CLI; however, a separate MENU
+	PASSWD can of course be set for this label.
+	
+
 INCLUDE filename
 MENU INCLUDE filename