X-Git-Url: https://git.subgeniuskitty.com/xmenu/.git/blobdiff_plain/f644b8bc229efaa87ac1d441918496e7e24cf29c..beae67a6a77acf992b044359f0e396965a3dced7:/xmenu.1 diff --git a/xmenu.1 b/xmenu.1 index de61a9e..d114668 100644 --- a/xmenu.1 +++ b/xmenu.1 @@ -3,7 +3,6 @@ xmenu \- menu utility for X .SH SYNOPSIS .B xmenu -.RB [ \-w ] .SH DESCRIPTION .B xmenu is a menu for X, @@ -11,32 +10,50 @@ 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 -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. -.PP Each item read from stdin has the following format: .IP .EX -ITEM := TABS LABEL TABS COMMAND NEWLINE +ITEM := [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 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 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. +.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 @@ -66,24 +83,26 @@ The color of the separator between itens in the menu. .B xmenu.width The minimum width, in pixels, of the items in the menu. .TP -.B xmenu.itemborder -The size in pixels of the border around the label text in items in the menu. +.B xmenu.padding +The size in pixels of the padding around the label text in items in the menu. .TP -.B xmenu.menuborder +.B xmenu.borderWidth The size in pixels of the border around the menu. .TP -.B xmenu.separatorsize +.B xmenu.separatorWidth The size in pixels of the item separator. .SH EXAMPLES -The following is an script exemplifying the use +The following is an script exemplifying 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 <