From 632689834b0b11394abc2d7195426eafcad1d5d4 Mon Sep 17 00:00:00 2001 From: LFdev Date: Tue, 14 Nov 2023 14:20:22 -0300 Subject: [PATCH] Use all paths relative to ~/ in FAQ for clarity --- _docs/110_faq.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/_docs/110_faq.md b/_docs/110_faq.md index fcca506..08f98b7 100644 --- a/_docs/110_faq.md +++ b/_docs/110_faq.md @@ -105,7 +105,7 @@ Of course. You only need `gpg` installed if you plan on using the encrypt/decrypt features. yadm will tell you if it is missing a dependency for any command. -### Should I `yadm add` my `.config/yadm/encrypt` file? +### Should I `yadm add` my `~/.config/yadm/encrypt` file? Yes! This way your configuration for what files should be encrypted will follow you when you clone your repository. @@ -113,18 +113,18 @@ you when you clone your repository. ### Should I `yadm add` encrypted files to repository? No, you should not. Files you want encrypted should be added to the file -`$HOME/.local/share/yadm/archive` using the `yadm encrypt` command. Then -`$HOME/.local/share/yadm/archive` should be added to the yadm repository. This way, only +`~/.local/share/yadm/archive` using the `yadm encrypt` command. Then +`~/.local/share/yadm/archive` should be added to the yadm repository. This way, only an encrypted collection of those files are put into the repository. After cloning or updating your repository, you can use `yadm decrypt` to extract those -files from `$HOME/.local/share/yadm/archive`. See the +files from `~/.local/share/yadm/archive`. See the [encryption help](encryption) for more details. ### I modified an encrypted file, but yadm doesn't show any modifications. Why? -If you changed files which are matched by `.config/yadm/encrypt`, you must -re-run `yadm encrypt` to generate a new version of `$HOME/.local/share/yadm/archive`. -Then `$HOME/.local/share/yadm/archive` can be added to a new commit. +If you changed files which are matched by `~/.config/yadm/encrypt`, you must +re-run `yadm encrypt` to generate a new version of `~/.local/share/yadm/archive`. +Then `~/.local/share/yadm/archive` can be added to a new commit. ### Why do I get the error `Inappropriate ioctl for device` when encrypting. @@ -175,7 +175,7 @@ Git. Be sure to add these `.gitignore` files to your repo, so they can be synced along with your other configurations. Another option is to add patterns to -`$HOME/.local/share/yadm/repo.git/info/exclude`. +`~/.local/share/yadm/repo.git/info/exclude`. If you use this file, be sure to add your patterns above any `yadm-auto-excludes` line, as all lines below this can be overwritten by yadm when encrypting data.