Debian Codegraph @

upstream/mageia-cauldron/man5/icewm-menu.5

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "ICEWM-MENU 5"
61 .TH ICEWM-MENU 5 2026-01-01 "icewm 4.0.0" "Standards, Environments and Macros"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SS NAME
67 .IX Subsection "NAME"
68 .Vb 1
69 \& icewm\-menu \- icewm menu configuration file
70 .Ve
71 .SS SYNOPSIS
72 .IX Subsection "SYNOPSIS"
73 .Vb 5
74 \& $ICEWM_PRIVCFG/menu
75 \& $XDG_CONFIG_HOME/icewm/menu
76 \& $HOME/.icewm/menu
77 \& /etc/icewm/menu
78 \& /usr/share/icewm/menu
79 .Ve
80 .SS DESCRIPTION
81 .IX Subsection "DESCRIPTION"
82 The \fImenu\fR file is responsible for configuring most of the \fBicewm\fR\|(1)
83 root menu and the start menu.
84 .PP
85 A menu that gives access to applications; usually customized by the user.
86 The \fBicewm\-menu\-fdo\fR\|(1) program generates a default menu
87 that contains most of the systems desktop applications.
88 Similar programs are \fBxdg_menu\fR\|(1), \fBmmaker\fR\|(1),
89 \&\fBxde\-menu\fR\|(1) and \fBxdgmenumaker\fR\|(1).
90 .SS FORMAT
91 .IX Subsection "FORMAT"
92 The file contains lines with the following syntax:
93 .IP "\fBprog\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fIprogram\fR \fIoptions\fR" 4
94 .IX Item "prog ""title"" icon program options"
95 Specifies a program to execute when the menu item is selected.
96 .IP "\fBrestart\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fIprogram\fR \fIoptions\fR" 4
97 .IX Item "restart ""title"" icon program options"
98 Specifies a program to replace the window manager when the menu item is
99 selected. This is for launching other window managers from within
100 \&\fBicewm\fR\|(1).
101 .IP "\fBrunonce\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fB""\fR[\fIname\fR][\fB.\fR\fIclass\fR]\fB""\fR \fIprogram\fR \fIoptions\fR" 4
102 .IX Item "runonce ""title"" icon ""[name][.class]"" program options"
103 Specifies a program to execute when the menu item is selected; however,
104 if a window of the specified \fIname\fR and \fIclass\fR is present,
105 the program will not be run again.
106 .IP "\fBmenu\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fB{\fR # contained items \fB}\fR" 4
107 .IX Item "menu ""title"" icon { # contained items }"
108 Specifies a sub\-menu. The lines that appear between the braces can be
109 any menu item described here.
110 .IP "\fBmenufile\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fB""\fR\fIfilename\fR\fB""\fR" 4
111 .IX Item "menufile ""title"" icon ""filename"""
112 Specifies a file from which to collect sub\-menu items (lines) and place
113 them at this point in the menu.
114 .IP "\fBmenuprog\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fIprogram\fR \fIoptions\fR" 4
115 .IX Item "menuprog ""title"" icon program options"
116 Specifies a program that will print sub\-menu items on standard output,
117 which will be collected and placed in the sub\-menu at this point.
118 .IP "\fBmenuprogreload\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fItimeout\fR \fIprogram\fR \fIoptions\fR" 4
119 .IX Item "menuprogreload ""title"" icon timeout program options"
120 Similar to \fBmenuprog\fR, but after at least \fItimeout\fR seconds
121 the menu is regenerated.
122 .IP "\fBinclude\fR \fB""\fR\fIfilename\fR\fB""\fR" 4
123 .IX Item "include ""filename"""
124 Read additional entries from the file \fIfilename\fR
125 .IP "\fBincludeprog\fR \fIprogram\fR \fIoptions\fR" 4
126 .IX Item "includeprog program options"
127 Read additional entries from the output of \fIprogram\fR \fIoptions\fR.
128 .IP \fBseparator\fR 4
129 .IX Item "separator"
130 A separator for menu items.
131 .PP
132 Where
133 .IP "\fBprog\fR, \fBrestart\fR, \fBrunonce\fR, \fBmenu\fR, \fBmenufile\fR, \fBmenuprog\fR, \fBmenuprogreload\fR, \fBinclude\fR, \fBincludeprog\fR, \fBseparator\fR" 4
134 .IX Item "prog, restart, runonce, menu, menufile, menuprog, menuprogreload, include, includeprog, separator"
135 These are literal string keywords.
136 .IP "\fB""\fR\fItitle\fR\fB""\fR" 4
137 .IX Item """title"""
138 This is the \fItitle\fR string associated with the menu item that is
139 displayed in the menu. When the \fItitle\fR contains spaces, the title
140 must be surrounded by double quotes (\f(CW\*(C`\*(C'\fR).
141 .IP \fIicon\fR 4
142 .IX Item "icon"
143 Is the name of the icon file (with or without extension) or the full
144 path to an icon file.
145 .IP "\fB""\fR[\fIname\fR][\fB.\fR\fIclass\fR]\fB""\fR" 4
146 .IX Item """[name][.class]"""
147 \&\fIname\fR is the resource name of a window launched by \fIprogram\fR and
148 \&\fIclass\fR is the resource class of the window. Only one of
149 \&\fIname\fR or \fIclass\fR need be specified. This is used to determine
150 whether the program is already running and is used with the
151 \&\fBrunonce\fR keyword.
152 .IP "\fIprogram\fR \fIoptions\fR" 4
153 .IX Item "program options"
154 \&\fIprogram\fR is the name of the executable or full path to the executable
155 file that will be run in response to selecting the menu item.
156 When used with the \fBmenuprog\fR keyword, the \fIprogram\fR must print on
157 standard output the contents of the menu and is used for dynamic menus.
158 .Sp
159 \&\fIoptions\fR are the options and arguments passed to the \fIprogram\fR
160 verbatim.
161 .IP \fIfilename\fR 4
162 .IX Item "filename"
163 \&\fIfilename\fR is the name of the file relative to one of the \fBicewm\fR\|(1)
164 configuration directories, or the full path to a file. The file is used
165 with the \fBmenufile\fR keyword and specifies the file from which to read
166 further menu items.
167 .SS EXAMPLES
168 .IX Subsection "EXAMPLES"
169 Following is the example \fImenu\fR file that ships with \fBicewm\fR\|(1):
170 .PP
171 .Vb 10
172 \& # This is an example for IceWM\*(Aqs menu definition file.
173 \& #
174 \& # Place your variants in /etc/icewm or in $HOME/.icewm
175 \& # since modifications to this file will be discarded when you
176 \& # (re)install icewm.
177 \& #
178 \& prog xterm xterm xterm
179 \& prog rxvt xterm rxvt \-bg black \-cr green \-fg white \-C \-fn 9x15 \-sl 500
180 \& prog fte fte fte
181 \& prog NEdit nedit nedit
182 \& prog Mozilla mozilla mozilla
183 \& prog XChat xchat xchat
184 \& prog Gimp gimp gimp
185 \& separator
186 \& menuprog "Desktop Apps" folder icewm\-menu\-fdo
187 \& menufile Programs folder programs
188 \& menufile Tool_bar folder toolbar
189 .Ve
190 .SS FILES
191 .IX Subsection "FILES"
192 Locations for the \fImenu\fR file are as follows:
193 .PP
194 .Vb 5
195 \& $ICEWM_PRIVCFG/menu
196 \& $XDG_CONFIG_HOME/icewm/menu
197 \& $HOME/.icewm/menu
198 \& /etc/icewm/menu
199 \& /usr/share/icewm/menu
200 .Ve
201 .PP
202 The locations are searched in the order listed; the first file found is
203 read and the remainder ignored.
204 .SS "SEE ALSO"
205 .IX Subsection "SEE ALSO"
206 \&\fBicewm\fR\|(1),
207 \&\fBicewm\-menu\-fdo\fR\|(1).
208 .SS AUTHOR
209 .IX Subsection "AUTHOR"
210 Brian Bidulock <mailto:[email protected]>.
211 .SS LICENSE
212 .IX Subsection "LICENSE"
213 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
214 See the \fICOPYING\fR file in the distribution.