Difference between revisions of "Compiz"

From ArchWiki
Jump to: navigation, search
(See also: see also is its own section, not part of troubleshooting)
(Extras: add compiz-manager and simple-ccsm to Extras)
 
(680 intermediate revisions by 14 users not shown)
Line 13: Line 13:
 
[[zh-CN:Compiz]]
 
[[zh-CN:Compiz]]
 
{{Related articles start}}
 
{{Related articles start}}
{{Related|Compiz Configuration}}
+
{{Related|Compiz configuration}}
 
{{Related|Window manager}}
 
{{Related|Window manager}}
 
{{Related|Desktop environment}}
 
{{Related|Desktop environment}}
{{Related|Cairo Compmgr}}
 
 
{{Related|Xfce}}
 
{{Related|Xfce}}
 
{{Related|MATE}}
 
{{Related|MATE}}
{{Related|KDE}}
 
 
{{Related articles end}}
 
{{Related articles end}}
  
Compiz is a [[Wikipedia:Compositing window manager|compositing window manager]]. It can replace the native window managers in [[Desktop environment|desktop environments]] such as [[MATE]] and [[KDE]]. The first version of Compiz was released in 2006. In September 2006 several changes proposed for Compiz were rejected by the Compiz team. This led to the formation of Beryl - a fork of Compiz. In 2007 the Compiz and Beryl communities merged and Compiz was split into two projects: 'compiz-core' (the window manager) and 'compiz-fusion' (the decorator and plugins). In 2009 the two projects merged into a single unified project and the 'fusion' name was dropped. There are currently two branches of Compiz: the older 0.8.x branch which is written in C and the newer 0.9.x branch which is written in C++.
+
According to [[Wikipedia:Compiz|Wikipedia]]:
 +
: Compiz is a [[Wikipedia:Compositing window manager|compositing window manager]] for the [[X Window System]], using 3D graphics hardware to create fast compositing desktop effects for window management. Effects, such as a minimization animation or a cube workspace, are implemented as loadable plugins.
  
 
== Installation ==
 
== Installation ==
  
