• Immutable Page
  • Info
  • Attachments

attachment:ccsm.png

CompizConfig Settings Manager main view

CCSM, short for CompizConfig Settings Manager, is a configuration tool for Compiz Fusion. It is used to configure the many plugins included in Compiz and Compiz Fusion, as well as the use of various profiles and intergrating better with existing desktop settings. CCSM uses the CompizConfig compiz configuration system.

Using CCSM

The main view in CCSM contains a list of the plugins you have installed. To view and edit the settings for a plugin, click on its icon. Hover the mouse over a plugin to view its description.

To enable or disable plugins, check or uncheck the boxes next to them. Most plugins can be separately disabled, but some depend on others. CCSM will inform you if you are about to disable such plugins, or if you need to enable other plugins to provide functionality to the one you enable.

Features

attachment:advsearch.png

CompizConfig Settings Manager Advanced Search

A search bar at the top left corner allows for quick and easy filtering of the plugin list by matching the text you enter; partial text also works. You can also use this filter box to filter through options when navigating a plugin's page.

The advanced search button on the plugins page allows you to filter through all options of all plugins. It does take a while to load, as all the metadata must be parsed first. When using advanced search, you can find options by name, long description and by what value you have set them to. When entering criteria into the filter, the list of plugins that match that filter will narrow down. By clicking on the plugin, you can see which groups contain the option you have searched for. Clicking on that group will bring you to a filtered options page.

Categories

The plugins are divided into 8 categories:

  • General

    • This contains the core options
  • Accessibility

    • This category contains plugins to make your desktop easier to use, especially if you have a reading or viewing disability
  • Desktop

    • This category contains plugins to configure how your desktop behaves, like the Desktop Cube and Desktop Wall
  • Effects

    • This category contains plugins to configure various animations and effects, such as the 'Wobbly Windows' plugins or the 'Animation' plugin
  • Extras

    • This category contains plugins that serve a minor or ambiance purpose, like water and annotate
  • Image Loading

    • This category contains plugins that allow various image formats to be loaded
  • Utility

    • This category contains plugins that provide internal functionality, or small but useful features, like DBUS and Resize Info.
  • Window Management

    • This category contains plugins that provide basic to advanced window management functionality, like moving windows to grouping and tabbing windows.

You can choose a category from the list on the left sidebar, if you wish, clicking All to return to the main view.

Changing options

Changing an option in CCSM is fairly intuitive.

Basic configuration

  • Value: To change a value for an option in CCSM, you just need to scroll the slider bar, or enter the value into the box containing the value.

  • Toggle on and off: To enable / disable an option, just check or uncheck the box.

  • Selecting an item: To change a type of option, just click on the combo box and select the option you want.

  • Color: To change a color, click on the button with the color and select a color from the color wheel. You can also set the opacity of the color.

  • Window Matches: You will need to enter a 'Window Match' into the box. For more information on how to write a window match, see WindowMatching

  • Strings: You will need to enter a string. This can be anything from a directory to a command, depending on what the option is.

  • Lists: These usually contain a list of options to follow, a list of files or a string.

    • To add a value to the list, press the 'Add' button.
    • Edit a value with 'Edit'
    • Delete a value with 'Delete.'
    • Moving the entry up and down the list changes it's priority.
    • Adding a value to the list usually opens a new window relevant to what you are adding, a file would open up a file browser, a string would open up a window to enter a string, etc.

CCSMKeybinding.png

Changing a Keybinding

Actions

An action is a function that is called when you press a key, button, hit an edge or have the system bell ring. No two actions can have the same binding, and CCSM will notify you if so and offer you to change to another binding, or disable the one conflicting with the binding you set.

Keybindings

A Keybinding option is an option that has a keyboard icon next to it. To edit a keybinding, you need to specify 'modifiers' by clicking on the Ctrl, Alt, Super and Shift buttons in the window and entering a key. If you just want to press the keys, hit 'Grab Key Combination' and enter in your modifiers and keys. The window will close automatically. If you don't like what you have entered in, you can press Escape and try again.

Mouse Buttons

A Mouse Button option is an option that has a mouse icon next to it.

CCSMMouseBinding.png

Changing a mouse button binding

To edit a mouse button you will need to specify 'modifiers' by clicking on the Ctrl, Alt, Super and Shift buttons in a window and/or optionally toggle a screencorner where this action can only happen. To set a screencorner, you will need to click on one of the red areas of the picture of the screen. Finally, select which button to use, you will need to select a button number from the combo box. Below is a list of Button numbers and what they usually correspond to:

  • Button 1: The 'Left-Click' mouse button

  • Button 2: The 'Middle-Click' mouse button, or pressing down on the scroll wheel

  • Button 3: The 'Right-Click' mouse button

  • Button 4: Scrolling up one increment on the mouse wheel

  • Button 5: Scrolling down one increment on the mouse wheel

  • Button 6: Usually the 'back' button or scrolling one increment left on your mouse wheel

  • Button 7: Usually the 'forward' button or scrolling one increment right on your mouse wheel

Buttons 6-9 can differ depending on the type of mouse you have. Some mice may not even have these buttons at all!

Screen Edges

A screen edge is a type of binding that makes an action occur when you move your mouse to a screen corner or edge. Screen Edge options have a display icon next to them. To set a screen edge simply select one or more of the red areas of the picture of the screen.

System Bell

The System Bell is called when an application or the system wants to notify you about something.By default, the system bell is usually a sound or a beep on most desktop environments.

CCSMEdgeBinding.png

Setting a Screen Edge

You can also have a function be called when the system bell sounds. System Bell options are options that have a picture of a note next to them. Checking the box calls that function on system bell.

Clearing a setting

To clear a setting back to the defaults, press the broom icon.

Preferences

The 'Preferences' area allows you to configure CCSM and LibCompizConfig itself, with profile settings, backend settings and plugin list settings.

Profiles

Profiles allow you to save and switch between different configurations of Compiz Fusion easily, without changing too many settings at once.

  • To create a new profile, press the 'Add Profile' button and enter a name for the profile. The profile will have the global defaults already stored in it.
  • To delete a profile, press the 'Delete Profile' button
  • To export a profile to share it with others, press the 'Export Profile' button. This will export your settings to a file with your profile's name with .profile appended

  • To import a profile that you have obtained, press the 'Import Profile' button. This will allow you to select the *.profile file. Once imported, the changes will be applied to the current active profile.

  • 'Reset to defaults' allows you to overwrite your settings profile with the global defaults. Use this for debugging.

Backends and Integration

CompizConfig allows you to write your settings to a specific desktop configuration backend, for better integration with your desktop. The list of current backends are as follows

  • GConf Configuration Backend: Stores your settings to the GNOME Configuration system. It also intergrates with GNOME options and reads settings to them if applicable.

  • KConfig Configuration Backend: Stores your settings to the KDE Configuration system. It also intergrates with KDE window manager options, and reads and writes to those values as applicable.

  • Flat-File (INI) Configuration Backend:Stores your settings to an INI file located in ~/.config/compiz/compizconfig. As it is not desktop-specific, it does not intergrate with any of the desktop options.

'Enable integration into the desktop environment' allows you to read and write to and from settings from your desktop's normal window manager. Integrated options are shown in blue.

Plugin List

This allows you to manually add and change the loading order of various plugins. It is recommended that you do not change settings here as they are there for debugging purposes. CCSM will automatically generate the best plugin loading order for you by default.

CCSM (last edited 2008-03-30 18:34:29 by localhost)