fix typos in README.md and config.toml comments

This commit is contained in:
2026-02-10 20:42:01 +03:00
parent 5d28bc72ad
commit fad35ec04b
2 changed files with 40 additions and 43 deletions

View File

@@ -1,6 +1,6 @@
[general]
# if dry run is set to true
# userctx will only validate config
# userctx will only validate config
# and tell you what it will do to apply context
# tasks
dry_run = true
@@ -15,9 +15,9 @@ apps = [
]
# target directory where managed configs
# are located
# are located
# defaults to $XDG_CONFIG_HOME if specifically set
# or ~/.config if $XGD_CONFIG_HOME is not set
# or ~/.config if $XDG_CONFIG_HOME is not set
target_path = "~/.config"
# directory where contexts are stored
@@ -32,18 +32,18 @@ source_path = "~/.config/userctx"
# if not overridden with general.target_path.
# Setting "target_path" overrides this.
# $CONTEXT_DST env will hold the actual destination path.
# symlinks will be created relative to this specified
# symlinks will be created relative to this specified
# path.
target_path = "~/.config/example/configs"
# "symlink" map defines
# which files will be symlinked to users home
# which files will be symlinked to user's home
# directory.
# Names of files in this mapping are relative to
# Names of files in this mapping are relative to
# context directory and target directory
# by default source is ~/.config/userctx/<context_name>/example
# by default source is ~/.config/userctx/<context_name>/example
# and target directory is ~/.config/example
# for app named "example"
# for app named "example"
#
# this will link file from context dir to destination dir
# $CONTEXT_SRC/context_file.conf -> $CONTEXT_DST/symlink_to_context_file.conf
@@ -58,7 +58,7 @@ symlink."subdir/yet_another_file.conf" = "yet_another_file.conf"
# If symlinks mapping is not empty then only instructions from the map
# will be applied. If you want to redefine linking rules only for single
# file and symlink others according to default rules then add the following
# rule as well.
# rule as well.
symlink."*" = "*"
# As a special case, providing the following mapping symlinks
@@ -68,20 +68,20 @@ symlink."*" = "*"
# symlink."*" = "some/destination.conf"
# "exec" let's you write a reload command or
# "exec" lets you write a reload command or
# even a bigger custom script that will apply contents of
# your context. Note the triple double-qoutes for multiline
# strings (see TOML spec).
# your context. Note the triple double-quotes for multiline
# strings (see TOML spec).
# This string will be passed as is to $SHELL for execution.
exec = """
# this is a normal shell script which will
# be executed by user's $SHELL or 'bash' binary
# if users $SHELL is empty
# if user's $SHELL is empty
# users envs are available
echo "$HOME"
# user's envs are available
echo "$HOME"
# additional envs are available
# additional envs are available
echo "$CONTEXT_SRC"
echo "$CONTEXT_DST"
echo "$CONTEXT_NAME"
@@ -89,10 +89,10 @@ exec = """
# if "script" array is not empty
# then userctx will try to find
# named files in $CONTEXT_SRC and
# named files in $CONTEXT_SRC and
# execute them with $SHELL <script>
# IMPORTANT: if array is empty
# and action "scripts" is present in
# and action "scripts" is present in
# "actions" array above then all files
# in $CONTEXT_SRC will be treated as scripts
# (note the "apps.gtk section below")
@@ -101,18 +101,18 @@ script = [
"script2.sh",
]
# if "reload" is present, the command will be executed after everythong alse is done
# if "reload" is present, the command will be executed after everything else is done
reload = "pkill -USR1 example"
# "actions" array specifies the order of actions when
# applying context. If omitted, the default behaviour
# it to symlink, run scripts, run exec part then run reload
# command (if relevant actions are specified).
# If nothig has been customized in apps configuration here
# (no commands array, not symlinks mapping etc.) then userctx
# will just symlink anythong it finds to target_path.
# If nothing has been customized in apps configuration here
# (no commands array, no symlinks mapping etc.) then userctx
# will just symlink anything it finds to target_path.
# If actions array is declared empty (actions = []) then
# userctx will do nothig.
# userctx will do nothing.
actions = [
"symlink",
"exec",
@@ -134,9 +134,9 @@ target_path = "~/.config/niri/configs"
# The snippet below is needed for niri 25.8 which did not
# support imports/includes in the config. I'm splitting
# config into several parts, putting those to ~/.config/niri/configs
# and them concatenating them after applying changes to theme.
# and then concatenating them after applying changes to theme.
# Also note the custom target path above. It instructs userctx to
# symlink configs found in the context dir to
# symlink configs found in the context dir to
# ~/.config/niri/configs, which then get concatenated.
# For niri since 25.11 you can just put your includes
# into the context dir and omit [apps.niri] altogether.
@@ -152,7 +152,7 @@ reload = "pkill -USR1 hx"
[apps.gtk]
# To setup the look of GTK you may put a simple shell script
# into ~/.userctx/<context_name>/gtk/theme.sh with contents similar to:
# into ~/.userctx/<context_name>/gtk/theme.sh with contents similar to:
# gsettings set org.gnome.desktop.interface color-scheme 'default'
# gsettings set org.gnome.desktop.interface gtk-theme 'Yaru'
# gsettings set org.gnome.desktop.interface icon-theme 'Yaru'
@@ -171,11 +171,9 @@ reload = 'pkill -USR1 kitty'
reload = 'pkill -USR2 waybar'
[apps.swaybg]
# This config is for swaybg setup as s systemd service.
# This config is for swaybg setup as a systemd service.
# Unit runs "swaybg -m fill -i "%h/.config/swaybg/wallpaper".
# ~/.config/userctx/<context>/swaybg/ contains single file
# ~/.config/userctx/<context>/swaybg/ contains single file
# which gets symlinked to ~/.config/swaybg/wallpaper
symlink."*" = "wallpaper"
reload = 'systemctl --user restart swaybg.service'