aboutsummaryrefslogtreecommitdiffstats
path: root/cg-darkroom.1
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-10-07 16:39:46 +0200
committerMattias Andrée <maandree@kth.se>2019-10-07 16:39:46 +0200
commit5eb6165d6806f5656802a6f58feea9469dad6141 (patch)
tree46fc5bc7fa308d73ed722059163098dca7c96c22 /cg-darkroom.1
parentAdd cg-shallow, minor fixes, and bump year (diff)
downloadcg-tools-5eb6165d6806f5656802a6f58feea9469dad6141.tar.gz
cg-tools-5eb6165d6806f5656802a6f58feea9469dad6141.tar.bz2
cg-tools-5eb6165d6806f5656802a6f58feea9469dad6141.tar.xz
Reorganise, change license, portable makefile, and reference radharc
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'cg-darkroom.1')
-rw-r--r--cg-darkroom.1108
1 files changed, 108 insertions, 0 deletions
diff --git a/cg-darkroom.1 b/cg-darkroom.1
new file mode 100644
index 0000000..ad812ff
--- /dev/null
+++ b/cg-darkroom.1
@@ -0,0 +1,108 @@
+.TH CG-DARKROOM 1 CG-TOOLS
+.SH NAME
+cg-darkroom - Invert colour on the monitors and make them dark red
+.SH SYNOPSIS
+.B cg-darkroom
+.RB [ \-M
+.IR method ]
+.RB [ \-S
+.IR site ]
+.RB [ \-c
+.IR crtc "]... ["\fB\-R\fP
+.IR rule ]
+.RB ( \-x
+|
+.RB [ \-p
+.IR priority ]
+.RB [ \-d ]
+.RI [ brightness ])
+.SH DESCRIPTION
+.B cg-darkroom
+inverts the colours on the monitors, dim them, and turns of
+the green and blue channels. The monitors are dimmed to the
+brilliance of
+.IR brightness ,
+or 0.25 if not specified. A value of 0 means complete darkness,
+and 1 means normal brilliance.
+.SH OPTIONS
+.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.
+
+If
+.I crtc
+is
+.RB ' ? ',
+all available CRTC's are listed.
+.TP
+.B \-d
+Keep the process alive and remove the filter on death.
+.TP
+.BR \-M " "\fImethod\fP
+Adjustment method name or number. Recognised names include:
+.TS
+tab(:);
+l l.
+\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
+.TE
+
+The adjustment methods are supported via
+.BR libgamma (7).
+Only methods that were enabled when
+.B libgamma
+was compiled will be supported.
+
+If
+.I method
+is
+.RB ' ? ',
+all available adjustment methods are printed.
+.TP
+.BR \-p " "\fIpriority\fP
+Set the priority of the filter. Filters with higher priority
+are applied before filters with lower priority. The value
+must be a signed 64-bit integer (between \-9223372036854775807
+and 9223372036854775807).
+.BR cg-darkroom 's
+default priority is 6917529027641081856.
+
+If
+.I priority
+is
+.RB ' ? ',
+the utility's default priority is printed.
+.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 .
+
+If
+.I rule
+is
+.RB ' ? '
+the utility's default rule is printed. If
+.I rule
+is
+.RB ' ?? '
+the utility's default class is printed.
+.TP
+.BR \-S " "\fIsite\fP
+Select the site to which to connect. For example
+.RB ' :0 ',
+for local display 0 when using
+.BR X .
+.TP
+.B \-x
+Remove the currently applied filter.
+.SH SEE ALSO
+.BR cg-tools (7)