.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "kanshi" "5" "2024-03-09"
.PP
.SH NAME
.PP
kanshi - configuration file
.PP
.SH DESCRIPTION
.PP
A kanshi configuration file is a list of profiles.\& Each profile has an optional
name and contains profile directives delimited by brackets (\fB{\fR and \fB}\fR).\&
.PP
Example:
.PP
.nf
.RS 4
include /etc/kanshi/config\&.d/*

profile {
	output LVDS-1 disable
	output "Some Company ASDF 4242" {
		mode 1600x900
		position 0,0
	}
}

profile nomad {
	output LVDS-1 enable scale 2
}
.fi
.RE
.PP
.SH DIRECTIVES
.PP
\fBprofile\fR [<name>] { <profile directives.\&.\&.\&> }
.RS 4
Defines a new profile using the specified bracket-delimited profile
directives.\& A name can be specified but is optional.\&
.PP
.RE
\fBinclude\fR <path>
.RS 4
Include as another file from \fIpath\fR.\& Expands shell syntax (see \fBwordexp\fR(3)
for details).\&
.PP
.RE
.SH PROFILE DIRECTIVES
.PP
Profile directives are followed by space-separated arguments.\& Arguments can be
quoted (with \fB"\fR) if they contain spaces.\&
.PP
\fBoutput\fR <criteria> <output-directive.\&.\&.\&>
.RS 4
An output directive adds an output to the profile.\& The criteria can either
be an output name, an output description or "*".\& The latter can be used to
match any output.\&
.PP
Output directives may be specified in a bracket-delimited block as well.\&
.PP
On \fBsway\fR(1), output names and descriptions can be obtained via
\fBswaymsg -t get_outputs\fR.\&
.PP
.RE
\fBexec\fR <command>
.RS 4
An exec directive executes a command when the profile was successfully
applied.\& This can be used to update the compositor state to the profile
when not done automatically.\&
.PP
Commands are executed asynchronously and their order may not be preserved.\&
If you need to execute sequential commands, you should collect in one exec
statement or in a separate script.\&
.PP
On \fBsway\fR(1) for example, \fBexec\fR can be used to move workspaces to the
right output:
.PP
.nf
.RS 4
profile multihead {
	output eDP-1 enable
	output DP-1 enable transform 270
	exec swaymsg workspace 1, move workspace to eDP-1
}
.fi
.RE
.PP
Note that some extra care must be taken with outputs identified by an
output description as the real name may change:
.PP
.nf
.RS 4
profile complex {
	output "Some Other Company GTBZ 2525" mode 1920x1200
	exec swaymsg workspace 1, move workspace to output \&'"Some Other Company GTBZ 2525"\&'
}
.fi
.RE
.PP
.RE
.SH OUTPUT DIRECTIVES
.PP
\fBenable\fR|\fBdisable\fR
.RS 4
Enables or disables the specified output.\&
.PP
.RE
\fBmode\fR [--custom] <width>x<height>[@<rate>[Hz]]
.RS 4
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.\&
.PP
Examples:
.PP
.nf
.RS 4
output HDMI-A-1 mode 1920x1080
output HDMI-A-1 mode 1920x1080@60Hz
output HDMI-A-1 mode --custom 1280x720@60Hz
.fi
.RE
.PP
.RE
\fBposition\fR <x>,<y>
.RS 4
Places the output at the specified position in the global coordinates space.\&
.PP
Example:
.PP
.nf
.RS 4
output HDMI-A-1 position 1600,0
.fi
.RE
.PP
.RE
\fBscale\fR <factor>
.RS 4
Scales the output by the specified scale factor.\&
.PP
.RE
\fBtransform\fR <transform>
.RS 4
Sets the output transform.\& Can be one of "90", "180", "270" for a rotation;
or "flipped", "flipped-90", "flipped-180", "flipped-270" for a rotation and
a flip; or "normal" for no transform.\&
.PP
.RE
\fBadaptive_sync\fR on|off
.RS 4
Enables or disables adaptive synchronization (aka.\& Variable Refresh Rate).\&
.PP
.RE
.SH AUTHORS
.PP
Maintained by Simon Ser <contact@emersion.\&fr>, who is assisted by other
open-source contributors.\& For more information about kanshi development, see
<https://git.\&sr.\&ht/~emersion/kanshi>.\&
.PP
.SH SEE ALSO
.PP
\fBkanshi\fR(1)