X-Git-Url: http://git.subgeniuskitty.com/xmenu/.git/blobdiff_plain/33376f5420409013cf1d67cfb8800067f63f12d3..d3c213125090d49408c78d2c4a9200ec1575c187:/xmenu.1 diff --git a/xmenu.1 b/xmenu.1 index 5201032..1e602df 100644 --- a/xmenu.1 +++ b/xmenu.1 @@ -1,8 +1,12 @@ -.TH PROG 1 +.TH XMENU 1 .SH NAME xmenu \- menu utility for X .SH SYNOPSIS .B xmenu +.RB [ \-iw ] +.RB [ -p +.IR position ] +.RI [ title ] .SH DESCRIPTION .B xmenu is a menu for X, @@ -10,6 +14,51 @@ 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 -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. +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 @@ -36,6 +85,10 @@ 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, @@ -65,30 +118,35 @@ 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 itens in the menu. +The background color of non-selected items in the menu. .TP .B xmenu.foreground -The color of the label text of non-selected itens in the menu. +The color of the label text of non-selected items in the menu. .TP .B xmenu.selbackground -The background color of selected itens in the menu. +The background color of selected items in the menu. .TP .B xmenu.selforeground -The color of the label text of selected itens in the menu. +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 itens in the menu. +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.padding -The size in pixels of the padding around the label text in items in the menu. +.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. @@ -97,7 +155,7 @@ The size in pixels of the border around the menu. 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), @@ -109,7 +167,7 @@ creating a command to be run by the shell. cat <