---
name: "ukui-session-tools"
section: "1"
platform: "linux"
package: "ukui-session-manager"
version: "3.0.5-1+b1"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/ukui-session-tools"
---

# ukui-session-tools(1)

Start the UKUI Desktop Environment.

## NAME

ukui-session - Start the UKUI Desktop Environment.

## SYNOPSIS

**ukui-session \[OPTIONS\]**

## DESCRIPTION

The **ukui-session** program starts up the UKUI desktop environment. This command is typically executed by your Login/Display Manager (like GDM, LXDM, XDM, SLiM, or from your X startup scripts like .xinitrc). It will load either your saved session, or it will provide a default session for the user as defined by the system administrator (or the default UKUI installation on your system).

The default session is defined in the dconf keys under **/***org***/***ukui***/***desktop***/***session***/**\
 When saving a session, **ukui-session** saves the currently running applications in the **~/.config/ukui-session/saved-session** directory of the users /home.

**ukui-session** is an X11 session manager. It can manage UKUI applications as well as any other X11 SM compliant ones.

## OPTIONS

### The following options are supported:

- **-a, --autostart=DIR**

  Start all applications defined in "**DIR**", instead of starting the applications defined in  **/***org***/***ukui***/***desktop***/***session***/***default-session*\
   Multiple **--autostart** options can be passed.

- **-f, --failsafe**

  Run in fail-safe mode. User-specified applications will not be started.

- **--debug**

  Enable debugging code.

- **--display=DISPLAY**

  X display to use.

- **--version**

  Output version information and exit.

- **-?, -h, --help**

  Print standard command line options.

- **--help-all**

  Print all command line options.

## ENVIRONMENT

### ukui-session sets several environment variables for the use of its child processes:

**SESSION\_MANAGER**

-

  This variable is used by session-manager aware clients to contact ukui-session.

**DISPLAY**

-

  This variable is set to the X display being used by **ukui-session**. Note that if the --display option is used this might be different from the setting of the environment variable when ukui-session is invoked.

## FILES

```
~/.config/autostart
/usr/share/autostart
/usr/share/ukui/autostart
```

-

  The applications defined in the above directories will be started on login. **[ukui-session-properties(1)](/ukui-session-properties/1.md)** can be used to easily configure them.

**~/.config/ukui-session/saved-session**

-

  This directory contains the list of applications of the saved session.

## BUGS

### Should you encounter any bugs, they may be reported at:

https://github.com/ukui/ukui-session-manager/issues

## AUTHORS

### This Manual page was originally written for gnome-session by:

```
Miguel de Icaza <miguel@helixcode.com> (2000)
Vincent Untz <vuntz@gnome.org> (2009-2010)
```

### It has been updated for the MATE Desktop Environment by:

Adam Erdman \<hekel@archlinux.info\> (2014)

### It has been updated for the UKUI Desktop Environment by:

yilei \<yilei@kylinos.cn\> (2016)

## SEE ALSO

### Further information may also be available at: http://wiki.ukui.org/

**[ukui-session-properties(1)](/ukui-session-properties/1.md),** **[ukui-session-save(1)](/ukui-session-save/1.md),** **[ukui-wm(1)](/ukui-wm/1.md)**