From 1c222c0991ab816f0c8dca32407801ce2525e885 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Sun, 25 Feb 2024 11:19:34 +0100
Subject: Add coreupdownd: and configurations and daemonisation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 coreupdownd.1 | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 80 insertions(+), 3 deletions(-)

(limited to 'coreupdownd.1')

diff --git a/coreupdownd.1 b/coreupdownd.1
index 9dde00b..23d7487 100644
--- a/coreupdownd.1
+++ b/coreupdownd.1
@@ -1,8 +1,17 @@
 .TH COREUPDOWND 1 COREUPDOWN
 .SH MAME
-coreupdownd - Dynamically enable and disable CPU' to only use one during low CPU usage
+coreupdownd - Dynamically enable and disable CPU's to only use one during low CPU usage
 .SH SYNPOSIS
 coreupdownd
+.RI "[-C " coreup-cooldown-time ]
+.RI "[-c " coredown-cooldown-time ]
+.RI "[-i " check-interval ]
+.RI "[-s " configuration-file ]
+.RI "[-T " coreup-cpu-usage-time-consistency-threshold ]
+.RI "[-t " coredown-cpu-usage-time-consistency-threshold ]
+.RI "[-U " coreup-cpu-usage-threshold ]
+.RI "[-u " coredown-cpu-usage-threshold ]
+[-ef]
 .SH DESCRIPTION
 The
 .B coreupdownd
@@ -19,7 +28,67 @@ that have input performance issues (keyboard input lag
 and keys getting stuck) when more than one CPU core is
 online.
 .SH OPTIONS
-No options are supported.
+The
+.B coreupdownd
+daemon shall conform to the Base Definitions volume of
+POSIX.1-2017, Section 12.2, Utility  Syntax Guidelines.
+.PP
+The following options are supported:
+.TP
+.BI "-C " coreup-cooldown-time
+The amount of time, measured in (integer) multiples of the
+.IR check-interval ,
+before the daemon may disable CPU's after enabling CPU's.
+During this time, time is not counted toward
+.IR coredown-cpu-usage-threshold .
+.TP
+.BI "-c " coredown-cooldown-time
+The amount of time, measured in (integer) multiples of the
+.IR check-interval ,
+before the daemon may enable CPU's after disabling CPU's.
+During this time, time is not counted toward
+.IR coreup-cpu-usage-threshold .
+.TP
+.B -e
+Do not close standard error at end of initialisation.
+.TP
+.B -f
+Do not daemonise. (The standard input and standard
+output will still be closed when the process has
+completed it's initialisation.)
+
+Implies
+.BR -e .
+.TP
+.BI "-i " check-interval
+The interval, in seconds (need not be integer), with
+which the daemon periodically checks the CPU usage.
+.TP
+.BI "-s " configuration-file
+Configuration file to read instead of
+.BR /etc/coreupdownd.conf .
+.TP
+.BI "-T " coreup-cpu-usage-time-consistency-threshold
+The amount of time, measure in (integer) multiples of the
+.I check-interval
+the CPU usage must have stayed at or above
+.I coreup-cpu-usage-threshold
+before the daemon may enable all CPU's.
+.TP
+.BI "-t " coredown-cpu-usage-time-consistency-threshold
+The amount of time, measured in (integer) multiples of the
+.IR check-interval ,
+the CPU usage must have stayed at or below
+.I coredown-cpu-usage-threshold
+before the daemon may disable all CPU's except the main core .
+.TP
+.BI "-U " coreup-cpu-usage-threshold
+The required CPU usage (integer lower bound) before the
+daemon may enable all CPU's.
+.TP
+.BI "-u " coredown-cpu-usage-threshold
+The required CPU usage (integer upper bound) before the
+daemon may disable all CPU's except the main core.
 .SH OPERANDS
 No operands are supported.
 .SH STDIN
@@ -34,7 +103,14 @@ None.
 No environment variables affects the execution of
 .BR coreupdownd .
 .SH ASYNCHRONOUS EVENTS
-Default.
+If the
+.B coreupdownd
+utility traps the following signals:
+.TP
+.B SIGHUP
+Causes the daemon reload it's configurations, and
+attempt to update to the newest installed version
+of the daemon.
 .SH STDOUT
 The
 .B coreupdownd
@@ -70,5 +146,6 @@ None.
 .SH FUTURE DIRECTIONS
 None.
 .SH SEE ALSO
+.BR coreupdownd.conf (5),
 .BR coreup (1),
 .BR coredown (1)
-- 
cgit v1.2.3-70-g09d2