X-Git-Url: https://git.subgeniuskitty.com/xmenu/.git/blobdiff_plain/3bec05ea77627fd24c1425e2e445ea17127e7a5b..2b0484b11ccb71b9bed2593706938928a32a4e11:/xmenu.1

diff --git a/xmenu.1 b/xmenu.1
index 1aa2434..30ea36b 100644
--- a/xmenu.1
+++ b/xmenu.1
@@ -1,9 +1,11 @@
-.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
@@ -14,9 +16,48 @@ 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.
+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
@@ -54,7 +95,14 @@ 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.
+.TP
+.BR Home
+Select the first item in the menu.
+.TP
+.BR End
+Select the last item in the menu.
 .TP
 .BR Down ", " Tab
 Cycle through the items in the regular direction.
@@ -70,6 +118,10 @@ Go to the menu above.
 .TP
 .B Esc
 Go to the menu above or exit xmenu.
+.PP
+Additional key bindings can be set at compile time by changing the
+.B config.h
+file.
 .SH RESOURCES
 .B
 xmenu
@@ -77,30 +129,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.
@@ -109,7 +166,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),
@@ -121,7 +178,7 @@ creating a command to be run by the shell.
 cat <<EOF | xmenu | sh &
 Applications
 	IMG:./web.png	Web Browser	firefox
-	Image editor				gimp
+	IMG:./gimp.png	Image editor	gimp
 Terminal (xterm)				xterm
 Terminal (urxvt)				urxvt
 Terminal (st)					st
@@ -132,7 +189,7 @@ EOF
 .EE
 .PP
 For example, by selecting \(lqApplications\(rq, a new menu will appear.
-Selecting \(lqWeb Browser\(rq in the new menu will open firefox.
+Selecting \(lqWeb Browser\(rq in the new menu opens firefox.
 .SH SEE ALSO
 .IR dmenu (1),
 .IR 9menu (1),