Skip to content

Commit

Permalink
Refs #118, updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
tvrzna committed Aug 8, 2024
1 parent b2a7f3e commit 4a50c02
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,15 @@ Command to be used to perform poweroff. Default value is "poweroff".
`CMD_REBOOT`
Command to be used to perform reboot. Default value is "reboot".

`CMD_SUSPEND`
Command to be used to perform suspend. Default value is blank, but it tries to use "systemctl suspend", "loginctl suspend" or "zzz".

#### Commands
If commands are allowed and default user is not defined, there could be used commands in login input. All of these commands need to start with colon `:`. Escape characters are ignored to prevent issues with muscle memory from VI.
- `:help`, `:?` prints available commands
- `:poweroff`, `:shutdown` processess poweroff command
- `:reboot` processes reboot command
- `:suspend`, `:zzz` processes suspend command

#### Dynamic MOTD
If `DYNAMIC_MOTD` is set to `true`, this file exists and is executable for its owner, the result is printed as your own MOTD. Be very careful with this script!
Expand Down
6 changes: 5 additions & 1 deletion res/emptty.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH EMPTTY 1 "July 2024" "emptty 0.12.1" emptty
.TH EMPTTY 1 "August 2024" "emptty 0.12.1" emptty

.SH NAME
emptty \- Dead simple CLI Display Manager on TTY
Expand Down Expand Up @@ -187,11 +187,15 @@ Command to be used to perform poweroff. Default value is "poweroff".
.IP CMD_REBOOT
Command to be used to perform reboot. Default value is "reboot".

.IP CMD_SUSPEND
Command to be used to perform suspend. Default value is blank, but it tries to use "systemctl suspend", "loginctl suspend" or "zzz".

.SH COMMANDS
If commands are allowed and default user is not defined, there could be used commands in login input. All of these commands need to start with colon ":". Escape characters are ignored to prevent issues with muscle memory from VI.
- :help, :? - prints available commands
- :poweroff, :shutdown - processess poweroff command
- :reboot - processes reboot command
- :suspend, :zzz - processes suspend command

.SH DYNAMIC MOTD
Optional file stored by default as /etc/emptty/motd-gen.sh. Could be overridden.
Expand Down

0 comments on commit 4a50c02

Please # to comment.