Difference between revisions of "Compiz"

From ArchWiki
Jump to navigation Jump to search
m (Modifying the default (Failsafe) session: removed unnecessary colon)
m (0.9 series: typo)
 
(229 intermediate revisions by 14 users not shown)
Line 10: Line 10:
 
[[pt:Compiz]]
 
[[pt:Compiz]]
 
[[ru:Compiz]]
 
[[ru:Compiz]]
[[tr:Compiz]]
+
[[zh-hans: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|Xfce}}
 
{{Related|Xfce}}
 
{{Related|MATE}}
 
{{Related|MATE}}
{{Related|Unity}}
 
 
{{Related articles end}}
 
{{Related articles end}}
  
 
According to [[Wikipedia:Compiz|Wikipedia]]:
 
According to [[Wikipedia:Compiz|Wikipedia]]:
: ''Compiz is a [[Wikipedia:Compositing window manager|compositing window manager]] for the [[Xorg|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.''
+
: 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]]. Packages for installing both the 0.9 and 0.8 series are available in the [[AUR]]. The two series are '''not parallel installable.'''
+
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://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.
  
=== Installing the 0.9 series ===
+
=== 0.9 series ===
  
{{Note|From Compiz 0.9.8 onwards, all Compiz components (e.g. CCSM, Plugins, gtk-window-decorator) are developed and distributed as a single project. This means that a single package can provide all of the Compiz components.}}
+
{{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 either {{AUR|compiz}} or {{AUR|compiz-bzr}} (the development version).
+
* {{App|Compiz|OpenGL compositing window manager with CCSM, Plugins and GTK Window Decorator.|https://launchpad.net/compiz|{{AUR|compiz}}}}
  
The Emerald decorator can be installed from either of the following packages: {{AUR|emerald0.9}}, {{AUR|emerald-git}}. Extra emerald themes can be installed from the {{AUR|emerald-themes}} package.
+
=== 0.8 series ===
  
=== Installing the 0.8 series ===
+
{{Note|The GTK Window Decorator is provided by {{AUR|compiz-gtk}}, a split package from {{AUR|compiz-core}}.}}
  
Install either {{AUR|compiz-core}}, {{AUR|compiz-gtk-standalone}} or {{AUR|compiz-core-mate}}.
+
Required:
 +
* {{App|Compiz Core|OpenGL compositing window manager.|https://github.com/compiz-reloaded/compiz/|{{AUR|compiz-core}}}}
  
For the settings manager, install {{AUR|ccsm}}.  
+
Highly recommended:
 +
* {{App|CompizConfig Settings Manager|Graphical settings manager for Compiz.|https://github.com/compiz-reloaded/ccsm|{{AUR|ccsm}}}}
 +
* {{App|Compiz Fusion Plugins Main|Main plugins collection for Compiz.|https://github.com/compiz-reloaded/compiz-plugins-main|{{AUR|compiz-fusion-plugins-main}}}}
 +
* {{App|Compiz Fusion Plugins Extra|Extra plugins collection for Compiz.|https://github.com/compiz-reloaded/compiz-plugins-extra|{{AUR|compiz-fusion-plugins-extra}}}}
  
For the plugins, install {{AUR|compiz-fusion-plugins-main}}, {{AUR|compiz-fusion-plugins-extra}} and optionally {{AUR|compiz-fusion-plugins-unsupported}}.
+
Optional:
 +
* {{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 Emerald decorator can be installed from the {{AUR|emerald}} package. Extra emerald themes can be installed from the {{AUR|emerald-themes}} package.
+
=== Extras ===
  
=== Window decorator ===
+
{{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.}}
  
{{Tip|For information on selecting and managing themes, see: [[Compiz Configuration#Window decoration themes]].}}
+
* {{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}}}}
  
{{Note|
+
== Starting ==
* Most Compiz packages will provide gtk-window-decorator by default. The only exception is the {{AUR|compiz-core}} package which provides no window decorator.
 
* Currently, no package provides the kde-window-decorator by default. To install it, you will need to edit the [[PKGBUILD]] of the package you used to install Compiz and enable the relevant option. Once you have done so, rebuild and then reinstall the Compiz package.}}
 
  
The window decorator is the program which provides windows with borders. Unlike window managers such as {{Pkg|mutter}}, Kwin or [[Xfwm]] which provide just one decorator, users of Compiz have a choice of three: Emerald, gtk-window-decorator and kde-window-decorator. The gtk-window-decorator and the kde-window-decorator are included in the Compiz source and compiled if the PKGBUILD specifies as such. However, Emerald is a separate, standalone decorator.
+
=== Enabling important plugins ===
  
Firstly, ensure that you have installed the decorator you wish to use with Compiz. Then start CCSM - you can do this by running the {{ic|ccsm}} command in a terminal. In the settings panel, navigate to the 'Effects' section and ensure that the 'Window Decoration' plugin is ticked. Now click on the 'Window Decoration' button and in the 'Command' field enter the relevant command for your decorator:
+
{{Tip|Depending on which package you installed Compiz from, some of these plugins may already be activated.}}
  
* {{ic|emerald}}
+
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:
  
* {{ic|gtk-window-decorator}}
+
* 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.
  
* {{ic|kde4-window-decorator}}
+
==== Window decoration ====
  
For the changes to take effect immediately, you may wish to add the {{ic|--replace}} switch to the end of the command. Otherwise, just log out and log in again and your preferred decorator will have been set. Be aware that using the {{ic|--replace}} switch after the decorator command in CCSM could cause a screen flicker on login.
+
{{Tip|For information on selecting and managing themes, see: [[Compiz/Configuration#Window decoration themes]].}}
  
== Starting Compiz ==
+
{{Note|The KDE Window Decorator is not compatible with KDE Plasma 5. The Compiz 0.8 upstream dropped the KDE Window Decorator from Compiz Core in December 2015. [https://github.com/compiz-reloaded/compiz/releases/tag/v0.8.9]}}
  
=== Enabling important plugins ===
+
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.
  
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:
+
;Choosing the decorator
 +
The window decorator that will be started is specified under CCSM -> ''Effects'' -> ''Window Decoration'' -> ''Command''. The default command is ''compiz-decorator'' which is a script which will attempt to locate the ''emerald'' and ''gtk-window-decorator'' executables (and also the ''kde4-window-decorator'' executable if you are using Compiz 0.9). It will then start the first decorator that it finds, according to the search order and conditions (such as session detection) specified in the script. Note that the script provided by Compiz 0.8 differs significantly from the one provided by Compiz 0.9 so the behavior may be different.
  
* Window Decoration - provides window borders (discussed in the section above)
+
The ''compiz-decorator'' command can be replaced with one of the executables listed above. If you find that your preferred decorator is not being started, try appending the {{ic|--replace}} switch to the command, for example: {{ic|emerald --replace}}.
* Move Window
 
* Resize Window
 
* Place Windows - configure window placement options
 
* Application Switcher - provides an Alt+Tab switcher (there are numerous alternative application switcher plugins e.g. 'Shift Switcher,' 'Static Application Switcher' etc. Not all of them use the Alt+Tab keybinding).
 
* OpenGL - (only visible in CCSM 0.9).
 
* Composite - (only visible in CCSM 0.9).
 
 
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 (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)
 
  
 
=== Compiz startup ===
 
=== Compiz startup ===
  
{{Note|Due to a packaging error, it was once necessary to use the {{ic|ccp}} switch with the {{ic|compiz --replace}} command in order to load Compiz plugins. The packaging error has been corrected and use of the {{ic|ccp}} switch should no longer be necessary.}}
+
{{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 &
+
  $ compiz --replace
  
{{Tip|If the {{ic|compiz --replace &}} command does not work when entered in a run dialog, try running the command without the ampersand: {{ic|compiz --replace}}.}}
+
See {{ic|compiz --help}} for more options.
 
 
A quick overview over common Compiz command-line options:
 
* {{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
 
  
 
==== Fusion Icon ====
 
==== Fusion Icon ====
  
Fusion Icon is a tray applet that can start Compiz and load different window managers and decorators during a session. '''It is only compatible with the Compiz 0.8 series.''' It can be installed from the {{AUR|fusion-icon}} package.
+
{{Tip|When [[#Autostarting Compiz in a desktop environment]] ''fusion-icon'' can be set as the default command instead of ''compiz''.}}
  
You can launch fusion-icon with the following command:
+
To start Compiz using Fusion Icon, execute the command below:
 
  $ fusion-icon
 
  $ 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 isn't selected already.
+
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.
 
 
Most of the methods below that autostart Compiz in a desktop environment can also be used to autostart fusion-icon which can then start Compiz. For the method you are using, just replace the command to start Compiz (usually {{ic|compiz --replace &}}) with {{ic|fusion-icon}}.
 
  
 
=== Autostarting Compiz in a desktop environment ===
 
=== Autostarting Compiz in a desktop environment ===
  
==== KDE4 ====
+
See [[Desktop environment#Use a different window manager]].
 
 
===== Use System Settings =====
 
 
 
Go to: ''System Settings > Default Applications > Window Manager > Use a different window manager'' and select ''Compiz''.
 
 
 
If you need to run Compiz with custom options and switches select "Compiz custom", then create a script called {{ic|compiz-kde-launcher}} and add to it the commands you wish to use to start Compiz. See the example below:
 
 
 
{{hc|/usr/local/bin/compiz-kde-launcher|
 
#!/bin/bash
 
LIBGL_ALWAYS_INDIRECT=1
 
compiz --replace &
 
wait
 
}}
 
 
 
Then make it executable:
 
$ chmod +x /usr/local/bin/compiz-kde-launcher
 
 
 
===== Autostart link =====
 
 
 
{{Note|
 
* Do not create the {{ic|compiz.desktop}} file if you intend to install the gtk-window-decorator as it may create a file conflict.
 
* If {{ic|compiz.desktop}} already exists, you may have to add {{ic|--replace}} to the {{ic|Exec}} variable.}}
 
 
 
Append a desktop entry in the KDE Autostart directory. If it doesn't exist already, create it:
 
 
 
{{hc|~/.kde4/Autostart/compiz.desktop|2=
 
[Desktop Entry]
 
Type=Application
 
Encoding=UTF-8
 
Name=Compiz
 
Exec=/usr/bin/compiz --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
 
}}
 
 
 
===== Export KDEWM =====
 
 
 
As root you must create a short script.  This will allow you to load Compiz with extra switches.
 
 
 
Create a file with the command to start Compiz plus any additional switches you may wish to use as well. See the example below:
 
 
 
{{hc|/usr/bin/startcompiz|
 
compiz --replace &
 
}}
 
 
 
{{Note|You do not have to call the script ''startcompiz''. Just ensure that the name of your script does not conflict with any executable files already in the {{ic|/usr/bin}} directory.}}
 
 
 
Ensure that your script is executable:
 
 
 
# chmod +x /usr/bin/startcompiz
 
 
 
Now you need to create the file that will load the script you created in {{ic|/usr/bin}}
 
 
 
1) For your user only:
 
 
 
{{hc|~/.kde4/env/startcompiz.sh|2=
 
KDEWM="compiz"
 
}}
 
 
 
2) System-wide:
 
 
 
{{hc|/etc/kde/env/startcompiz.sh|2=
 
KDEWM="compiz"
 
}}
 
 
 
{{Note|
 
* If the above method does not work, an alternate approach is to include the line:
 
 
 
$ export KDEWM="startcompiz"
 
 
 
: in your user's {{ic|~/.bashrc}} file.
 
 
 
* 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:
 
 
 
$ export KDEWM="/usr/local/bin/startcompiz"
 
}}
 
 
 
==== GNOME ====
 
 
 
===== GNOME Shell & Cinnamon =====
 
 
 
[[GNOME]] Shell is implemented as a plugin of the {{pkg|mutter}} window manager. Likewise, the [[Cinnamon]] shell is implemented as a plugin of the {{Pkg|muffin}} window manager. This means that it is impossible to use either GNOME Shell or Cinnamon with Compiz or any other window manager.
 
 
 
===== Unity =====
 
 
 
Ensure that the 'Ubuntu Unity Plugin' is enabled in CCSM in order for [[Unity]] to start successfully. This plugin will only be visible in CCSM if Unity is successfully installed.
 
 
 
===== Alternate Session for GNOME (Cairo dock and Compiz) =====
 
 
 
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.
 
 
 
Ensure that Compiz and Cairo Dock (Taskbar/Panel) have been configured correctly.
 
 
 
In CCSM, ensure that a window decorator is selected and the necessary plugins for window management have been enabled. See [[Compiz#Enabling important plugins]].
 
 
 
See below for recommended Cairo dock configuration:
 
 
 
* Add Application Menu icon to Cairo Dock and remember its key-bindings.
 
* 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 =====
 
 
 
See [[GNOME Flashback#Alternative window manager]].
 
 
 
==== MATE ====
 
 
 
===== Using GSettings =====
 
 
 
Use the following GSettings command to change the default window manager from {{Pkg|marco}} to Compiz.
 
$ gsettings set org.mate.session.required-components windowmanager compiz
 
 
 
===== Using mate-session-properties =====
 
 
 
{{Note|If this method is used, Marco will start first and will then be replaced by Compiz.}}
 
 
 
Another approach is to start Compiz using mate-session-properties. In a terminal enter the command:
 
$ mate-session-properties
 
 
 
Click on the add button and in the command section enter the {{ic|compiz --replace &}} 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.
 
 
 
==== Xfce ====
 
 
 
===== Modifying the default (Failsafe) session =====
 
 
 
To configure the default session (known as the Failsafe session) of Xfce, use {{ic|xfconf-query}}:
 
 
 
  xfconf-query -c xfce4-session -p /sessions/Failsafe/Client0_Command -t string -t string -s compiz
 
 
 
or alternatively edit one of the following files:
 
* User: {{ic|~/.config/xfce4/xfconf/xfce-perchannel-xml/xfce4-session.xml}}
 
* Systemwide: {{ic|/etc/xdg/xfce4/xfconf/xfce-perchannel-xml/xfce4-session.xml}}
 
 
 
{{Note|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}}}}
 
 
 
Replace the [[Xfwm]] startup command,
 
 
 
  <property name="Client0_Command" type="array">
 
    <value type="string" value="xfwm4"/>
 
  </property>
 
 
 
with the following:
 
 
 
  <property name="Client0_Command" type="array">
 
    <value type="string" value="compiz"/>
 
  </property>
 
 
 
To prevent the default session from being overwritten you may also want to add this:
 
 
 
  <property name="general" type="empty">
 
    ...
 
    ...
 
    <property name="SaveOnExit" type="bool" value="false"/>
 
  </property>
 
 
 
Then remove the existing sessions:
 
 
 
$ rm -r ~/.cache/sessions
 
 
 
Now you will need to log out. Ensure that the 'Save session for future logins' option in the logout dialogue is '''unticked''' or the edit will not take effect. Log in again and Compiz should start. Once you are sure Compiz is running, you can tick the 'Save session for future logins' option again.
 
 
 
===== Starting Compiz from a restored Xfce session =====
 
 
 
{{Note|If you clear your saved sessions then you will need to run through the steps of this method again.}}
 
 
 
By default, Xfce saves its sessions on logout which means that running applications will be restored on login. Therefore, to ensure that Compiz is autostarted with each session, you merely need to ensure that Compiz is running when you logout. To do so, hit {{ic|Alt+F2}} to start the Xfce run dialog. Then run the command to start Compiz: {{ic|compiz --replace &}}. Then you just need to logout. When logging out, ensure that the "Save session for future logins" option in the Xfce logout dialog is '''ticked'''. You should find that Compiz is autostarted in all future sessions.
 
 
 
===== Using Xfce application autostart =====
 
 
 
{{Note|If this method is used, Xfwm will start first and will then be replaced by Compiz.}}
 
 
 
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 &}} 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.
 
 
 
{{Tip|When using this method, it is advisable to disable saved sessions otherwise Compiz will be started twice at login which could lead to problems such as the {{ic|Alt+F4}} keybinding not working. To disable saved sessions, open the 'Session and Startup' menu entry, click on the 'Session' tab and click the 'Clear saved sessions' button. Then, untick the 'Save session for future logins' option in the Xfce logout dialog.}}
 
 
 
==== LXDE & LXQt ====
 
 
 
The session files of LXDE and LXQt can be edited to start an alternative [[window manager]] (such as Compiz) with the session.
 
 
 
* For LXDE, see the following section: [[LXDE#Replace the default window manager]].
 
* For LXQt, see the following section: [[LXQt#Replace the default window manager]].
 
  
 
== Using Compiz as a standalone window manager ==
 
== Using Compiz as a standalone window manager ==
Line 313: Line 115:
 
=== Starting the session with a display 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]], [[LXDM]], [[GDM]] etc) all that's required is to create a .desktop file in {{ic|/usr/share/xsessions}} defining the Compiz session. See the article for your display manager to check if this is the case.
+
A standalone Compiz session can be started from a [[display manager]]. For most display managers - [[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.
 
 
Firstly, create the {{ic|/usr/share/xsessions}} directory if it does not already exist. Then create the .desktop file. A basic example is provided below:
 
 
 
{{hc|/usr/share/xsessions/compiz.desktop|
 
<nowiki>[Desktop Entry]
 
Version=1.0
 
Name=Compiz
 
Comment=Start a standalone Compiz session
 
Exec=compiz
 
Type=Application</nowiki>
 
}}
 
 
 
Then just choose 'Compiz' from your sessions list and log in.
 
 
 
{{Note|Some display managers are stricter than others regarding the syntax of .desktop files. If a Compiz option does not appear in your display manager's session menu you will need to edit your .desktop file to make it compatible. The example above should work in most cases.}}
 
  
 
==== Autostarting programs when using a display manager ====
 
==== 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. The xprofile file is similar in syntax to [[xinitrc]] - it can contain commands for programs you wish to start with your session. Most display managers will parse commands from an xprofile file by default.
+
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.
 
 
Alternatively, you could use Compiz's 'Session Management' plugin. This plugin will save running programs on exit and restore them when the session is next started. Simply enable the 'Session Management' plugin in CCSM.
 
  
 
=== Starting the session with startx ===
 
=== Starting the session with startx ===
  
To start Compiz with the {{ic|startx}} command, add the following line to your {{ic|~/.xinitrc}} file:
+
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.
 
 
{{hc|~/.xinitrc|
 
exec compiz
 
}}
 
 
 
You can also use fusion icon as shown below:
 
 
 
{{hc|~/.xinitrc|
 
exec fusion-icon
 
}}
 
 
 
You can autostart additional programs (such as a panel) by adding the relevant command to your {{ic|~/.xinitrc}} file. Below is an example of a {{ic|~/.xinitrc}} file which starts Compiz, the tint2 panel and the Cairo dock.
 
 
 
{{hc|~/.xinitrc|
 
tint2 &
 
cairo-dock &
 
exec compiz
 
}}
 
 
 
See the [[xinitrc]] article for more details.
 
  
 
=== Add a root menu ===
 
=== Add a root menu ===
  
To add a root menu similar to that in [[Openbox]] and other standalone window managers you can install the {{AUR|compiz-boxmenu}} package. This program is a fork of {{AUR|compiz-deskmenu}}. Among the changes that the fork introduces are the addition of some extra features such as a window list and a recent documents list.  
+
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}}.
  
After installing the {{AUR|compiz-boxmenu}} package, copy the config files to your home directory as shown below:
+
Then copy the config files to your home directory as shown below:
  
 
  # cp -R /etc/xdg/compiz /home/''username''/.config
 
  # cp -R /etc/xdg/compiz /home/''username''/.config
Line 371: Line 136:
 
where {{ic|username}} is your username and {{ic|group}} is the primary group for your user.
 
where {{ic|username}} is your username and {{ic|group}} is the primary group for your user.
  
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}} (you can use the 'Grab key combination' option to simplify this process.)
+
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.
 
 
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}}.
 
  
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.
+
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}}.
  
{{Warning|Whilst {{ic|Control+Space}} is the default keybinding for {{ic|compiz-boxmenu}} you can assign the menu to other keybindings or mousebindings as well. Take extreme care if doing so as Compiz bindings will take precedence over keybindings of all other programs. For instance, if you assign {{ic|compiz-boxmenu}} to {{ic|Button3}} then you may lose right click functionality in all programs. If the keybinding/mousebinding you are attempting to create has any conflicts, {{ic|cssm}} will notify you.}}
+
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.
  
 
=== Allow users to shutdown/reboot ===
 
=== Allow users to shutdown/reboot ===
  
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]].
+
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]].
 
 
=== Utilities ===
 
 
 
==== Panels & docks ====
 
 
 
There are a number of panels and docks available in Arch however only a few are compatible with Compiz's [[Compiz_Configuration#Workspaces_and_Viewports|viewports]]. They are listed below:
 
 
 
*{{Pkg|xfce4-panel}}
 
*{{Pkg|mate-panel}}
 
*{{Pkg|perlpanel}}
 
*{{AUR|gnome-panel}}
 
*{{Pkg|cairo-dock}}
 
 
 
{{Note|Other [[List of applications#Taskbars_.2F_panels_.2F_docks|panels and docks]] can be run with Compiz however their desktop pagers will show only one virtual desktop and all window buttons will be shown in all viewports regardless of which viewport the window happens to be in.}}
 
 
 
==== Run dialog ====
 
 
 
*{{Pkg|mate-panel}} provides a run dialog. To enable it, see the following section: [[Compiz#MATE Panel]].
 
*{{AUR|gnome-panel}} provides a run dialog. To enable it, see the following section: [[Compiz#GNOME Panel]].
 
*{{Pkg|lxpanel}} provides a run dialog. To enable it, see the following section: [[Compiz#LXDE Panel]].
 
 
 
{{Note|The panels mentioned above must be running in order to use their respective run dialogs.}}
 
 
 
Alternatively you could install one of the following:
 
 
 
*{{Pkg|xfce4-appfinder}} - use the following command to launch a run dialog: {{ic|xfce4-appfinder --collapsed}}
 
*{{Pkg|bbrun}} - use the following command to launch a run dialog: {{ic|bbrun -w}}
 
*{{pkg|gmrun}} - use the following command to launch a run dialog: {{ic|gmrun}}
 
*{{AUR|fbrun}} - use the following command to launch a run dialog: {{ic|fbrun}}
 
 
 
In each case, simply map the command to {{ic|Alt+F2}} (or a key combination of your choice) via the 'Commands' plugin in CCSM.
 
  
 
== Tips and tricks ==
 
== Tips and tricks ==
Line 422: Line 154:
 
  ''wm_name'' --replace
 
  ''wm_name'' --replace
  
with {{ic|kwin}}, {{ic|metacity}} or {{ic|xfwm4}} instead of {{ic|wm_name}}.
+
using ''kwin'', ''metacity'' or ''xfwm4'' for example instead of ''wm_name''.
  
 
=== Enabling the Alt+F2 run dialog ===
 
=== Enabling the Alt+F2 run dialog ===
  
==== GNOME Panel ====
+
;GNOME Panel
  
Enable the 'Gnome Compatibility' plugin in CCSM.
+
Enable the ''Gnome Compatibility'' plugin in CCSM.
  
==== MATE Panel ====
+
;MATE Panel
  
 
There are two ways to enable MATE Panel's run dialog in Compiz. You can either:
 
There are two ways to enable MATE Panel's run dialog in Compiz. You can either:
  
* Enable the 'Gnome Compatibility' plugin in CCSM.
+
* 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.
+
* Map the command below to the {{ic|Alt+F2}} key combination using the ''Commands'' plugin in CCSM.
  
 
  mate-panel --run-dialog
 
  mate-panel --run-dialog
  
==== LXDE Panel ====
+
;LXDE Panel
  
Map the command below to the {{ic|Alt+F2}} key combination using the 'Commands' plugin in CCSM.
+
Map the command below to the {{ic|Alt+F2}} key combination using the ''Commands'' plugin in CCSM.
  
 
  lxpanelctl run
 
  lxpanelctl run
  
==== Xfce Appfinder ====
+
;Xfce Appfinder
  
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, see the following section: [[Compiz#Run dialog]].
+
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.
  
==== Other run dialogs ====
+
xfce4-appfinder --collapsed
  
See the following section: [[Compiz#Run dialog]].
+
;Other run dialogs
  
== Troubleshooting ==
+
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.
  
=== Missing GLX_EXT_texture_from_pixmaps ===
+
=== Remove title bar from maximized windows ===
  
==== On ATI cards (first solution) ====
+
Start CCSM and navigate to the ''Window Decoration'' plugin. Then in the ''Decoration Windows'' field, change {{ic|any}} to {{ic|1=!state=maxvert}}. [http://planetkris.com/2009/07/how-to-remove-the-title-bar-with-compiz-without-losing-3-hours-of-your-life/]
  
You may run into the following error when trying to run Compiz on an ATI card:
+
== Troubleshooting ==
  
Missing GLX_EXT_texture_from_pixmap
+
=== Missing GLX_EXT_texture_from_pixmaps ===
 
 
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: 
+
==== ATI cards ====
 
$ 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) ====
+
A possible issue 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:
 
 
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 &
 
  LIBGL_ALWAYS_INDIRECT=1 compiz --replace &
  
(Workaround tested on the following card : ATI Technologies Inc Radeon R250 [Mobility FireGL 9000] (rev 02))
+
==== Intel chips ====
  
==== On Intel chips ====
+
Use the following command to start Compiz (this command must be used every time).
 
 
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).
 
 
  LIBGL_ALWAYS_INDIRECT=true compiz --replace --sm-disable &
 
  LIBGL_ALWAYS_INDIRECT=true compiz --replace --sm-disable &
  
 
=== Compiz starts without window borders with NVIDIA binary drivers ===
 
=== Compiz starts without window borders with NVIDIA binary drivers ===
  
Firstly, ensure that your window decorator settings are configured correctly - see the following: [[Compiz#Starting the window decorator]]. 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.
+
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.
  
=== Blank screen on resume from suspend-to-ram using the NVIDIA binary drivers ===
+
=== 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.
+
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 ===
 
=== Poor performance from capable graphics cards ===
Line 497: Line 218:
 
'''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 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 {{ic|/etc/X11/xorg.conf.d/20-nvidia.conf}}, and then restarting your computer:
+
'''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:
  
 
  Option "DynamicTwinView" "False"
 
  Option "DynamicTwinView" "False"
Line 508: Line 229:
 
}}
 
}}
  
=== Compiz effects not working (GConf backend) ===
+
=== Video tearing ===
  
If you have installed the gtk-window-decorator, check if the GConf schema was correctly installed:  
+
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''.
  
$ gconftool-2 -R /apps/compiz/plugins | grep plugins
+
If you are using [[Intel graphics]] and the workaround above does not fix the video tearing, see [[Intel graphics#Tearing]].
  
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):
+
Also see, [[#Poor performance from capable graphics cards]].
 
 
$ gconftool-2 --install-schema-file=/usr/share/gconf/schemas/compiz-decorator-gtk.schemas
 
  
 
=== Fusion Icon fails to start ===
 
=== Fusion Icon fails to start ===
Line 544: Line 263:
 
=== Alt+F4 keybinding not working (Xfce) ===
 
=== Alt+F4 keybinding not working (Xfce) ===
  
See the following section: [[Compiz#Using Xfce application autostart]].
+
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#Use a different 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 {{ic|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 [https://bugs.launchpad.net/ubuntu/+source/compiz/+bug/537703 upstream bug report].
  
=== Emerald refuses to start (crashes with a segfault) ===
+
[[PulseAudio]] users, as a workaround, can force PulseAudio to handle the system bell, see [[PulseAudio#X11 Bell Events]].
  
You may find that Emerald fails to start with your Compiz session and attempting to start it from a terminal gives you the following output (or something similar):
+
=== Compiz crashes when enabling the Gnome Compatibility plugin (GSettings backend) ===
  
Segmentation fault (core dumped)
+
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.
  
In this case, the solution is to reset the Emerald theme settings:
+
=== Windows lose focus when unminimised ===
  
$ rm -rf ~/.emerald/theme
+
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.
  
Emerald should now start successfully.
+
{{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.}}
  
=== No system bell when Compiz is running ===
+
=== 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.
  
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].
+
* 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 [[Pulseaudio]] users the following workaround is available:
+
For more information, see the following [https://bugs.launchpad.net/compiz/+bug/1419346 upstream bug report].
  
Append the following lines
+
=== Alt-Tab switcher has no background (Emerald) ===
  
load-sample-lazy bell /usr/share/sounds/freedesktop/stereo/bell.oga
+
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.
load-module module-x11-bell sample=bell
 
  
to your {{ic|/etc/pulse/default.pa}} file and then restart Pulseaudio.
+
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.
  
=== Compiz crashes when enabling the Gnome Compatibility plugin (GSettings backend) ===
+
=== Mouse cursor invisible or X shaped on startup ===
  
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.
+
See [[Cursor themes#Change X shaped default cursor]].
  
 
== Known issues ==
 
== Known issues ==
  
=== Xfce panel window buttons are not refreshed when a window changes viewport ===
+
=== 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 [[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].
 +
 
 +
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 issues ===
  
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. See the following [https://bugzilla.xfce.org/show_bug.cgi?id=10908 upstream bug report].
+
==== 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 {{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.
 +
 
 +
==== 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 specifies. 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].
  
 
=== Compiz crashes when enabling the D-Bus plugin ===
 
=== 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 [https://bugs.launchpad.net/compiz/+bug/959395 upstream bug report].
+
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].
 +
 
 +
=== Workspace pager and window buttons issues ===
 +
 
 +
Only a few [[List of applications/Other#Taskbars|taskbars]] 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:
 +
 
 +
*{{Pkg|xfce4-panel}} (partial, see [[#Xfce panel issues]])
 +
*{{Pkg|mate-panel}}
 +
*{{AUR|perlpanel-git}}
 +
*{{Pkg|gnome-panel}}
 +
*{{Pkg|cairo-dock}}
  
 
== See also ==
 
== See also ==
  
 
* [https://launchpad.net/compiz Compiz in Launchpad]
 
* [https://launchpad.net/compiz Compiz in Launchpad]
 +
* [https://github.com/compiz-reloaded Compiz in GitHub]
 
* [http://compiz.org Compiz Home], including wiki and forum (website and wiki are unmaintained)
 
* [http://compiz.org Compiz Home], including wiki and forum (website and wiki are unmaintained)
 
* [http://wiki.compiz.org/Troubleshooting Troubleshooting - Compiz Wiki], (wiki is unmaintained)
 
* [http://wiki.compiz.org/Troubleshooting Troubleshooting - Compiz Wiki], (wiki is unmaintained)

Latest revision as of 22:12, 16 February 2019

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

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.
Note: The KDE Window Decorator is not compatible with KDE Plasma 5. The Compiz 0.8 upstream dropped the KDE Window Decorator from Compiz Core in December 2015. [1]

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 default command is compiz-decorator which is a script which will attempt to locate the emerald and gtk-window-decorator executables (and also the kde4-window-decorator executable if you are using Compiz 0.9). It will then start the first decorator that it finds, according to the search order and conditions (such as session detection) specified in the script. Note that the script provided by Compiz 0.8 differs significantly from the one provided by Compiz 0.9 so the behavior may be different.

The compiz-decorator command can be replaced with one of the executables listed above. If you find that your preferred decorator is not being started, try appending the --replace switch to the command, for example: emerald --replace.

Compiz startup

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

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#Use a different 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 managers - 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

Start CCSM and navigate to the Window Decoration plugin. Then in the Decoration Windows field, change any to !state=maxvert. [3]

Troubleshooting

Missing GLX_EXT_texture_from_pixmaps

ATI cards

A possible issue 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 &

Intel chips

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#Tearing.

Also see, #Poor performance from capable graphics cards.

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#Use a different 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.

Mouse cursor invisible or X shaped on startup

See Cursor themes#Change X shaped default cursor.

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 issues

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.

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 specifies. 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.

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 taskbars 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:

See also