How to use the command gsettings (with examples)

The gsettings command allows users to query and modify dconf settings with schema validation. It provides a way to interact with the dconf database, which stores the configuration data for the GNOME desktop environment. This command is useful for configuring and customizing various aspects of the GNOME desktop.

Use case 1: Set the value of a key

Code:

gsettings set org.example.schema example-key value

Motivation: This use case is helpful when you want to change the value of a specific key in the dconf database. It allows you to customize various settings related to the GNOME desktop environment.

Explanation:

• gsettings: The command to query and modify dconf settings.
• set: Specifies that we want to set the value of a key.
• org.example.schema: The schema that contains the key.
• example-key: The key whose value we want to set.
• value: The value to set for the key.

Example output:

No output. The command will set the value of the specified key.

Use case 2: Print the value of a key or the schema default

Code:

gsettings get org.example.schema example-key

Motivation: This use case is useful when you want to retrieve the value of a specific key from the dconf database. It helps in checking the current value associated with a particular setting.

Explanation:

• gsettings: The command to query and modify dconf settings.
• get: Specifies that we want to retrieve the value of a key.
• org.example.schema: The schema that contains the key.
• example-key: The key whose value we want to retrieve.

Example output:

The output will display the current value of the specified key.

Use case 3: Unset a key to use the schema default value

Code:

gsettings reset org.example.schema example-key

Motivation: This use case is useful when you want to reset a key to its default value defined in the schema. It allows you to revert any customizations made to a specific setting and restore it to its original state.

Explanation:

• gsettings: The command to query and modify dconf settings.
• reset: Specifies that we want to unset a key.
• org.example.schema: The schema that contains the key.
• example-key: The key to reset.

Example output:

No output. The command will reset the key to its default value.

Use case 4: Display all schemas, keys, and values

Code:

gsettings list-recursively

Motivation: This use case is helpful when you want to view all the (non-relocatable) schemas, keys, and their corresponding values present in the dconf database. It provides a comprehensive overview of the available configurations.

Explanation:

• gsettings: The command to query and modify dconf settings.
• list-recursively: Specifies that we want to display all (non-relocatable) schemas, keys, and values.

Example output:

org.gnome.desktop.interface enable-animations true
org.gnome.desktop.interface show-battery-percentage false
org.gnome.desktop.interface gtk-theme 'Adwaita'
...

Use case 5: Display keys and values from a specific schema

Code:

gsettings list-recursively org.example.schema

Motivation: This use case is useful when you want to view all the keys and their corresponding values from a specific schema. It provides a focused view of the available configurations within a particular schema.

Explanation:

• gsettings: The command to query and modify dconf settings.
• list-recursively: Specifies that we want to display all keys and values.
• org.example.schema: The schema for which to display keys and values.

Example output:

org.example.schema example-key 'value'
org.example.schema example-key2 42
...

Use case 6: Display schema-allowed values for a key

Code:

gsettings range org.example.schema example-key

Motivation: This use case is helpful when you want to see the allowed values for a particular key, especially when dealing with enum keys. It helps in understanding the range of options available for a specific setting.

Explanation:

• gsettings: The command to query and modify dconf settings.
• range: Specifies that we want to display the allowed values for a key.
• org.example.schema: The schema that contains the key.
• example-key: The key for which to display the allowed values.

Example output:

type: 's'
flags: none
range: 'value1', 'value2', 'value3'

Use case 7: Display the human-readable description of a key

Code:

gsettings describe org.example.schema example-key

Motivation: This use case is useful when you want to get more information about a specific key, such as its purpose or usage. It helps in understanding the functionality and significance of a particular setting.

Explanation:

• gsettings: The command to query and modify dconf settings.
• describe: Specifies that we want to display the description of a key.
• org.example.schema: The schema that contains the key.
• example-key: The key for which to display the description.

Example output:

The description of the key will be shown here.

Conclusion:

The gsettings command provides a versatile way to interact with the dconf database and configure various aspects of the GNOME desktop environment. With its ability to query and modify settings, view schema information, and retrieve default values, it is a powerful tool for customizing the GNOME desktop experience.