X-Git-Url: https://ruderich.org/simon/gitweb/?p=safcm%2Fsafcm.git;a=blobdiff_plain;f=README.adoc;h=d65e2b0f181fcd3493c03fcc988fc5ef247afae2;hp=2512596957b7ba0b6efb1c191ac84ed0c913a005;hb=5dca1e53d7fa0c2b7c15bbcec5654638727f9009;hpb=91283c7517bd49d9c7cb4114454cdd7644a442a0

diff --git a/README.adoc b/README.adoc
index 2512596..d65e2b0 100644
--- a/README.adoc
+++ b/README.adoc
@@ -102,6 +102,21 @@ future, others are due to the design of safcm.
   `/root` which often have strict permissions by default, so carefully check
   the diff output for unwanted changes.
 
+- Full file content of all files is sent to the remote during synchronization.
+  This makes it impractical to synchronize large files with safcm. As most
+  configuration files are small this shouldn't be an issue for common
+  scenarios.
+
+- Quoted strings in the output are quoted using Go's `%q` format string. The
+  result is similar -- but not identical -- to quoted strings in regular shell
+  scripts which can be confusing.
+
+- Permissions of symlinks are ignored on BSD systems. They are always shown to
+  have `0777` as permissions even though the current umask controls the actual
+  permissions when creating new symlinks. Existing symlinks with different
+  permissions are not updated. Most BSDs ignore the permissions when following
+  symlinks which should reduce the impact of this limitation.
+
 
 == Requirements
 
@@ -116,8 +131,11 @@ future, others are due to the design of safcm.
 
 - *remote hosts*:
   * Go support for architecture and operating system
-  * GNU/Linux with common commands (`stat`, `sha512sum`, `cat`, `rm`, `ln`,
-    `chmod`)
+  * Supported operating system:
+    ** GNU/Linux with common commands (`uname`, `id`, `stat`, `sha512sum`,
+       `cat`, `mktemp`, `rm`, `ln`, `chmod`)
+    ** FreeBSD (same commands, but uses `sha512`)
+    ** OpenBSD (same commands, but uses `sha512`)
   * SSH server
   * to install packages:
     ** `apt-get` (Debian or derivative)