Debian Codegraph @

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