Difference between revisions of "Xcompmgr"

From ArchWiki
Jump to: navigation, search
m (added ja)
m (Style fixes.)
Line 5: Line 5:
 
[[ru:Xcompmgr]]
 
[[ru:Xcompmgr]]
 
[[zh-CN:Xcompmgr]]
 
[[zh-CN:Xcompmgr]]
{{Article summary start}}
+
{{Related articles start}}
{{Article summary text|Describes the installation and usage of Xcompmgr.}}
+
{{Related|Compiz}}
{{Article summary heading|Related articles}}
+
{{Related|Cairo Compmgr}}
{{Article summary text|[[Compiz]]}}
+
{{Related|Compton}}
{{Article summary text|[[Cairo Compmgr]]}}
+
{{Related articles end}}
{{Article summary text|[[Compton]]}}
+
{{Article summary end}}
+
  
 
[http://cgit.freedesktop.org/xorg/app/xcompmgr/ Xcompmgr] is a simple [[Wikipedia:Compositing window manager|composite manager]] capable of rendering drop shadows and, with the use of the '''transset''' utility, primitive window transparency. Designed solely as a proof-of-concept, Xcompmgr is a lightweight alternative to Compiz and similar composite managers.
 
[http://cgit.freedesktop.org/xorg/app/xcompmgr/ Xcompmgr] is a simple [[Wikipedia:Compositing window manager|composite manager]] capable of rendering drop shadows and, with the use of the '''transset''' utility, primitive window transparency. Designed solely as a proof-of-concept, Xcompmgr is a lightweight alternative to Compiz and similar composite managers.
  
Because it does not replace any existing window manager, it is an ideal solution for users of lightweight [[Window Manager|window managers]], seeking a more elegant desktop.
+
Because it does not replace any existing window manager, it is an ideal solution for users of lightweight [[window managers]], seeking a more elegant desktop.
  
 
== Installation ==
 
== Installation ==
 +
 
Before installing Xcompmgr, make sure you have installed and correctly configured [[Xorg]]. If you have a custom setup, also turn on the [[Composite]] extension for the X Server.
 
Before installing Xcompmgr, make sure you have installed and correctly configured [[Xorg]]. If you have a custom setup, also turn on the [[Composite]] extension for the X Server.
  
Line 23: Line 22:
  
 
=== Forks and updated versions ===
 
=== Forks and updated versions ===
 +
 
There are some forks available, with various bugfixes:
 
There are some forks available, with various bugfixes:
 
* {{App|xcompmgr-dana|One of the first forks of Xcompmgr.|http://oliwer.net/xcompmgr-dana/|{{AUR|xcompmgr-dana}}}}
 
* {{App|xcompmgr-dana|One of the first forks of Xcompmgr.|http://oliwer.net/xcompmgr-dana/|{{AUR|xcompmgr-dana}}}}
Line 29: Line 29:
  
 
== Configuration ==
 
== Configuration ==
 +
 
To load {{ic|xcompmgr}}, simply run:
 
To load {{ic|xcompmgr}}, simply run:
 
  $ xcompmgr -c
 
  $ xcompmgr -c
Line 41: Line 42:
 
  $ xcompmgr --help
 
  $ xcompmgr --help
  
=== Window Transparency ===
+
=== Window transparency ===
 +
 
 
Although its practical use is limited, due to its slow performance, the {{ic|transset-df}} utility can be used to set the transparency of individual windows.
 
Although its practical use is limited, due to its slow performance, the {{ic|transset-df}} utility can be used to set the transparency of individual windows.
  
 
To set the transparency of a program window, make sure the desired program is already running, then execute:
 
To set the transparency of a program window, make sure the desired program is already running, then execute:
  $ transset-df [opacity]
+
  $ transset-df ''opacity''
where {{ic|opacity}} is a number between '''0''' and '''1''', 0 being transparent and 1 being opaque.
+
where ''opacity'' is a number between '''0''' and '''1''', 0 being transparent and 1 being opaque.
  
 
Once execution, the mouse cursor will transform to a cross-hair. Click a window and its transparency will change to the value specified. For example, {{ic|transset-df 0.25}} will set the target window to 25% opacity (75% transparency).
 
Once execution, the mouse cursor will transform to a cross-hair. Click a window and its transparency will change to the value specified. For example, {{ic|transset-df 0.25}} will set the target window to 25% opacity (75% transparency).
  
 
== Tips and tricks ==
 
== Tips and tricks ==
 +
 
=== Start/Stop Xcompmgr on demand ===
 
=== Start/Stop Xcompmgr on demand ===
 +
 
This script allows easy (re)starting and stopping of the compositing manager.
 
This script allows easy (re)starting and stopping of the compositing manager.
 
{{hc|~/.bin/comp|<nowiki>
 
{{hc|~/.bin/comp|<nowiki>
#!/bin/bash
+
#!/bin/bash
#
+
#
# Start a composition manager.
+
# Start a composition manager.
# (xcompmgr in this case)
+
# (xcompmgr in this case)
+
 
comphelp() {
+
comphelp() {
  echo "Composition Manager:"
+
    echo "Composition Manager:"
  echo "  (re)start: COMP"
+
    echo "  (re)start: COMP"
  echo "  stop:      COMP -s"
+
    echo "  stop:      COMP -s"
  echo "  query:    COMP -q"
+
    echo "  query:    COMP -q"
  echo "              returns 0 if composition manager is running, else 1"
+
    echo "              returns 0 if composition manager is running, else 1"
  exit
+
    exit
}
+
}
+
 
checkcomp() {
+
checkcomp() {
  pgrep xcompmgr &>/dev/null
+
    pgrep xcompmgr &>/dev/null
}
+
}
+
 
stopcomp() {
+
stopcomp() {
  checkcomp && killall xcompmgr
+
    checkcomp && killall xcompmgr
}
+
}
+
 
startcomp() {
+
startcomp() {
  stopcomp
+
    stopcomp
# Example settings only. Replace with your own.
+
    # Example settings only. Replace with your own.
  xcompmgr -CcfF -I-.015 -O-.03 -D6 -t-1 -l-3 -r4.2 -o.5 &
+
    xcompmgr -CcfF -I-.015 -O-.03 -D6 -t-1 -l-3 -r4.2 -o.5 &
  exit
+
    exit
}
+
}
+
 
case "$1" in
+
case "$1" in
    "") startcomp ;;
+
    "")   startcomp ;;
  "-q") checkcomp ;;
+
    "-q") checkcomp ;;
  "-s") stopcomp; exit ;;
+
    "-s") stopcomp; exit ;;
      *) comphelp ;;
+
    *)   comphelp ;;
esac</nowiki>
+
esac
}}
+
</nowiki>}}
  
 
For ease of use, you can bind this script to a hot-key using, for example, [[Xbindkeys]]. This allows for fast restart or temporary composition removal if needed without interrupting other work.
 
