psi-jack
/
yadm
mirror of
1
0
Fork 0
Code Issues Releases Wiki Activity

Use all paths relative to ~/ in FAQ for clarity

This commit is contained in:
LFdev 2023-11-14 14:20:22 -03:00
parent 64864ba10a
commit 632689834b
No known key found for this signature in database
GPG Key ID: 2F374E5CD5D09119
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
_docs/110_faq.md
View File

@ -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 encrypt/decrypt features. yadm will tell you if it is missing a dependency
for any command. 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 Yes! This way your configuration for what files should be encrypted will follow
you when you clone your repository. you when you clone your repository.
@ -113,18 +113,18 @@ you when you clone your repository.
### Should I `yadm add` encrypted files to repository? ### Should I `yadm add` encrypted files to repository?
No, you should not. Files you want encrypted should be added to the file 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 `~/.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` should be added to the yadm repository. This way, only
an encrypted collection of those files are put into the repository. After 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 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. [encryption help](encryption) for more details.
### I modified an encrypted file, but yadm doesn't show any modifications. Why? ### 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 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`. re-run `yadm encrypt` to generate a new version of `~/.local/share/yadm/archive`.
Then `$HOME/.local/share/yadm/archive` can be added to a new commit. Then `~/.local/share/yadm/archive` can be added to a new commit.
### Why do I get the error `Inappropriate ioctl for device` when encrypting. ### 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. along with your other configurations.
Another option is to add patterns to 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 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 `yadm-auto-excludes` line, as all lines below this can be overwritten by yadm
when encrypting data. when encrypting data.