commit: b0c9ca88d6217610badf54f2f92e75f929184feb Author: Niklaus 'vimja' Hofer <gentoo-bugzilla <AT> vimja <DOT> email> AuthorDate: Sat Sep 20 18:39:02 2025 +0000 Commit: David Roman <davidroman96 <AT> gmail <DOT> com> CommitDate: Sat Sep 20 18:40:20 2025 +0000 URL: https://gitweb.gentoo.org/repo/proj/guru.git/commit/?id=b0c9ca88
gui-apps/waylock: Install man page unconditionally Thank @pastalian for the review and the suggestions :) Signed-off-by: Niklaus 'vimja' Hofer <gentoo-bugzilla <AT> vimja.email> gui-apps/waylock/files/waylock.1 | 112 +++++++++++++++++++++ ...ock-1.5.0-r1.ebuild => waylock-1.5.0-r2.ebuild} | 10 +- 2 files changed, 113 insertions(+), 9 deletions(-) diff --git a/gui-apps/waylock/files/waylock.1 b/gui-apps/waylock/files/waylock.1 new file mode 100644 index 0000000000..b596316e90 --- /dev/null +++ b/gui-apps/waylock/files/waylock.1 @@ -0,0 +1,112 @@ +.\" Generated by scdoc 1.11.3 +.\" Complete documentation for this program is not available as a GNU info page +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.nh +.ad l +.\" Begin generated content: +.TH "WAYLOCK" "1" "2025-09-20" "https://codeberg.org/ifreund/waylock"; "General Commands Manual" +.PP +.SH NAME +.PP +waylock - a small Wayland screenlocker +.PP +.SH SYNOPSIS +.PP +\fBwaylock\fR [\fIoptions\fR] +.PP +.SH DESCRIPTION +.PP +Waylock is a small screenlocker for Wayland compositors implementing +\fBext-session-lock-v1\fR.\& The \fBext-session-lock-v1\fR protocol is significantly +more robust than previous client-side Wayland screen locking approaches.\& +Importantly, the screenlocker crashing does not cause the session to be +unlocked.\& +.PP +.SH OPTIONS +.PP +\fB-h\fR +.RS 4 +Print a help message and exit.\& +.PP +.RE +\fB-version\fR +.RS 4 +Print the version number and exit.\& +.PP +.RE +\fB-log-level\fR [\fBerror\fR|\fBwarning\fR|\fBinfo\fR|\fBdebug\fR] +.RS 4 +Set the log level of waylock.\& At the \fBerror\fR log level, only errors +are logged.\& At the \fBdebug\fR log level, everything is logged including +verbose debug messages.\& +.PP +.RE +\fB-fork-on-lock\fR +.RS 4 +Fork to the background after locking the session.\& This is useful to +integrate with idle management daemons without racing to lock the +session before suspend.\& With this option waylock will exit once the +session has been locked and it is safe to suspend.\& +.PP +.RE +\fB-ready-fd\fR \fIfd\fR +.RS 4 +Write a newline to file descriptor \fIfd\fR (a number) after locking and +close the \fIfd\fR.\& This is useful if a fork-less lock notification is needed; +for example, for integration with a service manager.\& +.PP +.RE +\fB-ignore-empty-password\fR +.RS 4 +Do not submit empty passwords to PAM for validation when the Enter +key is pressed.\& Instead, do nothing.\& This may be useful if, for +example, the Enter key is used to wake the computer from sleep.\& +.PP +.RE +\fB-init-color\fR \fI0xRRGGBB\fR +.RS 4 +Set the initial color.\& (default: 0x002b36) +.PP +.RE +\fB-input-color\fR \fI0xRRGGBB\fR +.RS 4 +Set the color used after input.\& (default: 0x6c71c4) +.PP +.RE +\fB-input-alt-color\fR \fI0xRRGGBB\fR +.RS 4 +Set the alternate color used after input.\& (default is what +\fB-input-color\fR is set to) +.PP +.RE +\fB-fail-color\fR \fI0xRRGGBB\fR +.RS 4 +Set the color used on authentication failure.\& (default: 0xdc322f) +.PP +.RE +.SH USAGE +.PP +Run the waylock executable to lock the session.\& All monitors will be blanked +with the \fB-init-color\fR.\& Typing causes the color to change to the +\fB-input-color\fR.\& If \fB-input-alt-color\fR is set, the typing color will alternate +between this and the former.\& Esc or Ctrl-U clears all current input, while +backspace deletes the last UTF-8 codepoint.\& +.PP +To unlock the session, type your password and press Enter.\& If the password +is correct, waylock will unlock the session and exit.\& Otherwise, the color +will change to the \fB-fail-color\fR and you may try again.\& +.PP +In order to automatically run waylock after a certain amount of time with +no input or before sleep, the \fBswayidle\fR(1) utility or a similar program +may be used.\& See the \fBswayidle\fR(1) man page for details.\& +.PP +.SH AUTHORS +.PP +Maintained by Isaac Freund <mail@isaacfreund.\&com> who is assisted by open +source contributors.\& For more information about waylock'\&s development, see +https://codeberg.\&org/ifreund/waylock.\&; +.PP +.SH SEE ALSO +.PP +\fBpam\fR(8), \fBswayidle\fR(1) diff --git a/gui-apps/waylock/waylock-1.5.0-r1.ebuild b/gui-apps/waylock/waylock-1.5.0-r2.ebuild similarity index 81% rename from gui-apps/waylock/waylock-1.5.0-r1.ebuild rename to gui-apps/waylock/waylock-1.5.0-r2.ebuild index 013e9a12c4..5ffbb1b018 100644 --- a/gui-apps/waylock/waylock-1.5.0-r1.ebuild +++ b/gui-apps/waylock/waylock-1.5.0-r2.ebuild @@ -24,7 +24,6 @@ SRC_URI=" LICENSE="ISC MIT" SLOT="0" KEYWORDS="~amd64 ~arm64" -IUSE="man" BDEPEND=" dev-libs/wayland-protocols @@ -43,18 +42,11 @@ src_configure() { -Dman-pages=false ) - if use man; then - mkdir --parents ${WORKDIR}/${P}-build/share/man/man1 - cp ${FILESDIR}/manpage-${PV} ${WORKDIR}/${P}-build/share/man/man1/waylock.1 - fi - zig_src_configure } src_install() { - if use man; then - doman ${WORKDIR}/${P}-build/share/man/man1/waylock.1 - fi + doman "${FILESDIR}/${PN}.1" zig_src_install }
