# Examples - ignore and transform flags
Here are some useful examples of flags for various settings files I have come across.
## KDE
### dolphinrc
```bash
ignore section "MainWindow"
ignore section "KPropertiesDialog"
ignore "General" "ViewPropsTimestamp"
ignore "Open-with settings" "History"
```
### kdeglobals
```bash
ignore "General" "ColorSchemeHash"
ignore "KFileDialog Settings" "Show hidden files"
ignore "KFileDialog Settings" "Show Inline Previews"
ignore section ""DirSelect Dialog""
```
### kglobalshortcutsrc
There are two issues in this configuration.
First, ActivityManager switch-to-activity entries. There are multiple entries,
making it a perfect fit for a regular expression. Note that this is not state
per se. It does however seem to vary between computers, having different UUID
values.
Second, certain shortcut keys like flipping between two representations. A
specialised transform has been added to handle this case. When this is needed
you will see diffs like the following:
```diff
-playmedia=none,,Play media playback
+playmedia=none,none,Play media playback
```
In summary, the following seems to work well:
```bash
ignore regex "ActivityManager" "switch-to-activity-.*"
transform regex ".*" ".*" kde_shortcut
```
### konversationrc
Konversation has two relevant quirks:
1. It saves the password in the settings file (instead of using kwallet)
2. It resorts it alias list every time.
```bash
ignore "ServerListDialog" "Size"
transform "Aliases" "AliasList" unsorted_list separator=","
transform "Identity 0" "Password" keyring service="konversation" user="konversation_id0"
# Make sure the password isn't added back into the config file on re-add
add:hide "Identity 0" "Password"
```
To store the password for Identity 0 in your keyring of choice you can use the
`secret-tool` program from `libsecret` (`libsecret-tools` on Debian/Ubuntu):
```console
$ secret-tool store --label="Konversation password" service konversation username konversation_id0
[Enter your password at the prompt]
```
### kwinrc
Similar to kglobalshortcutsrc there are computer specific UUIDs. In addition,
the tiling configurations seem to be overwritten by KDE Plasma between computers.
```bash
ignore regex "Desktops" "Id_.*"
ignore regex "Tiling\\]\\[.*" ".*"
```
### plasmanotifyrc
```bash
ignore section "DoNotDisturb"
```
### Trolltech.conf
This is a Qt config, rather than a KDE config (strictly speaking) but since KDE
uses Qt, it is sitll relevant.
```bash
ignore "Qt" "filedialog"
```
## PrusaSlicer / SuperSlicer
PrusaSlicer and the fork SuperSlicer also use INI style files:
### PrusaSlicer.ini / SuperSlicer.ini
```bash
ignore "<NO_SECTION>" "auto_toolbar_size"
ignore "<NO_SECTION>" "downloader_url_registered"
ignore "<NO_SECTION>" "freecad_path"
ignore "<NO_SECTION>" "last_output_path_removable"
ignore "<NO_SECTION>" "last_output_path"
ignore "<NO_SECTION>" "version_online_seen"
ignore "<NO_SECTION>" "version_online"
ignore "<NO_SECTION>" "version_system_info_sent"
ignore "<NO_SECTION>" "version"
ignore "<NO_SECTION>" "window_mainframe"
ignore "font" "active_font"
ignore "presets" "filament"
ignore "presets" "print"
ignore "presets" "printer"
ignore "presets" "sla_material"
ignore "presets" "sla_print"
ignore regex "<NO_SECTION>" "desktop_integration_.*"
ignore regex "font:.*" ".*"
ignore regex "presets" "filament_.*"
ignore section "recent_projects"
ignore section "recent"
```
### PrusaSlicerGcodeViewer.ini / SuperSlicerGcodeViewer.ini
```bash
ignore "<NO_SECTION>" "version"
ignore "<NO_SECTION>" "window_mainframe"
ignore section "recent_projects"
```
## KeePassXC
### keepassxc.ini
KeePassXC stores private and public keys for KeeShare in the config.
You may not want to commit this to the repository.
```bash
ignore "KeeShare" "Active"
ignore "KeeShare" "Foreign"
ignore "KeeShare" "Own"
```
## GTK-3.0/GTK-4.0
### settings.ini
The file `~/.config/gtk-<version>/settings.ini` has a DPI value in it that
changes between computers. Thus, each of those setting files need the
following:
```bash
ignore "Settings" "gtk-xft-dpi"
```
# Examples - hook scripts (LEGACY)
## Add hook (LEGACY)
> ⚠️ LEGACY! ⚠️ This approach is has been replaced with `add:remove` and
`add:hide` directives in the configuration file, which is suitable for the
password use case as well as when using `set` on specific systems. If you use
add hooks for anything else where the new directives don't work, please leave
a comment on
[issue #46](https://github.com/VorpalBlade/chezmoi_modify_manager/issues/46)
so that I can look into other possible ways to support it.
A user defined hook script can optionally be executed by chezmoi_ini_add to
filter the data when adding it. This can be useful when readding files to
automatically remove passwords that are managed by a transform.
The hook script should be an executable file in the root of the chezmoi
directory and must be named `.chezmoi_modify_manager.add_hook`.
Here is an example that will filter out passwords of the `konversationrc` file:
```zsh
#!/bin/zsh
#
# NOTE: LEGACY, use add:hide & add:remove directives instead
#
# The file from the target directory will be available on STDIN.
# The data to add to the source state should be printed to STDOUT.
# Currently only "ini"
type=$1
# Path of file as provided by the user to the command, may be a relative path
target_path=$2
# Path in the source state we are writing to. Will end in .src.ini for ini files.
source_data_path=$3
if [[ $source_data_path =~ konversationrc ]]; then
# Filter out any set password.
sed '/Password=./s/=.*$/=PLACEHOLDER/'
else
# Let other files through as they are without changes
cat
fi
```
## Add hook on Windows (or multiplatform solution) (LEGACY)
On Windows chezmoi_modify_manager will instead look for a file
`.chezmoi_modify_manager.add_hook.*`. At most one such file may be present.
This allows you to use a suitable scripting language for that platform.
Currently, `bat` extension is confirmed to be working well. However not all
scripting languages seem to work here (for unknown reason).
Below is an example for a cross-platform solution, in which both
`.chezmoi_modify_manager.add_hook` (Linux/MacOS) and
`.chezmoi_modify_manager.add_hook.bat` (Windows) scripts pass input arguments to
a common `.chezmoi_modify_manager.add_hook_wrapped.py` Python script:
`.chezmoi_modify_manager.add_hook` (Linux/MacOS) contents:
```bash
#!/bin/sh
# NOTE: LEGACY, use add:hide & add:remove directives instead
CHEZMOI_SOURCE_DIR="$(chezmoi source-path)"
exec python3 "${CHEZMOI_SOURCE_DIR}/.chezmoi_modify_manager.add_hook_wrapped.py" "$1" "$2" "$3"
```
`.chezmoi_modify_manager.add_hook.bat` (Windows) contents:
```bat
@echo off
REM NOTE: LEGACY, use add:hide & add:remove directives instead
for /f %%i in ('chezmoi source-path') do set "CHEZMOI_SOURCE_DIR=%%i"
python3 "%CHEZMOI_SOURCE_DIR%\.chezmoi_modify_manager.add_hook_wrapped.py" "%1" "%2" "%3"
```
`.chezmoi_modify_manager.add_hook_wrapped.py` contents:
```python
#!/usr/bin/env python3
#
# NOTE: LEGACY, use add:hide & add:remove directives instead
#
# The file from the target directory will be available on STDIN.
# The data to add to the source state should be printed to STDOUT.
import re
import sys
# Currently only "ini"
type = sys.argv[1]
# Path of file as provided by the user to the command, may be a relative path
target_path = sys.argv[2]
# Path in the source state we are writing to. Will end in .src.ini for ini files.
source_data_path = sys.argv[3]
# Read data from STDIN
input_data = sys.stdin.read()
if "konversationrc" in source_data_path:
# Filter out any set password.
input_data = re.sub(r'Password=.*$', 'Password=PLACEHOLDER', input_data)
print(input_data)
```
# Examples - set/remove
The `set` and `remove` directives are meant to be used together with templating
in the modify scripts. For example, there might be a key binding in KDE you only
want on computers were a specific program is installed. This could be accomplished
by something like the following for `kglobalshortcutsrc`
```bash
{{if lookPath "my-fancy-program"}}
set "my-fancy-program.desktop" _k_friendly_name "My fancy program" separator="="
set "my-fancy-program.desktop" _launch "Ctrl+Shift+Y,none,my-fancy-program" separator="="
{{end}}
# Make sure the lines aren't added back into the config for all systems
# This should be outside the if statement
add:remove "my-fancy-program.desktop" _k_friendly_name
add:remove "my-fancy-program.desktop" _launch
```
(In this case, note that you might need to manage the `.desktop` file with
chezmoi as well. KDE normally creates these in `$HOME/.local/share/applications/`.)
Similarly, `remove` can be used to remove entries, but be careful when readding
the source files: If you blindly re-add the file on the computer where the lines
are filtered out, they will get lost for all computers.