From 6d357a9ffb072f55454012f4a35feca5727db825 Mon Sep 17 00:00:00 2001
From: Jonas Smedegaard <dr@jones.dk>
Date: Wed, 24 Feb 2021 22:10:01 +0100
Subject: make a bit of sense of it all (still work in progress...)

---
 USE.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 USE.md

(limited to 'USE.md')

diff --git a/USE.md b/USE.md
new file mode 100644
index 0000000..6898c42
--- /dev/null
+++ b/USE.md
@@ -0,0 +1,41 @@
+# Using shell account profile
+
+
+## Status
+
+    vcsh status
+
+This shows you the profiles known to vcsh,
+and their state -
+e.g. if some settings files contain local changes not tracked.
+
+
+## Update a tracked settings file
+
+    vcsh $PROFILE commit $PATH_TO_FILE
+
+As an example,
+you have changed the configuration of your email client,
+and want to update your profile tracking -
+e.g. to distribute that change to your other shell environments.
+
+    vcsh mail commit ~/.thunderbird/profiles.ini
+
+The command is a wrapper for `git commit ...`
+and can take ordinary git options, e.g. `-m "some commit message..."`.
+
+Later when you use another shell environment
+(or when others in your organisation has done the above)
+you can apply those changes here like this:
+
+    vcsh pull
+
+In case of collision,
+vcsh will warn and you can work it out with git commands,
+where `git` is replaced by `vcsh $PROJECT`.
+
+
+## More information
+
+    vcsh help
+    man vcsh
-- 
cgit v1.2.3