or .darken
is appended to the parameters, they are
instead replaced with a color that is lighter or darker than the one
defined in colorset (between 0 and 100).
For example "$[bg.cs3.lighten15]" is expanded to the background color of
colorset 3 and then lightened 15% (in rgb:rrrr/gggg/bbbb form).
.sp
If .hash is appened to the end the color output will use #rrggbb form
(instead of rgb:rrrr/gggg/bbbb). For example, $[bg.cs3.hash] or
$[bg.cs3.lighten15.hash].
.sp
Please refer to the \fBColorsets\fP section for details about colorsets.
.RE
.sp
$[schedule.last]
.RS 4
This is replaced by the id of the last command that was scheduled with
the \fBSchedule\fP command, even if this command was already executed.
.RE
.sp
$[schedule.next]
.RS 4
This is replaced by the id the next command used with \fBSchedule\fP will
get (unless a different id is specified explicitly).
.RE
.sp
$[cond.rc]
.RS 4
The return code of the last conditional command. This variable is only
valid inside a function and can not be used in a conditional command.
Please refer to the section \fBConditional Commands\fP in the command list.
.RE
.sp
$[func.context]
.RS 4
The context character of the running command as used in the \fBMouse\fP,
\fBKey\fP or \fBPointerKey\fP command. This is useful for example with:
.sp
.if n .RS 4
.nf
.fam C
Mouse 3 FS N WindowShade $$[func.context]
.fam
.fi
.if n .RE
.RE
.sp
$[debuglog.state]
.RS 4
Either \fI0\fP (debug log closed) or \fI1\fP. Indicates the current state of
debugging and logging facility.
.RE
.sp
$[gt.\fIstr\fP]
.RS 4
return the translation of \fIstr\fP by looking in the current locale
catalogs. If no translation is found \fIstr\fP is returned as is. See the
\fBLocalePath\fP command.
.RE
.sp
$[infostore.\fIkey\fP]
.RS 4
Return the value of the item stored in the InfoStore at the given \fIkey\fP.
If no key is present, the unexpanded string is returned.
.RE
.sp
$[...]
.RS 4
If the string within the braces is neither of the above, fvwm tries to
find an environment variable with this name and replaces its value if
one is found (e.g. "$[PAGER]" could be replaced by "more"). Otherwise
the string is left as is.
.sp
Some examples can be found in the description of the \fBAddToFunc\fP
command.
.RE
.SH "SCRIPTING AND COMPLEX FUNCTIONS"
.sp
To achieve the more complex effects, fvwm has a number of commands that
improve its scripting abilities. Scripts can be read from a file with
\fBRead\fP, from the output of a command with \fBPipeRead\fP or written as a
complex function with the \fBAddToFunc\fP command. For the curious, section
7 of the fvwm FAQ shows some real life applications of scripting. Please
refer to the sections \fBUser Functions and Shell Commands\fP and
\fBConditional Commands\fP for details. A word of warning: during execution
of complex functions, fvwm needs to take all input from the mouse
pointer (the pointer is "grabbed" in the slang of X). No other programs
can receive any input from the pointer while a function is run. This can
confuse some programs. For example, the xwd program refuses to make
screen shots when run from a complex function. To achieve the same
functionality you can use the \fBRead\fP or \fBPipeRead\fP command instead.
.SH "MENU CONCEPTS AND COMMANDS"
.sp
Please refer to the fvwm3menus man page.
.SH "LIST OF FVWM COMMANDS"
.sp
Please refer to the fvwm3commands and fvwm3styles man pages.
.SH "ENVIRONMENT"
.sp
The environment variables that have an effect on how fvwm operates are
the following:
.sp
\fIDISPLAY\fP
.RS 4
Fvwm starts on this display unless the \fB\-display\fP option is given.
.RE
.sp
\fIFVWM_USERDIR\fP
.RS 4
Used to determine the user\(cqs data directory for reading and writing
files. If this variable is not already set, it is set by fvwm to
\fI$HOME/.fvwm\fP, which is the default user\(cqs data directory.
.RE
.sp
\fIFVWM3_LOGFILE\fP
.RS 4
Used to determine the path and filename to log debug information from
fvwm3. By default debug log is written to
\fI$FVWM_USERDIR\fP/fvwm3\-output.log . If an absolute path is specified
(starting with /) then \fI$FVWM_USERDIR\fP is ignored, otherwise the log is
written to \fI$FVWM_USERDIR\fP/\fI$FVWM3_LOGFILE\fP .
.RE
.sp
\fIFVWM_DATADIR\fP
.RS 4
Set by fvwm to the directory containing fvwm config and module data.
.RE
.sp
\fIFVWM_MODULEDIR\fP
.RS 4
Set by fvwm to the directory containing the standard fvwm modules.
.RE
.sp
\fISESSION_MANAGER\fP
.RS 4
Fvwm tries to contact this session manager.
.RE
.sp
\fISESSION_MANAGER_NAME\fP
.RS 4
This is used mainly to determine xsm running to work around its bug. If
this variable is set to "xsm", DiscardCommand is set as xsm expects it
and not as XSMP requires. If you run fvwm under xsm, you should set this
variable to "xsm", otherwise old state files are not removed.
.RE
.sp
\fISM_SAVE_DIR\fP
.RS 4
If this is set, fvwm saves its session data in this directory. Otherwise
it uses \fI$HOME\fP. Note, the state files are named \fI.fs\-??????\fP and
normally are removed automatically when not used anymore.
.RE
.SH "AUTHORS"
.sp
Robert Nation with help from many people, based on twm code, which was
written by Tom LaStrange. After Robert Nation came Charles Hines,
followed by Brady Montz. Currently fvwm is developed by a number of
people on the fvwm\-workers mailing list.
.SH "COPYRIGHT"
.sp
Fvwm and all the modules, scripts and other files coming with the
distribution are subject to the GNU General Public License (GPL). Please
refer to the COPYING file that came with fvwm for details.
.SH "BUGS"
.sp
Bug reports can be sent to the fvwm\-workers mailing list at
\c
.MTO "fvwm\-workers\(atfvwm.org" "" ""
.sp
The official fvwm homepage is \fI\c
.URL "http://fvwm.org/" "" "\fP."