projects
/
xmenu
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
tags
|
clone url
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Squashed commit of the following:
[xmenu]
/
xmenu.1
diff --git
a/xmenu.1
b/xmenu.1
index
d114668
..
d8fc51e
100644
(file)
--- a/
xmenu.1
+++ b/
xmenu.1
@@
-1,8
+1,10
@@
-.TH
PROG
1
+.TH
XMENU
1
.SH NAME
xmenu \- menu utility for X
.SH SYNOPSIS
.B xmenu
.SH NAME
xmenu \- menu utility for X
.SH SYNOPSIS
.B xmenu
+.RB [ \-w ]
+.RI [ title ]
.SH DESCRIPTION
.B xmenu
is a menu for X,
.SH DESCRIPTION
.B xmenu
is a menu for X,
@@
-10,20
+12,30
@@
it reads a list of newline-separated items from stdin,
shows a menu for the user to select one of the items,
and outputs the item selected to stdout.
.PP
shows a menu for the user to select one of the items,
and outputs the item selected to stdout.
.PP
+The options are as follows:
+.TP
+.B -w
+Asks the window manager to draw a border around the menus.
+This option may be buggy in some window managers, specially tiled ones.
+.PP
Each item read from stdin has the following format:
.IP
.EX
Each item read from stdin has the following format:
.IP
.EX
-ITEM := [TABS] [LABEL [TABS OUTPUT]] NEWLINE
+ITEM := [TABS] [
[IMAGE TABS]
LABEL [TABS OUTPUT]] NEWLINE
.EE
.PP
That means that each item is composed by
.EE
.PP
That means that each item is composed by
-tabs, followed by a label, followed by more tabs, followed by an output,
+tabs, followed by an optional image specification, followed by tabs
+followed by a label, followed by more tabs, followed by an output,
and ended by a newline. Brackets group optional elements.
.IP
The initial tabs indicate the menu hierarchy:
items indented with a tab is shown in a submenu of the preceding item not indented.
An item without initial tabs is a top-level item.
.IP
and ended by a newline. Brackets group optional elements.
.IP
The initial tabs indicate the menu hierarchy:
items indented with a tab is shown in a submenu of the preceding item not indented.
An item without initial tabs is a top-level item.
.IP
+The image is a string of the form "IMG:/path/to/image.png".
+It specifies a image to be shown as icon at the left of the entry.
+.IP
The label is the string that will be shown as a item in the menu.
An item without label is considered a separator and is drawn as a thin line in the menu
separating the item above from the item below.
The label is the string that will be shown as a item in the menu.
An item without label is considered a separator and is drawn as a thin line in the menu
separating the item above from the item below.
@@
-32,6
+44,10
@@
The output is the string that will be output after selecting the item.
If an item does not have an output, its label is used as its output.
.IP
The newline terminates the item specification.
If an item does not have an output, its label is used as its output.
.IP
The newline terminates the item specification.
+.PP
+If the argument
+.I title
+is given, the title of the menu window is set to it.
.SH USAGE
.B xmenu
is controlled by the mouse,
.SH USAGE
.B xmenu
is controlled by the mouse,
@@
-63,28
+79,28
@@
understands the following X resources.
The font in which the labels should be drawn.
.TP
.B xmenu.background
The font in which the labels should be drawn.
.TP
.B xmenu.background
-The background color of non-selected ite
n
s in the menu.
+The background color of non-selected ite
m
s in the menu.
.TP
.B xmenu.foreground
.TP
.B xmenu.foreground
-The color of the label text of non-selected ite
n
s in the menu.
+The color of the label text of non-selected ite
m
s in the menu.
.TP
.B xmenu.selbackground
.TP
.B xmenu.selbackground
-The background color of selected ite
n
s in the menu.
+The background color of selected ite
m
s in the menu.
.TP
.B xmenu.selforeground
.TP
.B xmenu.selforeground
-The color of the label text of selected ite
n
s in the menu.
+The color of the label text of selected ite
m
s in the menu.
.TP
.B xmenu.border
The color of the border around the menu.
.TP
.B xmenu.separator
.TP
.B xmenu.border
The color of the border around the menu.
.TP
.B xmenu.separator
-The color of the separator between ite
n
s in the menu.
+The color of the separator between ite
m
s in the menu.
.TP
.B xmenu.width
The minimum width, in pixels, of the items in the menu.
.TP
.TP
.B xmenu.width
The minimum width, in pixels, of the items in the menu.
.TP
-.B xmenu.
padding
-The size in pixels of the
padding around the label text in items in the menu
.
+.B xmenu.
height
+The size in pixels of the
height of a single menu item
.
.TP
.B xmenu.borderWidth
The size in pixels of the border around the menu.
.TP
.B xmenu.borderWidth
The size in pixels of the border around the menu.
@@
-93,7
+109,7
@@
The size in pixels of the border around the menu.
The size in pixels of the item separator.
.SH EXAMPLES
The size in pixels of the item separator.
.SH EXAMPLES
-The following
is an script exemplifying
the use of
+The following
script illustrates
the use of
.BR xmenu .
The output is redirected to
.IR sh (1),
.BR xmenu .
The output is redirected to
.IR sh (1),
@@
-104,19
+120,19
@@
creating a command to be run by the shell.
cat <<EOF | xmenu | sh &
Applications
cat <<EOF | xmenu | sh &
Applications
- Web Browser firefox
- Image editor gimp
-Terminal (xterm) xterm
-Terminal (urxvt) urxvt
-Terminal (st) st
+
IMG:./web.png
Web Browser firefox
+ I
MG:./gimp.png I
mage editor gimp
+Terminal (xterm)
xterm
+Terminal (urxvt)
urxvt
+Terminal (st)
st
-Shutdown poweroff
-Reboot reboot
+Shutdown
poweroff
+Reboot
reboot
EOF
.EE
.PP
For example, by selecting \(lqApplications\(rq, a new menu will appear.
EOF
.EE
.PP
For example, by selecting \(lqApplications\(rq, a new menu will appear.
-Selecting \(lqWeb Browser\(rq in the new menu
will open
firefox.
+Selecting \(lqWeb Browser\(rq in the new menu
opens
firefox.
.SH SEE ALSO
.IR dmenu (1),
.IR 9menu (1),
.SH SEE ALSO
.IR dmenu (1),
.IR 9menu (1),