man-pages/man5/kanshi.5.html
2021-03-31 01:06:50 +01:00

168 lines
3.6 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of kanshi</TITLE>
</HEAD><BODY>
<H1>kanshi</H1>
Section: File Formats (5)<BR>Updated: 2019-08-30<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<P>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
<P>
kanshi - configuration file
<P>
<A NAME="lbAC">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
A kanshi configuration file is a list of profiles. Each profile is delimited by
brackets (<B>{</B> and <B>}</B>) and contains directives.
<P>
Example:
<P>
<PRE>
<DL COMPACT><DT id="1"><DD>{
output LVDS-1 disable
output &quot;Some Company ASDF 4242&quot; mode 1600x900 position 0,0
}
{
output LVDS-1 enable scale 2
}
</PRE>
</DL>
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DIRECTIVES</H2>
<P>
Directives are followed by space-separated arguments. Arguments can be quoted
(with <B>&quot;</B>) if they contain spaces.
<P>
<B>output</B> &lt;criteria&gt; &lt;output-command...&gt;
<DL COMPACT><DT id="2"><DD>
An output directive adds an output to the profile. The criteria can either
be an output name, an output description or &quot;*&quot;. The latter can be used to
match any output.
<P>
On <B><A HREF="/cgi-bin/man/man2html?1+sway">sway</A></B>(1), output names and descriptions can be obtained via
<B>swaymsg -t get_outputs</B>.
<P>
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>OUTPUT DIRECTIVES</H2>
<P>
<B>enable</B>|<B>disable</B>
<DL COMPACT><DT id="3"><DD>
Enables or disables the specified output.
<P>
</DL>
<B>mode</B> &lt;width&gt;x&lt;height&gt;[@&lt;rate&gt;[Hz]]
<DL COMPACT><DT id="4"><DD>
Configures the specified output to use the specified mode. Modes are a
combination of width and height (in pixels) and a refresh rate (in Hz) that
your display can be configured to use.
<P>
Examples:
<P>
<DL COMPACT><DT id="5"><DD>
output HDMI-A-1 mode 1920x1080
output HDMI-A-1 mode <A HREF="mailto:1920x1080@60Hz">1920x1080@60Hz</A>
<P>
</DL>
</DL>
<B>position</B> &lt;x&gt;,&lt;y&gt;
<DL COMPACT><DT id="6"><DD>
Places the output at the specified position in the global coordinates space.
<P>
Example:
<P>
<DL COMPACT><DT id="7"><DD>
output HDMI-A-1 position 1600,0
<P>
</DL>
</DL>
<B>scale</B> &lt;factor&gt;
<DL COMPACT><DT id="8"><DD>
Scales the output by the specified scale factor.
<P>
</DL>
<B>transform</B> &lt;transform&gt;
<DL COMPACT><DT id="9"><DD>
Sets the output transform. Can be one of &quot;90&quot;, &quot;180&quot;, &quot;270&quot; for a rotation;
or &quot;flipped&quot;, &quot;flipped-90&quot;, &quot;flipped-180&quot;, &quot;flipped-270&quot; for a rotation and
a flip; or &quot;normal&quot; for no transform.
<P>
<P>
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>AUTHORS</H2>
<P>
Maintained by Simon Ser &lt;<A HREF="mailto:contact@emersion.fr">contact@emersion.fr</A>&gt;, who is assisted by other
open-source contributors. For more information about kanshi development, see
<A HREF="https://github.com/emersion/kanshi.">https://github.com/emersion/kanshi.</A>
<P>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+kanshi">kanshi</A></B>(1)
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="10"><A HREF="#lbAB">NAME</A><DD>
<DT id="11"><A HREF="#lbAC">DESCRIPTION</A><DD>
<DT id="12"><A HREF="#lbAD">DIRECTIVES</A><DD>
<DT id="13"><A HREF="#lbAE">OUTPUT DIRECTIVES</A><DD>
<DT id="14"><A HREF="#lbAF">AUTHORS</A><DD>
<DT id="15"><A HREF="#lbAG">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:03 GMT, March 31, 2021
</BODY>
</HTML>