psi-jack/yadm
1
0
Fork 0
mirror of synced 2024-12-21 06:01:08 -05:00
Code Issues Releases Wiki Activity

Update version number and update documentation

Browse source 
* Support spaces in distro/distro-family (#432)
* Fix zsh hanging when tab completing add/checkout (#417)
* Add yadm-untracked script to contributed files (#418)
* Fix documentation typos (#425)
* Support docker-like OCI engines for dev testing (#431)
This commit is contained in:
Tim Byrne 2023-01-23 13:25:54 -06:00
parent 5981f6329e
commit 2d4dcd05ef
No known key found for this signature in database
GPG key ID: 14DB4FC2465A4B12
7 changed files with 157 additions and 150 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CHANGES
View file

@ -1,3 +1,10 @@
3.2.2
* Support spaces in distro/distro-family (#432)
* Fix zsh hanging when tab completing add/checkout (#417)
* Add yadm-untracked script to contributed files (#418)
* Fix documentation typos (#425)
* Support docker-like OCI engines for dev testing (#431)
3.2.1 3.2.1
* Fix Bash 3 bad array subscript bug (#411) * Fix Bash 3 bad array subscript bug (#411)

6
CONTRIBUTORS
View file

@ -12,8 +12,12 @@ Espen Henriksen
Cameron Eagans Cameron Eagans
Klas Mellbourn Klas Mellbourn
James Clark James Clark
Glenn Waters
Nicolas signed-log FORMICHELLA
Tomas Cernaj Tomas Cernaj
Joshua Cold
jonasc jonasc
Nicolas stig124 FORMICHELLA
Chad Wade Day, Jr Chad Wade Day, Jr
Sébastien Gross Sébastien Gross
David Mandelberg David Mandelberg
@ -26,7 +30,6 @@ Siôn Le Roux
Mateusz Piotrowski Mateusz Piotrowski
Uroš Golja Uroš Golja
Satoshi Ohki Satoshi Ohki
Nicolas stig124 FORMICHELLA
Jonas Jonas
Franciszek Madej Franciszek Madej
Daniel Wagenknecht Daniel Wagenknecht
@ -46,3 +49,4 @@ Thomas Luzat
Russ Allbery Russ Allbery
Brayden Banks Brayden Banks
Alexandre GV Alexandre GV
Felipe S. S. Schneider

2
README.md
View file

@ -72,7 +72,7 @@ The star count helps others discover yadm.
[master-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Tests/master?label=master [master-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Tests/master?label=master
[master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master [master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master
[master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master [master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master
[obs-badge]: https://img.shields.io/badge/OBS-v3.2.1-blue [obs-badge]: https://img.shields.io/badge/OBS-v3.2.2-blue
[obs-link]: https://software.opensuse.org//download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm [obs-link]: https://software.opensuse.org//download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm
[releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release [releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release
[releases-link]: https://github.com/TheLocehiliosan/yadm/releases [releases-link]: https://github.com/TheLocehiliosan/yadm/releases

4
yadm
View file

@ -1,6 +1,6 @@
#!/bin/sh #!/bin/sh
# yadm - Yet Another Dotfiles Manager # yadm - Yet Another Dotfiles Manager
# Copyright (C) 2015-2022 Tim Byrne # Copyright (C) 2015-2023 Tim Byrne
# This program is free software: you can redistribute it and/or modify # This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by # it under the terms of the GNU General Public License as published by
@ -21,7 +21,7 @@ if [ -z "$BASH_VERSION" ]; then
[ "$YADM_TEST" != 1 ] && exec bash "$0" "$@" [ "$YADM_TEST" != 1 ] && exec bash "$0" "$@"
fi fi
VERSION=3.2.1 VERSION=3.2.2
YADM_WORK="$HOME" YADM_WORK="$HOME"
YADM_DIR= YADM_DIR=

2
yadm.1
View file

@ -1,5 +1,5 @@
.\" vim: set spell so=8: .\" vim: set spell so=8:
.TH yadm 1 "17 March 2022" "3.2.1" .TH yadm 1 "23 January 2023" "3.2.2"
.SH NAME .SH NAME

284
yadm.md
View file

@ -42,68 +42,68 @@
## DESCRIPTION ## DESCRIPTION
yadm is a tool for managing a collection of files across multiple com- yadm is a tool for managing a collection of files across multiple com‐
puters, using a shared Git repository. In addition, yadm provides a puters, using a shared Git repository. In addition, yadm provides a
feature to select alternate versions of files for particular systems. feature to select alternate versions of files for particular systems.
Lastly, yadm supplies the ability to manage a subset of secure files, Lastly, yadm supplies the ability to manage a subset of secure files,
which are encrypted before they are included in the repository. which are encrypted before they are included in the repository.
## COMMANDS ## COMMANDS
git-command or git-alias git-command or git-alias
Any command not internally handled by yadm is passed through to Any command not internally handled by yadm is passed through to
git(1). Git commands or aliases are invoked with the yadm man- git(1). Git commands or aliases are invoked with the yadm man‐
aged repository. The working directory for Git commands will be aged repository. The working directory for Git commands will be
the configured work-tree (usually $HOME). the configured work-tree (usually $HOME).
Dotfiles are managed by using standard git commands; add, com- Dotfiles are managed by using standard git commands; add, com‐
mit, push, pull, etc. mit, push, pull, etc.
The config command is not passed directly through. Instead use The config command is not passed directly through. Instead use
the gitconfig command (see below). the gitconfig command (see below).
alt Create symbolic links and process templates for any managed alt Create symbolic links and process templates for any managed
files matching the naming rules described in the ALTERNATES and files matching the naming rules described in the ALTERNATES and
TEMPLATES sections. It is usually unnecessary to run this com- TEMPLATES sections. It is usually unnecessary to run this com‐
mand, as yadm automatically processes alternates by default. mand, as yadm automatically processes alternates by default.
This automatic behavior can be disabled by setting the configu- This automatic behavior can be disabled by setting the configu‐
ration yadm.auto-alt to "false". ration yadm.auto-alt to "false".
bootstrap bootstrap
Execute $HOME/.config/yadm/bootstrap if it exists. Execute $HOME/.config/yadm/bootstrap if it exists.
clone url clone url
Clone a remote repository for tracking dotfiles. After the con- Clone a remote repository for tracking dotfiles. After the con‐
tents of the remote repository have been fetched, a "check out" tents of the remote repository have been fetched, a "check out"
of the remote HEAD branch is attempted. If there are conflict- of the remote HEAD branch is attempted. If there are conflict‐
ing files already present in the work-tree, the local version ing files already present in the work-tree, the local version
will be left unmodified and you'll have to review and resolve will be left unmodified and you'll have to review and resolve
the difference. the difference.
The repository is stored in $HOME/.local/share/yadm/repo.git. The repository is stored in $HOME/.local/share/yadm/repo.git.
By default, $HOME will be used as the work-tree, but this can be By default, $HOME will be used as the work-tree, but this can be
overridden with the -w option. yadm can be forced to overwrite overridden with the -w option. yadm can be forced to overwrite
an existing repository by providing the -f option. If you want an existing repository by providing the -f option. If you want
to use a branch other than the remote HEAD branch you can spec- to use a branch other than the remote HEAD branch you can spec‐
ify it using the -b option. By default yadm will ask the user ify it using the -b option. By default yadm will ask the user
if the bootstrap program should be run (if it exists). The if the bootstrap program should be run (if it exists). The op‐
options --bootstrap or --no-bootstrap will either force the tions --bootstrap or --no-bootstrap will either force the boot‐
bootstrap to be run, or prevent it from being run, without strap to be run, or prevent it from being run, without prompting
prompting the user. the user.
config This command manages configurations for yadm. This command config This command manages configurations for yadm. This command
works exactly the way git-config(1) does. See the CONFIGURATION works exactly the way git-config(1) does. See the CONFIGURATION
section for more details. section for more details.
decrypt decrypt
Decrypt all files stored in $HOME/.local/share/yadm/archive. Decrypt all files stored in $HOME/.local/share/yadm/archive.
Files decrypted will be relative to the configured work-tree Files decrypted will be relative to the configured work-tree
(usually $HOME). Using the -l option will list the files stored (usually $HOME). Using the -l option will list the files stored
without extracting them. without extracting them.
encrypt encrypt
Encrypt all files matching the patterns found in $HOME/.con- Encrypt all files matching the patterns found in $HOME/.con‐
fig/yadm/encrypt. See the ENCRYPTION section for more details. fig/yadm/encrypt. See the ENCRYPTION section for more details.
enter Run a sub-shell with all Git variables set. Exit the sub-shell enter Run a sub-shell with all Git variables set. Exit the sub-shell
the same way you leave your normal shell (usually with the the same way you leave your normal shell (usually with the
@ -116,7 +116,7 @@
of invoking your shell, that command will be run with all of the of invoking your shell, that command will be run with all of the
Git variables exposed to the command's environment. Git variables exposed to the command's environment.
Emacs Tramp and Magit can manage files by using this configura- Emacs Tramp and Magit can manage files by using this configura‐
tion: tion:
(add-to-list 'tramp-methods (add-to-list 'tramp-methods
@ -130,9 +130,9 @@
With this config, use (magit-status "/yadm::"). With this config, use (magit-status "/yadm::").
git-crypt options git-crypt options
If git-crypt is installed, this command allows you to pass If git-crypt is installed, this command allows you to pass op‐
options directly to git-crypt, with the environment configured tions directly to git-crypt, with the environment configured to
to use the yadm repository. use the yadm repository.
git-crypt enables transparent encryption and decryption of files git-crypt enables transparent encryption and decryption of files
in a git repository. You can read https://github.com/AGWA/git- in a git repository. You can read https://github.com/AGWA/git-
@ -140,13 +140,13 @@
gitconfig gitconfig
Pass options to the git config command. Since yadm already uses Pass options to the git config command. Since yadm already uses
the config command to manage its own configurations, this com- the config command to manage its own configurations, this com‐
mand is provided as a way to change configurations of the repos- mand is provided as a way to change configurations of the repos‐
itory managed by yadm. One useful case might be to configure itory managed by yadm. One useful case might be to configure
the repository so untracked files are shown in status commands. the repository so untracked files are shown in status commands.
yadm initially configures its repository so that untracked files yadm initially configures its repository so that untracked files
are not shown. If you wish use the default Git behavior (to are not shown. If you wish use the default Git behavior (to
show untracked files and directories), you can remove this con- show untracked files and directories), you can remove this con‐
figuration. figuration.
yadm gitconfig --unset status.showUntrackedFiles yadm gitconfig --unset status.showUntrackedFiles
@ -169,15 +169,15 @@
support command line completion. support command line completion.
perms Update permissions as described in the PERMISSIONS section. It perms Update permissions as described in the PERMISSIONS section. It
is usually unnecessary to run this command, as yadm automati- is usually unnecessary to run this command, as yadm automati‐
cally processes permissions by default. This automatic behavior cally processes permissions by default. This automatic behavior
can be disabled by setting the configuration yadm.auto-perms to can be disabled by setting the configuration yadm.auto-perms to
"false". "false".
transcrypt options transcrypt options
If transcrypt is installed, this command allows you to pass If transcrypt is installed, this command allows you to pass op‐
options directly to transcrypt, with the environment configured tions directly to transcrypt, with the environment configured to
to use the yadm repository. use the yadm repository.
transcrypt enables transparent encryption and decryption of transcrypt enables transparent encryption and decryption of
files in a git repository. You can read files in a git repository. You can read
@ -186,7 +186,7 @@
upgrade upgrade
Version 3 of yadm uses a different directory for storing data. Version 3 of yadm uses a different directory for storing data.
When you start to use version 3 for the first time, you may see When you start to use version 3 for the first time, you may see
warnings about moving your data to this new directory. The eas- warnings about moving your data to this new directory. The eas‐
iest way to accomplish this is by running "yadm upgrade". This iest way to accomplish this is by running "yadm upgrade". This
command will start by moving your yadm repo to the new path. command will start by moving your yadm repo to the new path.
Next it will move any archive data. If the archive is tracked Next it will move any archive data. If the archive is tracked
@ -194,18 +194,18 @@
that file in the repo's index. that file in the repo's index.
Upgrading will attempt to de-initialize and re-initialize your Upgrading will attempt to de-initialize and re-initialize your
submodules. If your submodules cannot be de-initialized, the submodules. If your submodules cannot be de-initialized, the up‐
upgrade will fail. The most common reason submodules will fail grade will fail. The most common reason submodules will fail to
to de-initialize is because they have local modifications. If de-initialize is because they have local modifications. If you
you are willing to lose the local modifications to those submod- are willing to lose the local modifications to those submodules,
ules, you can use the -f option with the "upgrade" command to you can use the -f option with the "upgrade" command to force
force the de-initialization. the de-initialization.
After running "yadm upgrade", you should run "yadm status" to After running "yadm upgrade", you should run "yadm status" to
review changes which have been staged, and commit them to your review changes which have been staged, and commit them to your
repository. repository.
You can read https://yadm.io/docs/upgrade_from_2 for more infor- You can read https://yadm.io/docs/upgrade_from_2 for more infor‐
mation. mation.
version version
@ -214,7 +214,7 @@
## OPTIONS ## OPTIONS
yadm supports a set of universal options that alter the paths it uses. yadm supports a set of universal options that alter the paths it uses.
The default paths are documented in the FILES section. Any path speci- The default paths are documented in the FILES section. Any path speci‐
fied by these options must be fully qualified. If you always want to fied by these options must be fully qualified. If you always want to
override one or more of these paths, it may be useful to create an override one or more of these paths, it may be useful to create an
alias for the yadm command. For example, the following alias could be alias for the yadm command. For example, the following alias could be
@ -261,24 +261,24 @@
The following is the full list of supported configurations: The following is the full list of supported configurations:
yadm.alt-copy yadm.alt-copy
If set to "true", alternate files will be copies instead of sym- If set to "true", alternate files will be copies instead of sym‐
bolic links. This might be desirable, because some systems may bolic links. This might be desirable, because some systems may
not properly support symlinks. not properly support symlinks.
yadm.auto-alt yadm.auto-alt
Disable the automatic linking described in the section ALTER- Disable the automatic linking described in the section ALTER‐
NATES. If disabled, you may still run "yadm alt" manually to NATES. If disabled, you may still run "yadm alt" manually to
create the alternate links. This feature is enabled by default. create the alternate links. This feature is enabled by default.
yadm.auto-exclude yadm.auto-exclude
Disable the automatic exclusion of patterns defined in Disable the automatic exclusion of patterns defined in
$HOME/.config/yadm/encrypt. This feature is enabled by default. $HOME/.config/yadm/encrypt. This feature is enabled by default.
yadm.auto-perms yadm.auto-perms
Disable the automatic permission changes described in the sec- Disable the automatic permission changes described in the sec‐
tion PERMISSIONS. If disabled, you may still run yadm perms tion PERMISSIONS. If disabled, you may still run yadm perms
manually to update permissions. This feature is enabled by manually to update permissions. This feature is enabled by de‐
default. fault.
yadm.auto-private-dirs yadm.auto-private-dirs
Disable the automatic creating of private directories described Disable the automatic creating of private directories described
@ -287,20 +287,20 @@
yadm.cipher yadm.cipher
Configure which encryption system is used by the encrypt/decrypt Configure which encryption system is used by the encrypt/decrypt
commands. Valid options are "gpg" and "openssl". The default is commands. Valid options are "gpg" and "openssl". The default is
"gpg". Detailed information can be found in the section ENCRYP- "gpg". Detailed information can be found in the section ENCRYP‐
TION. TION.
yadm.git-program yadm.git-program
Specify an alternate program to use instead of "git". By Specify an alternate program to use instead of "git". By de‐
default, the first "git" found in $PATH is used. fault, the first "git" found in $PATH is used.
yadm.gpg-perms yadm.gpg-perms
Disable the permission changes to $HOME/.gnupg/*. This feature Disable the permission changes to $HOME/.gnupg/*. This feature
is enabled by default. is enabled by default.
yadm.gpg-program yadm.gpg-program
Specify an alternate program to use instead of "gpg". By Specify an alternate program to use instead of "gpg". By de‐
default, the first "gpg" found in $PATH is used. fault, the first "gpg" found in $PATH is used.
yadm.gpg-recipient yadm.gpg-recipient
Asymmetrically encrypt files with a gpg public/private key pair. Asymmetrically encrypt files with a gpg public/private key pair.
@ -308,9 +308,9 @@
The key must exist in your public keyrings. Multiple recipients The key must exist in your public keyrings. Multiple recipients
can be specified (separated by space). If left blank or not can be specified (separated by space). If left blank or not
provided, symmetric encryption is used instead. If set to provided, symmetric encryption is used instead. If set to
"ASK", gpg will interactively ask for recipients. See the "ASK", gpg will interactively ask for recipients. See the EN‐
ENCRYPTION section for more details. This feature is disabled CRYPTION section for more details. This feature is disabled by
by default. default.
yadm.openssl-ciphername yadm.openssl-ciphername
Specify which cipher should be used by openssl. "aes-256-cbc" Specify which cipher should be used by openssl. "aes-256-cbc"
@ -337,13 +337,13 @@
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. The local host can be By default, no class will be matched. The local host can be as‐
assigned multiple classes using command: signed multiple classes using command:
yadm config --add local.class <additional-class> yadm config --add local.class <additional-class>
local.arch local.arch
Override the architecture for the purpose of symlinking alter- Override the architecture for the purpose of symlinking alter‐
nate files. nate files.
local.hostname local.hostname
@ -362,53 +362,53 @@
to have an automated way of choosing an alternate version of a file for to have an automated way of choosing an alternate version of a file for
a different operating system, host, user, etc. a different operating system, host, user, etc.
yadm will automatically create a symbolic link to the appropriate ver- yadm will automatically create a symbolic link to the appropriate ver‐
sion of a file, when a valid suffix is appended to the filename. The sion of a file, when a valid suffix is appended to the filename. The
suffix contains the conditions that must be met for that file to be suffix contains the conditions that must be met for that file to be
used. used.
The suffix begins with "##", followed by any number of conditions sepa- The suffix begins with "##", followed by any number of conditions sepa‐
rated by commas. rated by commas.
##<condition>[,<condition>,...] ##<condition>[,<condition>,...]
Each condition is an attribute/value pair, separated by a period. Some Each condition is an attribute/value pair, separated by a period. Some
conditions do not require a "value", and in that case, the period and conditions do not require a "value", and in that case, the period and
value can be omitted. Most attributes can be abbreviated as a single value can be omitted. Most attributes can be abbreviated as a single
letter. letter.
<attribute>[.<value>] <attribute>[.<value>]
These are the supported attributes, in the order of the weighted prece- These are the supported attributes, in the order of the weighted prece‐
dence: dence:
template, t template, t
Valid when the value matches a supported template processor. Valid when the value matches a supported template processor.
See the TEMPLATES section for more details. See the TEMPLATES section for more details.
user, u user, u
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 hostname, h
Valid if the value matches the short hostname. Hostname is cal- Valid if the value matches the short hostname. Hostname is cal‐
culated by running uname -n, and trimming off any domain. culated by running uname -n, and trimming off any domain.
class, c class, c
Valid if the value matches the local.class configuration. Class Valid if the value matches the local.class configuration. Class
must be manually set using yadm config local.class <class>. See must be manually set using yadm config local.class <class>. See
the CONFIGURATION section for more details about setting the CONFIGURATION section for more details about setting lo‐
local.class. cal.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-re‐
release. lease.
distro_family, f distro_family, f
Valid if the value matches the distro family. Distro family is Valid if the value matches the distro family. Distro family is
calculated by inspecting the ID_LIKE line from /etc/os-release. 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.
@ -426,7 +426,6 @@
certain extension to e.g. make editors highlight the content certain extension to e.g. make editors highlight the content
properly. properly.
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".
@ -439,15 +438,15 @@
The "most appropriate" version is determined by calculating a score for The "most appropriate" version is determined by calculating a score for
each version of a file. A template is always scored higher than any each version of a file. A template is always scored higher than any
symlink condition. The number of conditions is the next largest factor symlink condition. The number of conditions is the next largest factor
in scoring. Files with more conditions will always be favored. Any in scoring. Files with more conditions will always be favored. Any in‐
invalid condition will disqualify that file completely. valid condition will disqualify that file completely.
If you don't care to have all versions of alternates stored in the same If you don't care to have all versions of alternates stored in the same
directory as the generated symlink, you can place them in the directory as the generated symlink, you can place them in the
$HOME/.config/yadm/alt directory. The generated symlink or processed $HOME/.config/yadm/alt directory. The generated symlink or processed
template will be created using the same relative path. template will be created using the same relative path.
Alternate linking may best be demonstrated by example. Assume the fol- Alternate linking may best be demonstrated by example. Assume the fol‐
lowing files are managed by yadm's repository: lowing files are managed by yadm's repository:
- $HOME/path/example.txt##default - $HOME/path/example.txt##default
@ -462,7 +461,7 @@
If running on a Macbook named "host2", yadm will create a symbolic link If running on a Macbook named "host2", yadm will create a symbolic link
which looks like this: which looks like this:
$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 Mackbook named "host3", yadm will create a symbolic However, on another Mackbook named "host3", yadm will create a symbolic
@ -491,7 +490,7 @@
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 (at the top level). 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
can be manually created by running yadm alt. can be manually created by running yadm alt.
@ -504,8 +503,8 @@
yadm config local.class Work yadm config local.class Work
Similarly, the values of architecture, os, hostname, and user can be Similarly, the values of architecture, os, hostname, and user can be
manually overridden using the configuration options local.arch, manually overridden using the configuration options local.arch, lo‐
local.os, local.hostname, and local.user. cal.os, local.hostname, and local.user.
## TEMPLATES ## TEMPLATES
@ -517,7 +516,7 @@
default default
This is yadm's built-in template processor. This processor is This is yadm's built-in template processor. This processor is
very basic, with a Jinja-like syntax. The advantage of this pro- very basic, with a Jinja-like syntax. The advantage of this pro‐
cessor is that it only depends upon awk, which is available on cessor is that it only depends upon awk, which is available on
most *nix systems. To use this processor, specify the value of most *nix systems. To use this processor, specify the value of
"default" or just leave the value off (e.g. "##template"). "default" or just leave the value off (e.g. "##template").
@ -537,14 +536,13 @@
envtpl To use the envtpl Jinja template processor, specify the value of envtpl To use the envtpl Jinja template processor, specify the value of
"j2" or "envtpl". "j2" or "envtpl".
NOTE: Specifying "j2" as the processor will attempt to use j2cli or en‐
NOTE: Specifying "j2" as the processor will attempt to use j2cli or vtpl, whichever is available.
envtpl, whichever is available.
If the template processor specified is available, templates will be If the template processor specified is available, templates will be
processed to create or overwrite files. processed to create or overwrite files.
During processing, the following variables are available in the tem- During processing, the following variables are available in the tem‐
plate: plate:
Default Jinja or ESH Description Default Jinja or ESH Description
@ -635,7 +633,7 @@
The yadm encrypt command will find all files matching the patterns, and The yadm encrypt command will find all files matching the patterns, and
prompt for a password. Once a password has confirmed, the matching prompt for a password. Once a password has confirmed, the matching
files will be encrypted and saved as $HOME/.local/share/yadm/archive. files will be encrypted and saved as $HOME/.local/share/yadm/archive.
The "encrypt" and "archive" files should be added to the yadm reposi- The "encrypt" and "archive" files should be added to the yadm reposi‐
tory so they are available across multiple systems. tory so they are available across multiple systems.
To decrypt these files later, or on another system run yadm decrypt and To decrypt these files later, or on another system run yadm decrypt and
@ -650,27 +648,25 @@
Patterns found in $HOME/.config/yadm/encrypt are automatically added to Patterns found in $HOME/.config/yadm/encrypt are automatically added to
the repository's info/exclude file every time yadm encrypt is run. the repository's info/exclude file every time yadm encrypt is run.
This is to prevent accidentally committing sensitive data to the repos- This is to prevent accidentally committing sensitive data to the repos‐
itory. This can be disabled using the yadm.auto-exclude configuration. itory. This can be disabled using the yadm.auto-exclude configuration.
Using transcrypt or git-crypt Using transcrypt or git-crypt
A completely separate option for encrypting data is to install and use A completely separate option for encrypting data is to install and use
transcrypt or git-crypt. Once installed, you can use these tools by transcrypt or git-crypt. Once installed, you can use these tools by
running yadm transcrypt or yadm git-crypt. These tools enables trans- running yadm transcrypt or yadm git-crypt. These tools enables trans‐
parent encryption and decryption of files in a git repository. See the parent encryption and decryption of files in a git repository. See the
following web sites for more information: following web sites for more information:
- https://github.com/elasticdog/transcrypt - https://github.com/elasticdog/transcrypt
- https://github.com/AGWA/git-crypt - https://github.com/AGWA/git-crypt
## PERMISSIONS ## PERMISSIONS
When files are checked out of a Git repository, their initial permis- When files are checked out of a Git repository, their initial permis‐
sions are dependent upon the user's umask. Because of this, yadm will sions are dependent upon the user's umask. Because of this, yadm will
automatically update the permissions of some file paths. The "group" automatically update the permissions of some file paths. The "group"
and "others" permissions will be removed from the following files: and "others" permissions will be removed from the following files:
- $HOME/.local/share/yadm/archive - $HOME/.local/share/yadm/archive
@ -681,40 +677,40 @@
- The GPG directory and files, .gnupg/* - The GPG directory and files, .gnupg/*
yadm will automatically update permissions by default. This can be dis- yadm will automatically update permissions by default. This can be dis‐
abled using the yadm.auto-perms configuration. Even if disabled, per- abled using the yadm.auto-perms configuration. Even if disabled, per‐
missions can be manually updated by running yadm perms. The .ssh missions can be manually updated by running yadm perms. The .ssh di‐
directory processing can be disabled using the yadm.ssh-perms configu- rectory processing can be disabled using the yadm.ssh-perms configura‐
ration. The .gnupg directory processing can be disabled using the tion. The .gnupg directory processing can be disabled using the
yadm.gpg-perms configuration. yadm.gpg-perms configuration.
When cloning a repo which includes data in a .ssh or .gnupg directory, When cloning a repo which includes data in a .ssh or .gnupg directory,
if those directories do not exist at the time of cloning, yadm will if those directories do not exist at the time of cloning, yadm will
create the directories with mask 0700 prior to merging the fetched data create the directories with mask 0700 prior to merging the fetched data
into the work-tree. into the work-tree.
When running a Git command and .ssh or .gnupg directories do not exist, When running a Git command and .ssh or .gnupg directories do not exist,
yadm will create those directories with mask 0700 prior to running the yadm will create those directories with mask 0700 prior to running the
Git command. This can be disabled using the yadm.auto-private-dirs con- Git command. This can be disabled using the yadm.auto-private-dirs con‐
figuration. figuration.
## HOOKS ## HOOKS
For every command yadm supports, a program can be provided to run For every command yadm supports, a program can be provided to run be‐
before or after that command. These are referred to as "hooks". yadm fore or after that command. These are referred to as "hooks". yadm
looks for hooks in the directory $HOME/.config/yadm/hooks. Each hook looks for hooks in the directory $HOME/.config/yadm/hooks. Each hook
is named using a prefix of pre_ or post_, followed by the command which is named using a prefix of pre_ or post_, followed by the command which
should trigger the hook. For example, to create a hook which is run should trigger the hook. For example, to create a hook which is run af‐
after every yadm pull command, create a hook named post_pull. Hooks ter every yadm pull command, create a hook named post_pull. Hooks must
must have the executable file permission set. have the executable file permission set.
If a pre_ hook is defined, and the hook terminates with a non-zero exit If a pre_ hook is defined, and the hook terminates with a non-zero exit
status, yadm will refuse to run the yadm command. For example, if a status, yadm will refuse to run the yadm command. For example, if a
pre_commit hook is defined, but that command ends with a non-zero exit pre_commit hook is defined, but that command ends with a non-zero exit
status, the yadm commit will never be run. This allows one to "short- status, the yadm commit will never be run. This allows one to "short-
circuit" any operation using a pre_ hook. circuit" any operation using a pre_ hook.
Hooks have the following environment variables available to them at Hooks have the following environment variables available to them at
runtime: runtime:
YADM_HOOK_COMMAND YADM_HOOK_COMMAND
@ -736,37 +732,37 @@
## FILES ## FILES
All of yadm's configurations are relative to the "yadm directory". All of yadm's configurations are relative to the "yadm directory".
yadm uses the "XDG Base Directory Specification" to determine this yadm uses the "XDG Base Directory Specification" to determine this di‐
directory. If the environment variable $XDG_CONFIG_HOME is defined as rectory. If the environment variable $XDG_CONFIG_HOME is defined as a
a fully qualified path, this directory will be $XDG_CONFIG_HOME/yadm. fully qualified path, this directory will be $XDG_CONFIG_HOME/yadm.
Otherwise it will be $HOME/.config/yadm. Otherwise it will be $HOME/.config/yadm.
Similarly, yadm's data files are relative to the "yadm data directory". Similarly, yadm's data files are relative to the "yadm data directory".
yadm uses the "XDG Base Directory Specification" to determine this yadm uses the "XDG Base Directory Specification" to determine this di‐
directory. If the environment variable $XDG_DATA_HOME is defined as a rectory. If the environment variable $XDG_DATA_HOME is defined as a
fully qualified path, this directory will be $XDG_DATA_HOME/yadm. Oth- fully qualified path, this directory will be $XDG_DATA_HOME/yadm. Oth‐
erwise it will be $HOME/.local/share/yadm. erwise it will be $HOME/.local/share/yadm.
The following are the default paths yadm uses for its own data. Most The following are the default paths yadm uses for its own data. Most
of these paths can be altered using universal options. See the OPTIONS of these paths can be altered using universal options. See the OPTIONS
section for details. section for details.
$HOME/.config/yadm $HOME/.config/yadm
The yadm directory. By default, all configs yadm stores is rela- The yadm directory. By default, all configs yadm stores is rela‐
tive to this directory. tive to this directory.
$HOME/.local/share/yadm $HOME/.local/share/yadm
The yadm data directory. By default, all data yadm stores is The yadm data directory. By default, all data yadm stores is
relative to this directory. relative to this directory.
$YADM_DIR/config $YADM_DIR/config
Configuration file for yadm. Configuration file for yadm.
$YADM_DIR/alt $YADM_DIR/alt
This is a directory to keep "alternate files" without having This is a directory to keep "alternate files" without having
them side-by-side with the resulting symlink or processed tem- them side-by-side with the resulting symlink or processed tem‐
plate. Alternate files placed in this directory will be created plate. Alternate files placed in this directory will be created
relative to $HOME instead. relative to $HOME instead.
$YADM_DATA/repo.git $YADM_DATA/repo.git

2
yadm.spec
View file

@ -1,7 +1,7 @@
%{!?_pkgdocdir: %global _pkgdocdir %{_docdir}/%{name}-%{version}} %{!?_pkgdocdir: %global _pkgdocdir %{_docdir}/%{name}-%{version}}
Name: yadm Name: yadm
Summary: Yet Another Dotfiles Manager Summary: Yet Another Dotfiles Manager
Version: 3.2.1 Version: 3.2.2
Group: Development/Tools Group: Development/Tools
Release: 1%{?dist} Release: 1%{?dist}
URL: https://yadm.io URL: https://yadm.io