From c5d697841fdbd314a2bcbba789234d8a40e195cc Mon Sep 17 00:00:00 2001
From: Niko Ehrenfeuchter <nikolaus.ehrenfeuchter@unibas.ch>
Date: Thu, 15 Mar 2018 16:26:38 +0100
Subject: [PATCH] Explain manual invokation of updater

---
 Updater/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/Updater/README.md b/Updater/README.md
index ef13090..e56c398 100644
--- a/Updater/README.md
+++ b/Updater/README.md
@@ -64,6 +64,24 @@ service installation directory and the `$UpdateSourcePath` location (the latter
 one only requires write-permissions for the `Logs` folder for uploading the log
 files).
 
+Manual Invokation
+-----------------
+
+To launch the updater manually, e.g. to run it in verbose mode for seeing what
+is going on, use the following command:
+
+```powershell
+.\Update-Service.ps1 -UpdaterSettings .\UpdaterConfig.inc.ps1 -Verbose
+```
+
+For enforcing a cleanup-update, use the `-ForceServiceCleanup` flag. The updater
+will then try to stop the service no matter whether it is busy and will remove
+an existing status file (so the service starts with a *clean* status):
+
+```powershell
+.\Update-Service.ps1 -UpdaterSettings .\UpdaterConfig.inc.ps1 -ForceServiceCleanup -Verbose
+```
+
 Automatic Updates
 -----------------
 
-- 
GitLab