.\" 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 "greetd" "1" "2024-04-22"
.PP
.SH NAME
.PP
greetd - A login manager daemon
.PP
.SH SYNOPSIS
.PP
\fBgreetd\fR [options]
.PP
.SH OPTIONS
.PP
\fB-h, --help\fR
.RS 4
Show help message and quit.\&
.PP
.RE
\fB-c, --config <config>\fR
.RS 4
Specifies the configuration file to use.\&
.PP
.RE
\fB--vt <vt>\fR
.RS 4
The VT to use, overwriting the value from the configuration file.\& This
can be useful when starting an instance per VT if greetd cannot deduce
the intended VT from an associated controlling terminal.\&
.PP
.RE
.SH DESCRIPTION
.PP
greetd was created to fill the need for a simple login manager that makes no
assumptions about the applications it starts, thus being equally suitable for
starting console sessions, Wayland sessions, or something else entirely.\&
.PP
greetd does not itself interact with the user, but relies on an external
greeter process like agreety(1) to handle that aspect.\&
.PP
.SH OPERATION
.PP
greetd operates on \fBsessions\fR.\& A greeter creates a session, attempts to
authenticate a user in it, and finally, uses it start an arbitrary
application.\&
.PP
There are two types of preconfigured sessions: The default session, also known
as the \fBgreeter\fR, and the optional initial session, serving the purpose of
"auto-login".\& The initial session, if configured, is started once when greetd
launches.\& The default session is started on launch if an initial session is
not configured, and started again whenever no session is running, such as when
the user logs out.\&
.PP
An IPC socket is exposed to this greeter, as reported by \fBGREETD_SOCK\fR.\& The
greeter can use this to create, authenticate and finally start a session.\& For
more information about the IPC layer, see greetd-ipc(7).\&
.PP
Once the greeter has requested the start of a session and terminated itself,
greetd will start the new session.\& Once this session terminates, the process
starts over.\&
.PP
greetd makes no assumptions about any sessions, including the greeter.\& They
can be text-based, running in the active console, or full-on graphical
environments.\&
.PP
.SH CONFIGURATION
.PP
greetd looks for a configuration file in /etc/greetd/config.\&toml by default.\&
This can be overriden with a command-line argument.\&
.PP
For information on the config file format, see greetd(5).\&
.PP
.SH AUTHORS
.PP
Maintained by Kenny Levinsen <contact@kl.\&wtf>.\& For more information about
greetd development, see https://git.\&sr.\&ht/~kennylevinsen/greetd.\&
.PP
.SH SEE ALSO
\fBgreetd\fR(5) \fBgreetd-ipc\fR(7)