From 7c778511f296c74f36c2b4967707c87ebf2fb808 Mon Sep 17 00:00:00 2001
From: Enrico Maria De Angelis <enricomaria.dean6elis@gmail.com>
Date: Sat, 30 Mar 2024 09:12:15 +0000
Subject: Add ctor for Locks plugin to accpet on/off labels

---
 doc/plugins.org | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'doc')

diff --git a/doc/plugins.org b/doc/plugins.org
index e408dec..ebe5a5b 100644
--- a/doc/plugins.org
+++ b/doc/plugins.org
@@ -698,18 +698,37 @@
       #+begin_src haskell
         Run Brightness ["-t", "<bar>"] 60
       #+end_src
+
 *** =Locks=
 
     - Displays the status of Caps Lock, Num Lock and Scroll Lock.
 
     - Aliases to =locks=
 
+    - Contructors:
+
+        - =Locks= is nullary and uses the strings =CAPS=, =NUM=, =SCROLL= to signal
+          that a lock is enabled (and empty strings to signal it's disabled)
+
+        - =Locks'= allow customizing the strings for the enabled/disabled states
+          of the 3 locks by accepting an assoc list of type =[(String, (String, String))]=,
+          which is expected to contain exactly 3 elements with keys
+          ="CAPS"=, ="NUM"=, ="SCROLL"=.
+
     - Example:
 
       #+begin_src haskell
+        -- using default labels
         Run Locks
       #+end_src
 
+      #+begin_src haskell
+        -- using custom labels
+        Run $ Locks' [("CAPS"  , ("<fc=#00ff00>\xf023</fc>", "<fc=#777777>\xf09c</fc>") )
+                     ,("NUM"   , ("<fc=#777777>\xf047</fc>", "<fc=#00ff00>\xf047</fc>" ) )
+                     ,("SCROLL", ("SlOCK", "" ))]
+      #+end_src
+
 ** Load and Process monitors
 *** =Load Args RefreshRate=
 
-- 
cgit v1.2.3