comment
[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• ./demo.gif: A gif demonstrating how XMenu works.
22• ./xmenu.1: The manual file (man page) for XMenu.
23• ./xmenu.c: The source code of XMenu.
24• ./xmenu.sh: A sample script illustrating how to use XMenu.
25
26
27§ Installation
28
29First, edit ./config.mk to match your local setup.
30
31In order to build XMenu you need the Xlib and the Xft header files.
32The default configuration for XMenu is specified in the file config.h,
33you can edit it, but most configuration can be changed at runtime via
34X resources. Enter the following command to build XMenu. This command
35creates the binary file ./xmenu.
36
37 make
38
39By default, XMenu is installed into the /usr/local prefix. Enter the
40following command to install XMenu (if necessary as root). This command
41installs the binary file ./xmenu into the ${PREFIX}/bin/ directory, and
42the manual file ./xmenu.1 into ${MANPREFIX}/man1/ directory.
43
44 make install
45
46
47§ Running XMenu
48
49XMenu receives as input a menu specification where each line is a menu
50entry. Each line can be indented with tabs to represent nested menus.
51Each line is made out of a label and a command separated by any number
52of tabs. Lines without labels are menu separators.
53
54See the script ./xmenu.sh for an example of how to use XMenu to draw a
55simple menu with submenus and separators. The file ./demo.gif shows how
56the menu generated by that script looks like.
57
58Read the manual for more information on running XMenu.
59
60
61§ License
62
63This software is in public domain and is provided AS IS, with NO WARRANTY.