For ease of use, you can bind this script to a hot-key using, for example, [[Xbindkeys]]. This allows for fast restart or temporary composition removal if needed without interrupting other work.
  
 
=== Toggle Xcompmgr ===
 
=== Toggle Xcompmgr ===
 +
 
Assign the following script to any hot-key:
 
Assign the following script to any hot-key:
#!/bin/bash
+
{{bc|
+
#!/bin/bash
if pgrep xcompmgr &>/dev/null; then
+
 
        echo "Turning xcompmgr ON"
+
if pgrep xcompmgr &>/dev/null; then
        xcompmgr -c -C -t-5 -l-5 -r4.2 -o.55 &
+
    echo "Turning xcompmgr ON"
else
+
    xcompmgr -c -C -t-5 -l-5 -r4.2 -o.55 &
        echo "Turning xcompmgr OFF"
+
else
        pkill xcompmgr &
+
    echo "Turning xcompmgr OFF"
fi
+
    pkill xcompmgr &
+
fi
exit 0
+
 
 +
exit 0
 +
}}
  
 
== Troubleshooting ==
 
== Troubleshooting ==
 +
 
=== Mozilla Firefox crashes when entering a Flash site ===
 
=== Mozilla Firefox crashes when entering a Flash site ===
 +
 
You can fix it by creating an executable file named {{ic|/etc/profile.d/flash.sh}} containing this line:
 
