X-Git-Url: http://git.subgeniuskitty.com/xmenu/.git/blobdiff_plain/08f165897c0d42fb8177344fdb1bbaf4fc944181..006c94ce9c745acfb07758c0d71a008d6dd2abe6:/xmenu.1 diff --git a/xmenu.1 b/xmenu.1 index 0e01c44..1e602df 100644 --- a/xmenu.1 +++ b/xmenu.1 @@ -1,9 +1,12 @@ -.TH PROG 1 +.TH XMENU 1 .SH NAME xmenu \- menu utility for X .SH SYNOPSIS .B xmenu -.RB [ \-w ] +.RB [ \-iw ] +.RB [ -p +.IR position ] +.RI [ title ] .SH DESCRIPTION .B xmenu is a menu for X, @@ -13,53 +16,169 @@ and outputs the item selected to stdout. .PP The options are as follows: .TP +.B -i +Disable icons. +This makes xmenu loading faster when not using icons. +.TP +.BI -p " position" +Set the position to spawn xmenu. +Without this option, xmenu spawns next to the cursor. +.I position +is a string of the form +.BR INTxINT[:MONITOR] , +where the first INT is the x position and the second INT is the y position. +The monitor part between brackets is optional. +.B MONITOR +can be a number from 0 to the number of monitors minus 1; +or it can be a string like +.B current +or +.BR cursor . +If present, the monitor specifies that the position is relative to the upper left corner +of that monitor. +If +.B monitor +is +.B current +or +.BR cursor , +the monitor to be used is that where the cursor is in. +For example, +.B -p 0x0:cursor +specifies that +.B xmenu +must spawn at the position 0x0 of the monitor where the cursor is in. +And +.B -p 100x500:0 +specifies that +.B xmenu +must spawn at the position 100x500 of the monitor 0. +.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 that do not respect window hints. .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 -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. +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 -The command is the string that will be output after selecting the item. +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 +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, +but can also be controlled by the keyboard. +Items can be selected using the arrow keys, +Tab (with and without Shift), +Enter and Esc. +.TP +.BR Down ", " Tab +Cycle through the items in the regular direction. +.TP +.BR Up ", " Shift-Tab +Cycle through the items in the reverse direction. +.TP +.BR Right ", " Enter +Select the highlighted item. +.TP +.B Left +Go to the menu above. +.TP +.B Esc +Go to the menu above or exit xmenu. +.SH RESOURCES +.B +xmenu +understands the following X resources. +.TP +.B xmenu.font +The font in which the labels should be drawn. +Multiple fonts can be added as fallback fonts; +they must be separated by a comma. +.TP +.B xmenu.background +The background color of non-selected items in the menu. +.TP +.B xmenu.foreground +The color of the label text of non-selected items in the menu. +.TP +.B xmenu.selbackground +The background color of selected items in the menu. +.TP +.B xmenu.selforeground +The color of the label text of selected items in the menu. +.TP +.B xmenu.border +The color of the border around the menu. +.TP +.B xmenu.separator +The color of the separator between items in the menu. +.TP +.B xmenu.gap +The gap, in pixels, between the menus. +.TP +.B xmenu.width +The minimum width, in pixels, of the items in the menu. +.TP +.B xmenu.height +The size in pixels of the height of a single menu item. +.TP +.B xmenu.borderWidth +The size in pixels of the border around the menu. +.TP +.B xmenu.separatorWidth +The size in pixels of the item separator. + .SH EXAMPLES -The following is an script exemplifying the use +The following script illustrates the use of .BR xmenu . -The output is redirected to xargs to make a command to be run by the shell. +The output is redirected to +.IR sh (1), +creating a command to be run by the shell. .IP .EX #!/bin/sh -cat <