merge LICENCE and README to dmenu.1

This commit is contained in:
randomuser 2020-12-13 14:24:05 -06:00
parent 2300a6e286
commit 54541eb06f
3 changed files with 69 additions and 72 deletions

30
LICENSE
View File

@ -1,30 +0,0 @@
MIT/X Consortium License
© 2006-2019 Anselm R Garbe <anselm@garbe.ca>
© 2006-2008 Sander van Dijk <a.h.vandijk@gmail.com>
© 2006-2007 Michał Janeczek <janeczek@gmail.com>
© 2007 Kris Maglione <jg@suckless.org>
© 2009 Gottox <gottox@s01.de>
© 2009 Markus Schnalke <meillo@marmaro.de>
© 2009 Evan Gates <evan.gates@gmail.com>
© 2010-2012 Connor Lane Smith <cls@lubutu.com>
© 2014-2019 Hiltjo Posthuma <hiltjo@codemadness.org>
© 2015-2018 Quentin Rameau <quinq@fifth.space>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

24
README
View File

@ -1,24 +0,0 @@
dmenu - dynamic menu
====================
dmenu is an efficient dynamic menu for X.
Requirements
------------
In order to build dmenu you need the Xlib header files.
Installation
------------
Edit config.mk to match your local setup (dmenu is installed into
the /usr/local namespace by default).
Afterwards enter the following command to build and install dmenu
(if necessary as root):
make clean install
Running dmenu
-------------
See the man page for details.

87
dmenu.1
View File

@ -26,23 +26,28 @@ dmenu \- dynamic menu
.BR dmenu_run " ..."
.SH DESCRIPTION
.B dmenu
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 dmenu terminates. Entering text will narrow the items to those
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
dmenu terminates. Entering text will narrow the items to those
matching the tokens in the input.
.P
.B dmenu_run
is a script used by
.IR dwm (1)
which lists programs in the user's $PATH and runs the result in their $SHELL.
which lists programs in the user's $PATH and runs the result in
their $SHELL.
.SH REQUIREMENTS
In order to build dmenu you need the Xlib header files.
.SH OPTIONS
.TP
.B \-b
dmenu appears at the bottom of the screen.
.TP
.B \-f
dmenu 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.
dmenu 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
dmenu matches menu items case insensitively.
@ -51,11 +56,12 @@ dmenu matches menu items case insensitively.
dmenu lists items vertically, with the given number of lines.
.TP
.BI \-m " monitor"
dmenu is displayed on the monitor number supplied. Monitor numbers are starting
from 0.
dmenu 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.
defines the prompt to be displayed to the left of the input
field.
.TP
.BI \-fn " font"
defines the font or font set used.
@ -81,21 +87,24 @@ prints version information to stdout, then exits.
.BI \-w " windowid"
embed into windowid.
.SH USAGE
dmenu is completely controlled by the keyboard. Items are selected using the
arrow keys, page up, page down, home, and end.
dmenu 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.
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.
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.
Confirm input. Prints the input text to stdout and exits,
returning success.
.TP
.B Escape
Exit without selecting an item, returning failure.
@ -189,6 +198,48 @@ Page up
.TP
.B M\-l
Down
.SH SEE ALSO
.IR dwm (1),
.IR stest (1)
.SH LICENSE
MIT/X Consortium License
(c) 2006-2019 Anselm R Garbe <anselm@garbe.ca>
(c) 2006-2008 Sander van Dijk <a.h.vandijk@gmail.com>
(c) 2006-2007 Michał Janeczek <janeczek@gmail.com>
(c) 2007 Kris Maglione <jg@suckless.org>
(c) 2009 Gottox <gottox@s01.de>
(c) 2009 Markus Schnalke <meillo@marmaro.de>
(c) 2009 Evan Gates <evan.gates@gmail.com>
(c) 2010-2012 Connor Lane Smith <cls@lubutu.com>
(c) 2014-2019 Hiltjo Posthuma <hiltjo@codemadness.org>
(c) 2015-2018 Quentin Rameau <quinq@fifth.space>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
.SH MAINTAINER
randomuser <randomuser at tilde dot club>