You can fix it by creating an executable file named {{ic|/etc/profile.d/flash.sh}} containing this line:
 
  export XLIB_SKIP_ARGB_VISUALS=1
 
  export XLIB_SKIP_ARGB_VISUALS=1
Line 115: Line 124:
  
 
=== Background turns light gray briefly after logging in (e.g. in Openbox) ===
 
=== Background turns light gray briefly after logging in (e.g. in Openbox) ===
 +
 
This is fixed by installing {{Pkg|hsetroot}} and setting the background color by executing {{ic|hsetroot -solid "#000000"}} (just type the code of the color you want instead of ''#000000'') before {{ic|xcompmgr}}.
 
This is fixed by installing {{Pkg|hsetroot}} and setting the background color by executing {{ic|hsetroot -solid "#000000"}} (just type the code of the color you want instead of ''#000000'') before {{ic|xcompmgr}}.
  
 
=== BadPicture request in awesome ===
 
=== BadPicture request in awesome ===
 +
 
If you get the following error in [[awesome]]:
 
If you get the following error in [[awesome]]:
 
   error 163: BadPicture request 149 minor 8 serial 34943
 
   error 163: BadPicture request 149 minor 8 serial 34943
Line 126: Line 137:
 
=== Screen not updating in awesome after resolution change ===
 
=== Screen not updating in awesome after resolution change ===
  
When using an external monitor, you may encounter problems when automatically changing display resolutions: a part of the screen becomes "stuck" and no longer updates itself. This problem occurs because of the initial resolution change (happening before Xcompmgr starts) as well as [[awesome]] setting the background via [[Feh]].
+
When using an external monitor, you may encounter problems when automatically changing display resolutions: a part of the screen becomes "stuck" and no longer updates itself. This problem occurs because of the initial resolution change (happening before Xcompmgr starts) as well as [[awesome]] setting the background via [[feh]].
  
 
To fix it, you need to install {{Pkg|hsetroot}}, from the [[official repositories]], and put the following line in {{ic|.xinitrc}}, just before {{ic|xcompmgr}}:
 
To fix it, you need to install {{Pkg|hsetroot}}, from the [[official repositories]], and put the following line in {{ic|.xinitrc}}, just before {{ic|xcompmgr}}:
 
  hsetroot -solid "#000066"
 
  hsetroot -solid "#000066"
 
(you can replace ''#000066'' with your color of choice).
 
(you can replace ''#000066'' with your color of choice).

Revision as of 10:42, 14 December 2013

Related articles

Xcompmgr is a simple composite manager capable of rendering drop shadows and, with the use of the transset utility, primitive window transparency. Designed solely as a proof-of-concept, Xcompmgr is a lightweight alternative to Compiz and similar composite managers.

Because it does not replace any existing window manager, it is an ideal solution for users of lightweight window managers, seeking a more elegant desktop.

Installation

Before installing Xcompmgr, make sure you have installed and correctly configured Xorg. If you have a custom setup, also turn on the Composite extension for the X Server.

Xcompmgr can be installed with the package xcompmgr, available in the official repositories. For transparency also install transset-df from the official repositories.

Forks and updated versions

There are some forks available, with various bugfixes:

  • xcompmgr-dana — One of the first forks of Xcompmgr.
http://oliwer.net/xcompmgr-dana/ || xcompmgr-danaAUR
  • xcompmgr_tint2 — A fork of Xcompmgr that contains a patch for enabling real transparency in Tint2.
http://www.freedesktop.org/wiki/Software/xapps || xcompmgr_tint2-gitAUR
  • Compton — A fork of Xcompmgr that contains most of the previous fixes as well as many others.
https://github.com/chjj/compton || compton-gitAUR

Configuration

To load xcompmgr, simply run:

$ xcompmgr -c

To have it load at session start, add the following to xprofile:

xcompmgr -c &

Instead of -c you can experiment with the other switches to modify the drop-shadows or even enable fading. Below is a common example:

xcompmgr -c -C -t-5 -l-5 -r4.2 -o.55 &

For a full list of options, run:

$ xcompmgr --help

Window transparency

Although its practical use is limited, due to its slow performance, the transset-df utility can be used to set the transparency of individual windows.

To set the transparency of a program window, make sure the desired program is already running, then execute:

$ transset-df opacity

where opacity is a number between 0 and 1, 0 being transparent and 1 being opaque.

Once execution, the mouse cursor will transform to a cross-hair. Click a window and its transparency will change to the value specified. For example, transset-df 0.25 will set the target window to 25% opacity (75% transparency).

Tips and tricks

Start/Stop Xcompmgr on demand

This script allows easy (re)starting and stopping of the compositing manager.

~/.bin/comp
#!/bin/bash
#
# Start a composition manager.
# (xcompmgr in this case)

comphelp() {
    echo "Composition Manager:"
    echo "   (re)start: COMP"
    echo "   stop:      COMP -s"
    echo "   query:     COMP -q"
    echo "              returns 0 if composition manager is running, else 1"
    exit
}

checkcomp() {
    pgrep xcompmgr &>/dev/null
}

stopcomp() {
    checkcomp && killall xcompmgr
}

startcomp() {
    stopcomp
    # Example settings only. Replace with your own.
    xcompmgr -CcfF -I-.015 -O-.03 -D6 -t-1 -l-3 -r4.2 -o.5 &
    exit
}

case "$1" in
    "")   startcomp ;;
    "-q") checkcomp ;;
    "-s") stopcomp; exit ;;
    *)    comphelp ;;
