diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/cg-rainbow.1 | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/man/cg-rainbow.1 b/man/cg-rainbow.1 new file mode 100644 index 0000000..9b1b91a --- /dev/null +++ b/man/cg-rainbow.1 @@ -0,0 +1,86 @@ +.TH CG-RAINBOW 1 CG-TOOLS +.SH NAME +cg-rainbow - Adds a rainbow cycle effect to the monitors +.SH SYNOPSIS +.B cg-rainbow +.RB [ \-M +.IR method ] +.RB [ \-S +.IR site ] +.RB [ \-c +.IR crtc "]... ["\fB\-R\fP +.IR rule ] +.RB [ \-p +.IR priority ] +.RB [ \-l +.IR luminosity ] +.RB [ \-s +.IR rainbowhz ] +.SH DESCRIPTION +.B cg-rainbow +cycles between a the rainbow's colors and use the colours +as the monitors' black colour. +.P +.B cg-rainbow +is a rewrite of +.BR xrainbow (1) +and +.BR grainbow (1). +.SH OPTIONS +.TP +.BR \-l " "\fIluminosity\fP +Select the luminosity of the rainbow. A value of 0 means +the rainbow is completely black, and a value of 1 means the +the rainbow is fully saturated, but not oversaturated. The +default luminosity is one third. +.TP +.BR \-s " "\fIrainbowhz\fP +Select the number of of rainbow-cycles per second. The +default frequency is one third. +.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-rainbow 's +default priority is 1152921504606846976. +.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 |