add support for mouse scrolling (#26)

[xmenu] / xmenu.1

diff --git a/xmenu.1 b/xmenu.1
index 1e602df..7b14eea 100644 (file)
--- a/xmenu.1
+++ b/xmenu.1
@@ -3,7 +3,7 @@
 xmenu \- menu utility for X
 .SH SYNOPSIS
 .B xmenu
 xmenu \- menu utility for X
 .SH SYNOPSIS
 .B xmenu

-.RB [ \-iw ]
+.RB [ \-irw ]

 .RB [ -p
 .IR position ]
 .RI [ title ]
 .RB [ -p
 .IR position ]
 .RI [ title ]


@@ -54,6 +54,10 @@ specifies that
 .B xmenu
 must spawn at the position 100x500 of the monitor 0.
 .TP
 .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,
 .B -w
 Asks the window manager to draw a border around the menus.
 This option may be buggy in some window managers,


@@ -95,13 +99,29 @@ 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),
 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
 .TP

-.BR Down ", " Tab
+.BR End
+Select the last item in the menu.
+.TP
+.BR Down

 Cycle through the items in the regular direction.
 .TP
 Cycle through the items in the regular direction.
 .TP

-.BR Up ", " Shift-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
+Cycle through the items in the reverse direction.
+.TP
+.BR Shift-Tab

 Cycle through the items in the reverse direction.
 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
 .BR Right ", " Enter
 Select the highlighted item.


@@ -111,6 +131,14 @@ Go to the menu above.
 .TP
 .B Esc
 Go to the menu above or exit xmenu.
 .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
 .SH RESOURCES
 .B
 xmenu


@@ -153,7 +181,15 @@ 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.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.

 .SH EXAMPLES
 The following script illustrates the use of
 .BR xmenu .
 .SH EXAMPLES
 The following script illustrates the use of
 .BR xmenu .