# SDDM

From ArchWiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Related articles

- Display manager
- KDE

The Simple Desktop Display Manager (SDDM) a display manager. It is the recommended display manager for the KDE Plasma and LXQt desktop environments.

From Wikipedia:Simple Desktop Display Manager:

  Simple Desktop Display Manager (SDDM) is a display manager (a graphical login program and session manager) for the X11 and Wayland windowing systems. SDDM was written from scratch in C++11 and supports theming via QML.

Note: The Wayland windowing system is not yet fully supported: Wayland sessions are listed, but SDDM runs on X11. SDDM 0.20 will introduce full Wayland support.[1]

## Installation

Install the sddm package. Optionally install sddm-kcm for the KDE Config Module.

Follow Display manager#Loading the display manager to start SDDM at boot.

## Configuration

The default configuration file for SDDM can be found at `/usr/lib/sddm/sddm.conf.d/default.conf`. For any changes, create configuration file(s) in `/etc/sddm.conf.d/`. See sddm.conf(5) for all options.

The sddm-kcm package (included in the plasma group) provides a GUI to configure SDDM in Plasma's system settings. There is also a Qt-based sddm-config-editor-gitAUR available in the AUR.

Everything should work out of the box, since Arch Linux uses systemd and SDDM defaults to using `systemd-logind` for session management.

### Autologin

SDDM supports automatic login through its configuration file, for example:

    /etc/sddm.conf.d/autologin.conf

    [Autologin]
    User=john
    Session=plasma

This configuration causes a KDE Plasma session to be started for user `john` when the system is booted. Available session types can be found in `/usr/share/xsessions/` for X and in `/usr/share/wayland-sessions/` for Wayland.

An option to autologin into KDE Plasma while simultaneously locking the session is not available [2]

You can add a script that activates the screensaver of KDE to the autostart as a workaround:

    #!/bin/sh
    /usr/bin/dbus-send --session --type=method_call --dest=org.freedesktop.ScreenSaver /ScreenSaver org.freedesktop.ScreenSaver.Lock &

### Unlock KDE Wallet automatically on login

See KDE Wallet#Unlock KDE Wallet automatically on login.

### Theme settings

Theme settings can be changed in the `[Theme]` section. If you use Plasma's system settings, themes may show previews.

Set to `breeze` for the default Plasma theme.

Some themes are available in the AUR, for example archlinux-themes-sddmAUR.

#### Current theme

Set the current theme through the `Current` value, e.g. `Current=archlinux-simplyblack`.

#### Editing themes

The default SDDM theme directory is `/usr/share/sddm/themes/`. You can add your custom made themes to that directory under a separate subdirectory. Note that SDDM requires these subdirectory names to be the same as the theme names. Study the files installed to modify or create your own theme.

#### Customizing a theme

To override settings in the `theme.conf` configuration file, create a custom `theme.conf.user` file in the same directory. For example, to change the theme's background:

    /usr/share/sddm/themes/name/theme.conf.user

    [General]
    background=/path/to/background.png

#### Testing (previewing) a theme

You can preview an SDDM theme if needed. This is especially helpful if you are not sure how the theme would look if selected or just edited a theme and want to see how it would look without logging out. You can run something like this:

    $ sddm-greeter --test-mode --theme /usr/share/sddm/themes/breeze

This should open a new window for every monitor you have connected and show a preview of the theme.

Note: This is just a preview. In this mode, some actions like shutdown, suspend or login will have no effect.

#### Mouse cursor

To set the mouse cursor theme, set `CursorTheme` to your preferred cursor theme.

Valid Plasma mouse cursor theme names are `breeze_cursors`, `Breeze_Snow` and `breeze-dark`.

#### User icon (avatar)

This article or section is out of date.

