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