Debian Codegraph @

upstream/debian-unstable/man5/icewm-menu.5

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "ICEWM-MENU 5"
58 .TH ICEWM-MENU 5 2026-01-18 "icewm\ 4.0.0" "Standards, Environments and Macros"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SS NAME
64 .IX Subsection "NAME"
65 .Vb 1
66 \& icewm\-menu \- icewm menu configuration file
67 .Ve
68 .SS SYNOPSIS
69 .IX Subsection "SYNOPSIS"
70 .Vb 5
71 \& $ICEWM_PRIVCFG/menu
72 \& $XDG_CONFIG_HOME/icewm/menu
73 \& $HOME/.icewm/menu
74 \& /etc/X11/icewm/menu
75 \& /usr/share/icewm/menu
76 .Ve
77 .SS DESCRIPTION
78 .IX Subsection "DESCRIPTION"
79 The \fImenu\fR file is responsible for configuring most of the \fBicewm\fR\|(1)
80 root menu and the start menu.
81 .PP
82 A menu that gives access to applications; usually customized by the user.
83 The \fBicewm\-menu\-fdo\fR\|(1) program generates a default menu
84 that contains most of the systems desktop applications.
85 Similar programs are \fBxdg_menu\fR\|(1), \fBmmaker\fR\|(1),
86 \&\fBxde\-menu\fR\|(1) and \fBxdgmenumaker\fR\|(1).
87 .SS FORMAT
88 .IX Subsection "FORMAT"
89 The file contains lines with the following syntax:
90 .IP "\fBprog\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fIprogram\fR \fIoptions\fR" 4
91 .IX Item "prog ""title"" icon program options"
92 Specifies a program to execute when the menu item is selected.
93 .IP "\fBrestart\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fIprogram\fR \fIoptions\fR" 4
94 .IX Item "restart ""title"" icon program options"
95 Specifies a program to replace the window manager when the menu item is
96 selected. This is for launching other window managers from within
97 \&\fBicewm\fR\|(1).
98 .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
99 .IX Item "runonce ""title"" icon ""[name][.class]"" program options"
100 Specifies a program to execute when the menu item is selected; however,
101 if a window of the specified \fIname\fR and \fIclass\fR is present,
102 the program will not be run again.
103 .IP "\fBmenu\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fB{\fR # contained items \fB}\fR" 4
104 .IX Item "menu ""title"" icon { # contained items }"
105 Specifies a sub-menu. The lines that appear between the braces can be
106 any menu item described here.
107 .IP "\fBmenufile\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fB""\fR\fIfilename\fR\fB""\fR" 4
108 .IX Item "menufile ""title"" icon ""filename"""
109 Specifies a file from which to collect sub-menu items (lines) and place
110 them at this point in the menu.
111 .IP "\fBmenuprog\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fIprogram\fR \fIoptions\fR" 4
112 .IX Item "menuprog ""title"" icon program options"
113 Specifies a program that will print sub-menu items on standard output,
114 which will be collected and placed in the sub-menu at this point.
115 .IP "\fBmenuprogreload\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fItimeout\fR \fIprogram\fR \fIoptions\fR" 4
116 .IX Item "menuprogreload ""title"" icon timeout program options"
117 Similar to \fBmenuprog\fR, but after at least \fItimeout\fR seconds
118 the menu is regenerated.
119 .IP "\fBinclude\fR \fB""\fR\fIfilename\fR\fB""\fR" 4
120 .IX Item "include ""filename"""
121 Read additional entries from the file \fIfilename\fR
122 .IP "\fBincludeprog\fR \fIprogram\fR \fIoptions\fR" 4
123 .IX Item "includeprog program options"
124 Read additional entries from the output of \fIprogram\fR \fIoptions\fR.
125 .IP \fBseparator\fR 4
126 .IX Item "separator"
127 A separator for menu items.
128 .PP
129 Where
130 .IP "\fBprog\fR, \fBrestart\fR, \fBrunonce\fR, \fBmenu\fR, \fBmenufile\fR, \fBmenuprog\fR, \fBmenuprogreload\fR, \fBinclude\fR, \fBincludeprog\fR, \fBseparator\fR" 4
131 .IX Item "prog, restart, runonce, menu, menufile, menuprog, menuprogreload, include, includeprog, separator"
132 These are literal string keywords.
133 .IP "\fB""\fR\fItitle\fR\fB""\fR" 4
134 .IX Item """title"""
135 This is the \fItitle\fR string associated with the menu item that is
136 displayed in the menu. When the \fItitle\fR contains spaces, the title
137 must be surrounded by double quotes (\f(CW\*(C`\*(C'\fR).
138 .IP \fIicon\fR 4
139 .IX Item "icon"
140 Is the name of the icon file (with or without extension) or the full
141 path to an icon file.
142 .IP "\fB""\fR[\fIname\fR][\fB.\fR\fIclass\fR]\fB""\fR" 4
143 .IX Item """[name][.class]"""
144 \&\fIname\fR is the resource name of a window launched by \fIprogram\fR and
145 \&\fIclass\fR is the resource class of the window. Only one of
146 \&\fIname\fR or \fIclass\fR need be specified. This is used to determine
147 whether the program is already running and is used with the
148 \&\fBrunonce\fR keyword.
149 .IP "\fIprogram\fR \fIoptions\fR" 4
150 .IX Item "program options"
151 \&\fIprogram\fR is the name of the executable or full path to the executable
152 file that will be run in response to selecting the menu item.
153 When used with the \fBmenuprog\fR keyword, the \fIprogram\fR must print on
154 standard output the contents of the menu and is used for dynamic menus.
155 .Sp
156 \&\fIoptions\fR are the options and arguments passed to the \fIprogram\fR
157 verbatim.
158 .IP \fIfilename\fR 4
159 .IX Item "filename"
160 \&\fIfilename\fR is the name of the file relative to one of the \fBicewm\fR\|(1)
161 configuration directories, or the full path to a file. The file is used
162 with the \fBmenufile\fR keyword and specifies the file from which to read
163 further menu items.
164 .SS EXAMPLES
165 .IX Subsection "EXAMPLES"
166 Following is the example \fImenu\fR file that ships with \fBicewm\fR\|(1):
167 .PP
168 .Vb 10
169 \& # This is an example for IceWM\*(Aqs menu definition file.
170 \& #
171 \& # Place your variants in /etc/X11/icewm or in $HOME/.icewm
172 \& # since modifications to this file will be discarded when you
173 \& # (re)install icewm.
174 \& #
175 \& prog xterm xterm xterm
176 \& prog rxvt xterm rxvt \-bg black \-cr green \-fg white \-C \-fn 9x15 \-sl 500
177 \& prog fte fte fte
178 \& prog NEdit nedit nedit
179 \& prog Mozilla mozilla mozilla
180 \& prog XChat xchat xchat
181 \& prog Gimp gimp gimp
182 \& separator
183 \& menuprog "Desktop Apps" folder icewm\-menu\-fdo
184 \& menufile Programs folder programs
185 \& menufile Tool_bar folder toolbar
186 .Ve
187 .SS FILES
188 .IX Subsection "FILES"
189 Locations for the \fImenu\fR file are as follows:
190 .PP
191 .Vb 5
192 \& $ICEWM_PRIVCFG/menu
193 \& $XDG_CONFIG_HOME/icewm/menu
194 \& $HOME/.icewm/menu
195 \& /etc/X11/icewm/menu
196 \& /usr/share/icewm/menu
197 .Ve
198 .PP
199 The locations are searched in the order listed; the first file found is
200 read and the remainder ignored.
201 .SS "SEE ALSO"
202 .IX Subsection "SEE ALSO"
203 \&\fBicewm\fR\|(1),
204 \&\fBicewm\-menu\-fdo\fR\|(1).
205 .SS AUTHOR
206 .IX Subsection "AUTHOR"
207 Brian Bidulock <mailto:[email protected]>.
208 .SS LICENSE
209 .IX Subsection "LICENSE"
210 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
211 See the \fICOPYING\fR file in the distribution.