[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).


§ Features

XMenu comes with the following features:
• XMenu reads something in and prints something out, the UNIX way.
• Submenus (some menu entries can spawn another menu).
• Separators (menu entries can be separated by a line).
• Icons (menu entries can be preceded by an icon image).


§ 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.
• ./icons/:     Icons for the sample script


§ Installation

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

In order to build XMenu you need the Imlib2, Xlib and 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
571d99e1	9
33376f54	10	§ Features
	11
	12	XMenu comes with the following features:
	13	• XMenu reads something in and prints something out, the UNIX way.
	14	• Submenus (some menu entries can spawn another menu).
	15	• Separators (menu entries can be separated by a line).
d584fba6	16	• Icons (menu entries can be preceded by an icon image).
33376f54	17
33376f54	18
571d99e1	19	§ Files
	20
	21	The files are:
	22	• ./README: This file.
	23	• ./Makefile: The makefile.
	24	• ./config.h: The hardcoded default configuration for XMenu.
	25	• ./config.mk: The setup for the makefile.
ddeb6e1e	26	• ./demo.gif: A gif demonstrating how XMenu works.
571d99e1	27	• ./xmenu.1: The manual file (man page) for XMenu.
	28	• ./xmenu.c: The source code of XMenu.
	29	• ./xmenu.sh: A sample script illustrating how to use XMenu.
33376f54	30	• ./icons/: Icons for the sample script
a7732690	31
27443900	32
a7732690	33	§ Installation
a7732690	34
571d99e1	35	First, edit ./config.mk to match your local setup.
571d99e1	36
33376f54	37	In order to build XMenu you need the Imlib2, Xlib and Xft header files.
571d99e1	38	The default configuration for XMenu is specified in the file config.h,
	39	you can edit it, but most configuration can be changed at runtime via
	40	X resources. Enter the following command to build XMenu. This command
	41	creates the binary file ./xmenu.
a7732690	42
571d99e1	43	make
a7732690	44
571d99e1	45	By default, XMenu is installed into the /usr/local prefix. Enter the
	46	following command to install XMenu (if necessary as root). This command
	47	installs the binary file ./xmenu into the ${PREFIX}/bin/ directory, and
	48	the manual file ./xmenu.1 into ${MANPREFIX}/man1/ directory.
a7732690	49
571d99e1	50	make install
a7732690	51
a7732690	52
571d99e1	53	§ Running XMenu
	54
	55	XMenu receives as input a menu specification where each line is a menu
a7732690	56	entry. Each line can be indented with tabs to represent nested menus.
a7732690	57	Each line is made out of a label and a command separated by any number
7fbd1c5e	58	of tabs. Lines without labels are menu separators.
a7732690	59
4f898cc3	60	See the script ./xmenu.sh for an example of how to use XMenu to draw a
	61	simple menu with submenus and separators. The file ./demo.gif shows how
	62	the menu generated by that script looks like.
571d99e1	63
	64	Read the manual for more information on running XMenu.
	65
	66
	67	§ License
08f16589	68
571d99e1	69	This software is in public domain and is provided AS IS, with NO WARRANTY.