Minor change to `Makefile` to set FreeBSD paths as default.

[xmenu] / xmenu.1

diff --git a/xmenu.1 b/xmenu.1
index e6a9018..26632fe 100644 (file)
--- a/xmenu.1
+++ b/xmenu.1
@@ -6,6 +6,8 @@ xmenu \- menu utility for X
 .RB [ \-irw ]
 .RB [ -p
 .IR position ]
 .RB [ \-irw ]
 .RB [ -p
 .IR position ]

+.RB [ -x|-X
+.RI [ modifier- ] button ]

 .RI [ title ]
 .SH DESCRIPTION
 .B xmenu
 .RI [ title ]
 .SH DESCRIPTION
 .B xmenu


@@ -83,22 +85,22 @@ and
 .I button
 is the number of a mouse button.
 When this option is used,
 .I button
 is the number of a mouse button.
 When this option is used,

-.B pmenu
+.B xmenu

 listens to button presses on the root window,
 and shows the pie menu when the given button is pressed,
 together with the given modifier,
 on the root window.
 For example, invoking
 listens to button presses on the root window,
 and shows the pie menu when the given button is pressed,
 together with the given modifier,
 on the root window.
 For example, invoking

-.B pmenu
+.B xmenu

 with the option
 .B -x Super-3
 makes a menu open when clicking with the third mouse button on the root window,
 or when clicking with the third mouse button together with the Super (Mod4) modifier on any window.
 This option makes
 with the option
 .B -x Super-3
 makes a menu open when clicking with the third mouse button on the root window,
 or when clicking with the third mouse button together with the Super (Mod4) modifier on any window.
 This option makes

-.B pmenu
+.B xmenu

 run continuously;
 so it should be used when
 run continuously;
 so it should be used when

-.B pmenu
+.B xmenu

 is invoked in background on a X startup file (like
 .BR "~/.xinitrc" ).
 .TP
 is invoked in background on a X startup file (like
 .BR "~/.xinitrc" ).
 .TP


@@ -126,7 +128,11 @@ items indented with a tab is shown in a submenu of the preceding item not indent
 An item without initial tabs is a top-level item.
 .IP
 The image is a string of the form "IMG:/path/to/image.png".
 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.
+It specifies the path to a image file to be shown as icon at the left of the entry.
+If the path does not begin with "/", "./" or "../",
+the file is searched on the paths specified in the
+.B ICONPATH
+environment variable.

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


@@ -237,6 +243,22 @@ or
 .BR "\(dqright\(dq" ,
 text is aligned to the left, center, or right of the menu, respectively.
 By default, text is aligned to the left.
 .BR "\(dqright\(dq" ,
 text is aligned to the left, center, or right of the menu, respectively.
 By default, text is aligned to the left.

+.TP
+.B xmenu.maxItems
+Maximum number of items to be displayed in a menu.
+If more a menu has more than this number of items,
+they will be scrolled with arrow buttons.
+.SH ENVIRONMENT
+The following environment variables affect the execution of
+.BR xmenu .
+.TP
+.B DISPLAY
+The display to start
+.B xmenu
+on.
+.TP
+.B ICONPATH
+A colon-separated list of directories used to search for the location of image files.

 .SH EXAMPLES
 The following script illustrates the use of
 .BR xmenu .
 .SH EXAMPLES
 The following script illustrates the use of
 .BR xmenu .