From a6465e4073010e326b9cc09c950738ea61260944 Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch>
Date: Mon, 20 Mar 2023 15:37:59 +0100
Subject: [PATCH] update docs

---
 docs/10_Features.md                       |  4 +++-
 docs/15_Requirements.md                   | 14 ++++++++++++++
 docs/20_Installation.md                   |  2 +-
 docs/30_Configuration/50_File_dirs.job.md | 15 +++++++++++++++
 4 files changed, 33 insertions(+), 2 deletions(-)
 create mode 100644 docs/15_Requirements.md

diff --git a/docs/10_Features.md b/docs/10_Features.md
index 1927ee4..7aa95b1 100644
--- a/docs/10_Features.md
+++ b/docs/10_Features.md
@@ -144,12 +144,14 @@ See [Hooks](50_Hooks/_index.md)
 
 ## Restic ##
 
-* creates one initial full backup - and then never again.
+* creates one initial full backup - and then never again. Then it makes incremental backups.
 * encrypts data
 * deduplicates files
 * delete backups by rules to keep a count of hourly, daily, weekly, mothly, yearly backups
 * several backup targets (currently supported protocols: sftp:// https:// and file://)
 * Single binary (written in Go)
+* MS Windows: Backup uses volume shadow copy service (vss)
+* Linux: with Fuse you can browse you can mount the backup repository and browse through all snapshots
 
 ## Duplicity ##
 
diff --git a/docs/15_Requirements.md b/docs/15_Requirements.md
new file mode 100644
index 0000000..69ed339
--- /dev/null
+++ b/docs/15_Requirements.md
@@ -0,0 +1,14 @@
+# What you need to run:
+
+* GNU core utilities
+  * Linux: On a basic linux installation it will run "out of the box"
+  * MS Windows: You need a set of GNU tools.
+    * Cygwin: https://cygwin.com/
+    * MINGW: https://www.mingw-w64.org/
+* Bash
+  * MS Windows: You can add let open .sh files with bash
+* Restic
+  * see the Docs https://restic.readthedocs.io/en/latest/020_installation.html
+  * Get the binary from your package manager or https://github.com/restic/restic/releases
+  * if you don't have the binary in a directory of $PATH you can add it in the environment of the backup. See Configuration -> File env.
+  
\ No newline at end of file
diff --git a/docs/20_Installation.md b/docs/20_Installation.md
index a4a287e..3e624c5 100644
--- a/docs/20_Installation.md
+++ b/docs/20_Installation.md
@@ -9,7 +9,7 @@
 
 ## Installation with git clone
 
-The most easy way is to use git pull.
+The most easy way to install it and keep it up to date is to use `git clone|pull`.
 If you don't have / want to use git see the next chapter "Manual installation: uncompress archive".
 
 As user **root**:
diff --git a/docs/30_Configuration/50_File_dirs.job.md b/docs/30_Configuration/50_File_dirs.job.md
index a31ac04..6c7fcf7 100644
--- a/docs/30_Configuration/50_File_dirs.job.md
+++ b/docs/30_Configuration/50_File_dirs.job.md
@@ -78,6 +78,21 @@ because of a wrong exclude pattern.
 
 `exclude = /tmp/.*`
 
+# Hints for MS Windows #
+
+To define folders to backup you should not use the bash unix like notation with forward slash eg. `/c/your/path`.
+There seems to be a bug in restic to show snapshots on MS Windows written with /.
+https://github.com/restic/restic/issues/2397
+
+Use the backslash - and quote it, eg:
+
+```txt
+include = c:\\backup
+include = c:\\inetpub
+include = c:\\scripts
+include = c:\\Users
+```
+
 ## TODO: custom single dirs with includes and exludes ##
 
 TODO.
-- 
GitLab