modify nenu.1 and remove README.md
This commit is contained in:
parent
99c3c87beb
commit
3267cd6dc3
1
Makefile
1
Makefile
|
@ -18,7 +18,6 @@ nenu: nenu.c
|
|||
.PHONY:
|
||||
clean:
|
||||
rm nenu
|
||||
rm nenu.1.gz
|
||||
|
||||
.PHONY:
|
||||
install-nenu: nenu
|
||||
|
|
18
README.md
18
README.md
|
@ -1,18 +0,0 @@
|
|||
#nenu
|
||||
|
||||
Nenu is a X11 utility similar to dmenu (but visually more like the menu's
|
||||
in cwm) that takes input from stdin and presents it to the user in a
|
||||
way they they can select what to return in a number of different ways.
|
||||
|
||||
By default nenu takes input from stdin and display it to the user in a
|
||||
vertical list. The user then types which reduces the list to those that
|
||||
match. Once the user presses return nenu exits and prints what was typed
|
||||
to stdout.
|
||||
|
||||
Check out the man page.
|
||||
|
||||
Look in nexec, ntime and nwindow for examples of use. These are useful
|
||||
scripts in their own right.
|
||||
|
||||
On exit returns 0, unless escape was pressed, then returns 1. Seems to
|
||||
be unicode safe, haven't don't much testing though.
|
65
nenu.1
65
nenu.1
|
@ -1,6 +1,4 @@
|
|||
.\" Manpage for nenu
|
||||
.\" Contact mytchel at openmailbox dot org to correct erros or typos.
|
||||
.TH man 1 "5 April 2015" "1.0" nenu man page"
|
||||
.TH man 1 "20 December 2020" "1.1" nenu man page"
|
||||
.SH NAME
|
||||
nenu - nilps menu
|
||||
.SH SYNOPSIS
|
||||
|
@ -16,9 +14,13 @@ nenu - nilps menu
|
|||
.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.
|
||||
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.
|
||||
It's very similar to dmenu but looks more like the menu's in
|
||||
cwm.
|
||||
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
|
@ -26,7 +28,8 @@ It's very similar to dmenu but looks more like the menu's in cwm.
|
|||
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.
|
||||
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).
|
||||
|
@ -38,14 +41,17 @@ No output on exit.
|
|||
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.
|
||||
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).
|
||||
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)
|
||||
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"
|
||||
|
@ -59,35 +65,22 @@ Sets font to font.
|
|||
.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.
|
||||
.TP
|
||||
.B Up, C-p, C-k
|
||||
Move valid options up one.
|
||||
.TP
|
||||
.B Down, C-n, C-j
|
||||
Move valid options down one.
|
||||
.TP
|
||||
.B Left, C-b, C-h
|
||||
Move cursor to the left.
|
||||
.TP
|
||||
.B Right, C-f, C-l
|
||||
Move curosr to the right.
|
||||
.TP
|
||||
.B Home, C-a
|
||||
Move cursor to begining.
|
||||
.TP
|
||||
.B End, C-e
|
||||
Move cursor to end.
|
||||
.TP
|
||||
.B Tab
|
||||
Copies the first option into user input.
|
||||
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 (promp/input) bar is displayed, this is to stop nenu for failing to alloc the pixmap it uses to draw on.
|
||||
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.
|
||||
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)
|
||||
|
|
Reference in New Issue