Reason: SDDM detects icons in `/var/lib/AccountsService/icons/` without configuration and Plasma no longer creates the files in `$HOME/`. (Discuss in Talk:SDDM#)

SDDM reads the user icon (a.k.a. "avatar") as a PNG image from either `~/.face.icon` for each user, or the common location for all users specified by `FacesDir` in an SDDM configuration file. The configuration setting can be placed in either `/etc/sddm.conf` directly, or, better, a file under `/etc/sddm.conf.d/` such as `/etc/sddm.conf.d/avatar.conf`.

To use the `FacesDir` location option, place a PNG image for each user named `username.face.icon` at the location specified by the `FacesDir` key in the configuration file. The default location for `FacesDir` is `/usr/share/sddm/faces/`. You can change the default `FacesDir` location to suit your needs. Here is an example:

    /etc/sddm.conf.d/avatar.conf

    [Theme]
    FacesDir=/var/lib/AccountsService/icons/

The other option is to put a PNG image named `.face.icon` at the root of your home directory. In this case, no changes to any SDDM configuration file is required. However, you need to make sure that `sddm` user can read the PNG image file(s) for the user icon(s).

Note: In many KDE versions, the user icon image file is `~/.face` and `~/.face.icon` is a symlink to that file. If the user icon images are symlinks, you need to set proper file permissions to the target files.

To set proper permissions run:

    $ setfacl -m u:sddm:x ~/
    $ setfacl -m u:sddm:r ~/.face.icon

You can check permissions with:

    $ getfacl ~/
    $ getfacl ~/.face.icon

See SDDM README: No User Icon.

### Numlock

If you want to enforce Numlock to be enabled, set `Numlock=on` in the `[General]` section.

### Rotate display

See Xrandr#Configuration.

### DPI settings

Sometimes it is useful to set up the correct monitor's PPI settings on a "Display Manager" level.[3] To do so you need to add to `ServerArguments` the parameter `-dpi your_dpi` at the end of the string. For example:

    /etc/sddm.conf.d/dpi.conf

    [X11]
    ServerArguments=-nolisten tcp -dpi 94

### Enable HiDPI

Create the following file:

    /etc/sddm.conf.d/hidpi.conf

    [Wayland]
    EnableHiDPI=true

    [X11]
    EnableHiDPI=true

### Enable virtual keyboard

Install qt5-virtualkeyboard.

Create the following file:

    /etc/sddm.conf.d/virtualkbd.conf

    [General]
    InputMethod=qtvirtualkeyboard

SDDM now displays a button in lower-left corner of login screen to open the virtual keyboard.

### Using a fingerprint reader

Note: Make sure that your fingerprint is registered before making these changes. Fingerprint support is not completely working properly yet, and it seems logging in with only a password no longer works using this method.

SDDM works with a fingerprint reader when using fprint. After installing fprint and adding fingerprint signatures, add the line `auth sufficient pam_fprintd.so` at the beginning of `/etc/pam.d/sddm`.

Tip: To make it work in KDE's lock screen, also add the same line at the beginning of `/etc/pam.d/kde`.

In KDE's lock screen it is also possible to use either password or fingerprint, this can be done by adding the following to the top of the auth section:

    /etc/pam.d/kde

    auth 			sufficient  	pam_unix.so try_first_pass likeauth nullok
    auth 			sufficient  	pam_fprintd.so

The above also works with SDDM (`/etc/pam.d/sddm`) but seems to require KWallet to be unlocked separately.

If you now press enter in the empty password field, the fingerprint reader should start working.

## Troubleshooting

### Blank screen with cursor, but no greeter shows

Greeter crashes if there is no available disk space. Check your disk space with `df -h`.

If disk space is not the issue, it may be due to a bug. Switch to another TTY, and then try `loginctl unlock-session session_id` or to restart SDDM.

### Long load time before SDDM shows the greeter

A low entropy pool can cause long SDDM load time (Bug report). See Random number generation for suggestions to increase the entropy pool.

### Hangs after login

Try removing `~/.Xauthority` and logging in again without rebooting. Rebooting without logging in creates the file again and the problem will persist.

### SDDM starts on tty1 instead of tty7

SDDM follows the systemd convention of starting the first graphical session on tty1. If you prefer the old convention where tty1 through tty6 are reserved for text consoles, change the default value of `MinimumVT` variable, which comes under the `[X11]` section:

    /etc/sddm.conf.d/tty.conf

    [X11]
    MinimumVT=7

### One or more users do not show up on the greeter

Warning: Users set with a UID lower than 1000 or higher than 60513 should generally not be exposed to a display manager.

SDDM only displays users with a UID in the range of 1000 to 60000 by default (the values are taken from `/etc/login.defs` at compile time). If the UIDs of the desired users are outside this range then you will have to modify the range.

For example, for a UID of 501, decrease the minimum UID and hide those with shells used by system users:

    /etc/sddm.conf.d/uid.conf

    [Users]
    HideShells=/usr/bin/nologin,/sbin/nologin,/bin/false,/usr/bin/git-shell
    MinimumUid=500

For users with a higher UIDs, like those used by systemd-homed, increase the maximum UID:

    /etc/sddm.conf.d/uid.conf

    [Users]
    MaximumUid=60513

### User avatars do not show up on the greeter

User avatars are not shown on the greeter if the number of users exceeds DisableAvatarsThreshold parameter or if avatars are not enabled at all as controlled by EnableAvatars parameter. To circumvent this add the following lines to your sddm configuration:

    /etc/sddm.conf.d/avatars.conf

    [Theme]
    EnableAvatars=true # enable avatars
    DisableAvatarsThreshold=7 # set the threshold for the number of users. Avatars are not shown if this threshold is exceeded.

### SDDM loads only US keyboard layout

SDDM loads the keyboard layout specified in `/etc/X11/xorg.conf.d/00-keyboard.conf`. You can generate this configuration file by `localectl set-x11-keymap` command. See Keyboard configuration in Xorg for more information.

An alternative way of setting the keyboard layout that will only set it in SDDM and not subsequent sessions is to invoke a setxkbmap command in the startup script of SDDM, located at `/usr/share/sddm/scripts/Xsetup`. See Xorg/Keyboard configuration#Using setxkbmap for examples.

SDDM may also incorrectly display the layout as US but will immediately change to the correct layout after you start typing your password [4]. This seems to not be a bug in SDDM but in X server.[5]

### Screen resolution is too low

Issue may be caused by HiDPI usage for monitors with corrupted EDID [6]. If you have enabled HiDPI, try to disable it.

If even the above fails, you can try setting your screen size in a Xorg configuration file:

    /etc/X11/xorg.conf.d/90-monitor.conf

    Section "Monitor"
            Identifier      "<default monitor>"
            DisplaySize     345 194 # in millimeters
    EndSection

### Long load time on autofs home directory

SDDM by default tries to display avatars of users by accessing `~/.face.icon` file. If your home directory is an autofs, for example if you use dm-crypt, this will make it wait for 60 seconds, until autofs reports that the directory cannot be mounted.

You can disable avatars by creating the following configuration file:

    /etc/sddm.conf.d/avatar.conf

    [Theme]
    EnableAvatars=false

### X authority (aka MIT-MAGIC-COOKIE) file

SDDM uses a random fresh UUID for the auth file as described in details at [7]. So in order to find that file one may use a script:

    # find /var/run/sddm/ -type f

This may be needed if one needs to start x11vnc when there is no user logged in. For example:

    # x11vnc -display :0 -auth "$( find /var/run/sddm/ -type f )"

Categories:

- KDE
- Display managers

Hidden category:

- Pages or sections flagged with Template:Out of date