Merge pull request #57 from renard/enter-function

yadm

@@ -53,7 +53,7 @@ function main() {
 
   #; parse command line arguments
   local retval=0
-  internal_commands="^(alt|bootstrap|clean|clone|config|decrypt|encrypt|help|init|list|perms|version)$"
+  internal_commands="^(alt|bootstrap|clean|clone|config|decrypt|encrypt|enter|help|init|list|perms|version)$"
   if [ -z "$*" ] ; then
     #; no argumnts will result in help()
     help
@@ -432,6 +432,13 @@ function encrypt() {
 
 }
 
+function enter() {
+    require_repo
+    echo "Entering repo"
+    $SHELL
+    echo "Leaving repo"
+}
+
 function git_command() {
 
   require_repo

yadm.1

@@ -41,6 +41,8 @@ list
 
 .BR yadm " encrypt
 
+.BR yadm " enter
+
 .BR yadm " decrypt
 .RB [ -l ]
 
@@ -176,6 +178,21 @@ Encrypt all files matching the patterns found in
 .IR $HOME/.yadm/encrypt .
 See the ENCRYPTION section for more details.
 .TP
+.B enter
+Run a subshell with all git variables set. This can be used to easily
+interact with your git repository. This is also useful if you are using
+Emacs Tramp and magit to manage your directory. You can add this
+configuration in your emacs configuration:
+
+.RS
+    (add-to-list 'tramp-methods
+  	     '("yadm"
+  	       (tramp-login-program "yadm")
+  	       (tramp-login-args (("enter")))
+  	       (tramp-remote-shell "/bin/sh")
+  	       (tramp-remote-shell-args ("-c"))))
+.RE
+.TP
 .B gitconfig
 Pass options to the
 .B git config