[xmenu] / README

                                 XMenu

XMenu is a menu utility for X.
XMenu receives a menu specification in stdin, shows a menu for the user
to select one of the options, and outputs the option selected to stdout.
XMenu can be controlled both via mouse and via keyboard.  The menu is a
pop-up menu (that is, after selecting an option, the menu disappears).

NOTE:
The -w (windowed) option was removed from the master branch.  It was too
buggy in tiled window managers and required more code to be maintained.


§ Files

The files are:
• ./README:     This file.
• ./Makefile:   The makefile.
• ./config.h:   The hardcoded default configuration for XMenu.
• ./config.mk:  The setup for the makefile.
• ./demo.gif:   A gif demonstrating how XMenu works.
• ./xmenu.1:    The manual file (man page) for XMenu.
• ./xmenu.c:    The source code of XMenu.
• ./xmenu.sh:   A sample script illustrating how to use XMenu.
• ./patches/    See the §Patches section


§ Patches

There are some patches that can be applied to XMenu in order to obtain
novel functionalities.   The patches are located at ./patches.  There
are the following patches:

• ./patches/icons.diff:     Add suport to image icons before menu entries.

To apply a patch, use the following command:

	patch -p1 < patches/patch.diff


§ Installation

First, edit ./config.mk to match your local setup.

In order to build XMenu you need the Xlib and the Xft header files.
The default configuration for XMenu is specified in the file config.h,
you can edit it, but most configuration can be changed at runtime via
X resources.  Enter the following command to build XMenu.  This command
creates the binary file ./xmenu.

	make

By default, XMenu is installed into the /usr/local prefix.  Enter the
following command to install XMenu (if necessary as root).  This command
installs the binary file ./xmenu into the ${PREFIX}/bin/ directory, and
the manual file ./xmenu.1 into ${MANPREFIX}/man1/ directory.

	make install


§ Running XMenu

XMenu receives as input a menu specification where each line is a menu
entry.  Each line can be indented with tabs to represent nested menus.
Each line is made out of a label and a command separated by any number
of tabs.  Lines without labels are menu separators.

See the script ./xmenu.sh for an example of how to use XMenu to draw a
simple menu with submenus and separators.  The file ./demo.gif shows how
the menu generated by that script looks like.

Read the manual for more information on running XMenu.


§ License

This software is in public domain and is provided AS IS, with NO WARRANTY.
Commit	Line	Data
571d99e1	1	XMenu
a7732690	2
571d99e1	3	XMenu is a menu utility for X.
571d99e1	4	XMenu receives a menu specification in stdin, shows a menu for the user
a7732690	5	to select one of the options, and outputs the option selected to stdout.
571d99e1	6	XMenu can be controlled both via mouse and via keyboard. The menu is a
	7	pop-up menu (that is, after selecting an option, the menu disappears).
	8
	9	NOTE:
	10	The -w (windowed) option was removed from the master branch. It was too
	11	buggy in tiled window managers and required more code to be maintained.
	12
	13
	14	§ Files
	15
	16	The 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.
ddeb6e1e	21	• ./demo.gif: A gif demonstrating how XMenu works.
571d99e1	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.
a966c866	25	• ./patches/ See the §Patches section
	26
	27
	28	§ Patches
	29
	30	There are some patches that can be applied to XMenu in order to obtain
	31	novel functionalities. The patches are located at ./patches. There
	32	are the following patches:
	33
	34	• ./patches/icons.diff: Add suport to image icons before menu entries.
	35
	36	To apply a patch, use the following command:
	37
	38	patch -p1 < patches/patch.diff
a7732690	39
27443900	40
a7732690	41	§ Installation
a7732690	42
571d99e1	43	First, edit ./config.mk to match your local setup.
	44
	45	In order to build XMenu you need the Xlib and the Xft header files.
	46	The default configuration for XMenu is specified in the file config.h,
	47	you can edit it, but most configuration can be changed at runtime via
	48	X resources. Enter the following command to build XMenu. This command
	49	creates the binary file ./xmenu.
a7732690	50
571d99e1	51	make
a7732690	52
571d99e1	53	By default, XMenu is installed into the /usr/local prefix. Enter the
	54	following command to install XMenu (if necessary as root). This command
	55	installs the binary file ./xmenu into the ${PREFIX}/bin/ directory, and
	56	the manual file ./xmenu.1 into ${MANPREFIX}/man1/ directory.
a7732690	57
571d99e1	58	make install
a7732690	59
a7732690	60
571d99e1	61	§ Running XMenu
	62
	63	XMenu receives as input a menu specification where each line is a menu
a7732690	64	entry. Each line can be indented with tabs to represent nested menus.
a7732690	65	Each line is made out of a label and a command separated by any number
7fbd1c5e	66	of tabs. Lines without labels are menu separators.
a7732690	67
4f898cc3	68	See the script ./xmenu.sh for an example of how to use XMenu to draw a
	69	simple menu with submenus and separators. The file ./demo.gif shows how
	70	the menu generated by that script looks like.
571d99e1	71
	72	Read the manual for more information on running XMenu.
	73
	74
	75	§ License
08f16589	76
571d99e1	77	This software is in public domain and is provided AS IS, with NO WARRANTY.