Drawing menus on demand, reordering functions
[xmenu] / README
CommitLineData
571d99e1 1 XMenu
a7732690 2
571d99e1 3XMenu is a menu utility for X.
4XMenu receives a menu specification in stdin, shows a menu for the user
a7732690 5to select one of the options, and outputs the option selected to stdout.
571d99e1 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
d94ef325 9Check out my other project, xclickroot[0] for an application that can
10spawn xmenu by right clicking on the root window (i.e. on the desktop).
11
12[0]: https://github.com/phillbush/xclickroot
13
571d99e1 14
33376f54 15§ Features
16
17XMenu comes with the following features:
18• XMenu reads something in and prints something out, the UNIX way.
19• Submenus (some menu entries can spawn another menu).
20• Separators (menu entries can be separated by a line).
d584fba6 21• Icons (menu entries can be preceded by an icon image).
33376f54 22
23
571d99e1 24§ Files
25
26The files are:
27• ./README: This file.
28• ./Makefile: The makefile.
29• ./config.h: The hardcoded default configuration for XMenu.
30• ./config.mk: The setup for the makefile.
ddeb6e1e 31• ./demo.gif: A gif demonstrating how XMenu works.
571d99e1 32• ./xmenu.1: The manual file (man page) for XMenu.
33• ./xmenu.c: The source code of XMenu.
34• ./xmenu.sh: A sample script illustrating how to use XMenu.
33376f54 35• ./icons/: Icons for the sample script
a7732690 36
27443900 37
a7732690 38§ Installation
39
571d99e1 40First, edit ./config.mk to match your local setup.
41
33376f54 42In order to build XMenu you need the Imlib2, Xlib and Xft header files.
571d99e1 43The default configuration for XMenu is specified in the file config.h,
44you can edit it, but most configuration can be changed at runtime via
45X resources. Enter the following command to build XMenu. This command
46creates the binary file ./xmenu.
a7732690 47
571d99e1 48 make
a7732690 49
571d99e1 50By default, XMenu is installed into the /usr/local prefix. Enter the
51following command to install XMenu (if necessary as root). This command
52installs the binary file ./xmenu into the ${PREFIX}/bin/ directory, and
53the manual file ./xmenu.1 into ${MANPREFIX}/man1/ directory.
a7732690 54
571d99e1 55 make install
a7732690 56
a7732690 57
571d99e1 58§ Running XMenu
59
60XMenu receives as input a menu specification where each line is a menu
a7732690 61entry. Each line can be indented with tabs to represent nested menus.
62Each line is made out of a label and a command separated by any number
7fbd1c5e 63of tabs. Lines without labels are menu separators.
a7732690 64
4f898cc3 65See the script ./xmenu.sh for an example of how to use XMenu to draw a
66simple menu with submenus and separators. The file ./demo.gif shows how
67the menu generated by that script looks like.
571d99e1 68
69Read the manual for more information on running XMenu.
70
71
72§ License
08f16589 73
cdeaefaa 74MIT/X Consortium License
75
76© 2020 phillbush
77
78Permission is hereby granted, free of charge, to any person obtaining a
79copy of this software and associated documentation files (the "Software"),
80to deal in the Software without restriction, including without limitation
81the rights to use, copy, modify, merge, publish, distribute, sublicense,
82and/or sell copies of the Software, and to permit persons to whom the
83Software is furnished to do so, subject to the following conditions:
84
85The above copyright notice and this permission notice shall be included in
86all copies or substantial portions of the Software.
87
88THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
89IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
90FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
91THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
92LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
93FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
94DEALINGS IN THE SOFTWARE.