This repository has been archived on 2020-12-21. You can view files and clone it, but cannot push or open issues or pull requests.
nenu/nenu.1

87 lines
2.1 KiB
Groff

.TH man 1 "20 December 2020" "1.1" nenu man page"
.SH NAME
nenu - nilps menu
.SH SYNOPSIS
.B nenu
.RB [\-oftqng]
.RB [ \-\-pos
.IR x,y ]
.RB [ \-\-abs ]
.RB [ \-\-fg
.IR color ]
.RB [ \-\-bg
.IR color ]
.RB [ \-\-fn
.IR font ]
.SH DESCRIPTION
nenu is a dynamic menu for X that takes (or doesnt) input from
stdin and displays in in a list, the user can then select one
of the options, typing reduces the number. Depending on the
flag they can input something not in the list.
It's very similar to dmenu but looks more like the menu's in
cwm.
.SH OPTIONS
.TP
.B \-o
Exits as soon as there is only one match.
.TP
.B \-f
On exit, return the first match. If there is no match return
user input.
.TP
.B \-t
No text input (can still select by scrolling/arrow/others).
.TP
.B \-q
No output on exit.
.TP
.B \-n
Takes no input from stdin.
.TP
.B \-g
Doesn't grab keyboard and pointer (Useful if you want to just
notify). The user can still select with the mouse if you enable
-f as well.
.TP
.BI \-\-pos " x,y"
Positions the window at x,y (you will probably want to --abs as
well).
.TP
.B \-\-abs
Don't shift the window so it stays inside the monitor (that x,y
or mouse is in)
.TP
.BI \-\-fg " color"
Sets foreground color to color in form of "#ff00ff"
.TP
.BI \-\-bg " color"
Sets background color to color in form of "#ff00ff"
.TP
.BI \-\-fn " font"
Sets font to font.
.TP
.B \-h
Prints help menu.
.SH USAGE
nenu is controlled mostly by the keyboard but you can also
scroll and click (button 1, 2 or 3) to select an option. Most
keys do as expected ie: backspace backspaces, delete deletes,
keys generally input what is often associated with said key.
.SH RETURNS
Returns 1 if the user types escape, else 0.
.SH NOTEs
If the height of nenu ends up being larger than the height of
the screen only the top (prompt/input) bar is displayed, this
is to stop nenu for failing to alloc the pixmap it uses to draw
on.
.SH BUGS
XftTextExtentsUtf8 and XftDrawStringUtf8 don't play nicely with
spaces and tabs. When you find them tell me, or even better,
fix it, then tell me.
.SH AUTHOR
Mytchel Hammond (mytchel at openmailbox dot org)
.SH MAINTAINER
randomuser (randomuser at tilde dot club)