mirror of
https://github.com/fairyglade/ly.git
synced 2026-03-21 22:43:38 +00:00
Improve README.md (#940)
For anyone who doesn't know see this thread; https://codeberg.org/fairyglade/ly/pulls/934 This is the original post i have fixed the commit log issue (by recreating entire new fork) Note that is is also grammarly fixed version. (mostly please advise if i still have those mistakes) Reviewed-on: https://codeberg.org/fairyglade/ly/pulls/940 Reviewed-by: AnErrupTion <anerruption+codeberg@disroot.org> Co-authored-by: OSVidYapan <osvidyapan@noreply.codeberg.org> Co-committed-by: OSVidYapan <osvidyapan@noreply.codeberg.org>
This commit is contained in:
OSVidYapan
AnErrupTion
129
readme.md
129
readme.md
@@ -2,25 +2,32 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ly is a lightweight TUI (ncurses-like) display manager for Linux and BSD,
|
Ly is a lightweight TUI (ncurses-like) display manager for Linux and BSD, designed with portability in mind (e.g. it does not require systemd to run).
|
||||||
designed with portability in mind (e.g. it does not require systemd to run).
|
|
||||||
|
|
||||||
Join us on Matrix over at [#ly-dm:matrix.org](https://matrix.to/#/#ly-dm:matrix.org)!
|
Join us on Matrix over at [#ly-dm:matrix.org](https://matrix.to/#/#ly-dm:matrix.org)!
|
||||||
|
|
||||||
**Note**: Development happens on [Codeberg](https://codeberg.org/fairyglade/ly)
|
**Note**: Development happens on [Codeberg](https://codeberg.org/fairyglade/ly) with a mirror on [GitHub](https://github.com/fairyglade/ly).
|
||||||
with a mirror on [GitHub](https://github.com/fairyglade/ly).
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
- Compile-time:
|
- Compile-time:
|
||||||
|
|
||||||
- zig 0.15.x
|
- zig 0.15.x
|
||||||
|
|
||||||
- libc
|
- libc
|
||||||
|
|
||||||
- pam
|
- pam
|
||||||
|
|
||||||
- xcb (optional, required by default; needed for X11 support)
|
- xcb (optional, required by default; needed for X11 support)
|
||||||
|
|
||||||
- Runtime (with default config):
|
- Runtime (with default config):
|
||||||
|
|
||||||
- xorg
|
- xorg
|
||||||
|
|
||||||
- xorg-xauth
|
- xorg-xauth
|
||||||
|
|
||||||
- shutdown
|
- shutdown
|
||||||
|
|
||||||
- brightnessctl
|
- brightnessctl
|
||||||
|
|
||||||
### Debian
|
### Debian
|
||||||
@@ -31,8 +38,7 @@ with a mirror on [GitHub](https://github.com/fairyglade/ly).
|
|||||||
|
|
||||||
### Fedora
|
### Fedora
|
||||||
|
|
||||||
**Warning**: You may encounter issues with SELinux on Fedora.
|
**Warning**: You may encounter issues with SELinux on Fedora. It is recommended to add a rule for Ly as it currently does not ship one.
|
||||||
It is recommended to add a rule for Ly as it currently does not ship one.
|
|
||||||
|
|
||||||
```
|
```
|
||||||
# dnf install kernel-devel pam-devel libxcb-devel zig xorg-x11-xauth xorg-x11-server brightnessctl
|
# dnf install kernel-devel pam-devel libxcb-devel zig xorg-x11-xauth xorg-x11-server brightnessctl
|
||||||
@@ -50,16 +56,22 @@ It is recommended to add a rule for Ly as it currently does not ship one.
|
|||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
Ly has been tested with a wide variety of desktop environments and window
|
Every environment that works on other login managers also should work on Ly.
|
||||||
managers, all of which you can find in the sections below:
|
|
||||||
|
|
||||||
[Wayland environments](#supported-wayland-environments)
|
- Unlike most login managers Ly has xinitrc entry and it also supports shell.
|
||||||
|
|
||||||
[X11 environments](#supported-x11-environments)
|
- If you installed your favorite environment and you don't see it, that's because Ly doesn't automatically refresh itself. To fix this you should restart Ly service (depends on your init system) or the easy way is to reboot your system.
|
||||||
|
|
||||||
|
- If your environment is still missing then check at `/usr/share/xsessions` or `/usr/share/wayland-sessions` to see if a .desktop file is present.
|
||||||
|
|
||||||
|
- If there isn't a .desktop file then create a new one at `/etc/ly/custom-sessions` that launches your favorite environment. These .desktop files can be only seen by Ly and if you want them system-wide you also can create at those directories instead.
|
||||||
|
|
||||||
|
- If only Xorg sessions doesn't work then check if your distro compiles Ly with Xorg support as it can be compiled with Xorg support disabled.
|
||||||
|
|
||||||
Logs are defined by `/etc/ly/config.ini`:
|
Logs are defined by `/etc/ly/config.ini`:
|
||||||
|
|
||||||
- The session log is located at `~/.local/state/ly-session.log` by default.
|
- The session log is located at `~/.local/state/ly-session.log` by default.
|
||||||
|
|
||||||
- The system log is located at `/var/log/ly.log` by default.
|
- The system log is located at `/var/log/ly.log` by default.
|
||||||
|
|
||||||
## Manually building
|
## Manually building
|
||||||
@@ -72,23 +84,17 @@ $ cd ly
|
|||||||
$ zig build
|
$ zig build
|
||||||
```
|
```
|
||||||
|
|
||||||
After building, you can (optionally) test Ly in a terminal emulator, although
|
After building, you can (optionally) test Ly in a terminal emulator, although authentication will **not** work:
|
||||||
authentication will **not** work:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
$ zig build run
|
$ zig build run
|
||||||
```
|
```
|
||||||
|
|
||||||
**Important**: While you can also run Ly in a terminal emulator as root, it is
|
**Important**: While you can also run Ly in a terminal emulator as root, it is **not** recommended either. If you want to properly test Ly, please enable its service (as described below) and reboot your machine.
|
||||||
**not** recommended either. If you want to properly test Ly, please enable its
|
|
||||||
service (as described below) and reboot your machine.
|
|
||||||
|
|
||||||
The following sections show how to install Ly for a particular init system.
|
The following sections show how to install Ly for a particular init system. Because the procedure is very similar for all of them, the commands will only be detailed for the first section (which is about systemd).
|
||||||
Because the procedure is very similar for all of them, the commands will only
|
|
||||||
be detailed for the first section (which is about systemd).
|
|
||||||
|
|
||||||
**Note**: All following sections will assume you are using LightDM for
|
**Note**: All following sections will assume you are using LightDM for convenience sake.
|
||||||
convenience sake.
|
|
||||||
|
|
||||||
### systemd
|
### systemd
|
||||||
|
|
||||||
@@ -100,9 +106,7 @@ Now, you can install Ly on your system:
|
|||||||
|
|
||||||
**Note**: The `init_system` parameter is optional and defaults to `systemd`.
|
**Note**: The `init_system` parameter is optional and defaults to `systemd`.
|
||||||
|
|
||||||
Note that you also need to disable your current display manager. For example,
|
Note that you also need to disable your current display manager. For example, if LightDM is the current display manager, you can execute the following command:
|
||||||
if LightDM is the current display manager, you can execute the following
|
|
||||||
command:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
# systemctl disable lightdm.service
|
# systemctl disable lightdm.service
|
||||||
@@ -114,8 +118,7 @@ Then, similarly to the previous command, you need to enable the Ly service:
|
|||||||
# systemctl enable ly@tty2.service
|
# systemctl enable ly@tty2.service
|
||||||
```
|
```
|
||||||
|
|
||||||
**Important**: Because Ly runs in a TTY, you **must** disable the TTY service
|
**Important**: Because Ly runs in a TTY, you **must** disable the TTY service that Ly will run on, otherwise bad things will happen. For example, to disable `getty` spawning on TTY 2, you need to execute the following command:
|
||||||
that Ly will run on, otherwise bad things will happen. For example, to disable `getty` spawning on TTY 2, you need to execute the following command:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
# systemctl disable getty@tty2.service
|
# systemctl disable getty@tty2.service
|
||||||
@@ -127,8 +130,7 @@ The target of the symlink, `ly@ttyN.service`, does not actually exist, but syste
|
|||||||
|
|
||||||
Compare to `man 5 logind.conf`, especially regarding the `NAutoVTs=` and `ReserveVT=` parameters.
|
Compare to `man 5 logind.conf`, especially regarding the `NAutoVTs=` and `ReserveVT=` parameters.
|
||||||
|
|
||||||
On non-systemd systems, you can change the TTY Ly will run on by editing the corresponding
|
On non-systemd systems, you can change the TTY Ly will run on by editing the corresponding service file for your platform.
|
||||||
service file for your platform.
|
|
||||||
|
|
||||||
### OpenRC
|
### OpenRC
|
||||||
|
|
||||||
@@ -139,8 +141,7 @@ service file for your platform.
|
|||||||
# rc-update del agetty.tty2
|
# rc-update del agetty.tty2
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note**: On Gentoo specifically, you also **must** comment out the appropriate
|
**Note**: On Gentoo specifically, you also **must** comment out the appropriate line for the TTY in /etc/inittab.
|
||||||
line for the TTY in /etc/inittab.
|
|
||||||
|
|
||||||
### runit
|
### runit
|
||||||
|
|
||||||
@@ -171,8 +172,7 @@ To disable TTY 2, edit `/etc/s6/config/tty2.conf` and set `SPAWN="no"`.
|
|||||||
# dinitctl enable ly
|
# dinitctl enable ly
|
||||||
```
|
```
|
||||||
|
|
||||||
To disable TTY 2, go to `/etc/dinit.d/config/console.conf` and modify
|
To disable TTY 2, go to `/etc/dinit.d/config/console.conf` and modify `ACTIVE_CONSOLES`.
|
||||||
`ACTIVE_CONSOLES`.
|
|
||||||
|
|
||||||
### sysvinit
|
### sysvinit
|
||||||
|
|
||||||
@@ -199,8 +199,7 @@ Ly:\
|
|||||||
:al=root:
|
:al=root:
|
||||||
```
|
```
|
||||||
|
|
||||||
Then, modify the command field of the `ttyv1` terminal entry in `/etc/ttys`
|
Then, modify the command field of the `ttyv1` terminal entry in `/etc/ttys` (TTYs in FreeBSD start at 0):
|
||||||
(TTYs in FreeBSD start at 0):
|
|
||||||
|
|
||||||
```
|
```
|
||||||
ttyv1 "/usr/libexec/getty Ly" xterm on secure
|
ttyv1 "/usr/libexec/getty Ly" xterm on secure
|
||||||
@@ -208,37 +207,27 @@ ttyv1 "/usr/libexec/getty Ly" xterm on secure
|
|||||||
|
|
||||||
### Updating
|
### Updating
|
||||||
|
|
||||||
You can also install Ly without overrding the current configuration file. This
|
You can also install Ly without overrding the current configuration file. This is called **updating**. To update, simply run:
|
||||||
is called **updating**. To update, simply run:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
# zig build installnoconf
|
# zig build installnoconf
|
||||||
```
|
```
|
||||||
|
|
||||||
You can, of course, still select the init system of your choice when using this
|
You can, of course, still select the init system of your choice when using this command.
|
||||||
command.
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
You can find all the configuration in `/etc/ly/config.ini`. The file is fully
|
You can find all the configuration in `/etc/ly/config.ini`. The file is fully commented, and includes the default values.
|
||||||
commented, and includes the default values.
|
|
||||||
|
|
||||||
## Controls
|
## Controls
|
||||||
|
|
||||||
Use the Up/Down arrow keys to change the current field, and the Left/Right
|
Use the Up/Down arrow keys to change the current field, and the Left/Right arrow keys to scroll through the different fields (whether it be the info line, the desktop environment, or the username). The info line is where messages and errors are displayed.
|
||||||
arrow keys to scroll through the different fields (whether it be the info line,
|
|
||||||
the desktop environment, or the username). The info line is where messages and
|
|
||||||
errors are displayed.
|
|
||||||
|
|
||||||
## A note on .xinitrc
|
## A note on .xinitrc
|
||||||
|
|
||||||
If your `.xinitrc` file doesn't work ,make sure it is executable and includes a
|
If your `.xinitrc` file doesn't work ,make sure it is executable and includes a shebang. This file is supposed to be a shell script! Quoting from `xinit`'s man page:
|
||||||
shebang. This file is supposed to be a shell script! Quoting from `xinit`'s man
|
|
||||||
page:
|
|
||||||
|
|
||||||
> If no specific client program is given on the command line, xinit will look
|
> If no specific client program is given on the command line, xinit will look for a file in the user's home directory called .xinitrc to run as a shell script to start up client programs.
|
||||||
> for a file in the user's home directory called .xinitrc to run as a shell
|
|
||||||
> script to start up client programs.
|
|
||||||
|
|
||||||
A typical shebang for a shell script looks like this:
|
A typical shebang for a shell script looks like this:
|
||||||
|
|
||||||
@@ -249,50 +238,14 @@ A typical shebang for a shell script looks like this:
|
|||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- The numlock and capslock state is printed in the top-right corner.
|
- The numlock and capslock state is printed in the top-right corner.
|
||||||
|
|
||||||
- Use the F1 and F2 keys to respectively shutdown and reboot.
|
- Use the F1 and F2 keys to respectively shutdown and reboot.
|
||||||
- Take a look at your `.xsession` file if X doesn't start, as it can interfere
|
|
||||||
(this file is launched with X to configure the display properly).
|
|
||||||
|
|
||||||
## Supported Wayland environments
|
- Take a look at your `.xsession` file if X doesn't start, as it can interfere (this file is launched with X to configure the display properly).
|
||||||
|
|
||||||
- budgie
|
|
||||||
- cosmic
|
|
||||||
- deepin
|
|
||||||
- enlightenment
|
|
||||||
- gnome
|
|
||||||
- hyprland
|
|
||||||
- kde
|
|
||||||
- labwc
|
|
||||||
- niri
|
|
||||||
- pantheon
|
|
||||||
- sway
|
|
||||||
- weston
|
|
||||||
|
|
||||||
## Supported X11 environments
|
|
||||||
|
|
||||||
- awesome
|
|
||||||
- bspwm
|
|
||||||
- budgie
|
|
||||||
- cinnamon
|
|
||||||
- dwm
|
|
||||||
- enlightenment
|
|
||||||
- gnome
|
|
||||||
- kde
|
|
||||||
- leftwm
|
|
||||||
- lxde
|
|
||||||
- mate
|
|
||||||
- maxx
|
|
||||||
- pantheon
|
|
||||||
- qwm
|
|
||||||
- spectrwm
|
|
||||||
- windowmaker
|
|
||||||
- xfce
|
|
||||||
- xmonad
|
|
||||||
|
|
||||||
## A final note
|
## A final note
|
||||||
|
|
||||||
The name "Ly" is a tribute to the fairy from the game Rayman. Ly was tested by
|
The name "Ly" is a tribute to the fairy from the game Rayman. Ly was tested by oxodao, who is some seriously awesome dude.
|
||||||
oxodao, who is some seriously awesome dude.
|
|
||||||
|
|
||||||
Also, Ly wouldn't be there today without [Kawaii-Ash](https://github.com/Kawaii-Ash), who has done significant contributions to the project for the Zig rewrite, which lead to the release of Ly v1.0.0. Massive thanks, and sorry for not crediting you enough beforehand!
|
Also, Ly wouldn't be there today without [Kawaii-Ash](https://github.com/Kawaii-Ash), who has done significant contributions to the project for the Zig rewrite, which lead to the release of Ly v1.0.0. Massive thanks, and sorry for not crediting you enough beforehand!
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user