X-Git-Url: https://git.subgeniuskitty.com/xmenu/.git/blobdiff_plain/7832d2cfa9c0f89592d05af8fe94d8e5230adbdf..HEAD:/xmenu.1 diff --git a/xmenu.1 b/xmenu.1 index 1e602df..26632fe 100644 --- a/xmenu.1 +++ b/xmenu.1 @@ -3,9 +3,11 @@ xmenu \- menu utility for X .SH SYNOPSIS .B xmenu -.RB [ \-iw ] +.RB [ \-irw ] .RB [ -p .IR position ] +.RB [ -x|-X +.RI [ modifier- ] button ] .RI [ title ] .SH DESCRIPTION .B xmenu @@ -54,10 +56,61 @@ specifies that .B xmenu must spawn at the position 100x500 of the monitor 0. .TP +.B -r +If this option is set, the right mouse button is disabled; +so pressing it will not trigger any menu item. +.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. +.TP +\fB\-x\fP [\fImod\fP-]\fIbutton\fP +This option requires an argument of the form +\fImod\fP-\fIbutton\fP or \fIbutton\fP; where +.I mod +is +.B Mod1 +to +.BR Mod5 , +or +.B Alt +(equivalent to +.BR Mod1 ), +or +.B Super +(equivalent to +.BR Mod4 ); +and +.I button +is the number of a mouse button. +When this option is used, +.B xmenu +listens to button presses on the root window, +and shows the pie menu when the given button is pressed, +together with the given modifier, +on the root window. +For example, invoking +.B xmenu +with the option +.B -x Super-3 +makes a menu open when clicking with the third mouse button on the root window, +or when clicking with the third mouse button together with the Super (Mod4) modifier on any window. +This option makes +.B xmenu +run continuously; +so it should be used when +.B xmenu +is invoked in background on a X startup file (like +.BR "~/.xinitrc" ). +.TP +\fB\-X\fP [\fImod\fP-]\fIbutton\fP +Just like +.BR \-x , +but also pass the click to the root window +(for the window manager to use it, for example). +This option is incompatible with +.BR \-x . .PP Each item read from stdin has the following format: .IP @@ -75,7 +128,11 @@ items indented with a tab is shown in a submenu of the preceding item not indent 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. +It specifies the path to a image file to be shown as icon at the left of the entry. +If the path does not begin with "/", "./" or "../", +the file is searched on the paths specified in the +.B ICONPATH +environment variable. .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 @@ -95,14 +152,30 @@ 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. +Home, End, +Enter and Esc, and 1-9 keys. +Items can also be selected by typing the first several characters in it. +.TP +.BR Home +Select the first item in the menu. +.TP +.BR End +Select the last item in the menu. +.TP +.BR Down +Cycle through the items in the regular direction. .TP -.BR Down ", " Tab +.BR Tab Cycle through the items in the regular direction. +When the type\-to\-select feature is active, cycle through matching items instead. .TP -.BR Up ", " Shift-Tab +.BR Up Cycle through the items in the reverse direction. .TP +.BR Shift-Tab +Cycle through the items in the reverse direction. +When the type\-to\-select feature is active, cycle through matching items instead. +.TP .BR Right ", " Enter Select the highlighted item. .TP @@ -111,6 +184,14 @@ Go to the menu above. .TP .B Esc Go to the menu above or exit xmenu. +.PP +.B xmenu +features the type\-to\-select selecting style, +where typing a string will select the first item matching it. +.PP +Additional key bindings can be set at compile time by changing the +.B config.h +file. .SH RESOURCES .B xmenu @@ -153,7 +234,31 @@ The size in pixels of the border around the menu. .TP .B xmenu.separatorWidth The size in pixels of the item separator. - +.TP +.B xmenu.alignment +If set to +.BR "\(dqleft\(dq" , +.BR "\(dqcenter\(dq" , +or +.BR "\(dqright\(dq" , +text is aligned to the left, center, or right of the menu, respectively. +By default, text is aligned to the left. +.TP +.B xmenu.maxItems +Maximum number of items to be displayed in a menu. +If more a menu has more than this number of items, +they will be scrolled with arrow buttons. +.SH ENVIRONMENT +The following environment variables affect the execution of +.BR xmenu . +.TP +.B DISPLAY +The display to start +.B xmenu +on. +.TP +.B ICONPATH +A colon-separated list of directories used to search for the location of image files. .SH EXAMPLES The following script illustrates the use of .BR xmenu . @@ -164,7 +269,7 @@ creating a command to be run by the shell. .EX #!/bin/sh -cat <