| blob | 1adf3b99eb301b3f08295c364700aa359e897d1d |
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.02)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 . ds -- \(*W-
36 . ds PI pi
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39 . ds L" ""
40 . ds R" ""
41 . ds C` ""
42 . ds C' ""
43 'br\}
44 .el\{\
45 . ds -- \|\(em\|
46 . ds PI \(*p
47 . ds L" ``
48 . ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 . de IX
61 . tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 . nr % 0
64 . rr F
65 .\}
66 .el \{\
67 . de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
74 .if n \{\
75 . ds #H 0
76 . ds #V .8m
77 . ds #F .3m
78 . ds #[ \f1
79 . ds #] \fP
80 .\}
81 .if t \{\
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 . ds #V .6m
84 . ds #F 0
85 . ds #[ \&
86 . ds #] \&
87 .\}
88 . \" simple accents for nroff and troff
89 .if n \{\
90 . ds ' \&
91 . ds ` \&
92 . ds ^ \&
93 . ds , \&
94 . ds ~ ~
95 . ds /
96 .\}
97 .if t \{\
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 . ds : e
122 . ds 8 ss
123 . ds o a
124 . ds d- d\h'-1'\(ga
125 . ds D- D\h'-1'\(hy
126 . ds th \o'bp'
127 . ds Th \o'LP'
128 . ds ae ae
129 . ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "FvwmPerl 1"
135 .TH FvwmPerl 1 "2009-03-22" "2.5.28 (from cvs)" "Fvwm Modules"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 FvwmPerl \- the fvwm perl manipulator and preprocessor
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 FvwmPerl should be spawned by \fIfvwm\fR\|(1) for normal functionality.
145 .PP
146 To run this module, place this command somewhere in the configuration:
147 .PP
148 .Vb 1
149 \& Module FvwmPerl [params]
150 .Ve
151 .PP
152 or:
153 .PP
154 .Vb 1
155 \& ModuleSynchronize FvwmPerl [params]
156 .Ve
157 .PP
158 if you want to immediately start to send commands to FvwmPerl.
159 .SH "DESCRIPTION"
160 .IX Header "DESCRIPTION"
161 This module is intended to extend fvwm commands with the perl scripting power.\ It enables to embed perl expressions in the fvwm config files and construct fvwm commands.
162 .SH "INVOCATION"
163 .IX Header "INVOCATION"
164 If you want to invoke the unique and persistent instanse of FvwmPerl, it is suggested to do this from the \fIStartFunction\fR.\ Calling it from the top is also possible, but involves some issues not discussed here.
165 .PP
166 .Vb 1
167 \& AddToFunc StartFunction I Module FvwmPerl
168 .Ve
169 .PP
170 There are several command line switches:
171 .PP
172 \&\fBFvwmPerl\fR [ \fB\-\-eval\fR line ] [ \fB\-\-load\fR file ] [ \fB\-\-preprocess\fR [ \fB\-\-quote\fR char ] [ \fB\-\-winid\fR wid ] [ \fB\-\-cmd\fR ] [ \fB\-\-nosend\fR ] [ \fB\-\-noremove\fR ] [ line | file ] ] [ \fB\-\-export\fR [names] ] [ \fB\-\-stay\fR ] [ \fB\-\-nolock\fR ] [ alias ]
173 .PP
174 Long switches may be abbreviated to short one-letter switches.
175 .PP
176 \&\fB\-e\fR|\fB\-\-eval\fR line \- evaluate the given perl code
177 .PP
178 \&\fB\-l\fR|\fB\-\-load\fR file \- evaluate perl code in the given file
179 .PP
180 \&\fB\-p\fR|\fB\-\-preprocess\fR [ file ] \- preprocess the given fvwm config file
181 .PP
182 The following 5 options are only valid together with \fB\-\-preprocess\fR option.
183 .PP
184 \&\fB\-c\fR|\fB\-\-cmd\fR line \- an fvwm command to be preprocessed instead of file
185 .PP
186 \&\fB\-q\fR|\fB\-\-quote\fR char \- change the default '%' quote
187 .PP
188 \&\fB\-w\fR|\fB\-\-winid\fR wid \- set explicit window context (should begin with digit, may be in oct or hex form; this window id overwrites implicit window context if any)
189 .PP
190 \&\fB\-\-nosend\fR \- do not send the preprocessed file to \fIfvwm\fR for \fBRead\fRing, the default is send. Useful for preprocessing non fvwm config files.
191 .PP
192 \&\fB\-\-noremove\fR \- do not remove the preprocessed file after sending it to \fIfvwm\fR for \fBRead\fRing, the default is remove. Useful for debugging.
193 .PP
194 \&\fB\-x\fR|\fB\-\-export\fR [names] \- define fvwm shortcut functions (by default, two functions named \*(L"Eval\*(R" and \*(L".\*(R").\ This option implies \fB\-\-stay\fR.
195 .PP
196 \&\fB\-s\fR|\fB\-\-stay\fR \- continues an execution after \fB\-\-eval\fR, \fB\-\-load\fR or \fB\-\-preprocess\fR are processed.\ By default, the module is not persistent in this case, i.e. \fB\-\-nostay\fR is assumed.
197 .PP
198 \&\fB\-\-nolock\fR \- when one of the 3 action options is given, this option causes unlocking \fIfvwm\fR immediately. By default the requested action is executed synchronously; this only makes difference when invoked like:
199 .PP
200 .Vb 1
201 \& ModuleSynchronous FvwmPerl \-\-preprocess someconfig.ppp
202 .Ve
203 .PP
204 If \fB\-\-nolock\fR is added here, \fBModuleSynchronous\fR returns immediately. Note that \fBModule\fR returns immediately regardless of this option.
205 .SH "USING ALIAS"
206 .IX Header "USING ALIAS"
207 Aliases allow to have several module invocations and work separately with all invocations, here is an example:
208 .PP
209 .Vb 4
210 \& ModuleSynchronous FvwmPerl FvwmPerl\-JustTest
211 \& SendToModule FvwmPerl\-JustTest eval $a = 2 + 2; $b = $a
212 \& SendToModule FvwmPerl\-JustTest eval cmd("Echo 2 + 2 = $b")
213 \& KillModule FvwmPerl FvwmPerl\-JustTest
214 .Ve
215 .SH "PREPROCESSING EXAMPLE"
216 .IX Header "PREPROCESSING EXAMPLE"
217 One of the effective proprocessing solutions is to pass the whole fvwm configuration with embeded perl code to \*(L"FvwmPerl \-\-preprocess\*(R". An alternative approach is to write a perl script that produces fvwm commands and sends them for execution, this script may be loaded using \*(L"FvwmPerl \-\-load\*(R". There are hovewer intermediate solutions that preprocess only separate configuration lines (or alternatively, execute separate perl commands that produce fvwm commands).
218 .PP
219 The following code snippet adds ability of arithmetics and string scripting to certain lines that need this. To use this, you want to start FvwmPerl as your first command so that other commands may be asked to be preprosessed.
220 .PP
221 .Vb 1
222 \& ModuleSynchronize FvwmPerl
223 \&
224 \& AddToFunc .
225 \& + I SendToModule FvwmPerl preprocess \-c \-\- $*
226 \&
227 \& . Exec exec xterm \-name xterm\-%{++$i}% # use unique name
228 \&
229 \& . GotoDesk 0 %{ $[desk.n] + 1 }% # go to next desk
230 \&
231 \& . Exec exec %{ \-x "/usr/bin/X11/aterm" ? "aterm" : "xterm" }% \-sb
232 \&
233 \& # center a window
234 \& Next (MyWindow) . Move \e
235 \& %{($WIDTH \- $[w.width]) / 2}%p %{($HEIGHT \- $[w.height]) / 2}%p
236 \&
237 \& . Exec exec xmessage %{2 + 2}% # simple calculator
238 \&
239 \& . %{main::show_message(2 + 2, "Yet another Calculator"); ""}%
240 .Ve
241 .SH "ACTIONS"
242 .IX Header "ACTIONS"
243 There are several actions that FvwmPerl may perform:
244 .IP "\fBeval\fR perl-code" 4
245 .IX Item "eval perl-code"
246 Evaluate a line of perl code.
247 .Sp
248 A special function \fBcmd(\fR\*(L"command\*(R"\fB)\fR may be used in perl code to send commands back to fvwm.
249 .Sp
250 If perl code contains an error, it is printed to the standard error stream with the \fI[FvwmPerl][eval]:\fR header prepended.
251 .IP "\fBload\fR file-name" 4
252 .IX Item "load file-name"
253 Load a file of perl code. If the file is not fully qualified, it is searched in the user directory \f(CW$FVWM_USERDIR\fR (usually ~/.fvwm) and the system wide data directory \f(CW$FVWM_DATADIR\fR.
254 .Sp
255 A special function \fBcmd(\fR\*(L"command\*(R"\fB)\fR may be used in perl code to send commands back to fvwm.
256 .Sp
257 If perl code contains an error, it is printed to the standard error stream with the \fI[FvwmPerl][load]:\fR header prepended.
258 .IP "\fBpreprocess\fR [\-q|\-\-quote char] [\-c|\-\-cmd] [\fIline\fR | \fIfile\fR]" 4
259 .IX Item "preprocess [-q|--quote char] [-c|--cmd] [line | file]"
260 Preprocess fvwm config \fIfile\fR or (if \-\-cmd is given) \fIline\fR. This file contains lines that are not touched (usually fvwm commands) and specially preformatted perl code that is processed and replaced. Text enclosed in \fB%{\fR ... \fB}%\fR delimiters, that may start anywhere on the line and end anywhere on the same or an other line, is perl code.
261 .Sp
262 The \fIquote\fR parameter changes perl code delimiters.\ If a single char is given, like '@', the delimiters are \fB@{\fR ... \fB}@\fR. If the given quote is 2 chars, like \fB<>\fR, the quotes are \fB<{\fR ... \fB}>\fR
263 .Sp
264 The perl code is substituted for the result of its evaluation. I.e. %{$a = \*(L"c\*(R"; ++$a}% is replaced with \*(L"d\*(R".
265 .Sp
266 The evaluation is unlike \fBeval\fR and \fBload\fR is done under the package PreprocessNamespace and without \fIuse strict\fR, so you are free to use any variable names without fear of conflicts. Just don't use uninitialized variables to mean undef or empty list (they may be in fact initialized by the previous preprocess action), and do a clean-up if needed. The variables and function in the \fImain\fR package are still available, like ::\fIcmd()\fR or ::\fIskip()\fR, but it is just not a good idea to access them while preprocessing.
267 .Sp
268 There is a special function \fBinclude\fR(\fIfile\fR) that loads a file, preprocesses it and returns the preprocessed result. Avoid recursion.
269 .Sp
270 If any embedded perl code contains an error, it is printed to the standard error stream and prepended with the \fI[FvwmPerl][preprocess]:\fR header. The result of substitution is empty in this case.
271 .Sp
272 The following variables may be used in the perl code:
273 .Sp
274 \&\f(CW$USER\fR, \f(CW$DISPLAY\fR, \f(CW$WIDTH\fR, \f(CW$HEIGHT\fR, \f(CW$FVWM_VERSION\fR, \f(CW$FVWM_MODULEDIR\fR, \f(CW$FVWM_DATADIR\fR, \f(CW$FVWM_USERDIR\fR
275 .Sp
276 The following line based directives are recognized when preprocessing. They are processed after the perl code (if any) is substituted.
277 .RS 4
278 .IP "%\fBRepeat\fR \fIcount\fR" 4
279 .IX Item "%Repeat count"
280 Causes the following lines to be repeated \fIcount\fR times.
281 .IP "%\fBModuleConfig\fR \fImodule-name\fR [ destroy ]" 4
282 .IX Item "%ModuleConfig module-name [ destroy ]"
283 Causes the following lines to be interpreted as the given module configuration. If \*(L"destroy\*(R" is specified the previous module configuration is destroyed first.
284 .IP "%\fBPrefix\fR \fIprefix\fR" 4
285 .IX Item "%Prefix prefix"
286 Prefixes the following lines with the quoted \fIprefix\fR.
287 .IP "%\fBEnd\fR any-optional-comment" 4
288 .IX Item "%End any-optional-comment"
289 Ends any of the directives described above, may be nested.
290 .RE
291 .RS 4
292 .Sp
293 Examples:
294 .Sp
295 .Vb 6
296 \& %Prefix "AddToFunc SwitchToWindow I"
297 \& Iconify off
298 \& WindowShade off
299 \& Raise
300 \& WarpToWindow 50 50
301 \& %End
302 \&
303 \& %ModuleConfig FvwmPager destroy
304 \& Colorset 0
305 \& Font lucidasans\-10
306 \& DeskTopScale 28
307 \& MiniIcons
308 \& %End ModuleConfig FvwmPager
309 \&
310 \& %Prefix "All (MyWindowToAnimate) ResizeMove "
311 \& 100 100 %{($WIDTH \- 100) / 2}% %{($HEIGHT \- 100) / 2}%
312 \& %Repeat %{$count}%
313 \& br w+2c w+2c w\-1c w\-1c
314 \& %End
315 \& %Repeat %{$count}%
316 \& br w\-2c w\-2c w+1c w+1c
317 \& %End
318 \& %End Prefix
319 .Ve
320 .Sp
321 Additional preprocess parameters \-\-nosend and \-\-noremove may be given too. See their description at the top.
322 .RE
323 .IP "\fBexport\fR [\fIfunc-names\fR]" 4
324 .IX Item "export [func-names]"
325 Send to \fIfvwm\fR the definition of shortcut functions that help to activate different actions of the module (i.e. \fBeval\fR, \fBload\fR and \fBpreprocess\fR).
326 .Sp
327 Function names (\fIfunc-names\fR) may be separated by commas or/and whitespace. By default, two functions \*(L"Eval\*(R" and \*(L".\*(R" are assumed.
328 .Sp
329 The actual action defined in a function is guessed from the function name if possible, where function name \*(L".\*(R" is reserved for \fBpreprocess\fR action.
330 .Sp
331 For example, any of these two fvwm commands
332 .Sp
333 .Vb 2
334 \& SendToModule MyPerl export PerlEval,PP
335 \& FvwmPerl \-\-export PerlEval,PP MyPerl
336 .Ve
337 .Sp
338 define the following two shortcut functions:
339 .Sp
340 .Vb 4
341 \& DestroyFunc PerlEval
342 \& AddToFunc I SendToModule MyPerl eval $*
343 \& DestroyFunc PP
344 \& AddToFunc I SendToModule MyPerl preprocess \-c \-\- $*
345 .Ve
346 .PP
347 These 4 actions may be requested in one of 3 ways: 1) in the command line when FvwmPerl is invoked (in this case FvwmPerl is short-lived unless \fB\-\-stay\fR or \fB\-\-export\fR is also given), 2) by sending the corresponding message in fvwm config using SendToModule, 3) by calling the corresponding perl function in perl code.
348 .SH "FUNCTIONS"
349 .IX Header "FUNCTIONS"
350 There are several functions that perl code may call:
351 .ie n .IP "\fBcmd(\fR\fI\fI$fvwm_command\fI\fR\fB)\fR" 4
352 .el .IP "\fBcmd(\fR\fI\f(CI$fvwm_command\fI\fR\fB)\fR" 4
353 .IX Item "cmd($fvwm_command)"
354 In case of \fBeval\fR or \fBload\fR \- send back to fvwm a string \fI\f(CI$fvwm_command\fI\fR. In case of \fBpreprocess\fR \- append a string \fI\f(CI$fvwm_command\fI\fR to the output of the embedded perl code.
355 .ie n .IP "\fBdo_eval(\fR\fI\fI$perl_code\fI\fR\fB)\fR" 4
356 .el .IP "\fBdo_eval(\fR\fI\f(CI$perl_code\fI\fR\fB)\fR" 4
357 .IX Item "do_eval($perl_code)"
358 This function is equivalent to the \fBeval\fR functionality on the string \fI\f(CI$perl_code\fI\fR, described above.
359 .ie n .IP "\fBload(\fR\fI\fI$filename\fI\fR\fB)\fR" 4
360 .el .IP "\fBload(\fR\fI\f(CI$filename\fI\fR\fB)\fR" 4
361 .IX Item "load($filename)"
362 This function is equivalent to the \fBload\fR functionality on the file \f(CW$filename\fR, described above.
363 .ie n .IP "\fBpreprocess(\fR\fI\fI@params\fI, [""\-c \f(CI$command\fI""] [$filename]\fR\fB)\fR" 4
364 .el .IP "\fBpreprocess(\fR\fI\f(CI@params\fI, [``\-c \f(CI$command\fI''] [$filename]\fR\fB)\fR" 4
365 .IX Item "preprocess(@params, [-c $command] [$filename])"
366 This function is equivalent to the \fBpreprocess\fR functionality with the given parameters and the file \f(CW$filename\fR described above.
367 .ie n .IP "\fBexport(\fR\fI\fI$func_names\fI, [$do_unexport]\fR\fB)\fR" 4
368 .el .IP "\fBexport(\fR\fI\f(CI$func_names\fI, [$do_unexport]\fR\fB)\fR" 4
369 .IX Item "export($func_names, [$do_unexport])"
370 This function is equivalent to the \fBexport\fR functionality with the given \f(CW$func_names\fR, described above. May also \fBunexport\fR the function names if the second parameter is true.
371 .Sp
372 Function names should be separated by commas or/and whitespace. If \fI\f(CI$func_names\fI\fR is empty then functions \*(L"Eval\*(R" and \*(L".\*(R" are assumed.
373 .IP "\fB\f(BIstop()\fB\fR" 4
374 .IX Item "stop()"
375 Terminates the module.
376 .IP "\fB\f(BIskip()\fB\fR" 4
377 .IX Item "skip()"
378 Skips the rest of the event callback code, i.e. the module returns to listen to new module events.
379 .IP "\fB\f(BIunlock()\fB\fR" 4
380 .IX Item "unlock()"
381 Unsynchronizes the event callback from fvwm. This may be useful to prevent deadlocks, i.e. usually fvwm kills the non-responding module if the event callback is not finished in \fIModuleTimeout\fR seconds. This prevents it.
382 .Sp
383 This example causes FvwmPerl to suspend its execution for one minute:
384 .Sp
385 .Vb 1
386 \& SendModule FvwmPerl eval unlock(); sleep(60);
387 .Ve
388 .Sp
389 However, verify that there is no way a new message is sent by fvwm while the module is busy, and fvwm stays locked on this new message for too long. See also the \fBdetach\fR solution if you need long lasting operations.
390 .IP "\fB\f(BIdetach()\fB\fR" 4
391 .IX Item "detach()"
392 Forks and detaches the rest of the event callback code from the main process. This may be useful to prevent killing the module if its event callback should take a long time to complete and it may be done in the detached child. The detached child may still send commands to fvwm (don't rely on this), but not receive the events of course, it exits immediately after the callback execution is finished.
393 .Sp
394 If you use \fIdetach()\fR, better only send commands to fvwm in one process (the main one or the detached one), doing otherwise may often cause conflicts.
395 .ie n .IP "\fBshow_message(\fR$msg\fR, \f(CW$title\fR[, \f(CW$use_stderr_too\fR=1]\fB)" 4
396 .el .IP "\fBshow_message(\fR\f(CW$msg\fR, \f(CW$title\fR[, \f(CW$use_stderr_too\fR=1]\fB)\fR" 4
397 .IX Item "show_message($msg, $title[, $use_stderr_too=1])"
398 Shows a dialog window with the given message, using whichever X tool is found in the system.
399 .Sp
400 See \fBFVWM::Module::Toolkit\fR::\fBshow_message\fR for more information.
401 .SH "VARIABLES"
402 .IX Header "VARIABLES"
403 There are several global variables in the \fImain\fR namespace that may be used in the perl code:
404 .PP
405 .Vb 3
406 \& $a, $b, ... $h
407 \& @a, @b, ... @h
408 \& %a, %b, ... %h
409 .Ve
410 .PP
411 They all are initialized to the empty value and may be used to store a state between different calls to FvwmPerl actions (\fBeval\fR and \fBload\fR).
412 .PP
413 If you need more readable variable names, either write \*(L"no strict 'vars';\*(R" at the start of every perl code or use a hash for this, like:
414 .PP
415 .Vb 1
416 \& $h{id} = $h{first_name} . " " . $h{second_name}
417 .Ve
418 .PP
419 or use a package name, like:
420 .PP
421 .Vb 2
422 \& @MyMenu::terminals = qw( xterm rxvt );
423 \& $MyMenu::item_num = @MyMenu::terminals;
424 .Ve
425 .PP
426 There may be a configuration option to turn strictness on and off.
427 .SH "MESSAGES"
428 .IX Header "MESSAGES"
429 FvwmPerl may receive messages using the fvwm command SendToModule. The names, meanings and parameters of the messages are the same as the corresponding actions, described above.
430 .PP
431 Additionally, a message \fBstop\fR causes a module to quit.
432 .PP
433 A message \fBunexport\fR [\fIfunc-names\fR] undoes the effect of \fBexport\fR, described in the \s-1ACTIONS\s0 section.
434 .PP
435 A message \fBdump\fR dumps the contents of the changed variables (not yet).
436 .SH "EXAMPLES"
437 .IX Header "EXAMPLES"
438 A simple test:
439 .PP
440 .Vb 7
441 \& SendToModule FvwmPerl eval $h{dir} = $ENV{HOME}
442 \& SendToModule FvwmPerl eval load($h{dir} . "/test.fpl")
443 \& SendToModule FvwmPerl load $[HOME]/test.fpl
444 \& SendToModule FvwmPerl preprocess config.ppp
445 \& SendToModule FvwmPerl export Eval,PerlEval,PerlLoad,PerlPP
446 \& SendToModule FvwmPerl unexport PerlEval,PerlLoad,PerlPP
447 \& SendToModule FvwmPerl stop
448 .Ve
449 .PP
450 The following example handles root backgrounds in fvwmrc. All these commands may be added to StartFunction.
451 .PP
452 .Vb 1
453 \& Module FvwmPerl \-\-export PerlEval
454 \&
455 \& # find all background pixmaps for a later use
456 \& PerlEval $a = $ENV{HOME} . "/bg"; \e
457 \& opendir DIR, $a; @b = grep { /xpm$/ } readdir(DIR); closedir DIR
458 \&
459 \& # build a menu of background pixmaps
460 \& AddToMenu MyBackgrounds "My Backgrounds" Title
461 \& PerlEval foreach $b (@b) \e
462 \& { cmd("AddToMenu MyBackgrounds \*(Aq$b\*(Aq Exec fvwm\-root $a/$b") }
463 \&
464 \& # choose a random background to load on start\-up
465 \& PerlEval cmd("AddToFunc \e
466 \& InitFunction + I Exec exec fvwm\-root $a/" . $b[int(random(@b))])
467 .Ve
468 .SH "ESCAPING"
469 .IX Header "ESCAPING"
470 \&\fBSendToModule\fR just like any other fvwm commands expands several dollar prefixed variables.\ This may clash with the dollars perl uses. You may avoid this by prefixing SendToModule with a leading dash. The following 2 lines in each pair are equivalent:
471 .PP
472 .Vb 2
473 \& SendToModule FvwmPerl eval $$d = "$[DISPLAY]"
474 \& \-SendToModule FvwmPerl eval $d = "$ENV{DISPLAY}"
475 \&
476 \& SendToModule FvwmPerl eval \e
477 \& cmd("Echo desk=$d, display=$$d")
478 \& SendToModule FvwmPerl preprocess \-c \e
479 \& Echo desk=%("$d")%, display=%{$$d}%
480 .Ve
481 .PP
482 Another solution to avoid escaping of special symbols like dollars and backslashes is to create a perl file in ~/.fvwm and then load it:
483 .PP
484 .Vb 1
485 \& SendToModule FvwmPerl load build\-menus.fpl
486 .Ve
487 .PP
488 If you need to preprocess one command starting with a dash, you should precede it using \*(L"\-\-\*(R".
489 .PP
490 .Vb 8
491 \& # this prints the current desk, i.e. "0"
492 \& SendToModule FvwmPerl preprocess \-c Echo "$%{$a = "c"; ++$a}%"
493 \& # this prints "$d"
494 \& SendToModule FvwmPerl preprocess \-c \-\- \-Echo "$%{"d"}%"
495 \& # this prints "$d" (SendToModule expands $$ to $)
496 \& SendToModule FvwmPerl preprocess \-c \-\- \-Echo "$$%{"d"}%"
497 \& # this prints "$$d"
498 \& \-SendToModule FvwmPerl preprocess \-c \-\- \-Echo "$$%{"d"}%"
499 .Ve
500 .PP
501 Again, it is suggested to put your command(s) into file and preprocess the file instead.
502 .SH "CAVEATS"
503 .IX Header "CAVEATS"
504 FvwmPerl being written in perl and dealing with perl, follows the famous perl motto: \*(L"There's more than one way to do it\*(R", so the choice is yours.
505 .PP
506 Here are more pairs of equivalent lines:
507 .PP
508 .Vb 2
509 \& Module FvwmPerl \-\-load "my.fpl" \-\-stay
510 \& Module FvwmPerl \-e \*(Aqload("my.fpl")\*(Aq \-s
511 \&
512 \& SendToModule FvwmPerl preprocess \-\-quote \*(Aq@\*(Aq my.ppp
513 \& SendToModule FvwmPerl eval preprocess({quote => \*(Aq@\*(Aq}, "my.ppp");
514 .Ve
515 .PP
516 Warning, you may affect the way FvwmPerl works by evaluating appropriate perl code, this is considered a feature not a bug.\ But please don't do this, write your own fvwm module in perl instead.
517 .SH "SEE ALSO"
518 .IX Header "SEE ALSO"
519 The \fIfvwm\fR\|(1) man page describes all available commands.
520 .PP
521 Basically, in your perl code you may use any function or class method from the perl library installed with fvwm, see the man pages of perl packages \fBGeneral::FileSystem\fR, \fBGeneral::Parse\fR and \fBFVWM::Module\fR.
522 .SH "AUTHOR"
523 .IX Header "AUTHOR"
524 Mikhael Goikhman <migo@homemail.com>.