diff --git a/Dockerfile b/Dockerfile index a721a0689..8a03d5fdb 100644 --- a/Dockerfile +++ b/Dockerfile @@ -8,4 +8,4 @@ ENV GO111MODULE="on" COPY . /build WORKDIR /build -RUN ./autogen.sh && ./configure --enable-golang && make -j4 +RUN ./autogen.sh && ./configure --enable-mandoc --enable-golang && make -j4 diff --git a/Makefile.am b/Makefile.am index 1ee64a3b6..ca89ddbbd 100644 --- a/Makefile.am +++ b/Makefile.am @@ -23,7 +23,7 @@ SUBDIRS = \ # make distcheck2 # instead of make distcheck # make distclean2 # instead of make distclean -DISTCHECK_CONFIGURE_FLAGS = --enable-htmldoc +DISTCHECK_CONFIGURE_FLAGS = --enable-mandoc distcheck2: distcheck @banner="$(distdir).tar.gz - ready for distribution"; \ diff --git a/bin/Makefile.am b/bin/Makefile.am index 109814d65..0b89e97d3 100644 --- a/bin/Makefile.am +++ b/bin/Makefile.am @@ -11,11 +11,7 @@ bin_SCRIPTS = fvwm-config fvwm-perllib \ fvwm-menu-xlock fvwm-menu-directory \ fvwm-menu-desktop -man_MANS = \ - fvwm-root.1 fvwm-config.1 fvwm-perllib.1 \ - fvwm-convert-2.6.1 \ - fvwm-menu-xlock.1 fvwm-menu-directory.1 \ - fvwm-menu-desktop.1 +man_MANS = fvwm-menu-xlock.1 LDADD = -L$(top_builddir)/libs $(X_LIBS) -lfvwm3 $(xpm_LIBS) $(Xcursor_LIBS) \ $(X_PRE_LIBS) -lXext -lX11 -lm $(X_EXTRA_LIBS) $(Xrender_LIBS) \ @@ -58,7 +54,7 @@ _fvwm-perllib.1: fvwm-perllib rm -rf $$TMP) regenerate: \ - _fvwm-menu-xlock.1 _fvwm-menu-directory.1 _fvwm-perllib.1 + _fvwm-menu-xlock.1 ## Create compatibility symlinks if available diff --git a/bin/fvwm-config.1.in b/bin/fvwm-config.1.in deleted file mode 100644 index fa4c0e21e..000000000 --- a/bin/fvwm-config.1.in +++ /dev/null @@ -1,152 +0,0 @@ -.\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@ -.de EX \"Begin example -.ne 5 -.if n .sp 1 -.if t .sp .5 -.nf -.in +.5i -.. -.de EE -.fi -.in -.5i -.if n .sp 1 -.if t .sp .5 -.. -.ta .3i .6i .9i 1.2i 1.5i 1.8i -.TH fvwm-config 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules" -.UC -.SH NAME -fvwm-config \- query an existing fvwm installation -.SH SYNOPSIS -.B fvwm-config -.RI [ --help ] -.RI [ --version ] -.RI [ --info ] -.RI [ --prefix ] -.RI [ --exec-prefix ] -.RI [ --bindir ] -.RI [ --datadir ] -.RI [ --libexecdir ] -.RI [ --sysconfdir ] -.RI [ --mandir ] -.RI [ --localedir ] -.RI [ --fvwm-moduledir ] -.RI [ --fvwm-datadir ] -.RI [ --fvwm-perllibdir ] -.RI [ --default-imagepath ] -.RI [ --default-userdir ] -.RI [ --fvwm-exe ] -.RI [ --supports ] -.RI [ --supports- ] -.SH DESCRIPTION -.B fvwm-config -is a shell script that provides an information about the fvwm version, -installation directories, built-in paths and supported features. -.SH OPTIONS -.B fvwm-config -prints to the standard output in all options. -Both short and long GNU-like option names may be used. -.TP -.B -h --help -? -prints the short usage -.TP -.B -v --version -V -prints the version -.TP -.B -i --info -prints the full info page -.TP -.B -P --prefix -prints the installation prefix -.TP -.B -E --exec-prefix -prints the installation exec-prefix -.TP -.B -B --bindir -prints the installation bindir -.TP -.B -D --datadir -prints the installation datadir -.TP -.B -L --libexecdir -prints the installation libexecdir -.TP -.B -S --sysconfdir -prints the installation sysconfdir -.TP -.B -M --mandir -prints the installation mandir -.TP -.B -O --localedir -prints the installation localedir -.TP -.B -m --fvwm-moduledir -prints FVWM_MODULEDIR, where the modules are installed -.TP -.B -d --fvwm-datadir -prints FVWM_DATADIR, where the system wide configs are installed -.TP -.B -p --fvwm-perllibdir -prints FVWM_PERLLIBDIR, where the perl library is installed -.TP -.B -I --default-imagepath -prints the built-in ImagePath -.TP -.B -U --default-userdir -prints the default FVWM_USERDIR, note: $HOME is not expanded -.TP -.B -e --fvwm-exe -prints the fvwm executable name (in bindir) -.TP -.B -s --supports -lists all supported features, one per line -.TP -.BI --supports- -prints nothing, returns: 0 if the -.I -is supported, 100 if not, 200 if unknown. -All or supported feature names may be found using -.IR --info " or " --supports -respectively. -.TP -.SH USAGE -Here are some real life usages. - -Checks for xft support: -.EX -if fvwm-config --supports-xft; - then echo 1; else echo 0; fi -.EE - -.I fvwm-themes -package checks for the correct -.I fvwm -version installed using: -.EX -fvwm-config --version -.EE -and tries to use the same installation directories: -.EX -fvwm-config --bindir --mandir --fvwm-datadir -.EE - -A way to find the full path to the fvwm executable: -.EX -echo `fvwm-config --bindir`/`fvwm-config --fvwm-exe` -.EE - -A way to start modules in perl: -.EX -use lib `fvwm-config -p | tr -d '\n'`; -use FVWM::Module; -.EE - -For a more human readable output, try: -.EX -fvwm-config --info -.EE -.SH COPYING -.B fvwm-config -is a part of fvwm package and distributed by the same terms, see GNU GPL. -.SH AUTHOR -Mikhael Goikhman diff --git a/bin/fvwm-convert-2.6.1.in b/bin/fvwm-convert-2.6.1.in deleted file mode 100644 index d449bc664..000000000 --- a/bin/fvwm-convert-2.6.1.in +++ /dev/null @@ -1,114 +0,0 @@ -.\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@ -.TH fvwm-convert-2.6 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules" -.SH NAME -fvwm-convert-2.6 \- convert fvwm 2.4.x configuration file to fvwm 2.6 style -.SH SYNOPSIS -.B fvwm-convert-2.6 -.RI [ --follow-read | -f ] -.RI [ --help | -h ] -.RI source -.RI [ dest ] -.SH OPTIONS -The following options are supported: -.IP "\fB\-\-help\fR | \fB\-h\fR" -Prints a usage message to the screen. -.IP "\fB\-\-follow\-read\fR | \fB\-f\fR" -Follows files found along with the -.B Read -command. -.SH DESCRIPTION -.B fvwm-convert-2.6 -converts an fvwm 2.4.x configuration file into a fvwm 2.6 -file with compatible syntax. It is not suitable to convert older 2.x -configuration files. Please use -.B fvwm-convert-2.2 -to convert these to the 2.2.x format first, and then if necessary -.B fvwm-convert-2.4 -.PP -By default, -.B fvwm-convert-2.6 -won't look for a given config file. This must be specified as the first -parameter to -.B fvwm-convert-2.6. -Different source and destination files may be given. -If the destination file already exists, this program exits. -If no destination file is given, then the filename is -the same name as the source file with the suffix ".converted" -added. Without an absolute path given as the destination path to the -destination file, the program will create the destination file in the CWD. -.PP -.B fvwm-convert-2.6 -makes the following changes: -.TP 4 -.B Style lines -In fvwm 2.4, most style options could be negated from their counterparts -using NoFoo -- fvwm-convert-2.6 corrects this by now using !Foo. -.TP 4 -.B ModulePath -In fvwm 2.4 and beyond, the ModulePath is compiled into fvwm. -.B fvwm-convert-2.6 -comments out any ModulePath commands it finds. -If you are using your own modules, (not the ones that come with fvwm), -you will have to fix your configuration file after using -.BR fvwm-convert-2.6 . -.TP 4 -.B Conditional command syntax -In fvwm 2.4, the conditional command options were whitespace-separated -- -they should now be comma-separated instead. In addition, the older syntax -to Next and Prev of using [*] to denote all windows has been removed -entirely. Both these checks and conversions are done on function commands, -key/mouse bindings. -.TP 4 -.B WindowShadeSteps -In fvwm 2.4, the WindowShadeSteps command is replaced by the -WindowShadeSteps Style option. -.B fvwm-convert-2.6 -makes this change. -.TP 4 -.B FvwmTheme -In fvwm 2.6, the FvwmTheme module is replaced by a series of Colorset -commands. Whilst -.B fvwm-convert-2.6 -will try and make this change, it is still recommended that this is checked -after conversion. -.TP 4 -.B EdgeResistance -In fvwm 2.6, the EdgeResistance command is has been split to include an -additional style option for EdgeMoveResistance. -.B fvwm-convert-2.6 -makes any changes necessary. -.TP 4 -.B StartFunction / RestartFunction / InitFunction -In fvwm 2.6, the need for using InitFunction and/or RestartFunction is -redundant when StartFunction is read at both of these times. -.B fvwm-convert-2.6 -attempts to convert this. -.TP 4 -.B Read -If -.B -f -or -.B --follow-read -is given, any files -.B fvwm-convert-2.6 -can detect and open will be converted automatically, else a list of files -that can be followed are printed to the screen. - -.TP 4 -.SH BUGS - -.I InitFunction -and -.I RestartFunction -and hence -.I StartFunction -are printed at the end of the files -- this slight reordering might put some -comments before in an odd spot. - -When converting over FvwmTheme lines, the colorset definitions might well be -broken, but these cannot easily be converted. - -Bug reports can be sent to the fvwm-workers mailing list (see the -.IR FAQ ). -.SH AUTHOR -Thomas Adam diff --git a/bin/fvwm-menu-desktop.1.in b/bin/fvwm-menu-desktop.1.in deleted file mode 100644 index b4b54a6cc..000000000 --- a/bin/fvwm-menu-desktop.1.in +++ /dev/null @@ -1,464 +0,0 @@ -.\" t -.\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@ -.de EX \"Begin example -.ne 5 -.if n .sp 1 -.if t .sp .5 -.nf -.in +.5i -.. -.de EE -.fi -.in -.5i -.if n .sp 1 -.if t .sp .5 -.. -.ta .3i .6i .9i 1.2i 1.5i 1.8i -.TH fvwm-menu-desktop 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules" -.UC -.SH NAME -fvwm-menu-desktop \- Reads XDG menu files and creates Fvwm menus - -.SH SYNOPSIS -fvwm-menu-desktop -[ \fB\-\-help\fR|\fB\-h\fR ] -[ \fB\-\-version\fR ] -[ \fB\-\-install\-prefix\fR \fIDIR\fR ] -[ \fB\-\-desktop\fR \fINAME\fR ] -[ \fB\-\-menu\-type\fR \fINAME\fR ] -[ \fB\-\-theme\fR \fINAME\fR ] -[ \fB\-\-with\-titles\fR|\fB\-w\fR ] -[ \fB\-\-without\-titles\fR ] -[ \fB\-\-enable\-mini\-icons\fR ] -[ \fB\-\-size\fR|\fB\-s\fR \fINUM\fR ] -[ \fB\-\-mini\-icon\-dir\fR \fIDIR\fR ] -[ \fB\-\-app\-icon\fR \fINAME\fR ] -[ \fB\-\-dir\-icon\fR \fINAME\fR ] -[ \fB\-\-title\fR|\fB\-t\fR \fINAME\fR ] -[ \fB\-\-insert\-in\-menu\fR \fINAME\fR ] -[ \fB\-\-get\-menus\fR \fIall\fR|\fIdesktop\fR ] -[ \fB\-\-set\-menus\fR \fImenu_paths\fR ] -[ \fB\-\-all\-menus\fR ] -[ \fB\-\-include\-items\fR \fINAME\fR ] -[ \fB\-\-regen\-cmd\fR \fICMD\fR ] -[ \fB\-\-term\-cmd\fR \fICMD\fR ] -[ \fB\-\-dynamic\fR ] -[ \fB\-\-menu-error\fR|\fB\-e\fR ] -[ \fB\-\-verbose\fR|\fB\-v\fR ] - - -.SH DESCRIPTION -This is a python script which parses XDG menus definitions to build -corresponding fvwm menus. This script depends on python-xdg to run. - - -.SH OPTIONS - -.IP "Main Options" - -.IP "\fB\-\-help\fR" -Show the help and exit. - -.IP "\fB\-\-version\fR" -Show the version and exit. - -.IP "\fB\-\-get\-menus\fR \fIall\fR|\fIdesktop\fR" -Prints a space separated list of full menu paths found on the system. -\fIall\fR will print all menus found on the system except empty ones. -\fIdesktop\fR will print the menu(s) that would be generated by the script. - -No menu generation is done. - -.IP "\fB\-\-desktop\fR \fINAME\fR" -Optional parameter to set the \fINAME\fR of the desktop XDG .menu -file(s) to use. This option will override any default menus -set via \fBFvwmForm-XDGMenu-Config\fR and cause the script -to find menus in which \fINAME\fR is a part of the file name. -Possible names are: \fIgnome\fR, \fIkde\fR, \fIxfce\fR, \fIlxde\fR, -\fIdebian\fR, etc. - -This option can be used in conjunction with \fB\-\-menu\-type\fR -to control which .menu file(s) are used. - -.IP "\fB\-\-menu\-type\fR \fINAME\fR" -Optional parameter to set the \fINAME\fR of the XDG menu type -to use. This option will override any default menus -set via \fBFvwmForm-XDGMenu-Config\fR and cause the script -to find menus in which \fINAME\fR is a part of the file name. -Possible \fINAME\fR types could be: \fIapplications\fR, \fIsettings\fR, -\fIpreferences\fR, etc. - -When used in conjunction with \fB\-\-desktop\fR, only menus whose file -name matches '*destkop*menutype*' are found. If no menus are found, -the script exits with an error. - -.IP "\fB\-\-all\-menus\fR" -This option will build all menus found on the system. If used in -conjunction with \fB\-\-desktop\fR or \fB\-\-menu\-type\fR this will -build all menus matching those settings. - -.IP "\fB\-\-install-prefix\fR \fIDIR\fR" -Optional parameter to override the standard locations for XDG menu -definitions. Tells \fBfvwm-menu-desktop\fR to look in \fIDIR\fR for .menu -files instead of the standard locations /etc/xdg/menus (and -$HOME/.config/menus if it exists). - -.IP "\fB\-\-with\-titles\fR|\fB\-w\fR" -If this option is set menus are generated with titles. This is the default. -This option can be used to override the \fBFvwmForm-XDGMenu-Config\fR -default setting. - -.IP "\fB\-\-without\-titles\fR" -If this option is set menus are generated without titles. The default -is to generate with titles. - -.IP "\fB\-\-title\fR|\fB\-t\fR \fINAME\fR " -Option to define the menu title \fINAME\fR of the top menu used by Fvwm's -\fBMenu\fR or \fBPopup\fR commands. Default is "XDGMenu". - -.IP "\fB\-\-include\-items\fR \fINAME\fR " -This option controls if the additional menu items 'Regenerate' and 'Configure' -are included in the top level menu. \fINAME\fR can be one of \fIregenerate\fR, -\fIconfig\fR, \fIboth\fR, or \fInone\fR. The default is \fIboth\fR. - -.IP "\fB\-\-regen\-cmd\fR \fICMD\fR " -This option sets the fvwm command \fICMD\fR that is run when the menu item -\'Regenerate' is selected. The default is "PipeRead `fvwm-menu-desktop`". - -.IP "\fB\-\-term\-cmd\fR \fICMD\fR " -This option sets the terminal emulator command \fICMD\fR that is used to -to run terminal applications in. \fICMD\fR needs to end with an execute -option, such as xterm's -e option, which will run the command that is -appended to \fICMD\fR. The default is "xterm -e". - -.IP "\fB\-\-dynamic\fR " -This option is to be used with creating dynamic menus using -\fBDynamicPopUpAction\fR and \fBDynamicPopDownAction\fR. This adds -a 'recreate' to the \fBDestroyMenu\fR command on the top level menu -so those actions are not Destroyed when the menu is regenerated. - -.IP "\fB\-\-insert\-in\-menu\fR \fINAME\fR" -Option to insert generated menu(s) \fBIN\fR a menu \fINAME\fR (its -top title). This option makes it so the top level menu is not -Destroyed and the items are added to the end. - -Note menus regenerated with this option will append the menu items -at the end of the existing menu. Each time the menu is regenerated -new menu items appear giving a growing menu of duplicate items. -You have to regenerate the whole menu via a function or restart -fvwm. See \fBEXAMPLES\fR below for some solutions. - -.IP "\fB\-\-set\-menus\fR \fImenu_paths\fR" -Generates all menus listed in a space separated list of full menu paths. -This option overrides any defaults and \fB\-\-desktop\fR|\fB\-\-menu\-type\fR -settings. - -.IP "\fB\-\-menu-error\fR |\fB\-t\fR" -If this option is present and python-xdg is not found, the script -will print the error in the generated menu. Used in the default-config. - -.IP "\fB\-\-verbose\fR" -Enables additional information printouts on STDERR. - -.IP "Icons Options" - -By default, fvwm-menu-desktop builds menus without mini\-icons. To enable -mini\-icons use the following options. - -If ImageMagick is installed on the system, the script will resize and copy -the icons to $FVWM_USERDIR/.icons. This can take awhile. You should be -prepared to wait the first time you generate the icons. Once the icons -have been generated the script should run faster. If it is still to slow -using icons, see \fBEXAMPLES\fR for ways to limit how often -the menu is generated to speed things up. - -.IP "\fB\-\-enable\-mini\-icons\fR" -This option enables mini\-icons in the menus. If set, 24x24 mini-icons -are used. If the specified icon isn't that size it will be converted -if \fBImageMagick\fR is installed and saved in $HOME/.fvwm/icons or to -the directory specified with \-\-mini\-icon\-dir option. Otherwise no icon -appears in the menu for that entry. -With most distributions, all the menu entries will have mini-icons -appropriate to the application. - -.IP "\fB\-\-theme\fR \fINAME\fR" -Defines the used icon theme. Default is \fIgnome\fR but all others -found in /usr/share/icons could be used except the \fIhicolor\fR theme -because it's the default fallback theme if no icon is found. - -.IP "\fB\-\-size\fR|\fB\-s\fR \fINUM\fR" -If \-\-enable\-mini\-icons is used the \fIsize\fR of the icons can -changed with this parameter. Default is 24. - -.IP "\fB\-\-mini\-icon\-dir\fR \fIDIR\fR" -When the right size mini-icon isn't available, -fvwm-menu-desktop creates icons with the right size in $HOME/.fvwm/icons. -If you don't want to use the default directory, $HOME/.fvwm/icons, -use this option to specify a different folder. - -.IP "\fB\-\-app\-icon\fR \fINAME\fR" -Sets the default application icon if no others are found. Default is -\'gnome-applications'. - -.IP "\fB\-\-dir\-icon\fR \fINAME\fR" -Sets the default directory icon if no others are found. Default is -\'gnome-fs-directory'. - -.SH USAGE -\fBfvwm-menu-desktop\fR outputs XDG .menu files in the syntax of fvwm -menus. When \fBfvwm-menu-desktop\fR is run with no options, it will load -defaults from the \fBFvwmForm-XDGMenu-Config\fR file (see below) then -search your system for suitable menu file(s). To see which menus are -available on your system run: - -.RS -.EX -fvwm-menu-desktop --get-menus all -.EE -.RE - -If no menus are found you may not have any installed on your -system. By default menus are stored as *.menu files in /etc/xdg/menus, -$HOME/.config/menus or the location set in $XDG_MENU_PREFIX. You can -use \fB\-\-install\-prefix\fR to specify another location search for menus. - -Though a combination of command line options and the \fBFvwmForm-XDGMenu-Config\fR -settings, \fBfvwm-menu-desktop\fR can generate any combination of the menus -found. To get a list of what menu(s) would be generated use the -\fB--get-menus\fR \fIdesktop\fR option. The following will list all menus -generated if \fBfvwm-menu-desktop\fR was run with no options. - -.RS -.EX -fvwm-menu-desktop --get-menus desktop -.EE -.RE - -\fBfvwm-menu-desktop\fR determines which menu(s) to generate as follows - -.RS -If no config file is found, all menus will be weighted and the script -will generate the best (highest weight) menu found. - -If a config file is found (and override options are not used) the script -will generate all menus selected in \fBFvwmForm-XDGMenu-Config\fR. - -\fB--desktop\fR, \fB--menu-type\fR, \fB--set-menus\fR and \fB--all-menus\fR -will override any menus selected in \fBFvwmForm-XDGMenu-Config\fR. - -\fB--desktop\fR and \fB--menu-type\fR will only include menus whose name -matches '*desktop*menutype*'. If used with \fB--all-menus\fR, all matching -menus are generated. If used without \fB--all-menus\fR, only the highest -weighted menu is generated. - -\fB--set-menus\fR generates menus from the list of full path menu file names. - -\fB--all-menus\fR by itself will generate all menus found. -.RE - -By default \fBfvwm-menu-desktop\fR will generate a menu whose -top level name is "XDGMenu". To tell fvwm to read the output -of \fBfvwm-menu-desktop\fR to create the menu XDGMenu add the following -to your fvwm config file: - -.RS -.EX -PipeRead 'fvwm-menu-desktop' -.EE -.RE - -\fBWarning:\fR Depending on the options used this command may be -slow and fvwm will pause until this command is complete. See -\fBEXAMPLES\fR below for more details and possible workarounds. - -Once the menu is generated you can open the menu by using the -command "Menu XDGMenu". You can also include this in the MenuFvwmRoot -menu by: - -.RS -.EX -AddToMenu MenuFvwmRoot "XDG Menu" Popup XDGMenu -.EE -.RE - -\fBfvwm-menu-desktop\fR can be configured though both command line -options and a \fBFvwmForm\fR GUI to customize the menu(s) that get -generated. - -.SH GUI -\fBFvwmForm-XDGMenu-Config\fR is a \fBFvwmForm\fR interface that can -be used to configure the defaults for \fBfvwm-menu-desktop\fR. You -can access this from the "Configure" item in the top level menu that -is generated or run the following from within \fBFvwmConsole\fR - -.RS -.EX -Module FvwmPerl -l fvwm-menu-desktop-config.fpl -.EE -.RE - -This form can be used to select which menu(s) get generated by default -along with setting many (but not all) of the available options. When -you click "Save Settings" the form will write a config file located at -$FVWM_USERDIR/.FvwmForm-XDGMenu-Config that \fBfvwm-menu-desktop\fR -will parse for defaults when run. - -See the help inside of \fBFvwmForm-XDGMenu-Config\fR for more information. - - -.SH EXAMPLES -There are many ways to setup when fvwm runs \fBfvwm-menu-desktop\fR -to generate the menu. One method is to just generate the menu when -fvwm loads and then use the GUI config tool to change any options. -To do this you only need to add the following to the fvwm config file: - -.RS -.EX -AddToMenu MenuFvwmRoot "XDG Menu" Popup XDGMenu -PipeRead 'fvwm-menu-desktop' -.EE -.RE - -The menu is created once when fvwm loads. Since menu creation can -sometimes be slow, this could cause fvwm to take longer to load than -one wants. - -The menu is only generated when fvwm starts. If software -is installed or removed you will have to select the 'Regenerate' option -to rebuild the menu. - -One way to speed things up is to save the menu in a file and only generate -the menu when 'Regenerate' is selected. To do this use \fB--regen-cmd\fR -to call a custom function and write the menu to a file using a command like - -.RS -.EX -fvwm-menu-desktop --regen-cmd XDGRegen > $FVWM_USERDIR/.XDGMenu -.EE -.RE - -Then add the following to the fvwm config file to define the function -XDGRegen. The second to last line will generate the menu if the menu -file doesn't exist when fvwm starts. - -.RS -.EX -DestroyFunc XDGRegen -AddToFunc XDGRegen -+ I PipeRead 'fvwm-menu-desktop --regen-cmd XDGRegen > \\ - $[FVWM_USERDIR]/.XDGMenu; echo "Nop"' -+ I Read $[FVWM_USERDIR]/.XDGMenu - -Test (!f $[FVWM_USERDIR]/.XDGMenu) XDGRegen -Read $[FVWM_USERDIR]/.XDGMenu -.EE -.RE - -Besides creating a top level menu, \fBfvwm-menu-desktop\fR can insert the -menu into an existing menu using the \fB--insert-in-menu\fR option. For example -one could create the menu MenuFvwmRoot and include the XDG items at the end. - -.RS -.EX -DestroyMenu MenuFvwmRoot -AddToMenu MenuFvwmRoot "Fvwm" Title -+ "Item1" Action1 - ... -+ "ItemN" ActionN -+ "" Nop -PipeRead 'fvwm-menu-desktop --insert-in-menu MenuFvwmRoot' -.EE -.RE - -In this case the menu items are inserted at the end of the MenuFvwmRoot menu. -If no items are in the menu, this menu becomes MenuFvwmRoot. The problem -here is, that you have to restart fvwm or rebuild the whole menu -to Regenerate it because menu items cannot be removed. -To do this you could use a function like - -.RS -.EX -DestroyFunc XDGRegen -AddToFunc XDGRegen -+ I DestroyMenu MenuFvwmRoot -+ I AddToMenu MenuFvwmRoot "Fvwm" Title -+ I AddToMenu MenuFvwmRoot "Item1" Action1 - ... -+ I AddToMenu MenuFvwmRoot "ItemN" ActionN -+ I AddToMenu MenuFvwmRoot "" Nop -+ I PipeRead 'fvwm-menu-desktop --insert-in-menu MenuFvwmRoot \\ - --regen-cmd XDGRegen' -.EE -.RE - -Fvwm can also create menus dynamically by using \fBDynamicPopUpAction\fR -and/or \fBDynamicPopDownAction\fR. These commands when used with a Menu -will run a Function when the menu is opened. For example one could -create the menu XDGMenu when it is opened using - -.RS -.EX -AddToMenu XDGMenu "XDGMenu" Title -+ DynamicPopUpAction PipeRead 'fvwm-menu-desktop' -.EE -.RE - -This will create the menu when it is opened. One issue here is it will only -create the menu the first time it is opened, and you still have to -Regenerate the menu to see any changes. To create the menu each time it -is open used the \fB--dynamic\fR option - -.RS -.EX -AddToMenu XDGMenu "XDGMenu" Title -+ DynamicPopUpAction PipeRead 'fvwm-menu-desktop \\ - --dynamic --include-items config' -+ DynamicPopDownAction DestroyMenu recreate XDGMenu -.EE -.RE - -This will now Destroy the menu when it closed so it can be rebuilt the -next time it is opened. The recreate flag doesn't completely destroy -the menu keeping the DynamicPopUpAction and DynamicPopDownAction actions. -The \fB--dynamic\fR flag includes the recreate option in the generated menus. - -To insert a menu into MenuFvwmRoot and still be dynamic you need to use -a function that generates the whole menu. For example - -.RS -.EX -DestroyFunc GenRootMenu -AddToFunc GenRootMenu -+ I DestroyMenu recreate MenuFvwmRoot -+ I AddToMenu MenuFvwmRoot "Fvwm" Title -+ I AddToMenu MenuFvwmRoot "Item1" Action1 - ... -+ I AddToMenu MenuFvwmRoot "ItemN" ActionN -+ I AddToMenu MenuFvwmRoot "" Nop -+ PipeRead `fvwm-menu-desktop --insert-in-menu MenuFvwmRoot \\ - --include-items config` - -AddToMenu MenuFvwmRoot "Fvwm" Title -+ DynamicPopUpAction GenRootMenu -+ DynamicPopDownAction DestroyMenu recreate MenuFvwmRoot -.EE -.RE - -.SH BUGS -The whole process of creating menus from files is slow. -Otherwise report bugs to the -fvwm-workers mailing list . - - -.SH AUTHORS -This script is based on fvwm-xdg-menu.py written by Piotr Zielinski -(http://www.cl.cam.ac.uk/~pz215/) who assigned Licence: GPL 2 Date: -03.12.2005. - -The script was reworked to replace the existing fvwm-menu-desktop perl -script by the fvwm-workers. - - -.SH COPYING -The script is distributed by the same terms as fvwm itself. See GNU -General Public License for details. diff --git a/bin/fvwm-root.1.in b/bin/fvwm-root.1.in deleted file mode 100644 index 58075be09..000000000 --- a/bin/fvwm-root.1.in +++ /dev/null @@ -1,110 +0,0 @@ -'\" t -.\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@ -.TH fvwm-root 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules" -.UC - -.SH NAME -fvwm-root \- Sets the root window of the current X display to image - -.SH SYNOPSIS -.B fvwm-root -.RB [ "--retain-pixmap" | "-r" ] -.RB [ "--no-retain-pixmap" ] -.RB [ "--dummy" | "-d" ] -.RB [ "--no-dummy" ] -.RB [ "--dither" ] -.RB [ "--no-dither" ] -.RB [ "--color-limit" -.RI [ ncolors "] ]" -.RB [ "--no-color-limit" ] -.RB [ "--help" | "-h" | "-?" ] -.RB [ "--version" | "-V" ] -.I image_file - -.SH DESCRIPTION -.I fvwm-root -reads the image file specified in the command line and displays it in the -root window. The supported image formats are -.IR XBM ", " XPM ", " PNG " and " SVG -if appropriated libraries are compiled in. - -SVG rendering options -.RB " (as described in the " " ICONS AND IMAGES " -section of the main fvwm documentation) can be utilized. - -.SH OPTIONS -These command line options are recognized by fvwm-root: -.TP -.BR "--retain-pixmap" " | " "-r" -Causes fvwm-root to retain and publish the Pixmap with which the background -has been set (the ESETROOT_PMAP_ID and _XROOTPMAP_ID properties are used). -This is useful for applications which want to use the root -Pixmap on the background to simulate transparency (for example, -Eterm and Aterm use this method). This option should also be used for the -RootTransparent colorset option, refer to the COLORSETS section of fvwm(1). -If this option is not used, fvwm-root sets the _XSETROOT_ID property to -None, and some programs, like fvwm modules, may use this to update their -background if the background is transparent (Transparent colorset). - -Note, a well behaved program, like fvwm, should listen to both _XSETROOT_ID -and _XROOTPMAP_ID property changes and update itself correspondingly. -However some programs listen only to one of them, so you should either use -this option or not depending on what part is implemented by these programs. -You should also use this option to get fast root-transparent menus in fvwm. -.TP -.BI "--no-retain-pixmap" -This is a default. May be useful to explicitly force the default even -if "--retain-pixmap" is specified earlier. -.TP -.BR "--dummy" " | " "-d" -Causes fvwm-root NOT to set the background, but to only free a memory -associated with the ESETROOT_PMAP_ID property (if any). -In any case the _XSETROOT_ID property is set to None. -.TP -.BI "--no-dummy" -This is a default. May be useful to explicitly force the default even -if "--dummy" is specified earlier. -.TP -.BI "--dither" -Causes fvwm-root to dither images for "smoother" rendition on displays -with color depth of 16 or lower. This the default with color depth less -or equal to 8. -.TP -.BI "--no-dither" -Causes fvwm-root NOT to dither images. This is the default with color depth -greater than 8. -.TP -.BI "--color-limit " ncolors -Causes fvwm-root to limit its color use to -.I ncolors -(if specified). This option is taken in account only with color depth less -or equal to 8 (and a TrueColor or GrayScale visual). The default is -to use the same color limit as fvwm. So in normal situation this option -is not useful. However, if fvwm use a private colors map, as fvwm-root -always use the default colors map you should use this option for -limiting colors correctly. If -.I ncolors -is not specified a default is used. -.TP -.BI "--no-color-limit" -Causes fvwm-root NOT to limit its color use. -.TP -.BI "--help" -Shows a short usage. -.TP -.BI "--version" -Shows a version number. - -.SH COMPATIBILITY -In the past this utility was called -.IR xpmroot . -This name is still supported as a symlink. - -.SH BUGS -Repeated use of fvwm-root with different xpm pixmaps will use up slots in -your color table pretty darn fast. - -.SH AUTHOR -Rob Nation - -Rewritten and enhanced by fvwm-workers. diff --git a/configure.ac b/configure.ac index 7479bf656..202866080 100644 --- a/configure.ac +++ b/configure.ac @@ -132,7 +132,6 @@ transform=`echo "${program_transform_name}" | "$SED" -e 's/\\$\\$/\\$/'` PPACKAGE=`echo "${PACKAGE}" | "$SED" -e "${transform}"` FVWM_MODULESUBDIR=/${PPACKAGE}/${VERSION} FVWM_DATASUBDIR=/${PPACKAGE} -FVWM_DOCSUBDIR=/doc/${PPACKAGE} AC_ARG_ENABLE(package-subdirs, AS_HELP_STRING([--disable-package-subdirs], @@ -303,93 +302,6 @@ esac # - version of fribidi without fribidi-config AM_CHECK_PKG_CONFIG - -# Building man pages & HTML documentation (from XML source). -# extract command names -if test ! x"$SED" = x; then - DOC_COMMANDS=` - sed -n ' - :findhead - /#.*define.*CMD_ENT/bfindcmd - n - bfindhead - :findcmd - n - /CMD_ENT/bfound - bfindcmd - :found - /"#"/bfindcmd - /"propertychange"/bfindcmd - /"readwritecolors"/bfindcmd - /"send_.*"/bfindcmd - /"set_.*"/bfindcmd - s/.*CMD_ENT.*CMD_// - s/,.*// - p - n - bfindcmd - ' < fvwm/functable.c` - DOC_COMMANDS=`echo $DOC_COMMANDS` - # with .xml suffix - DOC_COMMANDS_XML=`for i in $DOC_COMMANDS; do echo ${i}.xml; done` - DOC_COMMANDS_XML=`echo $DOC_COMMANDS_XML` - # with .xml suffix and path - DOC_COMMANDS_XML_PATH=` - for i in $DOC_COMMANDS; do - echo ../commands/${i}.xml; - done - ` - DOC_COMMANDS_XML_PATH=`echo $DOC_COMMANDS_XML_PATH` - # with .html suffix - DOC_COMMANDS_HTML=`for i in $DOC_COMMANDS; do echo ${i}.html; done` - DOC_COMMANDS_HTML=`echo $DOC_COMMANDS_HTML` - # extract module names - DOC_MODULES="" - DOC_MODULES=` - for i in modules/*; do echo "$i"; done | - sed -n ' - :search - /^modules.Fvwm/bfound - bnext - :found - s/modules.// - p - :next - n - bsearch - ' - ` - DOC_MODULES=`echo $DOC_MODULES` - DOC_MODULES_HTML=`for i in $DOC_MODULES; do echo ${i}.html; done` - DOC_MODULES_HTML=`echo $DOC_MODULES_HTML` - # extract man page section names - DOC_SECTIONS=`cat doc/fvwm/sections` - DOC_SECTIONS=`echo $DOC_SECTIONS` - DOC_SECTIONS_XML=`for i in $DOC_SECTIONS; do echo ${i}.xml; done` - DOC_SECTIONS_XML=`echo $DOC_SECTIONS_XML` - DOC_SECTIONS_XML_PATH=`for i in $DOC_SECTIONS; do echo ${i}.xml; done` - DOC_SECTIONS_XML_PATH=`echo $DOC_SECTIONS_XML` -else - DOC_COMMANDS="" - DOC_COMMANDS_XML="" - DOC_COMMANDS_XML_PATH="" - DOC_COMMANDS_HTML="" - DOC_MODULES="" - DOC_MODULES_HTML="" - DOC_SECTIONS="" - DOC_SECTIONS_XML="" - DOC_SECTIONS_XML_PATH="" -fi -AC_SUBST(DOC_COMMANDS) -AC_SUBST(DOC_COMMANDS_XML) -AC_SUBST(DOC_COMMANDS_XML_PATH) -AC_SUBST(DOC_COMMANDS_HTML) -AC_SUBST(DOC_MODULES) -AC_SUBST(DOC_MODULES_HTML) -AC_SUBST(DOC_SECTIONS) -AC_SUBST(DOC_SECTIONS_XML) -AC_SUBST(DOC_SECTIONS_XML_PATH) - PKG_CHECK_MODULES([xt],[xt], [], [ @@ -397,7 +309,8 @@ PKG_CHECK_MODULES([xt],[xt], ]) problem_mandoc="" -AC_CHECK_PROG(XSLTPROC, xsltproc, xsltproc, "") +AC_CHECK_PROG(ASCIIDOC, asciidoctor, asciidoctor, "") +AC_SUBST(ASCIIDOC) AC_ARG_ENABLE(mandoc, AS_HELP_STRING([--disable-mandoc], @@ -412,9 +325,9 @@ AC_ARG_ENABLE(mandoc, ) if test ! x"$with_mandoc" = xno; then - if test x"$XSLTPROC" = x ; then + if test x"$ASCIIDOC" = x ; then with_mandoc="no" - problem_mandoc=": No xsltproc found in PATH" + problem_mandoc=": No asciidoctor found in PATH" elif test x"$SED" = x ; then with_mandoc="no" problem_mandoc=": No sed found in PATH" @@ -427,36 +340,6 @@ if test ! x"$with_mandoc" = xno; then fi AM_CONDITIONAL([FVWM_BUILD_MANDOC], [test x"$with_mandoc" = xyes]) - -problem_htmldoc="" -AC_ARG_ENABLE(htmldoc, - AS_HELP_STRING([--enable-htmldoc],[enable generation of HTML documentation]), - [ if test x"$enableval" = xyes; then - with_htmldoc="yes, check" - else - with_htmldoc="no" - problem_htmldoc=": Explicitly disabled" - fi ], - [ with_htmldoc="no" ] -) - -if test ! x"$with_htmldoc" = xno; then - if test x"$XSLTPROC" = x ; then - with_htmldoc="no" - problem_htmldoc=": No xsltproc found in PATH" - elif test x"$SED" = x ; then - with_htmldoc="no" - problem_htmldoc=": No sed found in PATH" - elif test x"$HAVE_PERL_FOR_DOCS" = x0 ; then - with_htmldoc="no" - problem_htmldoc=": No perl found in PATH" - else - with_htmldoc="yes" - fi -fi -AM_CONDITIONAL([FVWM_BUILD_HTMLDOC], [test x"$with_htmldoc" = xyes]) - - # ********* session management # Check the availability of SM; we don't have to add any extra libraries, # since -lSM -lICE are in X_PRE_LIBS when they exist. @@ -1610,27 +1493,9 @@ AC_OUTPUT( fvwm/Makefile modules/Makefile dnl - bin/fvwm-config.1 - bin/fvwm-convert-2.6.1 - bin/fvwm-menu-desktop.1 dnl bin/fvwm-menu-directory.1 dnl bin/fvwm-menu-xlock.1 dnl bin/fvwm-perllib.1 - bin/fvwm-root.1 - modules/FvwmAnimate/FvwmAnimate.1 - modules/FvwmAuto/FvwmAuto.1 - modules/FvwmBacker/FvwmBacker.1 - modules/FvwmButtons/FvwmButtons.1 - modules/FvwmConsole/FvwmConsole.1 - modules/FvwmConsole/FvwmConsoleC.pl.1 - modules/FvwmEvent/FvwmEvent.1 - modules/FvwmForm/FvwmForm.1 - modules/FvwmIconMan/FvwmIconMan.1 - modules/FvwmIdent/FvwmIdent.1 - modules/FvwmMFL/FvwmMFL.1 - modules/FvwmPager/FvwmPager.1 - modules/FvwmRearrange/FvwmRearrange.1 - modules/FvwmScript/FvwmScript.1 dnl bin/Makefile bin/FvwmPrompt/Makefile @@ -1649,22 +1514,7 @@ dnl perllib/FVWM/Tracker/Makefile perllib/FVWM/Module.pm default-config/Makefile - doc/fvwm3.ent - doc/footer.html doc/Makefile - doc/fvwm/Makefile - doc/commands/Makefile - doc/docbook-xml/Makefile - doc/docbook-xml/ent/Makefile - doc/docbook-xsl/Makefile - doc/docbook-xsl/common/Makefile - doc/docbook-xsl/manpages/Makefile - doc/docbook-xsl/profiling/Makefile - doc/docbook-xsl/highlighting/Makefile - doc/docbook-xsl/lib/Makefile - doc/docbook-xsl/html/Makefile - doc/images/Makefile - doc/images/svg_rendering/Makefile dev-docs/Makefile po/Makefile dnl @@ -1747,7 +1597,6 @@ Fvwm3 Configuration: With Xrender image support? $with_xrender$problem_xrender With Golang support? $with_golang$problem_golang Build man pages? $with_mandoc$problem_mandoc - Build HTML documentation? $with_htmldoc$problem_htmldoc " case "$ac_cv_dmalloc" in diff --git a/dev-docs/INSTALL.md b/dev-docs/INSTALL.md index 37e30c538..d2dbbbce5 100644 --- a/dev-docs/INSTALL.md +++ b/dev-docs/INSTALL.md @@ -28,6 +28,7 @@ FVWM3 has the following dependencies. ## Optional dependencies +* asciidoctor * libfontconfig-dev * libfreetype6-dev * libfribidi-dev @@ -43,7 +44,16 @@ FVWM3 has the following dependencies. * libxi-dev * libxpm-dev * sharutils -* xsltproc + +Generating documentation +======================== + +To generate `fvwm3`'s documentation: + +1. Install `asciidoctor` +2. Pass `--enable-mandoc` to `./configure` (see below( + +`fvwm3` won't compile documentation by default, so it's opt-in. Installing From Git =================== diff --git a/doc/Makefile.am b/doc/Makefile.am index 8126727f0..88d654048 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,21 +1,35 @@ -# Author: Scott Smedley - docdir = @FVWM_DOCDIR@ +MODULE_ADOCS = $(wildcard fvwm3/fvwm3.adoc bin/*.adoc modules/*.adoc) -HTML_FILES = \ - index.html allCommands.html groupedCommands.html modules.html style.css -EXTRA_DIST = \ - fvwm3.xsl fvwm3-man.xsl header.html $(HTML_FILES) - -if FVWM_BUILD_HTMLDOC -doc_DATA = \ - $(HTML_FILES) -endif +man_MANS = $(patsubst %.adoc,%.1, $(MODULE_ADOCS)) +EXTRA_DISTS = $(man_MANS) if FVWM_BUILD_MANDOC -SUBDIRS = commands images docbook-xml docbook-xsl fvwm +BUILD_MANS = $(man_MANS) else -SUBDIRS = commands images docbook-xml docbook-xsl +BUILD_MANS = endif -all: $(doc_DATA) +all: docs +docs: $(BUILD_MANS) + +clean: + rm -f $(BUILD_MANS) + +distclean-local: clean + +if FVWM_BUILD_MANDOC +QUIET_ASCIIDOC = @echo ' ' DOC ' ' $@; + +%.1: %.adoc + $(QUIET_ASCIIDOC)$(ASCIIDOC) -b manpage $< -o $@ + +install-data-local: + install -d -m 755 $(DESTDIR)$(mandir)/man1/ + install -m 644 $(BUILD_MANS) $(DESTDIR)$(mandir)/man1/ + +uninstall-local: + @for i in $(notdir $(BUILD_MANS)); do \ + rm -f "$(DESTDIR)$(mandir)/man1/$$i"; \ + done +endif diff --git a/doc/README b/doc/README index 90d6cc5c1..85d7cceb8 100644 --- a/doc/README +++ b/doc/README @@ -1,130 +1,20 @@ -# Author: Scott Smedley +Fvwm3 Documentation +=================== -This directory contains fvwm XML documentation. It can output an -fvwm3.1 man page & a plethora of HTML files - all from the same (XML) -source. +The old docbook formatted files have been replaced in favour of using +`asciidoc` -- specifically via `asciidoctor` (https://asciidoctor.org). +Unlike previous efforts, `asciidoctor` is now used to generate every man page +-- including modules. -By default the documentation is not generated. If you want to -generate the man page, use: +For more information about the specific markup available, see: - $ ./configure --enable-mandoc +* https://asciidoctor.org/docs/asciidoc-writers-guide/ +* https://asciidoctor.org/docs/user-manual/ -If you want to generate the HTML documentation, use: +To add additional documents, see: - $ ./configure --enable-htmldoc + doc/fvwm3/*.adoc + doc/modules/*.adoc -Once the HTML documentation is built and installed, you should be able -to point your web browser to: - - file:///usr/local/share/doc/fvwm/index.html - -(Change "/usr/local" if you use ./configure --prefix="...".) - -For developers, the XML source files supersede the old fvwm man -page. Please make any documentation changes here & NOT in the -fvwm/fvwm.1.in file. - -If you are editing the documentation for an fvwm command, you will -find an XML file relating to that command in the doc/command/ -directory. Any other documentation changes (e.g. general -description) will most likely need to be made in the doc/fvwm -directory. - -The XML syntax is intuitive - a cursory inspection of a few XML -files should suffice to allow even a novice user to make their -changes. However, there are a few idiosyncrasies worth pointing -out: - -Formatting instructions -======================= - -* The name fvwm is spelled "fvwm". At the beginning of a sentence - or in other places where nouns are capitalized: "Fvwm". It's - *never* spelled "FVWM". - -* Use when referring to an fvwm - command, e.g.: - - - - This will create a link to the Style command (in HTML output). - Caveat: don't use to reference commands that are - actually being described. ie. In the Style.xml file, you won't - see any s to the Style command. - -* Use when _referring_ to an - fvwm command option, e.g.: - - when _describing_ an - option to a command, e.g.: - - - - This will highlight the option name & allow the option to be - referenced elsewhere. - -* Use when referring to an fvwm module, e.g.: - - - - This will create a link to the FvwmPager module (in HTML - output). - -* Use when - refering to a different section. - - - -* Use <... output="html"> to wrap text that should only appear in - HTML output. E.g. - - This text only appears in HTML. - -* Use <... output="man"> to wrap text that should only only appear - in man-page output, e.g. - - This text only appears in man page. - -* Use for filenames. - -* Use for environment variables. - -* Use for links to web pages. - -* Use for acronyms. - -* Use for key names. - - -How to add documentation for a new fvwm command -=============================================== - -1. Copy a similar command, e.g. - - $ cd doc/commands && cp Echo.xml EchoFuncDefinition.xml - -2. Edit contents appropriately. Make sure the section id, title - and cmdsynopsis are correct. - -3. Ensure the new command appears in the appropriate section of the - man page, e.g. this line is included in fvwm/userFunctions.xml: - - - -4. Add the new command to groupedCommands.html. - -5. Add the new command to allCommands.html - this content is - auto-generated by a script in the util/ subdirectory. First - add the command name to the alphabetically sorted util/cmds.txt - file, then run: - - $ cd doc/util - $ ./genAllCommands.pl cmds.txt - -7. Add a ChangeLog entry to doc/ChangeLog. +Documentation for modules now resides under `doc/`, rather than its own +module. diff --git a/doc/allCommands.html b/doc/allCommands.html deleted file mode 100644 index 71e1fd584..000000000 --- a/doc/allCommands.html +++ /dev/null @@ -1,331 +0,0 @@ - - -Fvwm: All Commands - - - - - - - - - - - - - -
- Home ⋅ - All Commands ⋅ - Grouped Commands ⋅ - Modules ⋅ - FAQ -
- - -

Allfvwm   Commands

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
A AddButtonStyleD DefaultColorsH HideGeometryWindowQ QuitT TearMenuOff
AddTitleStyleDefaultColorsetHilightColorQuitScreenTest
AddToDecorDefaultFontHilightColorsetQuitSessionTestRc
AddToFuncDefaultIconI IconFontR RaiseThisWindow
AddToMenuDefaultLayersIconifyRaiseLowerTitle
AllDeleteIconPathReadTitleStyle
AnimatedMoveDescheduleIgnoreModifiersU UnsetEnv
AnyDeskImagePathUpdateDecor
AsteriskDesktopNameDesktopConfigurationK KeyRefreshUpdateStyles
B BeepDesktopSizeKeepRcRefreshWindowStatusW Wait
BorderStyleDestroyKillModuleRepeatWarpToWindow
BreakDestroyDecorL LayerResizeWindowFont
BugOptsDestroyFuncLocalePathResizeMaximizeWindowId
BusyCursorDestroyMenuLowerResizeMoveWindowList
ButtonStateDestroyMenuStyleM MaximizeResizeMoveMaximizeWindowsDesk
ButtonStyleDestroyModuleConfigMenuRestackTransientsWindowShade
C ChangeDecorDestroyStyleMenuStyleRestartWindowShadeAnimate
ChangeMenuStyleDestroyWindowStyleModuleS SaveQuitSessionWindowStyle
CleanupColorsetsDirectionModuleListenOnlySaveSession
ClickTimeE EchoModulePathScanForWindow
CloseEchoFuncDefinitionModuleSynchronousSchedule
ColorLimitEdgeCommandModuleTimeoutScroll
ColormapFocusEdgeLeaveCommandMouseSendToModule
ColorsetEdgeResistanceMoveSetAnimationXorPixmap
CopyMenuStyleEdgeScrollMoveThresholdSetEnvXorValue
CurrentEdgeThicknessMoveToDeskShellCmdXSync
CursorMoveEmulateMoveToPageSilentXSynchronize
CursorStyleEscapeFuncMoveToScreenSnapAttraction
EwmhBaseStrutsN NextSnapGrid
EwmhNumberOfDesktopsNoneState
ExecNopStick
ExecUseShellNoWindowStickAcrossDesks
F FakeClickO OpaqueMoveSizeStickAcrossPages
FakeKeypressP Pick
FlipFocusPipeRead
FocusPixmapPathStyle
FocusStylePlaceAgain
FunctionPointerKey
G GlobalOptsPointerWindow
GotoDeskPrintInfo
GotoDeskAndPage
GotoPage
- -

Note: Some commands are obsolete.

- - - - - - -
???
fvwm 2.5.x
diff --git a/doc/bin/fvwm-config-2.6.adoc b/doc/bin/fvwm-config-2.6.adoc new file mode 100644 index 000000000..82636a4dc --- /dev/null +++ b/doc/bin/fvwm-config-2.6.adoc @@ -0,0 +1,89 @@ += fvwm-convert-2.6(1) + +== NAME + +fvwm-convert-2.6 - convert fvwm 2.4.x configuration file to fvwm 2.6 style + +== SYNOPSIS + +*fvwm-convert-2.6* [__--follow-read__|_-f_] [__--help__|_-h_] source +[_dest_] + +== OPTIONS + +The following options are supported: + +--help | -h:: + Prints a usage message to the screen. +--follow-read | -f:: + Follows files found along with the *Read* command. + +== DESCRIPTION + +*fvwm-convert-2.6* converts an fvwm 2.4.x configuration file into a fvwm +2.6 file with compatible syntax. It is not suitable to convert older 2.x +configuration files. Please use *fvwm-convert-2.2* to convert these to +the 2.2.x format first, and then if necessary *fvwm-convert-2.4* + +By default, *fvwm-convert-2.6* won't look for a given config file. This +must be specified as the first parameter to *fvwm-convert-2.6.* +Different source and destination files may be given. If the destination +file already exists, this program exits. If no destination file is +given, then the filename is the same name as the source file with the +suffix ".converted" added. Without an absolute path given as the +destination path to the destination file, the program will create the +destination file in the CWD. + +*fvwm-convert-2.6* makes the following changes: + +*Style lines*:: + In fvwm 2.4, most style options could be negated from their + counterparts using NoFoo -- fvwm-convert-2.6 corrects this by now + using !Foo. +*ModulePath*:: + In fvwm 2.4 and beyond, the ModulePath is compiled into fvwm. + *fvwm-convert-2.6* comments out any ModulePath commands it finds. If + you are using your own modules, (not the ones that come with fvwm), + you will have to fix your configuration file after using + *fvwm-convert-2.6*. +*Conditional command syntax*:: + In fvwm 2.4, the conditional command options were whitespace-separated + -- they should now be comma-separated instead. In addition, the older + syntax to Next and Prev of using [*] to denote all windows has been + removed entirely. Both these checks and conversions are done on + function commands, key/mouse bindings. +*WindowShadeSteps*:: + In fvwm 2.4, the WindowShadeSteps command is replaced by the + WindowShadeSteps Style option. *fvwm-convert-2.6* makes this change. +*FvwmTheme*:: + In fvwm 2.6, the FvwmTheme module is replaced by a series of Colorset + commands. Whilst *fvwm-convert-2.6* will try and make this change, it + is still recommended that this is checked after conversion. +*EdgeResistance*:: + In fvwm 2.6, the EdgeResistance command is has been split to include + an additional style option for EdgeMoveResistance. *fvwm-convert-2.6* + makes any changes necessary. +*StartFunction / RestartFunction / InitFunction*:: + In fvwm 2.6, the need for using InitFunction and/or RestartFunction is + redundant when StartFunction is read at both of these times. + *fvwm-convert-2.6* attempts to convert this. +*Read*:: + If *-f* or *--follow-read* is given, any files *fvwm-convert-2.6* can + detect and open will be converted automatically, else a list of files + that can be followed are printed to the screen. + +== BUGS + +_InitFunction_ and _RestartFunction_ and hence _StartFunction_ are +printed at the end of the files -- this slight reordering might put some +comments before in an odd spot. + +When converting over FvwmTheme lines, the colorset definitions might +well be broken, but these cannot easily be converted. + +Bug reports can be sent to the fvwm-workers mailing list (see the +_FAQ_). + +== AUTHOR + +Thomas Adam diff --git a/doc/bin/fvwm-config.adoc b/doc/bin/fvwm-config.adoc new file mode 100644 index 000000000..6d5c0393d --- /dev/null +++ b/doc/bin/fvwm-config.adoc @@ -0,0 +1,96 @@ += fvwm-config(1) + +== NAME + +fvwm-config - query an existing fvwm installation + +== SYNOPSIS + +*fvwm-config* [_--help_] [_--version_] [_--info_] [_--prefix_] +[_--exec-prefix_] [_--bindir_] [_--datadir_] [_--libexecdir_] +[_--sysconfdir_] [_--mandir_] [_--localedir_] [_--fvwm-moduledir_] +[_--fvwm-datadir_] [_--fvwm-perllibdir_] [_--default-imagepath_] +[_--default-userdir_] [_--fvwm-exe_] [_--supports_] +[_--supports-_] + +== DESCRIPTION + +*fvwm-config* is a shell script that provides an information about the +fvwm version, installation directories, built-in paths and supported +features. + +== OPTIONS + +*fvwm-config* prints to the standard output in all options. Both short +and long GNU-like option names may be used. + +*-h --help -?*:: + prints the short usage +*-v --version -V*:: + prints the version +*-i --info*:: + prints the full info page +*-P --prefix*:: + prints the installation prefix +*-E --exec-prefix*:: + prints the installation exec-prefix +*-B --bindir*:: + prints the installation bindir +*-D --datadir*:: + prints the installation datadir +*-L --libexecdir*:: + prints the installation libexecdir +*-S --sysconfdir*:: + prints the installation sysconfdir +*-M --mandir*:: + prints the installation mandir +*-O --localedir*:: + prints the installation localedir +*-m --fvwm-moduledir*:: + prints FVWM_MODULEDIR, where the modules are installed +*-d --fvwm-datadir*:: + prints FVWM_DATADIR, where the system wide configs are installed +*-p --fvwm-perllibdir*:: + prints FVWM_PERLLIBDIR, where the perl library is installed +*-I --default-imagepath*:: + prints the built-in ImagePath +*-U --default-userdir*:: + prints the default FVWM_USERDIR, note: $HOME is not expanded +*-e --fvwm-exe*:: + prints the fvwm executable name (in bindir) +*-s --supports*:: + lists all supported features, one per line +**--supports-**____:: + prints nothing, returns: 0 if the __ is supported, 100 if + not, 200 if unknown. All or supported feature names may be found using + _--info_ or _--supports_ respectively. + +== USAGE + +Here are some real life usages. + +Checks for xft support: if fvwm-config --supports-xft; then echo 1; else +echo 0; fi + +_fvwm-themes_ package checks for the correct _fvwm_ version installed +using: fvwm-config --version + +and tries to use the same installation directories: fvwm-config --bindir +--mandir --fvwm-datadir + +A way to find the full path to the fvwm executable: echo `fvwm-config +--bindir`/`fvwm-config --fvwm-exe` + +A way to start modules in perl: use lib `fvwm-config -p | tr -d '`; use +FVWM::Module; + +For a more human readable output, try: fvwm-config --info + +== COPYING + +*fvwm-config* is a part of fvwm package and distributed by the same +terms, see GNU GPL. + +== AUTHOR + +Mikhael Goikhman diff --git a/doc/bin/fvwm-menu-desktop.adoc b/doc/bin/fvwm-menu-desktop.adoc new file mode 100644 index 000000000..6b2c879d7 --- /dev/null +++ b/doc/bin/fvwm-menu-desktop.adoc @@ -0,0 +1,383 @@ += fvwm-menu-desktop(1) + +== NAME + +fvwm-menu-desktop - Reads XDG menu files and creates Fvwm menus + +== SYNOPSIS + +fvwm-menu-desktop [ **--help**|*-h* ] [ *--version* ] [ +*--install-prefix* _DIR_ ] [ *--desktop* _NAME_ ] [ *--menu-type* _NAME_ +] [ *--theme* _NAME_ ] [ **--with-titles**|*-w* ] [ *--without-titles* ] +[ *--enable-mini-icons* ] [ **--size**|*-s* _NUM_ ] [ *--mini-icon-dir* +_DIR_ ] [ *--app-icon* _NAME_ ] [ *--dir-icon* _NAME_ ] [ +**--title**|*-t* _NAME_ ] [ *--insert-in-menu* _NAME_ ] [ *--get-menus* +__all__|_desktop_ ] [ *--set-menus* _menu_paths_ ] [ *--all-menus* ] [ +*--include-items* _NAME_ ] [ *--regen-cmd* _CMD_ ] [ *--term-cmd* _CMD_ +] [ *--dynamic* ] [ **--menu-error**|*-e* ] [ **--verbose**|*-v* ] + +== DESCRIPTION + +This is a python script which parses XDG menus definitions to build +corresponding fvwm menus. This script depends on python-xdg to run. + +== OPTIONS + +Main Options:: +--help:: + Show the help and exit. +--version:: + Show the version and exit. +--get-menus all|desktop:: + Prints a space separated list of full menu paths found on the system. + _all_ will print all menus found on the system except empty ones. + _desktop_ will print the menu(s) that would be generated by the + script. + +No menu generation is done. + +--desktop NAME:: + Optional parameter to set the _NAME_ of the desktop XDG .menu file(s) + to use. This option will override any default menus set via + *FvwmForm-XDGMenu-Config* and cause the script to find menus in which + _NAME_ is a part of the file name. Possible names are: _gnome_, _kde_, + _xfce_, _lxde_, _debian_, etc. + +This option can be used in conjunction with *--menu-type* to control +which .menu file(s) are used. + +--menu-type NAME:: + Optional parameter to set the _NAME_ of the XDG menu type to use. This + option will override any default menus set via + *FvwmForm-XDGMenu-Config* and cause the script to find menus in which + _NAME_ is a part of the file name. Possible _NAME_ types could be: + _applications_, _settings_, _preferences_, etc. + +When used in conjunction with *--desktop*, only menus whose file name +matches '*destkop*menutype*' are found. If no menus are found, the +script exits with an error. + +--all-menus:: + This option will build all menus found on the system. If used in + conjunction with *--desktop* or *--menu-type* this will build all + menus matching those settings. +--install-prefix DIR:: + Optional parameter to override the standard locations for XDG menu + definitions. Tells *fvwm-menu-desktop* to look in _DIR_ for .menu + files instead of the standard locations /etc/xdg/menus (and + $HOME/.config/menus if it exists). +--with-titles|-w:: + If this option is set menus are generated with titles. This is the + default. This option can be used to override the + *FvwmForm-XDGMenu-Config* default setting. +--without-titles:: + If this option is set menus are generated without titles. The default + is to generate with titles. +--title|-t NAME :: + Option to define the menu title _NAME_ of the top menu used by Fvwm's + *Menu* or *Popup* commands. Default is "XDGMenu". +--include-items NAME :: + This option controls if the additional menu items 'Regenerate' and + 'Configure' are included in the top level menu. _NAME_ can be one of + _regenerate_, _config_, _both_, or _none_. The default is _both_. +--regen-cmd CMD :: + This option sets the fvwm command _CMD_ that is run when the menu item + 'Regenerate' is selected. The default is "PipeRead + `fvwm-menu-desktop`". +--term-cmd CMD :: + This option sets the terminal emulator command _CMD_ that is used to + to run terminal applications in. _CMD_ needs to end with an execute + option, such as xterm's -e option, which will run the command that is + appended to _CMD_. The default is "xterm -e". +--dynamic :: + This option is to be used with creating dynamic menus using + *DynamicPopUpAction* and *DynamicPopDownAction*. This adds a + 'recreate' to the *DestroyMenu* command on the top level menu so those + actions are not Destroyed when the menu is regenerated. +--insert-in-menu NAME:: + Option to insert generated menu(s) *IN* a menu _NAME_ (its top title). + This option makes it so the top level menu is not Destroyed and the + items are added to the end. + +Note menus regenerated with this option will append the menu items at +the end of the existing menu. Each time the menu is regenerated new menu +items appear giving a growing menu of duplicate items. You have to +regenerate the whole menu via a function or restart fvwm. See *EXAMPLES* +below for some solutions. + +--set-menus menu_paths:: + Generates all menus listed in a space separated list of full menu + paths. This option overrides any defaults and + **--desktop**|*--menu-type* settings. +--menu-error |-t:: + If this option is present and python-xdg is not found, the script will + print the error in the generated menu. Used in the default-config. +--verbose:: + Enables additional information printouts on STDERR. +Icons Options:: + By default, fvwm-menu-desktop builds menus without mini-icons. To + enable mini-icons use the following options. + +If ImageMagick is installed on the system, the script will resize and +copy the icons to $FVWM_USERDIR/.icons. This can take awhile. You should +be prepared to wait the first time you generate the icons. Once the +icons have been generated the script should run faster. If it is still +to slow using icons, see *EXAMPLES* for ways to limit how often the menu +is generated to speed things up. + +--enable-mini-icons:: + This option enables mini-icons in the menus. If set, 24x24 mini-icons + are used. If the specified icon isn't that size it will be converted + if *ImageMagick* is installed and saved in $HOME/.fvwm/icons or to the + directory specified with --mini-icon-dir option. Otherwise no icon + appears in the menu for that entry. With most distributions, all the + menu entries will have mini-icons appropriate to the application. +--theme NAME:: + Defines the used icon theme. Default is _gnome_ but all others found + in /usr/share/icons could be used except the _hicolor_ theme because + it's the default fallback theme if no icon is found. +--size|-s NUM:: + If --enable-mini-icons is used the _size_ of the icons can changed + with this parameter. Default is 24. +--mini-icon-dir DIR:: + When the right size mini-icon isn't available, fvwm-menu-desktop + creates icons with the right size in $HOME/.fvwm/icons. If you don't + want to use the default directory, $HOME/.fvwm/icons, use this option + to specify a different folder. +--app-icon NAME:: + Sets the default application icon if no others are found. Default is + 'gnome-applications'. +--dir-icon NAME:: + Sets the default directory icon if no others are found. Default is + 'gnome-fs-directory'. + +== USAGE + +*fvwm-menu-desktop* outputs XDG .menu files in the syntax of fvwm menus. +When *fvwm-menu-desktop* is run with no options, it will load defaults +from the *FvwmForm-XDGMenu-Config* file (see below) then search your +system for suitable menu file(s). To see which menus are available on +your system run: + +.... +fvwm-menu-desktop --get-menus all +.... + +If no menus are found you may not have any installed on your system. By +default menus are stored as *.menu files in /etc/xdg/menus, +$HOME/.config/menus or the location set in $XDG_MENU_PREFIX. You can use +*--install-prefix* to specify another location search for menus. + +Though a combination of command line options and the +*FvwmForm-XDGMenu-Config* settings, *fvwm-menu-desktop* can generate any +combination of the menus found. To get a list of what menu(s) would be +generated use the *--get-menus* _desktop_ option. The following will +list all menus generated if *fvwm-menu-desktop* was run with no options. + +.... +fvwm-menu-desktop --get-menus desktop +.... + +*fvwm-menu-desktop* determines which menu(s) to generate as follows + +If no config file is found, all menus will be weighted and the script +will generate the best (highest weight) menu found. + +If a config file is found (and override options are not used) the script +will generate all menus selected in *FvwmForm-XDGMenu-Config*. + +*--desktop*, *--menu-type*, *--set-menus* and *--all-menus* will +override any menus selected in *FvwmForm-XDGMenu-Config*. + +*--desktop* and *--menu-type* will only include menus whose name matches +'*desktop*menutype*'. If used with *--all-menus*, all matching menus are +generated. If used without *--all-menus*, only the highest weighted menu +is generated. + +*--set-menus* generates menus from the list of full path menu file +names. + +*--all-menus* by itself will generate all menus found. + +By default *fvwm-menu-desktop* will generate a menu whose top level name +is "XDGMenu". To tell fvwm to read the output of *fvwm-menu-desktop* to +create the menu XDGMenu add the following to your fvwm config file: + +.... +PipeRead 'fvwm-menu-desktop' +.... + +*Warning:* Depending on the options used this command may be slow and +fvwm will pause until this command is complete. See *EXAMPLES* below for +more details and possible workarounds. + +Once the menu is generated you can open the menu by using the command +"Menu XDGMenu". You can also include this in the MenuFvwmRoot menu by: + +.... +AddToMenu MenuFvwmRoot "XDG Menu" Popup XDGMenu +.... + +*fvwm-menu-desktop* can be configured though both command line options +and a *FvwmForm* GUI to customize the menu(s) that get generated. + +== GUI + +*FvwmForm-XDGMenu-Config* is a *FvwmForm* interface that can be used to +configure the defaults for *fvwm-menu-desktop*. You can access this from +the "Configure" item in the top level menu that is generated or run the +following from within *FvwmConsole* + +.... +Module FvwmPerl -l fvwm-menu-desktop-config.fpl +.... + +This form can be used to select which menu(s) get generated by default +along with setting many (but not all) of the available options. When you +click "Save Settings" the form will write a config file located at +$FVWM_USERDIR/.FvwmForm-XDGMenu-Config that *fvwm-menu-desktop* will +parse for defaults when run. + +See the help inside of *FvwmForm-XDGMenu-Config* for more information. + +== EXAMPLES + +There are many ways to setup when fvwm runs *fvwm-menu-desktop* to +generate the menu. One method is to just generate the menu when fvwm +loads and then use the GUI config tool to change any options. To do this +you only need to add the following to the fvwm config file: + +.... +AddToMenu MenuFvwmRoot "XDG Menu" Popup XDGMenu PipeRead +'fvwm-menu-desktop' +.... + +The menu is created once when fvwm loads. Since menu creation can +sometimes be slow, this could cause fvwm to take longer to load than one +wants. + +The menu is only generated when fvwm starts. If software is installed or +removed you will have to select the 'Regenerate' option to rebuild the +menu. + +One way to speed things up is to save the menu in a file and only +generate the menu when 'Regenerate' is selected. To do this use +*--regen-cmd* to call a custom function and write the menu to a file +using a command like + +.... +fvwm-menu-desktop --regen-cmd XDGRegen > $FVWM_USERDIR/.XDGMenu +.... + +Then add the following to the fvwm config file to define the function +XDGRegen. The second to last line will generate the menu if the menu +file doesn't exist when fvwm starts. + +.... +DestroyFunc XDGRegen +AddToFunc XDGRegen ++ I PipeRead 'fvwm-menu-desktop --regen-cmd XDGRegen > \ + $[FVWM_USERDIR]/.XDGMenu; echo "Nop"' ++ I Read $[FVWM_USERDIR]/.XDGMenu + +Test (!f $[FVWM_USERDIR]/.XDGMenu) XDGRegen Read $[FVWM_USERDIR]/.XDGMenu +.... + +Besides creating a top level menu, *fvwm-menu-desktop* can insert the +menu into an existing menu using the *--insert-in-menu* option. For +example one could create the menu MenuFvwmRoot and include the XDG items +at the end. + +.... +DestroyMenu MenuFvwmRoot +AddToMenu MenuFvwmRoot "Fvwm" Title ++ "Item1" Action1 ... ++ "ItemN" ActionN ++ "" Nop + +PipeRead 'fvwm-menu-desktop --insert-in-menu MenuFvwmRoot' +.... + +In this case the menu items are inserted at the end of the MenuFvwmRoot +menu. If no items are in the menu, this menu becomes MenuFvwmRoot. The +problem here is, that you have to restart fvwm or rebuild the whole menu +to Regenerate it because menu items cannot be removed. To do this you +could use a function like + +.... +DestroyFunc XDGRegen +AddToFunc XDGRegen ++ I DestroyMenu MenuFvwmRoot ++ I AddToMenu MenuFvwmRoot "Fvwm" Title ++ I AddToMenu MenuFvwmRoot "Item1" Action1 ... ++ I AddToMenu MenuFvwmRoot "ItemN" ActionN ++ I AddToMenu MenuFvwmRoot "" Nop ++ I PipeRead 'fvwm-menu-desktop --insert-in-menu MenuFvwmRoot \ + --regen-cmd XDGRegen' +.... + +Fvwm can also create menus dynamically by using *DynamicPopUpAction* +and/or *DynamicPopDownAction*. These commands when used with a Menu will +run a Function when the menu is opened. For example one could create the +menu XDGMenu when it is opened using + +.... +AddToMenu XDGMenu "XDGMenu" Title ++ DynamicPopUpAction PipeRead 'fvwm-menu-desktop' +.... + +This will create the menu when it is opened. One issue here is it will +only create the menu the first time it is opened, and you still have to +Regenerate the menu to see any changes. To create the menu each time it +is open used the *--dynamic* option + +.... +AddToMenu XDGMenu "XDGMenu" Title ++ DynamicPopUpAction PipeRead 'fvwm-menu-desktop \ + --dynamic --include-items config' ++ DynamicPopDownAction DestroyMenu recreate XDGMenu +.... + +This will now Destroy the menu when it closed so it can be rebuilt the +next time it is opened. The recreate flag doesn't completely destroy the +menu keeping the DynamicPopUpAction and DynamicPopDownAction actions. +The *--dynamic* flag includes the recreate option in the generated +menus. + +To insert a menu into MenuFvwmRoot and still be dynamic you need to use +a function that generates the whole menu. For example + +.... +DestroyFunc GenRootMenu +AddToFunc GenRootMenu ++ I DestroyMenu recreate MenuFvwmRoot ++ I AddToMenu MenuFvwmRoot "Fvwm" Title ++ I AddToMenu MenuFvwmRoot "Item1" Action1 ... ++ I AddToMenu MenuFvwmRoot "ItemN" ActionN ++ I AddToMenu MenuFvwmRoot "" Nop ++ PipeRead `fvwm-menu-desktop --insert-in-menu MenuFvwmRoot \ + --include-items config` + +AddToMenu MenuFvwmRoot "Fvwm" Title ++ DynamicPopUpAction GenRootMenu ++ DynamicPopDownAction DestroyMenu recreate MenuFvwmRoot +.... + +== BUGS + +The whole process of creating menus from files is slow. Otherwise report +bugs to the fvwm-workers mailing list . + +== AUTHORS + +This script is based on fvwm-xdg-menu.py written by Piotr Zielinski +(http://www.cl.cam.ac.uk/~pz215/) who assigned Licence: GPL 2 Date: +03.12.2005. + +The script was reworked to replace the existing fvwm-menu-desktop perl +script by the fvwm-workers. + +== COPYING + +The script is distributed by the same terms as fvwm itself. See GNU +General Public License for details. diff --git a/doc/bin/fvwm-root.adoc b/doc/bin/fvwm-root.adoc new file mode 100644 index 000000000..bf1b7916f --- /dev/null +++ b/doc/bin/fvwm-root.adoc @@ -0,0 +1,92 @@ += fvwm-root(1) + +== NAME + +fvwm-root - Sets the root window of the current X display to image + +== SYNOPSIS + +*fvwm-root* [**--retain-pixmap**|*-r*] [*--no-retain-pixmap*] +[**--dummy**|*-d*] [*--no-dummy*] [*--dither*] [*--no-dither*] +[*--color-limit* [_ncolors_] ] [*--no-color-limit*] +[**--help**|**-h**|*-?*] [**--version**|*-V*] _image_file_ + +== DESCRIPTION + +_fvwm-root_ reads the image file specified in the command line and +displays it in the root window. The supported image formats are _XBM_, +_XPM_, _PNG_ and _SVG_ if appropriated libraries are compiled in. + +SVG rendering options (as described in the * ICONS AND IMAGES * section +of the main fvwm documentation) can be utilized. + +== OPTIONS + +These command line options are recognized by fvwm-root: + +*--retain-pixmap* | *-r*:: + Causes fvwm-root to retain and publish the Pixmap with which the + background has been set (the ESETROOT_PMAP_ID and _XROOTPMAP_ID + properties are used). This is useful for applications which want to + use the root Pixmap on the background to simulate transparency (for + example, Eterm and Aterm use this method). This option should also be + used for the RootTransparent colorset option, refer to the COLORSETS + section of fvwm(1). If this option is not used, fvwm-root sets the + _XSETROOT_ID property to None, and some programs, like fvwm modules, + may use this to update their background if the background is + transparent (Transparent colorset). ++ +Note, a well behaved program, like fvwm, should listen to both +_XSETROOT_ID and _XROOTPMAP_ID property changes and update itself +correspondingly. However some programs listen only to one of them, so +you should either use this option or not depending on what part is +implemented by these programs. You should also use this option to get +fast root-transparent menus in fvwm. + +*--no-retain-pixmap*:: + This is a default. May be useful to explicitly force the default even + if "--retain-pixmap" is specified earlier. +*--dummy* | *-d*:: + Causes fvwm-root NOT to set the background, but to only free a memory + associated with the ESETROOT_PMAP_ID property (if any). In any case + the _XSETROOT_ID property is set to None. +*--no-dummy*:: + This is a default. May be useful to explicitly force the default even + if "--dummy" is specified earlier. +*--dither*:: + Causes fvwm-root to dither images for "smoother" rendition on displays + with color depth of 16 or lower. This the default with color depth + less or equal to 8. +*--no-dither*:: + Causes fvwm-root NOT to dither images. This is the default with color + depth greater than 8. +**--color-limit **__ncolors__:: + Causes fvwm-root to limit its color use to _ncolors_ (if specified). + This option is taken in account only with color depth less or equal to + 8 (and a TrueColor or GrayScale visual). The default is to use the + same color limit as fvwm. So in normal situation this option is not + useful. However, if fvwm use a private colors map, as fvwm-root always + use the default colors map you should use this option for limiting + colors correctly. If _ncolors_ is not specified a default is used. +*--no-color-limit*:: + Causes fvwm-root NOT to limit its color use. +*--help*:: + Shows a short usage. +*--version*:: + Shows a version number. + +== COMPATIBILITY + +In the past this utility was called _xpmroot_. This name is still +supported as a symlink. + +== BUGS + +Repeated use of fvwm-root with different xpm pixmaps will use up slots +in your color table pretty darn fast. + +== AUTHOR + +Rob Nation + +Rewritten and enhanced by fvwm-workers. diff --git a/doc/commands/AddButtonStyle.xml b/doc/commands/AddButtonStyle.xml deleted file mode 100644 index 50d01da63..000000000 --- a/doc/commands/AddButtonStyle.xml +++ /dev/null @@ -1,111 +0,0 @@ - - -%myents; -]> - - - -
-AddButtonStyle - - - AddButtonStylebuttonstatestyle-- !flag - - -Adds a button style to -button. -button -can be a button number, or one of -"", -"" or -"". -state -can be -"", -"", -"" or -"", or -"" (the same as both "ActiveUp" and "ActiveDown") or -"" (the same as both "InactiveUp" and "InactiveDown") -or any of these 6 with -"" prepended. -The "Active" states apply to the focused window, the "Inactive" -ones apply to all other windows. The "Up" states apply to the -non pressed buttons, the "Down" ones apply to pressed buttons. -The "Toggled" prefix refers to maximized, shaded or sticky windows -that have the corresponding -MwmDecor... -button style set. -Additionally, the following shortcuts may be used: -"", -"", -"", -"", -"", -"". -They are actually different masks for 4 individual states from -8 total. These are supported too: -"", -"", -"", -"". - -If -state -is omitted, then the style is added to every state. If the -style and flags -are enclosed in parentheses, then multiple -state -definitions can be placed on a single line. -Flags -for additional button styles cannot be changed after definition. - -Buttons are drawn in the order of definition, beginning with the -most recent button style, followed by those added with -AddButtonStyle. -To clear the button style stack, change style flags, or for -descriptions of available styles and flags, see the - -command. Examples: - - - 1 Pixmap led.xpm -- Top Left - 1 ActiveDown HGradient 8 grey black - -- UseTitleStyle -AddButtonStyle 1 \ - ActiveUp (Pixmap a.xpm) \ - ActiveDown (Pixmap b.xpm -- Top) -AddButtonStyle 1 Vector 4 50x30@1 70x70@0 30x70@0 50x30@1 - - -Initially for this example all button states are set to a pixmap. -The second line replaces the "ActiveDown" state with a gradient -(it overrides the pixmap assigned to it in the line before, which -assigned the same style to every state). Then, the -UseTitleStyle -flag is set for all buttons, which causes fvwm to draw any styles -set with - -before drawing the buttons. Finally, -AddButtonStyle -is used to place additional pixmaps for both "ActiveUp" and -"ActiveDown" states and a vector button style is drawn on top of -all states. - -
diff --git a/doc/commands/AddTitleStyle.xml b/doc/commands/AddTitleStyle.xml deleted file mode 100644 index 58ba54ba0..000000000 --- a/doc/commands/AddTitleStyle.xml +++ /dev/null @@ -1,60 +0,0 @@ - - -%myents; -]> - - - -
-AddTitleStyle - - - AddTitleStylestatestyle-- !flag - - -Adds a title style to the title-bar. -state can be -"", -"", -"" or -"", or -"" (the same as both "ActiveUp" and "ActiveDown") or -"" (the same as both "InactiveUp" and "InactiveDown") -or any of these 6 with "Toggled" prepended. If -state -is omitted, then the style is added to every state. If the -style and flags -are enclosed in parentheses, then multiple -state -definitions can be placed on a single line. This command is quite -similar to the - -command. - -Title-bars are drawn in the order of definition, beginning with -the most recent -, -followed by those added with -AddTitleStyle. -To clear the title style stack, change style flags, or for the -descriptions of available styles and flags, see the - and - -commands. - -
diff --git a/doc/commands/AddToDecor.xml b/doc/commands/AddToDecor.xml deleted file mode 100644 index 6c86eece9..000000000 --- a/doc/commands/AddToDecor.xml +++ /dev/null @@ -1,96 +0,0 @@ - - -%myents; -]> - - - -
-AddToDecor - - - AddToDecordecor - - -This command is deprecated and will be removed in the future. There -are plans to replace it with a more flexible solution in fvwm-3.0. - -Add or divert commands to the decor named -decor. -A decor is a name given to the set of commands which affect button -styles, title-bar styles and border styles. If -decor -does not exist it is created; otherwise the existing -decor -is modified. Note: Earlier versions allowed to use the -, and -commands in decors. This is no longer possible. Please use the - -command with the -Hilight... and -options. - -New decors start out exactly like the "default" decor without any -style definitions. A given decor may be applied to a set of -windows with the - -option of the - -command. Modifying an existing decor affects all windows which -are currently assigned to it. - -AddToDecor -is similar in usage to the - and -commands, except that menus and functions are replaced by -, , , - and -commands. Decors created with -AddToDecor -can be manipulated with -, , -and the - -option. - -The following example creates a decor "FlatDecor" and style -"FlatStyle". They are distinct entities: - - -AddToDecor FlatDecor -+ All Active (-- flat) Inactive (-- flat) -+ -- flat -+ -- HiddenHandles NoInset - - FlatStyle \ - UseDecor FlatDecor, HandleWidth 4, ForeColor white, \ - BackColor grey40, HilightFore black, HilightBack grey70 - - xterm UseStyle FlatStyle - - -An existing window's decor may be reassigned with -. -A decor can be destroyed with -. - - - FlatDecor -AddToDecor FlatDecor ... - - FlatStyle UseDecor FlatDecor - - -and now apply the style again: - - - xterm UseStyle FlatStyle - - -
diff --git a/doc/commands/AddToFunc.xml b/doc/commands/AddToFunc.xml deleted file mode 100644 index 9edc7e8dd..000000000 --- a/doc/commands/AddToFunc.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - -%myents; -]> - - -
-AddToFunc - - - AddToFuncnameIJMCHDaction - - -Begins or adds to a function definition. Here is an example: - - -AddToFunc Move-or-Raise I - + M - + D - - -The function name is "Move-or-Raise", and it could be invoked from a -menu or a mouse binding or key binding: - - - 1 TS A Move-or-Raise - - -The -name -must not contain embedded whitespace. No guarantees are made -whether function names with embedded whitespace work or not. This -behavior may also change in the future without further notice. -The letter before the -action -tells what kind of action triggers the command which follows it. -'' -stands for "Immediate", and is executed as soon as the function is -invoked. -'' -is similar to "Immediate" but is delayed until a button is pressed -or released or the pointer is moved, or the function completes. It -is always executed before the other function actions. -'' -stands for "Motion", i.e. if the user starts moving the mouse. -'' -stands for "Click", i.e., if the user presses and releases the -mouse button. -'' -stands for "Hold", i.e. if the user presses a mouse button and -holds it down for more than - -milliseconds. -'' -stands for "Double-click". The action -'I' -causes an action to be performed on the button-press, if the -function is invoked with prior knowledge of which window to act -on. - -There is a number of predefined symbols that are replaced by -certain values if they appear on the command line. Please refer -to the - -section for details. - -Please read the comments on executing complex functions -in the section -. - - -Examples: - -If you call - - - F10 R A MailFunction xmh "-font fixed" - - -and "MailFunction" is - - -AddToFunc MailFunction - + I ($0) off - + I (AcceptsFocus, $0) - + I ($0) exec $0 $1 - - -Then the last line of the function becomes - - - + I (xmh) exec xmh -font fixed - - -The expansion is performed as the function is executed, so you can -use the same function with all sorts of different arguments. You -could use - - - F11 R A MailFunction zmail "-bg pink" - - -in the same -config, -if you wanted. An example of using "$[w.id]" is: - - -AddToFunc PrintFunction - + I - + I xdpr -id $[w.id] - - -Note that "$$" is expanded to '$'. - -Another example: bind right mouse button within the window button -number 6 (this is a minimize button for the win95 theme) to -iconify all windows of the same resource: - - -AddToFunc FuncIconifySameResource "I" ($0) on - 3 6 A FuncIconifySameResource $[w.resource] - - - -
diff --git a/doc/commands/AddToMenu.xml b/doc/commands/AddToMenu.xml deleted file mode 100644 index 936cbc209..000000000 --- a/doc/commands/AddToMenu.xml +++ /dev/null @@ -1,260 +0,0 @@ - - - -%myents; -]> - - -
-AddToMenu - - - AddToMenumenu-namemenu-label action - - -Begins or adds to a menu definition. Typically a menu definition -looks like this: - - -AddToMenu Utilities Utilities - + Xterm exec xterm -e tcsh - + Rxvt exec rxvt - + "Remote Logins" Remote-Logins - + Top exec rxvt -T Top -n Top -e top - + Calculator exec xcalc - + Xman exec xman - + Xmag exec xmag - + emacs exec xemacs - + Mail MailFunction xmh "-font fixed" - + "" - + Modules Module-Popup - + "" - + Exit Fvwm Quit-Verify - - -The menu could be invoked via - - - 1 R A Utilities Nop - - -or - - - 1 R A Utilities - - -There is no end-of-menu symbol. Menus do not have to be defined -in a contiguous region of the -config -file. The quoted (or first word) -portion in the above examples is the menu label, -which appears in the menu when the user pops it up. The remaining -portion is an fvwm command which is executed if the user -selects that menu item. An empty menu-label ("") and the - -function are used to insert a separator into the menu. - -The keywords - -and - -have a special meaning when used as the name of a menu item. The -action following the keyword is executed whenever the menu is -popped up or down. This way you can implement dynamic menus. It -is even possible to destroy itself with - -and the rebuild from scratch. When the menu has been destroyed -(unless you used the - -option when destroying the menu), do not forget to add the dynamic -action again. - -Note: Do not trigger actions that require user interaction. They -may fail and may screw up your menus. See the - -command. - -Do not issue - -commands as dynamic menu actions. Chances are good that this -crashes fvwm. - - - -There are several configurable scripts installed together with fvwm -for automatic menu generation. They have their own man pages. -Some of them, specifically -fvwm-menu-directory and -fvwm-menu-desktop, may be used with - -to create a directory listing or GNOME/KDE -application listing. - -Example (File browser): - - -# You can find the shell script fvwm_make_browse_menu.sh -# in the utils/ directory of the distribution. -AddToMenu BrowseMenu -+ DynamicPopupAction \ - 'fvwm_make_browse_menu.sh BrowseMenu' - - -Example (Picture menu): - - -# Build a menu of all .jpg files in -# $HOME/Pictures -AddToMenu JpgMenu foo title -+ DynamicPopupAction MakeJpgMenu - - MakeJpgMenu -+ I recreate JpgMenu -+ I AddToMenu JpgMenu Pictures -+ I 'for i in $HOME/Pictures/*.jpg; \ - do echo AddToMenu JpgMenu "`basename $i`" xv $i; done' - - -The keyword - -has a similar meaning. It is executed whenever you try to pop up -a sub menu that does not exist. With this function you can define -and destroy menus on the fly. You can use any command after the -keyword, but if the name of an item (that is a submenu) defined with - -follows it, fvwm executes this command: - - <function-name> <submenu-name> - -i.e. the name is passed to the function as its first argument and -can be referred to with "$0". - -The -fvwm-menu-directory -script mentioned above may be used with -MissingSubmenuFunction -to create an up to date recursive directory listing. - -Example: - - -# There is another shell script fvwm_make_directory_menu.sh -# in the utils/ directory of the distribution. To use it, -# define this function in your configuration file: - - MakeMissingDirectoryMenu - MakeMissingDirectoryMenu -+ I fvwm_make_directory_menu.sh $0 - - SomeMenu -AddToMenu SomeMenu -+ MissingSubmenuFunction MakeMissingDirectoryMenu -+ "Root directory" / - - -This is another implementation of the file browser that uses -sub menus for subdirectories. - -Titles can be used within the menu. If you add the option - -behind the keyword -, -the title is added to the top of the menu. If there was a title -already, it is overwritten. - -AddToMenu Utilities Tools Title top - -All text up to the first -Tab -in the menu label is aligned to the left side of the menu, all -text right of the first -Tab -is aligned to the left in a second column and all text thereafter -is placed right aligned in the third column. All other -Tabs -are replaced by spaces. Note that you can change this format with -the - -option of the - -command. - -If the menu-label contains an ampersand ('&'), the next character -is taken as a hot-key for the menu item. Hot-keys are underlined -in the label. To get a literal '&', insert "&&". Pressing the -hot-key moves through the list of menu items with this hot-key or -selects an item that is the only one with this hot-key. - -If the menu-label contains a sub-string which is set off by stars, -then the text between the stars is expected to be the name of an -image file to insert in the menu. To get a literal '*', insert "**". For example - -+ Calculator*xcalc.xpm* exec xcalc - -inserts a menu item labeled "Calculator" with a picture of a -calculator above it. The following: - -+ *xcalc.xpm* exec xcalc - -Omits the "Calculator" label, but leaves the picture. - -If the menu-label contains a sub-string which is set off by -percent signs, then the text between the percent signs is expected -to be the name of image file (a so called mini icon to insert to -the left of the menu label. A second mini icon that is drawn at -the right side of the menu can be given in the same way. To get a -literal '%', insert "%%". For example - -+ Calculator%xcalc.xpm% exec xcalc - -inserts a menu item labeled "Calculator" with a picture of a -calculator to the left. The following: - -+ %xcalc.xpm% exec xcalc - -Omits the "Calculator" label, but leaves the picture. The -pictures used with this feature should be small (perhaps 16x16). - -If the menu-name (not the label) contains a sub-string which is -set off by at signs ('@'), then the text between them is expected -to be the name of an image file to draw along the left -side of the menu (a side pixmap). You may want to use the - -option of the - -command instead. To get a literal '@', insert "@@". For example - -AddToMenu StartMenu@linux-menu.xpm@ - -creates a menu with a picture in its bottom left corner. - -If the menu-name also contains a sub-string surrounded by '^'s, then -the text between '^'s is expected to be the name of an X11 color -and the column containing the side picture is colored with that -color. You can set this color for a menu style using the - -option of the - -command. To get a literal '^', insert "^^". Example: - -AddToMenu StartMenu@linux-menu.xpm@^blue^ - -creates a menu with a picture in its bottom left corner and -colors with blue the region of the menu containing the picture. - -In all the above cases, the name of the resulting menu is name -specified, stripped of the substrings between the various -delimiters. - -
diff --git a/doc/commands/All.xml b/doc/commands/All.xml deleted file mode 100644 index 769c5cb28..000000000 --- a/doc/commands/All.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - -%myents; -]> - - -
-All - - - Alloptions(conditions)command - - -Execute -command -on all windows meeting the conditions. It returns 1 if any window -matches the condition and 0 otherwise. The execution starts at the top of the -window ring and continues towards the bottom. The -options -can be any combination of -Reverse and UseStack. -If the option - -is given the execution order is reversed. The option - -makes All use the stacking order instead of the window ring when walking -through windows. -See the section for a list of conditions. - -This command implies the conditions -CirculateHit, CirculateHitIcon and CirculateHitShaded. -They can be turned off by specifying -!CirculateHit -etc. explicitly. -
diff --git a/doc/commands/AnimatedMove.xml b/doc/commands/AnimatedMove.xml deleted file mode 100644 index 407bb946f..000000000 --- a/doc/commands/AnimatedMove.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -%myents; -]> - - - -
-AnimatedMove - - - AnimatedMovexyWarp - - - - -Move a window in an animated fashion. Similar to - -command. The options are the same, except they are required, -since it doesn't make sense to have a user move the window -interactively and animatedly. If the optional argument - -is specified the pointer is warped with the window. - -
diff --git a/doc/commands/Any.xml b/doc/commands/Any.xml deleted file mode 100644 index 8cb8c4f20..000000000 --- a/doc/commands/Any.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - -%myents; -]> - - -
-Any - - - Any(conditions)command - - -Performs -command -if any window which satisfies all -conditions -exists. The command is run in the context of the root window. -See the section for a list of conditions. - -
diff --git a/doc/commands/Asterisk.xml b/doc/commands/Asterisk.xml deleted file mode 100644 index 640ec0dbb..000000000 --- a/doc/commands/Asterisk.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -%myents; -]> - - - -
-Asterisk - - - *module_config_line - - -Defines a module configuration. -module_config_line -consists of a module name (or a module alias) and a module -resource line. The new syntax allows a delimiter, a colon and -optional spaces, between the module name and the rest of the line, -this is recommended to avoid conflicts. - - -*FvwmPager: WindowBorderWidth 1 -*FvwmButtons-TopRight: Geometry 100x100-0+0 -*FvwmButtons-Bottom: Geometry +0-0 - - -
diff --git a/doc/commands/Beep.xml b/doc/commands/Beep.xml deleted file mode 100644 index e93e5394f..000000000 --- a/doc/commands/Beep.xml +++ /dev/null @@ -1,20 +0,0 @@ - - -%myents; -]> - - - -
-Beep - - - Beep - - -As might be expected, this makes the terminal beep. - -
diff --git a/doc/commands/BorderStyle.xml b/doc/commands/BorderStyle.xml deleted file mode 100644 index cfcd42b57..000000000 --- a/doc/commands/BorderStyle.xml +++ /dev/null @@ -1,109 +0,0 @@ - - -%myents; -]> - - - -
-BorderStyle - - - BorderStylestatestyle-- !flag - - -Defines a border style for windows. -state -can be either "" or "". If -state -is omitted, then the style is set for both states. If the -style and flags -are enclosed in parentheses, then multiple -state -definitions can be specified per line. - -style -is a subset of the available button styles, and can only be - -(uniform pixmaps which match the bevel colors work best this -way) or . If a -'!' is prefixed to any -flag, -the behavior is negated. If -style -is not specified, then one can change flags without resetting the -style. - -The - -flag hides the corner handle dividing lines on windows with -handles (this option has no effect for ! windows). By -default, -HiddenHandles -is disabled. - -The - -flag supplements -HiddenHandles. -If given, the inner bevel around the window frame is not drawn. -If -HiddenHandles -is not specified, the frame looks a little strange. - - - -causes a raised relief pattern to be drawn (default). - -causes a sunken relief pattern to be drawn. - -inhibits the relief pattern from being drawn. - -To decorate the active and inactive window borders with a textured -pixmap, one might specify: - - -BorderStyle Active TiledPixmap marble.xpm -BorderStyle Inactive TiledPixmap granite.xpm -BorderStyle Active -- HiddenHandles NoInset - - -To clear the style for both states: - - -BorderStyle - - -To clear for a single state: - - -BorderStyle Active Simple - - -To unset a flag for a given state: - - -BorderStyle Inactive -- !NoInset - - -title-bar buttons can inherit the border style with the - -flag (see -). - -
diff --git a/doc/commands/Break.xml b/doc/commands/Break.xml deleted file mode 100644 index 762e645ef..000000000 --- a/doc/commands/Break.xml +++ /dev/null @@ -1,41 +0,0 @@ - - -%myents; -]> - - - -
-Break - - - Break - levels - - -If the break command is used in a function, function execution is -terminated immediately. Further commands of the function are not -processed. Normally, all nested invocations of complex functions -are left. An optional integer number -levels -may be given to break out of the given number of nested functions -and continue execution of a higher level function. -The -Break -command always has the return code -2. Example: - - - PickWindowRaiseAndDeiconify -+ I -+ I (Error) Break -+ I -+ I off - - - -
diff --git a/doc/commands/BugOpts.xml b/doc/commands/BugOpts.xml deleted file mode 100644 index 12dce2a02..000000000 --- a/doc/commands/BugOpts.xml +++ /dev/null @@ -1,140 +0,0 @@ - - -%myents; -]> - - - -
-BugOpts - - - BugOptsoptionbool, - - -This command controls several workarounds for bugs in third party -programs. The individual options are separated by commas. The -optional argument -bool -is a boolean argument and controls if the bug workaround is -enabled or not. It can either be "True" or "False" to turn the -option on or off, or "toggle" to switch is back and forth. If -bool -is omitted, the default setting is restored. - - -disables ConfigureNotify events that are usually sent to an -application while it is moved. If some windows flicker annoyingly -while being moved, this option may help you. Note that if this -problem occurs it is not an fvwm bug, it is a problem of the -application. - - -makes fvwm install the root colormap before it does some -operations using the root window visuals. This is only useful -when the - -option is used to start fvwm and then only with some -configurations of some servers (e.g. Exceed 6.0 with an 8 bit -PseudoColor root and fvwm using a 24 bit TrueColor visual). - -The - -option controls whether Motif applications have the ability to -have modal dialogs (dialogs that force you to close them first -before you can do anything else). The default is to not allow -applications to have modal dialogs. Use this option with -care. Once this option is turned on, you have to restart fvwm to -turn it off. - - -makes fvwm try to raise the windows it manages over native windows -of the X server's host system. This is needed for some X servers -running under Windows, Windows NT or Mac OS X. Fvwm tries to detect if it -is running under such an X server and initializes the flag -accordingly. - - -makes fvwm try to raise the windows it manages over -override_redirect windows. This is used to cope with ill-mannered -applications that use long-lived windows of this sort, contrary to -ICCCM -conventions. It is useful with the - -style option too. - - -suppresses flickering of the focused window in some modules when -using KDE or QT applications with application modal dialog -windows. By default this option is turned on. This option may be -visually disturbing for other applications using windows not -managed by fvwm. Since these applications are rare it is most -likely safe to leave this option at its default. - - -suppresses the forwarding of unknown ClientEvent messages to windows -- -usually this is harmless, but Qt has problems handling unrecognised -ClientEvent messages. Enabling this option might therefore help for Qt -applications using DragnDrop. This option is off by default. - - -is needed by EWMH compliant pagers or taskbars which represent -windows which are on a different desktops as iconified. These -pagers and taskbars use a version of the EWMH specification before -version 1.2 (the current KDE 2 & 3 versions). These pagers and -taskbars use the IconicState WM_STATE state to determine if an -application is iconified. This state, according to the -ICCCM, -does not imply that a window is iconified (in the usual sense). -Turning on this option forces fvwm to establish an equivalence -between the IconicState WM_STATE state and the iconified window. -This violates -ICCCM -compliance but should not cause big problems. -By default this option is off. - -With the - -enabled, fvwm prints the name, icon name (if available), resource -and class of new windows to the console. This can help in finding -the correct strings to use in the - -command. - -When the - -option is enabled, fvwm prints a message to the console whenever a -new window is placed or -, -is used. The message explains on which desk, page, -screen and position it was placed and why. This option can be -used to figure out why a specific window does not appear where you -think it should. - -The - -option enables some debugging code in the ConfigureRequest -handling routines of fvwm. It is not helpful for the user, but if -you report a bug to the fvwm team we may ask you to enable this -option. - -The option -enables transliteration during conversions from utf-8 strings. By -default fvwm will not transliterate during conversion, but will fall -back to alternate strings provided by the clients if conversion from -utf-8 fails due to characters which have no direct correspondence in -the target charecter set. Some clients however neglect to set non utf-8 -properties correctly in which case this option may help. - -
diff --git a/doc/commands/BusyCursor.xml b/doc/commands/BusyCursor.xml deleted file mode 100644 index 7e90f38e6..000000000 --- a/doc/commands/BusyCursor.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - -%myents; -]> - - -
-BusyCursor - - - BusyCursorOption bool, - - -This command controls the cursor during the execution of certain -commands. -Option -can be -DynamicMenu, -ModuleSynchronous, -Read, -Wait or -*. -An option must be followed by a boolean argument -bool. -You can use commas to separate individual options. If you set an -option to "True", then when the corresponding command is run, fvwm -displays the cursor of the - -context of the - -command. "False" forces to not display the cursor. The default is: - - -BusyCursor DynamicMenu False, ModuleSynchronous False, \ - Read False, Wait False - - - -The option -refers to all available options. - - -The -option controls the command. - - -The -option affects the -and -options of the -command. If this option is set to "False", then the busy cursor -is not displayed during a dynamic menu command even if this -command is a or -command and the Read -option is set to "True". - -The -option affects the command. -If this option is set to "False", then the busy cursor is not -displayed while fvwm waits for a module started by - to complete its startup. - - -The -option affects only the root cursor. During a wait pause the root -cursor is replaced by the busy cursor and fvwm is still fully -functional (you can escape from the pause, see the - -command). If you want to use this option and if you do not use -the default root cursor, you must set your root cursor with the - command. - -
diff --git a/doc/commands/ButtonState.xml b/doc/commands/ButtonState.xml deleted file mode 100644 index 4cb4af8c0..000000000 --- a/doc/commands/ButtonState.xml +++ /dev/null @@ -1,67 +0,0 @@ - - -%myents; -]> - - - -
-ButtonState - - - ButtonStateActiveDown boolInactive boolInactiveDown bool - - - -The -ButtonState -command controls which states of the window titles and title -buttons are used. The default is to use all four states: -"ActiveUp", -"ActiveDown", -"InactiveUp" and -"InactiveDown" (see - and - -commands). The -bool -argument after the key word controls if the designated state is -used ("True") or not ("False"). The bool flag -is the same as other commands, and not limited to just "True" or "False"; -"Yes" and "No" may also be used. -The "ActiveUp" state cannot be -deactivated. If no arguments are provided or the given arguments -are illegal, the default is restored. - -If - -argument is "False", no different button style -for the pressed down buttons used, instead "ActiveUp" state is -used even when button is pressed. - -If - -argument is "False", focused and unfocused windows -look similarly, the corresponding "Active" states are always used. - -If - -argument is "False" (only applied when -Inactive -is "True"), the pressed titles and title buttons in non-focused -windows are drawn using "InactiveUp" or "ActiveUp" states -depending on the values of the other key words. - -
diff --git a/doc/commands/ButtonStyle.xml b/doc/commands/ButtonStyle.xml deleted file mode 100644 index 49b0c0060..000000000 --- a/doc/commands/ButtonStyle.xml +++ /dev/null @@ -1,478 +0,0 @@ - - -%myents; -]> - - - -
-ButtonStyle - - - ButtonStyle - >buttonstatestyle-- !flag - - -Sets the button style for a title-bar button. -button -is the title-bar button number between 0 and 9, or one of -"", -"", -"", or -"". Button numbering is described in the - -command section. If the -style and flags -are enclosed in parentheses, then multiple -state -definitions can be specified per line. - -state -refers to which button state should be set. Button states are -defined as follows: -"" and -"" refer to the -un-pressed and pressed states for buttons on active windows; while -the "" and -"" states denote buttons on -inactive windows. The shortcut -"" denotes both "ActiveUp" and -"ActiveDown" states. Shortcut -"" denotes both "InactiveUp" -and "InactiveDown" states. -The similar state names like just described, but with the "Toggled" -prefix are used instead for title buttons which have one of the -MwmDecorMax, MwmDecorShade, MwmDecorStick or MwmDecorLayer -hints, if the window is maximized, shaded, sticky or placed on specific -layer, respectively. - - - Default - + ButtonStyle 6 \ - Vector 4 50x25@1 85x75@0 15x75@0 50x25@1 - + ButtonStyle 6 ToggledActiveUp \ - Vector 4 50x75@0 85x25@1 15x25@0 50x75@0 - + ButtonStyle 6 ToggledActiveDown \ - Vector 4 50x75@0 85x25@1 15x25@0 50x75@0 - + ButtonStyle 6 ToggledInactive \ - Vector 4 50x75@0 85x25@1 15x25@0 50x75@0 - + ButtonStyle 6 - MwmDecorShade - 0 6 N - - -Additionally, the following shortcuts may be used: -"", -"", -"", -"", -"", -"". -They are actually different masks for 4 individual states from -8 total. These are supported too: -"", -"", -"", -"". - -If -state -is specified, -that particular button state is set. If -state -is omitted, every state is set. Specifying a style destroys the -current style (use - -to avoid this). - -If -style -is omitted, then state-dependent flags can be set for the primary -button style without destroying the current style. Examples (each -line should be considered independent): - - -ButtonStyle Left -- flat -ButtonStyle All ActiveUp (-- flat) Inactive (-- flat) - - -The first line sets every state of the left buttons to flat, while -the second sets only the "ActiveUp" and "Inactive" states of every -button to flat (only flags are changed; the buttons' individual -styles are not changed). - -If you want to reset all buttons to their defaults: - - -ButtonStyle - - -To reset the "ActiveUp" button state of button 1 to the default: - - -ButtonStyle 1 ActiveUp Default - - -To reset all button states of button 1 to the default of -button number 2: - - -ButtonStyle 1 Default 2 - - -For any button, multiple -state -definitions can be given on one line by enclosing the -style and flags -in parentheses. If only one definition per line is given the -parentheses can be omitted. - -flags -affect the specified -state. -If a -'!' -is prefixed to any -flag, -its behavior is negated. The available state-dependent flags for -all styles are described here (the -ButtonStyle -entry deals with state-independent flags). - - - -causes a raised relief pattern to be drawn. - - - -causes a sunken relief pattern to be drawn. - - - -inhibits the relief pattern from being drawn. - - - -causes the given button state to render the current title style -before rendering the buttons' own styles. The -, - and - - -flags are ignored since they are redundant in this context. - - - -causes the button to inherit the decorated -BorderStyle -options. - - -Raised, Sunk and Flat -are mutually exclusive, and can be specified for the initial -ButtonStyle -only. -UseTitleStyle and UseBorderStyle -are also mutually exclusive (both can be off however). The -default is -Raised -with both -UseBorderStyle and UseTitleStyle -left unset. - - -for the "ActiveDown" and "InactiveDown" states: When a button is -pressed, the relief is inverted. Because of this, to obtain the -raised look in "ActiveDown" or "InactiveDown" states you must -specify the opposite of the desired relief (i.e. -Sunk -for "ActiveDown" or "InactiveDown"). This behavior is consistent, -but may seem confusing at first. The same applies to the -"Toggled" states. - -Button styles are classified as non-destructive, partially -destructive, or fully destructive. Non-destructive styles do not -affect the image. Partially destructive styles can obscure some or -all parts of the underlying image (i.e. -Pixmap). -Fully destructive styles obscure the entire underlying image (i.e. -Solid -or one of the -gradient -styles). Thus, if stacking styles with - (or -for title-bars), use care in sequencing styles to minimize redraw. - -The available styles are: - -Simple, Default, Solid, Colorset, Vector, -?Gradient, Pixmap, AdjustedPixmap, -ShrunkPixmap, StretchedPixmap, TiledPixmap, MiniIcon - -The description of these styles and their arguments follow: - -The - -style does nothing. There are no arguments, and this style is an -example of a non-destructive button style. - -The - -style conditionally accepts one argument: a number which specifies -the default button number to load. If the style command given is -ButtonStyle or , -the argument is optional (if given, it overrides the current button). -If a command other than -ButtonStyle or -is used, the number must be specified. - -The - -style fills the button with a solid color. The relief border -color is not affected. The color is specified as a single -argument. This style is fully destructive. - -The - -cs -alpha -style fills the button with the Colorset -cs. -The optional -alpha -argument is a percentage between 0 and 100. It causes fvwm to -merge the colorset background onto the button using this -percentage. If the percentage is 0 the colorset background is -hidden and if it is 100 the colorset background is fully -applied. The default is 100. So, the destructiveness depends on the -alpha -argument. - -The - -num -X[offsetp]xY[offsetp]@C ... -style draws a line pattern. Since this is a standard button style, -the keyword -Vector -is optional, -num -is a number of point specifications of the form -X[offsetp]xY[offsetp]@C ... -X and Y -are point coordinates inside the button, given in percents -(from 0 to 100). An optional absolute -offset -in pixels, can be given as "+<offset>p" for a positive or -"-<offset>p" for a negative offset. - - - -specifies a line color (0 - the shadow color, 1 - the highlight -color, 2 - the background color, 3 - the foreground color, 4 - -only move the point, do not draw). The first point color is not -used. You can use up to 10000 points in a line pattern. This -style is partially destructive. - -The specification is a little cumbersome: - - -ButtonStyle 2 Vector 4 50x30@1 70x70@0 30x70@0 50x30@1 - - -then the button 2 decoration uses a 4-point pattern consisting of -a line from (x=50,y=30) to (70,70) in the shadow color (@0), and -then to (30,70) in the shadow color, and finally to (50,30) in the -highlight color (@1). Is that too confusing? See the fvwm web -pages for some examples with screenshots. - -A more complex example of -Vector: - - -ButtonStyle 8 Vector 10 45x65@2 45x75@3 \ - 20x75@3 20x50@3 35x50@3 35x65@1 35x25@1 \ - 75x25@1 75x65@0 35x65@0 -ButtonStyle 0 Vector 10 45x65@2 45x75@0 \ - 20x75@0 20x50@1 45x50@1 45x65@0 75x65@3 \ - 75x25@3 35x25@3 35x47@3 - - -The - -styles denote color gradients. Fill in the question mark with any -one of the defined gradient types. Please refer to the - -section for a description of the gradient syntax. The gradient -styles are fully destructive. - -The - -style displays a pixmap. A pixmap should be specified as an -argument. For example, the following would give button number 2 -the same pixmap for all 4 states (2 active and 2 inactive), and -button number 4 all different pixmaps. - - -ButtonStyle 2 Pixmap my_pixmap.xpm -ButtonStyle 4 \ - ActiveUp (Pixmap activeup.xpm) \ - ActiveDown (Pixmap activedown.xpm) \ - Inactive (Pixmap inactiveup.xpm) -ButtonStyle 4 \ - InactiveDown Pixmap inactivedown.xpm - - -The pixmap specification can be given as an absolute or relative -pathname (see -). -If the pixmap cannot be found, the button style reverts to -Simple. -Flags specific to the -Pixmap -style are -Left, Right, -Top, and Bottom. -These can be used to justify the pixmap (default is centered for -both directions). Pixmap transparency is used for the color -"None." This style is partially destructive. - -The - -style is similar to the -Pixmap -style. But the image is resized to exactly fit the button. - -The - -style is similar to the -Pixmap -style. But if the image is bigger than the button the image is -resized to fit into the button. - -The - -style is similar to the -Pixmap -style. But if the image is smaller than the button the image is -resized to cover the button. - -The - -style accepts a pixmap to be tiled as the button background. One -pixmap is specified as an argument. Pixmap transparency is not -used. This style is fully destructive. - -The - -style draws the window's miniature icon in the button, which is -specified with the -MiniIcon -option of the -Style -command. This button style accepts no arguments. Example: - - - * MiniIcon mini-bx2.xpm - xterm MiniIcon mini-term.xpm - Emacs MiniIcon mini-doc.xpm - -ButtonStyle 1 MiniIcon - - - - - ButtonStylebutton-!flag - - -Sets state-independent flags for the specified -button. -State-independent flags affect button behavior. Each -flag -is separated by a space. If a '!' -is prefixed to the flag then the behavior is negated. The special -flag - -clears any existing flags. - -The following flags are usually used to tell fvwm which buttons -should be affected by mwm function hints (see - -option of the - -command. This is not done automatically since you might have -buttons bound to complex functions, for instance. - - - -should be assigned to title-bar buttons which display a menu. The -default assignment is the leftmost button. When a window with the - - -option requests not to show this button, it is hidden. - - - -should be assigned to title-bar buttons which minimize or iconify -the window. The default assignment is the second button over from -the rightmost button. When a window with the - - -option requests not to show this button, it is hidden. - - - -should be assigned to title-bar buttons which maximize the -window. The default assignment is the rightmost button. When a -window with the - - -option requests not to show this button, it is hidden. When the -window is maximized, the vector pattern on the button looks -pressed in. - - - -should be assigned to title-bar buttons which shade the window -(see - -command). When the window is shaded, the vector pattern on the -button looks pressed in. - - - -should be assigned to title-bar buttons which make the window -sticky. When the window is sticky, the vector pattern on the -button looks pressed in. - -The flag - -layer -should be assigned to title-bar buttons which place the window in -the layer numbered -layer. -When the window is on that specific layer, the vector pattern on -the button looks pressed in. -
diff --git a/doc/commands/ChangeDecor.xml b/doc/commands/ChangeDecor.xml deleted file mode 100644 index 7dc836c0c..000000000 --- a/doc/commands/ChangeDecor.xml +++ /dev/null @@ -1,44 +0,0 @@ - - -%myents; -]> - - - -
-ChangeDecor - - - ChangeDecordecor - - -This command is deprecated and will be removed in the future. There -are plans to replace it with a more flexible solution in fvwm-3.0. - -Changes the decor of a window to -decor. -decor -is "Default" or the name of a decor defined with -. -If -decor -is invalid, nothing occurs. If called from somewhere in a window -or its border, then that window is affected. If called from the -root window the user is allowed to select the target window. -ChangeDecor -only affects attributes which can be set using the - -command. - - -ChangeDecor CustomDecor1 - - - -
diff --git a/doc/commands/ChangeMenuStyle.xml b/doc/commands/ChangeMenuStyle.xml deleted file mode 100644 index 31737bbda..000000000 --- a/doc/commands/ChangeMenuStyle.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - -%myents; -]> - - -
-ChangeMenuStyle - - - ChangeMenuStyle - menustyle - menu - - -Changes the menu style of -menu to menustyle. -You may specify more than one menu in each call of -ChangeMenuStyle. - -
diff --git a/doc/commands/CleanupColorsets.xml b/doc/commands/CleanupColorsets.xml deleted file mode 100644 index bc435a919..000000000 --- a/doc/commands/CleanupColorsets.xml +++ /dev/null @@ -1,21 +0,0 @@ - - -%myents; -]> - - - -
-CleanupColorsets - - - CleanupColorsets - - -Resets a definition of all colorsets. - - -
diff --git a/doc/commands/ClickTime.xml b/doc/commands/ClickTime.xml deleted file mode 100644 index 0da9e5ad0..000000000 --- a/doc/commands/ClickTime.xml +++ /dev/null @@ -1,29 +0,0 @@ - - -%myents; -]> - - - -
-ClickTime - - - ClickTimedelay - - -Specifies the maximum delay in milliseconds between a button press -and a button release for the - -command to consider the action a mouse click. The default delay -is 150 milliseconds. Omitting the delay value resets the -ClickTime -to the default. - -
diff --git a/doc/commands/Close.xml b/doc/commands/Close.xml deleted file mode 100644 index e6f89d04c..000000000 --- a/doc/commands/Close.xml +++ /dev/null @@ -1,26 +0,0 @@ - - -%myents; -]> - - - -
-Close - - - Close - - -If the window accepts the delete window protocol a message is sent -to the window asking it to gracefully remove itself. If the -window does not understand the delete window protocol then the -window is destroyed as with the - -command. Note: if the window accepts the delete window protocol -but does not close itself in response, the window is not deleted. - -
diff --git a/doc/commands/ColorLimit.xml b/doc/commands/ColorLimit.xml deleted file mode 100644 index 7adeedae5..000000000 --- a/doc/commands/ColorLimit.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - -%myents; -]> - - -
-ColorLimit - - - ColorLimitlimit - - - -This command is obsolete. See the option to fvwm. - - -
diff --git a/doc/commands/ColormapFocus.xml b/doc/commands/ColormapFocus.xml deleted file mode 100644 index 4483de9ea..000000000 --- a/doc/commands/ColormapFocus.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -%myents; -]> - - - -
-ColormapFocus - - - ColormapFocusFollowsMouseFollowsFocus - - -By default, fvwm installs the colormap of the window that the -cursor is in. If you use - - -ColormapFocus - - -then the installed colormap is the one for the window that -currently has the keyboard focus. - -
diff --git a/doc/commands/Colorset.xml b/doc/commands/Colorset.xml deleted file mode 100644 index 723868c1f..000000000 --- a/doc/commands/Colorset.xml +++ /dev/null @@ -1,526 +0,0 @@ - - -%myents; -]> - - - -
-Colorset - - - Colorsetnumoptions - - -Creates or modifies colorset -num. -Colorsets are identified by this number. The number can start at -zero and can be a very large number. - -Warning: The highest colorset number used determines memory -consumption. Thus, if you define 'Colorset 100000', the memory for -100001 colorsets is used. Keep your colorset numbers as small as -possible. - -By convention, colorsets are numbered like this: - - -# 0 = Default colors -# 1 = Inactive windows -# 2 = Active windows -# 3 = Inactive menu entry and menu background -# 4 = Active menu entry -# 5 = greyed out menu entry (only bg used) -# 6 = module foreground and background -# 7 = hilight colors - - - -If you need to have more colors and do not want to reinvent the -wheel, you may use the convention used in fvwm-themes, it defines -the meaning of the first 40 colorsets for nearly all purposes: - - -http://fvwm-themes.sourceforge.net/doc/colorsets - -Each colorset has four colors, an optional pixmap and an optional -shape mask. The four colors are used by modules as the -foreground, background, highlight and shadow colors. When a -colorset is created it defaults to a foreground of black and -background of gray. The background and foreground are marked as -"average" and "contrast" (see later) so that just specifying a -pixmap or gradient gives sensible results. - -options -is a comma separated list containing some of the keywords: -fg, Fore, Foreground, -bg, Back, Background, -hi, Hilite, Hilight, -sh, Shade, Shadow, -fgsh, -Pixmap, TiledPixmap, AspectPixmap, -Transparent, RootTransparent, -Shape, TiledShape, AspectShape, NoShape, -?Gradient, -Tint, fgTint, bgTint, -Alpha, fgAlpha, -Dither, NoDither, -IconTint, -IconAlpha, -Plain. - - -, - and - -take a color name as an argument and set the foreground color. -The special name - -may be used to select a color that contrasts well with the -background color. To reset the foreground color to the default -value you can simply omit the color name. - - -, - and - -take a color name as an argument and set the background color. It -also sets the highlight and shadow colors to values that give a 3d -effect unless these have been explicitly set with the options -below. The special name - -may be used to select a color that is the average color of the -pixmap. If the pixmap is tinted with the -Tint -option, the tint is not taken in account in the computation of the -average color. You should use the -bgTint -option to get the "real" average color. The background color is -reset to the default value if the color name is omitted. - - -, - and - -take a color name as an argument and set the highlight color. If -the highlight color is not explicitly set, the default is to -calculate it from the background color. To switch back to the -default behavior the color name can be omitted. - - -, - and - -take a color name as an argument and set the shadow color. If the -shadow color is not explicitly set, the default is to calculate it -from the background color. To switch back to the default behavior -the color name can be omitted. - - - -takes a color name as an argument and sets the color used by the -shadowing font effect. See the - -section of the fvwm man page. By default this color is computed -from the foreground and background colors. To switch back to the -default the color name can be omitted. - - -, - and - -take a file name as an argument, search the - -and use it as the background pixmap. Any transparent parts are -filled with the background color. Not specifying a file name -removes any existing image from the colorset. -TiledPixmap -produces repeated copies of the image with no scaling, -Pixmap -causes the image to be stretched to fit whatever object the -colorset is applied to and -AspectPixmap -stretches to fit but retains the image aspect ratio. - - - -creates a transparent background pixmap. The pixmap is used as a -window background to achieve root transparency. For this you -should use the - -option to the - -command. -A subsequent root background change may be detected or not, this -depends on the program used to set the background. If you use -fvwm-root, xsetbg (xli), - with solid or colorset colors -or a recent version of Esetroot (>= 9.2) a background change is -detected. If background changes are not detected (e.g., if you use -xv or xsetroot) you can force detection by using the option of -fvwm-root: - - -xv -root -quit mybg.png; fvwm-root -d - - -Due to the way X implements transparency no guarantees can be made -that the desired effect can be achieved. The application may even -crash. If you experience any problems with this option, do not -use it. - -Using outline move and resize (see the - -command and the - - -option) as well as setting the - -style may help. The transparency achieved with -Transparent -depends on whether the colorset is applied to the foreground or -the background of a window. In the second case the transparency is -relative to the parent window of the window on which the colorset -is defined. For example: - - -Colorset 12 VGradient 200 grey30 grey60 -Colorset 17 Transparent -*: Colorset 12 -*: PlainColorset 17 - - -gives an IconMan with a vertical grey gradient background and the -buttons use the background (by transparency). To obtain a (root) -transparent IconMan: - - -Colorset 12 Transparent -Colorset 17 Transparent -Colorset 18 Transparent -Colorset 19 Transparent - -*: Colorset 12 -*: PlainColorset 17 -*: FocusColorset 18 -*: IconColorset 19 - - -The Colorset IconMan option defines the IconMan window background, -but the PlainColorset and the FocusColorset are drawn on the -foreground. So, the transparency of the IconMan buttons is -achieved by drawing nothing. Now if this IconMan is swallowed in -an FvwmButtons as: - - -:(Colorset 10, Swallow "FvwmIconMan" 'FvwmIconMan') - - -then, - -becomes a child of - -and it is transparent relative to -. -So, in this case - -uses Colorset 10 as background. If you want root transparency use -the -RootTransparent -option. - -, -and -, -are relatively simple. There is one main colorset option which -defines the background of the window and the other colorsets (if -any) are drawn on the foreground. The case of - -is simpler, the two colorsets refer to the window backgrounds. - -is more complicated as almost everything in the pager are windows -with some parental relations (the mini windows are the child and -the desktops are the parents and all this is complicated by the -hilighted page). So, the colorsets apply to the background of -these windows. You should experiment. For - and - -the situation is similar. There is a main window (a child of the -root window) which corresponds to the main colorset and most of -the widgets are windows which are children of the main window. -Tint -may work or not with the -Transparent -option. When the colorset is drawn on the foreground -Tint -should work. In some cases, tinting may be very slow. Tinting may -work with fvwm menu (without animation). Tinting may work better -if your X server has backing store enabled (try xdpyinfo to see if -this the case). There is a chance that the backing store support -of your X server does not work well with the terrible hack used to -Tint the ParentRelative Pixmap. So, to get tinted root -transparency it is more safe to use the -RootTransparent -option. - - - buffer -creates a root transparent background. To make this option work, -you must use an Esetroot compatible program, fvwm-root with the ---retain-pixmap option or with the RetainPixmap option -(and colorset or solid backgrounds). The -buffer -keyword is useful only when the -Tint -option is used too. This speeds up creation of windows which use -the colorset (useful for fvwm menus) at the cost of memory -usage. It also speeds up opaque move and resize which can be -unacceptably slow without -buffer. -However, this option may add a lot of memory to your X server -(depending on the size of the image used to set the -background). In summary, using outline move and resize for modules -which use such a colorset may be a good idea. - - -, - and - -take a file name as an argument, search the - -and use it as the shape bitmap. -TiledShape -produces repeated copies of the bitmap with no scaling, -Shape -causes the bitmap to be stretched to fit whatever object the -colorset is applied to and -AspectShape -stretches to fit but retains the bitmap aspect ratio. If the file -is a pixmap in xpm format the shape mask (all opaque pixels) of the -pixmap is used. For png and svg images, the shape mask is equivalent -to all not completely transparent pixels (alpha > 0). - -Due to the way X11 implements shapes you cannot take back -making windows shaped. You may have to restart fvwm or the shaped -application. - - -?Gradient ... -creates a pixmap and stretches it to fit the window. -?Gradient -may be one of , , -, , -, , - or . -The gradient types -are as follows: H is horizontal; V is vertical; D is diagonal -from top left to bottom right; B is a backwards diagonal from -bottom left to top right; S is concentric squares; C is concentric -circles; R is a radar like pattern and Y is a Yin Yang style (but -without the dots). -Please refer to the - -section for the syntax of gradients. - - - -takes 2 arguments, a color and a percentage between 0 and 100. It -causes the image defined using -?Pixmap -or -?Gradient -to be tinted with the specified color using the percentage. If the -image is transparent -Tint -tints only the image part. Unfortunately, a colorset background -specified using the -Transparent -option can give strange results. See the -Transparent -option for details. With no arguments this option removes the -tint. - - - -takes 2 arguments, a color and a percentage between 0 and 100. It -causes the color defined using -fg -to be tinted with the specified color using the percentage. With -no arguments this option removes the tint. - - - -takes 2 arguments, a color and a percentage between 0 and 100. It -causes the color defined using -bg -to be tinted with the specified color using the percentage. If the -sh -and -hi -colors are not specified, they are recomputed from the tinted bg -color. With no arguments this option removes the tint. - - - -takes a percentage between 0 and 100 as an argument. It causes -fvwm to merge the image defined using -?Pixmap -or -?Gradient -with the -bg -color using the percentage. If the percentage is 0 the image is -hidden and if it is 100 the image is displayed as usual (no -merge). The default is 100 and it is restored if no argument is -given. - - - -takes a percentage between 0 and 100 as an argument. It causes -fvwm to merge the text and the colorset background using the -percentage. If the percentage is 0 the text is hidden and if it is -100 the text is displayed as usual (no merge). This option has an -effect only with fonts loaded by Xft, see the - -section. The default is 100 and it is restored if no argument is -given. - - - -causes fvwm to dither the image defined using -?Pixmap -or -?Gradient. -This is useful only with displays with depth less than or equal to -16 (i.e., on displays which can only display less than 65537 -colors at once). The dithering effect lets you simulate having -more colors available that you actually have. - -causes fvwm to do not dither the images. -Dither -is the default if the depth is less than or equal to 8 (a screen -with 256 colors or less). In depth 15 (32768 colors) and 16 (65536 -colors), the default is -NoDither, -however this effect can be useful with images which contain a lot -of close colors. For example a fine gradient looks more -smooth. - - - -takes 2 arguments, a color and a percentage between 0 and 100. It -causes fvwm or a module to tint the "icons" which are rendered -into the colorset background with the specified color using a -percentage. Here "icons" means, fvwm Icons, fvwm menu icons, -MiniIcons which represent applications in various modules, images -loaded by modules (e.g., images specified by the - - -button option) ...etc. With no arguments this option removes the -icon tint. - - - -takes a percentage between 0 and 100 as an argument. It causes -fvwm to merge the "icons" which are rendered into the colorset -background using this percentage. The default is 100 and it is -restored if no argument is given. - -Note: -It is equivalent to use "Tint a_color rate" and "Alpha a" if a = -100 and the bg color is a_color. This equivalence does not hold -for IconAlpha and IconTint as the background can be an image or a -gradient (and not a uniform color background). -However, in some cases you can achieve (almost) the same effect by -using IconTint in the place of IconAlpha. This is preferable as, -in general, IconAlpha generates more redrawing than IconTint. - - - -removes the shape mask from the colorset while - -removes the background pixmap or gradient. - -Examples - - -Colorset 3 fg tan, bg navy - - - -If necessary this creates colorsets 0, 1, 2 and 3 and then changes -colorset 3 to have a foreground of tan, a background of navy. - - - -Colorset 3 bg "navy blue" - - - -changes the background color of colorset 3 to navy blue. The -foreground and pixmap are unchanged. - - - -Colorset 3 AspectPixmap large_murky_dungeon.xpm - - - -causes depression. - - - -Colorset 3 bg Average - - - -Sets the background color and the relief colors to match the -background pixmap. This is the default setting but it must be used -if a background color was specified and is now not required. - - -Colorset 3 YGradient 200 3 blue 1000 navy 1 blue 1000 navy - - -Adds a Yin Yang gradient background pixmap to colorset 3. If the -background is set to average it is recomputed along with the -foreground if that is set to contrast. - - - -#!/bin/sh - "Colorset 7 fg navy, bg gray" -while true -do - "Colorset 7 fg gray" - sleep 1 - "Colorset 7 fg navy" - sleep 1 -done - - -Makes colorset 7 blink. - -The color names used in colorsets are saved as fvwm variables which -can be substituted in any fvwm command. For example: - - - InitFunction -+ I exec xterm -fg $[fg.cs0] -bg $[bg.cs0] - - -Where $[fg.cs0] is the foreground color of colorset zero. Please -refer to the - -section for more information. - -
diff --git a/doc/commands/CopyMenuStyle.xml b/doc/commands/CopyMenuStyle.xml deleted file mode 100644 index 1af610440..000000000 --- a/doc/commands/CopyMenuStyle.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -%myents; -]> - - - -
-CopyMenuStyle - - - CopyMenuStyleorig-menustyledest-menustyle - - - - -Copy -orig-menustyle to -dest-menustyle, -where -orig-menustyle -is an existing menu style. If the menu style -dest_menustyle -does not exist, then it is created. - -
diff --git a/doc/commands/Current.xml b/doc/commands/Current.xml deleted file mode 100644 index 559870a8d..000000000 --- a/doc/commands/Current.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - -%myents; -]> - - -
-Current - - - Current(conditions)command - - -Performs -command -on the currently focused window if it satisfies all -conditions. -See the section for a list of conditions. - -This command implies the conditions -CirculateHit, CirculateHitIcon and CirculateHitShaded. -They can be turned off by specifying -!CirculateHit -etc. explicitly. - -
diff --git a/doc/commands/CursorMove.xml b/doc/commands/CursorMove.xml deleted file mode 100644 index 985973d68..000000000 --- a/doc/commands/CursorMove.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - -%myents; -]> - - -
-CursorMove - - - CursorMovehorizontalpverticalp - - -Moves the mouse pointer by -horizontal -pages in the X direction and -vertical -pages in the Y direction. Either or both entries may be -negative. Both horizontal and vertical values are expressed in -percent of pages, so - - -CursorMove 100 100 - - -means to move down and right by one full page. - - -CursorMove 50 25 - - -means to move right half a page and down a quarter of a -page. Alternatively, the distance can be specified in pixels by -appending a -'' -to the horizontal and/or vertical specification. For example - - -CursorMove -10p -10p - - -means move ten pixels up and ten pixels left. The CursorMove -function should not be called from pop-up menus. - -
diff --git a/doc/commands/CursorStyle.xml b/doc/commands/CursorStyle.xml deleted file mode 100644 index ac946ca3b..000000000 --- a/doc/commands/CursorStyle.xml +++ /dev/null @@ -1,205 +0,0 @@ - - - -%myents; -]> - - -
-CursorStyle - - - CursorStylecontextnumnameNoneTinyfilexyfg - bg - - -Defines a new cursor for the specified context. Note that this -command can not control the shapes an applications uses, for -example, to indicate that it is busy. The various contexts are: - - - - (top_left_corner) - used when initially placing windows - - - (top_left_arrow) - used in a window title-bar - - - (top_left_arrow) - used in windows that do not set their cursor - - - (hand2) - used in one of the title-bar buttons - - - (fleur) - used when moving or resizing windows - - - (sizing) - used when moving or resizing windows - - - (watch) - used during certain fvwm commands (see for details) - - - (top_left_arrow) - used in menus - - - (crosshair) - used when the user is required to select a window - - - (pirate) - used for , , and commands - - - (top_side) - used in the top side-bar of a window - - - (right_side) - used in the right side-bar of a window - - - (bottom_side) - used in the bottom side-bar of a window - - - (left_side) - used in the left side-bar of a window - - - (top_left_corner) - used in the top left corner of a window - - - (top_right_corner) - used in the top right corner of a window - - - (bottom_left_corner) - used in the bottom left corner of a window - - - (bottom_right_corner) - used in the bottom right corner of a window - - - (top_side) - used at the top edge of the screen - - - (right_side) - used at the right edge of the screen - - - (bottom_side) - used at the bottom edge of the screen - - - (left_side) - used at the left edge of the screen - - - (left_ptr) - used as the root cursor - - - - - -The defaults are shown in parentheses above. If you ever want to -restore the default cursor for a specific context you can omit the -second argument. - - - -The second argument is either the numeric value of the cursor as -defined in the include file X11/cursorfont.h -or its name (without the XC_ prefix). Alternatively, the xpm file -name may be specified. The name can also be - -(no cursor) or - -(a single pixel as the cursor). - - -# make the kill cursor be XC_gumby (both forms work): -CursorStyle DESTROY 56 -CursorStyle DESTROY gumby - - - -Alternatively, the cursor can be loaded from an (XPM, PNG or SVG) image -file. If fvwm is compiled with Xcursor support, -full ARGB is used, and (possibly animated) cursor files made with the -xcursorgen program can be loaded. Otherwise the cursor -is converted to monochrome. - - - -The optional x and y -arguments (following a file argument) specifies -the hot-spot coordinate with 0 0 as the top left corner of the image. -Coordinates within the image boundary are valid and overrides any hot-spot -defined in the (XPM/Xcursor) image file. An invalid or undefined hot-spot -is placed in the center of the image. - - -CursorStyle ROOT cursor_image.png 0 0 - - -The optional -fg and bg -arguments specify the foreground and background colors for the -cursor, defaulting to black and white (reverse video compared -to the actual bitmap). These colors are only used with monochrome -cursors. Otherwise they are silently ignored. - - -CursorStyle ROOT nice_arrow.xpm yellow black - - -
diff --git a/doc/commands/DefaultColors.xml b/doc/commands/DefaultColors.xml deleted file mode 100644 index e402a7741..000000000 --- a/doc/commands/DefaultColors.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -%myents; -]> - - - -
-DefaultColors - - - DefaultColorsforegroundbackground - - -DefaultColors -sets the default foreground and background colors used in -miscellaneous windows created by fvwm, for example in the geometry -feedback windows during a move or resize operation. If you do not -want to change one color or the other, use - as its color name. To -revert to the built-in default colors omit both color names. Note -that the default colors are not used in menus, window titles or -icon titles. - -
diff --git a/doc/commands/DefaultColorset.xml b/doc/commands/DefaultColorset.xml deleted file mode 100644 index 4c566dab1..000000000 --- a/doc/commands/DefaultColorset.xml +++ /dev/null @@ -1,36 +0,0 @@ - - -%myents; -]> - - - -
-DefaultColorset - - - DefaultColorsetnum - - -DefaultColorset -sets the colorset used by the windows controlled by the - -command. To revert back to the - -colors use - - -DefaultColorset -1 - - -or any variant of the - -command. - -
diff --git a/doc/commands/DefaultFont.xml b/doc/commands/DefaultFont.xml deleted file mode 100644 index 6c967fefb..000000000 --- a/doc/commands/DefaultFont.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -%myents; -]> - - - -
-DefaultFont - - - DefaultFontfontname - - -DefaultFont -sets the default font to font -fontname. -The default font is used by fvwm whenever no other font has been -specified. To reset the default font to the built-in default, -omit the argument. The default font is used for menus, window -titles, icon titles as well as the geometry feedback windows -during a move or resize operation. To override the default font -in a specific context, use the - * , - * , or - -commands. - -
diff --git a/doc/commands/DefaultIcon.xml b/doc/commands/DefaultIcon.xml deleted file mode 100644 index 8903a4510..000000000 --- a/doc/commands/DefaultIcon.xml +++ /dev/null @@ -1,29 +0,0 @@ - - -%myents; -]> - - - -
-DefaultIcon - - - DefaultIconfilename - - - -Sets the default icon which is used if a window has neither an -client-supplied icon nor an icon supplied via the - -option of the - -command. - -
diff --git a/doc/commands/DefaultLayers.xml b/doc/commands/DefaultLayers.xml deleted file mode 100644 index 154d10625..000000000 --- a/doc/commands/DefaultLayers.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -%myents; -]> - - - -
-DefaultLayers - - - DefaultLayersbottomputtop - - - -Changes the layers that are used for the -, -, - - -options. Initially, the layers 2, 4 and 6 are used. - -
diff --git a/doc/commands/Delete.xml b/doc/commands/Delete.xml deleted file mode 100644 index cb3a5aa6e..000000000 --- a/doc/commands/Delete.xml +++ /dev/null @@ -1,21 +0,0 @@ - - -%myents; -]> - - - -
-Delete - - - Delete - - -Sends a message to a window asking that it remove itself, -frequently causing the application to exit. - -
diff --git a/doc/commands/Deschedule.xml b/doc/commands/Deschedule.xml deleted file mode 100644 index e42ee624b..000000000 --- a/doc/commands/Deschedule.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -%myents; -]> - - - -
-Deschedule - - - Deschedulecommand_id - - -Removes all commands that were scheduled with the id -command_id -with the - -command from the list of commands to be executed unless they were -already executed. If the -command_id -is omitted, the value of the variable $[schedule.last] is used as -the id. - -
diff --git a/doc/commands/Desk.xml b/doc/commands/Desk.xml deleted file mode 100644 index e0581ce9f..000000000 --- a/doc/commands/Desk.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -%myents; -]> - - - -
-Desk - - - Deskarg1arg2min max - - -This command has been renamed. Please see - -command. - -
diff --git a/doc/commands/DesktopConfiguration.xml b/doc/commands/DesktopConfiguration.xml deleted file mode 100644 index b93538ad5..000000000 --- a/doc/commands/DesktopConfiguration.xml +++ /dev/null @@ -1,41 +0,0 @@ - - -%myents; -]> - - - -
-DesktopConfiguration - - - DesktopConfiguration - - global - per-monitor - - - - - This command controls the behaviour of how desktops should be managed - by FVWM. By default, for all screens detected by FVWM through RandR - support, the option of - - global - - means that all windows on the same desk across monitors is treated as one -- - hence, when a change of desktop/page happens, the same change occurs across - all monitors. - - - - With - - per-monitor - , each RandR monitor has a separate copy of desktops, and hence function -independently of one another when switching desks/pages. - -
diff --git a/doc/commands/DesktopName.xml b/doc/commands/DesktopName.xml deleted file mode 100644 index f08dfeabb..000000000 --- a/doc/commands/DesktopName.xml +++ /dev/null @@ -1,38 +0,0 @@ - - -%myents; -]> - - - -
-DesktopName - - - DesktopNamedeskname - - -Defines the name of the desktop number -desk -to -name. -This name is used in the - -command and in the - -where it override the - -configuration option. Moreover, if consecutive names starting from -desktop 0 are defined, then these names can be used by any EWMH -compliant application (as a pager). - -
diff --git a/doc/commands/DesktopSize.xml b/doc/commands/DesktopSize.xml deleted file mode 100644 index 1f1607b92..000000000 --- a/doc/commands/DesktopSize.xml +++ /dev/null @@ -1,24 +0,0 @@ - -%myents; -]> - - - -
-DesktopSize - - - DesktopSizeHorizontalxVertical - - -Defines the virtual desktop size in units of the physical screen -size. - -
diff --git a/doc/commands/Destroy.xml b/doc/commands/Destroy.xml deleted file mode 100644 index 64be272a3..000000000 --- a/doc/commands/Destroy.xml +++ /dev/null @@ -1,21 +0,0 @@ - - -%myents; -]> - - - -
-Destroy - - - Destroy - - -Destroys an application window, which usually causes the -application to crash and burn. - -
diff --git a/doc/commands/DestroyDecor.xml b/doc/commands/DestroyDecor.xml deleted file mode 100644 index 0f8d73c15..000000000 --- a/doc/commands/DestroyDecor.xml +++ /dev/null @@ -1,47 +0,0 @@ - - -%myents; -]> - - - -
-DestroyDecor - - - DestroyDecorrecreatedecor - - -This command is deprecated and will be removed in the future. There -are plans to replace it with a more flexible solution in fvwm-3.0. - -Deletes the -decor -defined with -AddToDecor, -so that subsequent references to it are no longer valid. Windows -using this -decor -revert to the "Default" decor. The optional parameter - -tells fvwm not to throw away the decor completely but to throw -away only its contents. If the decor is created again later, -windows do not use it before the - -style is applied again unless the decor was destroyed with the -recreate -option. The decor named "Default" cannot be destroyed. - - -DestroyDecor CustomDecor1 - - - -
diff --git a/doc/commands/DestroyFunc.xml b/doc/commands/DestroyFunc.xml deleted file mode 100644 index 53dd93cdb..000000000 --- a/doc/commands/DestroyFunc.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -%myents; -]> - - - -
-DestroyFunc - - - DestroyFuncfunction - - - -Deletes a function, so that subsequent references to it are no -longer valid. You can use this to change the contents of a -function during a fvwm session. The function can be rebuilt using -. - - -DestroyFunc PrintFunction - - - -
diff --git a/doc/commands/DestroyMenu.xml b/doc/commands/DestroyMenu.xml deleted file mode 100644 index 69fbd6006..000000000 --- a/doc/commands/DestroyMenu.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -%myents; -]> - - - -
-DestroyMenu - - - DestroyMenurecreatemenu - - - -Deletes a menu, so that subsequent references to it are no longer -valid. You can use this to change the contents of a menu during -an fvwm session. The menu can be rebuilt using -. -The optional parameter - -tells fvwm not to throw away the menu completely but to throw away -all the menu items (including the title). - -DestroyMenu Utilities - -
diff --git a/doc/commands/DestroyMenuStyle.xml b/doc/commands/DestroyMenuStyle.xml deleted file mode 100644 index 147275c1d..000000000 --- a/doc/commands/DestroyMenuStyle.xml +++ /dev/null @@ -1,28 +0,0 @@ - - -%myents; -]> - - - -
-DestroyMenuStyle - - - DestroyMenuStylemenustyle - - -Deletes the menu style named -menustyle -and changes all menus using this style to the default style, you -cannot destroy the default menu style. - -DestroyMenuStyle pixmap1 - -
diff --git a/doc/commands/DestroyModuleConfig.xml b/doc/commands/DestroyModuleConfig.xml deleted file mode 100644 index 677daf123..000000000 --- a/doc/commands/DestroyModuleConfig.xml +++ /dev/null @@ -1,38 +0,0 @@ - - -%myents; -]> - - - -
-DestroyModuleConfig - - - DestroyModuleConfigmodule_config - - -Deletes module configuration entries, so that new configuration -lines may be entered instead. This also sometimes the only way to -turn back some module settings, previously defined. This changes -the way a module runs during a fvwm session without restarting. -Wildcards can be used for portions of the name as well. - -The new non-conflicting syntax allows a delimiter, a colon and -optional spaces between the module name and the rest of the line. -In this case a module name (or alias) can't have wildcards. - - -DestroyModuleConfig FvwmButtons* -DestroyModuleConfig FvwmForm: Fore -DestroyModuleConfig FvwmIconMan: Tips* - - - -
diff --git a/doc/commands/DestroyStyle.xml b/doc/commands/DestroyStyle.xml deleted file mode 100644 index 18fabfd61..000000000 --- a/doc/commands/DestroyStyle.xml +++ /dev/null @@ -1,40 +0,0 @@ - - -%myents; -]> - - - -
-DestroyStyle - - - DestroyStylestyle - - -deletes the style named -style. -The changes take effect immediately. Note that -style -is not a wild-carded search string, but rather a case-sensitive -string that should exactly match the original - -command. - -Destroying style "*" can be done, but isn't really to be -recommended. For example: - - -DestroyStyle Application* - - -This removes all settings for the style named "Application*", NOT -all styles starting with "Application". - -
diff --git a/doc/commands/DestroyWindowStyle.xml b/doc/commands/DestroyWindowStyle.xml deleted file mode 100644 index ff218c2a9..000000000 --- a/doc/commands/DestroyWindowStyle.xml +++ /dev/null @@ -1,22 +0,0 @@ - - -%myents; -]> - - - -
-DestroyWindowStyle - - - DestroyWindowStyle - - -deletes the styles set by the - -command on the selected window. The changes take effect immediately. - -
diff --git a/doc/commands/Direction.xml b/doc/commands/Direction.xml deleted file mode 100644 index 836d86a78..000000000 --- a/doc/commands/Direction.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - -%myents; -]> - - -
-Direction - - - DirectionFromPointerdirection(conditions)command - - -Performs -command -(typically -) -on a window in the given direction which satisfies all -conditions. -Normally, the center of the currently focused window or the -context window in which the command was invoked is taken as the -starting point. Lacking such a window, or when the - -option is given, the current position of the pointer is taken as -the starting point. The -direction -may be one of "North", "Northeast", "East", "Southeast", "South", -"Southwest", "West", "Northwest" and "Center". Which window -Direction -selects depends on angle and distance between the center points of -the windows. Closer windows are considered a better match than -those farther away. The - -direction simply selects the window closest to the starting point. -Returns -1 if an invalid direction was given. -See the section for a list of conditions. - -
diff --git a/doc/commands/Echo.xml b/doc/commands/Echo.xml deleted file mode 100644 index 5e2667a37..000000000 --- a/doc/commands/Echo.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -%myents; -]> - - - -
-Echo - - - Echostring - - -Prints a message to -stderr. -Potentially useful for debugging things in your -config. - - -Echo Beginning style definitions... - - - -
diff --git a/doc/commands/EchoFuncDefinition.xml b/doc/commands/EchoFuncDefinition.xml deleted file mode 100644 index 2bcd47a58..000000000 --- a/doc/commands/EchoFuncDefinition.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - -%myents; -]> - -
-EchoFuncDefinition - - - EchoFuncDefinition - function - - -The -EchoFuncDefinition -is similar to the - -command but prints the definition for the given -function -to -stderr. -It is useful to find out how fvwm handles quoting and for -debugging functions -. - -
diff --git a/doc/commands/EdgeCommand.xml b/doc/commands/EdgeCommand.xml deleted file mode 100644 index 7bd42ef23..000000000 --- a/doc/commands/EdgeCommand.xml +++ /dev/null @@ -1,97 +0,0 @@ - - -%myents; -]> - - - -
-EdgeCommand - - - EdgeCommanddirectionFunction - - -Binds a specified fvwm command -Function -to an edge of the screen. Direction may be one of -"", -"", -"", -"", -"", -"", -"" and -"". -If -Function -is omitted the binding for this edge is removed. If EdgeCommand is -called without any arguments all edge bindings are removed. - -Function is executed when the mouse pointer -enters the invisible pan frames that surround the visible screen. -The binding works only if - -is set to a value greater than 0. -If a function is bound to an edge, scrolling specified by - -is disabled for this edge. -It is possible to bind a function only to some edges -and use the other edges for scrolling. -This command is intended to raise or lower certain windows -when the mouse pointer enters an edge. - -can be used get a delay when raising or lowering windows. -The following example raises - -if the mouse pointer enters the top edge of the screen. - - -# Disable EdgeScrolling but make it possible -# to move windows over the screen edge - -1 - * EdgeMoveDelay 250 - * EdgeMoveResistance 20 - -# Set thickness of the edge of the screen to 1 - 1 - -# Give focus to FvwmButtons if the mouse -# hits top edge -EdgeCommand Top (FvwmButtons) -# Make sure the command matches the window - FvwmButtons CirculateHit - - - 100 "Silent AutoRaiseFunction" \ - "Silent AutoLowerFunction" - -# If any window except FvwmButtons has -# focus when calling this function -# FvwmButtons are lowered - AutoLowerFunction - AutoLowerFunction -+ I (!FvwmButtons) (FvwmButtons) - -# If FvwmButtons has focus when calling this function raise it - AutoRaiseFunction - AutoRaiseFunction -+ I (FvwmButtons) - - -Normally, the invisible pan frames are only on the screen edges -that border virtual pages. If a screen edge has a command bound -to it, the pan frame is always created on that edge. - -
diff --git a/doc/commands/EdgeLeaveCommand.xml b/doc/commands/EdgeLeaveCommand.xml deleted file mode 100644 index e0483f041..000000000 --- a/doc/commands/EdgeLeaveCommand.xml +++ /dev/null @@ -1,65 +0,0 @@ - - -%myents; -]> - - - -
-EdgeLeaveCommand - - - EdgeLeaveCommanddirection - Function - - -Binds a specified fvwm command -Function -to an edge of the screen. Direction may be one of -"", -"", -"", -"", -"", -"", -"" and -"". -If -Function -is omitted the binding for this edge is removed. If -EdgeLeaveCommand is called without any arguments all edge bindings -are removed. - -Function -is executed when the mouse pointer -leaves the invisible pan frames that surround the visible screen. -The binding works only if - -is set to a value greater than 0. -If a function is bound to an edge, scrolling specified by - -is disabled for this edge. -It is possible to bind a function only to some edges -and use the other edges for scrolling. -This command is intended to raise or lower certain windows -when the mouse pointer leaves an edge. - -can be used get a delay when raising or lowering windows. -See example for - - -Normally, the invisible pan frames are only on the screen edges -that border virtual pages. If a screen edge has a command bound -to it, the pan frame is always created on that edge. - -
diff --git a/doc/commands/EdgeResistance.xml b/doc/commands/EdgeResistance.xml deleted file mode 100644 index 2ae233694..000000000 --- a/doc/commands/EdgeResistance.xml +++ /dev/null @@ -1,60 +0,0 @@ - - -%myents; -]> - - - -
-EdgeResistance - - - EdgeResistance - - delay - - - EdgeResistancescrollingmoving - screen-scrolling - - -Tells how hard it should be to change the desktop viewport by -moving the mouse over the edge of the screen. The parameter tells -how many milliseconds the pointer must spend on the screen edge -before fvwm moves the viewport. This is intended for people who -use - - - 100 100 - - -but find themselves accidentally flipping pages when they do -not want to. If -1 is given as the delay, scrolling is disabled -completely. - -The second form of invocation with two or three arguments is -obsolete and should be replaced with the following three commands -as needed: - - - scrolling - * EdgeMoveDelay scrolling - * EdgeMoveResistance moving -or - * EdgeMoveResistance moving screen-scrolling - - -Fvwm does this substitution automatically and prints a warning. - -
diff --git a/doc/commands/EdgeScroll.xml b/doc/commands/EdgeScroll.xml deleted file mode 100644 index 072532f61..000000000 --- a/doc/commands/EdgeScroll.xml +++ /dev/null @@ -1,73 +0,0 @@ - - -%myents; -]> - - - -
-EdgeScroll - - - - EdgeScrollhorizontalpverticalp - wrapwrapxwrapy - - -Specifies the percentage of a page to scroll when the cursor hits -the edge of a page. A trailing -'' -changes the interpretation to mean pixels. If you do not want any -paging or scrolling when you hit the edge of a page include - - -EdgeScroll 0 0 - - -in your -config -file, or possibly better, set the - -to zero. See the - -command. If you want whole pages, use - - -EdgeScroll 100 100 - - -Both -horizontal and vertical -should be positive numbers. - -If the -horizontal and vertical -percentages are multiplied by 1000 or one of the keywords -, -and -is given then scrolling wraps around at the edge of the desktop. -If - - -EdgeScroll 100000 100000 - - -is used fvwm scrolls by whole pages, wrapping around at the edge -of the desktop. - -
diff --git a/doc/commands/EdgeThickness.xml b/doc/commands/EdgeThickness.xml deleted file mode 100644 index 8711552c0..000000000 --- a/doc/commands/EdgeThickness.xml +++ /dev/null @@ -1,55 +0,0 @@ - - -%myents; -]> - - - -
-EdgeThickness - - - EdgeThickness012 - - -This is the width or height of the invisible window that fvwm -creates on the edges of the screen that are used for the edge -scrolling feature. - -In order to enable page scrolling via the mouse, four windows -called the "pan frames" are placed at the very edge of the -screen. This is how fvwm detects the mouse's presence at the -window edge. Because of the way this works, they need to be at the -top of the stack and eat mouse events, so if you have any kind of -error along the lines of: "mouse clicks at the edge of the screen -do the wrong thing" you're having trouble with the pan frames and -(assuming you do not use the mouse to flip between pages) should -set the EdgeThickness to 0. - -A value of -0 -completely disables mouse edge scrolling, even while dragging a -window. -1 -gives the smallest pan frames, which seem to work best except on -some servers. - -2 -is the default. - -Pan frames of -1 or 2 -pixels can sometimes be confusing, for example, if you drag a -window over the edge of the screen, so that it straddles a pan -frame, clicks on the window, near the edge of the screen are -treated as clicks on the root window. - -
diff --git a/doc/commands/Emulate.xml b/doc/commands/Emulate.xml deleted file mode 100644 index 6220afb4e..000000000 --- a/doc/commands/Emulate.xml +++ /dev/null @@ -1,38 +0,0 @@ - - -%myents; -]> - - - -
-Emulate - - - EmulateFvwmMwmWin - - -This command is a catch all for how miscellaneous things are done -by fvwm. Right now this command affects where the move/resize -feedback window appears and how window placement is aborted. To -have more Mwm- or Win-like behavior you can call -Emulate -with - or - -as its argument. With -Mwm -resize and move feedback windows are in the center of the screen, -instead of the upper left corner. -This also affects how manual placement is aborted. -See the description. - -
diff --git a/doc/commands/EscapeFunc.xml b/doc/commands/EscapeFunc.xml deleted file mode 100644 index 49838043e..000000000 --- a/doc/commands/EscapeFunc.xml +++ /dev/null @@ -1,49 +0,0 @@ - - -%myents; -]> - - - -
-EscapeFunc - - - EscapeFunc - - -By default the key sequence -Ctrl-Alt-Escape -allows for escaping from a - -pause and from a locked - -command. The -EscapeFunc -command used with the - -command allows for configuring this key sequence. An example: - - - Escape A MC - - Escape A S EscapeFunc - - -replaces the -Ctrl-Alt-Escape -key sequence with -Shift-Escape -for aborting a - -pause and - -command. -EscapeFunc -used outside the - -command does nothing. - -
diff --git a/doc/commands/EwmhBaseStruts.xml b/doc/commands/EwmhBaseStruts.xml deleted file mode 100644 index b0d391fab..000000000 --- a/doc/commands/EwmhBaseStruts.xml +++ /dev/null @@ -1,55 +0,0 @@ - - -%myents; -]> - - - -
-EwmhBaseStruts - - - EwmhBaseStruts - - screen RANDRNAME - - left - - - right - - - top - - - bottom - - -Where left, right, top and bottom are positive or null integers - which define bands at the edge of the screen. -If screen is given, followed by the RANDRNAME of a -given display, then the EwmhBaseStruts are defined for just RANDRNAME. -left -defines a band on the left of your screen of width -left, -right -defines a band on the right of your screen of width -right, -top -defines a band on the top of your screen of height -top -and -bottom -defines a band on the bottom of your screen of height -bottom. -The unit is the pixel and the default is 0 0 0 0. These areas -define additional reserved space to the reserved space defined by -some ewmh compliant applications. This is used to compute the -Working Area. See the - -section for a definition of the Working Area. - -
diff --git a/doc/commands/EwmhNumberOfDesktops.xml b/doc/commands/EwmhNumberOfDesktops.xml deleted file mode 100644 index 5f05cc4c8..000000000 --- a/doc/commands/EwmhNumberOfDesktops.xml +++ /dev/null @@ -1,57 +0,0 @@ - - -%myents; -]> - - - -
-EwmhNumberOfDesktops - - - EwmhNumberOfDesktopsnum - max - - -This command is useful only for an ewmh compliant pager or taskbar -(as kpager or kicker taskbar) and not for fvwm modules ( - or ). It causes a -compliant application to consider at least -num -desktops (desktop 0 to desktop -num-1). -The optional argument -max -causes a compliant application to never consider more than -max -desktops. If -max -is 0 (the default) there is no limitation. The actual number of -desktops is determined dynamically. It is at least -num, -but it can be d if there is a window on desktop d-1 (or if the -current desktop is desktop d-1) and d is less or equal to -max -or -max -is null. -Moreover, a compliant pager can ask to change -num -itself. -This is accepted by fvwm only if this number is -less than or equal to -max -or if -max -is null. Note that negative desktops are not supported by the -ewmh specification. The default is 4 0. - -
diff --git a/doc/commands/Exec.xml b/doc/commands/Exec.xml deleted file mode 100644 index ce7d1354d..000000000 --- a/doc/commands/Exec.xml +++ /dev/null @@ -1,58 +0,0 @@ - - -%myents; -]> - - - -
-Exec - - - Execcommand - - -Executes -command. -You should not use an ampersand '&' at the end of the command. You -probably want to use an additional "exec" at the beginning of -command. -Without that, the shell that fvwm invokes to run your command -stays until the command exits. In effect, you'll have twice as -many processes running as you need. Note that some shells are -smart enough to avoid this, but it never hurts to include the -"exec" anyway. - -The following example binds function key -F1 -in the root window, with no modifiers, to the exec function. The -program rxvt is started with an assortment of options. - - - - F1 R N Exec exec rxvt -fg yellow -bg blue \ - -e /bin/tcsh - - -Note that this function doesn't wait for -command -to complete, so things like: - - -Exec "echo ... > /tmp/file" - /tmp/file - - -do not work reliably -(see the - -command). - - -
diff --git a/doc/commands/ExecUseShell.xml b/doc/commands/ExecUseShell.xml deleted file mode 100644 index 37ef91fb8..000000000 --- a/doc/commands/ExecUseShell.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -%myents; -]> - - - -
-ExecUseShell - - - ExecUseShellshell - - -Makes the - -command use the specified shell, or the value of the -$SHELL -environment variable if no shell is specified, instead of the -default Bourne shell -(/bin/sh). - - -ExecUseShell -ExecUseShell /usr/local/bin/tcsh - - - -
diff --git a/doc/commands/FakeClick.xml b/doc/commands/FakeClick.xml deleted file mode 100644 index 8ee422067..000000000 --- a/doc/commands/FakeClick.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - -%myents; -]> - - -
-FakeClick - - - FakeClickcommandvalue - - -This command is mainly intended for debugging fvwm and no -guarantees are made that it works for you. -FakeClick -can simulate mouse button press and release events and pass them -to fvwm or the applications. The parameters are a list of -commands which consist of pairs of -command -tokens and integer -values, -The - and -commands are followed by the appropriate mouse button number and -generate a button press or release event on the window below the -pointer. The - -commands pauses fvwm for the given number of milliseconds. The - -command simulates pressing or releasing modifier keys. The values -1 to 5 are mapped to -Mod1 -to -Mod5 -while 6, 7 and 8 are mapped to -Shift, -Lock -and -Control. -The modifier is set for any further button events. To release a -modifier key, use the corresponding negative number. The - -command determines to which window the button events are -sent. With a depth of 1, all events go to the root window, -regardless of the pointer's position. With 2, the event is passed -to the top level window under the pointer which is usually the -frame window. With 3, events go to the client window. Higher -numbers go to successive sub windows. Zero (0) goes to the -smallest window that contains the pointer. Note that events -propagate upward. - - -FakeClick depth 2 press 1 wait 250 release 1 - - -This simulates a click with button 1 in the parent window (depth -2) with a delay of 250 milliseconds between the press and the -release. -Note: all command names can be abbreviated with their first letter. - - -
diff --git a/doc/commands/FakeKeypress.xml b/doc/commands/FakeKeypress.xml deleted file mode 100644 index 9bc29b402..000000000 --- a/doc/commands/FakeKeypress.xml +++ /dev/null @@ -1,79 +0,0 @@ - - -%myents; -]> - - - -
-FakeKeypress - - - FakeKeypresscommandvalue - - -This command is mainly intended for debugging fvwm and no -guarantees are made that it works for you. -FakeKeypress -can simulate key press and release events and pass them -to fvwm or applications. The parameters are a list of -commands which consist of pairs of command tokens and values. -The - and - -commands are followed by a key name. -The key name is a standard X11 key name as defined in -/usr/include/X11/keysymdef.h, -(without the -XK_ -prefix), or the keysym database -/usr/X11R6/lib/X11/XKeysymDB. -The -, - and - -commands are the same as those used by -. - -Save all GVim sessions with: "Esc:w\n" - - - (gvim) FakeKeypress press Escape \ - press colon \ - press w \ - press Return - - -Save & exit all GVim sessions with: "Esc:wq\n" - - - (gvim) FakeKeypress press Escape \ - press colon \ - press w \ - press q \ - press Return - - -Send A to a specific window: - - - 0x3800002 FakeKeypress press A - - -Note: all command names can be abbreviated with their first letter. - - -
diff --git a/doc/commands/FlipFocus.xml b/doc/commands/FlipFocus.xml deleted file mode 100644 index 6b84f4abe..000000000 --- a/doc/commands/FlipFocus.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -%myents; -]> - - - -
-FlipFocus - - - FlipFocusNoWarp - - -Executes a - -command as if the user had used the pointer to select the -window. This command alters the order of the WindowList in the -same way as clicking in a window to focus, i.e. the target window -is removed from the -WindowList -and placed at the start. This command is recommended for use with -the - -command and in the function invoked from -. - -
diff --git a/doc/commands/Focus.xml b/doc/commands/Focus.xml deleted file mode 100644 index dafdae028..000000000 --- a/doc/commands/Focus.xml +++ /dev/null @@ -1,50 +0,0 @@ - - -%myents; -]> - - - -
-Focus - - - FocusNoWarp - - -Sets the keyboard focus to the selected window. If the - -argument is given, this is all it does. Otherwise it also moves -the viewport or window as needed to make the selected window -visible. This command does not automatically raise the -window. Does not warp the pointer into the selected window (see - -function). Does not de-iconify. This command does not alter the -order of the -WindowList, -it rotates the -WindowList -around so that the target window is at the start. - -When the -NoWarp -argument is given, Focus cannot transfer the keyboard focus to -windows on other desks. - -To raise and/or warp a pointer to a window together with -Focus or , -use a function, like: - - - SelectWindow -+ I Focus -+ I false -+ I -+ I 50 8p - - -
diff --git a/doc/commands/FocusStyle.xml b/doc/commands/FocusStyle.xml deleted file mode 100644 index cba5ff619..000000000 --- a/doc/commands/FocusStyle.xml +++ /dev/null @@ -1,43 +0,0 @@ - - -%myents; -]> - - - -
-FocusStyle - - - FocusStylestylenameoptions - - -works exactly like the - -command, but accepts only the focus policy related styles -beginning with "FP". The prefix can be removed, but at the cost -of a little bit of time. -FocusStyle -is meant to make the configuration file more readable. Example: - - -FocusStyle * EnterToFocus, !LeaveToUnfocus - - -is equivalent to - - - * FPEnterToFocus, !FPLeaveToUnfocus - - - -
diff --git a/doc/commands/Function.xml b/doc/commands/Function.xml deleted file mode 100644 index f6fdc357f..000000000 --- a/doc/commands/Function.xml +++ /dev/null @@ -1,41 +0,0 @@ - - -%myents; -]> - - - -
-Function - - - FunctionFunctionName - - -Used to bind a previously defined function to a key or mouse -button. The following example binds mouse button 1 to a function -called "Move-or-Raise", whose definition was provided as an -example earlier in this man page. After performing this binding -fvwm executes the "move-or-raise" function whenever button 1 is -pressed in a window's title-bar. - - - 1 T A Function Move-or-Raise - - -The keyword -Function -may be omitted if -FunctionName -does not coincide with an fvwm command. - -Warning: Please read the comments on executing complex functions -in the section . - -
diff --git a/doc/commands/GlobalOpts.xml b/doc/commands/GlobalOpts.xml deleted file mode 100644 index 5400f4b77..000000000 --- a/doc/commands/GlobalOpts.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - -%myents; -]> - - -
-GlobalOpts - - - GlobalOptsoptions - - -This command is obsolete. Please -replace the global options in your configuration file according to -the following table: - - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * ! - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - * - -GlobalOpts - --> - on - -GlobalOpts - --> - off - - - - -
diff --git a/doc/commands/GnomeShowDesks.xml b/doc/commands/GnomeShowDesks.xml deleted file mode 100644 index 2533c0765..000000000 --- a/doc/commands/GnomeShowDesks.xml +++ /dev/null @@ -1,28 +0,0 @@ - - -%myents; -]> - - - -
-GnomeShowDesks - - - GnomeShowDesksnumber - - - - -This command tells GNOME compliant applications -the number of desktops that are used by -fvwm. - - -
diff --git a/doc/commands/GotoDesk.xml b/doc/commands/GotoDesk.xml deleted file mode 100644 index aedb41182..000000000 --- a/doc/commands/GotoDesk.xml +++ /dev/null @@ -1,81 +0,0 @@ - - -%myents; -]> - - - -
-GotoDesk - - - GotoDeskprevarg1arg2min max - - - -Switches the current viewport to another desktop (workspace, room). - - -The command takes 1, 2, 3, or 4 arguments. A single argument is -interpreted as a relative desk number. Two arguments are -understood as a relative and an absolute desk number. Three -arguments specify a relative desk and the minimum and maximum of -the allowable range. Four arguments specify the relative, -absolute, minimum and maximum values. (Desktop numbers can be -negative). If a literal - -is given as the single argument, the last visited desk number is -used. - -If -arg1 -is non zero then the next desktop number is the current desktop -number plus -arg1. - -If -arg1 -is zero then the new desktop number is -arg2. -(If -arg2 -is not present, then the command has no effect.) - -If -min and max -are given, the new desktop number is no smaller than -min -and no bigger than -max. -Values out of this range are truncated (if you gave an absolute -desk number) or wrapped around (if you gave a relative desk -number). - -The syntax is the same as for -, -which moves a window to a different desktop. - -The number of active desktops is determined dynamically. Only -desktops which contain windows or are currently being displayed -are active. Desktop numbers must be between 2147483647 and --2147483648 (is that enough?). - -
diff --git a/doc/commands/GotoDeskAndPage.xml b/doc/commands/GotoDeskAndPage.xml deleted file mode 100644 index 88ede5f29..000000000 --- a/doc/commands/GotoDeskAndPage.xml +++ /dev/null @@ -1,41 +0,0 @@ - - -%myents; -]> - - - -
-GotoDeskAndPage - - - GotoDeskAndPage - - screen - prevdeskxpageypage - - -Switches the current viewport to another desktop and page, similar -to the - and -commands. The new desk is -desk -and the new page is -(xpage,ypage). - -
diff --git a/doc/commands/GotoPage.xml b/doc/commands/GotoPage.xml deleted file mode 100644 index 189fa2ad7..000000000 --- a/doc/commands/GotoPage.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - -%myents; -]> - - -
-GotoPage - - - GotoPage - - screen - prevoptionsxpyp - - - -Moves the desktop viewport to page (x,y). The upper left page is -(0,0), the upper right is (M,0), where M is one less than the -current number of horizontal pages specified in the - -command. The lower left page is (0,N), and the lower right page -is (M,N), where N is the desktop's vertical size as specified in the - -command. To switch to a page relative to the current one add a -trailing -'' -after any or both numerical arguments. - -Possible -options -are - and -to wrap around the x or y coordinate when the viewport is moved -beyond the border of the desktop. - -The name of the RandR screen. - -To go to the last visited page use - -as the first argument. The -GotoPage -function should not be used in a pop-up menu. - -Examples: - - -# Go to page (2,3) -GotoPage 2 3 - -# Go to lowest and rightmost page -GotoPage -1 -1 - -# Go to last page visited -GotoPage prev - -# Go two pages to the right and one page up -GotoPage +2p -1p - - - -
diff --git a/doc/commands/HideGeometryWindow.xml b/doc/commands/HideGeometryWindow.xml deleted file mode 100644 index 6985a0c9c..000000000 --- a/doc/commands/HideGeometryWindow.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -%myents; -]> - - - -
-HideGeometryWindow - - - HideGeometryWindowNeverMoveResize - - -Hides the position or size window that is usually shown when a -window is moved or resized interactively. To switch it off only -for move or resize operations the optional parameters - and - -can be used respectively. To switch both on again use the - -option. - -
diff --git a/doc/commands/HilightColor.xml b/doc/commands/HilightColor.xml deleted file mode 100644 index b6ed9656e..000000000 --- a/doc/commands/HilightColor.xml +++ /dev/null @@ -1,37 +0,0 @@ - - -%myents; -]> - - - -
-HilightColor - - - HilightColortextcolorbackgroundcolor - - -This command is obsoleted by the - -options - and -. -Please use - - - * textcolor, backgroundcolor - - -instead. - -
diff --git a/doc/commands/HilightColorset.xml b/doc/commands/HilightColorset.xml deleted file mode 100644 index 759e2a7e4..000000000 --- a/doc/commands/HilightColorset.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -%myents; -]> - - - -
-HilightColorset - - - HilightColorsetnum - - -This command is obsoleted by the - -option -. -Please use - - - * num - - -instead. - -
diff --git a/doc/commands/IconFont.xml b/doc/commands/IconFont.xml deleted file mode 100644 index a1280d4b3..000000000 --- a/doc/commands/IconFont.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -%myents; -]> - - - -
-IconFont - - - IconFontfontname - - -This command is obsoleted by the - -option -. -Please use - - - * IconFont fontname - - -instead. - -
diff --git a/doc/commands/IconPath.xml b/doc/commands/IconPath.xml deleted file mode 100644 index f5d94477f..000000000 --- a/doc/commands/IconPath.xml +++ /dev/null @@ -1,25 +0,0 @@ - - -%myents; -]> - - - -
-IconPath - - - IconPathpath - - -This command is obsolete. Please use - -instead. - -
diff --git a/doc/commands/Iconify.xml b/doc/commands/Iconify.xml deleted file mode 100644 index 75e5ff798..000000000 --- a/doc/commands/Iconify.xml +++ /dev/null @@ -1,38 +0,0 @@ - - -%myents; -]> - - - -
-Iconify - - - Iconifybool - - -Iconifies a window if it is not already iconified or de-iconifies -it if it is already iconified. The optional argument -bool -is a boolean argument. "" means only iconification is -allowed, while "" forces de-iconification. Using "" -switches between iconified and de-iconified states. - -There are a number of - -options which influence the appearance and behavior of icons (e.g. -, ). - -For backward compatibility, the optional argument may also be a -positive number instead of "True", or a negative number instead -of "False". Note that this syntax is obsolete, and will be removed -in the future. - -
diff --git a/doc/commands/IgnoreModifiers.xml b/doc/commands/IgnoreModifiers.xml deleted file mode 100644 index 476494d71..000000000 --- a/doc/commands/IgnoreModifiers.xml +++ /dev/null @@ -1,78 +0,0 @@ - - -%myents; -]> - - - -
-IgnoreModifiers - - - IgnoreModifiersModifiers - - -Tells fvwm which modifiers to ignore when matching Mouse or Key -bindings. -IgnoreModifiers -affects the - -style too. This command belongs into your -config. -If you issue it when your fvwm session is already up and running -the results are unpredictable. The should appear before any -applications or modules are started in your -config -file (e.g. with the - -command). - -Modifiers -has the same syntax as in the - or -bindings, with the addition of 'L' meaning the -caps lock -key. The default is "L". -Modifiers -can be omitted, meaning no modifiers are ignored. This command -comes in handy if the -num-lock -and -scroll-lock -keys interfere with your shortcuts. With XFree86 '2' usually is -the -num-lock -modifier and '5' refers to the -scroll-lock -key. To turn all these pesky modifiers off you can use this -command: - - -IgnoreModifiers L25 - - -If the -Modifiers -argument is the string "", fvwm reverts back to the -default value "L". - - -This command creates a lot of extra network traffic, depending on -your CPU, network connection, the number of - or -commands in your configuration file and the number of modifiers -you want to ignore. If you do not have a lightning fast machine -or very few bindings you should not ignore more than two -modifiers. I.e. do not ignore -scroll-lock -if you have no problem with it. In the -FAQ -you can find a better solution of this problem. - -
diff --git a/doc/commands/ImagePath.xml b/doc/commands/ImagePath.xml deleted file mode 100644 index 21a10c5d8..000000000 --- a/doc/commands/ImagePath.xml +++ /dev/null @@ -1,73 +0,0 @@ - - -%myents; -]> - - - -
-ImagePath - - - ImagePathpath - - -Specifies a colon separated list of directories in which to search -for images (both monochrome and pixmap). To find an image given -by a relative pathname, fvwm looks into each directory listed in -turn, and uses the first file found. - -If a directory is given in the form "/some/dir;.ext", this means -all images in this directory have the extension ".ext" that should -be forced. The original image name (that may contain another -extension or no extension at all) is not probed, instead ".ext" is -added or replaces the original extension. This is useful, for -example, if a user has some image directories with ".xpm" images -and other image directories with the same names, but ".png" -images. - -The -path -may contain environment variables such as -$HOME (or ${HOME}). -Further, a '+' in the -path -is expanded to the previous value of the path, allowing appending -or prepending to the path easily. - -For example: - - -ImagePath $HOME/icons:+:/usr/include/X11/bitmaps - - -Note: if the - -module is used to parse your -config -files, then m4 may want to mangle the word "include" which -frequently shows up in the -ImagePath -command. To fix this one may add - - -undefine(`include') - - -prior to the -ImagePath -command, or better: use the - -option to force all -m4 -directives to have a prefix of "m4_" (see the - -man page). - -
diff --git a/doc/commands/InfoStoreAdd.xml b/doc/commands/InfoStoreAdd.xml deleted file mode 100644 index 7a6f8966b..000000000 --- a/doc/commands/InfoStoreAdd.xml +++ /dev/null @@ -1,57 +0,0 @@ - - -%myents; -]> - -
-InfoStoreAdd - - - InfoStoreAdd - - key - - - value - - - -Stores the value at the given - key. This is useful to store generic - information used in the lifetime of an fvwm config file. For example - storing program preferences for opening video files. - - -The purpose of this command is to store internal information to fvwm - which can be used bu fvwm functions, or when opening programs of a - certain type. Previous to this command the only way to do this was - via but this is discouraged because it places - such information in the environment, which pollutes it and makes the - information global to other processes started by fvwm which may then - modify them which might not be what's wanted. Hence the point of - is to still allow for such information to - be stored, but kept internal to fvwm. - - -In this way, one can build up as many key/value pairs as needed. - Recalling the value of a given key happens through fvwm's usual expansion - mechanism. See the - section for more details. For example: - - - - InfoStoreAdd teddybearprog xteddy - - # Echo the value of teddybearprog - Echo $[infostore.teddybearprog] - - -Removing an entry from the InfoStore is done with the - command. - - -
diff --git a/doc/commands/InfoStoreClear.xml b/doc/commands/InfoStoreClear.xml deleted file mode 100644 index 290129905..000000000 --- a/doc/commands/InfoStoreClear.xml +++ /dev/null @@ -1,21 +0,0 @@ - - -%myents; -]> - -
-InfoStoreClear - - - InfoStoreClear - - key - - - -Removes all entries from the Infostore. - -
diff --git a/doc/commands/InfoStoreRemove.xml b/doc/commands/InfoStoreRemove.xml deleted file mode 100644 index dba1f4d50..000000000 --- a/doc/commands/InfoStoreRemove.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -%myents; -]> - -
-InfoStoreRemove - - - InfoStoreRemove - - key - - - -Removes an entry at the given - key from the InfoStore. Example: - - - -InfoStoreRemove teddybearprog - - -
diff --git a/doc/commands/KeepRc.xml b/doc/commands/KeepRc.xml deleted file mode 100644 index ed651113f..000000000 --- a/doc/commands/KeepRc.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -%myents; -]> - - - -
-KeepRc - - - KeepRccommand - - -Runs the -command -but does not alter the return code of the previous command. Note: -KeepRc -is treated as a prefix to its -command. -Expansion of the command line is done as if -KeepRc -was not there. - -
diff --git a/doc/commands/Key.xml b/doc/commands/Key.xml deleted file mode 100644 index 97c15acd7..000000000 --- a/doc/commands/Key.xml +++ /dev/null @@ -1,91 +0,0 @@ - - -%myents; -]> - - - -
-Key - - - Key(window) - Keyname - Context - Modifiers - Function - - -Binds a keyboard key to a specified fvwm command, or -removes the binding if -Function -is '-'. The syntax is the same as for a - -binding except that the mouse button number is replaced with a -Keyname. -Normally, the key binding is activated when the key is pressed. -Keyname -is a standard X11 key name as defined in -/usr/include/X11/keysymdef.h, -(without the -XK_ -prefix), or the keysym database -/usr/X11R6/lib/X11/XKeysymDB. -Only key names that are -generated with no modifier keys or with just the -Shift -key held are guaranteed to work. The -Context and Modifiers -fields are defined as in the - -binding. However, when you press a key the context window is the -window that has the keyboard focus. That is not necessarily the -same as the window the pointer is over (with - or -). -Note that key bindings with the '' (root window) context do not -work properly with - and -. -If you encounter problems, use the - -command instead. If you want to bind keys to a window with - or - -that are supposed to work when the pointer is not over the window, -fvwm assumes the pointer is over the client window (i.e. you have -to use the 'W' context). - -The special context '' for menus can be used to (re)define the menu -controls. It be used alone or together with 'T', 'S', 'I', '[', ']', '-' and '_'. See the -section for details. - -The following example binds the built-in window list to pop up -when -Alt-Ctrl-Shift-F11 -is hit, no matter where the mouse pointer is: - - -Key F11 A SCM - - -Binding a key to a title-bar button causes that button to appear. -Please refer to the - -command for details. - -
diff --git a/doc/commands/KillModule.xml b/doc/commands/KillModule.xml deleted file mode 100644 index b1abd0840..000000000 --- a/doc/commands/KillModule.xml +++ /dev/null @@ -1,39 +0,0 @@ - - -%myents; -]> - - - -
-KillModule - - - KillModulemodulenamemodulealias - - -Causes the module which was invoked with name -modulename -to be killed. The name may include wildcards. If -modulealias -is given, only modules started with the given alias are killed. - - -# kill all pagers -KillModule FvwmPager - - FvwmEvent SoundEvent -KillModule FvwmEvent SoundEvent - - - -
diff --git a/doc/commands/Layer.xml b/doc/commands/Layer.xml deleted file mode 100644 index fa004fe3b..000000000 --- a/doc/commands/Layer.xml +++ /dev/null @@ -1,40 +0,0 @@ - - -%myents; -]> - - - -
-Layer - - - Layerarg1 arg2default - - -Puts the current window in a new layer. If -arg1 -is non zero then the next layer is the current layer number plus -arg1. -If -arg1 -is zero then the new layer is -arg2. - -As a special case, - -puts the window in its default layer, i.e. the layer it was -initially in. The same happens if no or invalid arguments are -specified. - -
diff --git a/doc/commands/LocalePath.xml b/doc/commands/LocalePath.xml deleted file mode 100644 index e4e82eeba..000000000 --- a/doc/commands/LocalePath.xml +++ /dev/null @@ -1,96 +0,0 @@ - - -%myents; -]> - - - -
-LocalePath - - - LocalePathpath - - -Specifies a colon separated list of "locale path" in which to -search for string translations. A locale path is constituted by a -directory path and a text domain separated by a semicolon -(';'). As an example the default locale path is: - - -/install_prefix/share/locale;fvwm - - -where install_prefix is the fvwm installation directory. With such -a locale path translations are searched for in - - -/install_prefix/share/locale/lang/LC_MESSAGES/fvwm.mo - - -where -lang -depends on the locale. If no directory is given the default -directory path is assumed. If no text domain is given, -fvwm -is assumed. Without argument the default locale path is restored. - -As for the - -command, -path -may contain environment variables and a '+' to append or prepend -the locale path easily. - -For example, the fvwm-themes package uses - - -LocalePath ";fvwm-themes:+" - - -to add locale catalogs. - -The default fvwm catalog contains a few strings used by the fvwm -executable itself (Desk and Geometry) and strings used in some -default configuration files and - -configuration. You can take a look at the po/ subdirectory of the -fvwm source to get the list of the strings with a possible -translation in various languages. At present, very few languages -are supported. - -The main use of locale catalogs is via the "$[gt.string]" -parameter: - - - MenuFvwmWindowOps - MenuFvwmWindowOps "$[gt.Window Ops]" -+ "$[gt.&Move]" -+ "$[gt.&Resize]" -+ "$[gt.R&aise]" -+ "$[gt.&Lower]" -+ "$[gt.(De)&Iconify]" -+ "$[gt.(Un)&Stick]" -+ "$[gt.(Un)Ma&ximize]" -+ "" -+ "$[gt.&Close]" -+ "$[gt.&Destroy]" - - -gives a menu in the locale languages if translations are -available. - -Note that the - -module has a set of special instructions for string -translation. It is out of the scope of this discussion to explain -how to build locale catalogs. Please refer to the GNU gettext -documentation. - -
diff --git a/doc/commands/Lower.xml b/doc/commands/Lower.xml deleted file mode 100644 index ac999bb2f..000000000 --- a/doc/commands/Lower.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -%myents; -]> - - - -
-Lower - - - Lower - - -Allows the user to lower a window. Note that this lowers a window -only in its layer. To bring a window to the absolute bottom, use - - - lower-to-bottom - + I 0 0 - + I Lower - - -
diff --git a/doc/commands/Makefile.am b/doc/commands/Makefile.am deleted file mode 100755 index 766f55385..000000000 --- a/doc/commands/Makefile.am +++ /dev/null @@ -1,29 +0,0 @@ -docdir = @FVWM_DOCDIR@/commands -XSLTPROC = @XSLTPROC@ - -XSL_FILE = $(srcdir)/../fvwm3.xsl -XSL_PROFILE = $(srcdir)/../docbook-xsl/profiling/profile.xsl - -EXTRA_DIST = @DOC_COMMANDS_XML@ WindowsDesk.xml - -if FVWM_BUILD_HTMLDOC -doc_DATA = @DOC_COMMANDS_HTML@ WindowsDesk.html -all: @DOC_COMMANDS_HTML@ WindowsDesk.html -endif - -clean: - rm -f @DOC_COMMANDS_HTML@ WindowsDesk.html - -distclean-local: clean - -# All HTML output is generated from XML files. -%.html : $(srcdir)/%.xml $(srcdir)/../header.html $(srcdir)/../style.css - $(XSLTPROC) --path "$(top_builddir)/doc" --xinclude \ - --stringparam profile.attribute output \ - --stringparam profile.value html \ - -o $( - -%myents; -]> - - - -
-Maximize - - - Maximizeflags - bool | forgethorizontalpverticalp - - - -Without its optional arguments (or if the -bool -bit has the value "") -Maximize -causes the window to alternately switch from a full-screen size to -its normal size. To force a window into maximized (normal) state -you can use a "" or "" value for the -bool -argument. - -With just the parameter "forget" a maximized window reverts -back into normal state but keeps its current maximized size. This -can be useful in conjunction with the commands - and . If -the window is not maximized, nothing happens. - -With the optional arguments -horizontal and vertical, -which are expressed as percentage of a full screen, the user can -control the new size of the window. An optional suffix -'' -can be used to indicate pixels instead of percents of the screen -size. If horizontal is greater than 0 then the horizontal -dimension of the window is set to -horizontal*screen_width/100. -If the value is smaller than 0 the size is subtracted from the -screen width, i.e. -25 is the same as 75. If -horizontal -is "", it is maximized to curren -available space until -finding any obstacle. The vertical resizing is similar. If both -horizontal and vertical values are "grow", it expands vertically -first, then horizontally to find space. Instead of the horizontal -"grow" argument, "" or "" can be used -respectively "" and "". -The optional -flags -argument is a space separated list containing the following -key words: -fullscreen, ewmhiwa, growonwindowlayer, growonlayers and screen. - -causes the window to become fullscreened if the appropriate EWMH hint is set. - -causes fvwm to ignore the EWMH working area. - -causes the various grow methods to ignore windows with a layer -other than the current layer of the window which is maximized. -The - -option must have two integer arguments. The first one is the -minimum layer and the second one the maximum layer to use. -Windows that are outside of this range of layers are ignored by -the grow methods. A negative value as the first or second -argument means to assume no minimum or maximum layer. - -must have an argument which specifies the screen on which -to operate. - -Here are some examples. The following adds a title-bar button to -switch a window to the full vertical size of the screen: - - - 0 4 A Maximize 0 100 - - -The following causes windows to be stretched to the full width: - - - 0 4 A Maximize 100 0 - - -This makes a window that is half the screen size in each -direction: - - - 0 4 A Maximize 50 50 - - -To expand a window horizontally until any other window is found: - - - 0 4 A Maximize 0 grow - - -To expand a window until any other window on the same or a higher -layer is hit. - - - 0 4 A Maximize growonlayers $[w.layer] -1 grow grow - - -To expand a window but leave the lower 60 pixels of the screen -unoccupied: - - - 0 4 A Maximize 100 -60p - - -Values larger than 100 can be used with caution. - -
diff --git a/doc/commands/Menu.xml b/doc/commands/Menu.xml deleted file mode 100644 index 42de2a2a5..000000000 --- a/doc/commands/Menu.xml +++ /dev/null @@ -1,249 +0,0 @@ - - -%myents; -]> - - - - diff --git a/doc/commands/MenuStyle.xml b/doc/commands/MenuStyle.xml deleted file mode 100644 index 7d8290e89..000000000 --- a/doc/commands/MenuStyle.xml +++ /dev/null @@ -1,840 +0,0 @@ - - - -%myents; -]> - - - diff --git a/doc/commands/Module.xml b/doc/commands/Module.xml deleted file mode 100644 index 609dd69f6..000000000 --- a/doc/commands/Module.xml +++ /dev/null @@ -1,80 +0,0 @@ - - -%myents; -]> - - - -
-Module - - - Modulemodulenamemoduleparams - - -Specifies a module with its optional parameters which should be -spawned. Currently several modules, including -, -, -, -, - -support aliases. Aliases are useful if more than one instance of -the module should be spawned. Aliases may be configured -separately using -* -syntax. To start a module -FvwmForm -using an alias -MyForm, -the following syntax may be used: - - -Module FvwmForm MyForm - - - -At the current time the available modules (included with fvwm) are - (produces animation effects when a window is iconified or de-iconified), - (an auto raise module), - (to change the background when you change desktops), - (to display a spiffy XBM, XPM, PNG or SVG), - (brings up a customizable tool bar), - (a command server to use with shell's FvwmCommand client), - (to execute fvwm commands directly), - (to preprocess your config with cpp), - (trigger various actions by events), - (to bring up dialogs), - (a flexible icon manager), - (to get window info), - (to preprocess your config with m4), - (a mini version of the desktop), - (a Perl manipulator and preprocessor), - (to locate and control obscured windows by using small proxy windows), - (to rearrange windows), - (another powerful dialog toolkit), -These modules have their own man -pages. There may be other modules out on there as well. - - -Modules can be short lived transient programs or, like - -, -can remain for the duration of the X session. Modules are -terminated by the window manager prior to restarts and quits, if -possible. See the introductory section on modules. The keyword -Module -may be omitted if -modulename -is distinct from all fvwm commands. - -
diff --git a/doc/commands/ModuleListenOnly.xml b/doc/commands/ModuleListenOnly.xml deleted file mode 100644 index a602c30ca..000000000 --- a/doc/commands/ModuleListenOnly.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -%myents; -]> - - - -
-ModuleListenOnly - - - ModuleListenOnlymodulenamemoduleparams - - -This command works like the - -command, but fvwm never sends any messages to the module. This may -be handy to write a module as a shell script that is triggered by -external events without the burden to answer packets sent by -fvwm. For example, a module written as a shell script may change -labels of the - -module to implement a simple clock. - -
diff --git a/doc/commands/ModulePath.xml b/doc/commands/ModulePath.xml deleted file mode 100644 index c8ae08223..000000000 --- a/doc/commands/ModulePath.xml +++ /dev/null @@ -1,47 +0,0 @@ - - -%myents; -]> - - - -
-ModulePath - - - ModulePathpath - - -Specifies a colon separated list of directories in which to search -for modules. To find a module, fvwm searches each directory in -turn and uses the first file found. Directory names on the list -do not need trailing slashes. - -The -ModulePath -may contain environment variables such as -$HOME (or ${HOME}). -Further, a '+' in the -path -is expanded to the previous value of the -path, -allowing easy appending or prepending to the -path. - -For example: - - -ModulePath ${HOME}/lib/fvwm/modules:+ - - -The directory containing the standard modules is available via the -environment variable -$FVWM_MODULEDIR. - -
diff --git a/doc/commands/ModuleSynchronous.xml b/doc/commands/ModuleSynchronous.xml deleted file mode 100644 index ba29200fb..000000000 --- a/doc/commands/ModuleSynchronous.xml +++ /dev/null @@ -1,61 +0,0 @@ - - -%myents; -]> - - - -
-ModuleSynchronous - - - ModuleSynchronousExpect stringTimeout secsmodulename - - -The -ModuleSynchronous -command is very similar to -. -Fvwm stops processing any commands and user input until the module -sends a string beginning with "NOP FINISHED STARTUP" back to fvwm. -If the optional - -is given fvwm gives up if the module sent no input back to fvwm -for -secs -seconds. If the - -option is given, fvwm waits for the given -string -instead. -ModuleSynchronous -should only be used during fvwm startup to enforce the order in -which modules are started. This command is intended for use with -the (currently hypothetical) module that should be in place before -other modules are started. - -Warning: It is quite easy to hang fvwm with this command, even if -a timeout is given. Be extra careful choosing the string to wait -for. Although all modules in the fvwm distribution send back the -"NOP FINISHED STARTUP" string once they have properly started up, -this may not be the case for third party modules. Moreover, you -can try to escape from a locked -ModuleSynchronous -command by using the key sequence -Ctrl-Alt-Escape -(see the -). - -
diff --git a/doc/commands/ModuleTimeout.xml b/doc/commands/ModuleTimeout.xml deleted file mode 100644 index df55915b9..000000000 --- a/doc/commands/ModuleTimeout.xml +++ /dev/null @@ -1,28 +0,0 @@ - - -%myents; -]> - - - -
-ModuleTimeout - - - ModuleTimeouttimeout - - -Specifies how many seconds fvwm waits for a module to respond. If -the module does not respond within the time limit then fvwm kills -it. -timeout -must be greater than zero, or it is reset to the default value of -30 seconds. - -
diff --git a/doc/commands/Mouse.xml b/doc/commands/Mouse.xml deleted file mode 100644 index 9206e4b20..000000000 --- a/doc/commands/Mouse.xml +++ /dev/null @@ -1,215 +0,0 @@ - - -%myents; -]> - - - -
-Mouse - - - Mouse(window)ButtonContextModifiersFunction - - -Defines a mouse binding, or removes the binding if -Function -is '-'. -Button -is the mouse button number. If -Button -is zero then any button performs the specified function. Note -that only mouse buttons 1 to 5 are fully supported by X11. Any -number above this works only partially. Complex functions can not -be used with these buttons and neither any operation that requires -dragging the pointer with the button held. This is due to -limitations of X11. By default, the highest allowed button number -is 9. - -Context -describes where the binding applies. Valid contexts are -'' for the root window, -'' for an application window, -'' for a desktop application (as kdesktop or Nautilus desktop), -'' for a window title-bar, -'' for a window side, top, or bottom bar, -'', -'', -'' and -'' for the left, right, top or bottom side only, -'' for a window frame (the corners), -'<', '^', '>' and -'' for the top -left, top right, bottom right or bottom left corner, -'' for an icon window, or -'' through -'' for title-bar buttons, or any combination of these letters. -'' is for any context. For -instance, a context of "FST" applies when the mouse is anywhere in -a window's border except the title-bar buttons. Only 'S' and 'W' -are valid for an undecorated window. - -The special context '' for menus can be used to (re)define the menu -controls. It can be used alone or together with 'T', 'S', 'I', '[', ']', '-' and '_'. See the - -section for details. - -The special context '' controls what buttons that can be used to -place a window. When using this context no modifiers are allowed -(Modifiers -must be N), no -window -is allowed, and the -Function -must be one of -PlaceWindow, -PlaceWindowDrag, -PlaceWindowInteractive, -CancelPlacement, -CancelPlacementDrag, -CancelPlacementInteractive or --. - - - -makes -Button -usable for window placement, both for interactive and drag move. - -does the inverse. That is makes -Button -to cancel move for both interactive and drag move. It may however -not override how new windows are resized after being placed. This -is controlled by the - -command. Also a window being dragged can always be placed -by releasing the button hold while dragging, regardless of if it is -set to -PlaceWindow -or not. - - - and -/ -and -work as -PlaceWindow/CancelPlacement -with the exception that they only affect either windows dragged / -placed interactively. - - - -is equivalent to -CancelPlacement. - -The following example makes all buttons but button 3 usable for -interactive placement and makes drag moves started by other buttons -than one cancel if button 1 is pressed before finishing the move: - - -Mouse 0 P N PlaceWindow -Mouse 3 P N CancelPlacement -Mouse 1 P N CancelPlacementDrag - - - -By default, the binding applies to all windows. You can specify -that a binding only applies to specific windows by specifying the -window name in brackets. The window name is a wildcard pattern -specifying the class, resource or name of the window you want the -binding to apply to. - -The following example shows how the same key-binding can be used to -perform different functions depending on the window that is focused: - - - (rxvt) V A C ctrl-V-in-RXVT - (*term) V A C ctrl-V-in-Term - (*vim) V A C -- - V A C ctrl-V-elsewhere - - - -A '' action indicates that the event should be propagated to the -specified window to handle. This is only a valid action for -window-specific bindings. - -This example shows how to display the WindowList when Button 3 is -pressed on an rxvt window: - - -Mouse (rxvt) 3 A A - - - -Note that Fvwm actually intercepts all events for a window-specific -binding and (if the focused window doesn't match any of the -bindings) sends a synthetic copy of the event to the window. This -should be transparent to most applications, however (for security -reasons) some programs ignore these synthetic events by default - -xterm is one of them. To enable handling of these events, add the -following line to your ~/.Xdefaults file: - - - -XTerm*allowSendEvents: true - - - -Modifiers -is any combination of -'' for no modifiers, -'' for control, -'' for shift, -'' for Meta, -'' for Caps-Lock or -'' for any -modifier. For example, a modifier of "SM" applies when both the -Meta -and -Shift -keys are down. X11 modifiers mod1 through mod5 are represented as -the digits '1' through '5'. The modifier 'L' is ignored by -default. To turn it on, use the - -command. - -Function -is one of fvwm's commands. - -The title-bar buttons are numbered with odd numbered buttons on -the left side of the title-bar and even numbers on the -right. Smaller-numbered buttons are displayed toward the outside -of the window while larger-numbered buttons appear toward the -middle of the window (0 is short for 10). In summary, the buttons -are numbered: - - -1 3 5 7 9 0 8 6 4 2 - - -The highest odd numbered button which has an action bound to it -determines the number of buttons drawn on the left side of the -title bar. The highest even number determines the number of right -side buttons which are drawn. Actions can be bound to either -mouse buttons or keyboard keys. - -
diff --git a/doc/commands/Move.xml b/doc/commands/Move.xml deleted file mode 100644 index 7b1c40c8b..000000000 --- a/doc/commands/Move.xml +++ /dev/null @@ -1,177 +0,0 @@ - - -%myents; -]> - - - -
-Move - - - Movescreen screenwmxpwwmypwWarppointerewmhiwa - - - -Allows the user to move a window. If called from somewhere in a -window or its border, then that window is moved. If called from -the root window then the user is allowed to select the target -window. By default, the EWMH working area is honoured. - -If the literal option followed by a -screen -argument is specified, the coordinates are interpreted as relative -to the given screen. The width and height of the screen are used -for the calculations instead of the display dimensions. The -screen -as interpreted as in the - -command. -If the optional argument - -is specified the pointer is warped with the window. If the single -argument - -is given, the top left corner of the window is moved to the -pointer position before starting the operation; this is mainly -intended for internal use by modules like -. -If the optional argument - -is given, then the window position will ignore the working area -(such as ignoring any values set via ). - -The operation can be aborted with Escape or any mouse -button not set to place the window. By default mouse button 2 is set to cancel -the move operation. To change this you may use the - -command with special context 'P' for Placement. - -The window condition - -can be used to check if a specific button was pressed to place the -window (see - -command). - -If the optional arguments - and - -are provided, then the window is moved immediately without user -interaction. Each argument can specify an absolute or relative -position from either the left/top or right/bottom of the screen. -By default, the numeric value given is interpreted as a percentage -of the screen width/height, but a trailing -'p' -changes the interpretation to mean pixels, while a trailing -'w' -means precent of the window width/height. -To move the window -relative to its current position, add the -'' -(for "window") prefix before the -x and/or y -value. To move the window to a position relative to the current -location of the pointer, add the -'' -(for "mouse") prefix. To leave either coordinate unchanged, -"" can be specified in place of -x or y. - -For advanced uses, the arguments -x and y -can be used multiple times, but without the prefix -'m' or 'w'. -(See complex examples below). - -Simple Examples: - - -# Interactive move - 1 T A Move -# Move window to top left is at (10%,10%) - 2 T A Move 10 10 -# Move top left to (10pixels,10pixels) - 3 T A Move 10p 10p - - -More complex examples (these can be bound as actions to -keystrokes, etc.; only the command is shown, though): - - -# Move window so bottom right is at bottom -# right of screen -Move -0 -0 - -# Move window so top left corner is 10 pixels -# off the top left screen edge -Move +-10 +-10 - -# Move window 5% to the right, and to the -# middle vertically -Move w+5 50 - -# Move window up 10 pixels, and so left edge -# is at x=40 pixels -Move 40p w-10p - -# Move window to the mouse pointer location -Move m+0 m+0 - -# Move window to center of screen (50% of screen -# poition minus 50% of widow size). -Move 50-50w 50-50w - - -Note: In order to obtain moving windows which do not snap -to screen, with interactive move, hold down Alt -whilst moving the window to disable snap attraction if it's defined. - - -See also the - -command. - -
diff --git a/doc/commands/MoveThreshold.xml b/doc/commands/MoveThreshold.xml deleted file mode 100644 index 9d939096e..000000000 --- a/doc/commands/MoveThreshold.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -%myents; -]> - - - -
-MoveThreshold - - - MoveThresholdpixels - - -When the user presses a mouse button upon an object fvwm waits to -see if the action is a click or a drag. If the mouse moves by -more than -pixels -pixels it is assumed to be a drag. - -Previous versions of fvwm hardwired -pixels -to 3, which is now the default value. If -pixels -is negative or omitted the default value (which might be increased -when 16000x9000 pixel displays become affordable) is restored. - -
diff --git a/doc/commands/MoveToDesk.xml b/doc/commands/MoveToDesk.xml deleted file mode 100644 index 8a061b920..000000000 --- a/doc/commands/MoveToDesk.xml +++ /dev/null @@ -1,43 +0,0 @@ - - -%myents; -]> - - - -
-MoveToDesk - - - MoveToDeskprevarg1arg2 - min max - - -Moves the selected window to another desktop. The arguments are -the same as for the - -command. Without any arguments, the window is moved to the -current desk. -MoveToDesk -is a replacement for the obsolete - -command, which can no longer be used. - -
diff --git a/doc/commands/MoveToPage.xml b/doc/commands/MoveToPage.xml deleted file mode 100644 index 82a113f56..000000000 --- a/doc/commands/MoveToPage.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - -%myents; -]> - - -
-MoveToPage - - - MoveToPageoptionsxpwypwprev - - -Moves the selected window to another page -(x,y). The -upper left page is (0,0), the upper right is (M,0), where M is one -less than the current number of horizontal pages specified in the - -command. Similarly the lower left page is (0,N), and the lower -right page is (M,N). Negative page numbers refer to pages from -the rightmost/lowest page. If - and - -are not given, the window is moved to the current page (a window -that has the focus but is off-screen can be retrieved with this). -Moving windows to a page relative to the current page can be -achieved by adding a trailing -'' -after any or both numerical arguments. To move the window -relative to its current location, add a trailing -''. -To move a window to the previous page use - -as the single argument. - -Windows are usually not moved beyond desk boundaries. - -Possible -options -are - and - -to wrap around the x or y coordinate when the window is moved -beyond the border of the desktop. For example, with -wrapx, -when the window moves past the right edge of the desktop, it -reappears on the left edge. The options - and - -allow moving windows beyond the desk boundaries in x and y -direction (disabling the -wrapx and wrapy -options). - -Examples: - - -# window to page (2,3) -MoveToPage 2 3 - -# window to lowest and rightmost page -MoveToPage -1 -1 - -# window to last page visited -MoveToPage prev - -# window two pages to the right and one -# page up, wrap at desk boundaries -MoveToPage wrapx wrapy +2p -1p - - -
diff --git a/doc/commands/MoveToScreen.xml b/doc/commands/MoveToScreen.xml deleted file mode 100644 index 59718c31f..000000000 --- a/doc/commands/MoveToScreen.xml +++ /dev/null @@ -1,25 +0,0 @@ - - -%myents; -]> - - - -
-MoveToScreen - - - MoveToScreenscreen - - -Moves the selected window to another screen. The -screen -argument must be a valid RandR name. - -
diff --git a/doc/commands/Next.xml b/doc/commands/Next.xml deleted file mode 100644 index 7e680b3f7..000000000 --- a/doc/commands/Next.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -%myents; -]> - - -
-Next - - - Next(conditions) - command - - -Performs -command -(typically -) -on the next window which satisfies all -conditions. -If the command is running in a window context, it starts looking -for a matching window from there. Otherwise it starts at the -focused window. -See section for a list of conditions. - -
diff --git a/doc/commands/NoWindow.xml b/doc/commands/NoWindow.xml deleted file mode 100644 index 84e6a0867..000000000 --- a/doc/commands/NoWindow.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -%myents; -]> - - - -
-NoWindow - - - NoWindowcommand - - -Performs -command, -but removes the window context if any. This is not really a -conditional command, but a prefix that may be useful in menu items -that should operate without a window even if such menu is bound to -window decorations. -
diff --git a/doc/commands/None.xml b/doc/commands/None.xml deleted file mode 100644 index 6f3a79887..000000000 --- a/doc/commands/None.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - -%myents; -]> - - -
-None - - - None(conditions)command - - -Performs -command -if no window which satisfies all -conditions -exists. The command is run in the context of the root window. -Returns 1 if no window matches the conditions and 0 otherwise. -See section for a list of conditions. - -This command implies the conditions -CirculateHit, CirculateHitIcon and CirculateHitShaded. -They can be turned off by specifying -!CirculateHit -etc. explicitly. - -
diff --git a/doc/commands/Nop.xml b/doc/commands/Nop.xml deleted file mode 100644 index 376b377e2..000000000 --- a/doc/commands/Nop.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -%myents; -]> - - - -
-Nop - - - Nop - - -Does nothing. This is used to insert a blank line or separator in -a menu. If the menu item specification is - - - MyMenu " " Nop - - -then a blank line is inserted. If it looks like - - -+ "" Nop - - -then a separator line is inserted. Can also be used as the -double-click action for - or Popup. - -
diff --git a/doc/commands/OpaqueMoveSize.xml b/doc/commands/OpaqueMoveSize.xml deleted file mode 100644 index c121223ad..000000000 --- a/doc/commands/OpaqueMoveSize.xml +++ /dev/null @@ -1,50 +0,0 @@ - - -%myents; -]> - - - -
-OpaqueMoveSize - - - OpaqueMoveSizepercentage - - - -Tells fvwm the maximum size window with which opaque window -movement should be used. The percentage is percent of the total -screen area (may be greater than 100). With - -OpaqueMoveSize 0 - -all windows are moved using the traditional rubber-band -outline. With - - -OpaqueMoveSize - - -or if a negative percentage is given -all windows are moved as solid windows. The default is - -OpaqueMoveSize 5 - -which allows small windows to be moved in an opaque manner but -large windows are moved as rubber-bands. If -percentage -is omitted or invalid the default value is set. To resize windows -in an opaque manner you can use the - -style. See -the -command. - -
diff --git a/doc/commands/Pick.xml b/doc/commands/Pick.xml deleted file mode 100644 index b671fabcf..000000000 --- a/doc/commands/Pick.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - -%myents; -]> - - -
-Pick - - - Pick(conditions)command - - -Pick -works like - -if invoked in the context of a window. If invoked in the root -window, it first asks the user to pick a window and then executes -the -command -in the context of that window. This avoids annoying multiple -selections with complex functions. The command is executed only -if the given -conditions -are met. Returns -1 if no window was selected. -See section for a list of conditions. - -This command implies the conditions -CirculateHit, CirculateHitIcon and CirculateHitShaded. -They can be turned off by specifying -!CirculateHit -etc. explicitly. - -
diff --git a/doc/commands/PipeRead.xml b/doc/commands/PipeRead.xml deleted file mode 100644 index 2acd01a42..000000000 --- a/doc/commands/PipeRead.xml +++ /dev/null @@ -1,78 +0,0 @@ - - -%myents; -]> - - - -
-PipeRead - - - PipeReadcommandquiet - - -Causes fvwm to read commands from the output of the -command. -This -command -is executed by -/bin/sh -as if you typed it on the command line. If the command consists -of more than one word it must be quoted. Useful for building up -dynamic menu entries based on a directories contents, for -example. If the keyword - -follows the command no message is produced if the -command -is not found. - -Example: - - - HomeDirMenu -PipeRead 'for i in $HOME/*; \ - do echo "+ $i xterm -e vi $i"; done' - - - -Note: The -PipeRead -changes the pointer to a watch cursor by default during -execution. However, some commands, for example xwd, need to take -control of the pointer themselves and do not work. To disable the -watch cursor, use the command prior to -PipeRead - - - off - - - -The -PipeRead -command executes synchronously. If you want to - -something, but need the command to run synchronously, -you might do something like: - - -PipeRead 'command 1>&2' - - -The redirection causes any output from the program to go to stderr -instead of being read as a sequence of commands by fvwm. -PipeRead -returns 1 if the given command could be executed or -1 if not -(see the section - -for the meaning of return codes). - -
diff --git a/doc/commands/PixmapPath.xml b/doc/commands/PixmapPath.xml deleted file mode 100644 index 4813aa826..000000000 --- a/doc/commands/PixmapPath.xml +++ /dev/null @@ -1,25 +0,0 @@ - - -%myents; -]> - - - -
-PixmapPath - - - PixmapPathpath - - -This command is obsolete. Please use - -instead. - -
diff --git a/doc/commands/PlaceAgain.xml b/doc/commands/PlaceAgain.xml deleted file mode 100644 index 499d01f0e..000000000 --- a/doc/commands/PlaceAgain.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -%myents; -]> - - - -
-PlaceAgain - - - PlaceAgainAnimIcon - - - -Causes the current window's position to be re-computed using the -initial window placement logic. The window is moved to where it -would have been if it were a new window that had just appeared. -Most useful with -Smart or Clever (ReallySmart) -placement. With the optional argument - -an animated move is used to place the window in its new position. -With the additional option -, -the icon is placed again instead. - -
diff --git a/doc/commands/Plus.xml b/doc/commands/Plus.xml deleted file mode 100644 index a0ab695cb..000000000 --- a/doc/commands/Plus.xml +++ /dev/null @@ -1,25 +0,0 @@ - - -%myents; -]> - - - -
-Plus - - - + - - -Used to continue adding to the last specified decor, function or -menu. See the discussion for -, -, and -. - - -
diff --git a/doc/commands/PointerKey.xml b/doc/commands/PointerKey.xml deleted file mode 100644 index 6daf8ec47..000000000 --- a/doc/commands/PointerKey.xml +++ /dev/null @@ -1,58 +0,0 @@ - - -%myents; -]> - - - -
-PointerKey - - - PointerKey(window)KeynameContextModifiersFunction - - -This command works exactly like the - -command. The only difference is that the binding operates on the -window under the pointer. Normal key bindings operate on the -focused window instead. The -PointerKey -command can for example be used to bind keys to the root window if -you are using - or -. -However, some applications (xterm is one example) are unable to -handle this key anymore, even if the pointer is over the xterm -window. It is recommended to use the -PointerKey -command only for key combinations that are not needed in any -application window. - -Example: - - - * -PointerKey f1 a m MainMenu - - - -
diff --git a/doc/commands/PointerWindow.xml b/doc/commands/PointerWindow.xml deleted file mode 100644 index f5d2c09b9..000000000 --- a/doc/commands/PointerWindow.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - -%myents; -]> - - -
-PointerWindow - - - PointerWindow(conditions)command - - -Performs -command -if the window under the pointer satisfies all -conditions. -Returns -1 if there is no window under the pointer. -See section for a list of conditions. - -This command implies the conditions -CirculateHit, CirculateHitIcon and CirculateHitShaded. -They can be turned off by specifying -!CirculateHit -etc. explicitly. - -
diff --git a/doc/commands/Popup.xml b/doc/commands/Popup.xml deleted file mode 100644 index db47eb5e6..000000000 --- a/doc/commands/Popup.xml +++ /dev/null @@ -1,113 +0,0 @@ - - -%myents; -]> - - - - diff --git a/doc/commands/Prev.xml b/doc/commands/Prev.xml deleted file mode 100644 index ad3b42691..000000000 --- a/doc/commands/Prev.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -%myents; -]> - - -
-Prev - - - Prev(conditions)command - - -Performs -command -(typically -) -on the previous window which satisfies all -conditions. -If the command is running in a window context, it starts looking -for a matching window from there. Otherwise it starts at the -focused window. -See section for a list of conditions. - -
diff --git a/doc/commands/PrintInfo.xml b/doc/commands/PrintInfo.xml deleted file mode 100644 index 5e7c667d5..000000000 --- a/doc/commands/PrintInfo.xml +++ /dev/null @@ -1,82 +0,0 @@ - - -%myents; -]> - - - -
-PrintInfo - - - PrintInfosubjectverbose - - -Print information on -subject -to debug log file, which defaults to $HOME/.fvwm/fvwm3-output.log . Environment variables $FVWM_USERDIR and -$FVWM3_LOGFILE can alter this default. For this logfile to be -written, either fvwm3 has to be started with option or - signal can be used to toggle opening/closing debug -log file. - An optional integer argument -to debug log file, which defaults to $HOME/.fvwm/fvwm3-output.log . Environment variables $FVWM_USERDIR and -$FVWM3_LOGFILE can alter this default. For this logfile to be -written, either fvwm3 has to be started with option or - signal can be used to toggle opening/closing debug -log file. - - An optional integer argument -verbose -defines the level of information which is given. -The current valid subjects are: - - -which prints information about the colors used by fvwm. This useful -on screens which can only display 256 (or less) colors at once. -If -verbose -is one or greater the palette used by fvwm is printed. -If you have a limited color palette, and you run out of colors, -this command might be helpful. - - -which prints information about the images loaded by fvwm. If -verbose -is one or greater all images in the cache will be listed together -with their respective reuse. - - -which prints information on your locale and the fonts that fvwm -used. -verbose -can be 1 or 2. - - -which prints information on the locale catalogs that fvwm used - - -which prints information on fvwm styles. -verbose -can be 1. - - -which prints information on all the bindings fvwm has: key and mouse bindings. -verbose -has no effect with this option. - - -which prints information on all entries in the infostore, listing the key and -its value. -verbose has no effect with this option. - -
diff --git a/doc/commands/Quit.xml b/doc/commands/Quit.xml deleted file mode 100644 index fae92b726..000000000 --- a/doc/commands/Quit.xml +++ /dev/null @@ -1,20 +0,0 @@ - - -%myents; -]> - - - -
-Quit - - - Quit - - -Exits fvwm, generally causing X to exit too. - -
diff --git a/doc/commands/QuitScreen.xml b/doc/commands/QuitScreen.xml deleted file mode 100644 index 58c5f4696..000000000 --- a/doc/commands/QuitScreen.xml +++ /dev/null @@ -1,21 +0,0 @@ - - -%myents; -]> - - - -
-QuitScreen - - - QuitScreen - - -Causes fvwm to stop managing the screen on which the command was -issued. - -
diff --git a/doc/commands/QuitSession.xml b/doc/commands/QuitSession.xml deleted file mode 100644 index 434ad0873..000000000 --- a/doc/commands/QuitSession.xml +++ /dev/null @@ -1,23 +0,0 @@ - - -%myents; -]> - - - -
-QuitSession - - - QuitSession - - -Causes a session manager (if any) to shutdown the session. This -command does not work for xsm, it seems that xsm does not -implement this functionality. Use Unix signals to manage xsm -remotely. - -
diff --git a/doc/commands/Raise.xml b/doc/commands/Raise.xml deleted file mode 100644 index e074b2437..000000000 --- a/doc/commands/Raise.xml +++ /dev/null @@ -1,29 +0,0 @@ - - -%myents; -]> - - - -
-Raise - - - Raise - - -Allows the user to raise a window. Note that this raises a window -only in its layer. To bring a window to the absolute top, use - - - raise-to-top - + I 0 ontop - + I Raise - - -where ontop is the highest layer used in your setup. - -
diff --git a/doc/commands/RaiseLower.xml b/doc/commands/RaiseLower.xml deleted file mode 100644 index ae5a9f359..000000000 --- a/doc/commands/RaiseLower.xml +++ /dev/null @@ -1,25 +0,0 @@ - - -%myents; -]> - - - -
-RaiseLower - - - RaiseLower - - -Alternately raises and lowers a window. The window is raised if -it is obscured by any window (except for its own transients when - -style is used; see the - -command) otherwise it is lowered. - -
diff --git a/doc/commands/Read.xml b/doc/commands/Read.xml deleted file mode 100644 index ffe7c6c67..000000000 --- a/doc/commands/Read.xml +++ /dev/null @@ -1,41 +0,0 @@ - - -%myents; -]> - - - -
-Read - - - Readfilenamequiet - - -Causes fvwm to read commands from the file named -filename. -If the keyword - -follows the command no message is produced if the file is not -found. If the file name does not begin with a slash ('/'), fvwm -looks in the user's data directory, then the system data -directory. The user's data directory is by default -$HOME/.fvwm. -It can be overridden by exporting -FVWM_USERDIR -set to any other directory. The -Read -command returns 1 if the given file could be read or -1 if not -(see the section - -for the meaning of return codes). - - -
diff --git a/doc/commands/Refresh.xml b/doc/commands/Refresh.xml deleted file mode 100644 index 6df9c4176..000000000 --- a/doc/commands/Refresh.xml +++ /dev/null @@ -1,25 +0,0 @@ - - -%myents; -]> - - - -
-Refresh - - - Refresh - - -Causes all windows on the screen to redraw themselves. All pending -updates of all windows' styles and looks are applied immediately. -E.g. if - or - -commands were issued inside a fvwm function. - -
diff --git a/doc/commands/RefreshWindow.xml b/doc/commands/RefreshWindow.xml deleted file mode 100644 index 603e7c1da..000000000 --- a/doc/commands/RefreshWindow.xml +++ /dev/null @@ -1,24 +0,0 @@ - - -%myents; -]> - - - -
-RefreshWindow - - - RefreshWindow - - -Causes the chosen window to redraw itself. All pending updates of -the window's style and look are applied immediately. E.g. if - or - -commands were issued inside a fvwm function. - -
diff --git a/doc/commands/Repeat.xml b/doc/commands/Repeat.xml deleted file mode 100644 index eb0ea7a54..000000000 --- a/doc/commands/Repeat.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -%myents; -]> - - - -
-Repeat - - - Repeat - - -When the -Repeat -command is invoked, the last command that was executed by fvwm is -executed again. This happens regardless of whether it was -triggered by user interaction, a module or by an X event. -Commands that are executed from a function defined with the - -command, from the - or - -commands or by a menu are not repeated. Instead, the function, -menu or the - or - -command is executed again. - -
diff --git a/doc/commands/Resize.xml b/doc/commands/Resize.xml deleted file mode 100644 index 3c71346b4..000000000 --- a/doc/commands/Resize.xml +++ /dev/null @@ -1,168 +0,0 @@ - - -%myents; -]> - - - -
-Resize - - - Resizeframedirection dirwarptoborder - automaticfixeddirectionwwidthpcwadawheightpc - - - -Allows for resizing a window. If called from somewhere in a window -or its border, then that window is resized. If called from the -root window then the user is allowed to select the target window. - -The operation can be aborted with Escape or by pressing -any mouse button (except button 1 which confirms it). - -If the optional arguments -width and height -are provided, then the window is resized so that its dimensions -are -width by height. -The units of -width and height -are percent-of-screen, unless a letter -'' -is appended to one or both coordinates, in which case the location -is specified in pixels. With a -'' -suffix the unit defined by the client application (hence the c) is -used. With the suffix -'' -the value is a percentage of the width or height size of the EWMH -working area, and with the suffix -'' -it is a percentage of the width or height of the EWMH dynamic working -area. So you can say - -Resize 80c 24c - -to make a terminal window just big enough for 80x24 -characters. - -If the -width or height -is prefixed with the letter -'' -the size is not taken as an absolute value but added to the -current size of the window. Example: - - -# Enlarge window by one line -Resize keep w+1c - - -Both, -width and height -can be negative. In this case the new size is the screen size -minus the given value. If either value is "", the -corresponding dimension of the window is left untouched. The new -size is the size of the client window, thus - -Resize 100 100 - -may make the window bigger than the screen. To base the new size -on the size of the whole fvwm window, add the - -option after the command. The options -fixeddirection, -direction and -warptoborder -are only used in interactive move operations. With - -the same border is moved even if the pointer moves past the -opposite border. The - -option must be followed by a direction name such as "NorthWest", -"South" or "East" (you get the idea). Resizing is started -immediately, even if the pointer is not on a border. If the special option - is given as a direction argument, then -the direction to resize is calculated based on the position of the pointer in -the window. If the pointer is in the middle of the window, then no direction is -calculated. - -The -option can be used to warp the pointer to the direction indicated. As with the - option for -, the border to warp to is -calculated based on the pointer's proximity to a given border. Also, if -resizing is started by clicking on the window border, the pointer -is warped to the outer edge of the border. - - - ResizeSE I Resize SE - 3 A M ResizeSE - - - - - Resizebottomrightbrxy - - -An alternate syntax is used if the keyword - or in short - -follows the command name. In this case, the arguments -x and y -specify the desired position of the bottom right corner of the -window. They are interpreted exactly like the -x and y -arguments of the - -command. Actually, any of the options accepted by the - -command can be used. - -
diff --git a/doc/commands/ResizeMaximize.xml b/doc/commands/ResizeMaximize.xml deleted file mode 100644 index 206a08a1c..000000000 --- a/doc/commands/ResizeMaximize.xml +++ /dev/null @@ -1,36 +0,0 @@ - - -%myents; -]> - - - -
-ResizeMaximize - - - ResizeMaximizeresize-arguments - - -Combines the effects of - -and - -in a single command. When used on a maximized window, the window -is resized and is still in the maximized state afterwards. When -used on an unmaximized window, the window is resized and put into -the maximized state afterwards. This is useful if the user wants -to resize the window temporarily and then return to the original -geometry. The -resize-arguments -are the same as for the - -command. - -
diff --git a/doc/commands/ResizeMove.xml b/doc/commands/ResizeMove.xml deleted file mode 100644 index 3bc02ae1f..000000000 --- a/doc/commands/ResizeMove.xml +++ /dev/null @@ -1,61 +0,0 @@ - - -%myents; -]> - - - -
-ResizeMove - - - ResizeMoveresize-argumentsmove-arguments - - -This command does the same as the - -and - -commands, but in a single call which is less visually -disturbing. The -resize-arguments -are exactly the same arguments as for the - -command and the -move-arguments -are exactly the same arguments as for the - -command except the - -option which is not supported by the -ResizeMove -command. - -Examples: - - -# Move window to top left corner and cover -# most of the screen -ResizeMove -10p -20p 0 0 - -# Grow the focused window towards the top of screen - keep w+$[w.y]p keep 0 - - -Note: Fvwm may not be able to parse the command properly if the -option - -of the - -command is used. - -
diff --git a/doc/commands/ResizeMoveMaximize.xml b/doc/commands/ResizeMoveMaximize.xml deleted file mode 100644 index 0d5099c45..000000000 --- a/doc/commands/ResizeMoveMaximize.xml +++ /dev/null @@ -1,39 +0,0 @@ - - -%myents; -]> - - - -
-ResizeMoveMaximize - - - ResizeMoveMaximizeresize-argumentsmove-arguments - - -Combines the effects of - -and - -in a single command. When used on a maximized window, the window -is resized and moved and is still in the maximized state -afterwards. When used on an unmaximized window, the window is -resized and put into the maximized state afterwards. This is -useful if the user wants to resize the window temporarily and then -return to the original geometry. The -resize-arguments and move-arguments -are the same as for the - -command. - -
diff --git a/doc/commands/RestackTransients.xml b/doc/commands/RestackTransients.xml deleted file mode 100644 index 2ce470ba7..000000000 --- a/doc/commands/RestackTransients.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -%myents; -]> - - - -
-RestackTransients - - - RestackTransients - - -This command regroups the transients of a window close to it in -the stacking order as if the window had just been lowered and then -raised. The position of the window itself is not altered. Only -windows that use either the - or - -style are affected at all. When -RestackTransients -is used on a transient window with the - -style set, it is redirected to the parent window. - -
diff --git a/doc/commands/Restart.xml b/doc/commands/Restart.xml deleted file mode 100644 index a7bd72dd6..000000000 --- a/doc/commands/Restart.xml +++ /dev/null @@ -1,130 +0,0 @@ - - -%myents; -]> - - - -
-Restart - - - Restartwindow_managerparams - - - -Causes fvwm to restart itself if -window_manager -is left blank, or to switch to an alternate window manager (or -other fvwm version) if -window_manager -is specified. If the window manager is not in your default search -path, then you should use the full path name for -window_manager. - -This command should not have a trailing ampersand. The command -can have optional parameters with simple shell-like syntax. You -can use -~ -(is expanded to the user's home directory) and environmental -variables -$VAR or ${VAR}. -Here are several examples: - - - F1 R N Restart - F1 R N Restart fvwm -s - F1 R N Restart ~/bin/fvwm -f $HOME/.fvwm/main - F1 R N Restart fvwm1 -s -f .fvwmrc - F1 R N Restart xterm -n '"X console"' \ - -T \"X\ console\" -e fvwm1 -s - - -If you need a native restart, we suggest only to use -Restart -command without parameters unless there is a reason not to. If you -still use an old command 'Restart fvwm2' that was correct in 2.2.x, -all current command line arguments are lost. On a restart without -parameters or with --pass-args, they are preserved. Here are some -cases when 'Restart fvwm2' or 'Restart fvwm' cause troubles: - - -* running fvwm under a session manager -* running fvwm with multi headed displays -* having command line arguments, like - -f themes-rc or -cmd -* if the first fvwm2 in the $PATH is a - different one - - -This is why we are issuing a warning on an old usage. If you -really want to restart to fvwm with no additional arguments, you -may get rid of this warning by using "Restart fvwm -s" or -"Restart /full/path/fvwm". - -Note, currently with multi headed displays, restart of fvwms on -different screens works independently. - - - - Restartwindow_manager - - - -The same as -Restart -without parameters but the name for the current window manager is -replaced with the specified -window_manager -and original arguments are preserved. - -This command is useful if you use initial arguments like - - --cmd FvwmCpp - - -and want to switch to another fvwm version without losing the -initial arguments. - - - - Restartother-params - - - -The same as - - -Restart other-params - - -but it does not save any window states over the restart. - -Without this option, -Restart -preserves most per-window state by writing it to a file named -.fs-restart-$HOSTDISPLAY -in the user's home directory. - -
diff --git a/doc/commands/SaveQuitSession.xml b/doc/commands/SaveQuitSession.xml deleted file mode 100644 index 28c6f0535..000000000 --- a/doc/commands/SaveQuitSession.xml +++ /dev/null @@ -1,23 +0,0 @@ - - -%myents; -]> - - - -
-SaveQuitSession - - - SaveQuitSession - - -Causes a session manager (if any) to save and then shutdown the -session. This command does not work for xsm, it seems that xsm -does not implement this functionality. Use Unix signals to manage -xsm remotely. - -
diff --git a/doc/commands/SaveSession.xml b/doc/commands/SaveSession.xml deleted file mode 100644 index 73bd0e0a5..000000000 --- a/doc/commands/SaveSession.xml +++ /dev/null @@ -1,23 +0,0 @@ - - -%myents; -]> - - - -
-SaveSession - - - SaveSession - - -Causes a session manager (if any) to save the session. This -command does not work for xsm, it seems that xsm does not -implement this functionality. Use Unix signals to manage xsm -remotely. - -
diff --git a/doc/commands/ScanForWindow.xml b/doc/commands/ScanForWindow.xml deleted file mode 100644 index 5fdcaa0af..000000000 --- a/doc/commands/ScanForWindow.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - -%myents; -]> - - -
-ScanForWindow - - - ScanForWindowFromPointerdir1dir2(conditions)command - - -Performs command -(typically ) -on a window in the given direction which satisfies all -conditions. -Normally, the center of the currently focused window or the -context window in which the command was invoked is taken as the -starting point. Lacking such a window, or when the - -option is given, the current position of the pointer is taken as -the starting point. The direction -dir1 -may be one of "North", "NorthEast", "East", "SouthEast", "South", -"SouthWest", "West", and "NorthWest". Which window -ScanForWindow -selects depends first on the position along the primary axis given -by -dir1. -If any windows have the exact same coordinate along the primary -axis, the secondary direction is used to order the windows. The -direction dir2 -may be one of the same set of values as -dir1. -If dir2 -is not perfectly perpendicular to -dir1, -ScanForWindow returns a failure. When using ScanForWindow -repeatedly with the same arguments, it is guaranteed that all -windows matching the conditions will eventually be found. If the -focus reaches a limit along the primary axis, it will wrap around -to the opposite side. Returns -1 if an invalid direction was -given. -See section for a list of conditions. - -
diff --git a/doc/commands/Schedule.xml b/doc/commands/Schedule.xml deleted file mode 100644 index 0faec84df..000000000 --- a/doc/commands/Schedule.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - -%myents; -]> - - -
-Schedule - - - SchedulePeriodicdelay_mscommand_idcommand - - -The -command -is executed after about -delay_ms -milliseconds. This may be useful in some tricky setups. The -command -is executed in the same context window as the -Schedule -command. An optional integer argument -command_id -may be given in decimal, hexadecimal or octal format. This id can -be used with the - -command to remove the scheduled command before it is executed. If -no id is given, fvwm uses negative id numbers, starting with -1 -and decreasing by one with each use of the -Schedule -command. -Note that the -Schedule -command and its arguments undergo the usual command line -expansion, and, when -command -is finally executed, it is expanded again. It may therefore be -necessary to quote the parts of the command that must not be -expanded twice. - -Note: A window's id as it is returned with $[w.id] can be used as -the -command_id. -Example: - - - Schedule 1000 $[w.id] - - - -The -Schedule -command also supports the optional keyword - -which indicates that the -command -should be executed every -delay_ms. -Example: - - -Schedule Periodic 10000 '[ -N "$MAIL" ] && echo \ - Echo You have mail' - - -Use the - -command to stop periodic commands. - - - - -
diff --git a/doc/commands/Scroll.xml b/doc/commands/Scroll.xml deleted file mode 100644 index 6b0d1f768..000000000 --- a/doc/commands/Scroll.xml +++ /dev/null @@ -1,94 +0,0 @@ - - -%myents; -]> - - - -
-Scroll - - - Scrollhorizonalp verticalpreverse - - - -Scrolls the virtual desktop's viewport by - -pages in the x-direction and - -pages in the y-direction or starts interactive scrolling of the viewport. Either or both entries may be negative. -Both -horizontal and vertical -values are expressed in percent of pages, so - - -Scroll 100 100 - - -means to scroll down and right by one full page. - - -Scroll 50 25 - - -means to scroll right half a page and down a quarter of a page. -The -Scroll -function should not be called from pop-up menus. Normally, -scrolling stops at the edge of the desktop. - -If the -horizontal and vertical -percentages are 100 or more and are multiplied by 1000 then -scrolling wraps around at the edge of the desktop. If - - -Scroll 100000 0 - - -is executed over and over fvwm moves to the next desktop page on -each execution and wraps around at the edge of the desktop, so -that every page is hit in turn. - -If the letter -'' -is appended to each coordinate -(horizontal and/or vertical), -then the scroll amount is measured in pixels. - -Without arguments or if the option -reverse -is given interactive scrolling takes place. The viewport -scrolls as the mouse is moved. With the - -option scrolling is done in opposite direction of the mouse -movement, and without it scrolling in the same direction as the -mouse. - -The binding - - - 1 A CM Scroll reverse - - -gives an effect of grabbing and dragging the viewport with button 1 -if -Control -and -Meta -is pressed. - -
diff --git a/doc/commands/SendToModule.xml b/doc/commands/SendToModule.xml deleted file mode 100644 index 13ba9dab0..000000000 --- a/doc/commands/SendToModule.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -%myents; -]> - - - -
-SendToModule - - - SendToModulemodulenamestring - - -Sends an arbitrary string (no quotes required) to all modules, -whose alias or name matching -modulename, -which may contain wildcards. This only makes sense if the module -is set up to understand and deal with these strings though. Can be -used for module to module communication, or implementation of more -complex commands in modules. - - -
diff --git a/doc/commands/SetAnimation.xml b/doc/commands/SetAnimation.xml deleted file mode 100644 index 4a8a175c8..000000000 --- a/doc/commands/SetAnimation.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - -%myents; -]> - - -
-SetAnimation - - - SetAnimationmilliseconds-delayfractions-to-move-list - - -Sets the time between frames and the list of fractional offsets to -customize the animated moves of the - -command and the animation of menus (if the menu style is set to -animated; see - -command). If the -fractions-to-move-list -is omitted, only the time between frames is altered. The -fractions-to-move-list -specifies how far the window should be offset at each successive -frame as a fraction of the difference between the starting -location and the ending location. e.g.: - - -SetAnimation 10 -.01 0 .01 .03 .08 .18 .3 \ - .45 .6 .75 .85 .90 .94 .97 .99 1.0 - - -Sets the delay between frames to 10 milliseconds, and sets the -positions of the 16 frames of the animation motion. Negative -values are allowed, and in particular can be used to make the -motion appear more cartoonish, by briefly moving slightly in the -opposite direction of the main motion. The above settings are the -default. - -
diff --git a/doc/commands/SetEnv.xml b/doc/commands/SetEnv.xml deleted file mode 100644 index 35a73f81c..000000000 --- a/doc/commands/SetEnv.xml +++ /dev/null @@ -1,48 +0,0 @@ - - -%myents; -]> - - - -
-SetEnv - - - SetEnvvariablevalue - - -Set an environment variable to a new value, similar to the shell's -export or setenv command. The -variable -and its -value -are inherited by processes started directly by fvwm. This can be -especially useful in conjunction with the - -module. For example: - - -SetEnv height HEIGHT - - -makes the set variable -HEIGHT -usable by processes started by fvwm as the environment variable -$height. -If -value -includes whitespace, you should enclose it in quotes. If no -value -is given, the variable is deleted. - -
diff --git a/doc/commands/Silent.xml b/doc/commands/Silent.xml deleted file mode 100644 index 2400f9970..000000000 --- a/doc/commands/Silent.xml +++ /dev/null @@ -1,62 +0,0 @@ - - -%myents; -]> - - - -
-Silent - - - Silentcommand - - -A number of commands require a window to operate on. If -no window was selected when such a function is invoked the user is -asked to select a window. Sometimes this behavior is unwanted, -for example if the function was called by a module and the window -that was selected at first does not exist anymore. You can -prevent this by putting -Silent -in front of the fvwm -command. -If a function that needs a window is called with -Silent -without a window selected, it simply returns without doing -anything. If -Silent -is used on a user defined function it affects all function and sub -function calls until the original function exits. - -Another usage of -Silent -is with binding commands -, PointerKey and Mouse, -this disables error messages. - -Silent -also disables the error message for non-existent commands. Note: -This command is treated as a prefix to its -command. -Expansion of the command line is done as if -Silent -was not there. - -Examples: - - -Silent 0 0 -Silent User_defined_function -# do not complain on keyboards without "Help" key -Silent Help R A HelpMenu - - - -
diff --git a/doc/commands/SnapAttraction.xml b/doc/commands/SnapAttraction.xml deleted file mode 100644 index a8d9c2ed4..000000000 --- a/doc/commands/SnapAttraction.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -%myents; -]> - - - -
-SnapAttraction - - - SnapAttractionproximitybehaviourScreen - - - -The command is obsolete. It has -been replaced by the command option -. - -
diff --git a/doc/commands/SnapGrid.xml b/doc/commands/SnapGrid.xml deleted file mode 100644 index 40a21c757..000000000 --- a/doc/commands/SnapGrid.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -%myents; -]> - - - - -
-SnapGrid - - - SnapGridx-grid-size y-grid-size - - -The command is obsolete. It has -been replaced by the command option -. - -
diff --git a/doc/commands/State.xml b/doc/commands/State.xml deleted file mode 100644 index 379dd6669..000000000 --- a/doc/commands/State.xml +++ /dev/null @@ -1,39 +0,0 @@ - - -%myents; -]> - - - -
-State - - - Statestatebool - - -Sets, clears or toggles one of the 32 user defined states which -are associated with each window. The -state -is a number ranging from 0 to 31. The states have no meaning in -fvwm, but they can be checked in conditional commands like - -with the -State -condition. The optional argument -bool -is a boolean argument. "True" sets the given state, while "False" -clears it. Using "toggle" switches to the opposite state. If the -bool -argument is not given, the state is toggled. - -
diff --git a/doc/commands/Status.xml b/doc/commands/Status.xml deleted file mode 100644 index ea4e060d8..000000000 --- a/doc/commands/Status.xml +++ /dev/null @@ -1,52 +0,0 @@ - - -%myents; -]> - - - -
-Status - - - Status - - On | Off - - - Turns status either On or Off. This sends information in JSON - format down a named pipe (set via FVWM_STATUS_PIPE env var) - about the current desks and number of windows, etc. This is - meant to provide a fast means of supplying third-party tools - information about what's happening in Fvwm. For example, the - JSON could be manipulated and sent to tools such as - lemonbar, - polybar, etc. - - The format of the JSON blob looks like this: - - { - "version": 1, - "current_screen": "HDMI2", - "screens": { - "HDMI2": { - "current_client": "n6tadam@shuttle: ~", - "desktops": { - "0": { - "number": 0, - "is_urgent": false, - "is_current": true, - "number_of_clients": 5 - }, - }, - }, - }, - } - - These sections repeat for all screens/groups/etc, depending on - how many there are of each. - -
diff --git a/doc/commands/Stick.xml b/doc/commands/Stick.xml deleted file mode 100644 index af398d513..000000000 --- a/doc/commands/Stick.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -%myents; -]> - - - -
-Stick - - - Stickbool - - -If the -bool -argument is empty or "", the -Stick -command makes a window sticky if it is not already sticky, or -non-sticky if it is already sticky. To make a window sticky -regardless of its current state the -bool -argument must be "True". To make it non-sticky use "False". - -
diff --git a/doc/commands/StickAcrossDesks.xml b/doc/commands/StickAcrossDesks.xml deleted file mode 100644 index 495eeddc3..000000000 --- a/doc/commands/StickAcrossDesks.xml +++ /dev/null @@ -1,25 +0,0 @@ - - -%myents; -]> - - - -
-StickAcrossDesks - - - StickAcrossDesksbool - - -Works like - -but only sticks a window across desks, not across pages. - -
diff --git a/doc/commands/StickAcrossPages.xml b/doc/commands/StickAcrossPages.xml deleted file mode 100644 index 84a60a287..000000000 --- a/doc/commands/StickAcrossPages.xml +++ /dev/null @@ -1,25 +0,0 @@ - - -%myents; -]> - - - -
-StickAcrossPages - - - StickAcrossPagesbool - - -Works like - -but only sticks a window across pages, not across desks. - -
diff --git a/doc/commands/Style.xml b/doc/commands/Style.xml deleted file mode 100644 index b1c69ab75..000000000 --- a/doc/commands/Style.xml +++ /dev/null @@ -1,2356 +0,0 @@ - - - -%myents; -]> - - -
-Style - - - Stylestylenameoptions - - -The -Style -command is used to set attributes of a window to values other than -the default or to set the window manager default styles. - -stylename -can be a window's name, class, visible name, or resource string. It may contain -the wildcards '*' and '?', which are matched in the usual Unix -filename manner. Multiple style options in a single -Style -command are read from left to right as if they were issued one -after each other in separate commands. A given style always -overrides all conflicting styles that have been issued earlier (or -further left on the same style line). - -Note: windows that have no name (WM_NAME) are given a name of -"Untitled", and windows that do not have a class (WM_CLASS, -res_class) are given class "NoClass" and those that do not have a -resource (WM_CLASS, res_name) are given resource "NoResource". - -If a window has the resource "fvwmstyle" set, the value of that -resource is used in addition to any window names when -selecting the style. - -options -is a comma separated list containing one or more of the -following keywords. Each group of style names is separated by -slashes ('/'). The last style in these groups is the default. -BorderWidth, HandleWidth, -!Icon / Icon, MiniIcon, -IconBox, IconGrid, IconFill, IconSize, -!Title / Title, -TitleAtBottom / TitleAtLeft / TitleAtRight / TitleAtTop, -LeftTitleRotatedCW / LeftTitleRotatedCCW, -RightTitleRotatedCCW / RightTitleRotatedCW, -TopTitleRotated / TopTitleNotRotated, -BottomTitleRotated / BottomTitleNotRotated, -!UseTitleDecorRotation / UseTitleDecorRotation, -StippledTitle / !StippledTitle, -StippledIconTitle / !StippledIconTitle, -IndexedWindowName / ExactWindowName, -IndexedIconName / ExactIconName, -TitleFormat / IconTitleFormat / !Borders / Borders, -!Handles / Handles, -WindowListSkip / WindowListHit, -CirculateSkip / CirculateHit, -CirculateSkipShaded / CirculateHitShaded, -CirculateSkipIcon / CirculateHitIcon, -Layer, -StaysOnTop / StaysOnBottom / StaysPut, -Sticky / Slippery, -StickyAcrossPages / !StickyAcrossPages, -StickyAcrossDesks / !StickyAcrossDesks, -!StickyStippledTitle / StickyStippledTitle, -!StickyStippledIconTitle / StickyStippledIconTitle, -StartIconic / StartNormal, -Color, ForeColor, BackColor, Colorset, -HilightFore, HilightBack, HilightColorset, -BorderColorset, HilightBorderColorset, -IconTitleColorset, HilightIconTitleColorset, -IconBackgroundColorset, -IconTitleRelief, IconBackgroundRelief, IconBackgroundPadding, -Font, -IconFont, -StartsOnDesk / StartsOnPage / StartsAnyWhere, -StartsOnScreen, -StartShaded / !StartShaded, -ManualPlacementHonorsStartsOnPage / ManualPlacementIgnoresStartsOnPage, -CaptureHonorsStartsOnPage / CaptureIgnoresStartsOnPage, -RecaptureHonorsStartsOnPage / RecaptureIgnoresStartsOnPage, -StartsOnPageIncludesTransients / StartsOnPageIgnoresTransients, -IconTitle / !IconTitle, -MwmButtons / FvwmButtons, -MwmBorder / FvwmBorder, -MwmDecor / !MwmDecor, -MwmFunctions / !MwmFunctions, -HintOverride / !HintOverride, -!Button / Button, -ResizeHintOverride / !ResizeHintOverride, -OLDecor / !OLDecor, -GNOMEUseHints / GNOMEIgnoreHints, -StickyIcon / SlipperyIcon, -StickyAcrossPagesIcon / !StickyAcrossPagesIcon, -StickyAcrossDesksIcon / !StickyAcrossDesksIcon, -ManualPlacement / CascadePlacement / MinOverlapPlacement / -MinOverlapPercentPlacement / TileManualPlacement / -TileCascadePlacement / PositionPlacement, -MinOverlapPlacementPenalties, -MinOverlapPercentPlacementPenalties, -DecorateTransient / NakedTransient, -DontRaiseTransient / RaiseTransient, -DontLowerTransient / LowerTransient, -DontStackTransientParent / StackTransientParent, -SkipMapping / ShowMapping, -ScatterWindowGroups / KeepWindowGroupsOnDesk, -UseDecor, -UseStyle, -!UsePPosition / NoPPosition / UsePPosition, -!UseUSPosition, NoUSPosition / UseUSPosition, -!UseTransientPPosition, NoTransientPPosition / UseTransientPPosition, -!UseTransientUSPosition / NoTransientUSPosition / UseTransientUSPosition, -!UseIconPosition / NoIconPosition / UseIconPosition, -Lenience / !Lenience, -ClickToFocus / SloppyFocus / -MouseFocus|FocusFollowsMouse / NeverFocus, -ClickToFocusPassesClickOff / ClickToFocusPassesClick, -ClickToFocusRaisesOff / ClickToFocusRaises, -MouseFocusClickRaises / MouseFocusClickRaisesOff, -GrabFocus / GrabFocusOff, -GrabFocusTransientOff / GrabFocusTransient, -FPFocusClickButtons, -FPFocusClickModifiers, -!FPSortWindowlistByFocus / FPSortWindowlistByFocus, -FPClickRaisesFocused / !FPClickRaisesFocused, -FPClickDecorRaisesFocused / !FPClickDecorRaisesFocused, -FPClickIconRaisesFocused / !FPClickIconRaisesFocused, -!FPClickRaisesUnfocused / FPClickRaisesUnfocused, -FPClickDecorRaisesUnfocused / !FPClickDecorRaisesUnfocused, -FPClickIconRaisesUnfocused / !FPClickIconRaisesUnfocused, -FPClickToFocus / !FPClickToFocus, -FPClickDecorToFocus / !FPClickDecorToFocus, -FPClickIconToFocus / !FPClickIconToFocus, -!FPEnterToFocus / FPEnterToFocus, -!FPLeaveToUnfocus / FPLeaveToUnfocus, -!FPFocusByProgram / FPFocusByProgram, -!FPFocusByFunction / FPFocusByFunction, -FPFocusByFunctionWarpPointer / !FPFocusByFunctionWarpPointer, -FPLenient / !FPLenient, -!FPPassFocusClick / FPPassFocusClick, -!FPPassRaiseClick / FPPassRaiseClick, -FPIgnoreFocusClickMotion / !FPIgnoreFocusClickMotion, -FPIgnoreRaiseClickMotion / !FPIgnoreRaiseClickMotion, -!FPAllowFocusClickFunction / FPAllowFocusClickFunction, -!FPAllowRaiseClickFunction / FPAllowRaiseClickFunction, -FPGrabFocus / !FPGrabFocus, -!FPGrabFocusTransient / FPGrabFocusTransient, -FPOverrideGrabFocus / !FPOverrideGrabFocus, -FPReleaseFocus / !FPReleaseFocus, -!FPReleaseFocusTransient / FPReleaseFocusTransient, -FPOverrideReleaseFocus / !FPOverrideReleaseFocus, -StartsLowered / StartsRaised, -IgnoreRestack / AllowRestack, -FixedPosition / VariablePosition, -FixedUSPosition / VariableUSPosition, -FixedPPosition / VariablePPosition, -FixedSize / VariableSize, -FixedUSSize / VariableUSSize, -FixedPSize / VariablePSize, -!Closable / Closable, -!Iconifiable / Iconifiable, -!Maximizable / Maximizable, -!AllowMaximizeFixedSize / AllowMaximizeFixedSize, -IconOverride / NoIconOverride / NoActiveIconOverride, -DepressableBorder / FirmBorder, -MinWindowSize, -MaxWindowSize, -IconifyWindowGroups / IconifyWindowGroupsOff, -ResizeOpaque / ResizeOutline, -BackingStore / BackingStoreOff / BackingStoreWindowDefault, -Opacity / ParentalRelativity, -SaveUnder / SaveUnderOff, -WindowShadeShrinks / WindowShadeScrolls, -WindowShadeSteps, -WindowShadeAlwaysLazy / WindowShadeBusy / WindowShadeLazy, -EWMHDonateIcon / EWMHDontDonateIcon, -EWMHDonateMiniIcon / EWMHDontDonateMiniIcon, -EWMHMiniIconOverride / EWMHNoMiniIconOverride, -EWMHUseStackingOrderHints / EWMHIgnoreStackingOrderHints, -EWMHIgnoreStateHints / EWMHUseStateHints, -EWMHIgnoreStrutHints / EWMHUseStrutHints, -EWMHIgnoreWindowType / !EWMHIgnoreWindowType, -EWMHMaximizeIgnoreWorkingArea / EWMHMaximizeUseWorkingArea / -EWMHMaximizeUseDynamicWorkingArea, -EWMHPlacementIgnoreWorkingArea / EWMHPlacementUseWorkingArea / -EWMHPlacementUseDynamicWorkingArea, -MoveByProgramMethod, -Unmanaged, -State, -SnapGrid, -SnapAttraction, -EdgeMoveDelay, -EdgeResizeDelay. -EdgeMoveResistance, -InitialMapCommand - - - - -In the above list some options are listed as -style-option/opposite-style-option. The opposite-style-option for -entries that have them describes the fvwm default behavior and can -be used if you want to change the fvwm default behavior. - - -
-Focus policy - - -instructs fvwm to give the focus to a window when it is clicked -in. The default - -(or its alias -) -tells fvwm to give a window the focus as soon as the pointer -enters the window, and take it away when the pointer leaves the -window. - -is similar, but doesn't give up the focus if the pointer leaves -the window to pass over the root window or a ClickToFocus window -(unless you click on it, that is), which makes it possible to move -the mouse out of the way without losing focus. A window with the -style - -never receives the focus. This is useful for modules like -. -for example. -Note: Once any of the "FP..." styles has been used, the defaults -that come with the basic focus policies are not restored when the -latter are used again. For example, once !FPGrabFocus has been -used, using ClickToFocus does not restore FPGrabFocus. - -The focus model can be augmented with several additional options. -In fvwm-2.5.3 and later, there are a large number of advanced -options beginning with "FP" or "!FP". These options shall replace -the older options one day and are described first. Using any of -these new options may limit compatibility with older releases. In -general, options beginning with "FP" turn a feature on, while -those beginning with "!FP" turn it off. - -
- - - - - - - -
-Focusing the window - -With -, -when the pointer enters a window it receives focus. - -With - -a window loses focus when the pointer leaves it. - -With -, - or -, -a window receives focus when the inside of the window or the -decorations or its icon is clicked. - -The - -style allows windows to take the focus themselves. - -The -! -style forbids that a window receives the focus via the - and -commands. - -The - -style controls if the pointer is warped to a selected window -when the - -command is used. - - -allows focus on windows that do not want it, like - -or xclock. - -The - -style takes a list of mouse buttons that can be clicked to focus -or raise a window when the appropriate style is used. The default -is to use the first three buttons ("123"). - -The - -style takes a list of modifier keys just like the - -command. The exact combination of modifier keys must be pressed -for the click to focus or raise a window to work. The default is -to use no modifiers ("N"). - -With the - -style, the click that was used to focus a window is passed to -the application. - -With the - -style, the click that was used to focus a window can also -trigger a normal action that was bound to the window with the - -command). - -If the - -style is used, clicking in a window and then dragging the pointer -with the button held down does not count as the click to focus the -window. Instead, the application processes these events -normally. This is useful to select text in a terminal window with -the mouse without raising the window. However, mouse bindings on -the client window are not guaranteed to work anymore (see - -command). This style forces the initial click to be -passed to the application. The distance that the pointer must be -moved to trigger this is controlled by the - -command. - -The - and ! -styles control whether the internal window list is sorted in the -order the windows were focused or in the order they were created. -The latter is the default for -ClickToFocus and SloppyFocus. - - -Clicking the window to raise - -The styles -, and - -allow one to raise the window when the interior or the decorations or -the icon of the window is clicked while the window is already -focused. - -The styles -, and - -allow one to raise the window when the interior or the decorations or -the icon of the window is clicked while the window is not yet -focused. - -With the - -style, the click that was used to raise the window is passed to -the application. - -With the - -style, the click that was used to raise the window can also -trigger a normal action that was bound to the window with the - -command. - -If the - -style is used, clicking in a window and then dragging the pointer -with the button held down does not count as the click to raise the -window. Instead, the application processes these events -normally. This is useful to select text in a terminal window with -the mouse without raising the window. However, mouse bindings on -the client window are not guaranteed to work anymore (see - -command. Note that this style forces that the initial click is -passed to the application. The distance that the pointer must be -moved to trigger this is controlled by the - -command. - -Grabbing the focus when a new window is created - -New normal or transient windows with the - or -style automatically receive the focus when they are created. - -is the default for windows with the -ClickToFocus -style. Note that even if these styles are disabled, the -application may take the focus itself. Fvwm can not prevent this. - -The - -style instructs fvwm to never take away the focus from such a -window via the - or -styles. This can be useful if you like to have transient windows -receive the focus immediately, for example in a web browser, but -not while you are working in a terminal window or a text -processor. - -The above three styles are accompanied by -, and -. -These control if the focus is returned to another window when the -window is closed. Otherwise no window or the window under the -pointer receives the focus. - - and -controls whether a mouse click to focus a window is sent to the -application or not. Similarly, -/ -and -/ -control if the window is raised (but depending on the focus -model). - -Note: in fvwm versions prior to -2.5.3, the "Click..." options applied only to windows with -ClickToFocus -while the "Mouse..." options applied to windows with a different -focus policy. This is no longer the case. - -The old - -style is equivalent to using -FPGrabFocus + FPReleaseFocus. - -The old - -style is equivalent to using - + . - - -is equivalent to the new style -FPLenient. - -
- - - - -
-Window title - -The - and !Title -options determine if the window has a title-bar or not. By -default all windows have a title-bar. - -is equivalent to -!Title -but is deprecated. - -Windows with the -, or -style have a title-bar below, to the left or to the right of the -window instead of above as usual. The - -style restores the default placement. Even if the window has the -!Title -style set, this affects the - -command. Please check the - -command for interactions between that command and these styles. -Titles on the left or right side of the windows are augmented by -the following styles: - -Normally, the text in titles on the left side of a window is -rotated counterclockwise by 90 degrees from the normal upright -position and 90 degrees clockwise for titles on the right side. -It can also be rotated in the opposite directions with - if -is used, and with - if -is used. The defaults can be restored with - and . -A normal horizontal text may be rotated as well with - if TitleAtTop -is used, and with - if -is used. The defaults can be restored with - and . - -By default the title bar decoration defined using the - -command is rotated following the title text rotation (see the -previous paragraph). This can be disabled by using the -! -style. -UseTitleDecorRotation -reverts back to the default. - -With the - -style, titles are drawn with the same effect that is usually -reserved for windows with the -, or -style. -!StippledTitle -reverts back to normal titles. - -is equivalent to -!StippledTitle -but is deprecated. - - -takes two arguments. The first is the window-label text color and -the second is the window decorations normal background color. The -two colors are separated with a slash. If the use of a slash -causes problems then the separate - and -options can be used. - - -takes the colorset number as its sole argument and overrides the -colors set by -Color. -Instead, the corresponding colors from the given colorset are -used. Note that all other features of a colorset are not used. -Use the - -decoration style in the - and -command for that. -To stop using the colorset, the colorset number is omitted. - -The -, and -style options work exactly like -, and Colorset -but are used only if the window has the focus. These styles -replace the old commands - and . - - -takes the colorset number as its sole argument and overrides the -colors set by -Color or Colorset. -for the window border. To stop using a colorset, the argument is -omitted. - -The - -style option works similarly to -BorderColorset -but is used when the window has the focus. - -! -disables displaying icon labels while the opposite style -IconTitle -enables icon labels (default behaviour). - -is equivalent to -!IconTitle -but is deprecated. - - -takes the colorset number as its sole argument and overrides the -colors set by -Color or Colorset. -To stop using this colorset, the argument is omitted. - - -takes the colorset number as its sole argument and overrides the -colors set by - or HilightColorset. -To stop using this colorset, the argument is omitted. - - -takes the colorset number as its sole argument and uses it to set -a background for the icon picture. By default the icon picture is -not drawn onto a background image. To restore the default, the -argument is omitted. - - -takes one numeric argument that may be between -50 and +50 pixels -and defines the thickness of the 3D relief drawn around the icon -title. With negative values the icon title gets a pressed in -look. The default is 2 and it is restored if the argument is -omitted. - - -takes one numeric argument that may be between -50 and +50 pixels -and defines the thickness of the 3D relief drawn around the icon -picture background (if any). With negative values the icon -background gets a pressed in look. The default is 2 and it is -restored if the argument is omitted. - - -takes one numeric argument that may be between 0 and 50 pixels and -defines the amount of free space between the relief of the icon -background picture (if any) and the icon picture. The default is 2 -and it is restored if the argument is omitted. - -The - and -options take the name of a font as their sole argument. This font -is used in the window or icon title. By default the font given in -the - -command is used. To revert back to the default, use the style -without the name argument. These styles replace the older - and -commands. - -The deprecated - -style causes fvwm to use window titles in the form - - -name (i) - - -where - -is the exact window name and - -is an integer which represents the -i th -window with -name -as window name. This has been replaced with: - - -TitleFormat %n (%t) - - - -restores the default which is to use the exact window name. Deprecated in -favour of: - - - TitleFormat %n - - - -and - -work the same as -IndexedWindowName -and -ExactWindowName -styles but for the icon titles. Both are deprecated in favour of: - - -IconTitleFormat %n (%t) -IconTitleFormat %n - - - describes what the visible -name of a window should look like, with the following placeholders being -valid: - - - - %n - Insert the window's name. - - - %i - Insert the window's icon name. - - - %c - Insert the window's class name. - - - %r - Insert the window's resource name. - - - %t - Insert the window count. - - - %I - Insert the window ID. - - - %% - Insert a literal '%' character. - - - -Any amount of whitespace may be used, along with other characters to - make up the string -- but a valid - string must contain at least one of the placeholders mentioned. No - quote stripping is performed on the string, so for example the following - is printed verbatim: - - - TitleFormat " %n " -> [%t] -> [%c] - - -Note: It's perfectly possible to use a - which can result in wiping out the -visible title altogether. For example: - - - TitleFormat %z - - -Simply because the placeholder '%z' isn't supported. This is not a bug -but rather a facet of how the formatting parser works. - - describes what the visible -icon name of a window should look like, with the options being the same as -. - - -
- - - - - -
-Title buttons - - and ! -take a numeric argument which is the number of the title-bar -button which is to be shown or omitted. - -is equivalent to -!Button -but is deprecated. - - -makes the - -button look pressed-in when the window is maximized. See the - -flag in - -for more information. To switch this style off again, use the - -style. - -
- - - - - -
-Borders - -! -suppresses the window border (but not the title) completely. The -Borders -style enables them again. Without borders, all other styles -affecting window borders are meaningless. - - -makes the 3D bevel more closely match Mwm's. - -turns off the previous option. - -With the -! -style, the window does not get the handles in the window corners -that are commonly used to resize it. With -!Handles, -the width from the -BorderWidth -style is used. By default, or if -Handles -is specified, the width from the -HandleWidth -style is used. - -is equivalent to -!Handles -but is deprecated. - - - -takes a numeric argument which is the width of the border to place -the window if it does have resize-handles. Using HandleWidth -without an argument restores the default. - - - -takes a numeric argument which is the width of the border to place -the window if it does not have resize-handles. It is used only if -the -!Handles -style is specified too. Using BorderWidth -without an argument restores the default. - - -makes the border parts of the window decoration look sunken in -when a button is pressed over them. This can be disabled again -with the - -style. - -
- - - - - -
-Icons, shading, maximizing, movement, resizing - - -takes an (optional) unquoted string argument which is the icon -bitmap or pixmap to use. Icons specified this way override pixmap -icons, but not icon windows or the ewmh icon, provided by the -client in the application (with the WM_HINTS property or with the -ewmh _NET_WM_ICON property). The - -style changes the behavior to override any client-provided icons; -the - -style changes the behavior to not override any client-provided -icons; the default overriding behavior can be activated with the - -style. With this style, fvwm uses application provided icons if -the icon is changed but uses the icon provided in the -configuration file until then. - -There is one exception to these rules, namely - - -Style * Icon unknown.xpm - - -doesn't force the unknown.xpm icon on every window, it just sets -the default icon like the DefaultIcon command. If you really want -all windows to have the same icon, you can use - - -Style ** Icon unknown.xpm - - -If the - -attribute is set then the specified window simply disappears when -it is iconified. The window can be recovered through the -window-list. If -Icon -is set without an argument then the -NoIcon -attribute is cleared but no icon is specified. An example which -allows only the -FvwmPager -module icon to exist: - - -Style * NoIcon -Style FvwmPager Icon - - - - -takes no argument, four numeric arguments (plus optionally a -screen specification), an X11 geometry string or the string -"none": - - -IconBox [screen scr-spec] l t r b - - -or - - -IconBox geometry - - -Where - -is the left coordinate, - -is the top, - -is right and - -is bottom. Negative coordinates indicate distance from the right -or bottom of the screen. -If the first argument is the word -, -the - -argument specifies the RandR screen on which the IconBox is -defined -´or the additional 'w' for the screen -where the window center is located. This is only useful with -multiple screens. -The "l t r b" specification is more flexible than an X11 geometry. -For example: - - -IconBox -80 240 -1 -1 - - -defines a box that is 80 pixels wide from the right edge, -240 pixels down from the top, and continues to the bottom of -the screen. - -Perhaps it is easier to use is an X11 -geometry string though: - - -IconBox 1000x70-1-1 - - -places an 1000 by 70 pixel icon box on the bottom of the screen -starting in the lower right hand corner of the screen. -One way to figure out a geometry like this is to use a window -that resizes in pixel increments, for example, xv. -Then resize and place the xv window where you want the iconbox. -Then use FvwmIdent to read the windows geometry. -The icon box is a region of the screen -where fvwm attempts to put icons for any matching window, as long -as they do not overlap other icons. -Multiple icon boxes can be -defined as overflow areas. When the first icon box is full, the -second one is filled. All the icon boxes for one style must be -defined in one -Style -command. For example: - - -Style * IconBox -80 240 -1 -1, \ - IconBox 1000x70-1-1 - - -A Style command with the IconBox option replaces any icon box -defined previously by another Style command for the same style. -That's why the backslash in the previous example is required. - -Note: The geometry for the icon box command takes the additional -screen specifier "@w" in case RandR isused. This -designates the screen where the window center is located. The -additional screen specifier is not allowed anywhere else. - -If you never define an icon box, or you fill all the icon boxes, -fvwm has a default icon box that covers the screen, it fills top -to bottom, then left to right, and has an 80x80 pixel grid. To -disable all but the default icon box you can use IconBox without -arguments in a separate -Style -command. To disable all icon boxes including the default icon -box, the argument "none" can be specified. - -Hint: You can auto arrange your icons in the icon box with a -simple fvwm function. Put the "DeiconifyAndRearrange" function -below in your configuration file: - - - DeiconifyAndRearrange - + C off - + C (CurrentPage, Iconic) Icon - - -And then replace all places where you call the - -command to de-iconify an icon with a call to the new -function. For example replace - - - IconFunc - + C off - + M - + M - + D off - - 1 I A off - - -with - - - IconFunc - + C DeiconifyAndRearrange - + M - + M - + D DeiconifyAndRearrange - - 1 I A DeiconifyAndRearrange - - - -takes 2 numeric arguments greater than zero. - - -IconGrid x y - - -Icons are placed in an icon box by stepping through the icon box -using the - and -values for the icon grid, looking for a free space. The default -grid is 3 by 3 pixels which gives a tightly packed appearance. To -get a more regular appearance use a grid larger than your largest -icon. Use the -IconSize -argument to clip or stretch an icon to a maximum size. An -IconGrid -definition must follow the -IconBox -definition that it applies to: - - -Style * IconBox -80x240-1-1, IconGrid 90 90 - - - -takes 2 arguments. - - -IconFill Bottom Right - - -Icons are placed in an icon box by stepping through the icon box -using these arguments to control the direction the box is filled -in. By default the direction is left to right, then top to bottom. -This would be expressed as: - - -IconFill left top - - -To fill an icon box in columns instead of rows, specify the -vertical direction (top or bottom) first. The directions can be -abbreviated or spelled out as follows: "t", "top", "b", "bot", -"bottom", "l", "lft", "left", "r", "rgt", "right". An -IconFill -definition must follow the -IconBox -definition that it applies to: - - -Style * IconBox -80x240-1-1, IconFill b r - - -
- - -sets limits on the size of an icon image. Both user-provided -and application-provided icon images are affected. - - -IconSize [ width height [ maxwidth maxheight ] ] - - -All arguments are measured in pixels. When all four arguments are -passed to -IconSize, -width -and -height -represent the minimum size of an icon, and -maxwidth -and -maxheight -represent the maximum size of an icon. Icon images that are smaller -than the minimum size are padded. Icon images that are bigger than -the maximum size are clipped. - -If only two arguments are passed to -IconSize, -width -and -height -represent the absolute size of an icon. Icons covered by this style -are padded or clipped to achieve the given size. - -If no arguments are specified, the default values are used for each -dimension. This effectively places no limits on the size of an icon. - -The value of "-1" can be used in place of any of the arguments to -specify the default value for that dimension. - -In addition to the numeric arguments, 1 additional argument can be -"Stretched", "Adjusted", or "Shrunk". - - -Note that module provided icon managers are not affected by this style. - -
- - - - - -specifies a pixmap to use as the miniature icon for the -window. This miniature icon can be drawn in a title-bar button -(see -), -and can be used by various fvwm modules -( and ). -It takes the name of a pixmap as an argument. - - and -control if the contents of a window that is being shaded with the - -command are scrolled (default) or if they stay in place. The -shrinking mode is a bit faster - -The - -option selects the number of steps for animation when shading a -window with -. -It takes one number as its argument. If the number has a trailing -'' -it sets the number of pixels to use as the step size instead of -a fixed number of steps. 0 disables the animation. This happens -too if the argument is omitted or invalid. - -The - -command has two modes of operation: busy and lazy shading. Busy -shading can be 50% slower than lazy shading, but the latter can -look strange under some conditions, for example, if the window -borders, buttons or the title are filled with a tiled pixmap. -Also, the window handles are not drawn in lazy mode and the border -relief may only be drawn partially right before the window reaches -the shaded state or tight after leaves the unshaded state. By -default, fvwm uses lazy mode if there are no bad visual effects -(not counting the window handles) and busy mode otherwise. Use -the -WindowShadeAlwaysLazy or WindowShadeBusy -to force using the lazy or busy mode. The default setting is -restored with -. - - -instructs fvwm to resize the corresponding windows with their -contents visible instead of using an outline. Since this causes -the application to redraw frequently it can be quite slow and make -the window flicker excessively, depending on the amount of -graphics the application redraws. The - -style (default) negates the -ResizeOpaque -style. Many applications do not like their windows being resized -opaque, e.g. XEmacs, Netscape or terminals with a pixmap -background. If you do not like the result, do not use the -ResizeOpaque -style for these windows. To exempt certain windows from opaque -resizing you could use these lines in your configuration file: - - -Style * ResizeOpaque -Style rxvt ResizeOutline -Style emacs ResizeOutline - - - -makes the window sticky, i.e. it is always visible on each page -and each desk. The opposite style, - -reverts back to the default. - - - -makes the window sticky when it's iconified. It de-iconifies on -top the active desktop. - -reverts back to the default. - - - and -work like -Sticky and StickyIcon, -but stick the window only across pages, not desks while -StickyAcrossDesks and StickyAcrossDesksIcon -works the other way round. - -Windows that have been marked as -Sticky or - or -StickyAcrossPages will have stipples drawn -on the titlebar. This can be negated with the -! -style. The style -StickyStippledTitle -puts back the stipples where that window has also been marked as -Sticky. Note that this is the default style for -Sticky windows. Sticky icons will have stipples drawn -on the icon title. This can be disabled in the same way with the -! -style. - -Windows with the - -style are shown as icons initially. Note that some applications -counteract that by deiconifying themselves. The default is to not -iconify windows and can be set with the - -style. - - -makes the window sticky when it's iconified. It de-iconifies on -top the active desktop. - -reverts back to the default. - - -works like -StickyIcon, -but sticks the icon only across pages, not desks while - -works the other way round. - - -works like -StippledTitle -in that it draws stipples on the titles of icons but doesn't -make the icon sticky. - - -makes fvwm ignore attempts of clients to raise or lower their own -windows. By default, the opposite style, - -is active. - - and -make fvwm ignore attempts of the user to move the window. It is -still possible to move the window by resizing it. To allow the -user to move windows, use the - or -style. - - and -make fvwm ignore attempts of the user to resize the window. To -allow the user to resize windows, use the - or -style. - - and -make fvwm ignore attempts of the program to move or resize its -windows. To allow this kind of actions, use the - or -style. These styles may sometimes affect the initial placement -and dimensions of new windows (depending on the application). If -windows are created at strange places, try either the - or -styles. The - -style may screw up window dimensions for some applications. Do Not -use this style in this case. - - -affects how fvwm reacts to requests by the application to move its -windows. By default, fvwm tries to detect which method to use, -but it sometimes detects the wrong method. You may come across a -window that travels across the screen by a few pixels when the -application resizes it, moves to a screen border with the frame -decorations off screen, that remembers its position for the next -time it starts but appears in a slighly shifted position, or that -attepmts to become full screen but has the. Try out both options, - and -on the window (and that window only) and see if that helps. By -default, fvwm uses the - -method. Once the method was detected, it is never changed again. -As long as fvwm can not detect the proper method, it uses -. -To force fvwm to retry the detection, use one of the other two -options first and then use -AutoDetect -again. - -Note: This option was introduced to alleviate a problem with the -ICCCM specification. The ICCCM clearly states that the - -option should be used, but traditionally applications ignored this -rule. - - -enables the functions -, - -and - -to be performed on the windows. This is on by default. -The opposite, -!Closable, -inhibits the window to be closed. - - -enables the function - -to be performed on the windows. -This is on by default. -The opposite, -!Iconifiable, -inhibits the window from being iconified. - - -enables the function - -to be performed on the windows. -This is on by default. -The opposite, -!Maximizable, -inhibits the window from being maximized. - - -enables the function - -to be performed on windows that are not resizable, unless -maximization has been disabled either using the style -!Maximizable -or through WM hints. This is on by default. The opposite, -!AllowMaximizeFixedSize, -inhibits all windows that are not resizable from being maximized. - - -instructs fvwm to ignore the program supplied minimum and maximum -size as well as the resize step size (the character size in many -applications). -This can be handy for broken applications that refuse to be -resized. Do not use it if you do not need it. The default -(opposite) style is -. - -MinWindowSize [ width [ p ] height [ p ] ] -Tells fvwm the minimum width and height of a window. The values -are the percentage of the total screen area. If the letter -'p' -is appended to either of the values, the numbers are interpreted -as pixels. This command is useful for certain versions of xemacs -which freak out if their windows become too small. If you omit -he parameters or their values are invalid, both limits are set to -0 pixels (which is the default value). - -MaxWindowSize [ width [ p ] height [ p ] ] -Tells fvwm the maximum width and height of a window. The values -are the percentage of the total screen area. If the letter -'p' -is appended to either of the values, the numbers are interpreted -as pixels. This command is useful to force large application -windows to be fully visible. Neither -height nor width -may be less than 100 pixels. If you omit the parameters or their -values are invalid, both limits are set to 32767 pixels (which is -the default). - -With - -all windows in the same window group are iconified and deiconified -at once when any window in the group is (de)iconified. - The default is -, -which disables this behavior. Although a number of applications -use the window group hint, it is rarely used in a proper way, so -it is probably best to use -IconifyWindowGroups -only for selected applications. - -The option -affects interactive window movement: If during an interactive -move the window or icon comes within -proximity pixels of another the window -or icon, it is moved to make the borders adjoin. The default of 0 -means that no snapping happens. Calling this command without -arguments turns off snap attraction and restores the default -behavior. Please refer also to the -command. - -The second argument determined is optional and may be set to one of the -five following values: With All both icons and -windows snap to other windows and other icons. -SameType lets windows snap only to windows, and -icons snap only to icons. With Windows windows snap -only to other windows. Similarly with Icons icons -snap only to other icons. With None no snapping -takes place. This option can be useful in conjunction with the following -argument if you only want to snap against the screen edges. The default -behavior is All. - -The third and last optional argument may be set to one of the -four following values: - -With Screen the -already snapping icons or windows, which is controlled by the second -argument, will snap now also to the screen edges. -ScreenWindows snaps -only windows to the screen edges. -ScreenIcons snaps -only icons to the screen edges. -ScreenAll snaps -windows and icons to the screen edges. - - -The option defines an -invisible grid on the screen. During an interactive move a window -or icon is positioned such that its location (top left corner) is -coincident with the nearest grid point. The default -x-grid-size and -y-grid-size setting are both 1, which -is effectively no grid all. - -An interactive move with both and - results in the window -being moved to be adjacent to the nearest window border (if within -snap proximity) or grid position. The window moves the shortest -distance possible to satisfy both and -. Note that the x and y -coordinates are not coupled. For example, a window may snap to -another window on the x axis while snapping to a grid point on the -y axis. Using this style without arguments reinstates the default -settings. - -The styles and - tells how hard it -should be to change the desktop viewport by moving or resizing a -window over the edge of the screen. The parameter tells how many -milliseconds the pointer must spend on the screen edge before fvwm -moves the viewport. The command -determines how far the viewport is scrolled. If -1 is given as -the delay, page flipping is disabled completely. The defaults are -no delay for moving (0) and no flipping for resizing (-1). Using -these styles without any argument restores the default -settings. Note that, with - - - 0 0 - - -it is still possible to move or resize windows across the -edge of the current screen. See also . - -The option -makes it easier to place a window directly adjacent to the -screen's or xinerama screen's border. It takes one or two -parameters. The first parameter tells how many pixels over the -edge of the screen a window's edge must move before it actually -moves partially off the screen. The optional second parameter -does the same as the first, but for individual RandR screens. -If omitted, the value of the first parameter is assumed for this -type of movement. Set the second parameter to 0 to zero to ignore -individual RandR screen edges. Note that the center of the -window being moved determines the screen on which the -window should be kept. Both values are 0 by default. To restore -the defaults, the option can be used without any -parameters. - -The option allows -for any valid fvwm command or function to run when the window is -initially mapped by fvwm. Example: - - - MyWindow StartsOnPage 0 0, InitialMapCommand Iconify - - -This would hence place the window called MyWindow -on page 0 0 for the current desk, and immediately run the -command on that window. - -Note that should be -used as a global option for all windows, but there is a need that some -windows should not have this command applied, then an action of - can be used on those windows, as in the following -example: - - - * InitialMapCommand Iconify - XTeddy InitialMapCommand Nop - - -
- -
-Window Manager placement - -Applications can place windows at a particular spot on the screen -either by window manager hints or a geometry specification. When -they do neither, then the window manager steps in to find a place -for the window. Fvwm knows several ways to deal with this -situation. The default is -TileCascadePlacement. - - - -[Center|UnderMouse|move-arguments] -When used without an argument, new windows are placed in the -top left corner of the display. With the argument -Center, -all new window appear at the center of the screen, and with -UnderMouse, -windows are centered under the mouse pointer where possible. If the window -is unable to fit on the screen because the pointer is at the edge of the -screen, then the window is forced on-screen using this option. If any other -move-arguments -are given, they are interpreted exactly as the -Move -command does (with the exception that references to the current -window position do not work as the window has not been placed -yet). - - - -automatically place new windows in a cascading fashion. - - - -automatically places new windows in a smart location - a location -in which they do not overlap any other windows on the screen. If -no such position can be found -CascadePlacement -is used as a fall-back method. - - -This is the same as -TileCascadePlacement, -but uses -ManualPlacement -as the fall-back method. - - -automatically places new windows in a location in which the -overlapping area in pixels of other windows is minimized. -By default this placement policy tries to avoid -overlapping icons and windows on higher layers. -This can be configured with the - -style. - - -is similar to -MinOverlapPlacement -but tries to minimize the overlapped percentages of other windows -instead of the overlapped area in pixels. This placement policy -tries to avoid covering other windows completely and tries even -harder not to cover small windows. -This can be configured with the -MinOverlapPlacementPenalties -and - -styles. - -MinOverlapPlacementPenalties -takes at most 6 positive or null decimal arguments: - - -normal ontop icon sticky below strut - - -if trailing arguments are missing the default is used which is: - - -1 5 10 1 0.05 50 - - -To reset this style to the default values, prefix it with a '!'. This style configures the -MinOverlapPlacement and MinOverlapPercentPlacement -placement policy. -The -normal -factor affects normal windows, the -ontop -factor affects windows with a greater layer than the window being -placed, the -icon -factor affects icons, the -sticky -factor affects sticky windows, the -below -factor affects windows with a smaller layer than the window being -placed, the -strut -factor affects the complement of the EWMH working area if the -window being placed has the - -style and windows with an EWMH strut hint (i.e., a "please do not -cover me" hint) if the window being placed has the - -style. These factors represent the amount of area that these -types of windows (or area) are counted as, when a new window is -placed. For example, by default the area of ontop windows is -counted 5 times as much as normal windows. So -MinOverlapPlacement and MinOverlapPercentPlacement -covers 5 times as much area of another window before it will -cover an ontop window. To treat ontop windows the same as other -windows, set this to 1. To really, really avoid putting windows -under ontop windows, set this to a high value, say 1000. This -style affects the window already mapped and not the window which -is currently placed. There is one exception to this rule: in the -case of the window being placed has the -EWMHPlacementUseWorkingArea -style the -strut -factor affects the placed window. - -MinOverlapPercentPlacementPenalties -takes at most 4 positive or null integer arguments: - - -cover_100 cover_95 cover_85 cover_75 - - -if trailing arguments are missing the defaults are used -which are: - - -12 6 4 1 - - -To reset this style to the default values, prefix it with a '!'. - -This style affects the -MinOverlapPercentPlacement -placement policy and is similar to the -MinOverlapPlacementPenalties -style. The -cover_xx -factor is used when the window being placed covers at least -xx -percent of the window. This factor is added to the factor -determined by the -MinOverlapPlacementPenalties -style. - - - -(aka active placement). The user is required to place every new -window manually. The window only shows as a rubber band until a -place is selected manually. The window is placed when a mouse -button or any key except - -is pressed. Escape aborts manual placement which places the -window in the top left corner of the screen. If mouse button 2 is -pressed during the initial placement of a window (respectively - -and mouse button 1 in case Mwm emulation has been enabled with the - -command), the user is asked to resize the window too. - -It is possible to define buttons usable to place windows with the - -command and the special context 'P' for placement (see - -command). However, you can't redefine the way to also resize the -window other than the way it is affected by the - -command. The button used for placing the window can be checked with -the - -condition (see - -command). - -Example: - - -Style * ManualPlacement - -*FvwmEvent: PassID -*FvwmEvent: add_window GrowDownFunc - StartFunction -+ I FvwmEvent - - GrowDownFunc -+ I windowid $0 (PlacedByButton 3) \ - bottomright keep -0p - - - -Now, whenever a window is created and the user presses button 3 to -finish initial placement, the window is automatically enlarged -until it hits the bottom screen border. - -Old placement styles -DumbPlacement / SmartPlacement / SmartPlacementOff, -CleverPlacement / CleverPlacementOff, -ActivePlacement / RandomPlacement, -ActivePlacementsHonorsStartsOnPage / -ActivePlacementsHonorsStartsOnPageOff, GlobalOpts -SmartPlacementIsReallySmart / GlobalOpts SmartPlacementIsNormal -are still supported but will be removed in the future. The old and -new styles can be translated according to the following table: - - - SmartPlacementIsReallySmart -Style * SmartPlacement ---> -Style * SmartPlacement, CleverPlacement - - SmartPlacementIsNormal -Style * SmartPlacement - --> -Style * SmartPlacement, CleverPlacementOff - -Style * DumbPlacement, RandomPlacement - --> -Style * CascadePlacement - -Style * DumbPlacement, ActivePlacement - --> -Style * ManualPlacement - -Style * SmartPlacement, \ -RandomPlacement, CleverPlacementOff - --> -Style * TileCascadePlacement - -Style * SmartPlacement, \ -ActivePlacement, CleverPlacementOff - --> -Style * TileManualPlacement - -Style * SmartPlacement, CleverPlacement - --> -Style * MinOverlapPlacement - -Style * SmartPlacement, \ -ActivePlacement, CleverPlacement - --> -Style * MinOverlapPercentPlacement - -Style * ActivePlacementsHonorsStartsOnPage - --> -Style * ManualPlacementsHonorsStartsOnPage - -Style * ActivePlacementsHonorsStartsOnPageOff - --> -Style * ManualPlacementsHonorsStartsOnPageOff - - -
- - - - -
-Placement policy options and window stacking - - -instructs fvwm to ignore the program specified position (PPosition -hint) when adding new windows. Using PPosition is required for -some applications, but if you do not have one of those it's a real -headache. Many programs set PPosition to something obnoxious like -0,0 (upper left corner). -Note: !UsePPosition -is equivalent to the deprecated option -!UsePPosition - - -works like -!UsePPosition -but applies suppresses using the user specified position indicated -by the program (USPosition hint). It is generally a bad thing to -override the user's choice, but some applications misuse the -USPosition hint to force their windows to a certain spot on the -screen without the user's consent. -Note: !UseUSPosition -is equivalent to the deprecated option -!USPosition - - - and - -work like -!UsePPosition and -UsePPosition -but apply only to transient windows. -Note: !UseTransientPPosition -is equivalent to the deprecated option -!TransientPPosition - - -instructs fvwm to ignore the program specified icon position -(IconPosition hint) when iconifying the window. -Note: !UseIconPosition -is equivalent to the deprecated option -!IconPosition - - -takes a numeric argument which is the desktop number on which the -window should be initially placed. Note that standard Xt programs -can also specify this via a resource (e.g. "-xrm '*Desk: 1'"). - - -takes 1, 2, or 3 numeric arguments. If one or three arguments are -given, the first (or only) argument is the desktop number. If -three arguments are given, the 2nd and 3rd arguments identify the -x,y page position on the virtual window. If two arguments are -given, they specify the page position, and indicate no desk -preference. If only one argument is given, -StartsOnPage -functions exactly like -StartsOnDesk. -For those standard Xt programs which understand this usage, the -starting desk/page can also be specified via a resource (e.g., -"-xrm '*page: 1 0 2'"). -StartsOnPage -in conjunction with - -is a useful technique when you want to start an app on some other -page and continue with what you were doing, rather than waiting -for it to appear. - - -takes one argument. It must be a valid RandR name. -A new window is placed on the specified screen. The -default is to place windows on the screen that contains the mouse -pointer at the time the window is created. However, those windows -which are not placed by fvwm (i.e., those with a USPosition hint -from a user specified geometry) are normally placed in a position -relative to all identified screens. - - -causes the -StartsOnPage -style to be applied even for transient windows. This is not -usually useful, since transients are usually pop ups that you want -to appear in your visible viewport; but occasionally an -application uses a transient for something like a startup window -that needs to be coerced into place. - - -suppresses -StartsOnPage or StartsOnDesk -placement in the event that both -ManualPlacement and SkipMapping -are in effect when a window is created. This prevents you from -interactively placing a window and then wondering where it -disappeared to, because it got placed on a different desk or page. - -allows this to happen anyway. The option has no effect if -SkipMapping -is not in effect, because fvwm switches to the proper desk/page to -perform interactive placement. The default is -ManualPlacementIgnoresStartsOnPage; -ManualPlacementHonorsStartsOnPage -matches the way the old -StartsOnDesk -style used to handle the situation. - - -causes the initial capture (of an already existing window) at -startup to place the window according to the -StartsOnPage and StartsOnScreen -desk, page and screen specification. - -causes fvwm to ignore these settings (including -StartsOnDesk) -on initial capture. The default is -CaptureIgnoresStartsOnPage. - - -causes a window to be placed according to, or revert to, the -StartsOnPage and StartsOnScreen -desk, page and screen specification on -. - -causes fvwm to respect the current window position on -. -The default is -RecaptureIgnoresStartsOnPage. - - - -accepts one optional argument: a non-negative integer. This is -the layer the window is put in. If no argument is given, any -previously set value is deleted and the default layer is implied. - - -puts the window in the top layer. This layer can be changed by -the command -; -the default is 6. - - -puts the window in the put layer. This layer can be changed by -the command -; -the default is 4. - - -puts the window in the bottom layer. This layer can be changed by -the command -; -the default is 2. - - -instructs fvwm to put the window initially at the bottom of its -layer rather than the default -. - - -tells fvwm to shade the window. An optional direction argument may be -given, which can be one of -"", -"", -"", -"", -"", -"", -"", -"" or -if no direction is given, the default is to shade north. - -SkipMapping -tells fvwm not to switch to the desk the window is on when it gets -mapped initially (useful with -StartsOnDesk or StartsOnPage). - - -makes new windows that have the window group hint set appear on -the same desk as the other windows of the same group. Since this -behavior may be confusing, the default setting is -. -The window group hint is ignored when placing windows in this -case. - -
- - - - -
-Transient windows - - -causes transient windows, which are normally left undecorated, to -be given the usual fvwm decorations (title bar, buttons, -etc.). Note that some pop-up windows, such as the xterm menus, are -not managed by the window manager and still do not receive -decorations. - -(the default) causes transient windows not to be given the -standard decorations. You can only bind keys or mouse buttons to -the sides and the client part of an undecorated window ('S' and -´W' contexts in bindings, see - and -commands). - -A window with the - -style that has transient windows raises all its transients when it -is raised. The - -style disables this behavior. All windows are then treated as if -they had no transients. - -A window with the - -style that has transient windows lowers all its transients when it -is lowered. The - -style disables this behavior. All windows are then treated as if -they had no transients. - -The - -style augments -RaiseTransient and LowerTransient -styles. Raising a window with -StackTransientParent -style transfers the raise action to the main window if the window -being raised is a transient and its main window has -RaiseTransient -style; this effect makes raise on a transient act just like raise -on its main - the whole group is raised. Similar behavior holds -for lowering a whole group of transients when the main has -LowerTransient -style. - -turns this behavior off. - -has no effect if -RaiseTransient and LowerTransient -are not used. - -A reasonable emulation of Motif raise/lower on transients is -possible like this - - -Style * RaiseTransient -Style * LowerTransient -Style * StackTransientParent - - -
- - - - -
-Extended Window Manager Hints styles - -To understand the used terminology in this sub section, please -read the - -section. - - -instructs fvwm to set the application ewmh icon hint with the icon -that is used by fvwm if the application does not provide such hint -(and if the icon used by fvwm is not an icon window). - -does the same thing for mini icons. This allows compliant pager, -taskbar, iconbox ...etc to display the same (mini) icons as -fvwm. Note that on some hardware (e.g., 8-bit displays) these -styles can slow down window mapping and that in general only one -of these styles is needed by a compliant application. - -and - -restore the defaults which are to not set any ewmh (mini) icons -hints. - -By default, if an application provides an ewmh icon hint of small -size (i.e., height and width less than or equal to 22), then fvwm -uses this icon as its mini icon. - -instructs fvwm to ignore ewmh icons and to use the mini icon -provided by the -MiniIcon -style. - -restores the default. - - -causes fvwm to use EWMH hints and respect EWMH hints which change -the window layer. - -causes fvwm to ignore EWMH layer hints. - -An application can ask for some reserved space on the desktop by a -hint. In the EWMH terminology such a hint is called a strut and -it is used to compute the working area and may be used for window -placement and in the maximize command. - -causes fvwm to ignore such hints, as -, -causes fvwm to use it which is the default. - - -causes fvwm to ignore initial EWMH state hints when a new window -is mapped. The default - -causes fvwm to accept such hints. - - -causes fvwm to ignore EWMH window type specification. The default -!EWMHIgnoreWindowType -causes fvwm to style windows of specified types as such. - - -causes fvwm to ignore the EWMH working area when it executes a - -command. With - -the EWMH working area is used as with - -the EWMH dynamic working area is used (the default). - - -causes fvwm to ignore the EWMH working area when it places (or -places again) a window. With -EWMHPlacementUseWorkingArea -the EWMH working area is taken in account as with -EWMHPlacementUseDynamicWorkingArea -the EWMH dynamic working area is taken in account (the default). -Note that with the -MinOverlapPlacement and MinOverlapPercentPlacement -placement policy, the way the EWMH (dynamic) working area is taken -in account is configurable with the -MinOverlapPlacementPenalties -style. - -
- - - - -
-Miscellaneous - -The -, and -determine if the X server uses backing store for the window or -not. - -means that the X server tries to keep the obscured parts of a -window in memory. This is usually slower if the client runs on -the same machine as the X server, but can be much faster if the -connection is slow (see also -SaveUnder -below). - -disables backing store for the window. By default, fvwm -does not enable or disable backing store itself but leaves is as -the window requested it. To revert back to the application's -choice, use the - -style. - -Note: This style is useless if the X server does not allow backing -store. - - - -enables the corresponding window attribute in the X server. For a -window using this style, the X server tries to store the graphics -below it in memory which is usually slower if the client runs on -the same machine as the X server. -SaveUnder -may speed up fvwm if the connection to the X server is slow -(e.g. over a modem link). To disable save under, use the - -style. This is the default. See also -BackingStore -above. - -Note: This style is useless if the X server does not allow save -under. - - -enables clients that use a background pixmap of type - -to achieve transparency. Fvwm modules that support transparent -colorsets require this setting. - -is the default and should be used for all non-transparent clients -for better performance. - - -makes fvwm attempt to recognize and respect the mwm decoration -hints that applications occasionally use. To switch this style -off, use the - -style. - - -makes fvwm attempt to recognize and respect the mwm prohibited -operations hints that applications occasionally use. - -makes fvwm shade out operations that mwm would prohibit, but it -lets you perform the operation anyway. - -allows turns off the mwm hints completely. - - -makes fvwm attempt to recognize and respect the olwm and olvwm -hints that many older XView and OLIT applications use. Switch -this option off with -. - -With - -fvwm ignores all GNOME hints for the window, even if GNOME -compliance is compiled in. This is useful for those pesky -applications that try to be more clever than the user and use -GNOME hints to force the window manager to ignore the user's -preferences. The - -style switches back to the default behavior. - - -This style is deprecated and will be removed in the future. There -are plans to replace it with a more flexible solution in fvwm-3.0. - -UseDecor -accepts one argument: the name of a decor created with -. -If no decor name is specified, the "Default" decor is -used. Windows do not actually contain decors, but are always -assigned to one. If the decor is later modified with -, -the changes are visible for all windows which are assigned to it. -The decor for a window can be reassigned with -. - - -This style is deprecated and will be removed in the future. There -are plans to replace it with a more flexible solution in fvwm-3.0. - -UseStyle -takes one arg, which is the name of another style. That way you -can have unrelated window names easily inherit similar traits -without retyping. For example: - - - Style rxvt UseStyle XTerm - - -Warning: If a style is built from one or more parent styles and -the parent styles are changed, the derived style is not -modified. To achieve this you have to issue the -UseStyle -line again. - - -Windows with the -Unmanaged -style option are ignored by fvwm. They are not decorated, can not -be moved or resized, etc. You probably want to use -Bugopts RaiseOverUnmanaged -too. This option can be turned off with the -!Unmanaged -style. - - - -sets the initial value of one of the 32 user defined states -which are associated with each window. The state number ranges -from 0 to 31 and must be given as an argument. The states have no -meaning in fvwm, but they can be checked in conditional commands -like - -with the -State -condition and manipulated with the - -command. - - -# turn on state 11 for xterms ... -Style xterm 11 -# ... but not for rxvts. -Style rxvt !State 11 - - - - - -Windows with the - -styles do not appear in the menu that is created with the - -command or the lists shown in modules like -. -In the modules, the style can usually be ignored with an option. -Please refer to the man page of the module in question for -further information. To disable this feature, use the default -style -. - -The styles - and -control whether the window is considered by conditional commands, -for example -, or . -Windows with -, -are never selected by conditional commands. However, the styles -can be overridden explicitly in the condition with the -, or -conditions, and some conditional commands, e.g. - and , -do this by default. -The styles -, , - and -work like -CirculateSkip and CirculateHit -but apply only to iconic or shaded windows. -Note: if multiple ...Skip... options are combined, windows are -only selected if they match none of the given conditions. So, -with - - -Style * CirculateSkipIcon, CirculateSkipShaded - - -only windows that are neither iconic nor shaded are selected. -Note: For historical reasons, the conditional commands understand -the names of these styles as condition names. Take care not to -confuse them. - -
- - - - - - - -
-Examples - - - -# Change default fvwm behavior to no title- -# bars on windows! Also define a default icon. -Style * !Title, \ - Icon unknown1.xpm, \ - BorderWidth 4, \ - HandleWidth 5 - -# now, window specific changes: -Style Fvwm* !Handles, Sticky, \ - WindowListSkip, \ - BorderWidth 0 -Style FvwmPager StaysOnTop, BorderWidth 0 -Style *lock !Handles, Sticky, \ - StaysOnTop, WindowListSkip -Style xbiff Sticky, WindowListSkip -Style FvwmButtons !Handles, Sticky, \ - WindowListSkip -Style sxpm !Handles - -# Put title-bars back on xterms only! -Style xterm Title, Color black/grey - -Style rxvt Icon term.xpm -Style xterm Icon rterm.xpm -Style xcalc Icon xcalc.xpm -Style xbiff Icon mail1.xpm -Style xmh Icon mail1.xpm, \ - StartsOnDesk 2 -Style xman Icon xman.xpm -Style matlab Icon math4.xpm, \ - StartsOnDesk 3 -Style xmag Icon magnifying_glass2.xpm -Style xgraph Icon graphs.xpm -Style FvwmButtons Icon toolbox.xpm -Style Maker StartsOnDesk 1 -Style signal StartsOnDesk 3 - -# Fire up Netscape on the second desk, in the -# middle of my 3x3 virtual desktop, and do not -# bother me with it... -Style Netscape* SkipMapping, \ - StartsOnPage 1 1 1 - - -Note that all properties for a window are or'ed together. In the -above example "FvwmPager" gets the property -StaysOnTop -via an exact window name match but also gets -!Handles, Sticky and WindowListSkip -by a match to "Fvwm*". It gets -!Title -by virtue of a match to "*". If conflicting styles are specified -for a window, then the last style specified is used. - -
- -
diff --git a/doc/commands/TearMenuOff.xml b/doc/commands/TearMenuOff.xml deleted file mode 100644 index bd0bfabfa..000000000 --- a/doc/commands/TearMenuOff.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -%myents; -]> - - - -
-TearMenuOff - - - TearMenuOff - - -When assigned to a menu item, it inserts a tear off bar into the -menu (a horizontal broken line). Activating that item tears off -the menu. If the menu item has a label, it is shown instead of -the broken line. If used outside menus, this command does -nothing. Examples: - - - WindowMenu -+ I "" TearMenuOff - - RootMenu -+ I "click here to tear me off" TearMenuOff - - -
diff --git a/doc/commands/Test.xml b/doc/commands/Test.xml deleted file mode 100644 index 951fdd446..000000000 --- a/doc/commands/Test.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - -%myents; -]> - - -
-Test - - - Test(test-conditions)command - - -Performs command if all -test-conditions are satisfied. The -test-conditions -are keywords with possible arguments from the list below -and are separated by commas or whitespace. They include: -Version operator x.y.z, -EnvIsSet varname, -EnvMatch varname pattern, -EdgeHasPointer direction, -EdgeIsActive direction, -Start, -Init, -Restart, -Exit, -Quit, -ToRestart, -True, -False, -F, -R, -W, -X and -I. -A test-condition prefixed with "!" is negated. - -The - operator x.y.z -test-condition is fulfilled if the logical condition of the expression is -true. Valid operator values are: ->=, ->, -<=, -<, -== -and -!=. - -Example: - - -Test (Version >= 2.5.11) 2.5.11 or later. - - -The - varname -test-condition is true if the given environment variable is set. -The - varname pattern -test-condition is true if -pattern -matches the given environment or infostore variable value. -(See ). -The pattern may contain special "*" and "?" chars. -The "varname" is coded without the leading dollar sign ($). - - -The - -direction -test-condition is true if the edge in the given direction currently -contains the pointer. -The - -direction -test-condition is true if the edge in the given direction currently is -active. An edge is active, and can contain a pointer if either a -command is bound to it or edge scroll is available in that -direction. The direction may be one of - Any, North, Top, Up, West, Left, South, Bottom, - Down, Right and East. -If no direction is specified Any is assumed. - -The - -test-condition is the same as either - or . -It is only true on startup or restart prior and during -StartFunction -execution. -The - -test-condition is the same as either - or . -It is only valid on shutdown during -ExitFunction -function execution. - -The and -test-conditions are unconditionally true and false. - -Additionally, if a test-condition name is not recognized, the Error -return code is set and the command is not executed. - -The - file, - file, - file, - file and - file -test-conditions test for existence of the given [F]ile (possibly -with [R]ead/[W]rite permissions), e[X]ecutable (in $PATH), -or the [I]mage (in ImagePath). - -Example: - - - StartFunction I Test (Init) exec xterm - - VerifyVersion -+ I Test (Version 2.5.*) 2.5.x detected -+ I (NoMatch) \ - Test (!Version 2.6.*) Future version -+ I (NoMatch) \ - 2.6.x is detected - -Test (F $[FVWM_USERDIR]/local-config) local-config -Test (X xterm-utf16) exec xterm-utf16 - - - -
diff --git a/doc/commands/TestRc.xml b/doc/commands/TestRc.xml deleted file mode 100644 index 839be220c..000000000 --- a/doc/commands/TestRc.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - -%myents; -]> - - -
-TestRc - - - TestRc(!returncode)command - - - -Performs -command -if the last conditional command returned the value -returncode. -Instead of the numeric values 0 (no match), 1 (match), -1 (error), -and -2 (break) the symbolic names "", -"", "" and -"" can be used. If no -returncode -is given, the default 0 is assumed. If the return code is -prefixed with '!', the command is executed if -returncode -does not match the value returned by the conditional command. -The TestRc -command can only be used inside functions. If the -command -is another conditional command, the previous return code is -replaced by the new one. Example: - - - ToggleXterm -+ I (my_xtermwindow) -+ I TestRc (NoMatch) xterm -T my_xtermwindow - - - -
diff --git a/doc/commands/ThisWindow.xml b/doc/commands/ThisWindow.xml deleted file mode 100644 index 0e39523cf..000000000 --- a/doc/commands/ThisWindow.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - -%myents; -]> - - -
-ThisWindow - - - ThisWindow(conditions)command - - -ThisWindow -executes the specified -command -in the context of the current operand window. If there is no -operand window (it is invoked in the root window), the command is -ignored. -ThisWindow -is never interactive. The command is executed only if the given -conditions -are met. It returns -1 if used outside a window context. -See section for a list of conditions. - -This command implies the conditions -CirculateHit, CirculateHitIcon and CirculateHitShaded. -They can be turned off by specifying "!CirculateHit" -etc. explicitly. - -
diff --git a/doc/commands/Title.xml b/doc/commands/Title.xml deleted file mode 100644 index ebb935dff..000000000 --- a/doc/commands/Title.xml +++ /dev/null @@ -1,20 +0,0 @@ - - -%myents; -]> - - - -
-Title - - - Title - - -Does nothing This is used to insert a title line in a popup or menu. - -
diff --git a/doc/commands/TitleStyle.xml b/doc/commands/TitleStyle.xml deleted file mode 100644 index 11230ed9a..000000000 --- a/doc/commands/TitleStyle.xml +++ /dev/null @@ -1,288 +0,0 @@ - - - -%myents; -]> - - -
-TitleStyle - - - TitleStylejustificationHeight numMinHeight num - - -Sets attributes for the title-bar. Justifications can be -, - or -. - -sets the title bar's height to an amount in pixels. - -sets the minimal height in pixels of the title bar. -Defaults are -Centered, -the window's font height and no minimal height. -To reset the font height to the -default value, omit the -num -argument after the -Height -keyword. The -MinHeight -height is reset by -Height -or if given with no argument. -Example: - - -TitleStyle LeftJustified Height 24 - - - - - TitleStylestatestyle-- !flag - - - -Sets the style for the title-bar. -See also - and -state -can be one of "", -"", -"", -or "". Shortcuts like -"" and -"" are -allowed. The states with the "Toggled" prefix are allowed too, -the title itself does not use "Toggled" states, but these states -are used for the buttons with - -. -If -state -is omitted, then the -style -is added to every state. If parentheses are placed around the -style and flags, -then multiple state definitions can be given per line. -style -can be omitted so that flags can be set while not destroying the -current style. - -If a -'!' -is prefixed to any -flag, -its behavior is negated. Valid flags for each state include -, - and - -(these are mutually exclusive). The default is -. -See the note in - -regarding the "" state. Examples: - - -TitleStyle ActiveUp HGradient 16 navy black -TitleStyle \ - ActiveDown (Solid red -- flat) \ - Inactive (TiledPixmap wood.xpm) -TitleStyle \ - ActiveUp (-- Flat) \ - ActiveDown (-- Raised) \ - InactiveUp (-- Flat) \ - InactiveDown (-- Sunk) - - -This sets the "ActiveUp" state to a horizontal gradient, the -"ActiveDown" state to solid red, and the "Inactive" states to a -tiled wood pixmap. Finally, "ActiveUp" and "InactiveUp" are set -to look flat, while "ActiveDown" set to be sunk (the - -flag for the "ActiveDown" state causes it to appear sunk due to -relief inversion), and "InactiveDown" is set to look raised. An -example which sets flags for all states: - - -TitleStyle -- flat - - -For a flattened look: - - -TitleStyle -- flat - Active (-- flat) Inactive (-- flat) - - - -TitleStyle -accepts all the - - styles and arguments: - -, -, -, -, -, -, -, -, -, -, -, -. - -See the - -command for a description of all these styles and their arguments. - -In addition to these styles -TitleStyle -accepts a powerful - -option. This allows you to specify different pixmaps, colorsets or -colors for different parts of the titlebar. Some of them are tiled or -stretched to fit a particular space; others are discrete "transition" -images. The definable - -are: - - - - - The full titlebar - - - - Left of title text - - - - Right of title text - - - - Underneath title text - - - - just to the left of the title text - - - - just to the right of the title text - - - - at the far left end of the titlebar - (just after left buttons if any) - - - - at the far right end of the titlebar - (just before right buttons if any) - - - - under buttons in case of - - - - - - under left buttons in case of - - - - - - under right buttons in case of - - - - - -None of these are mandatory except for -Main -(or, if you do not define -Main -you must define both -LeftMain and RightMain). -If no -Buttons -pixmaps are defined and - -is specified for one or more buttons, -Main, -LeftMain or RightMain -are used as appropriate. - -The syntax for this style type is: - - -MultiPixmap section style arg, ... - - -continuing for whatever you want to define. The -style -can be either -, , or . -See the - -command for the description of these styles. -In the case of a transition section, -LeftEnd, LeftOfText, -RightOfText or RightEnd, - -only resize the pixmap in the "y" direction. For the - and -styles a width of the half of the title bar height is assumed -for the transition sections. - -An example: - - -MultiPixmap Main AdjustedPixmap foo.xpm, \ - UnderText TiledPixmap bar.xpm, \ - Buttons 2 - - -Note that the old syntax is still supported: if the style is omitted, - -is assumed and adding "(stretched)" between the section and the -file name implies -. - -
diff --git a/doc/commands/UnsetEnv.xml b/doc/commands/UnsetEnv.xml deleted file mode 100644 index 35352eeb3..000000000 --- a/doc/commands/UnsetEnv.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -%myents; -]> - - - -
-UnsetEnv - - - UnsetEnvvariable - - -Unset an environment variable, similar to shell's export or -unsetenv command. The -variable -then is removed from the environment array inherited by processes -started directly by fvwm. - -
diff --git a/doc/commands/UpdateDecor.xml b/doc/commands/UpdateDecor.xml deleted file mode 100644 index 9ad44e888..000000000 --- a/doc/commands/UpdateDecor.xml +++ /dev/null @@ -1,42 +0,0 @@ - - -%myents; -]> - - - -
-UpdateDecor - - - UpdateDecordecor - - -This command is deprecated and will be removed in the future. There -are plans to replace it with a more flexible solution in fvwm-3.0. - -This command is kept mainly for backward compatibility. Since -all elements of a decor are updated immediately when they are -changed, this command is mostly useless. - -Updates window decorations. -decor -is an optional argument which specifies the -decor -to update. If given, only windows which are assigned to that -particular -decor -are updated. This command is useful, for instance, after a -, or -(possibly used in conjunction with -). -Specifying an invalid decor results in all windows being updated. - - -
diff --git a/doc/commands/UpdateStyles.xml b/doc/commands/UpdateStyles.xml deleted file mode 100644 index 4e961eef8..000000000 --- a/doc/commands/UpdateStyles.xml +++ /dev/null @@ -1,25 +0,0 @@ - - -%myents; -]> - - - -
-UpdateStyles - - - UpdateStyles - - -All pending updates of all windows' styles and looks are applied -immediately. E.g. if -, - or - -commands were issued inside a fvwm function. - -
diff --git a/doc/commands/Wait.xml b/doc/commands/Wait.xml deleted file mode 100644 index 1c8933125..000000000 --- a/doc/commands/Wait.xml +++ /dev/null @@ -1,61 +0,0 @@ - - -%myents; -]> - - - -
-Wait - - - Waitwindow - - -This command is intended to be used in fvwm functions only. It -causes execution of a function to pause until a new window matching -window -appears. This can be a window's name, class, or resource string. -It may contain the wildcards '*' and '?', which are matched in the -usual Unix filename manner. This is particularly useful in the -"InitFunction" if you are trying to start windows on specific desktops: - - - InitFunction - + I exec xterm -geometry 80x64+0+0 - + I Wait xterm - + I 0 2 - + I exec xmh -font fixed -geometry \ - 507x750+0+0 - + I Wait xmh - + I 0 0 - - -The above function starts an xterm on the current desk, waits for -it to map itself, then switches to desk 2 and starts an xmh. -After the xmh window appears control moves to desk 0. - -Fvwm remains partially functional during a wait, but any input -from the modules is queued up and processed only after the window -appears or the command is aborted. For example, windows can not -be focused with or - during a wait. - -You can escape from a -Wait -pause by pressing -Ctrl-Alt-Escape -(where -Alt -is the first modifier). To redefine this key sequence see the - -command. - - -
diff --git a/doc/commands/WarpToWindow.xml b/doc/commands/WarpToWindow.xml deleted file mode 100644 index 52033c1a4..000000000 --- a/doc/commands/WarpToWindow.xml +++ /dev/null @@ -1,48 +0,0 @@ - - -%myents; -]> - - - -
-WarpToWindow - - - WarpToWindow!raiseraisexpyp - - -Warps the cursor to the associated window and raises it -(unless the option is -present). The parameters -x and y -default to percentage of window down and in from the upper left -hand corner (or number of pixels down and in if -'' -is appended to the numbers). If a number is negative the opposite -edge is used and the direction reversed. This command works also -with windows that are not managed by fvwm. In this case fvwm does -not bring the window onto the screen if it is not visible. For -example it is possible to warp the pointer to the center of the -root window on screen 1: - - - root 1 WarpToWindow 50 50 - - -
diff --git a/doc/commands/WindowFont.xml b/doc/commands/WindowFont.xml deleted file mode 100644 index c5b2c4389..000000000 --- a/doc/commands/WindowFont.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -%myents; -]> - - - -
-WindowFont - - - WindowFontfontname - - -This command is obsoleted by the - -option -. -Please use - - - * fontname - - -instead. - -
diff --git a/doc/commands/WindowId.xml b/doc/commands/WindowId.xml deleted file mode 100644 index c355119ca..000000000 --- a/doc/commands/WindowId.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - -%myents; -]> - - -
-WindowId - - - WindowIdid(conditions)root screencommand - - - -The -WindowId -command looks for a specific window -id -and runs the specified -command -on it. The second form of syntax retrieves the window id of the -root window of the given -screen. -If no -screen -is given, the current screen is assumed. The window indicated by -id -may belong to a window not managed by fvwm or even a window on a -different screen. Although most commands can not operate on such -windows, there are some exceptions, for example the - -command. -Returns -1 if no window with the given id exists. -See section for a list of conditions. - -This command implies the conditions -CirculateHit, CirculateHitIcon and CirculateHitShaded. -They can be turned off by specifying -!CirculateHit -etc. explicitly. - -Examples: - - -WindowId 0x34567890 -WindowId root 1 50 50 -WindowId $0 (Silly_Popup) - - -In the past this command was mostly useful for functions used with -the - -command, or for selective processing of - -calls (as in the last example), but currently these handler functions -are called within a window context, so this command is not really -needed in these cases. Still it may be useful if, for example, the -window id should be stored in the environment variable for a further -proceeding. - - - BOOKMARKED_WINDOW $[w.id] -WindowId $[BOOKMARKED_WINDOW] - - -
diff --git a/doc/commands/WindowList.xml b/doc/commands/WindowList.xml deleted file mode 100644 index 958b89dd5..000000000 --- a/doc/commands/WindowList.xml +++ /dev/null @@ -1,279 +0,0 @@ - - -%myents; -]> - - - -
-WindowList - - - WindowList(conditions)positionoptionsdouble-click-action - - - -Generates a pop-up menu (and pops it up) in which the title and -geometry of each of the windows currently on the desktop are -shown. - -The format of the geometry part is: -desk(layer): x-geometry sticky, -where -desk and layer -are the corresponding numbers and -sticky -is empty or a capital S. The geometry of iconified windows is -shown in parentheses. Selecting an item from the window list -pop-up menu causes the interpreted function "WindowListFunc" to be -run with the window id of that window passed in as $0. The default -"WindowListFunc" looks like this: - - - WindowListFunc -+ I off -+ I -+ I -+ I 5p 5p - - -You can destroy the built-in "WindowListFunc" and create your own -if these defaults do not suit you. - -The window list menu uses the "WindowList" menu style if it is -defined (see - -command). Otherwise the default menu style is used. To switch -back to the default menu style, issue the command - - - WindowList - - -Example: - - - WindowList Meta_L - - -The -conditions -can be used to exclude certain windows from the window -list. Please refer to the - -command for details. Only windows that match the given conditions -are displayed in the window list. The -options -below work vice versa: windows that would otherwise not be -included in the window list can be selected with them. The -conditions -always override the -options. - - -The -position -arguments are the same as for -. -The command -double-click-action -is invoked if the user double-clicks (or hits the key rapidly -twice if the menu is bound to a key) when bringing the window -list. The -double-click-action -must be quoted if it consists of more than one word. - -The -double-click-action -is useful to define a default window if you have bound the window -list to a key (or button) like this: - - -# Here we call an existing function, but -# it may be different. See the default -# WindowListFunc definition earlier in this -# man page. - SwitchToWindow -+ I WindowListFunc - - Tab A M WindowList "Prev SwitchToWindow" - - -Hitting -Alt-Tab -once it brings up the window list, if you hit it twice the focus -is flipped between the current and the last focused window. With -the proper - -menu style (see example above) a window is selected as soon as you -release the -Alt -key. - -The -options -passed to WindowList are separated by commas and can be -Geometry / NoGeometry / NoGeometryWithInfo, -NoDeskNum, -NoLayer, -NoNumInDeskTitle, -NoCurrentDeskTitle, -MaxLabelWidth width, -TitleForAllDesks, -Function funcname, -Desk desknum, -CurrentDesk, -NoIcons / Icons / OnlyIcons, -NoNormal / Normal / OnlyNormal, -NoSticky / Sticky / OnlySticky, -NoStickyAcrossPages / StickyAcrossPages / OnlyStickyAcrossPages, -NoStickyAcrossDesks / StickyAcrossDesks / OnlyStickyAcrossDesks, -NoOnTop / OnTop / OnlyOnTop, -NoOnBottom / OnBottom / OnlyOnBottom, -Layer m [n], -UseSkipList / OnlySkipList, -NoDeskSort, -ReverseOrder, -CurrentAtEnd, -IconifiedAtEnd, -UseIconName, -Alphabetic / NotAlphabetic, -SortByResource, -SortByClass, -NoHotkeys, -SelectOnRelease. - -(Note - normal means not iconic, sticky, or on top) - -With the - -option windows are alphabetically sorted first by resource class, -then by resource name and then by window name (or icon name if - -is specified). - -also works in the expected manner. - -With the - -option windows are sorted just like with -SortByResource, -but the resource name is not taken into account, only the resource -class. - -The - -option works exactly like the - -option with the same name, but overrides the option given in a -menu style. By default, this option is set to the left -Alt -key. To switch it off, use -SelectOnRelease -without a key name. - -If you pass in a function via - funcname, -it is called within a window context of the selected window: - - - IFunc I toggle -WindowList IFunc, NoSticky, CurrentDesk, NoIcons - - -If you use the - -m -n -option, only windows in layers between m and n are displayed. n -defaults to m. With the -ReverseOrder -option the order of the windows in the list is reversed. - -With the - -option the currently focused window (if any) is shown at the -bottom of the list. This is mostly intended for simulating the -Alt-Tab behavior in another GUI. - - - -makes iconified windows be moved to the end of the list. This is -also from another GUI. - -The - -option causes fvwm to not display the geometries as well as -the separators which indicate the different desktops. - -removes the geometries, but keep the desktop information -and indicates iconic windows. - -causes fvwm to not display the desktop number in the geometry -or before the window title with the - -option. - -is only useful if a desktop name is defined with the - -command. It causes fvwm to not display the desktop number before -the desktop name. By default, the WindowList menu have a title -which indicates the current desk or the selected desktop if the - -condition is used. The - -option removes this title. - -causes fvwm to add a menu title with the desk name and/or number -before each group of windows on the same desk. -With -, -the layer of the window is not diplayed. The options -, - and - -enable displaying the page of the window rounded multiples of the -display size. -With -, -the window's screen name is displayed. - -The - -option takes the number of characters to print as its argument. -No more than that many characters of the window name are visible. - -If you wanted to use the -WindowList -as an icon manager, you could invoke the following: - - -WindowList OnlyIcons, Sticky, OnTop, Geometry - - -(Note - the -Only -options essentially wipe out all other ones... but the - -option which just causes -WindowList -to only consider the windows with - -style.) - -
diff --git a/doc/commands/WindowShade.xml b/doc/commands/WindowShade.xml deleted file mode 100644 index ba118fdb6..000000000 --- a/doc/commands/WindowShade.xml +++ /dev/null @@ -1,93 +0,0 @@ - - -%myents; -]> - - - -
-WindowShade - - - WindowShadeboolShadeAgaindirection - - -Toggles the window shade feature for titled windows. Windows in -the shaded state only display a title-bar. If -bool -is not given or "", -the window shade state is toggled. If -bool -is "True", the window is forced to the shaded state. If -bool -is "False", then the window is forced to the non-shaded -state. To force shading in a certain direction, the -direction -argument can be used. Any of the strings -"", -"", -"", -"", -"", -"", -"", -"" or -"" -can be given. The direction can be abbreviated with -the usual one or two letters "", "", etc. Using a direction on -a window that was already shaded unshades the window. To shade it -in a different direction, use the - -option. The direction -Last -shades the window in the direction it last was shaded. If the -window has never been shaded before it is shaded as if no -direction had been given. Windows without titles can be shaded too. -Please refer also to the options -, -, -, -, - and - -options of the - -command. Examples: - - - * , 20, \ - - 1 - S WindowShade North - 1 [ S WindowShade West - 1 ] S WindowShade E - 1 _ S WindowShade S - - - -Note: When a window that has been shaded with a -direction -argument changes the direction of the window title (see - - -option), the shading direction does not change. This may look -very strange. Windows that were shaded without a -direction -argument stay shaded in the direction of the title bar. - -For backward compatibility, the optional argument may also be 1 to -signify "on", and 2 to signify "off". Note that this syntax is -obsolete, and will be removed in the future. - -
diff --git a/doc/commands/WindowShadeAnimate.xml b/doc/commands/WindowShadeAnimate.xml deleted file mode 100644 index f85a3ba4f..000000000 --- a/doc/commands/WindowShadeAnimate.xml +++ /dev/null @@ -1,29 +0,0 @@ - - -%myents; -]> - - - -
-WindowShadeAnimate - - - WindowShadeAnimatestepsp - - -This command is obsolete. Please use the - -option of the - -command instead. - - -
diff --git a/doc/commands/WindowStyle.xml b/doc/commands/WindowStyle.xml deleted file mode 100644 index 147101ce5..000000000 --- a/doc/commands/WindowStyle.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -%myents; -]> - - - -
-WindowStyle - - - WindowStyleoptions - - -sets attributes (styles) on the selected window. The -options -are exactly the same as for the - -command. - -
diff --git a/doc/commands/WindowsDesk.xml b/doc/commands/WindowsDesk.xml deleted file mode 100644 index 887fb4e4e..000000000 --- a/doc/commands/WindowsDesk.xml +++ /dev/null @@ -1,47 +0,0 @@ - - -%myents; -]> - - - -
-WindowsDesk - - - WindowsDeskarg1arg2 - - -Moves the selected window to another desktop. - -This command has been removed and must be replaced by -, -the arguments for which are the same as for the - -command. - - -You cannot simply change the name of the command: the syntax has -changed. If you used: - - -WindowsDesk n - - -to move a window to desk n, you have to change it to: - - - 0 n - - - -
diff --git a/doc/commands/XSync.xml b/doc/commands/XSync.xml deleted file mode 100644 index bc45df966..000000000 --- a/doc/commands/XSync.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - -%myents; -]> - - -
-XSync - - - XSync - - -When -XSync -is called, the X function with the same name is used to send all -pending X requests to the server. This command is intended for -debugging only. - -
diff --git a/doc/commands/XSynchronize.xml b/doc/commands/XSynchronize.xml deleted file mode 100644 index 70618d72d..000000000 --- a/doc/commands/XSynchronize.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -%myents; -]> - - - -
-XSynchronize - - - XSynchronizebool - - -The -XSynchronize -command controls whether X requests are sent to the X server -immediately or not. Normally, requests are sent in larger batches -to save unnecessary communication. To send requests immediately, -use "True" as the argument, to disable this use "False" or to -toggle between both methods use "Toggle" or omit the -bool -argument. Fvwm defaults to synchronized requests when started -with the - -option. This command is intended for debugging only. - -
diff --git a/doc/commands/XorPixmap.xml b/doc/commands/XorPixmap.xml deleted file mode 100644 index 6a0a17575..000000000 --- a/doc/commands/XorPixmap.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -%myents; -]> - - - -
-XorPixmap - - - XorPixmappixmap - - -Selects the pixmap with which bits are xor'ed when doing -rubber-band window moving or resizing. This has a better chance -of making the rubber-band visible if - -does not give good results. An example pixmap -resize.rainbow.xpm -is provided with the icon distribution. To turn the -XorPixmap -off again use the - -command or omit the -pixmap -argument. - -
diff --git a/doc/commands/XorValue.xml b/doc/commands/XorValue.xml deleted file mode 100644 index ab0724a1c..000000000 --- a/doc/commands/XorValue.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -%myents; -]> - - - -
-XorValue - - - XorValuenumber - - -Changes the value with which bits are xor'ed when doing -rubber-band window moving or resizing. -Valid values range from zero to the maximum value of an -unsigned long integer on your system. -Setting this value is a trial-and-error process. -The default value 0 tries to find a -value that gives a good contrast to black and white. -The default value is used if the given -number -is omitted or invalid. - -
diff --git a/doc/docbook-xml/Makefile.am b/doc/docbook-xml/Makefile.am deleted file mode 100644 index a930f11e4..000000000 --- a/doc/docbook-xml/Makefile.am +++ /dev/null @@ -1,15 +0,0 @@ -SUBDIRS = ent - -EXTRA_DIST = \ - README \ - calstblx.dtd \ - catalog.xml \ - dbcentx.mod \ - dbgenent.mod \ - dbhierx.mod \ - dbnotnx.mod \ - dbpoolx.mod \ - docbook.cat \ - docbookx.dtd \ - htmltblx.mod \ - soextblx.dtd diff --git a/doc/docbook-xml/README b/doc/docbook-xml/README deleted file mode 100644 index 6fc60c4bf..000000000 --- a/doc/docbook-xml/README +++ /dev/null @@ -1,8 +0,0 @@ -README for the DocBook XML DTD - -For more information about DocBook, please see - - http://www.oasis-open.org/docbook/ - -Please send all questions, comments, concerns, and bug reports to the -DocBook mailing list: docbook@lists.oasis-open.org diff --git a/doc/docbook-xml/calstblx.dtd b/doc/docbook-xml/calstblx.dtd deleted file mode 100644 index 1e1d91b37..000000000 --- a/doc/docbook-xml/calstblx.dtd +++ /dev/null @@ -1,215 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/catalog.xml b/doc/docbook-xml/catalog.xml deleted file mode 100644 index f75c1d764..000000000 --- a/doc/docbook-xml/catalog.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/dbcentx.mod b/doc/docbook-xml/dbcentx.mod deleted file mode 100644 index ced94c194..000000000 --- a/doc/docbook-xml/dbcentx.mod +++ /dev/null @@ -1,384 +0,0 @@ - - - - - - - - - - - - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - - - -]]> - -]]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/dbgenent.mod b/doc/docbook-xml/dbgenent.mod deleted file mode 100644 index ff5ba90d1..000000000 --- a/doc/docbook-xml/dbgenent.mod +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - - - - diff --git a/doc/docbook-xml/dbhierx.mod b/doc/docbook-xml/dbhierx.mod deleted file mode 100644 index a2f46bebb..000000000 --- a/doc/docbook-xml/dbhierx.mod +++ /dev/null @@ -1,2193 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -%rdbhier; -]]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -%rdbhier2; -]]> - - - - - - - - - - - - - - - - - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> -]]> - - - - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - -]]> -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> - -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - -]]> - - - -]]> - - - - - - - -]]> - - - -]]> - - - - - - - -]]> - - - -]]> - - - - - - - -]]> - - - -]]> - - - - - - - -]]> - - - -]]> - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - - - -]]> - - - -]]> - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - -]]> - - - - -]]> - - - - - -]]> - - - - -]]> - - - - - -]]> - -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> -]]> - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - diff --git a/doc/docbook-xml/dbnotnx.mod b/doc/docbook-xml/dbnotnx.mod deleted file mode 100644 index 74e312f08..000000000 --- a/doc/docbook-xml/dbnotnx.mod +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/dbpoolx.mod b/doc/docbook-xml/dbpoolx.mod deleted file mode 100644 index 25969335d..000000000 --- a/doc/docbook-xml/dbpoolx.mod +++ /dev/null @@ -1,8701 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -%rdbpool; -]]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -]]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -]]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -]]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - - - - - - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - -]]> - - - -]]> - - - - - -]]> - - - -]]> - - - - - -]]> - - - -]]> - - - - -]]> - - - -]]> - - - - - -]]> - - - -]]> - -]]> - - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> -]]> - - - - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - - -]]> - - - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> -]]> - - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - -]]> - - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - -]]> -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - -]]> - - - - - - - - -]]> - - - -]]> - - -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - - -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - - - - - -]]> - - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - - - -%htmltbl; -]]> - - - - - - - - - - - - - - - - - - - -]]> - - - - - - - - - - - - - - - - - - - - - - - - -]]> - -%tablemodel; - -]]> - - - - - - - - - - - - -]]> - - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> - - - - -]]> -]]> - - - - - - - - - - - - - -]]> - - - -]]> - - -]]> - - - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - - - -]]> - - - -]]> - ]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - - - -]]> - - - -]]> - ]]> - - -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> - -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - ]]> - - - - -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - - - -]]> - - - -]]> - ]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - -]]> - - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> - -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> - -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> - - - - - - - - -]]> - - - -]]> - ]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - ]]> - - -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - -]]> - - - - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - -]]> - - - -]]> -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> - - - - -]]> - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - -]]> -]]> - - - - - - - - - - -]]> - - - - - - - -]]> -]]> - - - - - - - - -]]> - - - - - - -]]> -]]> - - - - - - - - - - - -]]> - - - - - - - - - - -]]> -]]> - - - - - - - - - -]]> - - - - -]]> - - - - - -]]> - - - - -]]> - - - - - -]]> - - - - -]]> - -]]> - - - - - - - - -]]> - - - -]]> - - - - -]]> - - - -]]> -]]> -]]> - - - diff --git a/doc/docbook-xml/docbook.cat b/doc/docbook-xml/docbook.cat deleted file mode 100644 index 25ac4dff0..000000000 --- a/doc/docbook-xml/docbook.cat +++ /dev/null @@ -1,113 +0,0 @@ - -- ...................................................................... -- - -- Catalog data for DocBook XML V4.5 .................................... -- - -- File docbook.cat ..................................................... -- - - -- Please direct all questions, bug reports, or suggestions for - changes to the docbook@lists.oasis-open.org mailing list. For more - information, see http://www.oasis-open.org/. - -- - - -- This is the catalog data file for DocBook XML V4.5. It is provided as - a convenience in building your own catalog files. You need not use - the filenames listed here, and need not use the filename method of - identifying storage objects at all. See the documentation for - detailed information on the files associated with the DocBook DTD. - See SGML Open Technical Resolution 9401 for detailed information - on supplying and using catalog data. - -- - - -- ...................................................................... -- - -- DocBook driver file .................................................. -- - -PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "docbookx.dtd" - - -- ...................................................................... -- - -- DocBook modules ...................................................... -- - -PUBLIC "-//OASIS//DTD DocBook CALS Table Model V4.5//EN" - "calstblx.dtd" - -PUBLIC "-//OASIS//ELEMENTS DocBook XML HTML Tables V4.5//EN" - "htmltblx.mod" - -PUBLIC "-//OASIS//DTD XML Exchange Table Model 19990315//EN" - "soextblx.dtd" - -PUBLIC "-//OASIS//ELEMENTS DocBook Information Pool V4.5//EN" - "dbpoolx.mod" - -PUBLIC "-//OASIS//ELEMENTS DocBook Document Hierarchy V4.5//EN" - "dbhierx.mod" - -PUBLIC "-//OASIS//ENTITIES DocBook Additional General Entities V4.5//EN" - "dbgenent.mod" - -PUBLIC "-//OASIS//ENTITIES DocBook Notations V4.5//EN" - "dbnotnx.mod" - -PUBLIC "-//OASIS//ENTITIES DocBook Character Entities V4.5//EN" - "dbcentx.mod" - - -- ...................................................................... -- - -- ISO entity sets ...................................................... -- - -PUBLIC "ISO 8879:1986//ENTITIES Diacritical Marks//EN//XML" - "ent/isodia.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN//XML" - "ent/isonum.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Publishing//EN//XML" - "ent/isopub.ent" - -PUBLIC "ISO 8879:1986//ENTITIES General Technical//EN//XML" - "ent/isotech.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Latin 1//EN//XML" - "ent/isolat1.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Latin 2//EN//XML" - "ent/isolat2.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Greek Letters//EN//XML" - "ent/isogrk1.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Monotoniko Greek//EN//XML" - "ent/isogrk2.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Greek Symbols//EN//XML" - "ent/isogrk3.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN//XML" - "ent/isogrk4.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN//XML" - "ent/isoamsa.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN//XML" - "ent/isoamsb.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN//XML" - "ent/isoamsc.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN//XML" - "ent/isoamsn.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN//XML" - "ent/isoamso.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN//XML" - "ent/isoamsr.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Box and Line Drawing//EN//XML" - "ent/isobox.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Russian Cyrillic//EN//XML" - "ent/isocyr1.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN//XML" - "ent/isocyr2.ent" - - -- End of catalog data for DocBook XML V4.5 ............................. -- - -- ...................................................................... -- diff --git a/doc/docbook-xml/docbookx.dtd b/doc/docbook-xml/docbookx.dtd deleted file mode 100644 index 19a19a6a7..000000000 --- a/doc/docbook-xml/docbookx.dtd +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - - - - - - - - - -]]> - - - - - - - - - -]]> -]]> - - - -]]> - - - -]]> - - - - - - -%dbnotn; -]]> - - - - - - - -]]> - -]]> -]]> - - -%dbcent; -]]> - - - - - - - - -%dbpool; -]]> - - - - - - -%rdbmods; -]]> - - - - - -%dbhier; -]]> - - - - - - -%dbgenent; -]]> - - - diff --git a/doc/docbook-xml/ent/Makefile.am b/doc/docbook-xml/ent/Makefile.am deleted file mode 100644 index 594b9c2b4..000000000 --- a/doc/docbook-xml/ent/Makefile.am +++ /dev/null @@ -1,21 +0,0 @@ -EXTRA_DIST = \ - README \ - isoamsa.ent \ - isoamsb.ent \ - isoamsc.ent \ - isoamsn.ent \ - isoamso.ent \ - isoamsr.ent \ - isobox.ent \ - isocyr1.ent \ - isocyr2.ent \ - isodia.ent \ - isogrk1.ent \ - isogrk2.ent \ - isogrk3.ent \ - isogrk4.ent \ - isolat1.ent \ - isolat2.ent \ - isonum.ent \ - isopub.ent \ - isotech.ent diff --git a/doc/docbook-xml/ent/README b/doc/docbook-xml/ent/README deleted file mode 100644 index c0da542a6..000000000 --- a/doc/docbook-xml/ent/README +++ /dev/null @@ -1,14 +0,0 @@ -XML Entity Declarations for Characters - -The character entity sets distributed with DocBook XML are direct -copies of the official entities located at - - http://www.w3.org/2003/entities/ - -They are distributed for historical compatibility and user convenience. -The DocBook Technical Committee no longer attempts to maintain these -definitions and will periodically update them from the W3C site if and -as they are updated there. - -Please direct all questions or comments about the entities to the -individuals or working groups who maintain the official sets. diff --git a/doc/docbook-xml/ent/isoamsa.ent b/doc/docbook-xml/ent/isoamsa.ent deleted file mode 100644 index 3c836f963..000000000 --- a/doc/docbook-xml/ent/isoamsa.ent +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isoamsb.ent b/doc/docbook-xml/ent/isoamsb.ent deleted file mode 100644 index 19c311a6b..000000000 --- a/doc/docbook-xml/ent/isoamsb.ent +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isoamsc.ent b/doc/docbook-xml/ent/isoamsc.ent deleted file mode 100644 index 41918fba1..000000000 --- a/doc/docbook-xml/ent/isoamsc.ent +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isoamsn.ent b/doc/docbook-xml/ent/isoamsn.ent deleted file mode 100644 index 24f3134ba..000000000 --- a/doc/docbook-xml/ent/isoamsn.ent +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isoamso.ent b/doc/docbook-xml/ent/isoamso.ent deleted file mode 100644 index a0b4e8a63..000000000 --- a/doc/docbook-xml/ent/isoamso.ent +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isoamsr.ent b/doc/docbook-xml/ent/isoamsr.ent deleted file mode 100644 index be8747611..000000000 --- a/doc/docbook-xml/ent/isoamsr.ent +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isobox.ent b/doc/docbook-xml/ent/isobox.ent deleted file mode 100644 index d9431bde5..000000000 --- a/doc/docbook-xml/ent/isobox.ent +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isocyr1.ent b/doc/docbook-xml/ent/isocyr1.ent deleted file mode 100644 index 40dfa2f80..000000000 --- a/doc/docbook-xml/ent/isocyr1.ent +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isocyr2.ent b/doc/docbook-xml/ent/isocyr2.ent deleted file mode 100644 index 34a0f956c..000000000 --- a/doc/docbook-xml/ent/isocyr2.ent +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isodia.ent b/doc/docbook-xml/ent/isodia.ent deleted file mode 100644 index bd890598a..000000000 --- a/doc/docbook-xml/ent/isodia.ent +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isogrk1.ent b/doc/docbook-xml/ent/isogrk1.ent deleted file mode 100644 index a098d5624..000000000 --- a/doc/docbook-xml/ent/isogrk1.ent +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isogrk2.ent b/doc/docbook-xml/ent/isogrk2.ent deleted file mode 100644 index 8a6b9ce82..000000000 --- a/doc/docbook-xml/ent/isogrk2.ent +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isogrk3.ent b/doc/docbook-xml/ent/isogrk3.ent deleted file mode 100644 index 997f784cd..000000000 --- a/doc/docbook-xml/ent/isogrk3.ent +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isogrk4.ent b/doc/docbook-xml/ent/isogrk4.ent deleted file mode 100644 index bac15bad0..000000000 --- a/doc/docbook-xml/ent/isogrk4.ent +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isolat1.ent b/doc/docbook-xml/ent/isolat1.ent deleted file mode 100644 index 874714fa1..000000000 --- a/doc/docbook-xml/ent/isolat1.ent +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isolat2.ent b/doc/docbook-xml/ent/isolat2.ent deleted file mode 100644 index 437e7303e..000000000 --- a/doc/docbook-xml/ent/isolat2.ent +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isonum.ent b/doc/docbook-xml/ent/isonum.ent deleted file mode 100644 index a0041038d..000000000 --- a/doc/docbook-xml/ent/isonum.ent +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isopub.ent b/doc/docbook-xml/ent/isopub.ent deleted file mode 100644 index a76a8feba..000000000 --- a/doc/docbook-xml/ent/isopub.ent +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/ent/isotech.ent b/doc/docbook-xml/ent/isotech.ent deleted file mode 100644 index 3135e7acb..000000000 --- a/doc/docbook-xml/ent/isotech.ent +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/htmltblx.mod b/doc/docbook-xml/htmltblx.mod deleted file mode 100644 index 8bfbdcf15..000000000 --- a/doc/docbook-xml/htmltblx.mod +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - - - - - - - - - - - -]]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xml/soextblx.dtd b/doc/docbook-xml/soextblx.dtd deleted file mode 100644 index 4a92e1162..000000000 --- a/doc/docbook-xml/soextblx.dtd +++ /dev/null @@ -1,321 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/Makefile.am b/doc/docbook-xsl/Makefile.am deleted file mode 100644 index b55d93f45..000000000 --- a/doc/docbook-xsl/Makefile.am +++ /dev/null @@ -1,4 +0,0 @@ -SUBDIRS = common highlighting html lib manpages profiling - -EXTRA_DIST = \ - VERSION diff --git a/doc/docbook-xsl/VERSION b/doc/docbook-xsl/VERSION deleted file mode 100644 index 014a05167..000000000 --- a/doc/docbook-xsl/VERSION +++ /dev/null @@ -1,90 +0,0 @@ - - - - - -docbook-xsl -1.72.0 -6553 -$Revision$ - - - - - DocBook - XSL Stylesheets - snapshot_6661 - - - - - - -Major feature enhancements - - - - - - http://sourceforge.net/projects/docbook/ - http://prdownloads.sourceforge.net/docbook/{DISTRONAME-VERSION}.tar.gz?download - http://prdownloads.sourceforge.net/docbook/{DISTRONAME-VERSION}.zip?download - http://prdownloads.sourceforge.net/docbook/{DISTRONAME-VERSION}.bz2?download - http://sourceforge.net/project/shownotes.php?release_id={SFRELID} - http://docbook.cvs.sourceforge.net/docbook/ - http://lists.oasis-open.org/archives/docbook-apps/ - This is a bug-fix release with a few feature enhancements. - - - - - - - You must specify the sf-relid as a parameter. - - - - - - - - - - - - - - - - - - : - - - - - - - - - : - - - - - - - - - : - - - - - diff --git a/doc/docbook-xsl/common/Makefile.am b/doc/docbook-xsl/common/Makefile.am deleted file mode 100644 index c62c5c3aa..000000000 --- a/doc/docbook-xsl/common/Makefile.am +++ /dev/null @@ -1,21 +0,0 @@ -EXTRA_DIST = \ - autoidx-kimber.xsl \ - autoidx-kosek.xsl \ - common.xsl \ - en.xml \ - entities.ent \ - gentext.xsl \ - insertfile.xsl \ - l10n.dtd \ - l10n.xml \ - l10n.xsl \ - labels.xsl \ - olink.xsl \ - pi.xsl \ - refentry.xsl \ - stripns.xsl \ - subtitles.xsl \ - table.xsl \ - targetdatabase.dtd \ - targets.xsl \ - titles.xsl diff --git a/doc/docbook-xsl/common/autoidx-kimber.xsl b/doc/docbook-xsl/common/autoidx-kimber.xsl deleted file mode 100644 index a1c4a1bf6..000000000 --- a/doc/docbook-xsl/common/autoidx-kimber.xsl +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - -]> - - - - - - - - - - ERROR: the 'kimber' index method requires the - Saxon version 6 or 8 XSLT processor. - - - 1 - - - - - - - - diff --git a/doc/docbook-xsl/common/autoidx-kosek.xsl b/doc/docbook-xsl/common/autoidx-kosek.xsl deleted file mode 100644 index 6bcad77aa..000000000 --- a/doc/docbook-xsl/common/autoidx-kosek.xsl +++ /dev/null @@ -1,150 +0,0 @@ - - - -]> - - - - - - - - - - ERROR: the 'kosek' index method does not - work with the xsltproc XSLT processor. - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - No " - - " localization of index grouping letters exists - - - . - - - ; using "en". - - - - - - - - - - - - - - - - - - - - - - 0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - No " - - " localization of index grouping letters exists - - - . - - - ; using "en". - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/common/common.xsl b/doc/docbook-xsl/common/common.xsl deleted file mode 100644 index 8edb30d4b..000000000 --- a/doc/docbook-xsl/common/common.xsl +++ /dev/null @@ -1,2094 +0,0 @@ - - - - - - - - -$Id$ - -Walsh -Norman -19992000 -Norman Walsh - - -Common Template Reference - - -Introduction - -This is technical reference documentation for the DocBook XSL -Stylesheets; it documents (some of) the parameters, templates, and -other elements of the stylesheets. - -This is not intended to be user documentation. -It is provided for developers writing customization layers for the -stylesheets, and for anyone who's interested in how it -works. - -Although I am trying to be thorough, this documentation is known -to be incomplete. Don't forget to read the source, too :-) - - - - - - - - - - - - - -Tests if a given node is a component-level element - - -This template returns '1' if the specified node is a component -(Chapter, Appendix, etc.), and '0' otherwise. - - - - -node - -The node which is to be tested. - - - - - - -This template returns '1' if the specified node is a component -(Chapter, Appendix, etc.), and '0' otherwise. - - - - - - - 1 - 0 - - - - - - -Tests if a given node is a section-level element - - -This template returns '1' if the specified node is a section -(Section, Sect1, Sect2, etc.), and '0' otherwise. - - - - -node - -The node which is to be tested. - - - - - - -This template returns '1' if the specified node is a section -(Section, Sect1, Sect2, etc.), and '0' otherwise. - - - - - - - 1 - 0 - - - - - - -Returns the hierarchical level of a section - - -This template calculates the hierarchical level of a section. -The element sect1 is at level 1, sect2 is -at level 2, etc. - -Recursive sections are calculated down to the fifth level. - - - - -node - -The section node for which the level should be calculated. -Defaults to the context node. - - - - - - -The section level, 1, 2, etc. - - - - - - - - 1 - 2 - 3 - 4 - 5 - - - 6 - 5 - 4 - 3 - 2 - 1 - - - - - - - - - - 2 - 3 - 4 - 5 - 5 - - - 5 - 4 - 3 - 2 - - - 1 - - - 1 - - - - -Returns the hierarchical level of a QandASet - - -This template calculates the hierarchical level of a QandASet. - - - - -The level, 1, 2, etc. - - - - - - - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - 1 - 1 - 2 - 3 - - - 5 - 4 - 3 - 2 - 1 - - - - - - - - - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - question - answer - qandadiv - qandaset - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [FAMILY Given] - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -[ -] -{ -} - - -[ -] -... - - - | -4pi - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Selects and processes an appropriate media object from a list - - -This template takes a list of media objects (usually the -children of a mediaobject or inlinemediaobject) and processes -the "right" object. - -This template relies on a template named -"select.mediaobject.index" to determine which object -in the list is appropriate. - -If no acceptable object is located, nothing happens. - - - - -olist - -The node list of potential objects to examine. - - - - - - -Calls <xsl:apply-templates> on the selected object. - - - - - - - - - - - - - - - - - - - - - -Selects the position of the appropriate media object from a list - - -This template takes a list of media objects (usually the -children of a mediaobject or inlinemediaobject) and determines -the "right" object. It returns the position of that object -to be used by the calling template. - -If the parameter use.role.for.mediaobject -is nonzero, then it first checks for an object with -a role attribute of the appropriate value. It takes the first -of those. Otherwise, it takes the first acceptable object -through a recursive pass through the list. - -This template relies on a template named "is.acceptable.mediaobject" -to determine if a given object is an acceptable graphic. The semantics -of media objects is that the first acceptable graphic should be used. - - -If no acceptable object is located, no index is returned. - - - - -olist - -The node list of potential objects to examine. - - -count - -The position in the list currently being considered by the -recursive process. - - - - - - -Returns the position in the original list of the selected object. - - - - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - - 0 - - - - 0 - - - - 1 - - - - 0 - - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Returns '1' if the specified media object is recognized - - -This template examines a media object and returns '1' if the -object is recognized as a graphic. - - - - -object - -The media object to consider. - - - - - - -0 or 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - 1 - 1 - 1 - 0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - . - - - - - - - - - - - - . - - - - - - - - - - - - - - - - -Warn users about references to non-unique IDs - -If passed an ID in linkend, -check.id.unique prints -a warning message to the user if either the ID does not exist or -the ID is not unique. - - - - - - - - - - - - Error: no ID for constraint linkend: - - . - - - - - - - Warning: multiple "IDs" for constraint linkend: - - . - - - - - - -Warn users about incorrectly typed references - -If passed an ID in linkend, -check.idref.targets makes sure that the element -pointed to by the link is one of the elements listed in -element-list and warns the user otherwise. - - - - - - - - - - - - - - Error: linkend ( - - ) points to " - - " not (one of): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unexpected context in procedure.step.numeration: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - - - - 2 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - loweralpha - lowerroman - upperalpha - upperroman - arabic - arabic - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - circle - square - disc - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Print a set of years with collapsed ranges - - -This template prints a list of year elements with consecutive -years printed as a range. In other words: - -1992 -1993 -1994]]> - -is printed 1992-1994, whereas: - -1992 -1994]]> - -is printed 1992, 1994. - -This template assumes that all the year elements contain only -decimal year numbers, that the elements are sorted in increasing -numerical order, that there are no duplicates, and that all the years -are expressed in full century+year -(1999 not 99) notation. - - - - -years - -The initial set of year elements. - - -print.ranges - -If non-zero, multi-year ranges are collapsed. If zero, all years -are printed discretely. - - -single.year.ranges - -If non-zero, two consecutive years will be printed as a range, -otherwise, they will be printed discretely. In other words, a single -year range is 1991-1992 but discretely it's -1991, 1992. - - - - - - -This template returns the formatted list of years. - - - - - - - - - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - , - - - - , - - , - - - - - - - , - - - - - - - - - - - - - - - - -Search in a table for the "best" match for the node - - -This template searches in a table for the value that most-closely -(in the typical best-match sense of XSLT) matches the current (element) -node location. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - / - - - - - - - - - -Converts a string to all uppercase letters - - -Given a string, this template does a language-aware conversion -of that string to all uppercase letters, based on the values of the -lowercase.alpha and -uppercase.alpha gentext keys for the current -locale. It affects only those characters found in the values of -lowercase.alpha and -uppercase.alpha. All other characters are left -unchanged. - - - - -string - -The string to convert to uppercase. - - - - - - - - - - - - - - - - - - - - - - - - -Converts a string to all lowercase letters - - -Given a string, this template does a language-aware conversion -of that string to all lowercase letters, based on the values of the -uppercase.alpha and -lowercase.alpha gentext keys for the current -locale. It affects only those characters found in the values of -uppercase.alpha and -lowercase.alpha. All other characters are left -unchanged. - - - - -string - -The string to convert to lowercase. - - - - - - - - - - - - - - - - - - - - - - - - - Returns localized choice separator - - This template enables auto-generation of an appropriate - localized "choice" separator (for example, "and" or "or") before - the final item in an inline list (though it could also be useful - for generating choice separators for non-inline lists). - - It currently works by evaluating a processing instruction - (PI) of the form <?dbchoice choice="foo"?> : - - - - if the value of the choice - pseudo-attribute is "and" or "or", returns a localized "and" - or "or" - - - otherwise returns the literal value of the - choice pseudo-attribute - - - - The latter is provided only as a temporary workaround because the - locale files do not currently have translations for the word - or. So if you want to generate a a - logical "or" separator in French (for example), you currently need - to do this: - - <?dbchoice choice="ou"?> - - - - The dbchoice processing instruction is - an unfortunate hack; support for it may disappear in the future - (particularly if and when a more appropriate means for marking - up "choice" lists becomes available in DocBook). - - - - - - - - - - choice - - - - - - - - - - - - - - - - - - - - - - Evaluates an info profile - - This function evaluates an "info profile" matching the XPath - expression given by the profile - parameter. It relies on the XSLT evaluate() - extension function. - - The value of the profile parameter - can include the literal string $info. If found - in the value of the profile parameter, the - literal string $info string is replaced with - the value of the info parameter, which - should be a set of *info nodes; the - expression is then evaluated using the XSLT - evaluate() extension function. - - - - - profile - - A string representing an XPath expression - - - - info - - A set of *info nodes - - - - - - - Returns a node (the result of evaluating the - profile parameter) - - - - - - - - - - - - - - - - - -Error: The "info profiling" mechanism currently requires an XSLT -engine that supports the evaluate() XSLT extension function. Your XSLT -engine does not support it. - - - - - - - - - Logs/emits formatted notes and warnings - - - The log.message function is a utility - function for logging/emitting formatted messages â€“ that is, - notes and warnings, along with a given log "level" and an - identifier for the "source" that the message relates to. - - - - - - level - - Text to indicate the message level - (Note or - Warning) - - - - source - - Text to identify source element the - notification/warning relates to - - - - message - - Message to lot/emit - - - - message-width - - Expected maximum message width - - - - - - Outputs a message (generally, to standard error). - - - - - - - 50 - : - - - - - - diff --git a/doc/docbook-xsl/common/en.xml b/doc/docbook-xsl/common/en.xml deleted file mode 100644 index 5ccbcf737..000000000 --- a/doc/docbook-xsl/common/en.xml +++ /dev/null @@ -1,1213 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Symbols -A -a -À -à -à -á - -â -à -ã -Ä -ä -Ã… -Ã¥ -Ä€ -Ä -Ä‚ -ă -Ä„ -Ä… -Ç -ÇŽ -Çž -ÇŸ -Ç  -Ç¡ -Ǻ -Ç» -È€ -È -È‚ -ȃ -Ȧ -ȧ -Ḁ -Ḡ-ẚ -Ạ -ạ -Ả -ả -Ấ -ấ -Ầ -ầ -Ẩ -ẩ -Ẫ -ẫ -Ậ -ậ -Ắ -ắ -Ằ -ằ -Ẳ -ẳ -Ẵ -ẵ -Ặ -ặ -B -b -Æ€ -Æ -É“ -Æ‚ -ƃ -Ḃ -ḃ -Ḅ -ḅ -Ḇ -ḇ -C -c -Ç -ç -Ć -ć -Ĉ -ĉ -ÄŠ -Ä‹ -ÄŒ -Ä -Ƈ -ƈ -É• -Ḉ -ḉ -D -d -ÄŽ -Ä -Ä -Ä‘ -ÆŠ -É— -Æ‹ -ÆŒ -Ç… -Dz -È¡ -É– -Ḋ -ḋ -Ḍ -Ḡ-Ḏ -Ḡ-Ḡ-ḑ -Ḓ -ḓ -E -e -È -è -É -é -Ê -ê -Ë -ë -Ä’ -Ä“ -Ä” -Ä• -Ä– -Ä— -Ę -Ä™ -Äš -Ä› -È„ -È… -Ȇ -ȇ -Ȩ -È© -Ḕ -ḕ -Ḗ -ḗ -Ḙ -ḙ -Ḛ -ḛ -Ḝ -Ḡ-Ẹ -ẹ -Ẻ -ẻ -Ẽ -ẽ -Ế -ế -Ề -á» -Ể -ể -Ễ -á»… -Ệ -ệ -F -f -Æ‘ -Æ’ -Ḟ -ḟ -G -g -Äœ -Ä -Äž -ÄŸ -Ä  -Ä¡ -Ä¢ -Ä£ -Æ“ -É  -Ǥ -Ç¥ -Ǧ -ǧ -Ç´ -ǵ -Ḡ -ḡ -H -h -Ĥ -Ä¥ -Ħ -ħ -Èž -ÈŸ -ɦ -Ḣ -ḣ -Ḥ -ḥ -Ḧ -ḧ -Ḩ -ḩ -Ḫ -ḫ -ẖ -I -i -ÃŒ -ì -à -í -ÃŽ -î -à -ï -Ĩ -Ä© -Ī -Ä« -Ĭ -Ä­ -Ä® -į -Ä° -Æ— -ɨ -Ç -Ç -Ȉ -ȉ -ÈŠ -È‹ -Ḭ -ḭ -Ḯ -ḯ -Ỉ -ỉ -Ị -ị -J -j -Ä´ -ĵ -Ç° -Ê -K -k -Ķ -Ä· -Ƙ -Æ™ -Ǩ -Ç© -Ḱ -ḱ -Ḳ -ḳ -Ḵ -ḵ -L -l -Ĺ -ĺ -Ä» -ļ -Ľ -ľ -Ä¿ -Å€ -Å -Å‚ -Æš -Lj -È´ -É« -ɬ -É­ -Ḷ -ḷ -Ḹ -ḹ -Ḻ -ḻ -Ḽ -ḽ -M -m -ɱ -Ḿ -ḿ -á¹€ -á¹ -Ṃ -ṃ -N -n -Ñ -ñ -Ń -Å„ -Å… -ņ -Ň -ň -Æ -ɲ -Æž -È  -Ç‹ -Ǹ -ǹ -ȵ -ɳ -Ṅ -á¹… -Ṇ -ṇ -Ṉ -ṉ -Ṋ -ṋ -O -o -Ã’ -ò -Ó -ó -Ô -ô -Õ -õ -Ö -ö -Ø -ø -ÅŒ -Å -ÅŽ -Å -Å -Å‘ -ÆŸ -Æ  -Æ¡ -Ç‘ -Ç’ -Ǫ -Ç« -Ǭ -Ç­ -Ǿ -Ç¿ -ÈŒ -È -ÈŽ -È -Ȫ -È« -Ȭ -È­ -È® -ȯ -È° -ȱ -Ṍ -á¹ -Ṏ -á¹ -á¹ -ṑ -á¹’ -ṓ -Ọ -á» -Ỏ -á» -á» -ố -á»’ -ồ -á»” -ổ -á»– -á»— -Ộ -á»™ -Ớ -á»› -Ờ -á» -Ở -ở -á»  -ỡ -Ợ -ợ -P -p -Ƥ -Æ¥ -á¹” -ṕ -á¹– -á¹— -Q -q -Ê  -R -r -Å” -Å• -Å– -Å— -Ř -Å™ -È -È‘ -È’ -È“ -ɼ -ɽ -ɾ -Ṙ -á¹™ -Ṛ -á¹› -Ṝ -á¹ -Ṟ -ṟ -S -s -Åš -Å› -Åœ -Å -Åž -ÅŸ -Å  -Å¡ -Ș -È™ -Ê‚ -á¹  -ṡ -á¹¢ -á¹£ -Ṥ -á¹¥ -Ṧ -ṧ -Ṩ -ṩ -T -t -Å¢ -Å£ -Ť -Å¥ -Ŧ -ŧ -Æ« -Ƭ -Æ­ -Æ® -ʈ -Èš -È› -ȶ -Ṫ -ṫ -Ṭ -á¹­ -á¹® -ṯ -á¹° -á¹± -ẗ -U -u -Ù -ù -Ú -ú -Û -û -Ãœ -ü -Ũ -Å© -Ū -Å« -Ŭ -Å­ -Å® -ů -Å° -ű -Ų -ų -Ư -Æ° -Ç“ -Ç” -Ç• -Ç– -Ç— -ǘ -Ç™ -Çš -Ç› -Çœ -È” -È• -È– -È— -á¹² -á¹³ -á¹´ -á¹µ -Ṷ -á¹· -Ṹ -á¹¹ -Ṻ -á¹» -Ụ -ụ -Ủ -ủ -Ứ -ứ -Ừ -ừ -Ử -á»­ -á»® -ữ -á»° -á»± -V -v -Ʋ -Ê‹ -á¹¼ -á¹½ -á¹¾ -ṿ -W -w -Å´ -ŵ -Ẁ -Ạ-Ẃ -ẃ -Ẅ -ẅ -Ẇ -ẇ -Ẉ -ẉ -ẘ -X -x -Ẋ -ẋ -Ẍ -Ạ-Y -y -à -ý -ÿ -Ÿ -Ŷ -Å· -Ƴ -Æ´ -Ȳ -ȳ -Ẏ -Ạ-ẙ -Ỳ -ỳ -á»´ -ỵ -Ỷ -á»· -Ỹ -ỹ -Z -z -Ź -ź -Å» -ż -Ž -ž -Ƶ -ƶ -Ȥ -È¥ -Ê -Ê‘ -Ạ-ẑ -Ẓ -ẓ -Ẕ -ẕ - - \ No newline at end of file diff --git a/doc/docbook-xsl/common/entities.ent b/doc/docbook-xsl/common/entities.ent deleted file mode 100644 index c0f65377c..000000000 --- a/doc/docbook-xsl/common/entities.ent +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/common/gentext.xsl b/doc/docbook-xsl/common/gentext.xsl deleted file mode 100644 index b134fe6e1..000000000 --- a/doc/docbook-xsl/common/gentext.xsl +++ /dev/null @@ -1,831 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .formal - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - object.xref.markup: empty xref template - for linkend=" - - " and @xrefstyle=" - - " - - - - - - - - - - - - - - - - - - - - - - - - - - - Xref is only supported to listitems in an - orderedlist: - - - ??? - - - - - - - - - - - - - - - - - - - - - - - - %n - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - - - - - - Attempt to use %d in gentext with no referrer! - - - - - - - % - - - % - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - labelnumber - - - labelname - - - label - - - - - - - - quotedtitle - - - title - - - - - - - - - - - - - - nopage - - - pagenumber - - - pageabbrev - - - Page - - - page - - - - - - - - - - - nodocname - - - docnamelong - - - docname - - - - - - - - - - - - - - - - - - - - - - %n - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - %t - - - - - - %t - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - %p - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/common/insertfile.xsl b/doc/docbook-xsl/common/insertfile.xsl deleted file mode 100644 index c4e2d0d44..000000000 --- a/doc/docbook-xsl/common/insertfile.xsl +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/common/l10n.dtd b/doc/docbook-xsl/common/l10n.dtd deleted file mode 100644 index 1d6f8361e..000000000 --- a/doc/docbook-xsl/common/l10n.dtd +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/common/l10n.xml b/doc/docbook-xsl/common/l10n.xml deleted file mode 100644 index 3e67fe588..000000000 --- a/doc/docbook-xsl/common/l10n.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - - - - - - - ---> - - -]> - - -&en; - - diff --git a/doc/docbook-xsl/common/l10n.xsl b/doc/docbook-xsl/common/l10n.xsl deleted file mode 100644 index 29e9e33af..000000000 --- a/doc/docbook-xsl/common/l10n.xsl +++ /dev/null @@ -1,441 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - _ - - - - - - - - - - - - - - - - - - - - No localization exists for " - - " or " - - ". Using default " - - ". - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - No " - - " localization of " - - " exists - - - . - - - ; using "en". - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - bullet - - - - - - - - - - - - - - - - - - No " - - " localization of dingbat - - exists; using "en". - - - - - - - - - - startquote - - - - - - endquote - - - - - - nestedstartquote - - - - - - nestedendquote - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - No " - - " localization exists. - - - - - - - - - - No context named " - - " exists in the " - - " localization. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - No template for " - - " (or any of its leaves) exists -in the context named " - - " in the " - - " localization. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - 0 - - - - - diff --git a/doc/docbook-xsl/common/labels.xsl b/doc/docbook-xsl/common/labels.xsl deleted file mode 100644 index cbede124c..000000000 --- a/doc/docbook-xsl/common/labels.xsl +++ /dev/null @@ -1,850 +0,0 @@ - - - - - - - - - - -Provides access to element labels - -Processing an element in the -label.markup mode produces the -element label. -Trailing punctuation is not added to the label. - - - - - - . - - - - - - - Request for label of unexpected element: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - label.markup: this can't happen! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - a - i - A - I - - - - Unexpected numeration: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - - - - -Returns true if $section should be labelled - -Returns true if the specified section should be labelled. -By default, this template returns zero unless -the section level is less than or equal to the value of the -$section.autolabel.max.depth parameter, in -which case it returns -$section.autolabel. -Custom stylesheets may override it to get more selective behavior. - - - - - - - - - - - - - - - 1 - - - - - - - - - - - 1 - - - - - - - - - - - - - - - - - - Unexpected .autolabel value: - ; using default. - - - - - - - - - -Returns format for autolabel parameters - -Returns format passed as parameter if non zero. Supported - format are 'arabic' or '1', 'loweralpha' or 'a', 'lowerroman' or 'i', - 'upperlapha' or 'A', 'upperroman' or 'I', 'arabicindic' or '١'. - If its not one of these then - returns the default format. - - - - - - diff --git a/doc/docbook-xsl/common/olink.xsl b/doc/docbook-xsl/common/olink.xsl deleted file mode 100644 index 91849263a..000000000 --- a/doc/docbook-xsl/common/olink.xsl +++ /dev/null @@ -1,1149 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Olinks not processed: must specify a - $target.database.document parameter - when using olinks with targetdoc - and targetptr attributes. - - - - - - Olink error: could not open target database ' - - '. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Olink debug: cases for targetdoc=' - - ' and targetptr=' - - ' in language ' - - '. - - - - - - - - - - - - - - Olink debug: CaseA matched. - - - - Olink debug: CaseA NOT matched - - - - - - - - - - - - - - - - Olink debug: CaseB matched. - - - - Olink debug: CaseB NOT matched - - - - - - - - - - - - - - - - - Olink debug: CaseC matched. - - - - Olink debug: CaseC NOT matched. - - - - - - - - - - - - - - - - - Olink debug: CaseD matched. - - - - Olink debug: CaseD NOT matched - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Olink debug: CaseE matched. - - - - Olink debug: CaseE NOT matched. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Olink debug: CaseF matched. - - - - Olink debug: CaseF NOT matched. - - - - - - - - - - - - - - Olink debug: CaseB key is the final selection: - - - - - - - - - Olink debug: CaseA key is the final selection: - - - - - - - - - Olink debug: CaseC key is the final selection: - - - - - - - - - Olink debug: CaseD key is the final selection: - - - - - - - - - Olink debug: CaseF key is the final selection: - - - - - - - - - Olink debug: CaseE key is the final selection: - - - - - - - - Olink debug: No case matched for lang ' - - '. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - 0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Olink error: cannot compute relative - sitemap path because $current.docid ' - - ' not found in target database. - - - - - - - Olink warning: cannot compute relative - sitemap path without $current.docid parameter - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - xrefstyle is ' - - '. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Olink error: no gentext template - exists for xrefstyle ' - - ' for element ' - - ' in language ' - - ' in context 'xref-number-and-title - '. Using template without @style. - - - - - - - - Olink error: no gentext template - exists for xrefstyle ' - - ' for element ' - - ' in language ' - - ' in context 'xref-number - '. Using template without @style. - - - - - - - - Olink error: no gentext template - exists for xrefstyle ' - - ' for element ' - - ' in language ' - - ' in context 'xref - '. Using template without @style. - - - - - - Olink error: no gentext template - exists for xrefstyle ' - - ' for element ' - - ' in language ' - - '. Trying '%t'. - - - - - - - - - - - Olink debug: xrefstyle template is ' - - '. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Olink error: no generated text for - targetdoc/targetptr/lang = ' - - '. - - ???? - - - - - - - Olink error: no generated text for - targetdoc/targetptr/lang = ' - - '. - - - ???? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Olink error: cannot locate targetdoc in sitemap - - - - - - - / - - - - - - - - - - - ../ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/common/pi.xsl b/doc/docbook-xsl/common/pi.xsl deleted file mode 100644 index 4022e8e62..000000000 --- a/doc/docbook-xsl/common/pi.xsl +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - - - - - - - - - - - format - - - - - - - - - - - - - - - - - - - - padding - - - - - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - Timestamp processing requires XSLT processor with EXSLT date support. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - - - - 0 - - - - - - - 0 - - - - 0 - - - - 0 - - - - - - - - - - - - - - - - - - - - - - - - - - - Timestamp processing requires an XSLT processor with support - for the EXSLT node-set() function. - - - - - - - - diff --git a/doc/docbook-xsl/common/refentry.xsl b/doc/docbook-xsl/common/refentry.xsl deleted file mode 100644 index bbe5d7265..000000000 --- a/doc/docbook-xsl/common/refentry.xsl +++ /dev/null @@ -1,1277 +0,0 @@ - - - - - - - - - - - $Id$ - - The DocBook Project - - 2005-2007 - The DocBook Project - - - Refentry Metadata-Gathering Template Reference - - - Introduction - - This is technical reference documentation for the "refentry - metadata gathering" templates in the DocBook XSL Stylesheets. - - This is not intended to be user documentation. It is provided - for developers writing customization layers for the - stylesheets. - - - Currently, only the manpages stylesheets make use of these - templates. They are, however, potentially useful elsewhere. - - - - - - - - - - Gathers metadata from a refentry and its ancestors - - - Reference documentation for particular commands, functions, - etc., is sometimes viewed in isolation from its greater "context". For - example, users view Unix man pages as, well, individual pages, not as - part of a "book" of some kind. Therefore, it is sometimes necessary to - embed "context" information in output for each refentry. - - However, one problem is that different users mark up that - context information in different ways. Often (usually), the - context information is not actually part of the content of the - refentry itself, but instead part of the content of a - parent or ancestor element to the the refentry. And - even then, DocBook provides a variety of elements that users might - potentially use to mark up the same kind of information. One user - might use the productnumber element to mark up version - information about a particular product, while another might use - the releaseinfo element. - - Taking all that in mind, the - get.refentry.metadata function tries to gather - metadata from a refentry element and its ancestor - elements in an intelligent and user-configurable way. The basic - mechanism used in the XPath expressions throughout this stylesheet - is to select the relevant metadata from the *info element that is - closest to the actual refentry â€“ either on the - refentry itself, or on its nearest ancestor. - - - The get.refentry.metadata function is - actually just sort of a "driver" function; it calls other - functions that do the actual data collection, then returns the - data as a set. - - - - - - - - refname - - The first refname in the refentry - - - - info - - A set of info nodes (from a refentry - element and its ancestors) - - - - prefs - - A node containing user preferences (from global - stylesheet parameters) - - - - - - - Returns a node set with the following elements. The - descriptions are verbatim from the man(7) man - page. - - - title - - the title of the man page (e.g., MAN) - - - - section - - the section number the man page should be placed in (e.g., - 7) - - - - date - - the date of the last revision - - - - source - - the source of the command - - - - manual - - the title of the manual (e.g., Linux - Programmer's Manual) - - - - - - - - - - - - - <xsl:call-template name="get.refentry.title"> - <xsl:with-param name="refname" select="$refname"/> - </xsl:call-template> - -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - Gets title metadata for a refentry - - - The man(7) man page describes this as "the - title of the man page (e.g., MAN). This differs - from refname in that, if the refentry has a - refentrytitle, we use that as the title; - otherwise, we just use first refname in the first - refnamediv in the source. - - - - - - refname - - The first refname in the refentry - - - - - - - Returns a title node. - - - - - - - - - - - - - - - - - - - - Gets section metadata for a refentry - - - The man(7) man page describes this as "the - section number the man page should be placed in (e.g., - 7)". If we do not find a manvolnum - specified in the source, and we find that the refentry is - for a function, we use the section number 3 - ["Library calls (functions within program libraries)"]; otherwise, we - default to using 1 ["Executable programs or shell - commands"]. - - - - - - refname - - The first refname in the refentry - - - - quiet - - If non-zero, no "missing" message is emitted - - - - - - - Returns a string representing a section number. - - - - - - - - - - - - - Note - - meta manvol : No manvolnum - - - - - - - - - Note - - meta manvol : Setting man section to 3 - - - - 3 - - - 1 - - - - - - - - - - Gets date metadata for a refentry - - - The man(7) man page describes this as "the - date of the last revision". If we cannot find a date in the source, we - generate one. - - - - - - refname - - The first refname in the refentry - - - - info - - A set of info nodes (from a refentry - element and its ancestors) - - - - prefs - - A node containing users preferences (from global stylesheet parameters) - - - - - - Returns a date node. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Note - - meta date : No date. Using generated date - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets source metadata for a refentry - - - The man(7) man page describes this as "the - source of the command", and provides the following examples: - - - For binaries, use something like: GNU, NET-2, SLS - Distribution, MCC Distribution. - - - For system calls, use the version of the kernel that you are - currently looking at: Linux 0.99.11. - - - For library calls, use the source of the function: GNU, BSD - 4.3, Linux DLL 4.4.1. - - - - - The solbook(5) man page describes - something very much like what man(7) calls - "source", except that solbook(5) names it - "software" and describes it like this: -
- This is the name of the software product that the topic - discussed on the reference page belongs to. For example UNIX - commands are part of the SunOS x.x - release. -
- - - In practice, there are many pages that simply have a version - number in the "source" field. So, it looks like what we have is a - two-part field, - Name Version, - where: - - - Name - - product name (e.g., BSD) or org. name (e.g., GNU) - - - - Version - - version name - - - - Each part is optional. If the Name is a - product name, then the Version is probably - the version of the product. Or there may be no - Name, in which case, if there is a - Version, it is probably the version of the - item itself, not the product it is part of. Or, if the - Name is an organization name, then there - probably will be no Version. - - - - - - - refname - - The first refname in the refentry - - - - info - - A set of info nodes (from a refentry - element and its ancestors) - - - - prefs - - A node containing users preferences (from global - stylesheet parameters) - - - - - - Returns a source node. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Warn - - meta source : No valid fallback. Leaving empty - - - - - - - - - Warn - - meta source : No fallback specified; leaving empty. - - - - - - - - - - Gets source-name metadata for a refentry - - - A "source name" is one part of a (potentially) two-part - Name Version - source field. For more details, see the documentation for the - get.refentry.source template. - - - - - - refname - - The first refname in the refentry - - - - info - - A set of info nodes (from a refentry - element and its ancestors) - - - - prefs - - A node containing users preferences (from global - stylesheet parameters) - - - - - - Depending on what output method is used for the - current stylesheet, either returns a text node or possibly an element - node, containing "source name" data. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - source - - - - - - - - source - productname - - - - - - - - source - productname - - - - - - - - source - productname - - - - - - - - source - productname - - - - - - - - source - productname - - - - - - Note - - meta source : No productname or alternative - - - Note - - meta source : No refmiscinfo@class=source - - - - - - - - - - - - - - Gets version metadata for a refentry - - - A "version" is one part of a (potentially) two-part - Name Version - source field. For more details, see the documentation for the - get.refentry.source template. - - - - - - refname - - The first refname in the refentry - - - - info - - A set of info nodes (from a refentry - element and its ancestors) - - - - prefs - - A node containing users preferences (from global - stylesheet parameters) - - - - - - Depending on what output method is used for the - current stylesheet, either returns a text node or possibly an element - node, containing "version" data. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - version - - - - - - - - version - productnumber - - - - - - - - version - productnumber - - - - - - Note - - meta version: No productnumber or alternative - - - Note - - meta version: No refmiscinfo@class=version - - - - - - - - - - - - - - Gets source metadata for a refentry - - - The man(7) man page describes this as "the - title of the manual (e.g., Linux Programmer's - Manual)". Here are some examples from existing man pages: - - - dpkg utilities - (dpkg-name) - - - User Contributed Perl Documentation - (GET) - - - GNU Development Tools - (ld) - - - Emperor Norton Utilities - (ddate) - - - Debian GNU/Linux manual - (faked) - - - GIMP Manual Pages - (gimp) - - - KDOC Documentation System - (qt2kdoc) - - - - - The solbook(5) man page describes - something very much like what man(7) calls - "manual", except that solbook(5) names it - "sectdesc" and describes it like this: -
- This is the section title of the reference page; for - example User Commands. -
- - - - - - - - refname - - The first refname in the refentry - - - - info - - A set of info nodes (from a refentry - element and its ancestors) - - - - prefs - - A node containing users preferences (from global - stylesheet parameters) - - - - - - Returns a manual node. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - manual - - - - - - - - manual - - - - - - Note - - meta manual : No ancestor with title - - - Note - - meta manual : No refmiscinfo@class=manual - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Warn - - meta manual : No valid fallback. Leaving empty - - - - - - - - - - Warn - - meta manual : No fallback specified; leaving empty. - - - - - - - - - - Gets user preferences for refentry metadata gathering - - - The DocBook XSL stylesheets include several user-configurable - global stylesheet parameters for controlling refentry - metadata gathering. Those parameters are not read directly by the - other refentry metadata-gathering functions. Instead, they - are read only by the get.refentry.metadata.prefs - function, which assembles them into a structure that is then passed to - the other refentry metadata-gathering functions. - - So the, get.refentry.metadata.prefs - function is the only interface to collecting stylesheet parameters for - controlling refentry metadata gathering. - - - - There are no local parameters for this function; however, it - does rely on a number of global parameters. - - - Returns a manual node. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Sets content of a refentry metadata item - - - The set.refentry.metadata function is - called each time a suitable source element is found for a certain - metadata field. - - - - - - refname - - The first refname in the refentry - - - - info - - A single *info node that contains the selected source element. - - - - contents - - A node containing the selected source element. - - - - context - - A string describing the metadata context in which the - set.refentry.metadata function was - called: either "date", "source", "version", or "manual". - - - - - - Returns formatted contents of a selected source element. - - - - - - - - - - - - Note - - meta - - - : No - - - Note - - meta - - - : No refmiscinfo@class= - - - Note - - meta - - - : Using - - - - - - - diff --git a/doc/docbook-xsl/common/stripns.xsl b/doc/docbook-xsl/common/stripns.xsl deleted file mode 100644 index 18d18441a..000000000 --- a/doc/docbook-xsl/common/stripns.xsl +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - info - - - objectinfo - - blockinfo - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WARNING: cannot add @xml:base to node - set root element. - Relative paths may not work. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - / - - - - - - - - - - - - - - Stripping namespace from DocBook 5 document. - - - - Processing stripped document. - - - - - - - - - diff --git a/doc/docbook-xsl/common/subtitles.xsl b/doc/docbook-xsl/common/subtitles.xsl deleted file mode 100644 index 8d5d4b36d..000000000 --- a/doc/docbook-xsl/common/subtitles.xsl +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - - - - -Provides access to element subtitles - -Processing an element in the -subtitle.markup mode produces the -subtitle of the element. - - - - - - - Request for subtitle of unexpected element: - - - ???SUBTITLE??? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/common/table.xsl b/doc/docbook-xsl/common/table.xsl deleted file mode 100644 index a6ee83a75..000000000 --- a/doc/docbook-xsl/common/table.xsl +++ /dev/null @@ -1,514 +0,0 @@ - - - - - - - - - - - 0: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0: - - - : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - - - - -Determine the column number in which a given entry occurs - -If an entry has a -colname or -namest attribute, this template -will determine the number of the column in which the entry should occur. -For other entrys, nothing is returned. - - - -entry - -The entry-element which is to be tested. - - - - - - -This template returns the column number if it can be determined, -or 0 (the empty string) - - - - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/common/targetdatabase.dtd b/doc/docbook-xsl/common/targetdatabase.dtd deleted file mode 100644 index 2ace1e003..000000000 --- a/doc/docbook-xsl/common/targetdatabase.dtd +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/common/targets.xsl b/doc/docbook-xsl/common/targets.xsl deleted file mode 100644 index 91cf93962..000000000 --- a/doc/docbook-xsl/common/targets.xsl +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - - - - - -Collects information for potential cross reference targets - -Processing the root element in the -collect.targets mode produces -a set of target database elements that can be used by -the olink mechanism to resolve external cross references. -The collection process is controlled by the -collect.xref.targets parameter, which can be -yes to collect targets and process -the document for output, only to -only collect the targets, and no -(default) to not collect the targets and only process the document. - - -A targets.filename parameter must be -specified to receive the output if -collect.xref.targets is -set to yes so as to -redirect the target data to a file separate from the -document output. - - - - - - - - - - - Must specify a $targets.filename parameter when - $collect.xref.targets is set to 'yes'. - The xref targets were not collected. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/common/titles.xsl b/doc/docbook-xsl/common/titles.xsl deleted file mode 100644 index af1e15ebf..000000000 --- a/doc/docbook-xsl/common/titles.xsl +++ /dev/null @@ -1,740 +0,0 @@ - - - - - - - - - - -Provides access to element titles - -Processing an element in the -title.markup mode produces the -title of the element. This does not include the label. - - - - - - - - - - - - - - - - - - - - - - - Request for title of element with no title: - - - - (id=" - - ") - - - (xml:id=" - - ") - - - - - ???TITLE??? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - REFENTRY WITHOUT TITLE??? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ERROR: glossdiv missing its required title - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Note - Important - Caution - Warning - Tip - - - - - - - - - - Question - - - - - Answer - - - - - Question - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - XRef to nonexistent id: - - - ??? - - - - - - - - - - Endterm points to nonexistent ID: - - - ??? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/highlighting/Makefile.am b/doc/docbook-xsl/highlighting/Makefile.am deleted file mode 100644 index 50532d1a5..000000000 --- a/doc/docbook-xsl/highlighting/Makefile.am +++ /dev/null @@ -1,2 +0,0 @@ -EXTRA_DIST = \ - common.xsl diff --git a/doc/docbook-xsl/highlighting/common.xsl b/doc/docbook-xsl/highlighting/common.xsl deleted file mode 100644 index e15c66035..000000000 --- a/doc/docbook-xsl/highlighting/common.xsl +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/Makefile.am b/doc/docbook-xsl/html/Makefile.am deleted file mode 100644 index 016b8b45f..000000000 --- a/doc/docbook-xsl/html/Makefile.am +++ /dev/null @@ -1,42 +0,0 @@ -EXTRA_DIST = \ - admon.xsl \ - annotations.xsl \ - autoidx.xsl \ - autotoc.xsl \ - biblio-iso690.xsl \ - biblio.xsl \ - block.xsl \ - callout.xsl \ - chunker.xsl \ - component.xsl \ - division.xsl \ - docbook.xsl \ - ebnf.xsl \ - footnote.xsl \ - formal.xsl \ - glossary.xsl \ - graphics.xsl \ - highlight.xsl \ - html-rtf.xsl \ - html.xsl \ - htmltbl.xsl \ - index.xsl \ - info.xsl \ - inline.xsl \ - keywords.xsl \ - lists.xsl \ - manifest.xsl \ - math.xsl \ - param.xsl \ - pi.xsl \ - qandaset.xsl \ - refentry.xsl \ - sections.xsl \ - synop.xsl \ - table.xsl \ - task.xsl \ - titlepage.templates.xsl \ - titlepage.xsl \ - toc.xsl \ - verbatim.xsl \ - xref.xsl diff --git a/doc/docbook-xsl/html/admon.xsl b/doc/docbook-xsl/html/admon.xsl deleted file mode 100644 index a72c783ca..000000000 --- a/doc/docbook-xsl/html/admon.xsl +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - 25 - - - - - - - - - - - - - - - - - - note - warning - caution - tip - important - note - - - - - - - - Note - Warning - Caution - Tip - Important - Note - - - - - - - - - -
- - - - - - - - - - - - : - - - - - - - - - - -
- - - - [{$alt}] - - - - - - - - - -
- -
-
- - - -
- - - - - - - -

- - - - -

- - -
- - - - - - - - - diff --git a/doc/docbook-xsl/html/annotations.xsl b/doc/docbook-xsl/html/annotations.xsl deleted file mode 100644 index f0106320a..000000000 --- a/doc/docbook-xsl/html/annotations.xsl +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Stripping namespace from DocBook 5 document. - - - - - Processing stripped document. - - - - - - Unable to strip the namespace from DB5 document, - cannot proceed. - - - - - - - - - ID ' - - ' not found in document. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - - - - - diff --git a/doc/docbook-xsl/html/ebnf.xsl b/doc/docbook-xsl/html/ebnf.xsl deleted file mode 100644 index 990632141..000000000 --- a/doc/docbook-xsl/html/ebnf.xsl +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - - -$Id$ - -Walsh -Norman -19992000 -Norman Walsh - - -HTML EBNF Reference - - -
Introduction - -This is technical reference documentation for the DocBook XSL -Stylesheets; it documents (some of) the parameters, templates, and -other elements of the stylesheets. - -This reference describes the templates and parameters relevant -to formatting EBNF markup. - -This is not intended to be user documentation. -It is provided for developers writing customization layers for the -stylesheets, and for anyone who's interested in how it -works. - -Although I am trying to be thorough, this documentation is known -to be incomplete. Don't forget to read the source, too :-) -
- - - - - - - - - - - - - - 1 - - - - - - EBNF - - for - - - - - - - - - - - - -
- - -
- - - - - - - - - - EBNF productions - -
-
- - - - - - - - - - - [ - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - Error: no ID for productionrecap linkend: - - . - - - - - - Warning: multiple "IDs" for productionrecap linkend: - - . - - - - - - - - - - - - - - - - | -
- - - - - - - - - - - - - - - - - production - - - - - - - - - Non-terminals with no content must point to - production elements in the current document. - - - Invalid xpointer for empty nt: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ??? - - - - - - - - - - - - - /*  - -  */ -
- - - - - - - - - - constraintdef - - - - - - - - - - - [  - - - - - : - - - - - - - : - - - - - - - - - -  ] - -
- - - - -
- - - -
- - - -

- - - - - diff --git a/doc/docbook-xsl/html/footnote.xsl b/doc/docbook-xsl/html/footnote.xsl deleted file mode 100644 index a8286805f..000000000 --- a/doc/docbook-xsl/html/footnote.xsl +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - - - #ftn. - - - - - - - [ - - - - - ] - - - - - [ - - - - - ] - - - - - - - - - - #ftn. - - - - - - [ - - - - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ftn. - - - - - - # - - - - -

- - - - - - - [ - - - - - ] - - -

- - - - - - - ftn. - - - - - - # - - - - - - - [ - - - - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
- - - -
-
-

The following annotations are from this essay. You are seeing - them here because your browser doesn’t support the user-interface - techniques used to make them appear as ‘popups’ on modern browsers.

-
- - -
- - - - - - - - - - -
- - -
- - - -
- - - -
- - - - - Warning: footnote number may not be generated - correctly; - - unexpected as first child of footnote. - -
- - -
- - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/formal.xsl b/doc/docbook-xsl/html/formal.xsl deleted file mode 100644 index 516dcdb13..000000000 --- a/doc/docbook-xsl/html/formal.xsl +++ /dev/null @@ -1,398 +0,0 @@ - - - - - -1 - - - - - - - - -
- - - - - - - -
- -
- - - - - -

- - -

-

- - - - - - - - -
- -
- - - - - - - - - - - -float - - - - - - - - - - - - - - - - - - - -

- - - -

- - - - - - -
-

- - - - - - - - -

-

- - - - - - - - - - -float - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - before - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Broken table: tr descendent of CALS Table. - - - - - - - - - - before - - - - - - - - - - - - - - - - - - - - - - - - - Broken table: row descendent of HTML table. - - - - - - - - - - - - - - before - - - - - - - - - - - - - - - - - - - - - before - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - float: - - ; - - - -
- - - diff --git a/doc/docbook-xsl/html/glossary.xsl b/doc/docbook-xsl/html/glossary.xsl deleted file mode 100644 index f1ec41e05..000000000 --- a/doc/docbook-xsl/html/glossary.xsl +++ /dev/null @@ -1,474 +0,0 @@ - - -%common.entities; -]> - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - -
- - - - - - - - - - - -
- - - - - -
- - - - - - - - - - -
-
- - - - - - - -
- - - -
- - - - - - - - - - -
-
- - - -

- - -

- - - - - - - - - -
- - - - 0 - 1 - - - - - - - - ( - - ) - - - - - -
- - -
- - - - 0 - 1 - - - - - - - - ( - - ) - -
- - -
- - - - 0 - 1 - - - - - -
- - - - - - - - - , - - - - - , - - - - - , - - - - - - - - - - -
-

- - - - - - - - - - - - - - - - - - - - - - - Warning: glosssee @otherterm reference not found: - - - - - - - - - - - - - - - . -

-
- - - -
- - -

- - - - - - - - - - - - - -

- -
- - - - - - - - - - - - - - - - - - - - - - Warning: glossseealso @otherterm reference not found: - - - - - - - - - - - - . - - - , - - - - - - - - - - - - - - - - - Warning: processing automatic glossary - without a glossary.collection file. - - - - - - Warning: processing automatic glossary but unable to - open glossary.collection file ' - - ' - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - -
- - - - - - - - - - -
- - - -
- - - - - - - - - - - - - - - - - - - -
-
- - - - - diff --git a/doc/docbook-xsl/html/graphics.xsl b/doc/docbook-xsl/html/graphics.xsl deleted file mode 100644 index 49d481df5..000000000 --- a/doc/docbook-xsl/html/graphics.xsl +++ /dev/null @@ -1,1475 +0,0 @@ - - - - - - - - - - - - - - 1 - - - - - - 1 - - - - - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - 0 - 0 - - 1 - 0 - - - - - - 1.0 - 1.0 - - - - 1.0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - px - - - - - - - - - - - px - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - px - - - - - - - - - - - px - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - 0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - middle - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Warning: imagemaps not supported - on scaled images - - - - 0 - - - - - - - - - - - - - - - - - - - - middle - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - height: - - px - - - - - - - - - - - -
- - - - - background-color: - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - calspair - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - , - - , - - , - - - - - - - - - - - - Warning: only calspair or - otherunits='imagemap' supported - in imageobjectco - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - middle - - - - - - - - - - - - - - - - - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - No insertfile extension available. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - No insertfile extension available. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - [ - D - ] - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - No insertfile extension available. - - - - - - - - - - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/highlight.xsl b/doc/docbook-xsl/html/highlight.xsl deleted file mode 100644 index 960f17c41..000000000 --- a/doc/docbook-xsl/html/highlight.xsl +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/html-rtf.xsl b/doc/docbook-xsl/html/html-rtf.xsl deleted file mode 100644 index 5b30c7025..000000000 --- a/doc/docbook-xsl/html/html-rtf.xsl +++ /dev/null @@ -1,336 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/html.xsl b/doc/docbook-xsl/html/html.xsl deleted file mode 100644 index 18c9735a8..000000000 --- a/doc/docbook-xsl/html/html.xsl +++ /dev/null @@ -1,241 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - # - - - - - - - - - - - - - - - - - - - bullet - - - - - - - - - bullet - - • - © - ™ - ™ - ® - (SM) -   - “ - ” - ‘ - ’ - — - — - – - – - - • - - - - - - - - - - - - - - - - - - - - - - - - - ID recommended on - - - : - - - - ... - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/htmltbl.xsl b/doc/docbook-xsl/html/htmltbl.xsl deleted file mode 100644 index feb79fa6f..000000000 --- a/doc/docbook-xsl/html/htmltbl.xsl +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/index.xsl b/doc/docbook-xsl/html/index.xsl deleted file mode 100644 index a91984019..000000000 --- a/doc/docbook-xsl/html/index.xsl +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - -
- - - - - - - - - -
- -
-
- - - -

- - -

- - - - - - - - - - - - - - - - - - - - - - - -
- -
- - -
-
- -
-
- - -
-
- -
-
- - - - - -
- -
- - -
-
- -
-
- - -
-
- -
-
- - - - - -
- -
- -
-
- -
-
- - - - -
- -
- - - diff --git a/doc/docbook-xsl/html/info.xsl b/doc/docbook-xsl/html/info.xsl deleted file mode 100644 index e97b66582..000000000 --- a/doc/docbook-xsl/html/info.xsl +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/inline.xsl b/doc/docbook-xsl/html/inline.xsl deleted file mode 100644 index a917165ac..000000000 --- a/doc/docbook-xsl/html/inline.xsl +++ /dev/null @@ -1,1421 +0,0 @@ - - -]> - - - - - - - - - - - - - - - - - - - - - - 1 - 0 - - - - - - - - - - - - - - - - - - - - - - - XLink to nonexistent id: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - span - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( - - ) - - - - - - - - - - - , - - - - - - - , - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - abbr - - - - - - acronym - - - - - - - - - - - - - - - - - - - - - - - - - - http://example.com/cgi-bin/man.cgi? - - ( - - ) - - - - - - - - - - - - - - - - - - - - - - - - - - emphasis - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - SM - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Warning: glossary.collection specified, but there are - - automatic glossaries - - - - - - - - - - - - - - - - - - - - - - - - There's no entry for - - in - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Error: no glossentry for glossterm: - - . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - element - - - - - - - - - - - - - - - - </ - - > - - - & - - ; - - - &# - - ; - - - % - - ; - - - <? - - > - - - <? - - ?> - - - < - - > - - - < - - /> - - - <!-- - - --> - - - - - - - - - - - - - - - - - - - - - - - < - - - - - mailto: - - - - - - > - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( - - ) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [ - - - - - - - - - - - ] - - - [ - - ] - - - - - - - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/keywords.xsl b/doc/docbook-xsl/html/keywords.xsl deleted file mode 100644 index 013858efc..000000000 --- a/doc/docbook-xsl/html/keywords.xsl +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - , - - - - - diff --git a/doc/docbook-xsl/html/lists.xsl b/doc/docbook-xsl/html/lists.xsl deleted file mode 100644 index 5e9f36203..000000000 --- a/doc/docbook-xsl/html/lists.xsl +++ /dev/null @@ -1,1119 +0,0 @@ - - - - - - - - -
- - - - - - - - - -
    - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - circle - disc - square - - - - - - -
  • - - - list-style-type: - - - - - - - - - - - -
    - -
    -     - - - -     -
    • -     - - - - - - - - - - - - - 1 - a - i - A - I - - - - Unexpected numeration: - - - - - - - -
    - - - - - - - - - - -
      - - - - - - - - - - - - - - - - -
    -
    -     - - - - - - -
  • - - - - - - - - - - - - - -
    - -
    -     - - - -     -
    • -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - -
    - -
    -     -     -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - -

    - - - - - - - - -

    -     -     -     - - -
    - - -
    -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     -     -     -     -     - - - - - - - - - -
    - -
    -     - - - -     -     - - - - - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - - 1 - - - -
    -     - - - 1 - 1 - - - - - - - - - - - - - - - - - - - - - - - - - 1 - 1 - - 1 - - - - - - - - -   - - - - - - - - - - - - - - 1 - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - 1 - 1 - - 1 - - - - - - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - before - - - - - - - - - -
    - - - - - 0 - 1 - - - - - - - - - - - - -
      - -
    -     - -
      - - - - -
    -     -     - - - - -
    -     - - - - - - - - - - - - -
      - -
    -     - - -
  • - - -
    • -     - - - -
      - -
    -     - - -

    - - - -

    -     - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - -
    -     - - -
    - -
    -     - - - - - - - - - -
    - - -
    -     - - - - - - - - -
    - - - - : - - - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - -
    -     - -
    - -
    -     -     -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    -     -     -     - - - - - - - - - -

    - - - - - - - - -

    -     -     -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ??? - - - - - # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ??? - - - - - - -     - diff --git a/doc/docbook-xsl/html/manifest.xsl b/doc/docbook-xsl/html/manifest.xsl deleted file mode 100644 index 4c23c86e9..000000000 --- a/doc/docbook-xsl/html/manifest.xsl +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/math.xsl b/doc/docbook-xsl/html/math.xsl deleted file mode 100644 index f6033bd3c..000000000 --- a/doc/docbook-xsl/html/math.xsl +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unsupported TeX math notation: - - - - - - - - - - - - - \nopagenumbers - - - - \bye - - - - - - - - - - - - - - - - - - - - - - - \special{dvi2bitmap outputfile - - } - - $ - - - - $ - - \vfill\eject - - - - - - - - - - - - - - - - - - - - - - - - \special{dvi2bitmap outputfile - - } - - $$ - - - - $$ - - \vfill\eject - - - - - - - - - \documentclass{article} - \pagestyle{empty} - \begin{document} - - - - \end{document} - - - - - - - - - - - - - - - - - - - - - - - \special{dvi2bitmap outputfile - - } - - $ - - - - $ - - \newpage - - - - - - - - - - - - - - - - - - - - - - - - \special{dvi2bitmap outputfile - - } - - $$ - - - - $$ - - \newpage - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - 0 - 1 - - - - - - diff --git a/doc/docbook-xsl/html/param.xsl b/doc/docbook-xsl/html/param.xsl deleted file mode 100644 index c59dda213..000000000 --- a/doc/docbook-xsl/html/param.xsl +++ /dev/null @@ -1,398 +0,0 @@ - - - - - - -images/ - - margin-left: 0.5in; margin-right: 0.5in; - - - - -/* ====================================================================== - Annotations -*/ - -div.annotation-list { visibility: hidden; - } - -div.annotation-nocss { position: absolute; - visibility: hidden; - } - -div.annotation-popup { position: absolute; - z-index: 4; - visibility: hidden; - padding: 0px; - margin: 2px; - border-style: solid; - border-width: 1px; - width: 200px; - background-color: white; - } - -div.annotation-title { padding: 1px; - font-weight: bold; - border-bottom-style: solid; - border-bottom-width: 1px; - color: white; - background-color: black; - } - -div.annotation-body { padding: 2px; - } - -div.annotation-body p { margin-top: 0px; - padding-top: 0px; - } - -div.annotation-close { position: absolute; - top: 2px; - right: 2px; - } - - - - - - - - - - -. - - - -0 - - - - - - - - - - - - - - - - - - - - - - - -1 - - - - - left - before - - - - - - - - - - -::= - - - - - -DocBook Online Help Sample -com.example.help -Example provider -1 -1 - - - - - - - - -figure before -example before -equation before -table before -procedure before -task before - - -kr - -0 - - - - - - - - -appendix toc,title -article/appendix nop -article toc,title -book toc,title,figure,table,example,equation -chapter toc,title -part toc,title -preface toc,title -qandadiv toc -qandaset toc -reference toc,title -sect1 toc -sect2 toc -sect3 toc -sect4 toc -sect5 toc -section toc -set toc,title - - - - - - - - - - - - - - - - - - - -copyright - - - - -text/css - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -no - - - - - - - - - - - - - - - - - - - - → - - - -images/ -1 - - - - - - - replace - -no - - - - - - - - - -0 - - - - - - - - - - - - - - - - - - - - - - - - - -number - - - - - - - - - - - - - - - - - - - - - 0 - #E0E0E0 - - -1 -0 - - -0 -0 -0 - - - - - - - - - - - - - - - - - - - -dl -2 -8 - - - - - - - - - -, -0 - -: - - - - \ No newline at end of file diff --git a/doc/docbook-xsl/html/pi.xsl b/doc/docbook-xsl/html/pi.xsl deleted file mode 100644 index 03a7d6fac..000000000 --- a/doc/docbook-xsl/html/pi.xsl +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - - - - - - - - - - - - filename - - - - - - - - - - - - filename - - - - - - - - - - - - - - - - - - - - - - dir - - - - - - - - - - - - - - / - - - - / - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - -
    - - - - - -     -     -     - - - - - - No cmdsynopsis elements matched dbcmdlist PI, perhaps it's nested too deep? - - - -
    - - - -
    -     - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - -
    - - - - - -     -     -     - - - - - - No funcsynopsis elements matched dbfunclist PI, perhaps it's nested too deep? - - - -
    - - - -
    -     - - - - - - - - - - href - - - - - - - - - - - - - - - - - - - - - ERROR: dbhtml-include processing instruction - href has no content. - - - - - - - ERROR: dbhtml-include processing instruction has - missing or empty href value. - - - - - -     diff --git a/doc/docbook-xsl/html/qandaset.xsl b/doc/docbook-xsl/html/qandaset.xsl deleted file mode 100644 index dc594eb1a..000000000 --- a/doc/docbook-xsl/html/qandaset.xsl +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - -
    -     - - -
    -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - -
    - - - - -     - - - -
    - -
    -     -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1% - - - - - - -
    -     - - - - - - - - - -     diff --git a/doc/docbook-xsl/html/refentry.xsl b/doc/docbook-xsl/html/refentry.xsl deleted file mode 100644 index 16ce62b42..000000000 --- a/doc/docbook-xsl/html/refentry.xsl +++ /dev/null @@ -1,309 +0,0 @@ - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    - -

    -     - - - - -
    - - - - - - -
    -
    -
    -     - - - - - - -
    -     - - - - - - - - - - - - - - ( - - ) - - - - - - - - - - - -
    - - - - - - - - - - - -

    - - - -

    -     - -

    - - - - - - - - -

    -     -     - -

    - -

    -
    -     - - - - - - , - - - - - - - - - em-dash - - - - - - - - - - - - -

    - - - - : - - - -

    -     -     - - -
    - - - - - -

    - - - - - - - - - - -

    - -
    -     - - - - - - - - - - - -
    - - - - - - - - - - - -
    -     - - - - - - 0 - 1 - - - - 6 - - - - - - - - - - - - -

    - -

    -     - - - -

    - -

    -     - - - -

    - -

    -     - - - - - - - - - -     diff --git a/doc/docbook-xsl/html/sections.xsl b/doc/docbook-xsl/html/sections.xsl deleted file mode 100644 index 006b6838d..000000000 --- a/doc/docbook-xsl/html/sections.xsl +++ /dev/null @@ -1,619 +0,0 @@ - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - 1 - 2 - 3 - 4 - 5 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - -
    - - - - - - - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 6 - - - - - - - - - - clear: both - - - - - - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - 1 - - - - - - - 2 - 3 - 4 - 5 - 6 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - diff --git a/doc/docbook-xsl/html/synop.xsl b/doc/docbook-xsl/html/synop.xsl deleted file mode 100644 index 198bcecea..000000000 --- a/doc/docbook-xsl/html/synop.xsl +++ /dev/null @@ -1,1577 +0,0 @@ - - -]> - - - - - - - - - - - -
    - -

    - - -

    -
    -     - - -
    - - -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - - - - ( - - ) - -   - - - - - - - - - - - - -

    - - - - - ( - - ) - - - -

    -     - - - - - - - 
    -    
-    
-
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    - - -
    - -     -

    -     - - - - - - ( - - - - - - - - - - - - - - - - ) - ; - - - - ... - ) - ; - - - - - - - , - - - ) - ; - - - - - - - - - - - - - - - - - - - - -
    - - - - ; -     - - - - - - - - - - - - - - - - - - ( - - ) - - - - - - - - - - - - - - - - - -
    - -
     
    - - - - padding-bottom: 1em - - -
    -     -     - - - - - - ( - - - - - - - - - - - - - - - - - ) - ; - -   - - - - - ... - ) - ; - -   - - - - - - - - , - - - ) - ; - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - ; - - - - - - - - - - - - - - - - - - - - - - - - ( - - ) - ; - - - - - - -

    - -

    -     - - - - - - ( - - - - - - - - - - - - - - - - void) - ; - - - - ... - ) - ; - - - - - - - , - - - ) - ; - - - - - - - - - - - - - - - - - - - - - ( - - ) - - - - - - - - - padding-bottom: 1em - - - - - - - - - - - -
    - -
     
    -     - - - - - - ( - - - - - - - - - - - - - - - - - void) - ; - -   - - - - - ... - ) - ; - -   - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - , - - - ) - ; - - - - - - - -   - - - - - - - , - - - ) - ; - - - - - - - - - - - - - - - - - - - - - - - - ( - - ) - - - - -java - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unrecognized language on - - : - - - - - - - - - - - -
    -     -     - - - - - - 
    -    
-    
-    
-       extends
-      
-      
-        
    
-	    
-          
-        
-    
-      implements
-      
-      
-        
    
-	    
-          
-        
-    
-      throws
-      
-    
-     {
-    
    
-    
-    }
-
    -     - - - - - - - - - , - - - - - - - - - - - - - - - - -   - - - - - - - , - - - - - - - - - - , - - - - - - - - - - , - - - - - - - - - - - -    - - - ; - - - - - - - - -   - - - - - - - -   - - - - - - - =  - - - - - - - - void  - - - - - - - - - - - - 0 - - , -
    - - -   - - - -     - - - - -     - - - - - - - - - - - - - - -    - - - - - - - - - - - - - - - ( - - - - ) - -
    -     throws  - -     - - - - - ; -     - -     - - - - - 
    -    
-    
-    
-      : 
-      
-      
-        
    
-	    
-          
-        
-    
-       implements
-      
-      
-        
    
-	    
-          
-        
-    
-       throws
-      
-    
-     {
-    
    
-    
-    }
-
    -     - - - - - - - - , - - - - - - - - - - - - -   - - - - - - - , - - - - - - - - - - , - - - - - - - - - - , - - - - - - - - - - - -    - - - ; - - - - - - - - -   - - - - - - - -   - - - - - - - =  - - - - - - - - void  - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - - -    - - - - - - - - - - ( - - ) - -
    -     throws  - -     - - - - - ; -     - -     - - - - - 
    -    
-    interface 
-    
-    
-      : 
-      
-      
-        
    
-	    
-          
-        
-    
-       implements
-      
-      
-        
    
-	    
-          
-        
-    
-       throws
-      
-    
-     {
-    
    
-    
-    }
-
    -     - - - - - - - - , - - - - - - - - - - - - -   - - - - - - - , - - - - - - - - - - , - - - - - - - - - - , - - - - - - - - - - - -    - - - ; - - - - - - - - -   - - - - - - - -   - - - - - - - =  - - - - - - - - void  - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - -    - - - - - - - - - - ( - - ) - -
    -     raises( - - ) -     - - - - - ; -     - -     - - - - - 
    -    
-    package 
-    
-    ;
-    
    
-
-    
-      @ISA = (
-      
-      );
-      
    
-        
-
-    
-
    -     - - - - - - - - , - - - - - - - - - - - - -   - - - - - - - , - - - - - - - - - - , - - - - - - - - - - , - - - - - - - - - - - -    - - - ; - - - - - - - - -   - - - - - - - -   - - - - - - - =  - - - - - - - - void  - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - - sub - - - { ... }; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     diff --git a/doc/docbook-xsl/html/table.xsl b/doc/docbook-xsl/html/table.xsl deleted file mode 100644 index 02b2cfe94..000000000 --- a/doc/docbook-xsl/html/table.xsl +++ /dev/null @@ -1,1144 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - - - - - - - border- - - : - - - - - - ; - - - - - border- - - -width: - - ; - - - - border- - - -style: - - ; - - - - border- - - -color: - - ; - - - - - - - - - - - Error: CALS tables must specify the number of columns. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 100% - - - - - 0 - - - - border-collapse: collapse; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - border-collapse: collapse; - - - - - - - - - - - - - - - - - border-collapse: collapse; - - - - - - - - - - - border-collapse: collapse; - - - - - - - - - - - border-collapse: collapse; - - - - - - - - - - - - - - - - - border-collapse: collapse; - - - - - - 0 - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - - 100% - - - - - - - - - - - - - - - - - - - - - - - - No convertLength function available. - - - - - - - - - - - - - - - - - - - - - - - - - - No adjustColumnWidths function available. - - - - - - - - - - - - - - - - - - - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Warning: overlapped row contains content! - - - This row intentionally left blank - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - th - th - td - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - - - : - - - - - - - - 0: - - - - - - - - - - - - - - - 0 - - : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - 1 - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - diff --git a/doc/docbook-xsl/html/task.xsl b/doc/docbook-xsl/html/task.xsl deleted file mode 100644 index 4b0dfaa68..000000000 --- a/doc/docbook-xsl/html/task.xsl +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - - - - - - - - - before - - - - - - - - -
    - - - - - - - - - - - - -
    -     - - - - - - - - - - - - - - - - - - - - - - - -     diff --git a/doc/docbook-xsl/html/titlepage.templates.xsl b/doc/docbook-xsl/html/titlepage.templates.xsl deleted file mode 100644 index 676e18c6f..000000000 --- a/doc/docbook-xsl/html/titlepage.templates.xsl +++ /dev/null @@ -1,3620 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - - - - - -     - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
     -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
     -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
     -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
     -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
     -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
     -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
     -     - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - -
    -     - - -
    - - -
    - - - - - - - - - - - - - - - -     - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - - -
    - - - - - - - - - - - - - - - -     - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - - -
    - - - - - - - - - - - - - - - -     - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - - -
    - - -
    - - - - - - - - - - - - - - - -     - - - - - - - - - - - - - - -
    - - - - - - - - - - 1 - - - -
    -     - - - - - - - - - - 1 - - - -
    -     - -
    -     - - - - - - - - - - - - - - -
    - -
    -     - -     diff --git a/doc/docbook-xsl/html/titlepage.xsl b/doc/docbook-xsl/html/titlepage.xsl deleted file mode 100644 index 6ea86090d..000000000 --- a/doc/docbook-xsl/html/titlepage.xsl +++ /dev/null @@ -1,966 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     -     - - -
    - - - - - - - - -
    -     - - - - - - - - - - - - - -
    - - - - - - - - -
    -     - - -
    - - - - - - - - -
    -     -     -     - - -
    - - -
    -     - - - - - -
    -     -     - - - - - - -
    - - -

    -     -

    - - -

    - - - - - - - - - - - - - - - -
    -     - - -
    - - -
    -     - - -
    - - - -
    -     - - - - - -
    -     -     - - - - - - - - - - - - - -
    -     -     - - - - - - - - - -
    - - -
    -     - - - - - -
    -     -     - - - - - -
    -     -     - - - - - -
    -     -     - - - - - - - - - -
    -     -     - - - - - -
    -     -     - - - - - - - - - - -
    - -

    -
    -     -     -     - - -

    - - - - - - - copyright - - - - - - - - - -

    -     - - - - - - - - - - - - - - - - - - - - - - - - - - - , - - - - -

    - - -

    -     - - - - - -
    -     -     - - - - - -
    -     -     - - - - - -
    -     -     - - -

    - - - - - - -

    -     - - - - - - - - - - -
    -     -     - - - - - - - - - - -
    -     -     - - - - - -
    -     -     - - - - - -
    -     -     - - - - - -
    -     -     - - - - - - - - -
    -     -     - - - - - -
    -     -     - - - - - -
    -     -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - -     -     -     - -
    - - - -
    -     -     -     - - -

    -     - - - - - -
    -     -     - - - - - - - - - - - -
    -     -     - - - - - -
    -     -     - - - - - - - - - - - - - : - - - - - - - - - - - - - - - - - - - - - - - - - - , - - - - - - - -
    -     -     - - - - - -
    -     -     - - -
    - - -
    -     - - - - - -
    -     -     - - - - - -
    -     -     - - - - - - - - - - - - - - - - - - - - - - - -
    -     -     - - - - - -
    -     -     - - - - - - - - - - - - - - 3 - 2 - - - - - - - - RevHistory - - - - -
    - - - - - - - - -
    - - - - - -
    -
    -     - - - - - - - - - - -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - , - - - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -     -     - - - - - -
    -     -     - - - - - -

    - - -

    -     - - - - - -
    -     -     - - - - - - - - - - - - - - - - - - -

    - - - - - - - - - - - - -

    -     - - - - - - - - - -
    -     -     - - - -     diff --git a/doc/docbook-xsl/html/toc.xsl b/doc/docbook-xsl/html/toc.xsl deleted file mode 100644 index f2f6b5117..000000000 --- a/doc/docbook-xsl/html/toc.xsl +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - I don't know how to make a TOC in this context! - - - - - - - - - - - - - -
    - - - -
    -     - - - - - -     -     -     - - - - - -
    - -
    - -     - -
  • - - -
    • -     -     -     - - - - -
    - -
    -     - -
  • - -
    • -     -     -     - - - - - - - - - - - - - - -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/html/verbatim.xsl b/doc/docbook-xsl/html/verbatim.xsl deleted file mode 100644 index 9df94e14c..000000000 --- a/doc/docbook-xsl/html/verbatim.xsl +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - The shade.verbatim parameter is deprecated. - Use CSS instead, - - - for example: pre. - - { background-color: #E0E0E0; } - - - - - - - - - 
    -        
-	
-	  
-	
-
    -     - - 
    -        
-	
-
    -     -     -     - - - - - - - - - - - The shade.verbatim parameter is deprecated. - Use CSS instead, - - - for example: pre. - - { background-color: #E0E0E0; } - - - - - - - - 
    -            
-	    
-	      
-	    
-
    -     - -
    - -

    - - - -

    -
    -     -     -     - - - - 
    -            
-	    
-
    -     - -
    - -

    - - - -

    -
    -     -     -     -     -     - - - - - - - - - - -
    - -

    - - - -

    -
    -     - - -
    - -

    - - - -

    -
    -     -     -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unexpected verbatim environment: - - - - - - - - - - 1 - - - - - - - - - - - - - No numberLines function available. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     diff --git a/doc/docbook-xsl/html/xref.xsl b/doc/docbook-xsl/html/xref.xsl deleted file mode 100644 index 54de0f081..000000000 --- a/doc/docbook-xsl/html/xref.xsl +++ /dev/null @@ -1,1303 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Endterm points to nonexistent ID: - - - ??? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ERROR: xref linking to - - has no generated link text. - - ??? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - XRef to nonexistent id: - - - ??? - - - - - - - - - - - - - - - - Endterm points to nonexistent ID: - - - - - ??? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - suppress anchor - - - - - - - - - - - removing - - - - - - - - - - - - - - - - - removing - - - - - - - - - - - - - - - - - - - - - - Don't know what gentext to create for xref to: " - - ", (" - - ") - - - ??? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [ - - - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - No bibliography entry: - - found in - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [ - - - - - - - - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Endterm points to nonexistent ID: - - - ??? - - - - - - - - - - - - - Link element has no content and no Endterm. - Nothing to show in the link to - - - ??? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Olink debug: root element of target.database ' - - ' is ' - - '. - - - - - - - - - - - - - - - Error: unresolved olink: - targetdoc/targetptr = ' - - / - - '. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Warning: olink linkmode pointer is wrong. - - - - # - - - - - - - - - - - - - ? - - - - - & - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/lib/Makefile.am b/doc/docbook-xsl/lib/Makefile.am deleted file mode 100644 index cedc5245c..000000000 --- a/doc/docbook-xsl/lib/Makefile.am +++ /dev/null @@ -1,2 +0,0 @@ -EXTRA_DIST = \ - lib.xsl diff --git a/doc/docbook-xsl/lib/lib.xsl b/doc/docbook-xsl/lib/lib.xsl deleted file mode 100644 index 0f1f77f35..000000000 --- a/doc/docbook-xsl/lib/lib.xsl +++ /dev/null @@ -1,559 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - http://... - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unrecognized unit of measure: - - . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unrecognized unit of measure: - - . - - - - - - - filename - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - / - - - - - - - - - - - - / - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Error: To process character-map subsets, you must use an XSLT engine -that supports the evaluate() XSLT extension function. Your XSLT engine -does not support it. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/doc/docbook-xsl/manpages/ChangeLog.20020917 b/doc/docbook-xsl/manpages/ChangeLog.20020917 deleted file mode 100644 index c170cc056..000000000 --- a/doc/docbook-xsl/manpages/ChangeLog.20020917 +++ /dev/null @@ -1,195 +0,0 @@ -Note: This changelog is a record of descriptions of all changes -made to the DocBook XSL manpages stylesheets during the time when -they were maintained in their original home in the -[cvs]/docbook/contrib/xsl/db2man area of the DocBook Project -source-code repository at Sourceforge; that is, from October 2001 -(when they were contributed to the project by Martijn van Beers) -until September 2002 (when they were moved to the -[cvs]/docbook/xsl/manpages area and became a standard part of all -subsequent DocBook XSL Stylesheets releases). - -2002-09-17 Norman Walsh - - * README, db2man.xsl, lists.xsl, sect23.xsl, synop.xsl, xref.xsl: - Moved to docbook/xsl/manpages - - * db2man.xsl, synop.xsl: Patch from Joe Orton - -2002-06-16 - - * db2man.xsl: commit patch sent by Joe Orton: - - This patch adds support for using the productname, date and title out of - a if one is present, rather than having to add each of - these individually for every refentry. - - * db2man.xsl: Tim Waugh sent: - - This patch normalizes space in each refname before displaying it in - the name section. - -2002-05-21 - - * xref.xsl: from Joe Orton: - this patch allows cross-referencing to a specific refname. I - need this since I'm documenting several different (but related) - functions per refentry, and want to cross-reference them individually, - rather than just by the title used for the refentry as a whole. - -2002-05-17 - - * lists.xsl: apply glosslist support patch from twaugh - -2002-05-15 - - * db2man.xsl: slightly sanitize the filenames we generate. again from twaugh - - * db2man.xsl: Apply twaugh's fix for making the entity transform stuff work - -2002-05-14 - - * db2man.xsl: generalize the tip template for all admonitions - (caution,important,note,tip,warning) - - * db2man.xsl: Apply Joe Orton's patch, modified to be indented. Also show "Tip" - in the title. - - so if foo, you get - Tip: foo - - * synop.xsl: rewrote funcprototype. It used to convert all its children to a single - string and the split it up again through recursion. Now has a nice - foreach loop for the paramdefs, which seems much cleaner than throwing - everything in a big string before processing it. - -2002-05-10 - - * db2man.xsl: add support for simpara - - * db2man.xsl, lists.xsl: fix refsect2 titles - - * synop.xsl: also from twaugh: - - I found some input that goes wrong with the synop.xsl we have in CVS: - - - -o FILE - --output=FILE - - - It gets rendered as (with *bold* and _italic_): - - [*-o FILE* | *--output=FILE*] - - The desired markup should look like: - The following macro does the trick: - - [\fB-o \fIFILE\fR\fR | \fB--output=\fIFILE\fR\fR] - - The trouble is that the named template 'bold' uses value-of, and so - strips of its significance. - - Another thing I found is that the arg/replaceable template is - superfluous altogether: db2man.xsl has a 'replaceable' template which - does the same thing. - - Here is a patch to make those two modifications. - - NOTE TO SELF: must try to fix bold template so we can use it everywhere - -2002-05-09 - - * db2man.xsl: oops, removed too much - - * db2man.xsl: remove stuff that's apparently left-over from sect23.xsl - - * db2man.xsl, lists.xsl, synop.xsl: batch of patches from twaugh: - * This patch (based on one from Jirka Kosek) adds support for - block-level elements inside s---s for example, or lists. - * This patch replaces entities (like '舒') with sensible - characters or groups of characters. - * This patch adds support for sbr. - * This patch normalizes spaces in varlistentry terms. - * This patch normalizes spaces in terminal varlistentry terms. - * This patch allows variable lists to be nested (once). - * This patch prevents variable list item paragraphs from merging into - one another. - * This patch improves the rendering of itemized lists, and adds support - for ordered lists and procedures. - * This patch makes some small adjustments to group/arg: don't put extra - spaces in where they aren't needed, and normalize the space of $arg. - * This patch makes adjustments to cmdsynopsis elements. In particular, - they can now be wrapped if no is provided. - * This patch adds funcsynopsis//* support. Again, wrapping is done - automatically. - - * synop.xsl: make synopsises work for --arg=foo s too - - * synop.xsl: remove unneccesary adding of whitespace for arg/replaceable - -2002-05-01 - - * db2man.xsl: This patch adds support for multiple refnames. - - (another twaugh patch) - - * db2man.xsl: modified ulink patch from twaugh. Be nice to content-less ulinks. But we - don't accomodate silly people who don't understand ulink and put the - url as the content too. - - * db2man.xsl, synop.xsl: db2man.xsl: - * temporarily add some params that chunker.xsl needs - * fix bold/italic templates - * update calls to bold/italic templates for new syntax - synop.xsl: - * add support for synopfragment - * update calls to bold/italic templates for new syntax - -2002-04-30 - - * db2man.xsl: Add twaug's patch for xref support - - * db2man.xsl: This patch adds support for: - - - Multiple authors. - - A (single) man page editor. - - (another patch from twaugh) - - * db2man.xsl: more twaugh patches: - - Use refentrytitle, not refname[1], for title. - - Upper-case it. - - Use date, productname, and title. - - Pick up author from main document if not contained in refentry. - - Use refname[1] for man page filename, not refentrytitle. - - * db2man.xsl: add varname support - - * db2man.xsl: This patch makes userinput (an inline element) have inline formatting. - - * db2man.xsl: This patch adds support for the top-level document being something - other than an article. - - It also emits a helpful warning if no refentry elements are found. - - * db2man.xsl: next twaugh patch: - Instead of writing to stdout, create a file for each - refentry. Plus, for bonus points, a file for each additional refname - within that entry (pointing to the main page). - - * db2man.xsl: Add named templates for bold-ifying and italicizing stuff. Inspired - by yet another twaugh patch - - * db2man.xsl, lists.xsl, sect23.xsl: consistently use instead of a newline - - * db2man.xsl, synop.xsl: * add support for informalexample, screen, errorcode, constant, type, - quote, programlisting and citerefentry - * use the 'bold' and 'italic' named templates - - * xref.xsl: New file. - -2001-12-01 Norman Walsh - - * README, db2man.xsl, lists.xsl, sect23.xsl, synop.xsl: - New file. - diff --git a/doc/docbook-xsl/manpages/Makefile.am b/doc/docbook-xsl/manpages/Makefile.am deleted file mode 100644 index 367167de8..000000000 --- a/doc/docbook-xsl/manpages/Makefile.am +++ /dev/null @@ -1,16 +0,0 @@ -EXTRA_DIST = \ - ChangeLog.20020917 \ - block.xsl \ - charmap.groff.xsl \ - docbook.xsl \ - endnotes.xsl \ - html-synop.xsl \ - info.xsl \ - inline.xsl \ - lists.xsl \ - other.xsl \ - param.xsl \ - refentry.xsl \ - synop.xsl \ - table.xsl \ - utility.xsl diff --git a/doc/docbook-xsl/manpages/block.xsl b/doc/docbook-xsl/manpages/block.xsl deleted file mode 100644 index 43917f6ff..000000000 --- a/doc/docbook-xsl/manpages/block.xsl +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - - - - - - - - .PP - - - - . - - - - - - - - - - - - - - - - - - - - - .sp - - .RS 4n - - - - - .PP - - - - - - - - .RE - - - - - - - - - - - - - - .sp - - - - - - - - - - - - Yes - - - - - - - - - - - - - - - - - .sp - - - - - .RS - - - - - - - - - - - - - - - - - - - - - - - - - - .ft - - - .nf - - - .fi - .ft - - - - .nf - - - .fi - - - - - .RE - - - - - .sp - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - before - - - - - - - .PP - - - - - - - - - - .sp - - .RS - - - - - - - - .RE - - - - [IMAGE] - - - - - - [ - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/manpages/charmap.groff.xsl b/doc/docbook-xsl/manpages/charmap.groff.xsl deleted file mode 100644 index 8541c0ede..000000000 --- a/doc/docbook-xsl/manpages/charmap.groff.xsl +++ /dev/null @@ -1,5985 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/manpages/docbook.xsl b/doc/docbook-xsl/manpages/docbook.xsl deleted file mode 100644 index 3ec2c34d6..000000000 --- a/doc/docbook-xsl/manpages/docbook.xsl +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - MAN.MANIFEST - - - - - - - - - - - - - - - - - - - - - - - Note: No refentry elements found in " - - - - - - ... - - - - - - - " - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/manpages/endnotes.xsl b/doc/docbook-xsl/manpages/endnotes.xsl deleted file mode 100644 index 39a2f81a2..000000000 --- a/doc/docbook-xsl/manpages/endnotes.xsl +++ /dev/null @@ -1,451 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \&[ - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .SH " - - - - - - - - - - - - - - - - - - " - - - - - - .IP - " - - - . - - - - - - - - " - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .RS - - - - - - - - - - \% - - - - .RE - - - - - - - diff --git a/doc/docbook-xsl/manpages/html-synop.xsl b/doc/docbook-xsl/manpages/html-synop.xsl deleted file mode 100644 index 3d7322677..000000000 --- a/doc/docbook-xsl/manpages/html-synop.xsl +++ /dev/null @@ -1,1583 +0,0 @@ - - - - - - - - - - - -
    - -

    - - -

    -
    -     - - - -. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -. - - - - - - - - - - - - - ( - - ) - -   - - - - - - - - - - - - -

    - - - - - ( - - ) - - - -

    -     - - - - - - - ⌂sp -⌂nf -
    -    
-    
-
    ⌂fi - -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    - - - -. - - - -

    -     - - - - - - ( - - - - - - - - - - - - - - - - ) - ; - - - - ... - ) - ; - - - - - - - , - - - ) - ; - - - - - - - - - - - - - - - - - - - - - -. - - - - - ; - - - - - - - - - - - - - - - - - - - ( - - ) - - - - - - - - - - - - - - - - - -
    - -
     
    - - - - padding-bottom: 1em - - -
    -     -     - - - - - - ( - - - - - - - - - - - - - - - - - ) - ; - -   - - - - - ... - ) - ; - -   - - - - - - - - , - - - ) - ; - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - ; - - - - - - - - - - - - - - - - - - - - - - - - ( - - ) - ; - - - - - - -

    - -

    -     - - - - - - ( - - - - - - - - - - - - - - - - void) - ; - - - - ... - ) - ; - - - - - - - , - - - ) - ; - - - - - - - - - - - - - - - - - - - - - ( - - ) - - - - - - - - - padding-bottom: 1em - - - - - - - - - - - -
    - -
     
    -     - - - - - - ( - - - - - - - - - - - - - - - - - void) - ; - -   - - - - - ... - ) - ; - -   - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - , - - - ) - ; - - - - - - - -   - - - - - - - , - - - ) - ; - - - - - - - - - - - - - - - - - - - - - - - - ( - - ) - - - - -java - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unrecognized language on - - : - - - - - - - - - - - - -. - - - - - - - - - ⌂sp -⌂nf -
    -    
-    
-    
-       extends
-      
-      
-        
-.
-
-	    
-      
-    
-    
-      implements
-      
-      
-        
-.
-
-	    
-      
-    
-    
-      throws
-      
-    
-     {
-    
-.
-
-    
-    }
-
    ⌂fi - -     - - - - - - - - - , - - - - - - - - - - - - - - - - -   - - - - - - - , - - - - - - - - - - , - - - - - - - - - - , - - - - - - - - - - - -    - - - ; - - - - - - - - -   - - - - - - - -   - - - - - - - =  - - - - - - - - void  - - - - - - - - - - - - 0 - - , - -. - - - -   - - - - - - - - - - - - - - - - - - - - - - - -    - - - - - - - - - - - - - - - ( - - - - ) - - -. - -     throws  - - - - - - - ; - - - - - - - - ⌂sp -⌂nf -
    -    
-    
-    
-      : 
-      
-      
-        
-.
-
-	    
-      
-    
-    
-       implements
-      
-      
-        
-.
-
-	    
-      
-    
-    
-       throws
-      
-    
-     {
-    
-.
-
-    
-    }
-
    ⌂fi - -     - - - - - - - - , - - - - - - - - - - - - -   - - - - - - - , - - - - - - - - - - , - - - - - - - - - - , - - - - - - - - - - - -    - - - ; - - - - - - - - -   - - - - - - - -   - - - - - - - =  - - - - - - - - void  - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - - -    - - - - - - - - - - ( - - ) - - -. - -     throws  - - - - - - - ; - - - - - - - - ⌂sp -⌂nf -
    -    
-    interface 
-    
-    
-      : 
-      
-      
-        
-.
-
-	    
-      
-    
-    
-       implements
-      
-      
-        
-.
-
-	    
-      
-    
-    
-       throws
-      
-    
-     {
-    
-.
-
-    
-    }
-
    ⌂fi - -     - - - - - - - - , - - - - - - - - - - - - -   - - - - - - - , - - - - - - - - - - , - - - - - - - - - - , - - - - - - - - - - - -    - - - ; - - - - - - - - -   - - - - - - - -   - - - - - - - =  - - - - - - - - void  - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - -    - - - - - - - - - - ( - - ) - - -. - -     raises( - - ) - - - - - - ; - - - - - - - - ⌂sp -⌂nf -
    -    
-    package 
-    
-    ;
-    
-.
-
-
-    
-      @ISA = (
-      
-      );
-      
-.
-
-    
-
-    
-
    ⌂fi - -     - - - - - - - - , - - - - - - - - - - - - -   - - - - - - - , - - - - - - - - - - , - - - - - - - - - - , - - - - - - - - - - - -    - - - ; - - - - - - - - -   - - - - - - - -   - - - - - - - =  - - - - - - - - void  - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - - sub - - - { ... }; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     diff --git a/doc/docbook-xsl/manpages/info.xsl b/doc/docbook-xsl/manpages/info.xsl deleted file mode 100644 index 5bbe063f6..000000000 --- a/doc/docbook-xsl/manpages/info.xsl +++ /dev/null @@ -1,618 +0,0 @@ - - - - - - - - - - - - - - - - \n(zqu - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - < - - - - - - - - - - - - - - - > - - - - - - - - - - - - - - - - - - - - - - - - - - .SH " - - - - - - - - - - - - - - - - - - - - Author - - - Authors - - - - - - - - - - - " - - - - - - - - - - - - - - - - .PP - - - - - - - - .br - - - - - - - - - - - - .PP - - - - - - - - - - .PP - - - - - - - - - - .PP - - - - - - - - - - - - .sp -1n - .IP "" - - - - - - - - - . - - - - - - - - - - - - - - - - - - <\& - - - - - - - - - - - - - - - \&> - - - - - - - , - - - - - - - - - - - - - - - .br - - - - - - - - - - , - - - - - - - - - - - .br - - - - - - - - - - - - .br - - - - - - - - - - - - - - - - - - .sp -1n - .IP "" - - - - - - - - - . - - - - .sp -1n - .IP "" - - - - - - - - - . - - - - - - - - .sp -1n - .IP "" - - - - - - - - - . - - - - - - - - - - - - - - - - - - - - - - - - - - - - . - - - - - - - - - - - - - - - - - - - - - - - - .sp -1n - .IP "" - - - - - - - - - - - - - .PP - - - - - .br - - - - - - - - - - - - - - - - - - .SH " - - - - Copyright - - - - " - - - - - - - - - .br - - - - - - .br - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/manpages/inline.xsl b/doc/docbook-xsl/manpages/inline.xsl deleted file mode 100644 index 5583ff975..000000000 --- a/doc/docbook-xsl/manpages/inline.xsl +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( - - ) - - - - - - - - - - - - - - - - - - © - - - ® - - - ℠ - - - ™ - - - - - ™ - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/manpages/lists.xsl b/doc/docbook-xsl/manpages/lists.xsl deleted file mode 100644 index 6b4fabcd5..000000000 --- a/doc/docbook-xsl/manpages/lists.xsl +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - \n(zqu - - - - - - - - - - - - - - .sp - - - - - - .PP - - - - - - - - .PP - - - - - - - - - - - - - - - - - - - - .br - - - - - - .RS - - - - - - - .RE - - - - - - - - - .sp - - - - - - - - - - - - - - - .sp - - .RS - - - - - - \h'- - - 0 - - - ' - • - \h'+ - - 0 - - ' - - - .RE - - - - - .sp - - .RS - - - - - - \h'- - - 0 - - - ' - - - - - \h'+ - - 0 - - ' - - - .RE - - - - - - .PP - - - - - - - - - - - - - .sp - .RE - - - - - - .PP - - - - - - .IP "" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - , - - - - - - - - - - - - - - - - - .IP "" - - - - - - - - - - - - - - - - - .PP - - - - .\" line length increase to cope w/ tbl weirdness - .ll +(\n(LLu * 62u / 100u) - - .TS - - - - - - l - - - . - - - - - - - - - - - - - - .TE - .\" line length decrease back to previous value - .ll -(\n(LLu * 62u / 100u) - - .sp - - - - - - - - - - - - - - - - - - - - - - - - - - - T{ - - - - - T} - - - - - - - - - - - - diff --git a/doc/docbook-xsl/manpages/other.xsl b/doc/docbook-xsl/manpages/other.xsl deleted file mode 100644 index 0b96f09cb..000000000 --- a/doc/docbook-xsl/manpages/other.xsl +++ /dev/null @@ -1,667 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ - - - - - \e - - - - - - - - . - \. - - - - - - - - - - \- - - - - - - - - ' - \' - - - - - - - -   - - - - - - - - - - - - - - - - \ - - - - - - - - - - - - - - - .\" Title: - - - - - .\" Author: - - - - - - - - - .\" Generator: DocBook - - v - - - - <http://docbook.sf.net/> - - .\" Date: - - - - - .\" Manual: - - - - - .\" Source: - - - - - .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .TH " - - - - - - - - - - - - - " " - - " " - - - - - - - " " - - - - - - - - - - - - " " - - - - - - - - - - - - " - - - - - - - - - - - - - .\" disable hyphenation - .nh - - - - - .\" disable justification - (adjust text to left margin only) - .ad l - - - .\" store initial "default indentation value" - .nr zq \n(IN - .\" adjust default indentation - .nr IN - - - .\" adjust indentation of SS headings - .nr SN \n(IN - - - - - - .\" enable line breaks after slashes - .cflags 4 / - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Note: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Note: - (soelim stub) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Note: - (manifest file) - - - - - - - - - - diff --git a/doc/docbook-xsl/manpages/param.xsl b/doc/docbook-xsl/manpages/param.xsl deleted file mode 100644 index 345066603..000000000 --- a/doc/docbook-xsl/manpages/param.xsl +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -0 -0 -0 -0 -0 -0 -4 - - - - - BI - B - B - B - -MAN.MANIFEST - - - - -man/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -1 - -1 -1 -, -0 - - - - -@*[local-name() = 'block'] = 'Miscellaneous Technical' or -(@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and - @*[local-name() = 'class'] = 'symbols' -) or -(@*[local-name() = 'block'] = 'General Punctuation' and - (@*[local-name() = 'class'] = 'spaces' or - @*[local-name() = 'class'] = 'dashes' or - @*[local-name() = 'class'] = 'quotes' or - @*[local-name() = 'class'] = 'bullets' - ) -) or -@*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or -@*[local-name() = 'name'] = 'WORD JOINER' or -@*[local-name() = 'name'] = 'SERVICE MARK' or -@*[local-name() = 'name'] = 'TRADE MARK SIGN' or -@*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE' - - ----- -======================================================================== -0 -0 - -0 -0 -0 -0 -0 - - (($info[//date])[last()]/date)[1]| - (($info[//pubdate])[last()]/pubdate)[1] - - -refmeta/refmiscinfo[1]/node() - - (($info[//title])[last()]/title)[1]| - ../title/node() - - -refmeta/refmiscinfo[1]/node() - - (($info[//productname])[last()]/productname)[1]| - (($info[//corpname])[last()]/corpname)[1]| - (($info[//corpcredit])[last()]/corpcredit)[1]| - (($info[//corpauthor])[last()]/corpauthor)[1]| - (($info[//orgname])[last()]/orgname)[1]| - (($info[//publishername])[last()]/publishername)[1] - - - (($info[//productnumber])[last()]/productnumber)[1]| - (($info[//edition])[last()]/edition)[1]| - (($info[//releaseinfo])[last()]/releaseinfo)[1] - -20 -30 -30 -0 -0 -0 -1 - \ No newline at end of file diff --git a/doc/docbook-xsl/manpages/refentry.xsl b/doc/docbook-xsl/manpages/refentry.xsl deleted file mode 100644 index 3634e79a5..000000000 --- a/doc/docbook-xsl/manpages/refentry.xsl +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - - - - - - - - .br - - - - .SH " - - " - - - - - - - - - , - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .SH " - - " - - - - - - - - - - .SH " - - " - - - - - - - - - - - .SS " - - " - - - - - - .RS - - .RE - - - - - - - - - - - - - - - - - - - - - - - - .RS - - .RE - - - - - - - - - - .ti (\n(SNu * 5u / 3u) - - - - - - - - - - - - - - - - - - - (\n(SNu) - - - - .RS (\n(SNu) - - .RE - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/docbook-xsl/manpages/synop.xsl b/doc/docbook-xsl/manpages/synop.xsl deleted file mode 100644 index 07678fc5a..000000000 --- a/doc/docbook-xsl/manpages/synop.xsl +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - | - - - - - - - - - - - ( - - ) - ▀ - - - - - - - - - - - - - - - - - - - - - - .sp -1n - - .HP - - - - - - - ( - - ) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ▒ - .br▒ - - - - - - .ad l - - - - .hy 0 - - .HP - - - - - - - .ad - - - - .hy - - - - - - - - - - - - - - - - - - .ad l - - - - .hy 0 - - - - - .ad - - - - .hy - - - - - - - - - - - - - - - - - - - - - - - - - - - - .HP - - - - - . - - - - - - - - " - - ( - - " - - - - - - - - - - - - - void); - - - - ...); - - - - - - - , - - - ); - - - - - - - - - - - - - - - "░" - - "░" - - - - ( - - ) - - - diff --git a/doc/docbook-xsl/manpages/table.xsl b/doc/docbook-xsl/manpages/table.xsl deleted file mode 100644 index ea15126e5..000000000 --- a/doc/docbook-xsl/manpages/table.xsl +++ /dev/null @@ -1,632 +0,0 @@ - - - - - - - : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - allbox - - - - - - - - center - - - - - - - - expand - - - - - - - - - - - - - - - - - - - - - - -
    -     -     -     - - - - - - - -     -     - - - - - - - - - - - - - - - - - - .PP - . - - - - *[nested▀table] - - - - .sp -1n - - - - - .TS - - - H - - - - - - - - - - - tab( - - ) - - - - ; - - - - - - - - - - - - - - - - .TH - - - - - - - - - - - .T& - - - - - - - - - - - - - - - - - - - - - - .TE - - .sp - -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - T{ - - T} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Warn - - - tbl convert : Extracted a nested table - - - [\fInested▀table\fR]* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - . - - - - - - - - - - - - - - - - - - - - - - - ^ - - - c - - - r - - - n - - - - l - - - - - - - - t - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ^ - - - - s - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .br - - - - - - - - - ftn. - - - - - - # - - - - - - [ - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     diff --git a/doc/docbook-xsl/manpages/utility.xsl b/doc/docbook-xsl/manpages/utility.xsl deleted file mode 100644 index 1ae62af63..000000000 --- a/doc/docbook-xsl/manpages/utility.xsl +++ /dev/null @@ -1,430 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - \fB - - \fR - - - - - - \fI - - \fR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .sp - .it 1 an-trap - .nr an-no-space-flag 1 - .nr an-break-flag 1 - .br - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .sp - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .RS - - - - - - - - - - - - - - - - - - - - - .RE - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .\" - - - - - - diff --git a/doc/docbook-xsl/profiling/Makefile.am b/doc/docbook-xsl/profiling/Makefile.am deleted file mode 100644 index 5a7e4b744..000000000 --- a/doc/docbook-xsl/profiling/Makefile.am +++ /dev/null @@ -1,3 +0,0 @@ -EXTRA_DIST = \ - profile-mode.xsl \ - profile.xsl diff --git a/doc/docbook-xsl/profiling/profile-mode.xsl b/doc/docbook-xsl/profiling/profile-mode.xsl deleted file mode 100644 index a0e927e3b..000000000 --- a/doc/docbook-xsl/profiling/profile-mode.xsl +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - - - - - - - - diff --git a/doc/docbook-xsl/profiling/profile.xsl b/doc/docbook-xsl/profiling/profile.xsl deleted file mode 100644 index a7b8cb2fc..000000000 --- a/doc/docbook-xsl/profiling/profile.xsl +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/footer.html.in b/doc/footer.html.in deleted file mode 100644 index dfbd9cf43..000000000 --- a/doc/footer.html.in +++ /dev/null @@ -1,4 +0,0 @@ - -
    -

    fvwm @VERSION@@VERSIONINFO@

    -     diff --git a/doc/fvwm/Makefile.am b/doc/fvwm/Makefile.am deleted file mode 100755 index e52facfe5..000000000 --- a/doc/fvwm/Makefile.am +++ /dev/null @@ -1,63 +0,0 @@ -# Author: Scott Smedley - -docdir = @FVWM_DOCDIR@/fvwm3 -XSLTPROC = @XSLTPROC@ - -XSL_FILE = $(srcdir)/../fvwm3.xsl -XSL_MAN_FILE = $(srcdir)/../fvwm3-man.xsl -XSL_PROFILE = $(srcdir)/../docbook-xsl/profiling/profile.xsl - -HTML_FILES = fvwm3.man.html -XML_FILES = @DOC_SECTIONS_XML_PATH@ -EXTRA_DIST = @DOC_SECTIONS_XML@ $(man_MANS) sections -man_MANS = fvwm3.1 - -if FVWM_BUILD_HTMLDOC -doc_DATA = $(HTML_FILES) -BUILD_HTML_FILES = $(HTML_FILES) -else -BUILD_HTML_FILES = -endif - -if FVWM_BUILD_MANDOC -BUILD_MANS = $(man_MANS) -else -BUILD_MANS = -endif - -all: $(BUILD_HTML_FILES) $(BUILD_MANS) - -clean: - rm -f $(BUILD_HTML_FILES) $(BUILD_MANS) - -distclean-local: clean - -if FVWM_BUILD_MANDOC -fvwm3.man.html: $(XML_FILES) $(XSL_FILE) $(top_builddir)/doc/fvwm3.ent @DOC_COMMANDS_XML_PATH@ $(srcdir)/../header.html - $(XSLTPROC) --path "$(top_builddir)/doc":"$(top_srcdir)/doc/commands" \ - --xinclude \ - --stringparam profile.attribute output \ - --stringparam profile.value html \ - -o fvwm3.man.html.tmp \ - $(XSL_PROFILE) "$(srcdir)/fvwm3.man.xml" - $(XSLTPROC) --path "$(top_builddir)/doc":"$(top_srcdir)/doc/commands" \ - --xinclude \ - --stringparam html.stylesheet "../style.css" \ - --stringparam header.file "$(srcdir)/../header.html" \ - --stringparam twdt 1 \ - --stringparam section.autolabel 1 \ - -o $@ $(XSL_FILE) fvwm3.man.html.tmp && rm fvwm3.man.html.tmp - -fvwm3.1: $(XML_FILES) $(srcdir)/fvwm3.man.xml $(XSL_MAN_FILE) @DOC_COMMANDS_XML_PATH@ - $(XSLTPROC) --path "$(top_builddir)/doc":"$(top_srcdir)/doc/commands" \ - --xinclude \ - --stringparam profile.attribute output \ - --stringparam profile.value man \ - -o fvwm3.1.tmp \ - $(XSL_PROFILE) "$(srcdir)/fvwm3.man.xml" - $(XSLTPROC) --path "$(top_builddir)/doc":"$(top_srcdir)/doc/commands" \ - --xinclude \ - $(XSL_MAN_FILE) fvwm3.1.tmp && rm fvwm3.1.tmp -# mv fvwm.1 fvwm.1.pre -# tbl fvwm.1.pre | sed '/^\.T[SE]$$/d' > fvwm.1 && rm fvwm.1.pre -endif diff --git a/doc/fvwm/authors.xml b/doc/fvwm/authors.xml deleted file mode 100644 index 8a8a4f561..000000000 --- a/doc/fvwm/authors.xml +++ /dev/null @@ -1,16 +0,0 @@ - - -%myents; -]> - - - -
    -Authors - -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. - -
    diff --git a/doc/fvwm/bidirText.xml b/doc/fvwm/bidirText.xml deleted file mode 100644 index 813f52a8f..000000000 --- a/doc/fvwm/bidirText.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -%myents; -]> - - - - -
    -Bi-directional Text -Arabic and Hebrew text require bi-directional text support to be -displayed correctly, this means that logical strings should be -converted before their visual presentation, so left-to-right and -right-to-left sub-strings are determined and reshuffled. -In fvwm this is done automatically in window titles, menus, -module labels and other places if the fonts used for displaying the -text are of one of the charsets that require -bidi -(bi-directional) support. For example, this includes iso8859-6, -iso8859-8 and iso10646-1 (unicode), but not other iso8859-* fonts. - -This bi-directional text support is done using the -fribidi -library compile time option, see -INSTALL.fvwm. - -
    diff --git a/doc/fvwm/bindings.xml b/doc/fvwm/bindings.xml deleted file mode 100644 index 974658e6c..000000000 --- a/doc/fvwm/bindings.xml +++ /dev/null @@ -1,22 +0,0 @@ - - -%myents; -]> - - - -
    -Mouse & Key Bindings - - - - - - - - - -
    diff --git a/doc/fvwm/booleanArgs.xml b/doc/fvwm/booleanArgs.xml deleted file mode 100644 index 8844c3d42..000000000 --- a/doc/fvwm/booleanArgs.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - -%myents; -]> - - -
    -Boolean Arguments - - -A number of commands take one or several boolean arguments. These take a few equivalent inputs: "yes", "on", "true", "t" and "y" all evaluate to true while "no", "off", "false", "f" and "n" evaluate to false. Some commands allow "toggle" too which means that the feature is disabled if it is currently enabled and vice versa. - -
    diff --git a/doc/fvwm/bugs.xml b/doc/fvwm/bugs.xml deleted file mode 100644 index 6a07ee330..000000000 --- a/doc/fvwm/bugs.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - -%myents; -]> - - -
    -Bugs - -Bug reports can be sent to the fvwm-workers mailing list at -fvwm-workers@fvwm.org - -The official fvwm homepage is -http://fvwm.org/. - -
    diff --git a/doc/fvwm/builtinBindings.xml b/doc/fvwm/builtinBindings.xml deleted file mode 100644 index 42eb7bdd9..000000000 --- a/doc/fvwm/builtinBindings.xml +++ /dev/null @@ -1,62 +0,0 @@ - - -%myents; -]> - - - -
    -Builtin Key and Mouse Bindings -The following commands are built-in to fvwm: - - - Help R A MenuFvwmRoot - F1 R A MenuFvwmRoot - Tab A M Root c c NoDeskSort - Escape A MC - 1 R A MenuFvwmRoot - 1 T A FuncFvwmRaiseLowerX - 1 FS A FuncFvwmRaiseLowerX - 2 FST A FuncFvwmRaiseLowerX - FuncFvwmRaiseLowerX -+ I -+ M $0 -+ D - - - -The -Help -and -F1 -keys invoke a built-in menu that fvwm creates. This is primarily -for new users that have not created their own configuration -file. Either key on the root (background) window pops up an menu -to help you get started. - -The -Tab -key pressed anywhere with the -Meta -key (same as the -Alt -key on PC keyboards) held down pop-ups a window list. - -Mouse button 1 on the title-bar or side frame can move, raise or -lower a window. - -Mouse button 1 on the window corners can resize, raise or lower a -window. - -You can override or remove these bindings. To remove the window -list binding, use this: - - - Tab A M - - - - -
    diff --git a/doc/fvwm/colorGradients.xml b/doc/fvwm/colorGradients.xml deleted file mode 100644 index 7c392c58d..000000000 --- a/doc/fvwm/colorGradients.xml +++ /dev/null @@ -1,120 +0,0 @@ - - -%myents; -]> - - - -
    -Color Gradients - -A color gradient is a background that changes its color gradually -from one hue to a different one. Color gradients can be used by -various commands and modules of fvwm. There are eight types of -gradients: -HGradient -is a horizontal gradient, -VGradient -is vertical, -DGradient -is diagonal from top left to bottom right, -BGradient -is backwards diagonal from bottom left to top right, -SGradient -is concentric squares, -CGradient -is concentric circles, -RGradient -is a radar like pattern and -YGradient -is a Yin Yang style (but without the dots). - -The color gradient syntax has two forms: - - - colorsstart-colorend-color - - -This form specifies a linear gradient. The arguments denote the -total number of colors -to allocate (between 2 and 1000), the initial color and the final -color. - -Example: - - - VGradient 20 rgb:b8/ce/bc rgb:5b/85/d0 - - - - - colorssegmentscolorlengthcolorlengthcolor - - -The second form specifies a nonlinear gradient. The arguments are: -the total number of colors -to allocate (between 2 and 1000), then the number of -segments. -For each segment, specify the starting color, -a relative length, -then the ending color. Each subsequent segment begins with the -second color of the last segment. The lengths may be any -non-negative integers. The length of one segment divided by the -sum of all segments lengths is the fraction of the colors that -are used for the segment. - -Examples: - - - * \ - MenuFace DGradient 128 2 lightgrey 50 blue 50 white - -# 20% gradient from red to blue, -# 30% from blue to black, -# 50% from black to grey - * \ - MenuFace DGradient 100 3 Red 20 Blue 30 Black 50 Grey - -# 50% from blue to green, then -# 50% from yellow to red - 0 HGradient 128 3 Blue 1000 Green 1 Yellow 1000 Red - - -
    diff --git a/doc/fvwm/colorsets.xml b/doc/fvwm/colorsets.xml deleted file mode 100644 index fd44ed6e6..000000000 --- a/doc/fvwm/colorsets.xml +++ /dev/null @@ -1,53 +0,0 @@ - - -%myents; -]> - - - -
    -Colorsets - -Colorsets are a powerful method to control colors. Colorsets -create appearance resources that are shared by fvwm and its -modules. When a colorset is modified all parts of fvwm react to -that change. A colorset includes a foreground color, background -color, shadow and highlight color (often based on the background -color), background face (this includes images and all kinds of -gradients). There is a way to render background face and specify -other color operations. - -In the 2.4.x versions a special module - -was introduced to manage colorsets. Starting with the 2.5.x beta -version, the functionality was moved to the core fvwm, -so this module became obsolete. In 2.6.7 the -module was removed. - -The old syntax: - - - : * -*: 0 fg black, bg rgb:b4/aa/94 -*: 1 fg black, bg rgb:a1/b2/c8 - - -corresponds to the new syntax: - - - - 0 fg black, bg rgb:b4/aa/94 - 1 fg black, bg rgb:a1/b2/c8 - - - - - - - - - -
    diff --git a/doc/fvwm/commands.xml b/doc/fvwm/commands.xml deleted file mode 100644 index cfb46dd2f..000000000 --- a/doc/fvwm/commands.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - -%myents; -]> - - -
    -List of Fvwm Commands - -The command descriptions below are grouped together in the -following sections. The sections are hopefully sorted in order of -usefulness to the newcomer. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    diff --git a/doc/fvwm/compilation.xml b/doc/fvwm/compilation.xml deleted file mode 100644 index a54d00dd8..000000000 --- a/doc/fvwm/compilation.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - -
    -Compilation Options -Fvwm has a number of compile-time options. If you have trouble -using a certain command or feature, check to see if support for it -was included at compile time. Optional features are described in -the config.h file that is generated -during compilation. -
    diff --git a/doc/fvwm/conditionals.xml b/doc/fvwm/conditionals.xml deleted file mode 100644 index 3566a804a..000000000 --- a/doc/fvwm/conditionals.xml +++ /dev/null @@ -1,468 +0,0 @@ - - - -%myents; -]> - - -
    -Conditional Commands - - -Conditional commands are commands that are only executed if certain -conditions are met. Most conditional commands work on windows, -like -, or . -There is one conditional command, -, -that works on global conditions unrelated to windows. The syntax -of the conditions is described below. For readability, the list -of conditions is located at the end of this section. - - -
    -Return Codes - -All commands in this section (unless specifically stated for the -command) also have a return code that can be 1 (if the condition -was met) or 0 (if the condition was not met). Some commands may -return -1 which means that an error occurred and the return code -is useless. The -Break -command returns -2. Additionally, the return codes of commands -run in a complex functions are passed to the invoking complex -function. The return code is used by the - -command. Please refer to the commands' description for examples. -The return code can also be accessed through the variable -$[cond.rc]. -Non conditional commands do not modify the return code of the last -conditional command. Important note: return codes are only -defined inside functions created with the - -command and are not inherited by sub functions. To run a command -without altering the return code, the - -command can be used. - -
    - -
    -The Ring of Windows - -Fvwm stores windows in a ring internally. Think of the focused -window as a cursor on the current position in the ring. The - -command and many other commands search forwards through the ring -for a matching window, and - -searches backwards. The windows in the ring are either ordered by -creation time (if the -!FPSortWindowlistByFocus, -NeverFocus or MouseFocus -styles are used) or by the last time they had the focus. - -
    - -
    -List of Conditional Commands - - - - - - - - - - - - - - - - - - -
    - -
    -Conditions - -The -conditions -that may be given as an argument to any conditional command are a -list of keywords separated by commas, enclosed in -parentheses. Unless stated otherwise, conditional commands accept -all the conditions listed below. Note that earlier versions of -fvwm required the conditions to be separated by whitespace instead -of commas and enclosed in brackets instead of parentheses -(this is still supported for backward compatibility). - -In addition, the -conditions -may include one or more window names to match to. If more than -one window name is given, all of them must match. The window -name, icon name, class, and resource are considered when -attempting to find a match. Each name may include the wildcards -'*' and '?', and may consist of two or more alternatives, -separated by the character '|', which acts as an OR operator. (If -OR operators are used, they must not be separated by spaces from -the names.) Each window name can begin with '!', which prevents -command -if any of the window name, icon name, class or resource match. -However, '!' must not be applied to individual names in a group -separated by OR operators; it may only be applied to the beginning -of the group, and then it operates on the whole group. - -Examples: - - - ("Netscape|konqueror|Mozilla*") 99 90 - - -This goes to the next web browser window, no matter which of the -three named web browsers is being used. - - - ("Mozilla*", "Bookmark*") 99 90 - - -This goes to Mozilla's bookmark manager window, ignoring other -Mozilla windows and other browsers' bookmark windows. - - - ("XTerm|rxvt", !console) - - -This iconifies all the xterm and rxvt windows on the current page, -except that the one named "console" (with the -name option to xterm) -is excluded. - - - (!"|*|") - (!, !*, !) - - -These two commands are equivalent; either one raises the next window -which is not one of the named fvwm modules. - -Any condition can be negated by using a an exclamation mark ('!') -directly in front of its name. - -AcceptsFocus, -AnyScreen, -CirculateHit, -CirculateHitIcon, -CirculateHitShaded, -Closable, -CurrentDesk, -CurrentGlobalPage, -CurrentGlobalPageAnyDesk, -CurrentPage, -CurrentPageAnyDesk, -CurrentScreen, -Desk, -FixedPosition, -FixedSize, -Focused, -HasHandles, -HasPointer, -Iconic, -Iconifiable, -Layer [n], -Maximizable, -Maximized, -Overlapped, -PlacedByButton n, -PlacedByButton3, -PlacedByFvwm, -Raised, -Shaded, -State n, -Sticky, -StickyAcrossDesks, -StickyAcrossPages, -StickyIcon, -StickyAcrossDesksIcon, -StickyAcrossPagesIcon, -Transient, -Visible. - -The -AcceptsFocus -condition excludes all windows that do not want the input focus -(the application has set the "Input hints" for the window to -False) and do not use the -Lenience -option of the -Style -command. Also, all windows using the -NeverFocus -style are ignored. -Note: -!Lenience -is equivalent to the deprecated option -NoLenience. - -With the -AnyScreen -condition used together with any of the -Current... -conditions, windows that do not intersect the screen -containing the mouse pointer are considered for a match too. For -example: - - -# Focus next window on current page, -# regardless of screen - (CurrentPage, AnyScreen) - - - -The -CirculateHit and CirculateHitIcon -options override the -CirculateSkip and CirculateSkipIcon -Style -attributes for normal or iconic windows. The -CirculateHitShaded -option overrides the -CirculateSkipShaded -Style. -All three options are turned on -by default for the - -command. They can be turned off by specifying -!CirculateHit -etc. explicitly. -Note: Do not confuse these conditions with the style options of -the same name. Specifically, - - - foo CirculateSkip - (foo, CirculateHit) ... - - -is not the same as - - - foo CirculateHit ... - (foo) - - -The prior selects windows with the name foo only in the Next -command. In the second example, these windows are always matched -in all conditional commands. - -The -Closable -condition matches only windows that are allowed to be closed. - -The -CurrentDesk -condition matches only windows that are on the current desk. - -The -CurrentGlobalPage -condition matches only windows that are on the current page of the -current desk, regardless of which screen the window is on. -This condition implicitly activates the -CurrentDesk -condition. - -The -CurrentGlobalPageAnyDesk -condition matches only windows that are on the current page of any -desk, regardless of RandR screen . - -The -CurrentPage -condition matches only windows that are on the current page of the -current desk. This condition implicitly -activates the -CurrentDesk -condition. - -The -CurrentPageAnyDesk and CurrentScreen -conditions matches only windows that are on the current page of any -desk. - - -The -Screen [name] -condition matches only windows which are on the specified screen. - -The -Desk [n] -condition matches only windows which are on the specified desk. -The -FixedPosition -condition excludes all windows that do not have a fixed position, -either set through WM hints or the -Style -option -FixedPosition. -Example: - - - ToggleFixedGeometry - ToggleFixedGeometry -+ I (FixedPosition) \ - VariablePosition, VariableSize -+ I (NoMatch) FixedPosition, FixedSize - - - -The -FixedSize -condition excludes all windows that do not have a fixed size, -either set through WM hints or the -Style -option -FixedSize. - -The -Focused -matches on the window that currently has the keyboard focus. -This is not useful for the -Current -command but can be used with the other conditional commands. - -The -HasHandles -condition excludes all windows that do not have resize handles. - -The -HasPointer -condition excludes all windows that do not contain the pointer. - -The -Iconic -condition matches only iconic windows. - -The -Iconifiable -condition matches only windows that are allowed to be iconified. - -The -Layer [n] -condition matches only windows on the specified layer. The -optional argument of the -Layer -condition defaults to the layer of the focused window. The -negation -!Layer -switches off the -Layer -condition. - -The -Maximizable -condition matches only windows that are allowed to be maximized. - -The -Maximized -condition matches only maximized windows. - -The -Overlapped -condition matches only windows that are overlapped by other windows -on the same layer (or unmanaged windows if the option -RaiseOverUnmanaged -of the - -command is used). Note that this condition can be slow if you -have many windows or if RaiseOverUnmanaged is used and the -connection to the X server is slow. - -The -PlacedByButton n -condition is fulfilled if the last interactive motion of the -window (with the - -command or as -ManualPlacement) -was ended by pressing mouse button -n. -Example: - - - 1 T A MoveWindow - - MoveWindow - MoveWindow -+ C -+ C (PlacedByButton 5) off -+ C (Match) on 0 100 -+ C (PlacedByButton 4) on - - - -The -PlacedByButton3 -condition has the same meaning as -PlacedByButton -3. It remains only for backward compatibility. - -The -PlacedByFvwm -condition excludes all windows that have been placed manually or -by using the user or program position hint. - -The -Raised -conditions matches only windows that are fully visible on the -current viewport and not overlapped by any other window. - -The -Shaded -conditions matches only shaded windows (see - -command). - -The -State n or !State n -conditions match only windows with the specified integer state set -(or unset). See the - -command for details. The argument may range from 0 to 31. - -The -Sticky, StickyAcrossDesks and StickyAcrossPages -match only windows that are currently sticky, sticky across all -desks or sticky across all pages. Please refer to the - -options with the same name and the commands -, and -for details. - -The -StickyIcon, StickyAcrossDesksIcon and StickyAcrossPagesIcon -match only windows that become sticky, sticky across all desks or sticky -across all pages when they are in iconified state. - -The -Transient -condition matches only windows that have the "transient" -property set by the application. This it usually the case for -application popup menus and dialogs. The - -module can be used to find out whether a specific window is -transient. - -The -Visible -condition matches only windows that are at least partially -visible on the current viewport and not completely overlapped by -other windows. - -
    - - - -
    diff --git a/doc/fvwm/configuration.xml b/doc/fvwm/configuration.xml deleted file mode 100644 index 8490a10a5..000000000 --- a/doc/fvwm/configuration.xml +++ /dev/null @@ -1,54 +0,0 @@ - - -%myents; -]> - - - -
    -Configuration -
    -Configuration Files -The configuration file is used to describe mouse and button -bindings, colors, the virtual display size, and related items. -The initialization configuration file is typically called -config (or .fvwm2rc). -By using the - -command, it is easy to read in new configuration files as you go. - -Lines beginning with '#' are ignored by fvwm. Lines starting with '*' -are expected to contain module configuration commands (rather -than configuration commands for fvwm itself). Like in shell -scripts embedded newlines in a configuration file line can be -quoted by preceding them with a backslash. All lines linked in -this fashion are treated as a single line. The newline itself is -ignored. - -Fvwm makes no distinction between configuration commands and -action commands, so anything mentioned in the fvwm commands -section can be placed on a line by itself for fvwm to execute as -it reads the configuration file, or it can be placed as an -executable command in a menu or bound to a mouse button or a -keyboard key. It is left as an exercise for the user to decide -which function make sense for initialization and which ones make -sense for run-time. - -
    - -
    -Supplied Configuration -A sample configuration file, -is supplied with the fvwm distribution. It is well commented and -can be used as a source of examples for fvwm configuration. -It may be copied from /usr/local/share/fvwm/config file. - -Alternatively, the built-in menu (accessible when no -configuration file is found) has options to create an initial -config file for the user. - -
    -
    diff --git a/doc/fvwm/copyright.xml b/doc/fvwm/copyright.xml deleted file mode 100644 index d5b950481..000000000 --- a/doc/fvwm/copyright.xml +++ /dev/null @@ -1,16 +0,0 @@ - - -%myents; -]> - - - - diff --git a/doc/fvwm/cpp.xml b/doc/fvwm/cpp.xml deleted file mode 100644 index 63e108079..000000000 --- a/doc/fvwm/cpp.xml +++ /dev/null @@ -1,19 +0,0 @@ - - -%myents; -]> - - - -
    -CPP Preprocessing -Cpp is the C-language pre-processor. fvwm offers cpp processing -which mirrors the m4 pre-processing. To find out about it, -re-read the - -section, but replace "m4" with "cpp". - -
    diff --git a/doc/fvwm/description.xml b/doc/fvwm/description.xml deleted file mode 100644 index 52a329ab3..000000000 --- a/doc/fvwm/description.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - -
    -Description -Fvwm is a window manager for X11. It is designed to minimize -memory consumption, provide a 3D look to window frames, and a -virtual desktop. - -Note that there are several window managers around that have -"fvwm" in their name. Fvwm3 is the successor to fvwm2, which -preceded the 1.x versions of fvwm. This version is simply called -fvwm throughout this document, while the main executable is named -fvwm3. - - Fvwm is intended to have a small memory footprint but a rich feature -set, be extremely customizable and extendible, and have a high degree of Motif -mwm compatibility. Fvwm provides both a large -virtual desktop -and -multiple disjoint desktops -which can be used separately or together. The virtual desktop -allows you to pretend that your video screen is really quite -large, and you can scroll around within the desktop. The multiple -disjoint desktops allow you to pretend that you really have -several screens to work at, but each screen is completely -unrelated to the others. - -Fvwm provides -keyboard accelerators -that allow you to perform most window manager functions, -including moving and resizing windows and operating the menus, -using keyboard shortcuts. - -Fvwm has also overcome the distinction between configuration -commands and action commands that most window managers -make. Configuration commands typically set fonts, colors, menu -contents, and key and mouse function bindings, while action commands -do things like raise and lower windows. Fvwm makes no such -distinction and allows anything to be changed at any time. - -Other noteworthy differences between fvwm and other X11 window -managers are the introduction of the and -focus methods. Focus policy can be separately specified for -different window groups. Windows using acquire focus when the pointer moves into them and retain focus -until some other window acquires it. Such windows do not lose -focus when the pointer moves into the root window. The - -policy is provided for use with windows into which one never types -(e.g. xclock, oclock, xbiff, xeyes, tuxeyes) - for example, if a -SloppyFocus terminal window has focus, moving the pointer over a -NeverFocus -decoration window does not deprive the terminal of focus. - -
    diff --git a/doc/fvwm/environment.xml b/doc/fvwm/environment.xml deleted file mode 100644 index 6dcbd9bc2..000000000 --- a/doc/fvwm/environment.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - -%myents; -]> - - -
    -Environment -The environment variables that have an effect on how fvwm operates -are the following: - - - DISPLAY - - Fvwm starts on this display unless the - option is given. - - - - FVWM_USERDIR - - Used to determine the user's data directory for reading and - writing files. If this variable is not already - set, it is set by fvwm to $HOME/.fvwm, which - is the default user's data directory. - - - - FVWM3_LOGFILE - - Used to determine the path and filename to log debug information - from fvwm3. By default debug log is written to - $FVWM_USERDIR/fvwm3-output.log . If an absolute path - is specified (starting with /) then $FVWM_USERDIR is - ignored, otherwise the log is written to - $FVWM_USERDIR/$FVWM3_LOGFILE . - - - - - FVWM_DATADIR - - Set by fvwm to the directory containing fvwm config and module - data. - - - - FVWM_MODULEDIR - - Set by fvwm to the directory containing the standard fvwm - modules. - - - - SESSION_MANAGER - - Fvwm tries to contact this session manager. - - - - SESSION_MANAGER_NAME - - 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. - - - - SM_SAVE_DIR - - If this is set, fvwm saves its session data in this -directory. Otherwise it uses $HOME. -Note, the state files are named .fs-?????? -and normally are removed automatically when not used anymore. - - - -fvwm-config --info is useful to query fvwm3 compiled-in paths -
    diff --git a/doc/fvwm/ewmh.xml b/doc/fvwm/ewmh.xml deleted file mode 100644 index edc876f90..000000000 --- a/doc/fvwm/ewmh.xml +++ /dev/null @@ -1,74 +0,0 @@ - - -%myents; -]> - -
    -Extended Window Manager Hints -Fvwm attempts to respect the extended window manager hints (ewmh -or EWMH for short) specification: -https://specifications.freedesktop.org/wm-spec/wm-spec-1.3.html -and some extensions of this specification. This allows fvwm to -work with -KDE -version >= 2, -GNOME -version 2 and other applications which respect this specification -(any application based on -GTK+ -version 2). Applications which respect this specification are -called ewmh compliant applications. - -This support is configurable with styles and commands. -These styles and commands have -EWMH -as the prefix (so you can find them easily in this man page). - -There is a new Context 'D' for the -, -, - -commands. This context is for desktop applications (such as -kdesktop and Nautilus desktop). - -When a compliant taskbar asks fvwm to activate a window (typically -when you click on a button which represents a window in such a -taskbar), then fvwm calls the complex function -EWMHActivateWindowFunc -which by default is Iconify Off, Focus and Raise. You can redefine -this function. For example: - - - EWMHActivateWindowFunc - EWMHActivateWindowFunc I Off -+ I -+ I -+ I 50 50 - - -additionally warps the pointer to the center of the window. - -The -EWMH -specification introduces the notion of Working Area. Without ewmh -support the Working Area is the full visible screen (or all your -screens if you have a multi head setup with RandR). -However, compliant applications (such as a panel) can ask to -reserve space at the edge of the screen. If this is the case, the -Working Area is your full visible screen minus these reserved -spaces. If a panel can be hidden by clicking on a button the -Working Area does not change (as you can unhide the panel at any -time), but the Dynamic Working Area is updated: the space reserved -by the panel is removed (and added again if you pop up the -panel). The Dynamic Working Area may be used when fvwm places or -maximizes a window. To know if an application reserves space you -can type "xprop | grep _NET_WM_STRUT" in a terminal and select the -application. If four numbers appear then these numbers define the -reserved space as explained in the - -command. - -
    diff --git a/doc/fvwm/execution.xml b/doc/fvwm/execution.xml deleted file mode 100644 index 91e7b3f15..000000000 --- a/doc/fvwm/execution.xml +++ /dev/null @@ -1,68 +0,0 @@ - - -%myents; -]> - - - -
    -Command Execution - -
    -Module and Function Commands - -If fvwm encounters a command that it doesn't recognize, -it checks to see if the -specified command should have been - - - (rest of command) - - -or - - - (rest of command) - - -This allows complex functions or modules to be invoked in a manner -which is fairly transparent to the configuration file. - -Example: the -config -file contains the line - - -HelpMe - - -Fvwm looks for an fvwm command called "HelpMe", and fails. -Next it looks for a user-defined complex function called "HelpMe". -If no such function exists, fvwm tries to execute a -module called "HelpMe". - -
    - -
    -Delayed Execution of Commands -Note: There are many commands that affect look and feel of -specific, some or all windows, like -, , , -and many others. For performance reasons such changes are -not applied immediately but only when fvwm is idle, i.e. no user -interaction or module input is pending. Specifically, new - -options that are set in a function are not applied until after the -function has completed. This can sometimes lead to unwanted -effects. - -To force that all pending changes are applied immediately, use the -, or -commands. - -
    - -
    diff --git a/doc/fvwm/expansion.xml b/doc/fvwm/expansion.xml deleted file mode 100644 index 43da0f33e..000000000 --- a/doc/fvwm/expansion.xml +++ /dev/null @@ -1,572 +0,0 @@ - - - -%myents; -]> - - -
    -Command Expansion - -Whenever an fvwm command line is executed, fvwm performs parameter -expansion. A parameter is a '$' followed by a word enclosed in -brackets ($[...]) or a single special character. If fvwm -encounters an unquoted parameter on the command line it expands it -to a string indicated by the parameter name. Unknown parameters -are left untouched. Parameter expansion is performed before -quoting. To get a literal '$' use "$$". - -If a command is prefixed with a '-' parameter expansion isn't -performed. This applies to the command immediately following the '-', -in which the expansion normally would have taken place. When uesed -together with other prefix commands it must be added before the other -prefix. - -Example: - - - - exec xmessage '$[w.name]' - - -opens an xmessage dialog with "$[w.name]" unexpanded. - - - -The longer variables may contain additional variables inside the -name, which are expanded before the outer variable. - -In earlier versions of fvwm, some single letter variables were -supported. It is deprecated now, since they cause a number of -problems. You should use the longer substitutes instead. - -Example: - - -# Print the current desk number, horizontal page number -# and the window's class (unexpanded here, no window). - $[desk.n] $[page.nx] $[w.class] - - - -Note: If the command is called outside a window context, it -prints "$[w.class]" instead of the class name. It is usually not -enough to have the pointer over a window to have a context window. -To force using the window with the focus, the - -command can be used: - - - $[desk.n] $[page.nx] $[w.class] - - -The parameters known by fvwm are: - - - - $$ - A literal '$'. - - - $. - - - The absolute directory of the currently Read file. Intended for - creating relative and relocatable configuration trees. If used - outside of any read file, the returned value is '.'. - - - - - $0 to $9 - - - The positional parameters given to a complex function (a function - that has been defined with the - - command). "$0" is replaced with the first parameter, "$1" with - the second parameter and so on. If the corresponding parameter is - undefined, the "$..." is deleted from the command line. - - - - - $* - - - All positional parameters given to a complex function. This - includes parameters that follow after "$9". - - - - - $[n] - - - The n:th - positional parameter given to a complex function, counting from 0. - If the corresponding parameter is undefined, the - "$[n]" is deleted - from the command line. The parameter is expanded unquoted. - - - - - $[n-m] - - - The positional parameters given to a complex function, starting - with parameter n and ending with parameter - m. - If all the corresponding parameters are undefined, the "$[...]" is - deleted from the command line. If only some of the parameters are - defined, all defined parameters are expanded, and the remaining - silently ignored. All parameters are expanded unquoted. - - - - - $[n-] - - - All the positional parameters given to a complex function, - starting with parameter n. - If all the corresponding parameters are undefined, the "$[...]" is - deleted from the command line. All parameters are expanded - unquoted. - - - - - $[*] - - - All the positional parameters given to a complex function. This is - equivalent of $[0-]. - - - - - $[version.num] - - The version number, like "2.6.0". - - - - $[version.info] - - - The version info, like " (from cvs)", empty for the official releases. - - - - - $[version.line] - - - The first line printed by the --version command line option. - - - - - $[vp.x] $[vp.y] $[vp.width] $[vp.height] - - - Either coordinate or the width or height of the current viewport. - - - - - $[wa.x] $[wa.y] $[wa.width] $[wa.height] - - - Either coordinate or the width or height of the EWMH working area. - - - - - $[dwa.x] $[dwa.y] $[dwa.width] $[dwa.height] - - - Either coordinate or the width or height of the dynamic EWMH working area. - - - - - $[desk.n] - The current desk number. - - - $[desk.name<n>] - - - These parameters are replaced with the name of the desktop - number <n> that is defined with the - - command. If no name is defined, then the default name is returned. - - - - - $[desk.width] $[desk.height] - - - The width or height of the whole desktop, i.e. the width or height - multiplied by the number of pages in x or y direction. - - - - - $[desk.pagesx] $[desk.pagesy] - - - The number of total pages in a desk in x or y direction. - This is the same as the values set by - . - - - - - $[page.nx] $[page.ny] - - - The current page numbers, by X and Y axes, starting from 0. - page is equivalent to - area in the - GNOME terminology. - - - - - $[w.id] - - - The window-id (expressed in hex, e.g. 0x10023c) of the window the - command was called for or "$[w.id]" if no window is associated - with the command. - - - - - - $[w.name] $[w.iconname] $[w.class] $[w.resource] - $[w.visiblename] $[w.iconfile] $[w.miniiconfile] - $[w.iconfile.svgopts] $[w.miniiconfile.svgopts] - - - - The window's name, icon name, resource class and resource name, - visible name, file name of its icon or mini icon defined with the - or - - style (including the full path if the file was found on disk), - and (if fvwm is compiled with SVG support) - the icon or mini icon svg rendering options (including the - leading colon), or unexpanded "$[w.<attribute>]" string - if no window is associated with the command. - - - Note, the first 5 variables may include any kind of characters, so - these variables are quoted. It means that the value is surrounded - by single quote characters and any contained single quote is - prefixed with a backslash. This guarantees that commands like: - - $[w.resource] norm/network.png - - work correctly, regardless of any special symbols the value may - contain, like spaces and different kinds of quotes. - - - In the case of the window's visible name, this is the value returned - from the literal title of the window shown in the titlebar. Typically - this will be the same as $[w.name] once expanded, although - in the case of using then - this is more useful a distinction, and allows for referencing the - specific window by its visible name for inclusion in things like - commands. - - - - - $[w.x] $[w.y] $[w.width] $[w.height] - - - Either coordinate or the width or height of the current window if - it is not iconified. If no window is associated with the command - or the window is iconified, the string is left as is. - - - - - $[w.pagex] $[w.pagey] - The X or Y page the window is on. - - - $[w.desk] - - - The number of the desk on which the window is shown. If the - window is sticky the current desk number is used. - - - - - $[w.layer] - The layer of the window. - - - $[w.screen] - The screen name the window is on. If RandR is not - present, this does not expand. - - - $[cw.x] $[cw.y] $[cw.width] $[cw.height] - - - These work like $[w....] but return the geometry of the client - part of the window. In other words: the border and title of the - window is not taken into account. - - - - - - $[i.x], $[it.x], $[ip.x] - $[i.y], $[it.y], $[ip.y] - $[i.width], $[it.width], $[ip.width] - $[i.height], $[it.height], $[ip.height] - - - - These work like $[w....] but return the geometry of the icon - ($[i....]), the icon title ($[it....]) or the icon picture - ($[ip....]). - - - - - $[pointer.x] $[pointer.y] - - - These return the position of the pointer on the screen. If the - pointer is not on the screen, these variables are not expanded. - - - - - $[pointer.wx] $[pointer.wy] - - - These return the position of the pointer in the selected window. If - the pointer is not on the screen, the window is iconified - or no window is selected, these variables are not expanded. - - - - - $[pointer.cx] $[pointer.cy] - - - These return the position of the pointer in the client portion of - the selected window. If the pointer is not on the screen, the - window is shaded or iconified or no window is selected, these - variables are not expanded. - - - - - $[pointer.screen] - - - The screen name the pointer is currently on. No expansion if - RandR is not enabled. - - - This command is deprecated; use $[monitor.current] instead. - - - - - - $[monitor.<n>.x], $[monitor.<n>.y], - $[monitor.<n>.width], - $[monitor.<n>.height], $[monitor.primary], - $[monitor.current], $[monitor.output], $[monitor.count] - - - - - Returns information about the selected monitor. These can be nested, - for example: $[monitor.$[monitor.primary].width] - - - <n> should be a valid xrandr(1) output name. - - - "x" returns the monitor's x position; - "y" returns the monitor's y position; - "width" returns the monitor's width (in pixels); - "height" returns the monitor's height (in pixels) - - - "current" is the same as the deprecated $[screen.pointer] variable; - the monitor which has the mouse pointer. - - - "count" returns the number of active monitors. - - - "primary" is the name of the output set as primary via xrandr(1). - - - - $[screen] - - - The screen number fvwm is running on. Useful for setups with - multiple screens. - - - - - $[screen.count] - - - The total number of screens detected. Assumes RandR. - - This is deprecated; use $[monitor.count] instead. - - - - - $[fg.cs<n>] - $[bg.cs<n>] - $[hilight.cs<n>] - $[shadow.cs<n>] - $[fgsh.cs<n>] - - - - These parameters are replaced with the name of the foreground - (fg), background (bg), hilight (hilight), shadow (shadow), or - the font shadow (fgsh) color that is defined in colorset <n> - (replace <n> with zero or a positive integer). For example - "$[fg.cs3]" is expanded to the name of the foreground color of - colorset 3 (in rgb:rrrr/gggg/bbbb form). - - - If .lighten<p> or .darken<p> is appended to the - parameters, they are instead replaced with a color that is - lighter or darker than the one defined in colorset <n> - by a percentage value <p> (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). - - - 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]. - - - Please refer to the - - section for details about colorsets. - - - - - $[schedule.last] - - - This is replaced by the id of the last command that was - scheduled with the command, even if - this command was already executed. - - - - - $[schedule.next] - - - This is replaced by the id the next command used with - will get (unless a different id is - specified explicitly). - - - - - $[cond.rc] - - - 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 - in the command list. - - - - - $[func.context] - - - The context character of the running command as used in the - , - or - - command. This is useful for example with: - 3 FS N $$[func.context] - - - - - $[debuglog.state] - - - Either 0 (debug log closed) or 1. - Indicates the current state of debuging and logging facility. - - - - - $[gt.str] - - - return the translation of - str by looking in the current - locale catalogs. If no translation is found - str is returned as is. See the - command. - - - - - $[infostore.key] - - Return the value of the item stored in the - InfoStore at the given key. - If no key is present, the unexpanded string is returned. - - - - - $[...] - - - 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. - - - - - - -Some examples can be found in the description of the - -command. - -
    diff --git a/doc/fvwm/focus.xml b/doc/fvwm/focus.xml deleted file mode 100644 index 16ba20adf..000000000 --- a/doc/fvwm/focus.xml +++ /dev/null @@ -1,21 +0,0 @@ - - -%myents; -]> - - - -
    -Focus & Mouse Movement - - - - - - - -
    diff --git a/doc/fvwm/fonts.xml b/doc/fvwm/fonts.xml deleted file mode 100644 index 1dbcdab25..000000000 --- a/doc/fvwm/fonts.xml +++ /dev/null @@ -1,333 +0,0 @@ - - -%myents; -]> - - - -
    -Fonts -
    -Font names and font loading -The fonts used for the text of a window title, icon titles, menus -and geometry window can be specified by using the Font and -IconFont , the Font and the -commands. Also, all the Modules which use text have configuration -command(s) to specify font(s). All these styles and commands take -a font name as an argument. This section explains what is a font -name for fvwm and which fonts fvwm loads. - -First, you can use what we can call a usual font name, for -example, - - --adobe-courier-bold-r-normal--10-100-75-75-m-60-ISO8859-1 --adobe-courier-bold-r-normal--10-* --*-fixed-medium-o-normal--14-*-ISO8859-15 - - -That is, you can use an X Logical Font Description (XLFD for -short). Then the "first" font which matches the description is -loaded and used. This "first" font depends of your font path and -also of your locale. Fonts which match the locale charset are -loaded in priority order. For example with - - --adobe-courier-bold-r-normal--10-* - - -if the locale charset is ISO8859-1, then fvwm tries to load a -font which matches - - --adobe-courier-bold-r-normal--10-*-ISO8859-1 - - -with the locale charset ISO8859-15 fvwm tries to load - - --adobe-courier-bold-r-normal--10-*-ISO8859-15. - - - -A font name can be given as an extended XLFD. This -is a comma separated list of (simple) XLFD font names, for example: - - --adobe-courier-bold-r-normal--14-*,-*-courier-medium-r-normal--14-* - - -Each simple font name is tried until a matching font with the -locale charset is found and if this fails each simple font name is -tried without constraint on the charset. - -More details on the XLFD can be found in the X manual page, the X -Logical Font Description Conventions document (called xlfd) and -the XLoadFont and XCreateFontSet manual pages. Some useful font -utilities are: xlsfonts, xfontsel, xfd and xset. - -If you have Xft support you can specify an Xft font name -(description) of a true type (or Type1) font prefixed by "xft:", -for example: - - -"xft:Luxi Mono" -"xft:Luxi Mono:Medium:Roman:size=14:encoding=iso8859-1" - - -The "first" font which matches the description is loaded. This -first font depends on the XftConfig configuration file with Xft1 -and on the /etc/fonts/fonts.conf file with Xft2. -One may read the Xft manual page and the fontconfig man page with -Xft2. The first string which follows "xft:" is always considered -as the family. With the second example Luxi Mono is the Family -(Other XFree TTF families: "Luxi Serif", "Luxi Sans"), Medium is -the Weight (other possible weights: Light, DemiBold, Bold, Black), -Roman is the slant or the style (other possibilities: Regular, -Oblique, Italic) size specifies the point size (for a pixel size -use pixelsize=), encoding allows for enforce a charset (iso8859-1 -or iso10646-1 only; if no encoding is given the locale charset is -assumed). -An important parameter is "minspace=bool" where bool is True or -False. If bool is False (the default?) Xft gives a greater font -height to fvwm than if bool is True. This may modify text -placement, icon and window title height, line spacing in menus and -, button height in some fvwm modules ...etc. With a LCD -monitor you may try to add "rgba=mode" where mode is either rgb, -bgr, vrgb or vbgr to enable subpixel rendering. The best mode -depends on the way your LCD cells are arranged. You can pass other -specifications in between ":", as "foundry=foundry_name", -"spacing=type" where type can be monospace, proportional or -charcell, "charwidth=integer", "charheight=integer" or -"antialias=bool" where bool is True or False. It seems that these -parameters are not always taken in account. - -To determine which Xft fonts are really loaded you can export -XFT_DEBUG=1 before starting fvwm and take a look to the error -log. With Xft2 you may use fc-list to list the available -fonts. Anyway, Xft support is experimental (from the X and the -fvwm point of view) and the quality of the rendering depends on -number of parameters (the XFree and the freetype versions and your -video card(s)). - -After an Xft font name you can add after a ";" an XLFD -font name (simple or extended) as: - - -xft:Verdana:pixelsize=14;-adobe-courier-bold-r-normal--14-* - - -then, if either loading the Xft font fails or fvwm has no Xft -support, fvwm loads the font -"-adobe-courier-bold-r-normal--14-*". This allows for writing -portable configuration files. - -
    - -
    -Font and string encoding -Once a font is loaded, fvwm finds its encoding (or charset) using -its name (the last two fields of the name). fvwm assumes that the -strings which are displayed with this font use this encoding (an -exception is that if an iso10646-1 font is loaded, then UTF-8 is -assumed for string encoding). -In a normal situation, -(i) a font is loaded by giving a font name without specifying the -encoding, -(ii) the encoding of the loaded font is the locale encoding, and -then -(iii) the strings in the fvwm configuration files should use the -locale encoding as well as the window and icon name. With Xft the -situation is bit different as Xft supports only iso10646-1 and -iso8859-1. If you do not specify one of these encodings in the Xft -font name, then fvwm does strings conversion using (iii). Note -that with multibyte fonts (and in particular with "CJK" fonts) for -good text rendering, the locale encoding should be the charset of -the font. - -To override the previous rules, it is possible to specify the -string encoding in the beginning of a font description as follow: - - -StringEncoding=enc:_full_font_name_ - - -where -enc -is an encoding supported by fvwm (usually font name charset plus some -unicode encodings: UTF-8, USC-2, USC-4 and UTF-16). - -For example, you may use an iso8859-1 locale charset and have an - in Russian using koi8-r encoding. In this case, you just -have to ask to load a koi8-r font by specifying the -encoding in the font name. With a multibyte language, (as -multibyte font works well only if the locale encoding is the -charset of the font), you should use an iso10646-1 font: - - -StringEncoding=jisx0208.1983-0:-*-fixed-medium-r-*-ja-*-iso10646-1 - - -or - - -"StringEncoding=jisx0208.1983-0:xft:Bitstream Cyberbit" - - -if your - -configuration uses jisx0208.1983-0 encoding. Another possibility -is to use UTF-8 encoding for your configuration and use -an iso10646-1 font: - - --*-fixed-medium-r-*-ja-*-iso10646-1 - - -or - - -"StringEncoding=UTF-8:xft:Bitstream Cyberbit" - - -or equivalently - - -"xft:Bitstream Cyberbit:encoding=iso10646-1" - - -In general iso10646-1 fonts together with UTF-8 string encoding -allows the display of any characters in a given menu, -etc. - -More and more, unicode is used and text files use UTF-8 -encoding. However, in practice the characters used range over your -locale charset (this is the case when you generate a menu with -fvwm-menu-desktop with recent versions of KDE and -GNOME). For -saving memory (an iso10646-1 font may have a very large number of -characters) or because you have a pretty font without an -iso10646-1 charset, you can specify the string encoding to be -UTF-8 and use a font in the locale charset: - - -StringEncoding=UTF-8:-*-pretty_font-*-12-* - - - -In most cases, fvwm correctly determines the encoding of the -font. However, some fonts do not end with valid encoding -names. When the font name isn't normal, for example: - - --misc-fixed-*--20-*-my_utf8-36 - - -you need to add the encoding after the font name using a slash as -a delimiter. For example: - - - * -misc-fixed-*--20-*-my_utf8-36/iso10646-1 - - -If fvwm finds an encoding, fvwm uses the iconv system functions to -do conversion between encodings. Unfortunately, there are no -standards. For conversion between iso8859-1 and UTF-8: a GNU -system uses "ISO-8859-1" and other systems use "iso881" to define -the converters (these two names are supported by fvwm). Moreover, -in some cases it may be necessary to use machine specific -converters. So, if you experience problems you can try to get -information on your iconv implementation ("man iconv" may help) -and put the name which defines the converter between the font -encoding and UTF-8 at the end of the font name after the encoding -hint and a / (another possible solution is to use GNU -libiconv). For example use: - - - * -misc-fixed-*--14-*-iso8859-1/*/latin1 - - -to use latin1 for defining the converter for the iso8859-1 encoding. -The "*" in between the "/" says to fvwm to determine the -encoding from the end of the font name. Use: - - - * \ - -misc-fixed-*--14-*-local8859-6/iso8859-6/local_iso8859_6_iconv - - -to force fvwm to use the font with iso8859-6 as the encoding -(this is useful for bi-directionality) -and to use local_iso8859_6_iconv for defining the converters. - -
    - -
    -Font Shadow Effects -Fonts can be given 3d effects. At the beginning of the font name -(or just after a possible StringEncoding specification) add - - -Shadow=size offset directions]: - - -size -is a positive integer which specifies the number of pixels of shadow. -offset -is an optional positive integer which defines the number of pixels -to offset the shadow from the edge of the character. The default -offset is zero. -directions -is an optional set of directions the shadow emanates from the -character. The -directions -are a space separated list of fvwm directions: - -N, North, Top, t, Up, u, - - -E, East, Right, r, Right, r, ] - -S, South, Bottom, b, Down, d, _ - -W, West, Left, l, Left, l, [ - -NE, NorthEast, TopRight, tr, UpRight, ur, ^ - -SE, SouthEast, BottomRight, br, DownRight, dr, > - -SW, SouthWest, BottomLeft, bl, DownLeft, dl, v - -NW, NorthWest, TopLeft, tl, UpLeft, ul, < - -C, Center, Centre, . - -A shadow is displayed in each given direction. -All -is equivalent to all the directions. The default -direction -is -BottomRight. -With the -Center -direction, the shadow surrounds the whole string. Since this is a -super set of all other directions, it is a waste of time to -specify this along with any other directions. - -The shadow effect only works with colorsets. The color of the -shadow is defined by using the - -option of the - -command. Please refer to the - -section for details about colorsets. - -Note: It can be difficult to find the font, -, and -colors to make this effect look good, but it can look quite good. - -
    -
    diff --git a/doc/fvwm/fvwm3.man.xml b/doc/fvwm/fvwm3.man.xml deleted file mode 100644 index dcda7a6d5..000000000 --- a/doc/fvwm/fvwm3.man.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - -%myents; -]> - -
    - - Fvwm3 &version; - Scott Smedley - fvwm3 - &releasedate; - - -
    -Name -Fvwm - F? Virtual Window Manager for X11 -
    - - - - - - - - - - - - - -
    -Gnome Compliance -Fvwm attempts to be GNOME (version 1) compliant. -Check http://www.gnome.org -for what that may mean. To disable GNOME hints for some -or all windows, the - -style can be used. -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    diff --git a/doc/fvwm/icccm.xml b/doc/fvwm/icccm.xml deleted file mode 100644 index 4bb219573..000000000 --- a/doc/fvwm/icccm.xml +++ /dev/null @@ -1,80 +0,0 @@ - - -%myents; -]> - -
    -ICCCM Compliance - -Fvwm attempts to be -ICCCM -2.0 compliant. Check -http://tronche.com/gui/x/icccm/ for more info. In addition, -ICCCM -states that it should be possible for applications to receive any -keystroke, which is not consistent with the keyboard shortcut -approach used in fvwm and most other window managers. In -particular you cannot have the same keyboard shortcuts working -with your fvwm and another fvwm running within Xnest (a nested X -server running in a window). The same problem exists with mouse -bindings. - -The -ICCCM -states that windows possessing the property - - -WM_HINTS(WM_HINTS): - Client accepts input or input focus: False - - -should not be given the keyboard input focus by the window -manager. These windows can take the input focus by themselves, -however. A number of applications set this property, and yet -expect the window manager to give them the keyboard focus anyway, -so fvwm provides a window style, -, -which allows fvwm to overlook this -ICCCM -rule. Even with this window style it is not guaranteed that the -application accepts focus. - -The differences between -ICCCM -1.1 and 2.0 include the ability to take over from a running -ICCCM -2.0 compliant window manager; thus - -fvwm; vi ~/.fvwm/config; fvwm -replace - -resembles the - -command. It is not exactly the same, since killing the previously -running wm may terminate your X session, if the wm was started as -the last client in your -.Xclients or .Xsession -file. - -Further additions are support for client-side colormap -installation (see the -ICCCM -for details) and the urgency hint. Clients can set this hint in -the WM_HINTS property of their window and expect the window manager -to attract the user's attention to the window. Fvwm has two re-definable -functions for this purpose, "UrgencyFunc" and "UrgencyDoneFunc", which -are executed when the flag is set/cleared. Their default definitions are: - - - UrgencyFunc - + I off - + I - + I - + I 5p 5p - UrgencyDoneFunc - + I - - -
    diff --git a/doc/fvwm/images.xml b/doc/fvwm/images.xml deleted file mode 100644 index 547250f81..000000000 --- a/doc/fvwm/images.xml +++ /dev/null @@ -1,453 +0,0 @@ - - - -%myents; -]> - -
    -Icons and Images -Fvwm can load .xbm, .xpm, -.png and -.svg images. XBM -images are monochrome. Fvwm can always display -XBM files. XPM -and PNG formats are color images. -SVG is a vector graphics image format. -Compile-time options determine whether fvwm can display -XPM, PNG or -SVG -icons and images. See the INSTALL.fvwm -file for more information. - - - -The related SHAPE -compile-time option can make fvwm display spiffy shaped icons. - - -
    -SVG rendering options - - -SVG images are generated from (XML) text files. A really simple SVG file -might look something like this: - - -<svg width="120" height="80"> - <rect fill="red" width="40" height="40" x="0" y="0" /> - <rect fill="lime" width="40" height="40" x="40" y="0" /> - <rect fill="blue" width="40" height="40" x="80" y="0" /> - <rect fill="cyan" width="40" height="40" x="0" y="40" /> - <rect fill="magenta" width="40" height="40" x="40" y="40" /> - <rect fill="yellow" width="40" height="40" x="80" y="40" /> -</svg> - - - - - - - image.svg - - - - - -By default, SVG images are rendered as the image creator intended -them to. But since SVG is a vector graphics format, the images can -be rendered at any chosen size and rotation, e.g. making it possible -to use the same icon file rendered at different sizes for the - and -styles. - -The rendering options are specified as a string appended to the SVG -filename as follows: - - - image.svg:!sizepositionrotationscale -widthx-height-+xpos-+ypos@-angle*/-factorxy - - - -The option string always starts with a colon (':') -to separate it from the filename. An empty option string can skip this -colon, but it might still be a good idea to include it to prevent -ambiguity if the filename contains any colon. - - -filename_without_colon.svg -filename:with:colon.svg: - - - -An exclamation point ('!') transposes the entire final -image (including the rendering area), i.e. all the horizontal and all the -vertical coordinates are swapped with each other. - - -image.svg:! - - - - - - - image.svg:! - - - - - -width and height -specifies the dimensions of the rendering area in pixels, i.e. the -dimensions of the resulting image. The actual image is fitted to fill -the entire rendering area. - - -image.svg:60x60 - - - - - - - image.svg:60x60 - - - - - -Use a width or height -value of 0 to keep the aspect ratio. - - -image.svg:0x60 -image.svg:60x0 - - - - - - - image.svg:0x60 - - - - - - - - image.svg:60x0 - - - - -A '-' before width -mirrors the rendering area horizontally. - - -image.svg:-0x0 - - -A '-' before height -mirrors the rendering area vertically. - - -image.svg:0x-0 - - - - - - - image.svg:0x-0 - - - - - -xpos and ypos -specifies a translation of the image in pixels. A positive -xpos value moves the image to the right. A -positive ypos value moves it down. Moving -it partially outside of the rendering area results in a cropped -image. - - -image.svg:-30-0 -image.svg:-0+10 -image.svg:-30+10 - - - - - - - image.svg:-30+10 - - - - - -angle specifies a rotation around the actual -image center in degrees. This might result in a cropped image. A -positive value rotates the image clockwise. Floating point values are -recognized. - - -image.svg:@180 -image.svg:@-90 -image.svg:@30 -image.svg:@57.3 - - - - - - - image.svg:@30 - - - - - -factor specifes a scaling of the actual -image (not the rendering area). Scaling it up results in a cropped -image. Floating point values are recognized. Division by zero is -ignored. If factor is directly followed -by a 'x' or a 'y', the scaling -is horizontal or vertical respectively. Otherwise the scaling is -uniform. - - -image.svg:*2 -image.svg:/2 -image.svg:/3x -image.svg:/2y - - - - - - - image.svg:*2 - - - - - - - - image.svg:/2 - - - - - - - - image.svg:/2y - - - - - -Scaling down a translated or rotated image can prevent cropping. - - -image.svg:@30*0.6 - - - - - - - image.svg:@30*0.6 - - - - - -Repeated usage of translation, rotation, and scaling is allowed. - Translation and rotation are additive. Scaling is multiplicative. - - -image.svg:*2/3 -image.svg:/3x/2y - - - - - - - image.svg:/3x/2y - - - - - -When combining affine transformations, the scaling is always done first, -then the rotation, and finally the translation. - - -image.svg:-30+10@30/3x/2y - - - - - - - image.svg:-30+10@30/3x/2y - - - - - -Use a negative scale factor to mirror the -actual image. - - -image.svg:-30+10@30/-3x/2y - - - - - - - image.svg:-30+10@30/-3x/2y - - - - - -Mirroring of the rendering area is done after any scaling, rotation or -translation of the image. - - -image.svg:-0x0-30+10@30/3x/2y - - - - - - - image.svg:-0x0-30+10@30/3x/2y - - - - - -Transposing is done last of all, after everything else. - - -image.svg:!-0x0-30+10@30/3x/2y - - - - - - - image.svg:!-0x0-30+10@30/3x/2y - - - - -
    -
    diff --git a/doc/fvwm/initialization.xml b/doc/fvwm/initialization.xml deleted file mode 100644 index 1c6ac1574..000000000 --- a/doc/fvwm/initialization.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - -
    -Initialization - -During initialization, fvwm searches for a configuration file -which describes key and button bindings, and many other -things. The format of these files is described later. Fvwm first -searches for configuration files using the command - - - config - - -This looks for file -config in $FVWM_USERDIR and $FVWM_DATADIR -directories, as described in -. If this fails more files are queried for backward -compatibility. Here is the complete list of all file locations -queried in the default installation (only the first found file -is used): - - -$HOME/.fvwm/config -/usr/local/share/fvwm/config - - - -$HOME/.fvwm/.fvwm2rc -$HOME/.fvwm2rc -/usr/local/share/fvwm/.fvwm2rc -/usr/local/share/fvwm/system.fvwm2rc -/etc/system.fvwm2rc - - -Please note, the last 5 locations are not guaranteed to be -supported in the future. - -If a configuration file is not found, the left mouse button, or -Help -or -F1 -keys on the root window bring up menus and forms that can create -a starting configuration file. - -Fvwm sets two environment variables which are inherited by its -children. These are -$DISPLAY -which describes the display on which fvwm is running. -$DISPLAY -may be -unix:0.0 -or -:0.0, -which doesn't work too well when passed through ssh to another -machine, so -$HOSTDISPLAY -is set to a network-ready description of the display. -$HOSTDISPLAY -always uses the TCP/IP transport protocol (even for a local -connection) so -$DISPLAY -should be used for local connections, as it may use Unix-domain -sockets, which are faster. - -If you want to start some applications or modules with fvwm, you -can simply put - - - app - - -or - - - FvwmXxx - - -into your -config, -but it is not recommended; do this only if you know what you are -doing. It is usually important to start applications or modules -after the entire config is read, because it contains styles or -module configurations which can affect window appearance and -functionality. - -The standard way to start applications or modules on fvwm's start -up is to add them to an initialization function (usually -StartFunction or InitFunction). -This way they are only started after fvwm finishes to read and -execute -config -file. - -Fvwm has three special functions for initialization: -StartFunction, -which is executed on startups and restarts; -InitFunction and RestartFunction, -which are executed during initialization and restarts -(respectively) just after StartFunction. These functions may be -customized in a user's -config -file using the - -command (described later) to start up modules, xterms, or whatever -you'd like to have started by fvwm. - -Fvwm has also a special exit function: -ExitFunction, -executed when exiting or restarting before actually quitting. -It could be used to explicitly kill modules, etc. - -If fvwm is run under a session manager, functions -SessionInitFunction and SessionRestartFunction -are executed instead of InitFunction and RestartFunction. -This helps to define the user's -config -file to be good for both running under a session manager and -without it. Generally it is a bad idea to start xterms or other -applications in "Session*" functions. Also someone can decide to -start different modules while running under a session manager or -not. For the similar purposes -SessionExitFunction -is used instead of ExitFunction. - - - StartFunction - StartFunction - + I * * - + I - - InitFunction - InitFunction - + I - + I - + I xsetroot -solid cyan - + I xterm - + I netscape - - RestartFunction - RestartFunction - + I - - SessionInitFunction - SessionInitFunction - + I - - SessionRestartFunction - SessionRestartFunction - + I - - -You do not need to define all special functions if some are empty. -Also note, all these special functions may be emulated now using -StartFunction and ExitFunction, -like this: - - - StartFunction - StartFunction -+ I (Init) -+ I * * -+ I (Restart) - - ExitFunction - ExitFunction -+ I (Quit) Bye-bye -+ I MyBuggyModule -+ I (ToRestart) - - -
    diff --git a/doc/fvwm/m4.xml b/doc/fvwm/m4.xml deleted file mode 100644 index a3e4cc896..000000000 --- a/doc/fvwm/m4.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -%myents; -]> - - - -
    -M4 Preprocessing -M4 pre-processing is handled by a module in fvwm. To get more -details, try man -. -In short, if you want fvwm to parse your files with m4, then -replace the command - -with - -in your -~/.fvwm/config -file (if it appears at all), and start fvwm with the command - - -fvwm -cmd " config" - - - -
    diff --git a/doc/fvwm/menus.xml b/doc/fvwm/menus.xml deleted file mode 100644 index 77229f2d6..000000000 --- a/doc/fvwm/menus.xml +++ /dev/null @@ -1,448 +0,0 @@ - - - -%myents; -]> - - - diff --git a/doc/fvwm/miscCommands.xml b/doc/fvwm/miscCommands.xml deleted file mode 100644 index 9e9d93ebb..000000000 --- a/doc/fvwm/miscCommands.xml +++ /dev/null @@ -1,49 +0,0 @@ - - -%myents; -]> - - - -
    -Miscellaneous Commands - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    diff --git a/doc/fvwm/moduleCommands.xml b/doc/fvwm/moduleCommands.xml deleted file mode 100644 index 4b613d93d..000000000 --- a/doc/fvwm/moduleCommands.xml +++ /dev/null @@ -1,50 +0,0 @@ - - -%myents; -]> - - - -
    -Module Commands - - -Fvwm maintains a database of module configuration lines in a form - - -*<ModuleName>: <Config-Resource> - - -where -<ModuleName> -is either a real module name or an alias. - -This database is initially filled from config file (or from -output of - -config command), and can be later modified either by user (via -) -or by modules. - -When modules are run, they read appropriate portion of database. -(The concept of this database is similar to one used in X resource -database). - -Commands for manipulating module configuration database are -described below. - - - - - - - - - - - - -
    diff --git a/doc/fvwm/modules.xml b/doc/fvwm/modules.xml deleted file mode 100644 index 7d0f719e0..000000000 --- a/doc/fvwm/modules.xml +++ /dev/null @@ -1,47 +0,0 @@ - - -%myents; -]> - -
    -Modules -A module is a separate program which runs as a separate Unix -process but transmits commands to fvwm to execute. Users can -write their own modules to do any weird or bizarre manipulations -without bloating or affecting the integrity of fvwm itself. - -Modules must be spawned by fvwm so that it can set up two pipes -for fvwm and the module to communicate with. The pipes are -already open for the module when it starts and the file -descriptors for the pipes are provided as command line arguments. - -Modules can be spawned by fvwm at any time during the X session by -use of the - -command. Modules can exist for the duration of the X -session, or can perform a single task and exit. If the module is -still active when fvwm is told to quit, then fvwm closes the -communication pipes and waits to receive a SIGCHLD from the -module, indicating that it has detected the pipe closure and has -exited. If modules fail to detect the pipe closure fvwm exits -after approximately 30 seconds anyway. The number of -simultaneously executing modules is limited by the operating -system's maximum number of simultaneously open files, usually -between 60 and 256. - -Modules simply transmit commands to the fvwm command -engine. Commands are formatted just as in the case of a -mouse binding in the -config -setup file. Certain auxiliary information is also transmitted, as -in the sample module -. - -Please refer to the - -section for details. - -
    diff --git a/doc/fvwm/multiScreen.xml b/doc/fvwm/multiScreen.xml deleted file mode 100644 index bb8dd186f..000000000 --- a/doc/fvwm/multiScreen.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - -
    -Use on Multi-Screen Displays -If the - -command line argument is not given, fvwm automatically starts up -on every screen on the specified display. After fvwm starts each -screen is treated independently. Restarts of fvwm need to be -performed separately on each screen. The use of - - - 0 0 - - -is strongly recommended for multi-screen displays. You may need -to quit on each screen to quit from the X session completely. -This is not to be confused with RandR support. - -
    diff --git a/doc/fvwm/mwm.xml b/doc/fvwm/mwm.xml deleted file mode 100644 index 0deb24497..000000000 --- a/doc/fvwm/mwm.xml +++ /dev/null @@ -1,19 +0,0 @@ - - -%myents; -]> - -
    -MWM Compatibility -Fvwm provides options to emulate Motif Window Manager (Mwm) as -well as possible. Please refer to the - -command as well as to the Mwm specific options of the - and - -commands for details. - -
    diff --git a/doc/fvwm/openLook.xml b/doc/fvwm/openLook.xml deleted file mode 100644 index 6b3447433..000000000 --- a/doc/fvwm/openLook.xml +++ /dev/null @@ -1,34 +0,0 @@ -
    -Open Look and XView Compatibility -Fvwm supports all the Open Look decoration hints (except -pushpins). Should you use any such application, please add the -following line to your config: - - - * - - -Most (perhaps all) Open Look applications have a strange notion of -keyboard focus handling. Although a lot of work went into fvwm to -work well with these, you may still encounter problems. It is -recommended to use the -focus policy and the -style for all such applications (the windows still get the -focus): - - - <application name> , - - -But in case you can not live with that focus policy, you can try -using one of the other focus policies in combination with the - style: - - - <application name> , - <application name> , - <application name> , - - - -
    diff --git a/doc/fvwm/options.xml b/doc/fvwm/options.xml deleted file mode 100644 index abd72d040..000000000 --- a/doc/fvwm/options.xml +++ /dev/null @@ -1,390 +0,0 @@ - - -%myents; -]> - - - -
    -Options - -These are the command line options that are recognized by fvwm: - - - - | - id - - - -This option is used when fvwm is started by a session -manager. Should not be used by a user. - - - - - | - config-command - - - -Causes fvwm to use -config-command -instead of -' -config' -(or ' -.fvwm2rc') -as its initialization command. (Note that up to 10 - and -parameters can be given, and they are executed in the order -specified.) - -Any module started by command line arguments is assumed to be a -module that sends back config commands. All command line modules -have to quit before fvwm proceeds on to the StartFunction and -setting border decorations and styles. There is a potential -deadlock if you start a module other than // -but there is a timeout so fvwm eventually gets going. - -As an example, starting the pager this way hangs fvwm until -the timeout, but the following should work well: - - -fvwm -c " StartFunction I " - - - - - - - | - displayname - - - -Manage the display called -displayname -instead of the name obtained from the environment variable -$DISPLAY. - - - - - | - - -Puts X transactions in synchronous mode, which dramatically slows -things down, but guarantees that fvwm's internal error messages -are correct. - - - - - - config-file - - -Causes fvwm to read -config-file -instead of -~/.fvwm/config -as its initialization file. $FVWM_USERDIR can also be used to -change location of default user directory ~/.fvwm. - - - - | - -A short usage description is printed. - - - - | - -Try to take over from a previously running wm. This does not work -unless the other wm is -ICCCM2 -2.0 compliant. - - - - - | - state-file - - - -This option is used when fvwm is started by a session manager. -Should not be used by a user. - - - - - | - screen_num - - - -On a multi-screen display, run fvwm only on the screen named in -the -$DISPLAY -environment variable or provided through the - -option. The optional argument -screen_num -should be positive or null and override the screen number. -Normally, fvwm attempts to start up on all screens of a -multi-screen display. - - - - | - -Prints the version of fvwm to -stderr. -Also prints an information about the compiled in support for -readline, rplay, xpm, png, svg, GNOME hints, EWMH hints, -session management, bidirectional text, multibyte characters, -RandR and Xft aa font rendering. - - - - - | - visual-class - - - -Causes fvwm to use -visual-class -for the window borders and menus. -visual-class -can be "StaticGray", "GrayScale", "StaticColor", "PseudoColor", -"TrueColor" or "DirectColor". - - - - - | - id - - - -Causes fvwm to use -id -as the visual id for the window borders and menus. -id -can be specified as N for decimal or 0xN for hexadecimal. See man -page of xdpyinfo for a list of supported visuals. - - - - - | - limit - - - -Specifies a limit on the colors -used in image, gradient and possibly simple colors used by -fvwm. In fact, fvwm (and all the modules) uses a palette with at -most limit colors. This option is only -useful with screens that display 256 colors (or less) with a -dynamic visual (PseudoColor, GrayScale or DirectColor). The -default depends on your X server and how you run fvwm. In most -case this default is reasonable. The option -should be used only if you encounter problems with colors. By -default, fvwm tries to detect large pre-allocated palettes. If -such a palette is detected fvwm uses it and a priori the - must not be used. Moreover, in this case the - and options are -forced. Note that XFree-4.2 pre-allocates 244 colors (if you use a -driver with Render support) leaving only a few free colors. This -may lead to some color problems (and nothing can be -done). XFree-4.3 or better pre-allocate only 85 colors. If no -pre-allocated palette is auto detected the defaults are as -follow: - - - - Display depth 8 (256 colors) - - - PseudoColor: 68 (4x4x4 color cube + 4 grey) - GrayScale: 64 regular grey - DirectColor: 32 (3x3x3 color cube + 5 grey) - - - - - Display depth 4 (16 colors) - - - PseudoColor: 10 (2x2x2 color cube + 2 grey) - GrayScale: 8 regular grey - DirectColor: 10 (2x2x2 color cube + 2 grey) - - - - - -Note that if -you use a private color map (i.e., fvwm is started with the - or the options), then -other defaults are used. - -Now what to do if you encounter problems with colors? The first -thing to do is to check if you really cannot run your X server -with depth 15, 16 or better. Check your X server -documentation. Note that some hardware can support two different -depths on the same screen (typically depth 8 and depth 24). If -depth 8 is the default, you can force fvwm to use the best depth -by using the - -option with -TrueColor -as argument. So now we assume that you are forced to run in depth -8 with a dynamic visual because your hardware/driver cannot do -better or because you need to use an application which needs to -run under this mode (e.g., because this application needs -read-write colors). What it should be understand is that you have -only 256 colors and that all the applications which use the -default color map must share these colors. The main problem is -that there are applications which use a lot or even all the -colors. If you use such application you may have no more free -colors and some applications (which used only a few colors) may -fail to start or are unusable. There are three things that can be -done (and fvwm does not really play a particular role, all -applications are concerned). The first is to run the applications -which waste your (default) color map with a private color map. For -example, run netscape with the -install option, run KDE -or QT -applications with the --cmap option, use the - -option for fvwm. The disadvantage of this method is that it is -visually disturbing (see the - -command for a better control of the color maps switching). The -second method is to limit the number of colors that the -applications use. Again, some applications have options to -specify a given color limit. With fvwm you may try various values, -61 (a special "visual" palette), 56 (a 4x4x3 color cube plus 6 -grey), 29 (a 3x3x3 color cube plus 2 grey), 10 or 9. Also, you may -use the - -option. However, limiting the number of colors is not the -definitive solution. The definitive solution is to try cause -applications which use a lot of colors use the same colors. This -is a difficult task as there are no formal standards for this -goal. However, some toolkits as QT and -GTK use color cubes as -palettes. So, the idea is to configure your applications/toolkits -to all use the same color cube. Moreover, you can use the colors -in this color cube in your X resources configuration files and/or -as arguments to colors options. -Fvwm can use any color cube of the form RxGxB with 2 <= R <= 6, R -= G, R-1 =< B <= R and B >= 2. To get an RxGxB color cube give an -argument to - -an integer c >= R*G*B and < (R+1)*(G+1)*B if B=R and < R*G*(B+1) -if B < R (and different from 61). If c > R*G*B, then some grey may -be added to the color cube. You can use the - -Colors -1 -command to get information on your fvwm colors setting. In -particular, this command prints the palette used by fvwm in rgb -format (the last integer gives the number of times fvwm has -allocated the colors). - - - - | - -If the screen displays 256 colors (or less) and has a dynamic visual, -causes fvwm to use its palette for all the colors. By default, the -palette is used only for images and gradients. - - - - | - -If the screen displays 256 colors (or less) and has a dynamic -visual, this option causes fvwm to use a palette designed for -limiting the "visual" color distance between the points of the -palette. Moreover, for better color sharing, if possible colors -with a name in the X rgb data base are used for defining the -colors (with the hope that applications and images prefer to -use named colors). If the - -option is not used this palette has 61 colors. This palette is -also automatically selected if 61 or 9 is used as argument to the - -option. - - - - | - -If the screen displays 256 colors (or less) and has a dynamic -visual this option causes fvwm to allocate all the colors of its -palette at start up for reserving these colors for future -use. This option forces the - -option. By default, fvwm allocates (reserves) a color in its palette -only if it needs this color. - - - - | - -If the screen displays 256 colors (or less) and has a dynamic -visual this option causes fvwm to never free the colors in its -palette. By default, when fvwm does not need a color any more it -frees this color so that a new color can be used. This option may -speed up image loading and save a few bits of memory. - - - - - -This option is provided for backward compatibility only. Blacking -out the screen during startup is not necessary (and doesn't work) -anymore. This option will be removed in the future. - - - - - -Enables stack ring debugging. This option is only intended for -internal debugging and should only be used by developers. - - - - - - -Enables debug logging. Writes in append mode to fvwm log file, -which is ~/.fvwm/fvwm3-output.log by default. See ENVIRONMENT section on -how to override this location on fvwm3 startup using -$FVWM_USERDIR or $FVWM3_LOGFILE . - - - Logging can also be dynamically toggled on and off using signals: - - - : used as a signal to restart Fvwm - : used as a signal to toggle opening/closing debug log file - - - - - - - - -
    diff --git a/doc/fvwm/quoting.xml b/doc/fvwm/quoting.xml deleted file mode 100644 index e78ca2f1b..000000000 --- a/doc/fvwm/quoting.xml +++ /dev/null @@ -1,38 +0,0 @@ - - -%myents; -]> - - - -
    -Quoting - -Quotes are required only when needed to make fvwm consider two or -more words to be a single argument. Unnecessary quoting is -allowed. If you want a quote character in your text, you must -escape it by using the backslash character. For example, if you -have a pop-up menu called "Window-Ops", then you do not need -quotes: - - - Window-Ops - - -but if you replace the dash with a space, then you need -quotes: - - - "Window Ops" - - -The supported quoting characters are double quotes, single quotes -and reverse single quotes. All three kinds of quotes are treated -in the same way. Single characters can be quoted with a preceding -backslash. Quoting single characters works even inside other -kinds of quotes. - -
    diff --git a/doc/fvwm/randr.xml b/doc/fvwm/randr.xml deleted file mode 100644 index a1009522d..000000000 --- a/doc/fvwm/randr.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - -
    -RandR Support -Fvwm supports the RandR X11 protocol. If Fvwm has been compiled -wiith RandR support then it tracks the outputs (displays) which it finds. -These outputs are stored by name, which can be found by running using -the xrand(1) command. - -In doing so, Fvwm tracks events from RandR, such as when a given -output changes size, or has been removed. In such cases, Fvwm will -react by moving windows. If an output is removed, those windows on that -removed output will be moved to the next active output (the output which -contains the mouse pointer). If the same output reappears, Fvwm will -move those windows back again. - -Desktop Behaviour - -Because Fvwm has the capability to track outputs, Fvwm can be told how to -handle those. This is controlled via the -command. By default, Fvwm treats all outputs it finds as one large screen, -although Fvwm can be told to treat screens indepedantly of each other. - -
    diff --git a/doc/fvwm/scripting.xml b/doc/fvwm/scripting.xml deleted file mode 100644 index c7ea00c8d..000000000 --- a/doc/fvwm/scripting.xml +++ /dev/null @@ -1,39 +0,0 @@ - - -%myents; -]> - - - -
    -Scripting & Complex Functions - -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 -, -from the output of a command with - -or written as a complex function with the - -command. For the curious, section 7 of the fvwm FAQ shows some -real life applications of scripting. Please refer to the sections - -and - -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 - -or - -command instead. - -
    diff --git a/doc/fvwm/sections b/doc/fvwm/sections deleted file mode 100644 index 367067c88..000000000 --- a/doc/fvwm/sections +++ /dev/null @@ -1,49 +0,0 @@ -authors -bidirText -bindings -booleanArgs -bugs -builtinBindings -colorGradients -colorsets -commands -compilation -conditionals -configuration -copyright -cpp -description -environment -ewmh -execution -expansion -focus -fonts -fvwm3.man -icccm -images -initialization -m4 -menus -miscCommands -moduleCommands -modules -multiScreen -mwm -openLook -options -quoting -randr -scripting -session -sessionCommands -shortcuts -styleCommands -synopsis -userFunctions -virtualDesktop -virtualDesktopCommands -windowAnatomy -windowMovement -windowState -windowStyles diff --git a/doc/fvwm/session.xml b/doc/fvwm/session.xml deleted file mode 100644 index a3df40da1..000000000 --- a/doc/fvwm/session.xml +++ /dev/null @@ -1,51 +0,0 @@ - - -%myents; -]> - - - -
    -Session Management -Fvwm supports session management according to the X Session -Management Protocol. It saves and restores window position, size, -stacking order, desk, stickiness, shadiness, maximizedness, -iconifiedness for all windows. Furthermore, some global state is -saved. - -Fvwm doesn't save any information regarding styles, decors, -functions or menus. If you change any of these resources during a -session (e.g. by issuing - -commands or by using various modules), these changes are lost -after saving and restarting the session. To become permanent, -such changes have to be added to the configuration file. - -Note further that the current implementation has the following -anomaly when used on a multi-screen display: Starting fvwm for the -first time, fvwm manages all screens by forking a copy of itself -for each screen. Every copy knows its parent and issuing a - -command to any instance of fvwm kills the master and thus all -copies of fvwm. When you save and restart the session, the -session manager brings up a copy of fvwm on each screen, but this -time they are started as individual instances managing one screen -only. Thus a - -kills only the copy it was sent to. This is probably not a very -serious problem, since with session management, you are supposed -to quit a session through the session manager anyway. If it is -really needed, - - - exec killall fvwm - - -still kills all copies of fvwm. Your system must have the -killall -command though. - -
    diff --git a/doc/fvwm/sessionCommands.xml b/doc/fvwm/sessionCommands.xml deleted file mode 100644 index c2165168d..000000000 --- a/doc/fvwm/sessionCommands.xml +++ /dev/null @@ -1,21 +0,0 @@ - - - -%myents; -]> - - -
    -Session Management Commands - - - - - - - - -
    diff --git a/doc/fvwm/shortcuts.xml b/doc/fvwm/shortcuts.xml deleted file mode 100644 index fbb938590..000000000 --- a/doc/fvwm/shortcuts.xml +++ /dev/null @@ -1,42 +0,0 @@ - - -%myents; -]> - - - -
    -Keyboard Shortcuts -Almost all window manager operations can be performed from the -keyboard so mouse-less operation should be possible. In addition -to scrolling around the virtual desktop by binding the - -command to appropriate keys, -, -, -, -and any other command can be bound to keys. Once a command -is started the pointer is moved by using the up, down, -left, and right arrows, and the action is terminated by pressing -return. Holding down the -Shift -key causes the pointer movement to go in larger steps and holding -down the -control -key causes the pointer movement to go in smaller steps. Standard -emacs and vi cursor movement controls ( -n, -p, -f, -b, -and -j, -k, -h, -l -) can be used instead of the arrow keys. - -
    diff --git a/doc/fvwm/styleCommands.xml b/doc/fvwm/styleCommands.xml deleted file mode 100644 index a27b7dd53..000000000 --- a/doc/fvwm/styleCommands.xml +++ /dev/null @@ -1,25 +0,0 @@ - - -%myents; -]> - - - -
    -Controlling Window Styles - -For readability, the commands in this section are not sorted alphabetically. -The description of the command can be found at the end of this section. - - - - - - - - - -
    diff --git a/doc/fvwm/synopsis.xml b/doc/fvwm/synopsis.xml deleted file mode 100644 index b59ad0f78..000000000 --- a/doc/fvwm/synopsis.xml +++ /dev/null @@ -1,101 +0,0 @@ - - -%myents; -]> - -
    -Synopsis - - - fvwm3config-commanddisplaynameconfig-filescreen_numvisual-classvisual-idcolorsclient-idstate-file - -
    diff --git a/doc/fvwm/userFunctions.xml b/doc/fvwm/userFunctions.xml deleted file mode 100644 index 81f2d9e1f..000000000 --- a/doc/fvwm/userFunctions.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -%myents; -]> - - - -
    -User Functions and Shell Commands - - - - - - - - - - - - - - - - - - - - -
    diff --git a/doc/fvwm/virtualDesktop.xml b/doc/fvwm/virtualDesktop.xml deleted file mode 100644 index ea4407b68..000000000 --- a/doc/fvwm/virtualDesktop.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - -
    -The Virtual Desktop -Fvwm provides multiple virtual desktops for users who wish to use -them. The screen is a viewport onto a -desktop -which may be larger than the screen. Several distinct desktops -can be accessed (concept: one desktop for each project, or one -desktop for each application, when view applications are -distinct). Since each desktop can be larger than the physical -screen, divided into m by n -pages -which are each the size of the physical screen, windows which are -larger than the screen or large groups of related windows can -easily be viewed. - -The (m by n) size (i.e. number of pages) of the virtual desktops -can be changed any time, by using the - -command. All virtual desktops must be (are) the same -size. The total number of distinct desktops does not need to be -specified, but is limited to approximately 4 billion total. All -windows on a range of desktops can be viewed in the -, -a miniature view of the desktops. The pager is an accessory -program, called a module, which is not essential for the window -manager to operate. Windows may also be listed using the - -command or the - -module. - -Fvwm keeps the windows on the desktop in a layered stacking order; -a window in a lower layer never obscures a window in a higher -layer. The layer of a window can be changed by using the - -command. The concept of layers is a generalization of the - -flag of older fvwm versions. The - and - - -options are now implemented by putting the windows in suitable -layers and the previously missing - - -option has been added. - - - -windows are windows which transcend the virtual desktop by -"Sticking to the screen's glass". They always stay put on the -screen. This is convenient for things like clocks and xbiffs, so -you only need to run one such gadget and it always stays with you. -Icons can also be made to stick to the glass, if desired. - -Window geometries are specified relative to the current viewport. -That is: - -xterm -geometry +0+0 - -creates a window in the upper left hand corner of the visible -portion of the screen. It is permissible to specify geometries -which place windows on the virtual desktop, but off the screen. -For example, if the visible screen is 1000 by 1000 pixels, and the -desktop size is 3x3, and the current viewport is at the upper left -hand corner of the desktop, invoking: - -xterm -geometry +1000+1000 - -places a window just off of the lower right hand corner of the -screen. It can be found by moving the mouse to the lower right -hand corner of the screen and waiting for it to scroll into view. -A geometry specified as something like: - -xterm -geometry -5-5 - -places the window's lower right hand corner 5 pixels from the -lower right corner of the visible portion of the screen. Not all -applications support window geometries with negative offsets. -Some applications place the window's upper right hand corner 5 -pixels above and to the left of the upper left hand corner of the -screen; others may do just plain bizarre things. - -There are several ways to cause a window to map onto a desktop or -page other than the currently active one. The geometry technique -mentioned above (specifying x,y coordinates larger than the -physical screen size), however, suffers from the limitation of -being interpreted relative to the current viewport: the window may -not consistently appear on a specific page, unless you always -invoke the application from the same page. - -A better way to place windows on a different page, screen or desk -from the currently mapped viewport is to use the - or - -style specification (the successors to the older - -style) in your -config -file. The placement is consistent: it does -not depend on your current location on the virtual desktop. - -Some applications that understand standard Xt command line -arguments and X resources, like xterm and xfontsel, allow the user -to specify the start-up desk or page on the command line: - -xterm -xrm "*Desk:1" - -starts an xterm on desk number 1; - -xterm -xrm "*Page:3 2 1" - -starts an xterm two pages to the right and one down from the upper -left hand page of desk number 3. Not all applications understand -the use of these options, however. You could achieve the same -results with the following lines in your -.Xdefaults -file: - -XTerm*Desk: 1 - -or - -XTerm*Page: 3 2 1 - -
    diff --git a/doc/fvwm/virtualDesktopCommands.xml b/doc/fvwm/virtualDesktopCommands.xml deleted file mode 100644 index f3cf302ed..000000000 --- a/doc/fvwm/virtualDesktopCommands.xml +++ /dev/null @@ -1,28 +0,0 @@ - - -%myents; -]> - - - -
    -Controlling the Virtual Desktop - - - - - - - - - - - - - - - -
    diff --git a/doc/fvwm/windowAnatomy.xml b/doc/fvwm/windowAnatomy.xml deleted file mode 100644 index 791cafce4..000000000 --- a/doc/fvwm/windowAnatomy.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - -
    -Anatomy of a Window - -Fvwm puts a decorative border around most windows. This border -consists of a bar on each side and a small L-shaped section on -each corner. There is an additional top bar called the title-bar -which is used to display the name of the window. In addition, -there are up to 10 title-bar buttons. The top, side, and bottom -bars are collectively known as the side-bars. The corner pieces -are called the frame. - -With the built-in minimal configuration, dragging mouse button 1 -in the frame or side-bars begins a resize operation on the window. -Dragging mouse button 2 in the frame or side-bars begins a move -operation. There are raise/lower operations bound to a single -clicking on borders. Similarly for the window title. - -Up to ten title-bar buttons may exist. Their use is completely -user definable. One popular configuration uses one button on the -left that is used to bring up a list of window options and two -buttons on the right used to iconify and maximize the window. -Another popular configuration adds a close button to the right. -The number of title-bar buttons used depends on which ones have -mouse actions bound to them. See the - -command. - -
    diff --git a/doc/fvwm/windowMovement.xml b/doc/fvwm/windowMovement.xml deleted file mode 100644 index 8716ee9aa..000000000 --- a/doc/fvwm/windowMovement.xml +++ /dev/null @@ -1,40 +0,0 @@ - - -%myents; -]> - - - -
    -Window Movement and Placement - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    diff --git a/doc/fvwm/windowState.xml b/doc/fvwm/windowState.xml deleted file mode 100644 index b2f427c4b..000000000 --- a/doc/fvwm/windowState.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -%myents; -]> - - - -
    -Window State - - - - - - - - - - - - - - -
    diff --git a/doc/fvwm/windowStyles.xml b/doc/fvwm/windowStyles.xml deleted file mode 100644 index 327113381..000000000 --- a/doc/fvwm/windowStyles.xml +++ /dev/null @@ -1,26 +0,0 @@ - - -%myents; -]> - - - -
    -Window Styles - - - - - - - - - - - - - -
    diff --git a/doc/fvwm3-man.xsl b/doc/fvwm3-man.xsl deleted file mode 100644 index 128ca67e6..000000000 --- a/doc/fvwm3-man.xsl +++ /dev/null @@ -1,601 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ... - - - - - - - - - - - ' - ' - - - - - - .SH - - - - - - - - - - .SS - - - - - - - - - - - - - - - .TP - .B - - .RS - - .\" - - - - - - - .RE - - - - - - - .RE - - .TP - - .RS - - .\" - - - - - - - - - - .nf - .IP "" - - - - - - - - - - - - - .fi - - - - - .SM - - - - - - - - - - - - - - - - \fI - - \fR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - . - - - - - - - - - - - - - - - - - - - - - - - - .PP - - - - - - - - - - - - - - - - - - - - - - - - - - - - \fB - - \fR - - - \fI - - \fR - - - \fB - - - - - - - - - - \fR - - - - - - - - .sp - .RS - - - - .nf - - - .fi - .RE - .PP - - - - - - <xsl:value-of select="artheader/titleabbrev"/> - -
    - 1 -
    - - - - - - - - -     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - MAN.MANIFEST - - - - - - - - - - - - - - - - - - - - - - - Note: No article elements found in " - - - - - - ... - - - - - - - " - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -     - - diff --git a/doc/fvwm3.ent.in b/doc/fvwm3.ent.in deleted file mode 100755 index e6fd7781d..000000000 --- a/doc/fvwm3.ent.in +++ /dev/null @@ -1,6 +0,0 @@ - - - - - -FIXME"> diff --git a/doc/fvwm3.xsl b/doc/fvwm3.xsl deleted file mode 100644 index 343bb946e..000000000 --- a/doc/fvwm3.xsl +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - - - - - - - - - - - - - # - - - - - - _ - - - - - - - - - - - - - - - - - - - - ../commands/ - - - - ../modules/ - - - - ../fvwm/fvwm.man - - - - - .html - - # - - - - _ - - - - _ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - _ - - - - - - - - - - - - - - - - - - diff --git a/doc/fvwm3/fvwm3.adoc b/doc/fvwm3/fvwm3.adoc new file mode 100644 index 000000000..658a32fd4 --- /dev/null +++ b/doc/fvwm3/fvwm3.adoc @@ -0,0 +1,9491 @@ += FVWM3(1) + +== NAME + +fvwm3 - F? Virtual Window Manager for X11 + +== SYNOPSIS + +*fvwm3* [*-c* _config-command_] [*-d* _displayname_] [*-f* +_config-file_] [*-r*] [*-s* [_screen_num_]] [*-V*] [*-C* _visual-class_ +| *-I* _visual-id_] [*-l* _colors_ [*-L*] [*-A*] [*-S*] [*-P*]] [*-D*] +[*-h*] [*-i* _client-id_] [*-F* _state-file_] [*--debug-stack-ring*] +[*-blackout*] + +== DESCRIPTION + +Fvwm is a window manager for X11. It is designed to minimize memory +consumption, provide a 3D look to window frames, and a virtual desktop. + +Note that there are several window managers around that have "fvwm" in +their name. Fvwm3 is the successor to fvwm2, which preceded the 1.x +versions of fvwm. This version is simply called fvwm throughout this +document, while the main executable is named fvwm3. + +Fvwm is intended to have a small memory footprint but a rich feature +set, be extremely customizable and extendible, and have a high degree of +Motif mwm compatibility. Fvwm provides both a large _virtual desktop_ +and _multiple disjoint desktops_ which can be used separately or +together. The virtual desktop allows you to pretend that your video +screen is really quite large, and you can scroll around within the +desktop. The multiple disjoint desktops allow you to pretend that you +really have several screens to work at, but each screen is completely +unrelated to the others. + +Fvwm provides _keyboard accelerators_ that allow you to perform most +window manager functions, including moving and resizing windows and +operating the menus, using keyboard shortcuts. + +Fvwm has also overcome the distinction between configuration commands +and action commands that most window managers make. Configuration +commands typically set fonts, colors, menu contents, and key and mouse +function bindings, while action commands do things like raise and lower +windows. Fvwm makes no such distinction and allows anything to be +changed at any time. + +Other noteworthy differences between fvwm and other X11 window managers +are the introduction of the _SloppyFocus_ and _NeverFocus_ focus +methods. Focus policy can be separately specified for different window +groups. Windows using _SloppyFocus_ acquire focus when the pointer moves +into them and retain focus until some other window acquires it. Such +windows do not lose focus when the pointer moves into the root window. +The _NeverFocus_ policy is provided for use with windows into which one +never types (e.g. xclock, oclock, xbiff, xeyes, tuxeyes) - for example, +if a SloppyFocus terminal window has focus, moving the pointer over a +NeverFocus decoration window does not deprive the terminal of focus. + +== OPTIONS + +These are the command line options that are recognized by fvwm: + +*-i* | *--clientid* _id_:: + +This option is used when fvwm is started by a session manager. Should +not be used by a user. + +*-c* | *--cmd* _config-command_:: + +Causes fvwm to use _config-command_ instead of '*Read* _config_' (or +'*Read* _.fvwm2rc_') as its initialization command. (Note that up to 10 +*-f* and *-c* parameters can be given, and they are executed in the +order specified.) ++ +Any module started by command line arguments is assumed to be a module +that sends back config commands. All command line modules have to quit +before fvwm proceeds on to the StartFunction and setting border +decorations and styles. There is a potential deadlock if you start a +module other than *FvwmCpp*/*FvwmM4*/*FvwmPerl* but there is a timeout +so fvwm eventually gets going. ++ +As an example, starting the pager this way hangs fvwm until the timeout, +but the following should work well: + +.... +fvwm -c "AddToFunc StartFunction I Module FvwmPager" +.... + +*-d* | *--display* _displayname_:: + +Manage the display called _displayname_ instead of the name obtained +from the environment variable _$DISPLAY_. + +*-D* | *--debug*:: + +Puts X transactions in synchronous mode, which dramatically slows things +down, but guarantees that fvwm's internal error messages are correct. + +*-f* _config-file_:: + +Causes fvwm to read _config-file_ instead of _~/.fvwm/config_ as its +initialization file. _$FVWM_USERDIR_ can also be used to change location +of default user directory _~/.fvwm_. + +*-h* | *--help*:: + +A short usage description is printed. + +*-r* | *--replace*:: + +Try to take over from a previously running wm. This does not work unless +the other wm is ICCCM2 2.0 compliant. + +*-F* | *--restore* _state-file_:: + +This option is used when fvwm is started by a session manager. Should +not be used by a user. + +*-s* | *--single-screen* [_screen_num_]:: + +On a multi-screen display, run fvwm only on the screen named in the +_$DISPLAY_ environment variable or provided through the *-d* option. The +optional argument _screen_num_ should be positive or null and override +the screen number. Normally, fvwm attempts to start up on all screens of +a multi-screen display. + +*-V* | *--version*:: + +Prints the version of fvwm to _stderr_. Also prints an information about +the compiled in support for readline, rplay, xpm, png, svg, GNOME hints, +EWMH hints, session management, bidirectional text, multibyte +characters, RandR and Xft aa font rendering. + +*-C* | *--visual* _visual-class_:: + +Causes fvwm to use _visual-class_ for the window borders and menus. +_visual-class_ can be "StaticGray", "GrayScale", "StaticColor", +"PseudoColor", "TrueColor" or "DirectColor". + +*-I* | *--visualid* _id_:: + +Causes fvwm to use _id_ as the visual id for the window borders and +menus. _id_ can be specified as N for decimal or 0xN for hexadecimal. +See man page of xdpyinfo for a list of supported visuals. + +*-l* | *--color-limit* _limit_:: + +Specifies a _limit_ on the colors used in image, gradient and possibly +simple colors used by fvwm. In fact, fvwm (and all the modules) uses a +palette with at most _limit_ colors. This option is only useful with +screens that display 256 colors (or less) with a dynamic visual +(PseudoColor, GrayScale or DirectColor). The default depends on your X +server and how you run fvwm. In most case this default is reasonable. +The *-l* option should be used only if you encounter problems with +colors. By default, fvwm tries to detect large pre-allocated palettes. +If such a palette is detected fvwm uses it and a priori the *-l* must +not be used. Moreover, in this case the *-A* and *-S* options are +forced. Note that XFree-4.2 pre-allocates 244 colors (if you use a +driver with Render support) leaving only a few free colors. This may +lead to some color problems (and nothing can be done). XFree-4.3 or +better pre-allocate only 85 colors. If no pre-allocated palette is auto +detected the defaults are as follow: ++ +Display depth 8 (256 colors) ++ +.... +PseudoColor: 68 (4x4x4 color cube + 4 grey) +GrayScale: 64 regular grey +DirectColor: 32 (3x3x3 color cube + 5 grey) +.... ++ +Display depth 4 (16 colors) ++ +.... +PseudoColor: 10 (2x2x2 color cube + 2 grey) +GrayScale: 8 regular grey +DirectColor: 10 (2x2x2 color cube + 2 grey) +.... ++ +Note that if you use a private color map (i.e., fvwm is started with the +*-C* or the *-I* options), then other defaults are used. ++ +Now what to do if you encounter problems with colors? The first thing to +do is to check if you really cannot run your X server with depth 15, 16 +or better. Check your X server documentation. Note that some hardware +can support two different depths on the same screen (typically depth 8 +and depth 24). If depth 8 is the default, you can force fvwm to use the +best depth by using the *-C* option with _TrueColor_ as argument. So now +we assume that you are forced to run in depth 8 with a dynamic visual +because your hardware/driver cannot do better or because you need to use +an application which needs to run under this mode (e.g., because this +application needs read-write colors). What it should be understand is +that you have only 256 colors and that all the applications which use +the default color map must share these colors. The main problem is that +there are applications which use a lot or even all the colors. If you +use such application you may have no more free colors and some +applications (which used only a few colors) may fail to start or are +unusable. There are three things that can be done (and fvwm does not +really play a particular role, all applications are concerned). The +first is to run the applications which waste your (default) color map +with a private color map. For example, run netscape with the -install +option, run KDE or QT applications with the --cmap option, use the *-C* +option for fvwm. The disadvantage of this method is that it is visually +disturbing (see the *ColormapFocus* command for a better control of the +color maps switching). The second method is to limit the number of +colors that the applications use. Again, some applications have options +to specify a given color limit. With fvwm you may try various values, 61 +(a special "visual" palette), 56 (a 4x4x3 color cube plus 6 grey), 29 (a +3x3x3 color cube plus 2 grey), 10 or 9. Also, you may use the *-L* +option. However, limiting the number of colors is not the definitive +solution. The definitive solution is to try cause applications which use +a lot of colors use the same colors. This is a difficult task as there +are no formal standards for this goal. However, some toolkits as QT and +GTK use color cubes as palettes. So, the idea is to configure your +applications/toolkits to all use the same color cube. Moreover, you can +use the colors in this color cube in your X resources configuration +files and/or as arguments to colors options. Fvwm can use any color cube +of the form RxGxB with 2 <= R <= 6, R = G, R-1 =< B <= R and B >= 2. To +get an RxGxB color cube give an argument to *-l* an integer c >= R*G*B +and < (R+1)*(G+1)*B if B=R and < R*G*(B+1) if B < R (and different from +61). If c > R*G*B, then some grey may be added to the color cube. You +can use the *PrintInfo* _Colors_ [_1_] command to get information on +your fvwm colors setting. In particular, this command prints the palette +used by fvwm in rgb format (the last integer gives the number of times +fvwm has allocated the colors). + +*-L* | *--strict-color-limit*:: + +If the screen displays 256 colors (or less) and has a dynamic visual, +causes fvwm to use its palette for all the colors. By default, the +palette is used only for images and gradients. + +*-P* | *--visual-palette*:: + +If the screen displays 256 colors (or less) and has a dynamic visual, +this option causes fvwm to use a palette designed for limiting the +"visual" color distance between the points of the palette. Moreover, for +better color sharing, if possible colors with a name in the X rgb data +base are used for defining the colors (with the hope that applications +and images prefer to use named colors). If the *-l* option is not used +this palette has 61 colors. This palette is also automatically selected +if 61 or 9 is used as argument to the *-l* option. + +*-A* | *--allocate-palette*:: + +If the screen displays 256 colors (or less) and has a dynamic visual +this option causes fvwm to allocate all the colors of its palette at +start up for reserving these colors for future use. This option forces +the *-static-palette* option. By default, fvwm allocates (reserves) a +color in its palette only if it needs this color. + +*-S* | *--static-palette*:: + +If the screen displays 256 colors (or less) and has a dynamic visual +this option causes fvwm to never free the colors in its palette. By +default, when fvwm does not need a color any more it frees this color so +that a new color can be used. This option may speed up image loading and +save a few bits of memory. + +*-blackout*:: + +This option is provided for backward compatibility only. Blacking out +the screen during startup is not necessary (and doesn't work) anymore. +This option will be removed in the future. + +*--debug-stack-ring*:: + +Enables stack ring debugging. This option is only intended for internal +debugging and should only be used by developers. + +*-v*:: + +Enables debug logging. Writes in append mode to fvwm log file, which is +~/.fvwm/fvwm3-output.log by default. See ENVIRONMENT section on how to +override this location on fvwm3 startup using _$FVWM_USERDIR_ or +_$FVWM3_LOGFILE_ . ++ +Logging can also be dynamically toggled on and off using signals: ++ +.... +SIGUSR1 : used as a signal to restart Fvwm +SIGUSR2 : used as a signal to toggle opening/closing debug log file +.... + +== ANATOMY OF A WINDOW + +Fvwm puts a decorative border around most windows. This border consists +of a bar on each side and a small L-shaped section on each corner. There +is an additional top bar called the title-bar which is used to display +the name of the window. In addition, there are up to 10 title-bar +buttons. The top, side, and bottom bars are collectively known as the +side-bars. The corner pieces are called the frame. + +With the built-in minimal configuration, dragging mouse button 1 in the +frame or side-bars begins a resize operation on the window. Dragging +mouse button 2 in the frame or side-bars begins a move operation. There +are raise/lower operations bound to a single clicking on borders. +Similarly for the window title. + +Up to ten title-bar buttons may exist. Their use is completely user +definable. One popular configuration uses one button on the left that is +used to bring up a list of window options and two buttons on the right +used to iconify and maximize the window. Another popular configuration +adds a close button to the right. The number of title-bar buttons used +depends on which ones have mouse actions bound to them. See the *Mouse* +command. + +== THE VIRTUAL DESKTOP + +Fvwm provides multiple virtual desktops for users who wish to use them. +The screen is a viewport onto a _desktop_ which may be larger than the +screen. Several distinct desktops can be accessed (concept: one desktop +for each project, or one desktop for each application, when view +applications are distinct). Since each desktop can be larger than the +physical screen, divided into m by n _pages_ which are each the size of +the physical screen, windows which are larger than the screen or large +groups of related windows can easily be viewed. + +The (m by n) size (i.e. number of pages) of the virtual desktops can be +changed any time, by using the *DesktopSize* command. All virtual +desktops must be (are) the same size. The total number of distinct +desktops does not need to be specified, but is limited to approximately +4 billion total. All windows on a range of desktops can be viewed in the +*FvwmPager*, a miniature view of the desktops. The pager is an accessory +program, called a module, which is not essential for the window manager +to operate. Windows may also be listed using the *WindowList* command or +the *FvwmIconMan* module. + +Fvwm keeps the windows on the desktop in a layered stacking order; a +window in a lower layer never obscures a window in a higher layer. The +layer of a window can be changed by using the *Layer* command. The +concept of layers is a generalization of the _StaysOnTop_ flag of older +fvwm versions. The _StaysOnTop_ and _StaysPut_ *Style* options are now +implemented by putting the windows in suitable layers and the previously +missing _StaysOnBottom_ *Style* option has been added. + +_Sticky_ windows are windows which transcend the virtual desktop by +"Sticking to the screen's glass". They always stay put on the screen. +This is convenient for things like clocks and xbiffs, so you only need +to run one such gadget and it always stays with you. Icons can also be +made to stick to the glass, if desired. + +Window geometries are specified relative to the current viewport. That +is: + +.... +xterm -geometry +0+0 +.... + +creates a window in the upper left hand corner of the visible portion of +the screen. It is permissible to specify geometries which place windows +on the virtual desktop, but off the screen. For example, if the visible +screen is 1000 by 1000 pixels, and the desktop size is 3x3, and the +current viewport is at the upper left hand corner of the desktop, +invoking: + +.... +xterm -geometry +1000+1000 +.... + +places a window just off of the lower right hand corner of the screen. +It can be found by moving the mouse to the lower right hand corner of +the screen and waiting for it to scroll into view. A geometry specified +as something like: + +.... +xterm -geometry -5-5 +.... + +places the window's lower right hand corner 5 pixels from the lower +right corner of the visible portion of the screen. Not all applications +support window geometries with negative offsets. Some applications place +the window's upper right hand corner 5 pixels above and to the left of +the upper left hand corner of the screen; others may do just plain +bizarre things. + +There are several ways to cause a window to map onto a desktop or page +other than the currently active one. The geometry technique mentioned +above (specifying x,y coordinates larger than the physical screen size), +however, suffers from the limitation of being interpreted relative to +the current viewport: the window may not consistently appear on a +specific page, unless you always invoke the application from the same +page. + +A better way to place windows on a different page, screen or desk from +the currently mapped viewport is to use the _StartsOnPage_ or +_StartsOnScreen_ style specification (the successors to the older +_StartsOnDesk_ style) in your _config_ file. The placement is +consistent: it does not depend on your current location on the virtual +desktop. + +Some applications that understand standard Xt command line arguments and +X resources, like xterm and xfontsel, allow the user to specify the +start-up desk or page on the command line: + +.... +xterm -xrm "*Desk:1" +.... + +starts an xterm on desk number 1; + +.... +xterm -xrm "*Page:3 2 1" +.... + +starts an xterm two pages to the right and one down from the upper left +hand page of desk number 3. Not all applications understand the use of +these options, however. You could achieve the same results with the +following lines in your _.Xdefaults_ file: + +.... +XTerm*Desk: 1 +.... + +or + +.... +XTerm*Page: 3 2 1 +.... + +== USE ON MULTI-SCREEN DISPLAYS + +If the *-s* command line argument is not given, fvwm automatically +starts up on every screen on the specified display. After fvwm starts +each screen is treated independently. Restarts of fvwm need to be +performed separately on each screen. The use of + +.... +EdgeScroll 0 0 +.... + +is strongly recommended for multi-screen displays. You may need to quit +on each screen to quit from the X session completely. This is not to be +confused with RandR support. + +== RANDR SUPPORT + +Fvwm supports the RandR X11 protocol. If Fvwm has been compiled wiith +RandR support then it tracks the outputs (displays) which it finds. +These outputs are stored by name, which can be found by running using +the xrand(1) command. + +In doing so, Fvwm tracks events from RandR, such as when a given output +changes size, or has been removed. In such cases, Fvwm will react by +moving windows. If an output is removed, those windows on that removed +output will be moved to the next active output (the output which +contains the mouse pointer). If the same output reappears, Fvwm will +move those windows back again. + +== DESKTOP BEHAVIOUR + +Because Fvwm has the capability to track outputs, Fvwm can be told how +to handle those. This is controlled via the *DesktopConfiguration* +command. By default, Fvwm treats all outputs it finds as one large +screen, although Fvwm can be told to treat screens indepedantly of each +other. + +== INITIALIZATION + +During initialization, fvwm searches for a configuration file which +describes key and button bindings, and many other things. The format of +these files is described later. Fvwm first searches for configuration +files using the command + +.... +Read config +.... + +This looks for file _config_ in _$FVWM_USERDIR_ and _$FVWM_DATADIR_ +directories, as described in *Read*. If this fails more files are +queried for backward compatibility. Here is the complete list of all +file locations queried in the default installation (only the first found +file is used): + +.... +$HOME/.fvwm/config +/usr/local/share/fvwm/config + +$HOME/.fvwm/.fvwm2rc +$HOME/.fvwm2rc +/usr/local/share/fvwm/.fvwm2rc +/usr/local/share/fvwm/system.fvwm2rc +/etc/system.fvwm2rc +.... + +Please note, the last 5 locations are not guaranteed to be supported in +the future. + +If a configuration file is not found, the left mouse button, or + +or + +keys on the root window bring up menus and forms that can create a +starting configuration file. + +Fvwm sets two environment variables which are inherited by its children. +These are _$DISPLAY_ which describes the display on which fvwm is +running. _$DISPLAY_ may be _unix:0.0_ or _:0.0_, which doesn't work too +well when passed through ssh to another machine, so _$HOSTDISPLAY_ is +set to a network-ready description of the display. _$HOSTDISPLAY_ always +uses the TCP/IP transport protocol (even for a local connection) so +_$DISPLAY_ should be used for local connections, as it may use +Unix-domain sockets, which are faster. + +If you want to start some applications or modules with fvwm, you can +simply put + +.... +Exec app +.... + +or + +.... +Module FvwmXxx +.... + +into your _config_, but it is not recommended; do this only if you know +what you are doing. It is usually important to start applications or +modules after the entire config is read, because it contains styles or +module configurations which can affect window appearance and +functionality. + +The standard way to start applications or modules on fvwm's start up is +to add them to an initialization function (usually *StartFunction* or +*InitFunction*). This way they are only started after fvwm finishes to +read and execute _config_ file. + +Fvwm has three special functions for initialization: *StartFunction*, +which is executed on startups and restarts; *InitFunction* and +*RestartFunction*, which are executed during initialization and restarts +(respectively) just after StartFunction. These functions may be +customized in a user's _config_ file using the *AddToFunc* command +(described later) to start up modules, xterms, or whatever you'd like to +have started by fvwm. + +Fvwm has also a special exit function: *ExitFunction*, executed when +exiting or restarting before actually quitting. It could be used to +explicitly kill modules, etc. + +If fvwm is run under a session manager, functions *SessionInitFunction* +and *SessionRestartFunction* are executed instead of InitFunction and +RestartFunction. This helps to define the user's _config_ file to be +good for both running under a session manager and without it. Generally +it is a bad idea to start xterms or other applications in "Session*" +functions. Also someone can decide to start different modules while +running under a session manager or not. For the similar purposes +*SessionExitFunction* is used instead of ExitFunction. + +.... +DestroyFunc StartFunction +AddToFunc StartFunction + + I Module FvwmPager * * + + I Module FvwmButtons + +DestroyFunc InitFunction +AddToFunc InitFunction + + I Module FvwmBanner + + I Module FvwmIconMan + + I Exec xsetroot -solid cyan + + I Exec xterm + + I Exec netscape + +DestroyFunc RestartFunction +AddToFunc RestartFunction + + I Module FvwmIconMan + +DestroyFunc SessionInitFunction +AddToFunc SessionInitFunction + + I Module FvwmBanner + +DestroyFunc SessionRestartFunction +AddToFunc SessionRestartFunction + + I Nop +.... + +You do not need to define all special functions if some are empty. Also +note, all these special functions may be emulated now using +*StartFunction* and *ExitFunction,* like this: + +.... +DestroyFunc StartFunction +AddToFunc StartFunction ++ I Test (Init) Module FvwmBanner ++ I Module FvwmPager * * ++ I Test (Restart) Beep + +DestroyFunc ExitFunction +AddToFunc ExitFunction ++ I Test (Quit) Echo Bye-bye ++ I KillModule MyBuggyModule ++ I Test (ToRestart) Beep +.... + +== COMPILATION OPTIONS + +Fvwm has a number of compile-time options. If you have trouble using a +certain command or feature, check to see if support for it was included +at compile time. Optional features are described in the _config.h_ file +that is generated during compilation. + +== ICONS AND IMAGES + +Fvwm can load *.xbm,* *.xpm,* *.png* and *.svg* images. *XBM* images are +monochrome. Fvwm can always display *XBM* files. *XPM* and *PNG* formats +are color images. SVG is a vector graphics image format. Compile-time +options determine whether fvwm can display *XPM*, *PNG* or *SVG* icons +and images. See the _INSTALL.fvwm_ file for more information. + +The related *SHAPE* compile-time option can make fvwm display spiffy +shaped icons. + +=== SVG rendering options + +SVG images are generated from (XML) text files. A really simple SVG file +might look something like this: + +.... + + + + + + + + +.... + +By default, SVG images are rendered as the image creator intended them +to. But since SVG is a vector graphics format, the images can be +rendered at any chosen size and rotation, e.g. making it possible to use +the same icon file rendered at different sizes for the _Icon_ and +_MiniIcon_ styles. + +The rendering options are specified as a string appended to the SVG +filename as follows: + +.... +_image.svg_:[!] [(1) _size_] [(2) _position_] [(3) _rotation_] [(4) +_scale_] ... + +{empty}(1) [-]_width_{x}[-]_height_ + +{empty}(2) {- | +}_xpos_{- | +}_ypos_ + +{empty}(3) @[-]_angle_ + +{empty}(4) {* | }[-]_factor_[x | y] +.... + +The option string always starts with a colon (':') to separate it from +the filename. An empty option string can skip this colon, but it might +still be a good idea to include it to prevent ambiguity if the filename +contains any colon. + +.... +filename_without_colon.svg +filename:with:colon.svg: +.... + +An exclamation point ('!') transposes the entire final image (including +the rendering area), i.e. all the horizontal and all the vertical +coordinates are swapped with each other. + +.... +image.svg:! +.... + +_width_ and _height_ specifies the dimensions of the rendering area in +pixels, i.e. the dimensions of the resulting image. The actual image is +fitted to fill the entire rendering area. + +.... +image.svg:60x60 +.... + +Use a _width_ or _height_ value of 0 to keep the aspect ratio. + +.... +image.svg:0x60 +image.svg:60x0 +.... + +A '-' before _width_ mirrors the rendering area horizontally. + +.... +image.svg:-0x0 +.... + +A '-' before _height_ mirrors the rendering area vertically. + +.... +image.svg:0x-0 +.... + +_xpos_ and _ypos_ specifies a translation of the image in pixels. A +positive _xpos_ value moves the image to the right. A positive _ypos_ +value moves it down. Moving it partially outside of the rendering area +results in a cropped image. + +.... +image.svg:-30-0 +image.svg:-0+10 +image.svg:-30+10 +.... + +_angle_ specifies a rotation around the actual image center in degrees. +This might result in a cropped image. A positive value rotates the image +clockwise. Floating point values are recognized. + +.... +image.svg:@180 +image.svg:@-90 +image.svg:@30 +image.svg:@57.3 +.... + +_factor_ specifes a scaling of the actual image (not the rendering +area). Scaling it up results in a cropped image. Floating point values +are recognized. Division by zero is ignored. If _factor_ is directly +followed by a 'x' or a 'y', the scaling is horizontal or vertical +respectively. Otherwise the scaling is uniform. + +.... +image.svg:*2 +image.svg:/2 +image.svg:/3x +image.svg:/2y +.... + +Scaling down a translated or rotated image can prevent cropping. + +.... +image.svg:@30*0.6 +.... + +Repeated usage of translation, rotation, and scaling is allowed. +Translation and rotation are additive. Scaling is multiplicative. + +.... +image.svg:*2/3 +image.svg:/3x/2y +.... + +When combining affine transformations, the scaling is always done first, +then the rotation, and finally the translation. + +.... +image.svg:-30+10@30/3x/2y +.... + +Use a negative scale _factor_ to mirror the actual image. + +.... +image.svg:-30+10@30/-3x/2y +.... + +Mirroring of the rendering area is done after any scaling, rotation or +translation of the image. + +.... +image.svg:-0x0-30+10@30/3x/2y +.... + +Transposing is done last of all, after everything else. + +.... +image.svg:!-0x0-30+10@30/3x/2y +.... + +== MODULES + +A module is a separate program which runs as a separate Unix process but +transmits commands to fvwm to execute. Users can write their own modules +to do any weird or bizarre manipulations without bloating or affecting +the integrity of fvwm itself. + +Modules must be spawned by fvwm so that it can set up two pipes for fvwm +and the module to communicate with. The pipes are already open for the +module when it starts and the file descriptors for the pipes are +provided as command line arguments. + +Modules can be spawned by fvwm at any time during the X session by use +of the *Module* command. Modules can exist for the duration of the X +session, or can perform a single task and exit. If the module is still +active when fvwm is told to quit, then fvwm closes the communication +pipes and waits to receive a SIGCHLD from the module, indicating that it +has detected the pipe closure and has exited. If modules fail to detect +the pipe closure fvwm exits after approximately 30 seconds anyway. The +number of simultaneously executing modules is limited by the operating +system's maximum number of simultaneously open files, usually between 60 +and 256. + +Modules simply transmit commands to the fvwm command engine. Commands +are formatted just as in the case of a mouse binding in the _config_ +setup file. Certain auxiliary information is also transmitted, as in the +sample module *FvwmButtons*. + +Please refer to the *Module Commands* section for details. + +== ICCCM COMPLIANCE + +Fvwm attempts to be ICCCM 2.0 compliant. Check +_http://tronche.com/gui/x/icccm/_ for more info. In addition, ICCCM +states that it should be possible for applications to receive any +keystroke, which is not consistent with the keyboard shortcut approach +used in fvwm and most other window managers. In particular you cannot +have the same keyboard shortcuts working with your fvwm and another fvwm +running within Xnest (a nested X server running in a window). The same +problem exists with mouse bindings. + +The ICCCM states that windows possessing the property + +.... +WM_HINTS(WM_HINTS): +Client accepts input or input focus: False +.... + +should not be given the keyboard input focus by the window manager. +These windows can take the input focus by themselves, however. A number +of applications set this property, and yet expect the window manager to +give them the keyboard focus anyway, so fvwm provides a window style, +_Lenience_, which allows fvwm to overlook this ICCCM rule. Even with +this window style it is not guaranteed that the application accepts +focus. + +The differences between ICCCM 1.1 and 2.0 include the ability to take +over from a running ICCCM 2.0 compliant window manager; thus + +.... +fvwm; vi ~/.fvwm/config; fvwm -replace +.... + +resembles the *Restart* command. It is not exactly the same, since +killing the previously running wm may terminate your X session, if the +wm was started as the last client in your _.Xclients_ or _.Xsession_ +file. + +Further additions are support for client-side colormap installation (see +the ICCCM for details) and the urgency hint. Clients can set this hint +in the WM_HINTS property of their window and expect the window manager +to attract the user's attention to the window. Fvwm has two re-definable +functions for this purpose, "UrgencyFunc" and "UrgencyDoneFunc", which +are executed when the flag is set/cleared. Their default definitions +are: + +.... +AddToFunc UrgencyFunc + + I Iconify off + + I FlipFocus + + I Raise + + I WarpToWindow !raise 5p 5p +AddToFunc UrgencyDoneFunc + + I Nop +.... + +== GNOME COMPLIANCE + +Fvwm attempts to be GNOME (version 1) compliant. Check +_http://www.gnome.org_ for what that may mean. To disable GNOME hints +for some or all windows, the _GNOMEIgnoreHints_ style can be used. + +== EXTENDED WINDOW MANAGER HINTS + +Fvwm attempts to respect the extended window manager hints (ewmh or EWMH +for short) specification: +_https://specifications.freedesktop.org/wm-spec/wm-spec-1.3.html_ and +some extensions of this specification. This allows fvwm to work with KDE +version >= 2, GNOME version 2 and other applications which respect this +specification (any application based on _GTK+_ version 2). Applications +which respect this specification are called ewmh compliant applications. + +This support is configurable with styles and commands. These styles and +commands have EWMH as the prefix (so you can find them easily in this +man page). + +There is a new Context 'D' for the *Key*, *PointerKey*, *Mouse* +commands. This context is for desktop applications (such as kdesktop and +Nautilus desktop). + +When a compliant taskbar asks fvwm to activate a window (typically when +you click on a button which represents a window in such a taskbar), then +fvwm calls the complex function *EWMHActivateWindowFunc* which by +default is Iconify Off, Focus and Raise. You can redefine this function. +For example: + +.... +DestroyFunc EWMHActivateWindowFunc +AddToFunc EWMHActivateWindowFunc I Iconify Off ++ I Focus ++ I Raise ++ I WarpToWindow 50 50 +.... + +additionally warps the pointer to the center of the window. + +The EWMH specification introduces the notion of Working Area. Without +ewmh support the Working Area is the full visible screen (or all your +screens if you have a multi head setup with RandR). However, compliant +applications (such as a panel) can ask to reserve space at the edge of +the screen. If this is the case, the Working Area is your full visible +screen minus these reserved spaces. If a panel can be hidden by clicking +on a button the Working Area does not change (as you can unhide the +panel at any time), but the Dynamic Working Area is updated: the space +reserved by the panel is removed (and added again if you pop up the +panel). The Dynamic Working Area may be used when fvwm places or +maximizes a window. To know if an application reserves space you can +type "xprop | grep _NET_WM_STRUT" in a terminal and select the +application. If four numbers appear then these numbers define the +reserved space as explained in the *EwmhBaseStruts* command. + +== MWM COMPATIBILITY + +Fvwm provides options to emulate Motif Window Manager (Mwm) as well as +possible. Please refer to the *Emulate* command as well as to the Mwm +specific options of the *Style* and *MenuStyle* commands for details. + +== OPEN LOOK AND XVIEW COMPATIBILITY + +Fvwm supports all the Open Look decoration hints (except pushpins). +Should you use any such application, please add the following line to +your config: + +.... +Style * OLDecor +.... + +Most (perhaps all) Open Look applications have a strange notion of +keyboard focus handling. Although a lot of work went into fvwm to work +well with these, you may still encounter problems. It is recommended to +use the _NeverFocus_ focus policy and the _Lenience_ style for all such +applications (the windows still get the focus): + +.... +Style NeverFocus, Lenience +.... + +But in case you can not live with that focus policy, you can try using +one of the other focus policies in combination with the _Lenience_ +style: + +.... +Style MouseFocus, Lenience +Style SloppyFocus, Lenience +Style ClickToFocus, Lenience +.... + +== CONFIGURATION + +=== Configuration Files + +The configuration file is used to describe mouse and button bindings, +colors, the virtual display size, and related items. The initialization +configuration file is typically called _config_ (or _.fvwm2rc_). By +using the *Read* command, it is easy to read in new configuration files +as you go. + +Lines beginning with '#' are ignored by fvwm. Lines starting with '*' +are expected to contain module configuration commands (rather than +configuration commands for fvwm itself). Like in shell scripts embedded +newlines in a configuration file line can be quoted by preceding them +with a backslash. All lines linked in this fashion are treated as a +single line. The newline itself is ignored. + +Fvwm makes no distinction between configuration commands and action +commands, so anything mentioned in the fvwm commands section can be +placed on a line by itself for fvwm to execute as it reads the +configuration file, or it can be placed as an executable command in a +menu or bound to a mouse button or a keyboard key. It is left as an +exercise for the user to decide which function make sense for +initialization and which ones make sense for run-time. + +=== Supplied Configuration + +A sample configuration file, is supplied with the fvwm distribution. It +is well commented and can be used as a source of examples for fvwm +configuration. It may be copied from _/usr/local/share/fvwm/config_ +file. + +Alternatively, the built-in menu (accessible when no configuration file +is found) has options to create an initial config file for the user. + +== FONTS + +=== Font names and font loading + +The fonts used for the text of a window title, icon titles, menus and +geometry window can be specified by using the Font and IconFont *Style*, +the Font *MenuStyle* and the *DefaultFont* commands. Also, all the +Modules which use text have configuration command(s) to specify font(s). +All these styles and commands take a font name as an argument. This +section explains what is a font name for fvwm and which fonts fvwm +loads. + +First, you can use what we can call a usual font name, for example, + +.... +-adobe-courier-bold-r-normal--10-100-75-75-m-60-ISO8859-1 +-adobe-courier-bold-r-normal--10-* +-*-fixed-medium-o-normal--14-*-ISO8859-15 +.... + +That is, you can use an X Logical Font Description (XLFD for short). +Then the "first" font which matches the description is loaded and used. +This "first" font depends of your font path and also of your locale. +Fonts which match the locale charset are loaded in priority order. For +example with + + +.... +-adobe-courier-bold-r-normal--10-* +.... + + +if the locale charset is ISO8859-1, then fvwm tries to load a font which +matches + +.... +-adobe-courier-bold-r-normal--10-*-ISO8859-1 +.... + +with the locale charset ISO8859-15 fvwm tries to load + +.... +-adobe-courier-bold-r-normal--10-*-ISO8859-15. +.... + +A font name can be given as an extended XLFD. This is a comma separated +list of (simple) XLFD font names, for example: + +.... +-adobe-courier-bold-r-normal--14-*,-*-courier-medium-r-normal--14-* +.... + +Each simple font name is tried until a matching font with the locale +charset is found and if this fails each simple font name is tried +without constraint on the charset. + +More details on the XLFD can be found in the X manual page, the X +Logical Font Description Conventions document (called xlfd) and the +XLoadFont and XCreateFontSet manual pages. Some useful font utilities +are: xlsfonts, xfontsel, xfd and xset. + +If you have Xft support you can specify an Xft font name (description) +of a true type (or Type1) font prefixed by "xft:", for example: + +.... +"xft:Luxi Mono" +"xft:Luxi Mono:Medium:Roman:size=14:encoding=iso8859-1" +.... + +The "first" font which matches the description is loaded. This first +font depends on the XftConfig configuration file with Xft1 and on the +/etc/fonts/fonts.conf file with Xft2. One may read the Xft manual page +and the fontconfig man page with Xft2. The first string which follows +"xft:" is always considered as the family. With the second example Luxi +Mono is the Family (Other XFree TTF families: "Luxi Serif", "Luxi +Sans"), Medium is the Weight (other possible weights: Light, DemiBold, +Bold, Black), Roman is the slant or the style (other possibilities: +Regular, Oblique, Italic) size specifies the point size (for a pixel +size use pixelsize=), encoding allows for enforce a charset (iso8859-1 +or iso10646-1 only; if no encoding is given the locale charset is +assumed). An important parameter is "minspace=bool" where bool is True +or False. If bool is False (the default?) Xft gives a greater font +height to fvwm than if bool is True. This may modify text placement, +icon and window title height, line spacing in menus and *FvwmIdent*, +button height in some fvwm modules ...etc. With a LCD monitor you may +try to add "rgba=mode" where mode is either rgb, bgr, vrgb or vbgr to +enable subpixel rendering. The best mode depends on the way your LCD +cells are arranged. You can pass other specifications in between ":", as +"foundry=foundry_name", "spacing=type" where type can be monospace, +proportional or charcell, "charwidth=integer", "charheight=integer" or +"antialias=bool" where bool is True or False. It seems that these +parameters are not always taken in account. + +To determine which Xft fonts are really loaded you can export +XFT_DEBUG=1 before starting fvwm and take a look to the error log. With +Xft2 you may use fc-list to list the available fonts. Anyway, Xft +support is experimental (from the X and the fvwm point of view) and the +quality of the rendering depends on number of parameters (the XFree and +the freetype versions and your video card(s)). + +After an Xft font name you can add after a ";" an XLFD font name (simple +or extended) as: + +.... +xft:Verdana:pixelsize=14;-adobe-courier-bold-r-normal--14-* +.... + +then, if either loading the Xft font fails or fvwm has no Xft support, +fvwm loads the font "-adobe-courier-bold-r-normal--14-*". This allows +for writing portable configuration files. + +=== Font and string encoding + +Once a font is loaded, fvwm finds its encoding (or charset) using its +name (the last two fields of the name). fvwm assumes that the strings +which are displayed with this font use this encoding (an exception is +that if an iso10646-1 font is loaded, then UTF-8 is assumed for string +encoding). In a normal situation, (i) a font is loaded by giving a font +name without specifying the encoding, (ii) the encoding of the loaded +font is the locale encoding, and then (iii) the strings in the fvwm +configuration files should use the locale encoding as well as the window +and icon name. With Xft the situation is bit different as Xft supports +only iso10646-1 and iso8859-1. If you do not specify one of these +encodings in the Xft font name, then fvwm does strings conversion using +(iii). Note that with multibyte fonts (and in particular with "CJK" +fonts) for good text rendering, the locale encoding should be the +charset of the font. + +To override the previous rules, it is possible to specify the string +encoding in the beginning of a font description as follow: + +.... +StringEncoding=enc:_full_font_name_ +.... + +where _enc_ is an encoding supported by fvwm (usually font name charset +plus some unicode encodings: UTF-8, USC-2, USC-4 and UTF-16). + +For example, you may use an iso8859-1 locale charset and have an +*FvwmForm* in Russian using koi8-r encoding. In this case, you just have +to ask *FvwmForm* to load a koi8-r font by specifying the encoding in +the font name. With a multibyte language, (as multibyte font works well +only if the locale encoding is the charset of the font), you should use +an iso10646-1 font: + +.... +StringEncoding=jisx0208.1983-0:-*-fixed-medium-r-*-ja-*-iso10646-1 +.... + +or + +.... +"StringEncoding=jisx0208.1983-0:xft:Bitstream Cyberbit" +.... + +if your *FvwmForm* configuration uses jisx0208.1983-0 encoding. Another +possibility is to use UTF-8 encoding for your *FvwmForm* configuration +and use an iso10646-1 font: + +.... +-*-fixed-medium-r-*-ja-*-iso10646-1 +.... + +or + +.... +"StringEncoding=UTF-8:xft:Bitstream Cyberbit" +.... + + +or equivalently + +.... +"xft:Bitstream Cyberbit:encoding=iso10646-1" +.... + +In general iso10646-1 fonts together with UTF-8 string encoding allows +the display of any characters in a given menu, *FvwmForm* etc. + +More and more, unicode is used and text files use UTF-8 encoding. +However, in practice the characters used range over your locale charset +(this is the case when you generate a menu with fvwm-menu-desktop with +recent versions of KDE and GNOME). For saving memory (an iso10646-1 font +may have a very large number of characters) or because you have a pretty +font without an iso10646-1 charset, you can specify the string encoding +to be UTF-8 and use a font in the locale charset: + +.... +StringEncoding=UTF-8:-*-pretty_font-*-12-* +.... + +In most cases, fvwm correctly determines the encoding of the font. +However, some fonts do not end with valid encoding names. When the font +name isn't normal, for example: + +.... +-misc-fixed-*--20-*-my_utf8-36 +.... + +you need to add the encoding after the font name using a slash as a +delimiter. For example: + + +.... +MenuStyle * Font -misc-fixed-*--20-*-my_utf8-36/iso10646-1 +.... + +If fvwm finds an encoding, fvwm uses the iconv system functions to do +conversion between encodings. Unfortunately, there are no standards. For +conversion between iso8859-1 and UTF-8: a GNU system uses "ISO-8859-1" +and other systems use "iso881" to define the converters (these two names +are supported by fvwm). Moreover, in some cases it may be necessary to +use machine specific converters. So, if you experience problems you can +try to get information on your iconv implementation ("man iconv" may +help) and put the name which defines the converter between the font +encoding and UTF-8 at the end of the font name after the encoding hint +and a / (another possible solution is to use GNU libiconv). For example +use: + +.... +Style * Font -misc-fixed-*--14-*-iso8859-1/*/latin1 +.... + +to use latin1 for defining the converter for the iso8859-1 encoding. The +"*" in between the "/" says to fvwm to determine the encoding from the +end of the font name. Use: + +.... +Style * Font \ +-misc-fixed-*--14-*-local8859-6/iso8859-6/local_iso8859_6_iconv +.... + +to force fvwm to use the font with iso8859-6 as the encoding (this is +useful for bi-directionality) and to use local_iso8859_6_iconv for +defining the converters. + +=== Font Shadow Effects + +Fonts can be given 3d effects. At the beginning of the font name (or +just after a possible StringEncoding specification) add + +.... +Shadow=size [offset] [directions]]: +.... + +_size_ is a positive integer which specifies the number of pixels of +shadow. _offset_ is an optional positive integer which defines the +number of pixels to offset the shadow from the edge of the character. +The default offset is zero. _directions_ is an optional set of +directions the shadow emanates from the character. The _directions_ are +a space separated list of fvwm directions: + +_N_, _North_, _Top_, _t_, _Up_, _u_, _-_ + +_E_, _East_, _Right_, _r_, _Right_, _r_, _]_ + +_S_, _South_, _Bottom_, _b_, _Down_, _d_, ___ + +_W_, _West_, _Left_, _l_, _Left_, _l_, _[_ + +_NE_, _NorthEast_, _TopRight_, _tr_, _UpRight_, _ur_, _^_ + +_SE_, _SouthEast_, _BottomRight_, _br_, _DownRight_, _dr_, _>_ + +_SW_, _SouthWest_, _BottomLeft_, _bl_, _DownLeft_, _dl_, _v_ + +_NW_, _NorthWest_, _TopLeft_, _tl_, _UpLeft_, _ul_, _<_ + +_C_, _Center_, _Centre_, _._ + +A shadow is displayed in each given direction. _All_ is equivalent to +all the directions. The default _direction_ is _BottomRight_. With the +_Center_ direction, the shadow surrounds the whole string. Since this is +a super set of all other directions, it is a waste of time to specify +this along with any other directions. + +The shadow effect only works with colorsets. The color of the shadow is +defined by using the _fgsh_ option of the *Colorset* command. Please +refer to the *Colorsets* section for details about colorsets. + +Note: It can be difficult to find the font, _fg_, _fgsh_ and _bg_ colors +to make this effect look good, but it can look quite good. + +== BI-DIRECTIONAL TEXT + +Arabic and Hebrew text require bi-directional text support to be +displayed correctly, this means that logical strings should be converted +before their visual presentation, so left-to-right and right-to-left +sub-strings are determined and reshuffled. In fvwm this is done +automatically in window titles, menus, module labels and other places if +the fonts used for displaying the text are of one of the charsets that +require _bidi_ (bi-directional) support. For example, this includes +iso8859-6, iso8859-8 and iso10646-1 (unicode), but not other iso8859-* +fonts. + +This bi-directional text support is done using the _fribidi_ library +compile time option, see _INSTALL.fvwm_. + +== KEYBOARD SHORTCUTS + +Almost all window manager operations can be performed from the keyboard +so mouse-less operation should be possible. In addition to scrolling +around the virtual desktop by binding the *Scroll* command to +appropriate keys, *Popup*, *Move*, *Resize*, and any other command can +be bound to keys. Once a command is started the pointer is moved by +using the up, down, left, and right arrows, and the action is terminated +by pressing return. Holding down the Shift key causes the pointer movement to +go in larger steps and holding down the control key causes the pointer movement +to go in smaller steps. Standard emacs and vi cursor movement controls can be +used instead of the arrow keys. + +== SESSION MANAGEMENT + +Fvwm supports session management according to the X Session Management +Protocol. It saves and restores window position, size, stacking order, +desk, stickiness, shadiness, maximizedness, iconifiedness for all +windows. Furthermore, some global state is saved. + +Fvwm doesn't save any information regarding styles, decors, functions or +menus. If you change any of these resources during a session (e.g. by +issuing *Style* commands or by using various modules), these changes are +lost after saving and restarting the session. To become permanent, such +changes have to be added to the configuration file. + +Note further that the current implementation has the following anomaly +when used on a multi-screen display: Starting fvwm for the first time, +fvwm manages all screens by forking a copy of itself for each screen. +Every copy knows its parent and issuing a *Quit* command to any instance +of fvwm kills the master and thus all copies of fvwm. When you save and +restart the session, the session manager brings up a copy of fvwm on +each screen, but this time they are started as individual instances +managing one screen only. Thus a *Quit* kills only the copy it was sent +to. This is probably not a very serious problem, since with session +management, you are supposed to quit a session through the session +manager anyway. If it is really needed, + +.... +Exec exec killall fvwm +.... + +still kills all copies of fvwm. Your system must have the *killall* +command though. + +== BOOLEAN ARGUMENTS + +A number of commands take one or several boolean arguments. These take a +few equivalent inputs: "yes", "on", "true", "t" and "y" all evaluate to +true while "no", "off", "false", "f" and "n" evaluate to false. Some +commands allow "toggle" too which means that the feature is disabled if +it is currently enabled and vice versa. + +== BUILTIN KEY AND MOUSE BINDINGS + +The following commands are built-in to fvwm: + +.... +Key Help R A Popup MenuFvwmRoot +Key F1 R A Popup MenuFvwmRoot +Key Tab A M WindowList Root c c NoDeskSort +Key Escape A MC EscapeFunc + +Mouse 1 R A Menu MenuFvwmRoot +Mouse 1 T A FuncFvwmRaiseLowerX Move +Mouse 1 FS A FuncFvwmRaiseLowerX Resize +Mouse 2 FST A FuncFvwmRaiseLowerX Move + +AddToFunc FuncFvwmRaiseLowerX ++ I Raise ++ M $0 ++ D Lower +.... + + +The Help and F1 keys invoke a built-in menu that fvwm creates. This is +primarily for new users that have not created their own configuration file. +Either key on the root (background) window pops up an menu to help you get +started. + +The Tab key pressed anywhere with the Alt key (same as the key on PC +keyboards) held down pop-ups a window list. + +Mouse button 1 on the title-bar or side frame can move, raise or lower a +window. + +Mouse button 1 on the window corners can resize, raise or lower a +window. + +You can override or remove these bindings. To remove the window list +binding, use this: + +.... +Key Tab A M - +.... + +== COMMAND EXECUTION + +=== Module and Function Commands + +If fvwm encounters a command that it doesn't recognize, it checks to see +if the specified command should have been + +.... +Function (rest of command) +.... + +or + +.... +Module (rest of command) +.... + +This allows complex functions or modules to be invoked in a manner which +is fairly transparent to the configuration file. + +Example: the _config_ file contains the line + +.... +HelpMe +.... + +Fvwm looks for an fvwm command called "HelpMe", and fails. Next it looks +for a user-defined complex function called "HelpMe". If no such function +exists, fvwm tries to execute a module called "HelpMe". + +=== Delayed Execution of Commands + +**Note**: There are many commands that affect look and feel of specific, +some or all windows, like *Style*, *Mouse*, *Colorset*, *TitleStyle* and +many others. For performance reasons such changes are not applied +immediately but only when fvwm is idle, i.e. no user interaction or +module input is pending. Specifically, new *Style* options that are set +in a function are not applied until after the function has completed. +This can sometimes lead to unwanted effects. + +To force that all pending changes are applied immediately, use the +*UpdateStyles*, *Refresh* or *RefreshWindow* commands. + +== QUOTING + +Quotes are required only when needed to make fvwm consider two or more +words to be a single argument. Unnecessary quoting is allowed. If you +want a quote character in your text, you must escape it by using the +backslash character. For example, if you have a pop-up menu called +"Window-Ops", then you do not need quotes: + +.... +Popup Window-Ops +.... + +but if you replace the dash with a space, then you need quotes: + +.... +Popup "Window Ops" +.... + +The supported quoting characters are double quotes, single quotes and +reverse single quotes. All three kinds of quotes are treated in the same +way. Single characters can be quoted with a preceding backslash. Quoting +single characters works even inside other kinds of quotes. + +== COMMAND EXPANSION + +Whenever an fvwm command line is executed, fvwm performs parameter +expansion. A parameter is a '$' followed by a word enclosed in brackets +($[...]) or a single special character. If fvwm encounters an unquoted +parameter on the command line it expands it to a string indicated by the +parameter name. Unknown parameters are left untouched. Parameter +expansion is performed before quoting. To get a literal '$' use "$$". + +If a command is prefixed with a '-' parameter expansion isn't performed. +This applies to the command immediately following the '-', in which the +expansion normally would have taken place. When uesed together with +other prefix commands it must be added before the other prefix. + +Example: + +.... +Pick -Exec exec xmessage '$[w.name]' +.... + +opens an xmessage dialog with "$[w.name]" unexpanded. + +The longer variables may contain additional variables inside the name, +which are expanded before the outer variable. + +In earlier versions of fvwm, some single letter variables were +supported. It is deprecated now, since they cause a number of problems. +You should use the longer substitutes instead. + +Example: + +.... +# Print the current desk number, horizontal page number +# and the window's class (unexpanded here, no window). +Echo $[desk.n] $[page.nx] $[w.class] +.... + +Note: If the command is called outside a window context, it prints +"$[w.class]" instead of the class name. It is usually not enough to have +the pointer over a window to have a context window. To force using the +window with the focus, the *Current* command can be used: + +.... +Current Echo $[desk.n] $[page.nx] $[w.class] +.... + +The parameters known by fvwm are: + +$$:: + A literal '$'. + +$.:: + The absolute directory of the currently Read file. Intended for creating + relative and relocatable configuration trees. If used outside of any + read file, the returned value is '.'. + +$0 to $9:: + The positional parameters given to a complex function (a function that + has been defined with the *AddToFunc* command). "$0" is replaced with + the first parameter, "$1" with the second parameter and so on. If the + corresponding parameter is undefined, the "$..." is deleted from the + command line. + +$*:: + All positional parameters given to a complex function. This includes + parameters that follow after "$9". + +$[_n_]:: + +The _n_:th positional parameter given to a complex function, counting +from 0. If the corresponding parameter is undefined, the "$[_n_]" is +deleted from the command line. The parameter is expanded unquoted. + +$[_n_-_m_]:: + The positional parameters given to a complex function, starting with + parameter _n_ and ending with parameter _m_. If all the corresponding + parameters are undefined, the "$[...]" is deleted from the command line. + If only some of the parameters are defined, all defined parameters are + expanded, and the remaining silently ignored. All parameters are + expanded unquoted. + +$[_n_-]:: + All the positional parameters given to a complex function, starting with + parameter _n_. If all the corresponding parameters are undefined, the + "$[...]" is deleted from the command line. All parameters are expanded + unquoted. + +$[*]:: + All the positional parameters given to a complex function. This is + equivalent of $[0-]. + +$[version.num]:: + The version number, like "2.6.0". + +$[version.info]:: + The version info, which contains the SHA of the latest commit (if + compiled from git), or "(relesaed)" if a compiled from a release + tarball. + +$[version.line]:: + The first line printed by the --version command line option. + +$[vp.x] $[vp.y] $[vp.width] $[vp.height]:: + Either coordinate or the width or height of the current viewport. + +$[wa.x] $[wa.y] $[wa.width] $[wa.height]:: + Either coordinate or the width or height of the EWMH working area. + +$[dwa.x] $[dwa.y] $[dwa.width] $[dwa.height]:: + Either coordinate or the width or height of the dynamic EWMH working area. + +$[desk.n]:: + The current desk number. + +$[desk.name]:: + These parameters are replaced with the name of the desktop number + that is defined with the *DesktopName* command. If no name is defined, + then the default name is returned. + +$[desk.width] $[desk.height]:: + The width or height of the whole desktop, i.e. the width or height + multiplied by the number of pages in x or y direction. + +$[desk.pagesx] $[desk.pagesy]:: + The number of total pages in a desk in x or y direction. This is the + same as the values set by *DesktopSize*. + +$[page.nx] $[page.ny]:: + The current page numbers, by X and Y axes, starting from 0. _page_ is + equivalent to _area_ in the GNOME terminology. + +$[w.id]:: + The window-id (expressed in hex, e.g. 0x10023c) of the window the + command was called for or "$[w.id]" if no window is associated with the + command. + +$[w.name] $[w.iconname] $[w.class] $[w.resource] $[w.visiblename] $[w.iconfile] $[w.miniiconfile] $[w.iconfile.svgopts] $[w.miniiconfile.svgopts]:: + The window's name, icon name, resource class and resource name, visible + name, file name of its icon or mini icon defined with the _Icon_ or + _MiniIcon_ style (including the full path if the file was found on + disk), and (if fvwm is compiled with SVG support) the icon or mini icon + svg rendering options (including the leading colon), or unexpanded + "$[w.]" string if no window is associated with the command. ++ +Note, the first 5 variables may include any kind of characters, so these +variables are quoted. It means that the value is surrounded by single +quote characters and any contained single quote is prefixed with a +backslash. This guarantees that commands like: ++ +.... +Style $[w.resource] Icon norm/network.png +.... ++ +work correctly, regardless of any special symbols the value may contain, +like spaces and different kinds of quotes. ++ +In the case of the window's visible name, this is the value returned +from the literal title of the window shown in the titlebar. Typically +this will be the same as $[w.name] once expanded, although in the case +of using _IndexedWindowName_ then this is more useful a distinction, and +allows for referencing the specific window by its visible name for +inclusion in things like *Style* commands. + +$[w.x] $[w.y] $[w.width] $[w.height]:: + Either coordinate or the width or height of the current window if it is + not iconified. If no window is associated with the command or the window + is iconified, the string is left as is. + +$[w.pagex] $[w.pagey]:: + The X or Y page the window is on. + +$[w.desk]:: + The number of the desk on which the window is shown. If the window is + sticky the current desk number is used. + +$[w.layer]:: + The layer of the window. + +$[w.screen]:: + The screen name the window is on. If RandR is not present, this does not + expand. + +$[cw.x] $[cw.y] $[cw.width] $[cw.height]:: + These work like $[w.…] but return the geometry of the client part of the + window. In other words: the border and title of the window is not taken + into account. + +$[i.x], $[it.x], $[ip.x] $[i.y], $[it.y], $[ip.y] $[i.width], $[it.width], $[ip.width] $[i.height], $[it.height], $[ip.height]:: + These work like $[w.…] but return the geometry of the icon ($[i.…]), the + icon title ($[it.…]) or the icon picture ($[ip.…]). + +$[pointer.x] $[pointer.y]:: + These return the position of the pointer on the screen. If the pointer + is not on the screen, these variables are not expanded. + +$[pointer.wx] $[pointer.wy]:: + These return the position of the pointer in the selected window. If the + pointer is not on the screen, the window is iconified or no window is + selected, these variables are not expanded. + +$[pointer.cx] $[pointer.cy]:: + These return the position of the pointer in the client portion of the + selected window. If the pointer is not on the screen, the window is + shaded or iconified or no window is selected, these variables are not + expanded. + +$[pointer.screen]:: + The screen name the pointer is currently on. No expansion if RandR is + not enabled. ++ +This command is deprecated; use $[monitor.current] instead. + +$[monitor..x], $[monitor..y], $[monitor..width], $[monitor..height], $[monitor.primary], $[monitor.current], $[monitor.output], $[monitor.count]:: + Returns information about the selected monitor. These can be nested, for + example: $[monitor.$[monitor.primary].width] ++ + should be a valid xrandr(1) output name. ++ +"x" returns the monitor's x position; "y" returns the monitor's y +position; "width" returns the monitor's width (in pixels); "height" +returns the monitor's height (in pixels) ++ +"current" is the same as the deprecated $[screen.pointer] variable; the +monitor which has the mouse pointer. ++ +"count" returns the number of active monitors. ++ +"primary" is the name of the output set as primary via xrandr(1). + +$[screen]:: + The screen number fvwm is running on. Useful for setups with multiple + screens. + +$[screen.count]:: + The total number of screens detected. Assumes RandR. ++ +This is deprecated; use $[monitor.count] instead. + + +$[fg.cs] $[bg.cs] $[hilight.cs] $[shadow.cs] $[fgsh.cs]:: + These parameters are replaced with the name of the foreground (fg), + background (bg), hilight (hilight), shadow (shadow), or the font shadow + (fgsh) color that is defined in colorset (replace with zero or a + positive integer). For example "$[fg.cs3]" is expanded to the name of + the foreground color of colorset 3 (in rgb:rrrr/gggg/bbbb form). ++ +If .lighten

    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 by a percentage value

    (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). ++ +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]. ++ +Please refer to the *Colorsets* section for details about colorsets. + +$[schedule.last]:: + This is replaced by the id of the last command that was scheduled with + the *Schedule* command, even if this command was already executed. + +$[schedule.next]:: + This is replaced by the id the next command used with *Schedule* will + get (unless a different id is specified explicitly). + +$[cond.rc]:: + 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 *Conditional Commands* in the command list. + +$[func.context]:: + The context character of the running command as used in the *Mouse*, + *Key* or *PointerKey* command. This is useful for example with: ++ +.... +Mouse 3 FS N WindowShade $$[func.context] +.... + +$[debuglog.state]:: + Either _0_ (debug log closed) or _1_. Indicates the current state of + debuging and logging facility. + +$[gt._str_]:: + return the translation of _str_ by looking in the current locale + catalogs. If no translation is found _str_ is returned as is. See the + *LocalePath* command. + +$[infostore._key_]:: + Return the value of the item stored in the InfoStore at the given _key_. + If no key is present, the unexpanded string is returned. + +$[...]:: + 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. ++ +Some examples can be found in the description of the *AddToFunc* +command. + +== SCRIPTING & COMPLEX FUNCTIONS + +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 +*Read*, from the output of a command with *PipeRead* or written as a +complex function with the *AddToFunc* command. For the curious, section +7 of the fvwm FAQ shows some real life applications of scripting. Please +refer to the sections *User Functions and Shell Commands* and +*Conditional Commands* 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 *Read* or *PipeRead* command instead. + +== LIST OF FVWM COMMANDS + +The command descriptions below are grouped together in the following +sections. The sections are hopefully sorted in order of usefulness to +the newcomer. + +* *Menu commands* +* *Miscellaneous commands* +* *Commands affecting window movement and placement* +* *Commands for focus and mouse movement* +* *Commands controlling window state* +* *Commands for mouse and key bindings* +* *The Style command (controlling window styles)* +* *Other commands controlling window styles* +* *Commands controlling the virtual desktop* +* *Commands for user functions and shell commands* +* *Conditional commands* +* *Module commands* +* *Quit, restart and session management commands* +* *Colorsets* +* *Color gradients* + +=== Menus + +Before a menu can be opened, it has to be populated with menu items +using the *AddToMenu* command and bound to a key or mouse button with +the *Key*, *PointerKey* or *Mouse* command (there are many other ways to +invoke a menu too). This is usually done in the configuration file. + +Fvwm menus are extremely configurable in look and feel. Even the +slightest nuances can be changed to the user's liking, including the +menu item fonts, the background, delays before popping up sub menus, +generating menus dynamically and many other features. Please refer to +the *MenuStyle* command to learn more. + +*Types of Menus*:: +In fvwm there are four slightly different types of menus: ++ +*Popup* menus can appear everywhere on the screen on their own or +attached to a part of a window. The *Popup* command opens popup menus. +If the popup menu was invoked with a mouse button held down, it is +closed when the button is released. The item under the pointer is then +activated and the associated action is executed. ++ +*Menu* is a very similar command, but the menus it opens are slightly +less transient. When invoked by clicking a mouse button, it stays open +and can be navigated with no button held. But if it is invoked by a +button press followed by mouse motion, it behaves exactly like a popup +menu. ++ +_Tear off menus_ or _Pin up menus_ are menus from either of the above +two commands that have been "torn off" their original context and +pinned on the desktop like a normal window. They are created from +other menus by certain key presses or mouse sequences or with the +*TearMenuOff* command from inside a menu. ++ +_Sub menus_ are menus inside menus. When a menu item that has the +*Popup* command as its action is selected, the named menu is opened as +an inferior menu to the parent. Any type of menu can have sub menus. + +*Menu Anatomy*:: +Menus consist of any number of titles which are inactive menu items +that usually appear at the top of the menu, normal items triggering +various actions when selected, separator lines between the items, tear +off bars (a horizontal broken line) that tear off the menu when +selected, and sub menu items indicated with a triangle pointing left +or right, depending on the direction in which the sub menu appears. +All the above menu items are optional. ++ +Additionally, if the menu is too long to fit on the screen, the excess +menu items are put in a continuation menu and a sub menu with the +string "More..." is placed at the bottom of the menu. The "More..." +string honors the locale settings. ++ +Finally, there may be a picture running up either side of the menu (a +"side bar"). + +*Menu Navigation*:: +Menus can be navigated either with the keyboard or with the mouse. +Many people prefer to use the mouse, but it can be rather tedious. +Once you get the hang of it, keyboard navigation can be much faster. +While fvwm displays a menu, it can do nothing else. For example, new +windows do not appear before the menu is closed. However, this is not +exactly true for tear off menus. See the *Tear Off Menus* section for +details. + +*Mouse Navigation*:: +Moving the pointer over a menu selects the item below it. Normally +this is indicated by a 3d border around the item, but not all parts of +a menu can be selected. Pressing any mouse button while a menu is open +by default activates the item below it. Items of a popup menu are also +activated by releasing a held mouse button. In case of an item that +hides a sub menu, the sub menu is displayed if the pointer hovers over +the item long enough or moves close to the triangle indicating the sub +menu. This behaviour can be tuned with menu styles. ++ +Scrolling a mouse wheel over a menu either wraps the pointer along the +menu (default), scrolls the menu under the pointer or act as if the +menu was clicked depending on the _MouseWheel_ menu style. ++ +Clicking on a selected item activates it - what happens exactly +depends on the type of the item. ++ +Clicking on a title, a separator, the side bar, or outside the menu +closes the menu (exception: tear off menus can not be closed this +way). Pressing mouse button 2 over a menu title or activating a tear +off bar creates a tear off menu from the current menu. Clicking on a +normal menu item invokes the command that is bound to it, and clicking +on a sub menu item either closes all open menus and replaces them with +the sub menu or posts the menu (default). ++ +Posting menus is meant to ease mouse navigation. Once a sub menu is +posted, only items from that sub menu can be selected. This can be +very useful to navigate the menu if the pointer tends to stray off the +menu. To unpost the menu and revert back to normal operation, either +click on the same sub menu item or press any key. + +*Keyboard Navigation*:: +Just like with mouse navigation, the item below the pointer is +selected. This is achieved by warping the pointer to the menu items +when necessary. While a menu is open, all key presses are intercepted +by the menu. No other application can get keyboard input (although +this is not the case for tear off menus). ++ +Items can be selected directly by pressing a hotkey that can be +configured individually for each menu item. The hotkey is indicated by +underlining it in the menu item label. With the _AutomaticHotkeys_ +menu style fvwm automatically assigns hotkeys to all menu items. ++ +The most basic keys to navigate through menus are the cursor keys +(move up or down one item, enter or leave a sub menu), ++ +(activate item) and ++ +(close menu). Numerous other keys can be used to navigate through +menus by default: ++ +_Enter_, _Return_, _Space_ activate the current item. ++ +_Escape_, _Delete_, _Ctrl-G_ exit the current sequence of menus or +destroy a tear off menu. ++ +_J_, _N_, _Cursor-Down_, _Tab_, _Meta-Tab_, _Ctrl-F_, move to the next +item. ++ +_K_, _P_, _Cursor-Up_, _Shift-Tab_, _Shift-Meta-Tab_, _Ctrl-B_, move +to the prior item. ++ +_L_, _Cursor-Right_, _F_ enter a sub menu. ++ +_H_, _Cursor-Left_, _B_ return to the prior menu. ++ +_Ctrl-Cursor-Up_, _Ctrl-K_ _Ctrl-P_, _Shift-Ctrl-Meta-Tab_, _Page-Up_ +move up five items. ++ +_Ctrl-Cursor-Down_, _Ctrl-J_ _Ctrl-N_, _Ctrl-Meta-Tab_ _Page-Down_ +move down five items. ++ +_Shift-P_, _Home_, _Shift-Cursor-Up_, _Ctrl-A_ move to the first item. ++ +_Shift-N_, _End_, _Shift-Cursor-Down_, _Ctrl-E_ move to the last item. ++ +_Meta-P_, _Meta-Cursor-Up_, _Ctrl-Cursor-Left_, _Shift-Ctrl-Tab_, move +up just below the next separator. ++ +_Meta-N_, _Meta-Cursor-Down_, _Ctrl-Cursor-Right_, _Ctrl-Tab_, move +down just below the next separator. ++ +_Insert_ opens the "More..." sub menu if any. ++ +_Backspace_ tears off the menu. + +*Menu Bindings*:: +The keys and mouse buttons used to navigate the menu can be configured +using the *Key* and *Mouse* commands with the special context 'M', +possible combined with 'T' for the menu title, 'I' for other menu +items, 'S' for any border or sidepic, '[' for left border including a +left sidepic, ']' for right border including a right sidepic, '-' for +top border, '_' for bottom border. The menu context uses its own set +of actions that can be bound to keys and mouse buttons. These are +_MenuClose_, _MenuCloseAndExec_, _MenuEnterContinuation_, +_MenuEnterSubmenu_, _MenuLeaveSubmenu_, _MenuMoveCursor_, +_MenuCursorLeft_, _MenuCursorRight_, _MenuSelectItem_, _MenuScroll_ +and _MenuTearOff_. ++ +It is not possible to override the key Escape with no modifiers for +closing the menu. Neither is it possible to undefine mouse button 1, +the arrow keys or the enter key for minimal navigation. ++ +*MenuClose* exits from the current sequence of menus or destroys a +tear off menu. ++ +*MenuCloseAndExec* exits from the current sequence of menus or +destroys a tear off menu and executes the rest of the line as a +command. ++ +*MenuEnterContinuation* opens the "More..." sub menu if any. ++ +*MenuEnterSubmenu* enters a sub menu. ++ +*MenuLeaveSubmenu* returns to the prior menu. ++ +*MenuMoveCursor* _n_ [_m_] moves the selection to another item. If the +first argument is zero the second argument specifies an absolute item +in the menu to move the pointer to. Negative items are counted from +the end of the menu. If the first argument is non-zero, the second +argument must be omitted, and the first argument specifies a relative +change in the selected item. The positions may be suffixed with a 's' +to indicate that the items should refer only to the first items after +separators. ++ +*MenuCursorLeft* enters a sub menu with the _SubmenusLeft_ menu style, +and returns to the prior menu with the _SubmenusRight_ menu style. ++ +*MenuCursorRight* enters a sub menu with the _SubmenusRight_ menu +style, and returns to the prior menu with the _SubmenusLeft_ menu +style. ++ +*MenuSelectItem* triggers the action for the menu item. ++ +**MenuScroll **__n__ performs menu scrolling according to the +_MouseWheel_ menu style with _n_ items. The distance can be suffixed +with an 's' to indicate the items should refer only to the first items +after separators. ++ +*MenuTearOff* turns a normal menu into a "torn off" menu. See *Tear +Off Menus* for details. + +*Tear Off Menus*:: +A tear off menu is any menu that has been "torn off" the window it was +attached to and pinned to the root window. There are three ways to +tear off a menu: click on the menu title with mouse button 2, press ++ +in the menu or activate its tear off bar (a horizontal bar with a +broken line). Tear off bars must be added to the menu as any other +item by assigning them the command *TearMenuOff*. ++ +The builtin tear off actions can be overridden by undefining the +builtin menu actions bound to tear off. To remove the builtin mouse +button 2 binding, use: ++ +.... +Mouse 2 MT A - +.... ++ +and to remove the builtin backspace binding, use: ++ +.... +Key Backspace M A - +.... ++ +See the section *Menu Bindings* for details on how to assign other +bindings for tear off. ++ +Note that prior to fvwm 2.5.20 the tear off mouse bindings were +redefined in different way, which no longer work. ++ +The window containing the menu is placed as any other window would be. +If you find it confusing to have your tear off menus appear at random +positions on the screen, put this line in your configuration file: ++ +.... +Style fvwm_menu UsePPosition +.... ++ +To remove borders and buttons from a tear-off menu but keep the menu +title, you can use ++ +.... +Style fvwm_menu !Button 0, !Button 1 +Style fvwm_menu !Button 2, !Button 3 +Style fvwm_menu !Button 4, !Button 5 +Style fvwm_menu !Button 6, !Button 7 +Style fvwm_menu !Button 8, !Button 9 +Style fvwm_menu Title, HandleWidth 0 +.... ++ +A tear off menu is a cross breeding between a window and a menu. The +menu is swallowed by a window and its title is stripped off and +displayed in the window title. The main advantage is that the menu +becomes permanent - activating an item does not close the menu. +Therefore, it can be used multiple times without reopening it. To +destroy such a menu, close its window or press the Escape key. ++ +Tear off menus behave somewhat differently than normal menus and +windows. They do not take the keyboard focus, but while the pointer is +over one of them, all key presses are sent to the menu. Other fvwm key +bindings are disabled as long as the pointer is inside the tear off +menu or one of its sub menus. When the pointer leaves this area, all +sub menus are closed immediately. Note that the window containing a +tear off menu is never hilighted as if it had the focus. ++ +A tear off menu is an independent copy of the menu it originated from. +As such, it is not affected by adding items to that menu or changing +its menu style. ++ +To create a tear off menu without opening the normal menu first, the +option _TearOffImmediately_ can be added to the *Menu* or *Popup* +command. + +*AddToMenu* _menu-name_ [_menu-label_ _action_]:: +Begins or adds to a menu definition. Typically a menu definition looks +like this: ++ +.... +AddToMenu Utilities Utilities Title + + Xterm Exec exec xterm -e tcsh + + Rxvt Exec exec rxvt + + "Remote Logins" Popup Remote-Logins + + Top Exec exec rxvt -T Top -n Top -e top + + Calculator Exec exec xcalc + + Xman Exec exec xman + + Xmag Exec exec xmag + + emacs Exec exec xemacs + + Mail MailFunction xmh "-font fixed" + + "" Nop + + Modules Popup Module-Popup + + "" Nop + + Exit Fvwm Popup Quit-Verify +.... ++ +The menu could be invoked via ++ +.... +Mouse 1 R A Menu Utilities Nop +.... ++ +or ++ +.... +Mouse 1 R A Popup Utilities +.... ++ +There is no end-of-menu symbol. Menus do not have to be defined in a +contiguous region of the _config_ file. The quoted (or first word) +portion in the above examples is the menu label, which appears in the +menu when the user pops it up. The remaining portion is an fvwm +command which is executed if the user selects that menu item. An empty +menu-label ("") and the *Nop* function are used to insert a separator +into the menu. ++ +The keywords _DynamicPopUpAction_ and _DynamicPopDownAction_ have a +special meaning when used as the name of a menu item. The action +following the keyword is executed whenever the menu is popped up or +down. This way you can implement dynamic menus. It is even possible to +destroy itself with *DestroyMenu* and the rebuild from scratch. When +the menu has been destroyed (unless you used the _recreate_ option +when destroying the menu), do not forget to add the dynamic action +again. ++ +Note: Do not trigger actions that require user interaction. They may +fail and may screw up your menus. See the *Silent* command. ++ +*Warning* Do not issue *MenuStyle* commands as dynamic menu actions. +Chances are good that this crashes fvwm. ++ +There are several configurable scripts installed together with fvwm +for automatic menu generation. They have their own man pages. Some of +them, specifically *fvwm-menu-directory* and *fvwm-menu-desktop*, may +be used with _DynamicPopupAction_ to create a directory listing or +GNOME/KDE application listing. ++ +Example (File browser): ++ +.... +# You can find the shell script fvwm_make_browse_menu.sh +# in the utils/ directory of the distribution. +AddToMenu BrowseMenu ++ DynamicPopupAction PipeRead \ +'fvwm_make_browse_menu.sh BrowseMenu' +.... ++ +Example (Picture menu): ++ +.... +# Build a menu of all .jpg files in +# $HOME/Pictures +AddToMenu JpgMenu foo title ++ DynamicPopupAction Function MakeJpgMenu + +AddToFunc MakeJpgMenu ++ I DestroyMenu recreate JpgMenu ++ I AddToMenu JpgMenu Pictures Title ++ I PipeRead 'for i in $HOME/Pictures/*.jpg; \ +do echo AddToMenu JpgMenu "`basename $i`" Exec xv $i; done' +.... ++ +The keyword _MissingSubmenuFunction_ has a similar meaning. It is +executed whenever you try to pop up a sub menu that does not exist. +With this function you can define and destroy menus on the fly. You +can use any command after the keyword, but if the name of an item +(that is a submenu) defined with *AddToFunc* follows it, fvwm executes +this command: ++ +.... +Function +.... ++ +i.e. the name is passed to the function as its first argument and can +be referred to with "$0". ++ +The *fvwm-menu-directory* script mentioned above may be used with +_MissingSubmenuFunction_ to create an up to date recursive directory +listing. ++ +Example: ++ +.... +# There is another shell script fvwm_make_directory_menu.sh +# in the utils/ directory of the distribution. To use it, +# define this function in your configuration file: + +DestroyFunc MakeMissingDirectoryMenu +AddToFunc MakeMissingDirectoryMenu ++ I PipeRead fvwm_make_directory_menu.sh $0 + +DestroyMenu SomeMenu +AddToMenu SomeMenu ++ MissingSubmenuFunction MakeMissingDirectoryMenu ++ "Root directory" Popup / +.... ++ +This is another implementation of the file browser that uses sub menus +for subdirectories. ++ +Titles can be used within the menu. If you add the option _top_ behind +the keyword *Title*, the title is added to the top of the menu. If +there was a title already, it is overwritten. ++ +.... +AddToMenu Utilities Tools Title top +.... ++ +All text up to the first Tab in the menu label is aligned to the left side of +t the menu, all text right of the first is aligned to the left in a second +column and all text thereafter is placed right aligned in the third column. +All other s are replaced by spaces. Note that you can change this format with +the _ItemFormat_ option of the *MenuStyle* command. ++ +If the menu-label contains an ampersand ('&'), the next character is +taken as a hot-key for the menu item. Hot-keys are underlined in the +label. To get a literal '&', insert "&&". Pressing the hot-key moves +through the list of menu items with this hot-key or selects an item +that is the only one with this hot-key. ++ +If the menu-label contains a sub-string which is set off by stars, +then the text between the stars is expected to be the name of an image +file to insert in the menu. To get a literal '*', insert "**". For +example ++ +.... ++ Calculator*xcalc.xpm* Exec exec xcalc +.... ++ +inserts a menu item labeled "Calculator" with a picture of a +calculator above it. The following: ++ +.... ++ *xcalc.xpm* Exec exec xcalc +.... ++ +Omits the "Calculator" label, but leaves the picture. ++ +If the menu-label contains a sub-string which is set off by percent +signs, then the text between the percent signs is expected to be the +name of image file (a so called mini icon to insert to the left of the +menu label. A second mini icon that is drawn at the right side of the +menu can be given in the same way. To get a literal '%', insert "%%". +For example ++ +.... ++ Calculator%xcalc.xpm% Exec exec xcalc +.... ++ +inserts a menu item labeled "Calculator" with a picture of a +calculator to the left. The following: ++ +.... ++ %xcalc.xpm% Exec exec xcalc +.... ++ +Omits the "Calculator" label, but leaves the picture. The pictures +used with this feature should be small (perhaps 16x16). ++ +If the menu-name (not the label) contains a sub-string which is set +off by at signs ('@'), then the text between them is expected to be +the name of an image file to draw along the left side of the menu (a +side pixmap). You may want to use the _SidePic_ option of the +*MenuStyle* command instead. To get a literal '@', insert "@@". For +example ++ +.... +AddToMenu StartMenu@linux-menu.xpm@ +.... ++ +creates a menu with a picture in its bottom left corner. ++ +If the menu-name also contains a sub-string surrounded by '^'s, then +the text between '^'s is expected to be the name of an X11 color and +the column containing the side picture is colored with that color. You +can set this color for a menu style using the _SideColor_ option of +the *MenuStyle* command. To get a literal '^', insert "^^". Example: ++ +.... +AddToMenu StartMenu@linux-menu.xpm@^blue^ +.... ++ +creates a menu with a picture in its bottom left corner and colors +with blue the region of the menu containing the picture. ++ +In all the above cases, the name of the resulting menu is name +specified, stripped of the substrings between the various delimiters. + +*ChangeMenuStyle* _menustyle_ _menu_ ...:: +Changes the menu style of _menu_ to _menustyle_. You may specify more +than one menu in each call of *ChangeMenuStyle*. + +*CopyMenuStyle* _orig-menustyle_ _dest-menustyle_:: +Copy _orig-menustyle_ to _dest-menustyle_, where _orig-menustyle_ is +an existing menu style. If the menu style _dest_menustyle_ does not +exist, then it is created. + +*DestroyMenu* [recreate] _menu_:: +Deletes a menu, so that subsequent references to it are no longer +valid. You can use this to change the contents of a menu during an +fvwm session. The menu can be rebuilt using *AddToMenu*. The optional +parameter _recreate_ tells fvwm not to throw away the menu completely +but to throw away all the menu items (including the title). ++ +.... +DestroyMenu Utilities +.... + +*DestroyMenuStyle* _menustyle_:: +Deletes the menu style named _menustyle_ and changes all menus using +this style to the default style, you cannot destroy the default menu +style. ++ +.... +DestroyMenuStyle pixmap1 +.... + +*Menu* _menu-name_ [_position_] [_double-click-action_]:: +Causes a previously defined menu to be popped up in a sticky manner. +That is, if the user invokes the menu with a click action instead of a +drag action, the menu stays up. The command _double-click-action_ is +invoked if the user double-clicks a button (or hits the key rapidly +twice if the menu is bound to a key) when bringing up the menu. If the +double click action is not specified, double clicking on the menu does +nothing. However, if the menu begins with a menu item (i.e. not with a +title or a separator) and the double click action is not given, double +clicking invokes the first item of the menu (but only if the pointer +really was over the item). ++ +The pointer is warped to where it was when the menu was invoked if it +was both invoked and closed with a keystroke. ++ +The _position_ arguments allow placement of the menu somewhere on the +screen, for example centered on the visible screen or above a title +bar. Basically it works like this: you specify a _context-rectangle_ +and an offset to this rectangle by which the upper left corner of the +menu is moved from the upper left corner of the rectangle. The +_position_ arguments consist of several parts: ++ +{empty}[_context-rectangle_] _x_ _y_ [_special-options_] ++ +The _context-rectangle_ can be one of: ++ +_Root_::: + the root window of the current screen. ++ +_Mouse_::: + a 1x1 rectangle at the mouse position. ++ +_Window_::: + the frame of the context window. ++ +_Interior_::: + the inside of the context window. ++ +_Title_::: + the title of the context window or icon. ++ +__Button__::: ++ +_Icon_::: + the icon of the context window. ++ +_Menu_::: + the current menu. ++ +_Item_::: + the current menu item. ++ +_Context_::: + the current window, menu or icon. ++ +_This_::: + whatever widget the pointer is on (e.g. a corner of a window or the + root window). ++ +_Rectangle_ <__geometry__>::: + the rectangle defined by <__geometry__> in X geometry format. Width + and height default to 1 if omitted. + +If the context-rectangle is omitted or illegal (e.g. "item" on a +window), "Mouse" is the default. Note that not all of these make sense +under all circumstances (e.g. "Icon" if the pointer is on a menu). + +The offset values _x_ and _y_ specify how far the menu is moved from +its default position. By default, the numeric value given is +interpreted as a percentage of the context rectangle's width (height), +but with a trailing '_m_' the menu's width (height) is used instead. +Furthermore a trailing '_p_' changes the interpretation to mean +pixels. + +Instead of a single value you can use a list of values. All additional +numbers after the first one are separated from their predecessor by +their sign. Do not use any other separators. + +If _x_ or _y_ are prefixed with "'__o__" where is an +integer, the menu and the rectangle are moved to overlap at the +specified position before any other offsets are applied. The menu and +the rectangle are placed so that the pixel at percent of the +rectangle's width/height is right over the pixel at percent +of the menu's width/height. So "o0" means that the top/left borders of +the menu and the rectangle overlap, with "o100" it's the bottom/right +borders and if you use "o50" they are centered upon each other (try it +and you will see it is much simpler than this description). The +default is "o0". The prefix "o" is an abbreviation for +"+-m". + +A prefix of '_c_' is equivalent to "o50". Examples: + +.... +# window list in the middle of the screen +WindowList Root c c + +# menu to the left of a window +Menu name window -100m c+0 + +# popup menu 8 pixels above the mouse pointer +Popup name mouse c -100m-8p + +# somewhere on the screen +Menu name rectangle 512x384+1+1 +0 +0 + +# centered vertically around a menu item +AddToMenu foobar-menu + + "first item" Nop + + "special item" Popup "another menu" item +100 c + + "last item" Nop + +# above the first menu item +AddToMenu foobar-menu + + "first item" Popup "another menu" item +0 -100m +.... + + +Note that you can put a sub menu far off the current menu so you could +not reach it with the mouse without leaving the menu. If the pointer +leaves the current menu in the general direction of the sub menu the +menu stays up. + +The _special-options_: + +To create a tear off menu without opening the normal menu, add the +option _TearOffImmediately_. Normally the menu opens in normal state +for a split second before being torn off. As tearing off places the +menu like any other window, a position should be specified explicitly: + +.... +# Forbid fvwm to place the menu window +Style UsePPosition +# Menu at top left corner of screen +Menu Root 0p 0p TearOffImmediately +.... + + +The _Animated_ and _Mwm_ or _Win_ menu styles may move a menu +somewhere else on the screen. If you do not want this you can add +_Fixed_ as an option. This might happen for example if you want the +menu always in the top right corner of the screen. + +Where do you want a menu to appear when you click on its menu item? +The default is to place the title under the cursor, but if you want it +where the position arguments say, use the _SelectInPlace_ option. If +you want the pointer on the title of the menu, use _SelectWarp_ too. +Note that these options apply only if the _PopupAsRootMenu_ +*MenuStyle* option is used. + +The pointer is warped to the title of a sub menu whenever the pointer +would be on an item when the sub menu is popped up (_fvwm_ menu style) +or never warped to the title at all (_Mwm_ or _Win_ menu styles). You +can force (forbid) warping whenever the sub menu is opened with the +_WarpTitle_ (_NoWarp_) option. + +Note that the _special-options_ do work with a normal menu that has no +other position arguments. +*MenuStyle* _stylename_ [_options_]:: +Sets a new menu style or changes a previously defined style. The +_stylename_ is the style name; if it contains spaces or tabs it has to +be quoted. The name "*" is reserved for the default menu style. The +default menu style is used for every menu-like object (e.g. the window +created by the *WindowList* command) that had not be assigned a style +using the *ChangeMenuStyle*. See also *DestroyMenuStyle*. When using +monochrome color options are ignored. + +_options_ is a comma separated list containing some of the keywords +Fvwm / Mwm / Win, BorderWidth, Foreground, Background, Greyed, +HilightBack / !HilightBack, HilightTitleBack, ActiveFore / +!ActiveFore, MenuColorset, ActiveColorset, GreyedColorset, +TitleColorset, Hilight3DThick / Hilight3DThin / Hilight3DOff, +Hilight3DThickness, Animation / !Animation, Font, TitleFont, MenuFace, +PopupDelay, PopupOffset, TitleWarp / !TitleWarp, TitleUnderlines0 / +TitleUnderlines1 / TitleUnderlines2, SeparatorsLong / SeparatorsShort, +TrianglesSolid / TrianglesRelief, PopupImmediately / PopupDelayed, +PopdownImmediately / PopdownDelayed, PopupActiveArea, DoubleClickTime, +SidePic, SideColor, PopupAsRootMenu / PopupAsSubmenu / PopupIgnore / +PopupClose, RemoveSubmenus / HoldSubmenus, SubmenusRight / +SubmenusLeft, SelectOnRelease, ItemFormat, VerticalItemSpacing, +VerticalMargins, VerticalTitleSpacing, AutomaticHotkeys / +!AutomaticHotkeys, UniqueHotkeyActivatesImmediate / +!UniqueHotkeyActivatesImmediate, MouseWheel, ScrollOffPage / +!ScrollOffPage, TrianglesUseFore / !TrianglesUseFore. + +In the above list some options are listed as option pairs or triples +with a '/' in between. These options exclude each other. All paired +options can be negated to have the effect of the counterpart option by +prefixing ! to the option. + +Some options are now negated by prefixing ! to the option. This is the +preferred form for all such options. The other negative forms are now +deprecated and will be removed in the future. + +This is a list of MenuStyle deprecated negative options: +ActiveForeOff, AnimationOff, AutomaticHotkeysOff, HilightBackOff, +TitleWarpOff + +_Fvwm_, _Mwm_, _Win_ reset all options to the style with the same name +in former versions of fvwm. The default for new menu styles is _Fvwm_ +style. These options override all others except _Foreground_, +_Background_, _Greyed_, _HilightBack_, _ActiveFore_ and _PopupDelay_, +so they should be used only as the first option specified for a menu +style or to reset the style to defined behavior. The same effect can +be created by setting all the other options one by one. + +_Mwm_ and _Win_ style menus popup sub menus automatically. _Win_ menus +indicate the current menu item by changing the background to dark. +_Fvwm_ sub menus overlap the parent menu, _Mwm_ and _Win_ style menus +never overlap the parent menu. + +_Fvwm_ style is equivalent to !HilightBack, Hilight3DThin, +!ActiveFore, !Animation, Font, MenuFace, PopupOffset 0 67, TitleWarp, +TitleUnderlines1, SeparatorsShort, TrianglesRelief, PopupDelayed, +PopdownDelayed, PopupDelay 150, PopdownDelay 150, PopupAsSubmenu, +HoldSubmenus, SubmenusRight, BorderWidth 2, !AutomaticHotkeys, +UniqueHotkeyActivatesImmediate, PopupActiveArea 75. + +_Mwm_ style is equivalent to !HilightBack, Hilight3DThick, +!ActiveFore, !Animation, Font, MenuFace, PopupOffset -3 100, +!TitleWarp, TitleUnderlines2, SeparatorsLong, TrianglesRelief, +PopupImmediately, PopdownDelayed, PopdownDelay 150, PopupAsSubmenu, +HoldSubmenus, SubmenusRight, BorderWidth 2, +UniqueHotkeyActivatesImmediate, !AutomaticHotkeys, PopupActiveArea 75. + +_Win_ style is equivalent to HilightBack, Hilight3DOff, ActiveFore, +!Animation, Font, MenuFace, PopupOffset -5 100, !TitleWarp, +TitleUnderlines1, SeparatorsShort, TrianglesSolid, PopupImmediately, +PopdownDelayed, PopdownDelay 150, PopupAsSubmenu, RemoveSubmenus, +SubmenusRight, BorderWidth 2, UniqueHotkeyActivatesImmediate, +!AutomaticHotkeys, PopupActiveArea 75. + +_BorderWidth_ takes the thickness of the border around the menus in +pixels. It may be zero to 50 pixels. The default is 2. Using an +illegal value reverts the border width to the default. + +_Foreground_ and _Background_ may have a color name as an argument. +This color is used for menu text or the menu's background. You can +omit the color name to reset these colors to the built-in default. + +_Greyed_ may have a color name as an argument. This color is the one +used to draw a menu-selection which is prohibited (or not recommended) +by the Mwm hints which an application has specified. If the color is +omitted the color of greyed menu entries is based on the background +color of the menu. + +_HilightBack_ and _!HilightBack_ switch hilighting the background of +the selected menu item on and off. A specific background color may be +used by providing the color name as an argument to _HilightBack_. If +you use this option without an argument the color is based on the +menu's background color. The _ActiveColorset_ option overrides the +specified color. If the colorset has a non solid background it is used +for the hilighting. + +_HilightTitleBack_ switches hilighting the background of menu titles +on. If a _TitleColorset_ was used, the background colour is taken from +there. Otherwise the color is based on the menu's background color. If +the colorset has a non solid background it is used for the hilighting. + +_ActiveFore_ and _!ActiveFore_ switch hilighting the foreground of the +selected menu item on and off. A specific foreground color may be used +by providing the color name as an argument to _ActiveFore_. Omitting +the color turns hilighting on when an _ActiveColorset_ is used. +_ActiveFore_ turns off hilighting the foreground completely. The +_ActiveColorset_ option overrides the specified color. + +_MenuColorset_ controls if a colorset is used instead of the +_Foreground_, _Background_ and _MenuFace_ menu styles. If the +_MenuColorset_ keyword is followed by a number equal to zero or +greater, this number is taken as the number of the colorset to use. If +the number is omitted, the colorset is switched off and the regular +menu styles are used again. The foreground and background colors of +the menu items are replaced by the colors from the colorset. If the +colorset has a pixmap defined, this pixmap is used as the background +of the menu. Note that the _MenuFace_ menu style has been optimized +for memory consumption and may use less memory than the background +from a colorset. The shape mask from the colorset is used to shape the +menu. Please refer to the *Colorsets* section for details about +colorsets. + +_ActiveColorset_ works exactly like _MenuColorset_, but the foreground +from the colorset replaces the color given with the _ActiveFore_ menu +style and the colorset's background color replaces the color given +with the _HilightBack_ command (to turn on background hilighting you +have to use the _HilightBack_ menu style too). If specified, the +hilight and shadow colors from the colorset are used too. The pixmap +and shape mask from the colorset are not used. Hilighting the +background or foreground can be turned off individually with the +_!ActiveFore_ or _!HilightBack_ menu styles. + +_GreyedColorset_ works exactly like _MenuColorset_, but the foreground +from the colorset replaces the color given with the _Greyed_ menu +style. No other parts of the colorset are used. + +_TitleColorset_ works exactly like _MenuColorset_, but is used only +for menu titles. + +_Hilight3DThick_, _Hilight3DThin_ and _Hilight3DOff_ determine if the +selected menu item is hilighted with a 3D relief. Thick reliefs are +two pixels wide, thin reliefs are one pixel wide. + +_Hilight3DThickness_ takes one numeric argument that may be between +-50 and +50 pixels. With negative values the menu item gets a pressed +in look. The above three commands are equivalent to a thickness of 2, +1 and 0. + +_Animation_ and _!Animation_ turn menu animation on or off. When +animation is on, sub menus that do not fit on the screen cause the +parent menu to be shifted to the left so the sub menu can be seen. + +_Font_ and _TitleFont_ take a font name as an argument. If a font by +this name exists it is used for the text of all menu items. If it does +not exist or if the name is left blank the built-in default is used. +If a _TitleFont_ is given, it is used for all menu titles instead of +the normal font. + +_MenuFace_ enforces a fancy background upon the menus. You can use the +same options for _MenuFace_ as for the *ButtonStyle*. See description +of *ButtonStyle* command and the *Color Gradients* sections for more +information. If you use _MenuFace_ without arguments the style is +reverted back to normal. + +Some examples of MenuFaces are: + +.... +MenuFace DGradient 128 2 lightgrey 50 blue 50 white +MenuFace TiledPixmap texture10.xpm +MenuFace HGradient 128 2 Red 40 Maroon 60 White +MenuFace Solid Maroon +.... + +Note: The gradient styles H, V, B and D are optimized for high speed +and low memory consumption in menus. This is not the case for all the +other gradient styles. They may be slow and consume huge amounts of +memory, so if you encounter performance problems with them you may be +better off by not using them. To improve performance you can try one +or all of the following: + +Turn hilighting of the active menu item other than foreground color +off: + +.... +MenuStyle