As of May 2013 Compiz is [https://mailman.archlinux.org/pipermail/arch-dev-public/2013-May/024956.html no longer available] in the [[official repositories]]. There are a number of packages in the [[AUR]] which can provide a full Compiz experience. The packages listed in this section are known to provide a working Compiz configuration. Other Compiz packages are [https://aur.archlinux.org/packages.php?K=compiz also available].
+
There are two versions of Compiz available, the 0.8 series which is written in C and the 0.9 series which is a complete re-write of Compiz in C++. As of August 2016, both series are actively developed. Compiz 0.9 is developed by the [https://code.launchpad.net/~compiz-team Compiz Maintainers on Launchpad] whilst Compiz 0.8 is developed by the [https://github.com/compiz-reloaded Compiz Reloaded project] on GitHub. The two series cannot be installed side by side.
  
{{Note|There is some debate over which branch is considered stable. Canonical declared the 0.9.x branch to be stable from version 0.9.7 onwards but some maintain that 0.9.x is a development branch and that 0.8.x is still the stable version until a 1.x branch is released.}}
+
=== 0.9 series ===
  
=== Installing the 0.9.x branch ===
+
{{Note|From Compiz 0.9.8 onwards, all Compiz components are developed and distributed as a single project. This means that a single package can provide all of the Compiz components.}}
  
Install '''one''' of the following '''two''' packages:
+
* {{App|Compiz|OpenGL compositing window manager with CCSM, Plugins and GTK Window Decorator.|https://launchpad.net/compiz|{{AUR|compiz}}}}
* {{AUR|compiz-dev}} - This package provides the '''latest stable release''' of the 0.9.x branch. It includes the window manager, decorator, settings panel and plugins.  
+
* {{AUR|compiz-bzr}} - This package provides the '''latest development version''' of the 0.9.x branch. It includes the window manager, decorator, settings panel and plugins.
+
  
=== Installing the 0.8.x branch ===
+
=== 0.8 series ===
  
Compiz can be installed from '''one''' of the following '''four''' packages:
+
{{Note|The GTK Window Decorator is provided by {{AUR|compiz-gtk}}, a split package from {{AUR|compiz-core}}.}}
* {{AUR|compiz-core}} - This package contains the Compiz window manager.
+
* {{AUR|compiz-pure}} - This package contains the Compiz window manager and the ''compiz-decorator-gtk'' window decorator.
+
* {{AUR|compiz}} - This package contains the Compiz window manager and both the ''compiz-decorator-gtk'' and ''kde-window-decorator'' window decorators.
+
* {{AUR|compiz-xfce}} - This package includes the Compiz window manager, compiz-decorator-gtk, settings panel and plugins. It is optimised for the [[Xfce]] desktop. The packages below are '''not''' required if you install this package.
+
  
The following packages are not essential but are '''highly recommended''':
+
Required:
* {{AUR|ccsm}} - a settings panel for compiz
+
* {{App|Compiz Core|OpenGL compositing window manager.|https://github.com/compiz-reloaded/compiz/|{{AUR|compiz-core}}}}
* {{AUR|compizconfig-python}} - Compizconfig bindings for python (required by ccsm)
+
* {{AUR|libcompizconfig}} - Compiz configuration system library (required by compizconfig-python)
+
* {{AUR|compiz-fusion-plugins-main}} - important plugins for Compiz
+
* {{AUR|compiz-fusion-plugins-extra}} - extra plugins for Compiz
+
* {{AUR|compiz-bcop}} - Compiz option code generator (required by all compiz-fusion-plugins)
+
  
The following packages are '''optional''':
+
Highly recommended:
* {{AUR|compiz-fusion-plugins-unsupported}} - unsupported plugins for Compiz
+
* {{App|CompizConfig Settings Manager|Graphical settings manager for Compiz.|https://github.com/compiz-reloaded/ccsm|{{AUR|ccsm}}}}
* {{AUR|fusion-icon}} - a tray applet that starts compiz and can load different window managers and decorators during a session
+
* {{App|Compiz Fusion Plugins Main|Main plugins collection for Compiz.|https://github.com/compiz-reloaded/compiz-plugins-main|{{AUR|compiz-fusion-plugins-main}}}}
* {{AUR|compiz-mate}} - a plugin for greater integration with the MATE desktop
+
* {{App|Compiz Fusion Plugins Extra|Extra plugins collection for Compiz.|https://github.com/compiz-reloaded/compiz-plugins-extra|{{AUR|compiz-fusion-plugins-extra}}}}
  
{{Note|
+
Optional:
* The compiz-mate and compiz-xfce packages are not required for Compiz to function in either desktop.
+
* {{App|Compiz Fusion Plugins Experimental|Experimental Compiz plugins (known as Plugins Unsupported prior to version 0.8.12).|https://github.com/compiz-reloaded/compiz-plugins-experimental|{{AUR|compiz-fusion-plugins-experimental}}}}
* The 0.8.x branch has not been updated for some time and is unlikely to be updated in the future as all work is concentrated on the 0.9.x branch.
+
}}
+
  
=== Installing a window decorator ===
+
=== Extras ===
  
Unlike window managers such as {{Pkg|mutter}}, Kwin or [[Xfwm]], Compiz does not provide a window decorator so you will need to install one yourself. Depending on which packages you used to install Compiz you may have a window decorator included already. There are three main decorators used with Compiz:
+
{{Note|Emerald since 0.8.12 and Fusion Icon since 0.1.2 support Compiz 0.9 as well as Compiz 0.8. Compiz 0.9 users using the older Emerald 0.9.5 release are recommended to switch to Emerald 0.8.12 or a higher version in the 0.8 series as Emerald 0.9 is not actively developed.}}
  
*'''Emerald''' - This decorator can be installed from the {{AUR|emerald}} package in the AUR. It has a number of themes available and supports various effects. You may also wish to install the {{AUR|emerald-themes}} package which contains a number of extra themes for emerald. If you are installing the 0.9.x branch from the {{AUR|compiz-bzr}} package then install the {{aur|emerald-git}} package to use Emerald with Compiz 0.9.x.
+
* {{App|Emerald|A standalone window decorator for Compiz.|https://github.com/compiz-reloaded/emerald|{{AUR|emerald}}}}
 +
* {{App|Emerald Themes|Extra themes for the Emerald window decorator.|https://github.com/compiz-reloaded/emerald-themes|{{AUR|emerald-themes}}}}
 +
* {{App|Fusion Icon|A tray applet for starting Compiz and switching window managers and decorators on the fly.|https://github.com/compiz-reloaded/fusion-icon|{{AUR|fusion-icon}}}}
 +
* {{App|Compiz Manager|A wrapper script to start Compiz.|https://github.com/compiz-reloaded/compiz-manager|{{AUR|compiz-manager}}}}
 +
* {{App|Simple CCSM|Simplified graphical settings manager for Compiz 0.8.|https://github.com/compiz-reloaded/simple-ccsm|{{AUR|simple-ccsm}}}}
  
*'''compiz-decorator-gtk''' - This decorator is included in the {{AUR|compiz-pure}}, {{AUR|compiz}} and {{AUR|compiz-xfce}} packages. If you are installing the {{AUR|compiz-core}} package you can install ''compiz-decorator-gtk'' seperately from the {{AUR|compiz-decorator-gtk-no-gnome}} package. For those installing the 0.9.x branch, ''compiz-decorator-gtk'' is included in the {{AUR|compiz-bzr}} and {{AUR|compiz-dev}} packages. This decorator can use Metacity or Cairo themes.
+
== Starting Compiz ==
  
*'''kde-window-decorator''' - The {{AUR|compiz}} package contains both the ''compiz-decorator-gtk'' and ''kde-window-decorator'' window decorators. The kde-window-decorator requires the {{Pkg|kdebase-workspace}} package which pulls in a number of KDE dependencies. Therefore it may not be the best solution in non KDE environments. If you are installing the 0.9.x branch and wish to use the ''kde-window-decorator'' modify the [[PKGBUILD]] of the package you are using and set {{ic|KDEWINDOWDECORATOR}} to {{ic|"on"}}. This decorator uses the current Kwin theme.
+
=== Enabling important plugins ===
  
== Starting the window decorator ==
+
{{Tip|Depending on which package you installed Compiz from, some of these plugins may already be activated.}}
  
Whist the appearance of the windows and their contents is a function of [[GTK+]] and [[Qt]], the frames around the windows are controlled by the Window Decoration plugin. To use it make sure you have a window decorator installed - see above. In a terminal enter {{ic|ccsm}}. In the panel, ensure that the 'Window Decoration' plugin is enabled in CCSM's 'Effects' tab. Click on the 'Window Decoration' button and in the 'Command' field enter the relevant command for your decorator - see below:
+
Before starting Compiz, you should activate some plugins to provide basic window manager behaviour or else you will have no ability to drag, scale or close any windows. Important plugins are listed below:
  
To set {{ic|emerald}} as your default window decorator use:
+
* Window Decoration - provides window borders, see [[#Window decoration]].
 +
* Move Window.
 +
* Resize Window.
 +
* Place Windows - configure window placement options.
 +
* Application Switcher - provides an {{ic|Alt+Tab}} switcher - there are numerous alternative application switcher plugins, for example: Shift Switcher, Static Application Switcher and more. Not all of them use the {{ic|Alt+Tab}} keybinding.
 +
 +
To be able to switch to different [[Compiz configuration#Workspaces and Viewports|viewports]] you will need to enable one of the following:
 +
* Desktop Cube & Rotate Cube - provides the spinning cube with each side being a different viewport.
 +
* Desktop Wall - viewports are arranged next to each other - the animation is similar to the workspace switching animation in [[Cinnamon]] and [[GNOME]] Shell.
 +
* Expo - creates a view of all viewports and windows when the mouse is moved into the top left corner - this plugin can be used on its own or in conjunction with either of the two previous plugins.
  
$ emerald --replace
+
==== Window decoration ====
  
The {{ic|emerald-theme-manager}} command will open a GUI for managing Emerald themes.
+
{{Tip|For information on selecting and managing themes, see: [[Compiz configuration#Window decoration themes]].}}
  
To set the {{ic|kde-window-decorator}} as your default window decorator use:
+
The window decorator is the program which provides windows with borders. Unlike window managers such as Kwin or [[Xfwm]] which provide just one decorator, users of Compiz have a choice of three: GTK Window Decorator, KDE Window Decorator and Emerald. The GTK Window Decorator and the KDE Window Decorator are included in the Compiz source and can be optionally compiled whilst building Compiz. Emerald, on the other hand, is a separate, standalone decorator. The ''Window Decoration'' plugin in CCSM must be ticked otherwise no window decorator will be started.
  
$ kde4-window-decorator --replace
+
;Choosing the decorator
 +
The window decorator that will be started is specified under CCSM -> ''Effects'' -> ''Window Decoration'' -> ''Command''. The command can be one of the following executables: ''emerald'', ''gtk-window-decorator'', ''kde4-window-decorator''. Use the {{ic|--replace}} switch, e.g. {{ic|emerald --replace}}, if specifying the decorator executable on its own is not sufficient.
  
To set {{ic|compiz-decorator-gtk}} as your default window decorator use:
+
{{Tip|In Compiz 0.9, the decorator command is set to ''compiz-decorator'' by default. This is a script which will search for the ''emerald'', ''gtk-window-decorator'' and ''kde4-window-decorator'' executables in that order and start the first one that it finds.}}
  
$ gtk-window-decorator --replace
+
=== Compiz startup ===
 
+
{{Note|
+
*You must '''activate important plugins''' to provide basic window manager behaviour or else you will have no ability to drag, scale or close any windows as soon as Compiz is activated. Among those plugins are 'Window Decoration' under 'Effects' and 'Move Window' & 'Resize Window' under 'Window Management.' These can be enabled with {{ic|ccsm}}.
+
*If you are using fusion-icon there is no need to set the command in CCSM as fusion-icon will do this automatically.
+
}}
+
 
+
== Starting Compiz ==
+
 
+
=== With fusion-icon ===
+
 
+
You can launch fusion-icon with the following command:
+
$ fusion-icon
+
 
+
To enable fusion-icon on startup you need to autostart it. Refer to the [[Autostarting]] article and your desktop environment's article for further instruction.
+
 
+
Right click on the icon in the panel and go to 'select window manager'. Choose 'Compiz' if it isn't selected already.
+
 
+
{{Note|
+
* Using fusion-icon means that the native window manager will be loaded first which will then be replaced by Compiz.
+
* It is uncertain whether fusion-icon is compatible with the 0.9.x branch.
+
}}
+
  
=== Without fusion-icon ===
+
{{Note|Some Compiz versions may require you to manually load the CCP plugin on startup: {{ic|compiz --replace ccp}} [http://blog.northfield.ws/compiz-release-announcement-0-8-12/]}}
  
 
You can start Compiz using the following command:
 
You can start Compiz using the following command:
  $ compiz --replace ccp &
+
  $ compiz --replace
  
See below for desktop environment specific instructions on how to start Compiz automatically without fusion-icon.
+
See {{ic|compiz --help}} for more options.
  
A quick overview over common Compiz command-line options:
+
==== Fusion Icon ====
* {{ic|--indirect-rendering}}: use indirect-rendering (AIGLX)
+
* {{ic|--loose-binding}}: can help performance issues (NVIDIA?)
+
* {{ic|--replace}}: replace current window-manager
+
* {{ic|--keep-window-hints}}: keep the gnome window manager gconf-settings for available viewports
+
* {{ic|--sm-disable}}: disable session-management
+
* {{ic|ccp}}: the 'ccp' command loads the last configured settings from CCSM (CompizConfig Settings Manager) otherwise Compiz will load with no settings and you won't be able to do anything with your windows like dragging, maximizing/minimizing, or moving.
+
  
=== Starting Compiz automatically without fusion-icon ===
+
{{Tip|When [[#Autostarting Compiz in a desktop environment]] ''fusion-icon'' can be set as the default command instead of ''compiz''.}}
  
Methods which involve starting the native window manager and then replacing it with Compiz have been indicated as such.
+
To start Compiz using Fusion Icon, execute the command below:
 +
$ fusion-icon
  
==== KDE4 ====
+
To ensure that ''fusion-icon'' then starts Compiz, right click on the icon in the panel and go to ''select window manager''. Choose ''Compiz'' if it is not selected already.
  
===== Use System Settings =====
+
=== Autostarting Compiz in a desktop environment ===
  
Go to: ''System Settings > Default Applications > Window Manager > Use a different window manager''
+
See [[Desktop environment#Custom window manager]].
  
If you need to run Compiz with custom options select "Compiz custom", then create the following script:
+
== Using Compiz as a standalone window manager ==
  
{{hc|/usr/local/bin/compiz-kde-launcher|
+
=== Starting the session with a display manager ===
#!/bin/bash
+
LIBGL_ALWAYS_INDIRECT=1
+
compiz --replace ccp &
+
wait
+
}}
+
  
Then make it executable:
+
A standalone Compiz session can be started from a [[display manager]]. For most display manager's - [[LightDM]] for example - all that is required is to create a {{ic|.desktop}} file in {{ic|/usr/share/xsessions}} that executes ''compiz'' (with command line options if needed) or ''fusion-icon''. See the article for your display manager. See [[Desktop entries]] for information on creating a {{ic|.desktop}} file.
$ chmod +x /usr/local/bin/compiz-kde-launcher
+
  
===== Autostart link =====
+
==== Autostarting programs when using a display manager ====
  
{{Warning|Do '''not''' create {{ic|compiz.desktop}} if you intend to install compiz-decorator-gtk as it will create a file conflict.}}
+
One way in which you could start programs with your Compiz session, when it is started from a [[display manager]], is to use an [[xprofile]] file. Another option is for the {{ic|.desktop}} file in {{ic|/usr/share/xsessions}} to not execute ''compiz'' directly but to execute a script which starts the programs you wish to start and also starts Compiz.
  
Append a desktop entry in the KDE Autostart directory. If it doesn't exist already (it should), create it:
+
=== Starting the session with startx ===
  
{{hc|~/.kde4/Autostart/compiz.desktop|2=
+
A Compiz session can be started with ''startx''. Define either ''compiz'' or ''fusion-icon'' in your {{ic|.xinitrc}} file. See the [[xinitrc]] article for more details.
[Desktop Entry]
+
Type=Application
+
Encoding=UTF-8
+
Name=Compiz
+
Exec=/usr/bin/compiz ccp --replace
+
NoDisplay=true
+
# name of loadable control center module
+
X-GNOME-WMSettingsModule=compiz
+
# autostart phase
+
X-GNOME-Autostart-Phase=WindowManager
+
X-GNOME-Provides=windowmanager
+
# name we put on the WM spec check window
+
X-GNOME-WMName=Compiz
+
# back compat only
+
X-GnomeWMSettingsLibrary=compiz
+
}}
+
  
{{Note|If {{ic|compiz.desktop}} already exists, you may have to add {{ic|--replace}} and/or {{ic|ccp}} to the {{ic|Exec}} variable. Without {{ic|--replace}}, Compiz won't load since it will detect another window manager already loaded. Without {{ic|ccp}}, Compiz will not load any of the settings and plugins that you have enabled through CompizConfig Settings Manager ({{ic|ccsm}}) and you won't be able to manipulate any of your windows.}}
+
=== Add a root menu ===
  
===== Export KDEWM =====
+
To add a root menu similar to that in [[Openbox]] and other standalone window managers install {{AUR|compiz-boxmenu}}. This program is a fork of {{AUR|compiz-deskmenu}}.
  
As root you must create a short script.  This will allow you to load Compiz with extra switches as doing it directly via {{ic|1=$ export KDEWM="compiz --replace ccp --sm-disable"}} may not work.
+
Then copy the config files to your home directory as shown below:
  
Create the file with the necessary text by using the command below:
+
  # cp -R /etc/xdg/compiz /home/''username''/.config
  $ echo "compiz --replace ccp --sm-disable &" > /usr/bin/compiz-fusion
+
# chown -R ''username'':''group'' /home/''username''/.config/compiz
  
Ensure that {{ic|/usr/bin/compiz-fusion}} has executable ({{ic|+x}}) permissions.
+
where {{ic|username}} is your username and {{ic|group}} is the primary group for your user.
  
$ chmod +x /usr/bin/compiz-fusion
+
Then, open CCSM, navigate to the ''Commands'' plugin and in ''Command line 0'' enter the command {{ic|compiz-boxmenu}}. In the ''Key Bindings'' tab, set ''Run command 0'' to {{ic|Control+Space}} or another key/mouse button combination of choice. Take care not to use a combination that is already used for other functionality.
  
Choose one of the following:
+
Now navigate to the ''Viewport Switcher'' plugin and click on the ''Desktop-based Viewport Switching'' tab. Change the ''Plugin for initiate action'' to {{ic|core}} and change ''Action name for initiate'' to {{ic|run_command0_key}}.
  
1) For your user only:
+
You should now find that a menu appears when you click {{ic|Control+Space}}. To launch a graphical menu editor, click on the ''Edit'' option or run {{ic|compiz-boxmenu-editor}} in a terminal. If you would prefer to edit your menu manually, open the following file in your favourite editor: {{ic|~/.config/compiz/boxmenu/menu.xml}}. For your changes to take effect, you must click the ''Reload'' option in your menu.
  
{{hc|~/.kde4/env/compiz.sh|2=
+
=== Allow users to shutdown/reboot ===
KDEWM="compiz-fusion"
+
}}
+
  
2) System-wide:
+
An unprivileged user should be able to execute commands such as {{ic|systemctl poweroff}} and {{ic|systemctl reboot}}. You could assign a keyboard shortcut to one of these commands using the ''Commands'' plugin in CCSM. Alternatively, you could create a launcher for one of these commands in {{AUR|compiz-boxmenu}} - see above. For more detailed information on shutting down see the following article: [[Allow users to shutdown]].
  
{{hc|/etc/kde/env/compiz.sh|2=
+
== Tips and tricks ==
KDEWM="compiz-fusion"
+
}}
+
  
{{Note|
+
=== Restoring the native window manager ===
* If the above method does not work, an alternate approach is to include the line:
+
  
$ export KDEWM="compiz-fusion"
+
You can switch back to your desktop environment's default window manager with the following command:
  
: in your user's {{ic|~/.bashrc}} file.
+
''wm_name'' --replace
  
* If you optionally use the {{ic|/usr/local/bin}} directory it may not work. In that case you should export the script including the whole path:
+
using ''kwin'', ''metacity'' or ''xfwm4'' for example instead of ''wm_name''.
  
$ export KDEWM="/usr/local/bin/compiz-fusion"
+
=== Enabling the Alt+F2 run dialog ===
}}
+
  
==== GNOME ====
+
;GNOME Panel
  
===== GNOME Shell =====
+
Enable the ''Gnome Compatibility'' plugin in CCSM.
  
[[GNOME]] Shell is set up as a plugin of the {{pkg|mutter}} window manager. This means that it is impossible to use GNOME Shell with Compiz or any other window manager.
+
;MATE Panel
  
{{warning|If you have another desktop environment installed alongside GNOME Shell and you are starting Compiz in that environment using a 'session-properties' dialogue or similar program ensure that the Compiz entry is disabled when using GNOME Shell as it could cause the shell to crash or freeze.}}
+
There are two ways to enable MATE Panel's run dialog in Compiz. You can either:
  
===== Alternate Session for GNOME (Cairo dock and Compiz) =====
+
* Enable the ''MATE Compatibility'' plugin in CCSM (use the ''Gnome Compatibility'' plugin for older Compiz versions which lack the MATE plugin).
 +
* Map the command below to the {{ic|Alt+F2}} key combination using the ''Commands'' plugin in CCSM.
  
The {{AUR|gnome-session-compiz}} package can be used to add an additional session in a [[display manager]]. Simply select the 'gnome-session-compiz' option in your display manager.
+
mate-panel --run-dialog
  
Ensure that Compiz and Cairo Dock (Taskbar/Panel) have been configured correctly.
+
;LXDE Panel
  
In CCSM ensure that a window decorator is selected and the necessary plugins for window management have been enabled. See [[Compiz#Starting_the_window_decorator|here]].
+
Map the command below to the {{ic|Alt+F2}} key combination using the ''Commands'' plugin in CCSM.
  
See below for recommended Cairo dock configuration:
+
lxpanelctl run
  
* Add Application Menu icon to Cairo Dock and remember its key-bindings.
+
;Xfce Appfinder
* Remap Application Menu key-bindings to {{ic|ALT+F1}} and {{ic|ALT+F2}}, for convenience.
+
* Add Clock, WiFi, NetSpeed icons to the dock as applicable.
+
* Add Log-out icon:
+
** Set the command for logout to {{ic|gnome-session-quit --logout}}
+
** Set the command for shutdown to {{ic|gnome-session-quit --power-off}}
+
* Add the Notification Area Old (systray) icon to Cairo Dock.
+
  
===== GNOME Flashback =====
+
When Compiz is used in an Xfce session, the run dialog (provided by {{Pkg|xfce4-appfinder}}) should work without intervention. If you are using Xfce Appfinder in a standalone Compiz session, map the command below to the {{ic|Alt+F2}} key combination using the ''Commands'' plugin in CCSM.
  
Compiz can replace the {{pkg|metacity}} window manager in the [[GNOME Flashback]] session. In a terminal enter the command:
+
  xfce4-appfinder --collapsed
  $ gnome-session-properties
+
  
Click on the add button and in the command section enter the {{ic|compiz --replace ccp &}} command. The name and comment sections are unimportant and are just there to indicate what the entry does. Log out and log in again and Compiz should start.
+
;Other run dialogs
  
{{Note|
+
Map the command for a [[List of applications#Application launchers|run dialog]] of choice to the {{ic|Alt+F2}} key combination using the ''Commands'' plugin in CCSM.
* This method will mean that metacity starts first and is then replaced by Compiz.
+
* You can also use this method to start fusion-icon.
+
}}
+
  
==== MATE ====
+
=== Remove title bar from maximized windows ===
 +
As mentioned [http://planetkris.com/2009/07/how-to-remove-the-title-bar-with-compiz-without-losing-3-hours-of-your-life/ here ], enter {{ic|ccsm}} --> {{ic|Window Decoration}} in Effects --> {{ic|Decoration Windows}} : change {{ic|any}} to {{ic|1=!state=maxvert}}.
  
===== Using gsettings =====
+
== Troubleshooting ==
  
Use the following gsettings command to change the default window manager from ''marco'' to Compiz.
+
=== Missing GLX_EXT_texture_from_pixmaps ===
$ gsettings set org.mate.session.required-components windowmanager compiz
+
  
===== Using mate-session-properties =====
+
==== On ATI cards (first solution) ====
  
Another approach is to start Compiz using mate-session-properties. In a terminal enter the command:
+
You may run into the following error when trying to run Compiz on an ATI card:
$ mate-session-properties
+
  
Click on the add button and in the command section enter the {{ic|compiz --replace ccp &}} command. The name and comment sections are unimportant and are just there to indicate what the entry does. Log out and log in again and Compiz should start.
+
Missing GLX_EXT_texture_from_pixmap
  
{{Note|
+
This is because Compiz's binary was compiled against Mesa's OpenGL library rather than ATI's OpenGL library.
* The first method will mean that only Compiz is started. The second method means that marco is started first and is then replaced by Compiz.
+
* You can also use the second method to start fusion-icon.
+
}}
+
  
==== Xfce ====
+
Firstly, copy the library into a directory to keep it because ATI's drivers will over write it: 
 +
 +
$ install -Dm644 /usr/lib/libGL.so.1.2 /usr/lib/mesa/libGL.so.1.2
 +
Then you can reinstall your fglrx drivers.  Now start Compiz as shown below:
 +
 +
LD_PRELOAD=/usr/lib/mesa/libGL.so.1.2 compiz --replace &
  
===== Modifying the failsafe session =====
+
==== On ATI cards (second solution) ====
  
To configure the default/failsafe session of Xfce, edit the {{ic|~/.config/xfce4/xfconf/xfce-perchannel-xml/xfce4-session.xml}} or (to make the change for all Xfce users) {{ic|/etc/xdg/xfce4/xfconf/xfce-perchannel-xml/xfce4-session.xml}}:
+
Another possible problem with ''GLX_EXT_texture_from_pixmap'' on ATI cards is that the card can only render it indirectly. If so, you have to pass the option to your libgl as shown below:
  
Replace the xfwm startup command,
+
LIBGL_ALWAYS_INDIRECT=1 compiz --replace &
  
  <property name="Client0_Command" type="array">
+
This workaround was tested on the following card : ATI Technologies Inc Radeon R250 [Mobility FireGL 9000] (rev 02).
    <value type="string" value="xfwm4"/>
+
  </property>
+
  
with the following:
+
==== On Intel chips ====
  
  <property name="Client0_Command" type="array">
+
Firstly, check that you're using the intel driver as opposed to i810. Then, use the following command to start Compiz (this command must be used every time).
    <value type="string" value="compiz"/>
+
LIBGL_ALWAYS_INDIRECT=true compiz --replace --sm-disable &
    <value type="string" value="ccp"/>
+
  </property>
+
  
{{Note|
+
=== Compiz starts without window borders with NVIDIA binary drivers ===
*The ccp value will tell Compiz to load your previous Compiz settings as configured with CompizConfig Settings Manager (ccsm).
+
*If the xfce4-session.xml file does not exist in {{ic|~/.config/xfce4/xfconf/xfce-perchannel-xml}} then you will need to edit the file in {{ic|/etc/xdg/xfce4/xfconf/xfce-perchannel-xml}}
+
}}
+
  
To prevent the default session from being overwritten you may also add this:
+
Firstly, ensure that your window decorator settings are configured correctly - see [[#Window decoration]]. If window borders still do not start try adding ''Option "AddARGBGLXVisuals" "True"'' and ''Option "DisableGLXRootClipping" "True"'' to your "Screen" section in {{ic|/etc/X11/xorg.conf.d/20-nvidia.conf}}. If window borders still do not load and you have used other Options elsewhere in {{ic|/etc/X11/xorg.conf.d/}} try commenting them out and using only the aformentioned ARGBGLXVisuals and GLXRootClipping Options.
  
  <property name="general" type="empty">
+
=== Blank screen on resume from suspend-to-ram with NVIDIA binary drivers ===
    ...
+
    ...
+
    <property name="SaveOnExit" type="bool" value="false"/>
+
  </property>
+
  
Then you will need to remove the existing sessions:
+
If you receive a blank screen with a responsive cursor upon resume, try disabling sync to vblank. To do so, open CCSM, navigate to the ''OpenGL'' plugin and untick the ''Sync to VBlank'' option.
  
$ rm -r ~/.cache/sessions
+
=== Poor performance from capable graphics cards ===
  
Log out and log in again and Compiz should start.
+
'''NVIDIA and Intel chips''': If everything is configured correctly but you still have poor performance with some effects, try disabling ''CCSM > General Options > Display Settings > Detect Refresh Rate'' and instead choose a value manually.
  
{{tip|When logging out after this edit ensure that the 'Save session for future logins' option in the logout dialogue is '''unticked'''. Once Compiz has started you can then tick the option again.}}
+
'''NVIDIA chips only''': The inadequate refresh rate with ''Detect Refresh Rate'' may be due to an option called ''DynamicTwinView'' being enabled by default which plays a factor in accurately reporting the maximum refresh rate that your card and display support. You can disable ''DynamicTwinView'' by adding the following line to the "Device" or "Screen" section of your {{ic|/etc/X11/xorg.conf.d/20-nvidia.conf}}, and then restarting your computer:
  
===== Using Xfce application autostart =====
+
Option "DynamicTwinView" "False"
  
In the Xfce main menu navigate to 'Settings' and click on 'Session and Startup.' Click on the 'Application Autostart' tab. Click the add button and in the command section enter the {{ic|compiz --replace ccp &}} command. The name and comment sections are unimportant and are just there to indicate what the entry does. Log out and log in again and Compiz should start.
+
=== Screen flicks with NVIDIA card ===
  
{{Note|
+
To fix this behaviour create the file below:
* The first method will mean that only Compiz is started. The second method means that xfwm4 is started first and is then replaced by Compiz.
+
{{hc|/etc/modprobe.d/nvidia.conf|2=
* You can also use the second method to start fusion-icon.
+
options nvidia NVreg_RegistryDwords="PerfLevelSrc=0x2222"
 
}}
 
}}
  
== Using Compiz as a standalone window manager ==
+
=== Video tearing ===
To start Compix configure {{ic|.xinitrc}} to launch Compiz as:
+
  
{{hc|~/.xinitrc|
+
If you experience video tearing when using Compiz, try enabling the ''Workarounds'' plugin in CCSM. Once enabled, ensure that the following options are enabled in Workarounds: ''Force complete redraw on initial damage'', ''Force full screen redraws (buffer swap) on repaint''.
exec compiz ccp
+
}}
+
  
You can also use fusion icon as shown below:
+
If you are using [[Intel graphics]] and the workaround above does not fix the video tearing, see [[Intel graphics#Tear-free video]].
  
{{hc|~/.xinitrc|
+
Also see, [[#Poor performance from capable graphics cards]].
exec fusion-icon
+
}}
+
  
However chances are you will need additional apps (e.g a panel) for optimal usability. Below is an example of a {{ic|~/.xinitrc}} file which starts Compiz (through fusion-icon), the tint2 panel and the Cairo dock.
+
=== Compiz effects not working (GConf backend) ===
  
{{hc|~/.xinitrc|
+
If you have installed the GTK Window Decorator, check if the GConf schema was correctly installed:
tint2 &
+
cairo-dock &
+
exec fusion-icon
+
}}
+
  
=== Add a root menu ===
+
$ gconftool-2 -R /apps/compiz/plugins | grep plugins
  
To add a root menu similar to that in Openbox and other standalone window managers you must install the package {{AUR|compiz-deskmenu}}.
+
Make sure that all plugins are listed. If they are not, try to install the Compiz schema manually (do '''not''' run this command as root):
Upon a restart of Compiz, you should be able to middle click on your desktop to launch the menu.
+
  
If it does not automatically work, enter the CompizConfig Settings Manager, and in the Commands plugin section, within the 'General' tab, ensure that there is a command to launch Compiz-Deskmenu, and the appropriate key binding is set to {{ic|Ctrl+Space}}.
+
$ gconftool-2 --install-schema-file=/usr/share/gconf/schemas/compiz-decorator-gtk.schemas
  
If it still does not work, enter the Viewport Switcher menu, and change 'Plugin for initiate action' to 'commands', and 'Action name for initiate' to {{ic|run_command0_key}}.
+
=== Fusion Icon fails to start ===
  
Aletrnatively you can use {{AUR|mygtkmenu}}, which is also in the [[AUR]].
+
If you get an output like this from the command line:
 
+
{{hc|$ fusion-icon|
=== Allow users to shutdown/reboot ===
+
* Detected Session: gnome
 
+
* Searching for installed applications...
If you are using policykit you can add the command to ''CCSM > General > Commands'' and assign a short-cut key to it or alternatively you can use a launcher application. See [[Allow_Users_to_Shutdown|here]] for further information.
+
Traceback (most recent call last):
 
+
  File "/usr/bin/fusion-icon", line 57, in <module>
== Tips and tricks ==
+
    from FusionIcon.interface import choose_interface
 
+
  File "/usr/lib/python2.5/site-packages/FusionIcon/interface.py", line 23, in <module>
=== Fallback ===
+
    import start
 
+
  File "/usr/lib/python2.5/site-packages/FusionIcon/start.py", line 36, in <module>
If you are using [[KDE]], [[GNOME]] or [[Xfce]] and you are experiencing problems, for example you don’t see borders for your window, you can switch back to the default DE window manager with this command:
+
    config.check()
 
+
  File "/usr/lib/python2.5/site-packages/FusionIcon/util.py", line 362, in check
''wm_name'' --replace
+
    os.makedirs(self.config_folder)
 
+
  File "/usr/lib/python2.5/os.py", line 172, in makedirs
with {{ic|kwin}}, {{ic|metacity}} or {{ic|xfwm4}} instead of {{ic|wm_name}}.
+
    mkdir(name, mode)
 
+
OSError: [Errno 13] Permission denied: '/home/andy/.config/compiz'
=== Keyboard shortcuts ===
+
 
+
Below is a list of the default keyboard shortcuts for Compiz. The 'Commands' plugin needs to be activated in the CCSM panel.
+
 
+
* Switch windows = {{ic|Alt+Tab}}.
+
* Switch to next desktops = {{ic|Ctrl+Alt+&larr;}}.
+
* Switch to previous desktop = {{ic|Ctrl+Alt+&rarr;}}.
+
* Move window = {{ic|Alt+Left click}}.
+
* Resize window = {{ic|Alt+Right click}}.
+
 
+
A more detailed list can be found under [http://wiki.compiz-fusion.org/CommonKeyboardShortcuts CommonKeyboardShortcuts] in the Compiz wiki or you can always just look at your plugin's configuration.
+
 
+
=== Enable window snapping in Compiz ===
+
 
+
If you want to compare two windows side by side by dragging them to the edges of the screen, similar to the 'Aero Snap' feature introduced in Windows 7, enable the 'Grid' plugin in {{ic|ccsm}}. If you are using the 'Desktop Wall' or 'Rotate Cube' plugin then disable the 'Edge Flip' options in that plugin's section to ensure that windows do not move to the next desktop when dragged to the screen edge.
+
 
+
{{tip|The plugin in {{ic|ccsm}} labelled 'Snapping Windows' merely adds resistance to the edges of the screen. It does not resize windows that are dragged to the screen edge.}}
+
 
+
=== Profiles ===
+
 
+
Profiles allow you to switch between different sets of Compiz settings easily. To create a new profile open {{ic|ccsm}} and click on the 'Preferences' tab. Under 'Profile' click the plus sign to add a new profile or the minus sign to delete one. All changes made in {{ic|ccsm}} will be written to your current profile.
+
 
+
{{Note|
+
* Profiles are specific to the backend you are using. For instance, if you are using the gsettings backend then any new profile you create will be a gsettings profile. If you switch to a different backend then your current profile will not work and you will automatically switch to a profile available for that backend.
+
* If you see more than one profile named 'Default' this is likely because you have used more than one backend e.g. you will have a default profile for ini and a default profile for gsettings or gconf.
+
 
}}
 
}}
  
=== Changing the backend ===
+
the problem is with the permission on {{ic|~/.config/compiz/}}. To fix it, use:
  
By default Compiz stores its configuration settings in a plain text file {{ic|~/.config/compiz-1/compizconfig/Default.ini}}. In {{ic|ccsm}} this is known as 'Flat-file Configuration Backend.'
+
# chown -R ''username'' /home/''username''/.config/compiz/
  
Compiz can also store its settings in the gsettings or gconf databases. To change how Compiz saves its settings open {{ic|ccsm}} and click on the 'Preferences' tab in the left hand column. Then choose your desired backend from the list under 'Backend.'
+
=== Alt+F4 keybinding not working (Xfce) ===
  
You can also change the backend manually by editing the {{ic|~/.config/compiz-1/compizconfig/config}} file.
+
If Compiz replaces Xfwm4 at login, this can cause the {{ic|Alt+F4}} keybinding to become non-functional. To avoid this issue, ensure that only Compiz is started at login - see [[Xfce#Default window manager]].
  
Edit the line below:
+
=== Emerald crashes when selecting a theme ===
backend = ini
+
  
* ini = Flat File Configuration Backend
+
You may find that Emerald crashes when selecting certain themes (especially themes that use the legacy engine). If this occurs, select another theme in Emerald Theme Manager and then run the command {{ic|emerald --replace}}.
* gsettings = GSettings Configuration Backend
+
* gconf = GConf Configuration Backend
+
  
Once you have edited and saved the file the change will take place immediately. There is no need to log out.
+
=== No system bell when Compiz is running ===
  
== Troubleshooting ==
+
You may find that the system bell (such as the drip sound played when pressing backspace at the beginning of a line in GNOME or MATE Terminal) will not sound if Compiz is running. See the following [https://bugs.launchpad.net/ubuntu/+source/compiz/+bug/537703 upstream bug report].
  
=== All windows start maximised ===
+
[[PulseAudio]] users, as a workaround, can force PulseAudio to handle the system bell, see [[PulseAudio#X11 Bell Events]].
  
If all windows in Compiz start maximised then open {{ic|ccsm}}, click on the 'Place Windows' plugin and set the 'Placement Mode' to 'Smart.'
+
=== Compiz crashes when enabling the Gnome Compatibility plugin (GSettings backend) ===
  
=== No Alt-F2 run dialog in MATE ===
+
If you are using the GSettings backend, you may find that Compiz crashes if you try to enable the ''Gnome Compatibility'' plugin. In order to enable this plugin whilst using the GSettings backend you need to open CCSM and navigate to ''Preferences''. Under the header ''Integration'' untick the box labelled ''Enable integration into the desktop environment''. After unticking this option, you should find it possible to enable the ''Gnome Compatibility'' plugin.
  
If you are using Compiz in [[MATE]] follow the instructions below to restore the Alt-F2 run dialog.
+
=== Windows lose focus when unminimised ===
  
Start {{ic|ccsm}}. Ensure that the 'Commands' plugin is ticked. Click on the 'Commands' button and enter the following command in a free command line box e.g. 'Command line 0'
+
You may find that certain windows (such as a [[Chromium]] window) will lose focus when unminimised. See the following [https://bugs.launchpad.net/compiz/+bug/1328779 upstream bug report]. One possible solution is to enable the ''Keep previews of minimized windows'' option, located within the ''Workarounds'' plugin.
  
mate-panel --run-dialog
+
{{Note|If you use the Chrome/Chromium browser and you enable this workaround, you will need to ensure that the ''Use system title bar and borders'' option within Chrome is enabled. If Chrome's own titlebar is used with the ''Keep previews of minimized windows'' Compiz workaround then when Chrome is minimized, the desktop beneath will become unresponsive.}}
  
Then click on the 'Key Bindings' tab. Click on the button labelled 'Disabled' for the appropriate command line box e.g. if you entered the command in 'Command line 0' click the 'Disabled' box adjacent to 'Run command 0.' In the box that appears tick the 'Enabled' option. Then click the 'Grab key combination' button and hit Alt-F2. Click 'Ok.'
+
=== Popout windows are offset when Compiz is running ===
  
{{tip|If the Alt-F2 run dialog window is always launched out of focus then start {{ic|ccsm}}, click on 'General Options' and click on the 'Focus & Raise Behaviour' tab. Change the 'Focus Prevention Level' setting to 'Off.'}}
+
You may find that popout windows for panels which are placed at the bottom of the screen are offset by a few pixels so that the window appears to float above the panel. This problem is known to affect Xfce and KDE and may affect other desktops as well. Listed below are a number of workarounds that might fix some cases.
  
=== Missing GLX_EXT_texture_from_pixmaps ===
+
* Place the panel at the top of screen instead of the bottom - this should work in most cases.
 +
* Disable the ''Place Windows'' plugin - this works for the Xfce Whisker Menu plugin but may not work elsewhere.
 +
* Use fixed window placement to determine the window's position. This can be set from the ''Place Windows'' plugin. For instance, for the Whisker Menu, specify that the window with the title ''Whisker Menu'' should appear at (-1, -1).
  
==== On ATI cards (first solution) ====
+
For more information, see the following [https://bugs.launchpad.net/compiz/+bug/1419346 upstream bug report].
  
If you run into the following error when trying to run Compiz on an ATI card:
+
=== Alt-Tab switcher has no background (Emerald) ===
  
Missing GLX_EXT_texture_from_pixmap
+
You may find that the {{ic|Alt-Tab}} switcher (provided by the staticswitcher or switcher plugins) has a completely transparent background when using Emerald as well. This can make it hard to differentiate window thumbnails from the desktop background behind them. As of Compiz 0.9.12 ([http://bazaar.launchpad.net/~compiz-team/compiz/0.9.12/revision/3975 revision 3975]) a workaround is available. In CCSM, navigate to ''Application Switcher'' or ''Static Application Switcher'' depending on which plugin you are using. For the former, the ''Background'' settings are located under ''General'' and for the latter the settings are located under ''Appearance''. Once you have found the settings, ensure that the ''Set background color'' box is ticked. The default is a dark grey which can be optionally changed.
  
This is because Compiz's binary was compiled against Mesa's OpenGL library rather than ATI's OpenGL library (which is what you are using).
+
Alternatively, use GTK Window Decorator instead of Emerald or use a different window switcher altogether such as the shift switcher. Note that even if you are using the GTK Window Decorator, you can still change the background color as described above.
  
copy the library into a directory to keep it because ATI's drivers will over write it. 
+
== Known issues ==
+
$ install -Dm644 /usr/lib/libGL.so.1.2 /usr/lib/mesa/libGL.so.1.2
+
  
Once you have it copied, you can reinstall your fglrx drivers. Now you can start Compiz using the following example syntax:
+
=== Plugins in Compiz 0.8 are not present in Compiz 0.9 ===
+
LD_PRELOAD=/usr/lib/mesa/libGL.so.1.2 compiz --replace &
+
  
==== On ATI cards (second solution) ====
+
Some plugins that were popular in Compiz 0.8 were disabled in Compiz versions 0.9.8 and above in order to complete [[Wikipedia:OpenGL ES|OpenGL ES]] support. A few of the disabled plugins have since been re-enabled; for instance, the ''Animations Add-On'' plugin was re-enabled for the Compiz 0.9.13.0 release. Other currently-disabled plugins that receive patches for this issue may well be re-enabled in future releases. For more information, see the [https://launchpad.net/compiz/0.9.8/0.9.8.0 Compiz 0.9.8 release notes].
  
Another problem that could arise is with 'GLX_EXT_texture_from_pixmap.' it is possible that the card could only render it indirectly. If so, you have to pass the option to your libgl as shown below:
+
Likewise, Compiz Plugins Unsupported (a package which includes plugins such as ''Atlantis'') is unavailable in recent versions of Compiz 0.9. It has not been developed for the Compiz 0.9 series since Compiz 0.9.5 and no longer builds successfully.
  
LIBGL_ALWAYS_INDIRECT=1 compiz --replace ccp &
+
=== Xfce panel window buttons are not refreshed when a window changes viewport ===
  
(Workaround tested on the following card : ATI Technologies Inc Radeon R250 [Mobility FireGL 9000] (rev 02))
+
You may find that if you right click on a window title and choose an option such as ''Move to Workspace Right'' then the window will move but the window button will still be visible in the viewport the window moved from until you switch viewports. This issue can be fixed by replacing {{Pkg|xfce4-panel}} with {{AUR|xfce4-panel-compiz}} which incorporates a patch for this issue. See the following [https://bugzilla.xfce.org/show_bug.cgi?id=10908 upstream bug report] for more information.
  
==== On Intel chips ====
+
=== Compiz crashes when enabling the D-Bus plugin ===
  
Firstly, check that you're using the intel driver as opposed to i810. Then, run the following command to run Compiz (This must be used every time).
+
The ''D-Bus'' plugin will cause Compiz to crash if enabled in conjunction with certain other plugins such as the ''Cube'' plugin. See the following [https://bugs.launchpad.net/compiz/+bug/959395 upstream bug report].
LIBGL_ALWAYS_INDIRECT=true compiz --replace --sm-disable ccp &
+
  
As at 17-Oct-07 the [http://wiki.compiz-fusion.org/Troubleshooting Compiz-Fusion Wiki] states: <i>"If you are using an Intel GMA card with AIGLX, you will need to start Compiz Fusion with LIBGL_ALWAYS_INDIRECT=1 appended.</i>"
+
=== Workspace pager and window buttons issues ===
  
=== Compiz effects not working (gconf backend) ===
+
Only a few [[List of applications#Taskbars / panels / docks|panels and docks]] are compatible with Compiz's [[Compiz configuration#Workspaces and Viewports|viewports]]. Incompatible panels and docks may display issues such as showing all window buttons in all workspaces or the workspace pager may only show one workspace available. The panels listed below are known to be compatible:
  
If you have installed {{ic|compiz-decorator-gtk}}:
+
*{{Pkg|xfce4-panel}}
Check if GConf schema was correctly installed:
+
*{{Pkg|mate-panel}}
 +
*{{Pkg|perlpanel}}
 +
*{{Pkg|gnome-panel}}
 +
*{{Pkg|cairo-dock}}
  
$ gconftool-2 -R /apps/compiz/plugins | grep plugins
+
=== Xfce workspace switcher has wrong aspect ratio ===
  
make sure that all plugins are listed (not only fade!). If not, try to install Compiz schema manually (do this as normal user, not as root!!!):
+
When Compiz is used with Xfce Panel 4.11 and above, the workspace pager will use the width of only one workspace but will divide this space into ever smaller bars, according to how many viewports Compiz will specify. This issue can be fixed by replacing {{Pkg|xfce4-panel}} with {{AUR|xfce4-panel-compiz}} which incorporates a patch for this issue. For more information, see the following [https://bugzilla.xfce.org/show_bug.cgi?id=11697 upstream bug report].
 
+
$ gconftool-2 --install-schema-file=/usr/share/gconf/schemas/compiz-decorator-gtk.schemas
+
 
+
=== Compiz starts without window borders with NVIDIA binary drivers ===
+
 
+
Firstly ensure that you have configured the settings discussed [[Compiz#Starting_the_window_decorator|here]] correctly. If window borders still do not start try adding ''Option "AddARGBGLXVisuals" "True"'' and ''Option "DisableGLXRootClipping" "True"'' to your "Screen" section in the config file if you are using the NVIDIA binary driver. If you used any other Options elsewhere in {{ic|/etc/X11/xorg.conf.d/}} to get Compiz working and still have no luck, try commenting them out and using only the aformentioned ARGBGLXVisuals and GLXRootClipping Options.
+
 
+
=== Blank screen on resume from suspend-to-ram using the NVIDIA binary drivers ===
+
 
+
If you receive a blank screen with a responsive cursor upon resume, try disabling sync to vblank:
+
 
+
$ gconftool -s /apps/compiz/general/screen0/options/sync_to_vblank-t boolean false
+
 
+
=== fusion-icon doesn't start ===
+
 
+
If you get an output like this from the command line:
+
{{hc|$ fusion-icon|
+
* Detected Session: gnome
+
* Searching for installed applications...
+
Traceback (most recent call last):
+
  File "/usr/bin/fusion-icon", line 57, in <module>
+
    from FusionIcon.interface import choose_interface
+
  File "/usr/lib/python2.5/site-packages/FusionIcon/interface.py", line 23, in <module>
+
    import start
+
  File "/usr/lib/python2.5/site-packages/FusionIcon/start.py", line 36, in <module>
+
    config.check()
+
  File "/usr/lib/python2.5/site-packages/FusionIcon/util.py", line 362, in check
+
    os.makedirs(self.config_folder)
+
  File "/usr/lib/python2.5/os.py", line 172, in makedirs
+
    mkdir(name, mode)
+
OSError: [Errno 13] Permission denied: '/home/andy/.config/compiz'
+
}}
+
 
+
the problem is with the permission on {{ic|~/.config/compiz/}}. To fix it, use:
+
 
+
# chown -R ''username'' /home/''username''/.config/compiz/
+
 
+
=== Poor performance from capable graphics cards ===
+
 
+
If everything is configured correctly but you still have poor performance with some effects, try disabling ''CCSM > General Options > Display Settings > Detect Refresh Rate'' and instead choose a value manually. This workaround has been tested on both '''NVIDIA and Intel chips'''.
+
 
+
'''NVIDIA Chips Only''': The inadequate refresh rate with 'Detect Refresh Rate' may be due to an option called 'DynamicTwinView' being enabled by default which plays a factor in accurately reporting the maximum refresh rate that your card and display support. You can disable 'DynamicTwinView' by adding the following line to the "Device" or "Screen" section of your {{ic|/etc/X11/xorg.conf.d/*.conf}}, and then restarting your computer:
+
 
+
Option "DynamicTwinView" "False"
+
 
+
=== Screen flicks with NVIDIA card ===
+
 
+
To fix it, create the following:
+
{{hc|/etc/modprobe.d/nvidia.conf|2=
+
options nvidia NVreg_RegistryDwords="PerfLevelSrc=0x2222"
+
}}
+
  
 
== See also ==
 
== See also ==
  
* [http://compiz.org Compiz website], including wiki and forum
+
* [https://launchpad.net/compiz Compiz in Launchpad]
* [https://launchpad.net/compiz Compiz development]
+
* [https://github.com/compiz-reloaded Compiz in GitHub]
* [http://wiki.compiz.org/Troubleshooting Troubleshooting page] on Compiz wiki
+
* [http://compiz.org Compiz Home], including wiki and forum (website and wiki are unmaintained)
* [http://wiki.compiz.org/Decorators/Emerald Emerald page] on Compiz wiki
+
* [http://wiki.compiz.org/Troubleshooting Troubleshooting - Compiz Wiki], (wiki is unmaintained)
* [http://wiki.compiz.org/EmeraldThemeManager Emerald Theme Manager page] on Compiz wiki
+
* [http://compiz-themes.org/ Additional themes]
+

Latest revision as of 09:31, 27 September 2016

According to Wikipedia:

Compiz is a compositing window manager for the X Window System, using 3D graphics hardware to create fast compositing desktop effects for window management. Effects, such as a minimization animation or a cube workspace, are implemented as loadable plugins.

Contents

Installation

There are two versions of Compiz available, the 0.8 series which is written in C and the 0.9 series which is a complete re-write of Compiz in C++. As of August 2016, both series are actively developed. Compiz 0.9 is developed by the Compiz Maintainers on Launchpad whilst Compiz 0.8 is developed by the Compiz Reloaded project on GitHub. The two series cannot be installed side by side.

0.9 series

Note: From Compiz 0.9.8 onwards, all Compiz components are developed and distributed as a single project. This means that a single package can provide all of the Compiz components.
  • Compiz — OpenGL compositing window manager with CCSM, Plugins and GTK Window Decorator.
https://launchpad.net/compiz || compizAUR

0.8 series

Note: The GTK Window Decorator is provided by compiz-gtkAUR, a split package from compiz-coreAUR.

Required:

  • Compiz Core — OpenGL compositing window manager.
https://github.com/compiz-reloaded/compiz/ || compiz-coreAUR

Highly recommended:

  • CompizConfig Settings Manager — Graphical settings manager for Compiz.
https://github.com/compiz-reloaded/ccsm || ccsmAUR
  • Compiz Fusion Plugins Main — Main plugins collection for Compiz.
https://github.com/compiz-reloaded/compiz-plugins-main || compiz-fusion-plugins-mainAUR
  • Compiz Fusion Plugins Extra — Extra plugins collection for Compiz.
https://github.com/compiz-reloaded/compiz-plugins-extra || compiz-fusion-plugins-extraAUR

Optional:

  • Compiz Fusion Plugins Experimental — Experimental Compiz plugins (known as Plugins Unsupported prior to version 0.8.12).
https://github.com/compiz-reloaded/compiz-plugins-experimental || compiz-fusion-plugins-experimentalAUR

Extras

Note: Emerald since 0.8.12 and Fusion Icon since 0.1.2 support Compiz 0.9 as well as Compiz 0.8. Compiz 0.9 users using the older Emerald 0.9.5 release are recommended to switch to Emerald 0.8.12 or a higher version in the 0.8 series as Emerald 0.9 is not actively developed.
  • Emerald — A standalone window decorator for Compiz.
https://github.com/compiz-reloaded/emerald || emeraldAUR
  • Emerald Themes — Extra themes for the Emerald window decorator.
https://github.com/compiz-reloaded/emerald-themes || emerald-themesAUR
  • Fusion Icon — A tray applet for starting Compiz and switching window managers and decorators on the fly.
https://github.com/compiz-reloaded/fusion-icon || fusion-iconAUR
  • Compiz Manager — A wrapper script to start Compiz.
https://github.com/compiz-reloaded/compiz-manager || compiz-managerAUR
  • Simple CCSM — Simplified graphical settings manager for Compiz 0.8.
https://github.com/compiz-reloaded/simple-ccsm || simple-ccsmAUR

Starting Compiz

Enabling important plugins

Tip: Depending on which package you installed Compiz from, some of these plugins may already be activated.

Before starting Compiz, you should activate some plugins to provide basic window manager behaviour or else you will have no ability to drag, scale or close any windows. Important plugins are listed below:

  • Window Decoration - provides window borders, see #Window decoration.
  • Move Window.
  • Resize Window.
  • Place Windows - configure window placement options.
  • Application Switcher - provides an Alt+Tab switcher - there are numerous alternative application switcher plugins, for example: Shift Switcher, Static Application Switcher and more. Not all of them use the Alt+Tab keybinding.

To be able to switch to different viewports you will need to enable one of the following:

  • Desktop Cube & Rotate Cube - provides the spinning cube with each side being a different viewport.
  • Desktop Wall - viewports are arranged next to each other - the animation is similar to the workspace switching animation in Cinnamon and GNOME Shell.
  • Expo - creates a view of all viewports and windows when the mouse is moved into the top left corner - this plugin can be used on its own or in conjunction with either of the two previous plugins.

Window decoration

Tip: For information on selecting and managing themes, see: Compiz configuration#Window decoration themes.

The window decorator is the program which provides windows with borders. Unlike window managers such as Kwin or Xfwm which provide just one decorator, users of Compiz have a choice of three: GTK Window Decorator, KDE Window Decorator and Emerald. The GTK Window Decorator and the KDE Window Decorator are included in the Compiz source and can be optionally compiled whilst building Compiz. Emerald, on the other hand, is a separate, standalone decorator. The Window Decoration plugin in CCSM must be ticked otherwise no window decorator will be started.

Choosing the decorator

The window decorator that will be started is specified under CCSM -> Effects -> Window Decoration -> Command. The command can be one of the following executables: emerald, gtk-window-decorator, kde4-window-decorator. Use the --replace switch, e.g. emerald --replace, if specifying the decorator executable on its own is not sufficient.

Tip: In Compiz 0.9, the decorator command is set to compiz-decorator by default. This is a script which will search for the emerald, gtk-window-decorator and kde4-window-decorator executables in that order and start the first one that it finds.

Compiz startup

Note: Some Compiz versions may require you to manually load the CCP plugin on startup: compiz --replace ccp [1]

You can start Compiz using the following command:

$ compiz --replace

See compiz --help for more options.

Fusion Icon

Tip: When #Autostarting Compiz in a desktop environment fusion-icon can be set as the default command instead of compiz.

To start Compiz using Fusion Icon, execute the command below:

$ fusion-icon

To ensure that fusion-icon then starts Compiz, right click on the icon in the panel and go to select window manager. Choose Compiz if it is not selected already.

Autostarting Compiz in a desktop environment

See Desktop environment#Custom window manager.

Using Compiz as a standalone window manager

Starting the session with a display manager

A standalone Compiz session can be started from a display manager. For most display manager's - LightDM for example - all that is required is to create a .desktop file in /usr/share/xsessions that executes compiz (with command line options if needed) or fusion-icon. See the article for your display manager. See Desktop entries for information on creating a .desktop file.

Autostarting programs when using a display manager

One way in which you could start programs with your Compiz session, when it is started from a display manager, is to use an xprofile file. Another option is for the .desktop file in /usr/share/xsessions to not execute compiz directly but to execute a script which starts the programs you wish to start and also starts Compiz.

Starting the session with startx

A Compiz session can be started with startx. Define either compiz or fusion-icon in your .xinitrc file. See the xinitrc article for more details.

Add a root menu

To add a root menu similar to that in Openbox and other standalone window managers install compiz-boxmenuAUR. This program is a fork of compiz-deskmenuAUR.

Then copy the config files to your home directory as shown below:

# cp -R /etc/xdg/compiz /home/username/.config
# chown -R username:group /home/username/.config/compiz

where username is your username and group is the primary group for your user.

Then, open CCSM, navigate to the Commands plugin and in Command line 0 enter the command compiz-boxmenu. In the Key Bindings tab, set Run command 0 to Control+Space or another key/mouse button combination of choice. Take care not to use a combination that is already used for other functionality.

Now navigate to the Viewport Switcher plugin and click on the Desktop-based Viewport Switching tab. Change the Plugin for initiate action to core and change Action name for initiate to run_command0_key.

You should now find that a menu appears when you click Control+Space. To launch a graphical menu editor, click on the Edit option or run compiz-boxmenu-editor in a terminal. If you would prefer to edit your menu manually, open the following file in your favourite editor: ~/.config/compiz/boxmenu/menu.xml. For your changes to take effect, you must click the Reload option in your menu.

Allow users to shutdown/reboot

An unprivileged user should be able to execute commands such as systemctl poweroff and systemctl reboot. You could assign a keyboard shortcut to one of these commands using the Commands plugin in CCSM. Alternatively, you could create a launcher for one of these commands in compiz-boxmenuAUR - see above. For more detailed information on shutting down see the following article: Allow users to shutdown.

Tips and tricks

Restoring the native window manager

You can switch back to your desktop environment's default window manager with the following command:

wm_name --replace

using kwin, metacity or xfwm4 for example instead of wm_name.

Enabling the Alt+F2 run dialog

GNOME Panel

Enable the Gnome Compatibility plugin in CCSM.

MATE Panel

There are two ways to enable MATE Panel's run dialog in Compiz. You can either:

  • Enable the MATE Compatibility plugin in CCSM (use the Gnome Compatibility plugin for older Compiz versions which lack the MATE plugin).
  • Map the command below to the Alt+F2 key combination using the Commands plugin in CCSM.
mate-panel --run-dialog
LXDE Panel

Map the command below to the Alt+F2 key combination using the Commands plugin in CCSM.

lxpanelctl run
Xfce Appfinder

When Compiz is used in an Xfce session, the run dialog (provided by xfce4-appfinder) should work without intervention. If you are using Xfce Appfinder in a standalone Compiz session, map the command below to the Alt+F2 key combination using the Commands plugin in CCSM.

xfce4-appfinder --collapsed
Other run dialogs

Map the command for a run dialog of choice to the Alt+F2 key combination using the Commands plugin in CCSM.

Remove title bar from maximized windows

As mentioned here , enter ccsm --> Window Decoration in Effects --> Decoration Windows : change any to !state=maxvert.

Troubleshooting

Missing GLX_EXT_texture_from_pixmaps

On ATI cards (first solution)

You may run into the following error when trying to run Compiz on an ATI card:

Missing GLX_EXT_texture_from_pixmap

This is because Compiz's binary was compiled against Mesa's OpenGL library rather than ATI's OpenGL library.

Firstly, copy the library into a directory to keep it because ATI's drivers will over write it:

$ install -Dm644 /usr/lib/libGL.so.1.2 /usr/lib/mesa/libGL.so.1.2

Then you can reinstall your fglrx drivers. Now start Compiz as shown below:

LD_PRELOAD=/usr/lib/mesa/libGL.so.1.2 compiz --replace &

On ATI cards (second solution)

Another possible problem with GLX_EXT_texture_from_pixmap on ATI cards is that the card can only render it indirectly. If so, you have to pass the option to your libgl as shown below:

LIBGL_ALWAYS_INDIRECT=1 compiz --replace &

This workaround was tested on the following card : ATI Technologies Inc Radeon R250 [Mobility FireGL 9000] (rev 02).

On Intel chips

Firstly, check that you're using the intel driver as opposed to i810. Then, use the following command to start Compiz (this command must be used every time).

LIBGL_ALWAYS_INDIRECT=true compiz --replace --sm-disable &

Compiz starts without window borders with NVIDIA binary drivers

Firstly, ensure that your window decorator settings are configured correctly - see #Window decoration. If window borders still do not start try adding Option "AddARGBGLXVisuals" "True" and Option "DisableGLXRootClipping" "True" to your "Screen" section in /etc/X11/xorg.conf.d/20-nvidia.conf. If window borders still do not load and you have used other Options elsewhere in /etc/X11/xorg.conf.d/ try commenting them out and using only the aformentioned ARGBGLXVisuals and GLXRootClipping Options.

Blank screen on resume from suspend-to-ram with NVIDIA binary drivers

If you receive a blank screen with a responsive cursor upon resume, try disabling sync to vblank. To do so, open CCSM, navigate to the OpenGL plugin and untick the Sync to VBlank option.

Poor performance from capable graphics cards

NVIDIA and Intel chips: If everything is configured correctly but you still have poor performance with some effects, try disabling CCSM > General Options > Display Settings > Detect Refresh Rate and instead choose a value manually.

NVIDIA chips only: The inadequate refresh rate with Detect Refresh Rate may be due to an option called DynamicTwinView being enabled by default which plays a factor in accurately reporting the maximum refresh rate that your card and display support. You can disable DynamicTwinView by adding the following line to the "Device" or "Screen" section of your /etc/X11/xorg.conf.d/20-nvidia.conf, and then restarting your computer:

Option "DynamicTwinView" "False"

Screen flicks with NVIDIA card

To fix this behaviour create the file below:

/etc/modprobe.d/nvidia.conf
options nvidia NVreg_RegistryDwords="PerfLevelSrc=0x2222"

Video tearing

If you experience video tearing when using Compiz, try enabling the Workarounds plugin in CCSM. Once enabled, ensure that the following options are enabled in Workarounds: Force complete redraw on initial damage, Force full screen redraws (buffer swap) on repaint.

If you are using Intel graphics and the workaround above does not fix the video tearing, see Intel graphics#Tear-free video.

Also see, #Poor performance from capable graphics cards.

Compiz effects not working (GConf backend)

If you have installed the GTK Window Decorator, check if the GConf schema was correctly installed:

$ gconftool-2 -R /apps/compiz/plugins | grep plugins

Make sure that all plugins are listed. If they are not, try to install the Compiz schema manually (do not run this command as root):

$ gconftool-2 --install-schema-file=/usr/share/gconf/schemas/compiz-decorator-gtk.schemas

Fusion Icon fails to start

If you get an output like this from the command line:

$ fusion-icon
* Detected Session: gnome
* Searching for installed applications...
Traceback (most recent call last):
  File "/usr/bin/fusion-icon", line 57, in <module>
    from FusionIcon.interface import choose_interface
  File "/usr/lib/python2.5/site-packages/FusionIcon/interface.py", line 23, in <module>
    import start
  File "/usr/lib/python2.5/site-packages/FusionIcon/start.py", line 36, in <module>
    config.check()
  File "/usr/lib/python2.5/site-packages/FusionIcon/util.py", line 362, in check
    os.makedirs(self.config_folder)
  File "/usr/lib/python2.5/os.py", line 172, in makedirs
    mkdir(name, mode)
OSError: [Errno 13] Permission denied: '/home/andy/.config/compiz'

the problem is with the permission on ~/.config/compiz/. To fix it, use:

# chown -R username /home/username/.config/compiz/

Alt+F4 keybinding not working (Xfce)

If Compiz replaces Xfwm4 at login, this can cause the Alt+F4 keybinding to become non-functional. To avoid this issue, ensure that only Compiz is started at login - see Xfce#Default window manager.

Emerald crashes when selecting a theme

You may find that Emerald crashes when selecting certain themes (especially themes that use the legacy engine). If this occurs, select another theme in Emerald Theme Manager and then run the command emerald --replace.

No system bell when Compiz is running

You may find that the system bell (such as the drip sound played when pressing backspace at the beginning of a line in GNOME or MATE Terminal) will not sound if Compiz is running. See the following upstream bug report.

PulseAudio users, as a workaround, can force PulseAudio to handle the system bell, see PulseAudio#X11 Bell Events.

Compiz crashes when enabling the Gnome Compatibility plugin (GSettings backend)

If you are using the GSettings backend, you may find that Compiz crashes if you try to enable the Gnome Compatibility plugin. In order to enable this plugin whilst using the GSettings backend you need to open CCSM and navigate to Preferences. Under the header Integration untick the box labelled Enable integration into the desktop environment. After unticking this option, you should find it possible to enable the Gnome Compatibility plugin.

Windows lose focus when unminimised

You may find that certain windows (such as a Chromium window) will lose focus when unminimised. See the following upstream bug report. One possible solution is to enable the Keep previews of minimized windows option, located within the Workarounds plugin.

Note: If you use the Chrome/Chromium browser and you enable this workaround, you will need to ensure that the Use system title bar and borders option within Chrome is enabled. If Chrome's own titlebar is used with the Keep previews of minimized windows Compiz workaround then when Chrome is minimized, the desktop beneath will become unresponsive.

Popout windows are offset when Compiz is running

You may find that popout windows for panels which are placed at the bottom of the screen are offset by a few pixels so that the window appears to float above the panel. This problem is known to affect Xfce and KDE and may affect other desktops as well. Listed below are a number of workarounds that might fix some cases.

  • Place the panel at the top of screen instead of the bottom - this should work in most cases.
  • Disable the Place Windows plugin - this works for the Xfce Whisker Menu plugin but may not work elsewhere.
  • Use fixed window placement to determine the window's position. This can be set from the Place Windows plugin. For instance, for the Whisker Menu, specify that the window with the title Whisker Menu should appear at (-1, -1).

For more information, see the following upstream bug report.

Alt-Tab switcher has no background (Emerald)

You may find that the Alt-Tab switcher (provided by the staticswitcher or switcher plugins) has a completely transparent background when using Emerald as well. This can make it hard to differentiate window thumbnails from the desktop background behind them. As of Compiz 0.9.12 (revision 3975) a workaround is available. In CCSM, navigate to Application Switcher or Static Application Switcher depending on which plugin you are using. For the former, the Background settings are located under General and for the latter the settings are located under Appearance. Once you have found the settings, ensure that the Set background color box is ticked. The default is a dark grey which can be optionally changed.

Alternatively, use GTK Window Decorator instead of Emerald or use a different window switcher altogether such as the shift switcher. Note that even if you are using the GTK Window Decorator, you can still change the background color as described above.

Known issues

Plugins in Compiz 0.8 are not present in Compiz 0.9

Some plugins that were popular in Compiz 0.8 were disabled in Compiz versions 0.9.8 and above in order to complete OpenGL ES support. A few of the disabled plugins have since been re-enabled; for instance, the Animations Add-On plugin was re-enabled for the Compiz 0.9.13.0 release. Other currently-disabled plugins that receive patches for this issue may well be re-enabled in future releases. For more information, see the Compiz 0.9.8 release notes.

Likewise, Compiz Plugins Unsupported (a package which includes plugins such as Atlantis) is unavailable in recent versions of Compiz 0.9. It has not been developed for the Compiz 0.9 series since Compiz 0.9.5 and no longer builds successfully.

Xfce panel window buttons are not refreshed when a window changes viewport

You may find that if you right click on a window title and choose an option such as Move to Workspace Right then the window will move but the window button will still be visible in the viewport the window moved from until you switch viewports. This issue can be fixed by replacing xfce4-panel with xfce4-panel-compizAUR which incorporates a patch for this issue. See the following upstream bug report for more information.

Compiz crashes when enabling the D-Bus plugin

The D-Bus plugin will cause Compiz to crash if enabled in conjunction with certain other plugins such as the Cube plugin. See the following upstream bug report.

Workspace pager and window buttons issues

Only a few panels and docks are compatible with Compiz's viewports. Incompatible panels and docks may display issues such as showing all window buttons in all workspaces or the workspace pager may only show one workspace available. The panels listed below are known to be compatible:

Xfce workspace switcher has wrong aspect ratio

When Compiz is used with Xfce Panel 4.11 and above, the workspace pager will use the width of only one workspace but will divide this space into ever smaller bars, according to how many viewports Compiz will specify. This issue can be fixed by replacing xfce4-panel with xfce4-panel-compizAUR which incorporates a patch for this issue. For more information, see the following upstream bug report.

See also