rowan/configctl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

basic readme

Browse source
This commit is contained in:
Rowan 2025-03-07 10:53:05 -06:00
parent cb12852924
commit d7b9ea2ee5
1 changed files with 34 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md Normal file
View file

@ -0,0 +1,34 @@
# configctl
a simple wrapper around fuse-overlayfs to manage multiple config changesets
# Why?
i have an unhealthy relationship with overlayfs. i also like to easily change my desktop themes without a bunch of symlink swapping
# Requirements
* fuse-overlayfs
* systemd
# Usage
```sh
configctl <changeset> [unmount]
```
by default, the configctl expects the base configuration set to exist in `$XDG_DATA_HOME/config/base` (usually `~/.local/share/config/base`) and the changesets to exist in `$XDG_DATA_HOME/config/changeset`. changes while the configuration is mounted will be written to `$XDG_STATE_HOME/config/{<changeset>,.work_<changeset>}`
```sh
configctl my_config
```
executing the previous command will do the following
* search for `$XDG_DATA_HOME/config/changeset/my_config`
* create the following directories if they don't already
* `$XDG_STATE_HOME/config/my_config`
* `$XDG_STATE_HOME/config/.work_my_config`
* create a service file in `$XDG_CONFIG_HOME/systemd/user/my_config-automount.service`
* mount the base config and the selected changeset
enabling the service file will mount the config on next user login
# Issues
while technically supported, it's not possible to change or unmount a changeset once mounted. this is because the mount will become immediately busy, preventing `fusermount` from being able to unmount it.