Skip to content

Commit

Permalink
Fixed #73, updated documentation to avoid confusions in terminology.
Browse files Browse the repository at this point in the history
  • Loading branch information
tvrzna committed Aug 16, 2022
1 parent dc5aa6c commit c869c77
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ __NOTE:__ to enable autologin DEFAULT_USER must be in group nopasswdlogin, other

`LANG` defines locale for all users. Default value is "en_US.UTF-8"

`DBUS_LAUNCH` Starts "dbus-launch" before desktop command. After end of session "dbus-daemon" is interrupted. Default value is true. If `.emptty` is handled as script (does not contain `Exec` option), this config is overriden to false.
`DBUS_LAUNCH` Starts "dbus-launch" before desktop command. After end of session "dbus-daemon" is interrupted. Default value is true. If user config is handled as script (does not contain `Exec` option), this config is overriden to false.

`ALWAYS_DBUS_LAUNCH` Starts "dbus-launch" before desktop command in any case, `DBUS_LAUNCH` value is ignored. It also starts even if `XINITRC_LAUNCH` is set to `true`. After end of session "dbus-daemon" is interrupted. Default value is false.

`XINITRC_LAUNCH` Starts Xorg desktop with calling "\~/.xinitrc" script with session exec as argument, if is true, file exists and selected WM/DE is Xorg session, it overrides DBUS_LAUNCH. If `.emptty` is handled as script (does not contain `Exec` option), this config is overriden to false.
`XINITRC_LAUNCH` Starts Xorg desktop with calling "\~/.xinitrc" script with session exec as argument, if is true, file exists and selected WM/DE is Xorg session, it overrides DBUS_LAUNCH. If user config is handled as script (does not contain `Exec` option), this config is overriden to false.

`VERTICAL_SELECTION` Prints available WM/DE each on new line instead of printing on single line.

Expand Down Expand Up @@ -108,14 +108,14 @@ If `DYNAMIC_MOTD` is set to `true`, this file exists and is executable for its o
#### Static MOTD
Custom file, that prints your own MOTD. Reading this file supports colors (e.g. `\x1b[31m` or `\033[32m`).

#### ${HOME}/.config/emptty or ${HOME}/.emptty
#### User Config (${HOME}/.config/emptty or ${HOME}/.emptty)
Optional configuration file, that could be also handled as shell script. If is not presented, emptty shows selection of installed desktops.
Configuration file stored as `${HOME}/.config/emptty` has higher priority on loading.
See [samples](SAMPLES.md#emptty-as-config)

`Name` Optional name to be used as Session Name.

`Exec` Defines command to start Desktop Environment/Window Manager. It could contain multiple arguments same as in \*.desktop files. This value does not need to be defined, if .emptty file is presented as shell script (with shebang at the start and execution permissions).
`Exec` Defines command to start Desktop Environment/Window Manager. It could contain multiple arguments same as in \*.desktop files. This value does not need to be defined, if user config file is presented as shell script (with shebang at the start and execution permissions).

`Environment` Selects, which environment should be defined for following command. Possible values are "xorg" and "wayland", "xorg" is default.

Expand Down
6 changes: 3 additions & 3 deletions res/emptty.1
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ If Autologin is enabled and session does not start correctly, the number of retr
defines locale for all users. Default value is "en_US.UTF-8"
.IP DBUS_LAUNCH
Starts "dbus-launch" before desktop command. After end of session "dbus-daemon" is interrupted. Default value is true. If
.I .emptty
.I user config
is handled as script (does not contain
.I Exec
option), this config is overriden to false.
Expand All @@ -84,7 +84,7 @@ is set to `true`. After end of session "dbus-daemon" is interrupted. Default val
Starts Xorg desktop with calling
.I ~/.xinitrc
script with session exec as argument, if is true, file exists and selected WM/DE is Xorg session, it overrides DBUS_LAUNCH. If
.I .emptty
.I user config
is handled as script (does not contain
.I Exec
option), this config is overriden to false.
Expand Down Expand Up @@ -189,7 +189,7 @@ Configuration file stored as ${HOME}/.config/emptty has higher priority on loadi
.IP Name
Optional name to be used as Session Name.
.IP Exec
Defines command to start Desktop Environment/Window Manager. This value does not need to be defined, if .emptty file is presented as shell script (with shebang at the start and execution permissions).
Defines command to start Desktop Environment/Window Manager. This value does not need to be defined, if user config is presented as shell script (with shebang at the start and execution permissions).
.IP Environment
Selects, which environment should be defined for following command. Possible values are "xorg" and "wayland", "xorg" is default.
.IP Lang
Expand Down

0 comments on commit c869c77

Please sign in to comment.