@ -331,13 +331,20 @@
Disable the permission changes to $HOME/.ssh/*. This feature is
Disable the permission changes to $HOME/.ssh/*. This feature is
enabled by default.
enabled by default.
The following four "local" configurations are not stored in the
The following five "local" configurations are not stored in the
$HOME/.config/yadm/config, they are stored in the local repository.
$HOME/.config/yadm/config, they are stored in the local repository.
local.class
local.class
Specify a class for the purpose of symlinking alternate files.
Specify a class for the purpose of symlinking alternate files.
By default, no class will be matched.
By default, no class will be matched. The local host can be
assigned multiple classes using command:
yadm config --add local.class < additional-class >
local.arch
Override the architecture for the purpose of symlinking alter-
nate files.
local.hostname
local.hostname
Override the hostname for the purpose of symlinking alternate
Override the hostname for the purpose of symlinking alternate
@ -384,23 +391,31 @@
Valid if the value matches the current user. Current user is
Valid if the value matches the current user. Current user is
calculated by running id -u -n.
calculated by running id -u -n.
hostname, h
Valid if the value matches the short hostname. Hostname is cal-
culated by running uname -n, and trimming off any domain.
class, c
Valid if the value matches the local.class configuration. Class
must be manually set using yadm config local.class < class > . See
the CONFIGURATION section for more details about setting
local.class.
distro, d
distro, d
Valid if the value matches the distro. Distro is calculated by
Valid if the value matches the distro. Distro is calculated by
running lsb_release -si or by inspecting the ID from /etc/os-
running lsb_release -si or by inspecting the ID from /etc/os-
release.
release.
distro_family, f
Valid if the value matches the distro family. Distro family is
calculated by inspecting the ID_LIKE line from /etc/os-release.
os, o Valid if the value matches the OS. OS is calculated by running
os, o Valid if the value matches the OS. OS is calculated by running
uname -s.
uname -s.
class, c
arch, a
Valid if the value matches the local.class configuration. Class
Valid if the value matches the architecture. Architecture is
must be manually set using yadm config local.class < class > . See
calculated by running uname -m.
the CONFIGURATION section for more details about setting
local.class.
hostname, h
Valid if the value matches the short hostname. Hostname is cal-
culated by running uname -n, and trimming off any domain.
default
default
Valid when no other alternate is valid.
Valid when no other alternate is valid.
@ -450,7 +465,7 @@
$HOME/path/example.txt -> $HOME/path/example.txt##os.Darwin,host-
$HOME/path/example.txt -> $HOME/path/example.txt##os.Darwin,host-
name.host2
name.host2
However, on another Macbook named "host3", yadm will create a symbolic
However, on another Mack book named "host3", yadm will create a symbolic
link which looks like this:
link which looks like this:
$HOME/path/example.txt -> $HOME/path/example.txt##os.Darwin
$HOME/path/example.txt -> $HOME/path/example.txt##os.Darwin
@ -474,7 +489,7 @@
then no link will be created.
then no link will be created.
Links are also created for directories named this way, as long as they
Links are also created for directories named this way, as long as they
have at least one yadm managed file within them.
have at least one yadm managed file within them (at the top level) .
yadm will automatically create these links by default. This can be dis-
yadm will automatically create these links by default. This can be dis-
abled using the yadm.auto-alt configuration. Even if disabled, links
abled using the yadm.auto-alt configuration. Even if disabled, links
@ -488,9 +503,9 @@
yadm config local.class Work
yadm config local.class Work
Similarly, the values of os, hostname, and user can be manually over-
Similarly, the values of architecture, os, hostname, and user can be
ridden using the configuration options local.os, local.hostname, and
manually overridden using the configuration options local.arch,
local.user.
local.os, local.hostname, and local. user.
## TEMPLATES
## TEMPLATES
@ -533,13 +548,17 @@
plate:
plate:
Default Jinja or ESH Description
Default Jinja or ESH Description
------------- ------------- --------------------------
------------- ------------- ----------------------------
yadm.class YADM_CLASS Locally defined yadm class
yadm.arch YADM_ARCH uname -m
yadm.class YADM_CLASS Last locally defined class
yadm.classes YADM_CLASSES All classes
yadm.distro YADM_DISTRO lsb_release -si
yadm.distro YADM_DISTRO lsb_release -si
yadm.distro_family YADM_DISTRO_FAMILY ID_LIKE from /etc/os-release
yadm.hostname YADM_HOSTNAME uname -n (without domain)
yadm.hostname YADM_HOSTNAME uname -n (without domain)
yadm.os YADM_OS uname -s
yadm.os YADM_OS uname -s
yadm.user YADM_USER id -u -n
yadm.source YADM_SOURCE Template filename
yadm.source YADM_SOURCE Template filename
yadm.user YADM_USER id -u -n
env.VAR Environment variable VAR
NOTE: The OS for "Windows Subsystem for Linux" is reported as "WSL",
NOTE: The OS for "Windows Subsystem for Linux" is reported as "WSL",
even though uname identifies as "Linux".
even though uname identifies as "Linux".
Tim Byrne
2 years ago