git.subgeniuskitty.com - xmenu/.git/blame_incremental

... / ...

Commit	Line	Data
	1	.TH XMENU 1
	2	.SH NAME
	3	xmenu \- menu utility for X
	4	.SH SYNOPSIS
	5	.B xmenu
	6	.RB [ \-iw ]
	7	.RB [ -p
	8	.IR position ]
	9	.RI [ title ]
	10	.SH DESCRIPTION
	11	.B xmenu
	12	is a menu for X,
	13	it reads a list of newline-separated items from stdin,
	14	shows a menu for the user to select one of the items,
	15	and outputs the item selected to stdout.
	16	.PP
	17	The options are as follows:
	18	.TP
	19	.B -i
	20	Disable icons.
	21	.B xmenu
	22	allocates a space at the left side of the menu for the icons;
	23	if there is no icon, then this space will be blank.
	24	Setting the
	25	.B -i
	26	option removes this space, making the menu narrower.
	27	.TP
	28	.BI -p " position"
	29	Set the position to spawn xmenu.
	30	Without this option, xmenu spawns next to the cursor.
	31	.I position
	32	is a string of the form
	33	.BR INTxINT ,
	34	where the first INT is the x position and the second INT is the y position.
	35	.TP
	36	.B -w
	37	Asks the window manager to draw a border around the menus.
	38	This option may be buggy in some window managers,
	39	specially tiled ones that do not respect window hints.
	40	.PP
	41	Each item read from stdin has the following format:
	42	.IP
	43	.EX
	44	ITEM := [TABS] [[IMAGE TABS] LABEL [TABS OUTPUT]] NEWLINE
	45	.EE
	46	.PP
	47	That means that each item is composed by
	48	tabs, followed by an optional image specification, followed by tabs
	49	followed by a label, followed by more tabs, followed by an output,
	50	and ended by a newline. Brackets group optional elements.
	51	.IP
	52	The initial tabs indicate the menu hierarchy:
	53	items indented with a tab is shown in a submenu of the preceding item not indented.
	54	An item without initial tabs is a top-level item.
	55	.IP
	56	The image is a string of the form "IMG:/path/to/image.png".
	57	It specifies a image to be shown as icon at the left of the entry.
	58	.IP
	59	The label is the string that will be shown as a item in the menu.
	60	An item without label is considered a separator and is drawn as a thin line in the menu
	61	separating the item above from the item below.
	62	.IP
	63	The output is the string that will be output after selecting the item.
	64	If an item does not have an output, its label is used as its output.
	65	.IP
	66	The newline terminates the item specification.
	67	.PP
	68	If the argument
	69	.I title
	70	is given, the title of the menu window is set to it.
	71	.SH USAGE
	72	.B xmenu
	73	is controlled by the mouse,
	74	but can also be controlled by the keyboard.
	75	Items can be selected using the arrow keys,
	76	Tab (with and without Shift),
	77	Enter and Esc.
	78	.TP
	79	.BR Down ", " Tab
	80	Cycle through the items in the regular direction.
	81	.TP
	82	.BR Up ", " Shift-Tab
	83	Cycle through the items in the reverse direction.
	84	.TP
	85	.BR Right ", " Enter
	86	Select the highlighted item.
	87	.TP
	88	.B Left
	89	Go to the menu above.
	90	.TP
	91	.B Esc
	92	Go to the menu above or exit xmenu.
	93	.SH RESOURCES
	94	.B
	95	xmenu
	96	understands the following X resources.
	97	.TP
	98	.B xmenu.font
	99	The font in which the labels should be drawn.
	100	Multiple fonts can be added as fallback fonts;
	101	they must be separated by a comma.
	102	.TP
	103	.B xmenu.background
	104	The background color of non-selected items in the menu.
	105	.TP
	106	.B xmenu.foreground
	107	The color of the label text of non-selected items in the menu.
	108	.TP
	109	.B xmenu.selbackground
	110	The background color of selected items in the menu.
	111	.TP
	112	.B xmenu.selforeground
	113	The color of the label text of selected items in the menu.
	114	.TP
	115	.B xmenu.border
	116	The color of the border around the menu.
	117	.TP
	118	.B xmenu.separator
	119	The color of the separator between items in the menu.
	120	.TP
	121	.B xmenu.gap
	122	The gap, in pixels, between the menus.
	123	.TP
	124	.B xmenu.width
	125	The minimum width, in pixels, of the items in the menu.
	126	.TP
	127	.B xmenu.height
	128	The size in pixels of the height of a single menu item.
	129	.TP
	130	.B xmenu.borderWidth
	131	The size in pixels of the border around the menu.
	132	.TP
	133	.B xmenu.separatorWidth
	134	The size in pixels of the item separator.
	135
	136	.SH EXAMPLES
	137	The following script illustrates the use of
	138	.BR xmenu .
	139	The output is redirected to
	140	.IR sh (1),
	141	creating a command to be run by the shell.
	142	.IP
	143	.EX
	144	#!/bin/sh
	145
	146	cat <<EOF \| xmenu \| sh &
	147	Applications
	148	IMG:./web.png Web Browser firefox
	149	IMG:./gimp.png Image editor gimp
	150	Terminal (xterm) xterm
	151	Terminal (urxvt) urxvt
	152	Terminal (st) st
	153
	154	Shutdown poweroff
	155	Reboot reboot
	156	EOF
	157	.EE
	158	.PP
	159	For example, by selecting \(lqApplications\(rq, a new menu will appear.
	160	Selecting \(lqWeb Browser\(rq in the new menu opens firefox.
	161	.SH SEE ALSO
	162	.IR dmenu (1),
	163	.IR 9menu (1),
	164	.IR thingmenu (1)