instantmenu.1

.TH INSTANTMENU 1 instantmenu\-VERSION
.SH NAME
instantMENU \- menu for instantOS
.SH SYNOPSIS
.B instantmenu
.RB [ \-bfirvP ]
.RB [ \-l
.IR lines ]
.RB [ \-g
.IR columns ]
.RB [ \-m
.IR monitor ]
.RB [ \-p
.IR prompt ]
.RB [ \-fn
.IR font ]
.RB [ \-nb
.IR color ]
.RB [ \-nf
.IR color ]
.RB [ \-sb
.IR color ]
.RB [ \-sf
.IR color ]
.RB [ \-w
.IR windowid ]
.P
.BR instantmenu_run " ..."
.SH DESCRIPTION
.B instantmenu
is a dynamic menu for X, which reads a list of newline\-separated items from
stdin.  When the user selects an item and presses Return, their choice is printed
to stdout and instantmenu terminates.  Entering text will narrow the items to those
matching the tokens in the input.
It is an extension of dmenu, meaning it can be used as a drop-in replacement but has a lot of extra features as well.
instantmenu is used for most of the interfaces present in instantOS. 
.P
.B instantmenu_run
is a script used by
.IR instantwm (1)
which lists programs in the user's $PATH and runs the result in their $SHELL.
.SH OPTIONS
.TP
.B \-b
instantmenu appears at the bottom of the screen.
.TP
.B \-S
confirm using space
.TP
.B \-c
instanmenu appears centered on the screen.
.TP
.B \-wm
let instantmenu be managed by the WM
.TP
.B \-f
instantmenu grabs the keyboard before reading stdin if not reading from a tty. This
is faster, but will lock up X until stdin reaches end\-of\-file.
.TP
.B \-i
instantmenu matches menu items case insensitively.
.TP
.B \-P
replace input indicator with dots
.TP
.B \-I
only display input field
.TP
.B \-A
activate alttab behaviour
.TP
.B \-F
disable fuzzy matching
.TP
.BI \-E
enable exact matching
.TP
.B \-A
Enable alt-tab behaviour
.TP
.B \-r
instantmenu rejects input that does not result in a match
.TP
.B \-it " initialtext"
instantmenu starts with an initial text in the input field
.TP
.B \-ps " index"
instantmenu starts with the item at index n preselected. it starts counting at 0
.TP
.BI \-l " lines"
instantmenu lists items vertically, with the given number of lines.
.TP
.BI \-g " columns"
instantmenu lists items in a grid with the given number of columns if the -l option is used.
.TP
.BI \-h " height"
instantmenu uses a menu line of at least 'height' pixels tall, but no less than 8.
.TP
.BI \-bw " borderwidth"
add a border around instantmenu with width n
.TP
.BI \-rc " command"
run command on shift + right
.TP
.BI \-lc " command"
run command on shift + left
.TP
.BI \-a " duration"
set animation duration in frames
.TP
.B \-n
instantmenu instantly selects if there is only one match.
.TP
.BI \-x " xoffset"
instantmenu is placed at this offset measured from the left side of the monitor.
Can be negative.
If option
.B \-C
instantmenu will appear at the position of the mouse cursor
.TP
.B \-H
Max out height to fit monitor
.TP
.B \-m
is present, the measurement will use the given monitor.
.TP
.BI \-xr " right xoffset"
instantmenu is placed at this offset measured from the right side of the monitor.
Can be negative.
If option
.B \-m
is present, the measurement will use the given monitor.
.TP
.BI \-y " yoffset"
instantmenu is placed at this offset measured from the top of the monitor.  If the
.B \-b
option is used, the offset is measured from the bottom.  Can be negative.
If option
.B \-m
is present, the measurement will use the given monitor.
.TP
.BI \-w " width"
sets the width of the instantmenu window.
.TP
.B \-W
The width will be automatically adjusted depending of the width of the longest line of text present in instdin
.TP
.BI \-m " monitor"
instantmenu is displayed on the monitor number supplied. Monitor numbers are starting
from 0.
.TP
.BI \-p " prompt"
defines the prompt to be displayed to the left of the input field
.TP
.BI \-q " pretext"
defines text to be displayed in empty input field
.TP
.BI \-G
disables grabbing the keyboard
.TP
.BI \-fn " font"
defines the font or font set used.
.TP
.BI \-nb " color"
defines the normal background color.
.IR #RGB ,
.IR #RRGGBB ,
and X color names are supported.
.TP
.BI \-nf " color"
defines the normal foreground color.
.TP
.BI \-sb " color"
defines the selected background color.
.TP
.BI \-sf " color"
defines the selected foreground color.
.TP
.B \-v
prints version information to stdout, then exits.
.TP
.BI \-w " windowid"
embed into windowid.
.SH USAGE
instantmenu is completely controlled by the keyboard.  Items are selected using the
arrow keys, page up, page down, home, and end.
.TP
.B Tab
Copy the selected item to the input field.
.TP
.B Return
Confirm selection.  Prints the selected item to stdout and exits, returning
success.
.TP
.B Ctrl-Return
Confirm selection.  Prints the selected item to stdout and continues.
.TP
.B Shift\-Return
Confirm input.  Prints the input text to stdout and exits, returning success.
.TP
.B Escape
Exit without selecting an item, returning failure.
.TP
.B Ctrl-Left
Move cursor to the start of the current word
.TP
.B Ctrl-Right
Move cursor to the end of the current word
.TP
.B C\-a
Home
.TP
.B C\-b
Left
.TP
.B C\-c
Escape
.TP
.B C\-d
Delete
.TP
.B C\-e
End
.TP
.B C\-f
Right
.TP
.B C\-g
Escape
.TP
.B C\-h
Backspace
.TP
.B C\-i
Tab
.TP
.B C\-j
Return
.TP
.B C\-J
Shift-Return
.TP
.B C\-k
Delete line right
.TP
.B C\-m
Return
.TP
.B C\-M
Shift-Return
.TP
.B C\-n
Down
.TP
.B C\-p
Up
.TP
.B C\-u
Delete line left
.TP
.B C\-w
Delete word left
.TP
.B C\-y
Paste from primary X selection
.TP
.B C\-Y
Paste from X clipboard
.TP
.B M\-b
Move cursor to the start of the current word
.TP
.B M\-f
Move cursor to the end of the current word
.TP
.B M\-g
Home
.TP
.B M\-G
End
.TP
.B M\-h
Up
.TP
.B M\-j
Page down
.TP
.B M\-k
Page up
.TP
.B M\-l
Down
.SH SEE ALSO
.IR instantwm (1),
.IR itest (1)