Debian Codegraph @

upstream/debian-unstable/man5/icewm-programs.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-PROGRAMS 5"
58 .TH ICEWM-PROGRAMS 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\-programs \- icewm programs configuration file
67 .Ve
68 .SS SYNOPSIS
69 .IX Subsection "SYNOPSIS"
70 .Vb 5
71 \& $ICEWM_PRIVCFG/programs
72 \& $XDG_CONFIG_HOME/icewm/programs
73 \& $HOME/.icewm/programs
74 \& /etc/X11/icewm/programs
75 \& /usr/share/icewm/programs
76 .Ve
77 .SS DESCRIPTION
78 .IX Subsection "DESCRIPTION"
79 The \fIprograms\fR file is an automatically generated menu configuration
80 file of installed programs. This file should be automatically generated
81 by xdg_menu, wmconfig (Redhat), menu (Debian), or icewm-menu-fdo,
82 perhaps as part of the login or X startup sequence.
83 .SS FORMAT
84 .IX Subsection "FORMAT"
85 The format of the file contains one of the following line syntax:
86 .IP "\fBprog\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fIprogram\fR \fIoptions\fR" 4
87 .IX Item "prog ""title"" icon program options"
88 Specifies a program to execute when the menu item is selected.
89 .IP "\fBrestart\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fIprogram\fR \fIoptions\fR" 4
90 .IX Item "restart ""title"" icon program options"
91 Specifies a program to replace the window manager when the menu item is
92 selected. This is for launching other window managers from within
93 \&\fBicewm\fR\|(1).
94 .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
95 .IX Item "runonce ""title"" icon ""[name][.class]"" program options"
96 Specifies a program to execute when the menu item is selected; however,
97 if a window of the specified \fIname\fR and \fIclass\fR is present,
98 the program will not be run again.
99 .IP "\fBmenu\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fB{\fR # contained items \fB}\fR" 4
100 .IX Item "menu ""title"" icon { # contained items }"
101 Specifies a sub-menu. The lines that appear between the braces can be
102 any menu item described here.
103 .IP "\fBmenufile\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fB""\fR\fIfilename\fR\fB""\fR" 4
104 .IX Item "menufile ""title"" icon ""filename"""
105 Specifies a file from which to collect sub-menu items (lines) and place
106 them at this point in the menu.
107 .IP "\fBmenuprog\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fIprogram\fR \fIoptions\fR" 4
108 .IX Item "menuprog ""title"" icon program options"
109 Specifies a program that will print sub-menu items on standard output
110 and will be collected and placed in the sub-menu at this point.
111 .IP "\fBmenuprogreload\fR \fB""\fR\fItitle\fR\fB""\fR \fIicon\fR \fItimeout\fR \fIprogram\fR \fIoptions\fR" 4
112 .IX Item "menuprogreload ""title"" icon timeout program options"
113 Similar to \fBmenuprog\fR, but after at least \fItimeout\fR seconds
114 the menu is regenerated.
115 .IP "\fBinclude\fR \fB""\fR\fIfilename\fR\fB""\fR" 4
116 .IX Item "include ""filename"""
117 Read additional entries from the file \fIfilename\fR
118 .IP "\fBincludeprog\fR \fIprogram\fR \fIoptions\fR" 4
119 .IX Item "includeprog program options"
120 Read additional entries from the output of \fIprogram\fR \fIoptions\fR.
121 .IP \fBseparator\fR 4
122 .IX Item "separator"
123 A separator for menu items.
124 .PP
125 Where
126 .IP "\fBprog\fR, \fBrestart\fR, \fBrunonce\fR, \fBmenu\fR, \fBmenufile\fR, \fBmenuprog\fR, \fBmenuprogreload\fR, \fBinclude\fR, \fBincludeprog\fR, \fBseparator\fR" 4
127 .IX Item "prog, restart, runonce, menu, menufile, menuprog, menuprogreload, include, includeprog, separator"
128 These are literal string keywords.
129 .IP "\fB""\fR\fItitle\fR\fB""\fR" 4
130 .IX Item """title"""
131 This is the \fItitle\fR string associated with the menu item that is
132 displayed in the menu. When the \fItitle\fR contains spaces, the title
133 must be surrounded by double quotes (\f(CW\*(C`"\*(C'\fR).
134 .IP \fIicon\fR 4
135 .IX Item "icon"
136 Is the name of the icon file (with or without extension) or the full
137 path to an icon file.
138 .IP "\fB""\fR[\fIname\fR][\fB.\fR\fIclass\fR]\fB""\fR" 4
139 .IX Item """[name][.class]"""
140 \&\fIname\fR is the resource name of a window launched by \fIprogram\fR and
141 \&\fIclass\fR is the resource class of the window. Only one of
142 \&\fIname\fR or \fIclass\fR need be specified. This is used to determine
143 whether the program is already running. It is used with the
144 \&\fBrunonce\fR keyword.
145 .IP "\fIprogram\fR \fIoptions\fR" 4
146 .IX Item "program options"
147 \&\fIprogram\fR is the name of the executable or full path to the executable
148 file that will
149 be run in response to selecting the menu item. When used with the
150 \&\fBmenuprog\fR keyword, the \fIprogram\fR must print on standard output the
151 contents of the menu and is used for dynamic menus.
152 .Sp
153 \&\fIoptions\fR is the options and arguments passed to the \fIprogram\fR
154 verbatim.
155 .IP \fIfilename\fR 4
156 .IX Item "filename"
157 \&\fIfilename\fR is the name of the file relative to one of the \fBicewm\fR\|(1)
158 configuration directories, or the full path to a file. The file is used
159 with the \fBmenufile\fR keyword and specifies the file from which to read
160 further menu items.
161 .SS EXAMPLES
162 .IX Subsection "EXAMPLES"
163 Following is the example \fIprograms\fR file that ships with \fBicewm\fR\|(1):
164 .PP
165 .Vb 10
166 \& # This file is intended to be customized by the distributions.
167 \& # (they should place it in /etc/X11/icewm)
168 \& #
169 \& # mostly obsolete, fixme
170 \& menu Editors folder {
171 \& prog vim vim gvim
172 \& prog emacs emacs emacs
173 \& prog Lyx emacs lyx
174 \& }
175 \& menu "WWW" folder {
176 \& prog Galeon galeon galeon
177 \& prog Arena arena arena
178 \& prog Lynx lynx xterm \-e lynx
179 \& prog Links lynx xterm \-e links
180 \& }
181 \& menu "Document Viewers" folder {
182 \& prog "DVI Previewer" xdvi xdvi
183 \& prog "Ghostview" ghostview gv
184 \& }
185 \& menu Graphics folder {
186 \& prog Gimp gimp gimp
187 \& prog XV xv xv
188 \& prog XPaint xpaint xpaint
189 \& prog XFig xfig xfig
190 \& }
191 \& menu Games folder {
192 \& prog Xboard xboard xboard
193 \& prog "Tux Racer" tuxracer tuxracer
194 \& }
195 \& menu System folder {
196 \& prog "Control Panel" redhat control\-panel
197 \& }
198 \& menu Utilities folder {
199 \& prog XPlayCD xplaycd xplaycd
200 \& prog XMixer xmixer xmixer
201 \& prog Clock xclock xclock
202 \& prog Magnify xmag xmag
203 \& prog Calculator xcalc xcalc
204 \& prog Colormap xcolormap xcmap
205 \& prog Clipboard xclipboard xclipboard
206 \& prog xkill bomb xkill
207 \& prog xload xload xload
208 \& prog xosview xosview xosview
209 \& separator
210 \& prog "Screen Saver" xlock xlock \-nolock
211 \& prog "Screen Lock" xlock xlock
212 \& }
213 \& menu "Window Managers" folder {
214 \& restart icewm \- icewm
215 \& restart metacity \- metacity
216 \& restart wmaker \- wmaker
217 \& restart fluxbox \- fluxbox
218 \& restart blackbox \- blackbox
219 \& restart enlightenment \- enlightenment
220 \& restart fvwm2 \- fvwm2
221 \& restart fvwm \- fvwm
222 \& restart sawfish \- sawfish
223 \& restart sawfish2 \- sawfish2
224 \& }
225 .Ve
226 .SS FILES
227 .IX Subsection "FILES"
228 Locations for the \fIprograms\fR file are as follows:
229 .PP
230 .Vb 5
231 \& $ICEWM_PRIVCFG/programs
232 \& $XDG_CONFIG_HOME/icewm/programs
233 \& $HOME/.icewm/programs
234 \& /etc/X11/icewm/programs
235 \& /usr/share/icewm/programs
236 .Ve
237 .PP
238 The locations are searched in the order listed; the first file found is
239 read and the remainder ignored.
240 .SS "SEE ALSO"
241 .IX Subsection "SEE ALSO"
242 \&\fBicewm\fR\|(1),
243 \&\fBicewm\-menu\fR\|(5),
244 \&\fBicewm\-menu\-fdo\fR\|(1).
245 .SS AUTHOR
246 .IX Subsection "AUTHOR"
247 Brian Bidulock <mailto:[email protected]>.
248 .SS LICENSE
249 .IX Subsection "LICENSE"
250 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
251 See the \fICOPYING\fR file in the distribution.