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