Debian Codegraph @

upstream/mageia-cauldron/man5/icewm-programs.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-PROGRAMS 5"
61 .TH ICEWM-PROGRAMS 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\-programs \- icewm programs configuration file
70 .Ve
71 .SS SYNOPSIS
72 .IX Subsection "SYNOPSIS"
73 .Vb 5
74 \& $ICEWM_PRIVCFG/programs
75 \& $XDG_CONFIG_HOME/icewm/programs
76 \& $HOME/.icewm/programs
77 \& /etc/icewm/programs
78 \& /usr/share/icewm/programs
79 .Ve
80 .SS DESCRIPTION
81 .IX Subsection "DESCRIPTION"
82 The \fIprograms\fR file is an automatically generated menu configuration
83 file of installed programs. This file should be automatically generated
84 by xdg_menu, wmconfig (Redhat), menu (Debian), or icewm\-menu\-fdo,
85 perhaps as part of the login or X startup sequence.
86 .SS FORMAT
87 .IX Subsection "FORMAT"
88 The format of the file contains one of the following line 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[\fIname\fR][\fB.\fR\fIclass\fR]\fB""\fR \fIprogram\fR \fIoptions\fR" 4
98 .IX Item "runonce ""title"" icon ""[name][.class]"" program options"
99 Specifies a program to execute when the menu item is selected; however,
100 if a window of the specified \fIname\fR and \fIclass\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 and 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[\fIname\fR][\fB.\fR\fIclass\fR]\fB""\fR" 4
142 .IX Item """[name][.class]"""
143 \&\fIname\fR is the resource name of a window launched by \fIprogram\fR and
144 \&\fIclass\fR is the resource class of the window. Only one of
145 \&\fIname\fR or \fIclass\fR need be specified. This is used to determine
146 whether the program is already running. It is used 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
152 be run in response to selecting the menu item. When used with the
153 \&\fBmenuprog\fR keyword, the \fIprogram\fR must print on standard output the
154 contents of the menu and is used for dynamic menus.
155 .Sp
156 \&\fIoptions\fR is 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 \fIprograms\fR file that ships with \fBicewm\fR\|(1):
167 .PP
168 .Vb 10
169 \& # This file is intended to be customized by the distributions.
170 \& # (they should place it in /etc/X11/icewm)
171 \& #
172 \& # mostly obsolete, fixme
173 \& menu Editors folder {
174 \& prog vim vim gvim
175 \& prog emacs emacs emacs
176 \& prog Lyx emacs lyx
177 \& }
178 \& menu "WWW" folder {
179 \& prog Galeon galeon galeon
180 \& prog Arena arena arena
181 \& prog Lynx lynx xterm \-e lynx
182 \& prog Links lynx xterm \-e links
183 \& }
184 \& menu "Document Viewers" folder {
185 \& prog "DVI Previewer" xdvi xdvi
186 \& prog "Ghostview" ghostview gv
187 \& }
188 \& menu Graphics folder {
189 \& prog Gimp gimp gimp
190 \& prog XV xv xv
191 \& prog XPaint xpaint xpaint
192 \& prog XFig xfig xfig
193 \& }
194 \& menu Games folder {
195 \& prog Xboard xboard xboard
196 \& prog "Tux Racer" tuxracer tuxracer
197 \& }
198 \& menu System folder {
199 \& prog "Control Panel" redhat control\-panel
200 \& }
201 \& menu Utilities folder {
202 \& prog XPlayCD xplaycd xplaycd
203 \& prog XMixer xmixer xmixer
204 \& prog Clock xclock xclock
205 \& prog Magnify xmag xmag
206 \& prog Calculator xcalc xcalc
207 \& prog Colormap xcolormap xcmap
208 \& prog Clipboard xclipboard xclipboard
209 \& prog xkill bomb xkill
210 \& prog xload xload xload
211 \& prog xosview xosview xosview
212 \& separator
213 \& prog "Screen Saver" xlock xlock \-nolock
214 \& prog "Screen Lock" xlock xlock
215 \& }
216 \& menu "Window Managers" folder {
217 \& restart icewm \- icewm
218 \& restart metacity \- metacity
219 \& restart wmaker \- wmaker
220 \& restart fluxbox \- fluxbox
221 \& restart blackbox \- blackbox
222 \& restart enlightenment \- enlightenment
223 \& restart fvwm2 \- fvwm2
224 \& restart fvwm \- fvwm
225 \& restart sawfish \- sawfish
226 \& restart sawfish2 \- sawfish2
227 \& }
228 .Ve
229 .SS FILES
230 .IX Subsection "FILES"
231 Locations for the \fIprograms\fR file are as follows:
232 .PP
233 .Vb 5
234 \& $ICEWM_PRIVCFG/programs
235 \& $XDG_CONFIG_HOME/icewm/programs
236 \& $HOME/.icewm/programs
237 \& /etc/icewm/programs
238 \& /usr/share/icewm/programs
239 .Ve
240 .PP
241 The locations are searched in the order listed; the first file found is
242 read and the remainder ignored.
243 .SS "SEE ALSO"
244 .IX Subsection "SEE ALSO"
245 \&\fBicewm\fR\|(1),
246 \&\fBicewm\-menu\fR\|(5),
247 \&\fBicewm\-menu\-fdo\fR\|(1).
248 .SS AUTHOR
249 .IX Subsection "AUTHOR"
250 Brian Bidulock <mailto:[email protected]>.
251 .SS LICENSE
252 .IX Subsection "LICENSE"
253 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
254 See the \fICOPYING\fR file in the distribution.