From 30d02851adbc5eea66c0009499620965725dd109 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Thu, 1 Dec 2016 10:52:31 +0100
Subject: Add cg-sleepmode.1
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 man/cg-sleepmode.1 | 105 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 105 insertions(+)
 create mode 100644 man/cg-sleepmode.1

(limited to 'man')

diff --git a/man/cg-sleepmode.1 b/man/cg-sleepmode.1
new file mode 100644
index 0000000..aa358b4
--- /dev/null
+++ b/man/cg-sleepmode.1
@@ -0,0 +1,105 @@
+.TH CG-SLEEPMODE 1 CG-TOOLS
+.SH NAME
+cg-sleepmode - Gradually fade out the monitors, and gradually fade in on exit
+.SH SYNOPSIS
+.B cg-sleepmode
+.RB [ \-M
+.IR method ]
+.RB [ \-S
+.IR site ]
+.RB [ \-c
+.IR crtc "]... ["\fB\-R\fP
+.IR rule ]
+.RB [ \-p
+.IR priority ]
+.RB [ \-r
+.IR red-fadeout-time ]
+.RB [ \-g
+.IR green-fadeout-time ]
+.RB [ \-b
+.IR blue-fadeout-time ]
+.RI [ red-luminosity
+.RI [ green-luminosity
+.RI [ blue-luminosity ]]]
+.SH DESCRIPTION
+.B cg-sleepmode
+gradually fade out the red, green, and blue channels on the
+monitors to the brilliances of
+.IR red-luminosity ,
+.IR green-luminosity ,
+and
+.IR blue-luminosity ,
+respectively, whose default values are 0.25, 0, and 0,
+respectively. A value of 0 means complete darkness, a
+value of 1 means normal brilliance.
+.P
+.B cg-sleepmode
+does not exist after the channels have been faded out,
+instead, it's waits until it's killed, and then fades the
+channel's back in to normal brilliance.
+.SH OPTIONS
+.TP
+.BR \-r " "\fIred-fadeout-time\fP
+Set the fade-out time for the red channel to
+\fIred-fadeout-time\fP seconds. The fade-in time is based
+on this value. The default fadeout time for the red channel
+is 3 seconds.
+.TP
+.BR \-g " "\fIgreen-fadeout-time\fP
+Set the fade-out time for the green channel to
+\fIgreen-fadeout-time\fP seconds. The fade-in time is based
+on this value. The default fadeout time for the green channel
+is 2 seconds.
+.TP
+.BR \-b " "\fIblue-fadeout-time\fP
+Set the fade-out time for the blue channel to
+\fIblue-fadeout-time\fP seconds. The fade-in time is based
+on this value. The default fadeout time for the blue channel
+is 1 second.
+.TP
+.BR \-c " "\fIcrtc\fP
+Apply the filter to the CRTC with the monitor whose EDID is
+.IR crtc .
+By default, the filter is applied to all monitors.
+.TP
+.BR \-M " "\fImethod\fP
+Adjustment method name or number. Recognised names include:
+
+.nf
+\fBdummy\fP      Dummy method
+\fBrandr\fP      X RAndR
+\fBvidmode\fP    X VidMode
+\fBdrm\fP        Linux DRM
+\fBgdi\fP        Windows GDI
+\fBquartz\fP     Quartz Core Graphics
+.fi
+
+The adjustment methods are supported via
+.BR libgamma (7).
+Only methods that were enabled when
+.B libgamma
+was compiled will be supported.
+.TP
+.BR \-p " "\fIpriority\fP
+Set the priority of the filter. Filters with lower priority
+are applied before filters with higher priority. The value
+must be a signed 64-bit integer (between -9223372036854775807
+and 9223372036854775808).
+.BR cg-sleepmode 's
+default priority is 1729382256910270464.
+.TP
+.BR \-R " "\fIrule\fP
+Set the rule of of the filter to
+.IR rule .
+This is the last part of the filter's identifier (class).
+The default rule is
+.BR standard .
+.TP
+.BR \-S " "\fIsite\fP
+Select the site to which to connect. For example
+.RB ' :0 ',
+for local display 0 when using
+.BR X .
+.SH BUGS
+Please report bugs to https://github.com/maandree/cg-tools/issues
+or to maandree@kth.se
-- 
cgit v1.2.3-70-g09d2