esac

For ease of use, you can bind this script to a hot-key using, for example, Xbindkeys. This allows for fast restart or temporary composition removal if needed without interrupting other work.

Toggle Xcompmgr

Assign the following script to any hot-key:

#!/bin/bash

if pgrep xcompmgr &>/dev/null; then
    echo "Turning xcompmgr ON"
    xcompmgr -c -C -t-5 -l-5 -r4.2 -o.55 &
else
    echo "Turning xcompmgr OFF"
    pkill xcompmgr &
fi

exit 0

Troubleshooting

Mozilla Firefox crashes when entering a Flash site

You can fix it by creating an executable file named /etc/profile.d/flash.sh containing this line:

export XLIB_SKIP_ARGB_VISUALS=1
Warning: This will disable compositing effects.

Background turns light gray briefly after logging in (e.g. in Openbox)

This is fixed by installing hsetroot and setting the background color by executing hsetroot -solid "#000000" (just type the code of the color you want instead of #000000) before xcompmgr.

BadPicture request in awesome

If you get the following error in awesome:

 error 163: BadPicture request 149 minor 8 serial 34943
 error 163: BadPicture request 149 minor 8 serial 34988
 error 163: BadPicture request 149 minor 8 serial 35033

just install feh and restart awesome.

Screen not updating in awesome after resolution change

When using an external monitor, you may encounter problems when automatically changing display resolutions: a part of the screen becomes "stuck" and no longer updates itself. This problem occurs because of the initial resolution change (happening before Xcompmgr starts) as well as awesome setting the background via feh.

To fix it, you need to install hsetroot, from the official repositories, and put the following line in .xinitrc, just before xcompmgr:

hsetroot -solid "#000066"

(you can replace #000066 with your color of choice).