[xmenu] / xmenu.1

.TH PROG 1
.SH NAME
xmenu \- menu utility for X
.SH SYNOPSIS
.B xmenu
.RB [ \-w ]
.SH DESCRIPTION
.B xmenu
is a menu for X,
it reads a list of newline-separated items from stdin,
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.
Without this options, the menus do not have border drawn by the window manager.
.PP
Each item read from stdin has the following format:
.IP
.EX
ITEM := TABS LABEL TABS COMMAND NEWLINE
.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.
.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 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.
.IP
The newline terminates the item specification.
.SH EXAMPLES
The following is an script exemplifying the use
.BR xmenu .
The output is redirected to xargs to make a command to be run by the shell.
.IP
.EX
#!/bin/sh

cat <<EOF | ./xmenu | xargs sh -c
Applications
	Web Browser	firefox
	Image editor	gimp
Terminal (xterm)	xterm
Terminal (urxvt)	urxvt
Terminal (st)		st

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.
.SH SEE ALSO
.IR dmenu (1),
.IR 9menu (1),
.IR thingmenu (1)
Commit	Line	Data
08f16589	1	.TH PROG 1
	2	.SH NAME
	3	xmenu \- menu utility for X
	4	.SH SYNOPSIS
	5	.B xmenu
	6	.RB [ \-w ]
	7	.SH DESCRIPTION
	8	.B xmenu
	9	is a menu for X,
	10	it reads a list of newline-separated items from stdin,
	11	shows a menu for the user to select one of the items,
	12	and outputs the item selected to stdout.
	13	.PP
	14	The options are as follows:
	15	.TP
	16	.B -w
	17	Asks the window manager to draw a border around the menus.
	18	Without this options, the menus do not have border drawn by the window manager.
	19	.PP
	20	Each item read from stdin has the following format:
	21	.IP
	22	.EX
	23	ITEM := TABS LABEL TABS COMMAND NEWLINE
	24	.EE
	25	.PP
	26	That means, each item is composed by
	27	tabs, followed by a label, followed by more tabs, followed by a command,
	28	and ended by a newline.
	29	.IP
	30	The initial tabs indicate the menu hierarchy:
	31	items indented with a tab is shown in a submenu of the preceding item not indented.
	32	.IP
	33	The label is the string that will be shown as a item in the menu.
	34	An item without label is considered a separator and is drawn as a thin line in the menu
	35	separating the item above from the item below.
	36	.IP
	37	The command is the string that will be output after selecting the item.
	38	.IP
	39	The newline terminates the item specification.
	40	.SH EXAMPLES
	41	The following is an script exemplifying the use
	42	.BR xmenu .
	43	The output is redirected to xargs to make a command to be run by the shell.
	44	.IP
	45	.EX
	46	#!/bin/sh
	47
	48	cat <<EOF \| ./xmenu \| xargs sh -c
	49	Applications
	50	Web Browser firefox
	51	Image editor gimp
	52	Terminal (xterm) xterm
	53	Terminal (urxvt) urxvt
	54	Terminal (st) st
	55
	56	Shutdown poweroff
	57	Reboot reboot
	58	EOF
	59	.EE
	60	.PP
	61	For example, by selecting \(lqApplications\(rq, a new menu will appear.
	62	Selecting \(lqWeb Browser\(rq in the new menu will open firefox.
	63	.SH SEE ALSO
	64	.IR dmenu (1),
65	.IR 9menu (1),
66	.IR thingmenu (1)