1ICEWM-MENU(5)         Standards, Environments and Macros         ICEWM-MENU(5)
2
3
4
5   NAME
6        icewm-menu - icewm menu configuration file
7
8   SYNOPSIS
9        $ICEWM_PRIVCFG/menu
10        $XDG_CONFIG_HOME/icewm/menu
11        $HOME/.icewm/menu
12        /etc/icewm/menu
13        /usr/share/icewm/menu
14
15   DESCRIPTION
16       The menu file is responsible for configuring most of the icewm(1) root
17       menu and start menu.
18
19       A menu of applications; usually customized by the user.  icewm provides
20       the icewm-menu-fdo(1) program to generate a default menu.  Similar
21       programs are xdg_menu(1), mmaker(1) (MenuMaker), xde-menu(1),
22       xdgmenumaker(1).
23
24   FORMAT
25       The format of the file contains one of the following line syntax:
26
27       prog ["]title["] icon program options
28           Specifies a program to execute when the menu item is selected.
29
30       restart ["]title["] icon program options
31           Specifies a program to replace the window manager when the menu
32           item is selected.  This is for launching other window managers from
33           within icewm(1).
34
35       runonce ["]title["] icon "[res_name][.res_class]" program options
36           Specifies a program to execute when the menu item is selected;
37           however, if a window of the specified res_name and res_class is
38           present, the program will not be run again.
39
40       menu ["]title["] icon { # contained items }
41           Specifies a sub-menu.  The lines that appear between the braces can
42           be any menu item described here.
43
44       menufile ["]title["] icon ["]filename["]
45           Specifies a file from which to collect sub-menu items (lines) and
46           place them at this point in the menu.
47
48       menuprog ["]title["] icon program options
49           Specifies a program that will print sub-menu items on standard
50           output and will be collected and placed in the sub-menu at this
51           point.
52
53       menuprogreload ["]title["] icon timeout program options
54           Similar to menuprog, but after at least timeout seconds the menu is
55           regenerated.
56
57       include ["]filename["]
58           Read additional entries from the file filename
59
60       includeprog program options
61           Read additional entries from the output of program options.
62
63       separator
64           A separator for menu items.
65
66       Where
67
68       prog, restart, runonce, menu, menufile, menuprog, menuprogreload,
69       include, includeprog, separator
70           These are literal string keywords.
71
72       ["]title["]
73           This is the title string associated with the menu item which is
74           displayed in the menu.  When the title contains spaces, the title
75           must be surrounded by double quotes ("").
76
77       icon
78           Is the name of the icon file (with or without extension) or the
79           full path to an icon file.
80
81       "[res_name][.res_class]"
82           res_name is the resource name of a window launched by program and
83           res_class is the resource class of the window.  Only one of
84           res_name or res_class need be specified.  This is used to identify
85           whether the program is already running and is for use with the
86           runonce keyword.
87
88       program options
89           program is the name of the executable or full path to the
90           executable file that will be run in response to selecting the menu
91           item.  When used with the menuprog keyword, the program must print
92           on standard output the contents of the menu and is used for dynamic
93           menus.
94
95           options is the options and arguments passed to the program
96           verbatim.
97
98       filename
99           filename is the name of the file relative to one of the icewm(1)
100           configuration directories, or the full path to a file.  The file is
101           used with the menufile keyword and specifies the file from which to
102           read further menu items.
103
104   EXAMPLES
105       Following is the example menu file that ships with icewm(1):
106
107        # This is an example for IceWM's menu definition file.
108        #
109        # Place your variants in /etc/icewm or in $HOME/.icewm
110        # since modifications to this file will be discarded when you
111        # (re)install icewm.
112        #
113        prog xterm xterm xterm
114        prog rxvt xterm rxvt -bg black -cr green -fg white -C -fn 9x15 -sl 500
115        prog fte fte fte
116        prog NEdit nedit nedit
117        prog Mozilla mozilla mozilla
118        prog XChat xchat xchat
119        prog Gimp gimp gimp
120        separator
121        menuprog "Desktop Apps" folder icewm-menu-fdo
122        menufile Programs folder programs
123        menufile Tool_bar folder toolbar
124
125   FILES
126       Locations for the menu file are as follows:
127
128        $ICEWM_PRIVCFG/menu
129        $XDG_CONFIG_HOME/icewm/menu
130        $HOME/.icewm/menu
131        /etc/icewm/menu
132        /usr/share/icewm/menu
133
134       The locations are searched in the order listed; the first file found is
135       read and the remainder ignored.
136
137   SEE ALSO
138       icewm(1), icewm-menu-fdo(1).
139
140   AUTHOR
141       Brian Bidulock <mailto:bidulock@openss7.org>.
142
143   LICENSE
144       IceWM is licensed under the GNU Library General Public License.  See
145       the COPYING file in the distribution.
146
147
148
149icewm 2.9.7                       2022-05-16                     ICEWM-MENU(5)