Updating config.mk, manual and README

[xmenu] / xmenu.1

diff --git a/xmenu.1 b/xmenu.1
index eac4699..bad4aee 100644 (file)
--- a/xmenu.1
+++ b/xmenu.1
@@ -4,7 +4,7 @@ xmenu \- menu utility for X
 .SH SYNOPSIS
 .B xmenu
 .RB [ \-w ]
 .SH SYNOPSIS
 .B xmenu
 .RB [ \-w ]

-.RI [ title... ]
+.RI [ title ]

 .SH DESCRIPTION
 .B xmenu
 is a menu for X,
 .SH DESCRIPTION
 .B xmenu
 is a menu for X,


@@ -16,27 +16,32 @@ The options are as follows:
 .TP
 .B -w
 Asks the window manager to draw a border around the menus.
 .TP
 .B -w
 Asks the window manager to draw a border around the menus.

-Without this options, the menus do not have border drawn by the window manager.
+This option may be buggy in some window managers, specially tiled ones.

 .PP
 Each item read from stdin has the following format:
 .IP
 .EX
 .PP
 Each item read from stdin has the following format:
 .IP
 .EX

-ITEM := TABS LABEL TABS COMMAND NEWLINE
+ITEM := [TABS] [[IMAGE TABS] LABEL [TABS OUTPUT]] NEWLINE

 .EE
 .PP
 .EE
 .PP

-That means, each item is composed by
-tabs, followed by a label, followed by more tabs, followed by a command,
-and ended by a newline.
+That means that each item is composed by
+tabs, followed by an optional image specification, followed by tabs
+followed by a label, followed by more tabs, followed by an output,
+and ended by a newline.  Brackets group optional elements.

 .IP
 The initial tabs indicate the menu hierarchy:
 items indented with a tab is shown in a submenu of the preceding item not indented.
 .IP
 The initial tabs indicate the menu hierarchy:
 items indented with a tab is shown in a submenu of the preceding item not indented.

+An item without initial tabs is a top-level item.
+.IP
+The image is a string of the form "IMG:/path/to/image.png".
+It specifies a image to be shown as icon at the left of the entry.

 .IP
 The label is the string that will be shown as a item in the menu.
 An item without label is considered a separator and is drawn as a thin line in the menu
 separating the item above from the item below.
 .IP
 .IP
 The label is the string that will be shown as a item in the menu.
 An item without label is considered a separator and is drawn as a thin line in the menu
 separating the item above from the item below.
 .IP

-The command is the string that will be output after selecting the item.
-If the item spawns a submenu, the command is the title of the menu.
+The output is the string that will be output after selecting the item.
+If an item does not have an output, its label is used as its output.

 .IP
 The newline terminates the item specification.
 .PP
 .IP
 The newline terminates the item specification.
 .PP


@@ -104,7 +109,7 @@ The size in pixels of the border around the menu.
 The size in pixels of the item separator.
 
 .SH EXAMPLES
 The size in pixels of the item separator.
 
 .SH EXAMPLES

-The following is an script exemplifying the use of
+The following script illustrates the use of

 .BR xmenu .
 The output is redirected to
 .IR sh (1),
 .BR xmenu .
 The output is redirected to
 .IR sh (1),


@@ -113,21 +118,21 @@ creating a command to be run by the shell.
 .EX
 #!/bin/sh
 
 .EX
 #!/bin/sh
 

-cat <<EOF | xmenu | sh
+cat <<EOF | xmenu | sh &

 Applications
 Applications

-       Web Browser     firefox
-       Image editor    gimp
-Terminal (xterm)       xterm
-Terminal (urxvt)       urxvt
-Terminal (st)          st
+       IMG:./web.png   Web Browser     firefox
+       IMG:./gimp.png  Image editor    gimp
+Terminal (xterm)                               xterm
+Terminal (urxvt)                               urxvt
+Terminal (st)                                  st

 
 

-Shutdown                       poweroff
-Reboot                 reboot
+Shutdown                                               poweroff
+Reboot                                         reboot

 EOF
 .EE
 .PP
 For example, by selecting \(lqApplications\(rq, a new menu will appear.
 EOF
 .EE
 .PP
 For example, by selecting \(lqApplications\(rq, a new menu will appear.

-Selecting \(lqWeb Browser\(rq in the new menu will open firefox.
+Selecting \(lqWeb Browser\(rq in the new menu opens firefox.

 .SH SEE ALSO
 .IR dmenu (1),
 .IR 9menu (1),
 .SH SEE ALSO
 .IR dmenu (1),
 .IR 9menu (1),