Updated manpage, removed unused variables, etc.
[xmenu] / README
... / ...
CommitLineData
1 XMenu
2
3XMenu is a menu utility for X.
4XMenu receives a menu specification in stdin, shows a menu for the user
5to select one of the options, and outputs the option selected to stdout.
6XMenu can be controlled both via mouse and via keyboard. The menu is a
7pop-up menu (that is, after selecting an option, the menu disappears).
8
9NOTE:
10The -w (windowed) option was removed from the master branch. It was too
11buggy in tiled window managers and required more code to be maintained.
12
13
14§ Files
15
16The files are:
17• ./README: This file.
18• ./Makefile: The makefile.
19• ./config.h: The hardcoded default configuration for XMenu.
20• ./config.mk: The setup for the makefile.
21• ./xmenu.1: The manual file (man page) for XMenu.
22• ./xmenu.c: The source code of XMenu.
23• ./xmenu.sh: A sample script illustrating how to use XMenu.
24
25
26§ Installation
27
28First, edit ./config.mk to match your local setup.
29
30In order to build XMenu you need the Xlib and the Xft header files.
31The default configuration for XMenu is specified in the file config.h,
32you can edit it, but most configuration can be changed at runtime via
33X resources. Enter the following command to build XMenu. This command
34creates the binary file ./xmenu.
35
36 make
37
38By default, XMenu is installed into the /usr/local prefix. Enter the
39following command to install XMenu (if necessary as root). This command
40installs the binary file ./xmenu into the ${PREFIX}/bin/ directory, and
41the manual file ./xmenu.1 into ${MANPREFIX}/man1/ directory.
42
43 make install
44
45
46§ Running XMenu
47
48XMenu receives as input a menu specification where each line is a menu
49entry. Each line can be indented with tabs to represent nested menus.
50Each line is made out of a label and a command separated by any number
51of tabs. Lines without labels are menu separators.
52
53See the script ./xmenu.sh for an example of how XMenu can be used to
54draw a simple menu with submenus and separators. The following gif
55shows how the menu generated by that script looks like.
56
57 https://i.redd.it/lxv7jewcwmz41.gif
58
59Read the manual for more information on running XMenu.
60
61
62§ License
63
64This software is in public domain and is provided AS IS, with NO WARRANTY.