Skip to main content

watch-xfce-xfconf - XFCE 4 Configuration as Code

License

The watch-xfce-xfconf monitors XFCE settings in real time and prints the corresponding xfconf-query commands whenever a setting is modified through the graphical interface.

Configuration changes performed in components such as xfce4-settings-manager, Thunar, Catfish, Ristretto, and other XFCE applications are translated into explicit xfconf-query commands. These commands reveal how XFCE 4 persists and applies configuration at the Xfconf layer.

The generated commands can be reused to modify or create XFCE 4 settings programmatically, including desktop backgrounds, panel layouts, window decorations, window manager behavior, and related preferences.

By displaying the xfconf-query commands, watch-xfce-xfconf allows to easily create a Shell script that can be used to automate the configuration of XFCE 4, which provides several benefits:

  • It saves time and effort by eliminating the need to manually adjust settings on each individual machine,
  • It reduces the risk of errors and inconsistencies that may arise from manually configuring settings on different machines,
  • Finally, it allows focusing on other important tasks rather than spending time configuring XFCE 4 manually.

The watch-xfce-xfconf tool is useful for users who want to replicate XFCE 4 settings across different users or computers.

Here is an example of an XFCE customization script created with the help of watch-xfce-xfconf: jc-xfce-settings @GitHub.

If watch-xfce-xfconf enhances your workflow, please show your support by ⭐ starring watch-xfce-xfconf on GitHub to help more users discover its benefits.

Installation

To install the watch-xfce-xfconf executable locally in ~/.local/bin/watch-xfce-xfconf using pip, run:

pip install --user watch-xfce-xfconf

(Omitting the --user flag will install watch-xfce-xfconf system-wide in /usr/local/bin/watch-xfce-xfconf.)

Usage

Run xfce4-settings-manager in the background:

xfce4-settings-manager &

After that, execute watch-xfce-xfconf:

~/.local/bin/watch-xfce-xfconf

Once you begin modifying XFCE 4 settings using xfce4-settings-manager, watch-xfce-xfconf will automatically display the corresponding xfconf-query commands in the terminal. These xfconf-query commands can be easily copied and pasted into a Shell script, allowing for quick and efficient automation of XFCE 4 configuration across multiple machines.

Author and License

The watch-xfce-xfconf tool has been written by James Cherti and is distributed under terms of the MIT license.

Features

  • Parses XML files that are located in the directory: ~/.config/xfce4/xfconf/xfce-perchannel-xml/,
  • Monitors changes in XFCE 4 settings / Xfconf,
  • Displays xfconf-query commands with correctly escaped special characters in their arguments.
  • Reloads Xfconf when it is necessary.

Metadata

Release files for watch-xfce-xfconf 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for watch-xfce-xfconf 1.0.6
File Size Uploaded Provenance Actions
watch_xfce_xfconf-1.0.6.tar.gz 11.1 kB Without provenance Details for watch_xfce_xfconf-1.0.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for watch-xfce-xfconf 1.0.6
File Interpreter ABI Platform Actions
watch_xfce_xfconf-1.0.6-py3-none-any.whl Python 3 none any Details for watch_xfce_xfconf-1.0.6-py3-none-any.whl

Total release size: 21.1 kB

Release files / watch_xfce_xfconf-1.0.6.tar.gz

Download URL watch_xfce_xfconf-1.0.6.tar.gz
Size 11.1 kB
Tags Source
SHA-256 checksum
How to use checksums
a91f2c6ee94eb9d75ab20e379bbd317a93ad248ec1cdf78cbbd232ee0e2bb400
BLAKE2b-256 checksum
How to use checksums
02aa6214e2dcde41a7e8d0d94e73c65ad37e52dd01f59f8d13d2f11bf14b2e95
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / watch_xfce_xfconf-1.0.6-py3-none-any.whl

Download URL watch_xfce_xfconf-1.0.6-py3-none-any.whl
Size 10.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
575985386e41684716e8a12c5e0be53f469cee10e1c35350279d78ae5a785dee
BLAKE2b-256 checksum
How to use checksums
467cfda0b2c6072eed5bd2cdc56eec43fba01393da78670f4b0418649efb25fb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for watch-xfce-xfconf 1.0.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page