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

[xmenu] / xmenu.1

diff --git a/xmenu.1 b/xmenu.1
index 7b14eea..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


@@ -62,6 +64,53 @@ so pressing it will not trigger any menu item.
 Asks the window manager to draw a border around the menus.
 This option may be buggy in some window managers,
 specially tiled ones that do not respect window hints.
 Asks the window manager to draw a border around the menus.
 This option may be buggy in some window managers,
 specially tiled ones that do not respect window hints.

+.TP
+\fB\-x\fP [\fImod\fP-]\fIbutton\fP
+This option requires an argument of the form
+\fImod\fP-\fIbutton\fP or \fIbutton\fP; where
+.I mod
+is
+.B Mod1
+to
+.BR Mod5 ,
+or
+.B Alt
+(equivalent to
+.BR Mod1 ),
+or
+.B Super
+(equivalent to
+.BR Mod4 );
+and
+.I button
+is the number of a mouse button.
+When this option is used,
+.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
+.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
+.B xmenu
+run continuously;
+so it should be used when
+.B xmenu
+is invoked in background on a X startup file (like
+.BR "~/.xinitrc" ).
+.TP
+\fB\-X\fP [\fImod\fP-]\fIbutton\fP
+Just like
+.BR \-x ,
+but also pass the click to the root window
+(for the window manager to use it, for example).
+This option is incompatible with
+.BR \-x .

 .PP
 Each item read from stdin has the following format:
 .IP
 .PP
 Each item read from stdin has the following format:
 .IP


@@ -79,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


@@ -190,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 .


@@ -200,7 +269,7 @@ creating a command to be run by the shell.
 .EX
 #!/bin/sh
 
 .EX
 #!/bin/sh
 

-cat <<EOF | xmenu | sh &
+xmenu <<EOF | sh &

 Applications
        IMG:./web.png   Web Browser     firefox
        IMG:./gimp.png  Image editor    gimp
 Applications
        IMG:./web.png   Web Browser     firefox
        IMG:./gimp.png  Image editor    gimp