From 727478f5b8916d8d98ae4208d4f6a80abb4fafc7 Mon Sep 17 00:00:00 2001
From: jao <jao@gnu.org>
Date: Thu, 14 Apr 2022 16:41:36 +0100
Subject: Memory: new argument to scale usage units

Fixes #624
---
 doc/plugins.org | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'doc')

diff --git a/doc/plugins.org b/doc/plugins.org
index 8ff75e4..383207c 100644
--- a/doc/plugins.org
+++ b/doc/plugins.org
@@ -510,6 +510,10 @@
           =freeipat=.
         - =--available-icon-pattern=: dynamic string for available memory
           ratio in =availableipat=.
+        - =--scale=: sizes (total, free, etc.) are reported in units of
+          ~Mb/scale~, with scale defaulting to 1.0.  So, for
+          instance, to get sizes reported in Gb, set this parameter
+          to 1024.
 
       - Thresholds refer to percentage of used memory
       - Variables that can be used with the =-t/--template= argument:
@@ -517,8 +521,18 @@
         =usedbar=, =usedvbar=, =usedipat=, =freeratio=, =freebar=, =freevbar=,
         =freeipat=, =availableratio=, =availablebar=, =availablevbar=,
         =availableipat=
+
       - Default template: =Mem: <usedratio>% (<cache>M)=
 
+      - Examples:
+
+        #+begin_src haskell
+          -- A monitor reporting memory used in Gb
+          Memory [ "-t", "<used> Gb", "--", "--scale", "1024"] 20
+          -- As above, but using one decimal digit to print numbers
+          Memory [ "-t", "<used> Gb", "-d", "1", "--", "--scale", "1024"] 20
+        #+end_src
+
 ***** =Swap Args RefreshRate=
 
       - Aliases to =swap=
-- 
cgit v1.2.3