Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jovanlanik committed Apr 18, 2024
1 parent 159592e commit 48001a2
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 7 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,11 @@ $ ninja -C builddir
- pkg-config (build-time)
- scdoc (optional, build-time)
- PAM
- wayland-client
- gtk+3.0
- gtk-session-lock
- [gtk-session-lock](https://github.com/Cu3PO42/gtk-session-lock)
### Installing build dependencies
- Arch: `# pacman -S gcc meson pkgconf scdoc pam wayland gtk3 gtk-layer-shell`
- Fedora: `# dnf install gcc meson pkgconf scdoc pam-devel wayland-devel gtk3-devel gtk-layer-shell-devel`
- Void: `# xbps-install gcc meson pkgconf scdoc pam-devel wayland-devel gtk+3-devel gtk-layer-shell-devel`
- Arch: `# yay -S gcc meson pkgconf scdoc pam wayland gtk3 gtk-session-lock`
- Fedora: `# dnf install gcc meson pkgconf scdoc pam-devel wayland-devel gtk3-devel`, install gtk-session-lock manually
- Void: `# xbps-install gcc meson pkgconf scdoc pam-devel wayland-devel gtk+3-devel`, install gtk-session-lock manually

❤️ __Please submit an dependency installation command for your distro!__
8 changes: 7 additions & 1 deletion man/gtklock.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ All available options are:
*-s, --style* <path>
Load CSS style file.

*-x, --layout* <path>
Load XML layout file.

*-m, --modules* <name>
Load gtklock modules. Module name can be an absolute path, relative path
(starting with ./ or ../) or name in system directory (such as
Expand All @@ -61,11 +64,14 @@ All available options are:
Start with input form hidden.

*-L, --lock-command*
Command to execute before locking. Command is executed asynchronously.
Command to execute after locking. Command is executed asynchronously.

*-U, --unlock-command*
Command to execute after unlocking. Command is executed asynchronously.

*-M, --monitor-priority* <name>
Set monitor focus priority. Option can be specified multiple times.

# EXAMPLE

Example config:
Expand Down
2 changes: 1 addition & 1 deletion src/source.c
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ static GOptionEntry config_entries[] = {
{ "start-hidden", 'S', 0, G_OPTION_ARG_NONE, &start_hidden, "Start with hidden form", NULL },
{ "lock-command", 'L', 0, G_OPTION_ARG_STRING, &lock_command, "Command to execute after locking", NULL },
{ "unlock-command", 'U', 0, G_OPTION_ARG_STRING, &unlock_command, "Command to execute after unlocking", NULL },
{ "monitor-priority", 'M', 0, G_OPTION_ARG_STRING_ARRAY, &monitor_priority, "Monitor focus priority", NULL },
{ "monitor-priority", 'M', 0, G_OPTION_ARG_STRING_ARRAY, &monitor_priority, "Set monitor focus priority", NULL },
{ NULL },
};

Expand Down

0 comments on commit 48001a2

Please sign in to comment.