Release 1.02

Update version number and update documentation
This commit is contained in:
Tim Byrne 2015-08-12 00:56:36 -05:00
parent 3a1a370efb
commit 0e7e92a3c1
4 changed files with 30 additions and 19 deletions

View File

@ -1,3 +1,6 @@
1.02
* Handle permissions for `~/.gnupg/*gpg`
1.01
* Set `status.showUntrackedFiles` to "no"

2
yadm
View File

@ -15,7 +15,7 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
VERSION=1.01
VERSION=1.02
YADM_WORK="$HOME"
YADM_DIR="$HOME/.yadm"

2
yadm.1
View File

@ -1,5 +1,5 @@
." vim: set spell so=8:
.TH yadm 1 "14 July 2015" "1.00"
.TH yadm 1 "12 August 2015" "1.02"
.SH NAME
yadm \- Yet Another Dotfiles Manager
.SH SYNOPSIS

20
yadm.md
View File

@ -146,6 +146,10 @@
Disable the permission changes to $HOME/.ssh/*. This feature is
enabled by default.
yadm.gpg-perms
Disable the permission changes to $HOME/.gnupg/*. This feature
is enabled by default.
## ALTERNATES
When managing a set of files across different systems, it can be useful
to have an automated way of choosing an alternate version of a file for
@ -199,18 +203,20 @@
abled, links can be manually created by running yadm alt.
## ENCRYPTION
It can be useful to manage confidential files, like SSH keys, across
multiple systems. However, doing so would put plain text data into a
Git repository, which often resides on a public system. yadm imple-
ments a feature which can make it easy to encrypt and decrypt a set of
files so the encrypted version can be maintained in the Git repository.
This feature will only work if the gpg(1) command is available.
It can be useful to manage confidential files, like SSH or GPG keys,
across multiple systems. However, doing so would put plain text data
into a Git repository, which often resides on a public system. yadm
implements a feature which can make it easy to encrypt and decrypt a
set of files so the encrypted version can be maintained in the Git
repository. This feature will only work if the gpg(1) command is
available.
To use this feature, a list of patterns must be created and saved as
$HOME/.yadm/encrypt. This list of patterns should be relative to the
configured work-tree (usually $HOME). For example:
.ssh/*.key
.gnupg/*.gpg
The yadm encrypt command will find all files matching the patterns, and
prompt for a password. Once a password has confirmed, the matching
@ -240,6 +246,8 @@
- The SSH directory and files, .ssh/*
- The GPG directory and files, .gnupg/*
yadm will automatically update permissions by default. This can be dis-
abled using the yadm.auto-perms configuration. Even if disabled, per-
missions can be manually updated by running yadm perms. The SSH direc-