From f52ef901cb6459a5fe7446fe6e69eab82cb373eb Mon Sep 17 00:00:00 2001
From: Martin Fischer <martin@push-f.com>
Date: Thu, 27 Feb 2025 20:42:04 +0100
Subject: docs: add one-line descriptions to workstation scripts

---
 nixos/profiles/workstation/scripts/deploy-dir | 1 +
 nixos/profiles/workstation/scripts/reset-bg   | 2 ++
 nixos/profiles/workstation/scripts/set-bg     | 2 ++
 3 files changed, 5 insertions(+)

diff --git a/nixos/profiles/workstation/scripts/deploy-dir b/nixos/profiles/workstation/scripts/deploy-dir
index bb7dfdf..f90a4ae 100755
--- a/nixos/profiles/workstation/scripts/deploy-dir
+++ b/nixos/profiles/workstation/scripts/deploy-dir
@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+# Replaces the contents of a remote directory with the contents of a local directory.
 
 if [ "$#" -ne 3 ]; then
     echo "usage: $0 <local_dir> <ssh_dest> <remote_dir>"
diff --git a/nixos/profiles/workstation/scripts/reset-bg b/nixos/profiles/workstation/scripts/reset-bg
index 5aa20f6..049954d 100644
--- a/nixos/profiles/workstation/scripts/reset-bg
+++ b/nixos/profiles/workstation/scripts/reset-bg
@@ -1,2 +1,4 @@
 #!/usr/bin/env bash
+# Resets the background color of the current foot terminal to the default.
+
 echo -en "\033]111\007"
diff --git a/nixos/profiles/workstation/scripts/set-bg b/nixos/profiles/workstation/scripts/set-bg
index e78afdc..2ed0a78 100644
--- a/nixos/profiles/workstation/scripts/set-bg
+++ b/nixos/profiles/workstation/scripts/set-bg
@@ -1,3 +1,5 @@
 #!/usr/bin/env bash
+# Sets the background color of the current foot terminal to the given hex color.
+
 rgb_with_slashes=$(echo "$1" | sed -r 's,(..)(..),\1/\2/,')
 echo -en "\033]11;rgb:$rgb_with_slashes\007"
-- 
cgit v1.2.3