xmenu \- menu utility for X
.SH SYNOPSIS
.B xmenu
+.RB [ \-w ]
+.RI [ title ]
.SH DESCRIPTION
.B xmenu
is a menu for X,
shows a menu for the user to select one of the items,
and outputs the item selected to stdout.
.PP
+The options are as follows:
+.TP
+.B -w
+Asks the window manager to draw a border around the menus.
+This option may be buggy in some window managers, specially tiled ones.
+.PP
Each item read from stdin has the following format:
.IP
.EX
-ITEM := [TABS] [LABEL [TABS OUTPUT]] NEWLINE
+ITEM := [TABS] [[IMAGE TABS] LABEL [TABS OUTPUT]] NEWLINE
.EE
.PP
That means that each item is composed by
-tabs, followed by a label, followed by more tabs, followed by an output,
+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.
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.
If an item does not have an output, its label is used as its output.
.IP
The newline terminates the item specification.
+.PP
+If the argument
+.I title
+is given, the title of the menu window is set to it.
.SH USAGE
.B xmenu
is controlled by the mouse,
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),
cat <<EOF | xmenu | sh &
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.
-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),