1341e2559e
Replace all ad-hoc inline comments between license headers and function declarations with consistent SYNOPSIS / DESCRIPTION / ARGUMENTS / RETURNS / EXAMPLE blocks across all 99 project-owned functions/ files. No executable logic, variable names, or exit codes were modified. Completes Task #6 from AGENTS.md (Retroactive Function Documentation Standardization).
22 lines
627 B
Fish
22 lines
627 B
Fish
# Copyright (C) 2026 Rootiest
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
# SYNOPSIS
|
|
# screensleep
|
|
#
|
|
# DESCRIPTION
|
|
# Turns off the display after a 1-second delay by invoking the KDE
|
|
# PowerDevil "Turn Off Screen" global shortcut via busctl.
|
|
#
|
|
# EXAMPLE
|
|
# screensleep
|
|
function screensleep --description 'Turn off the display using KDE PowerDevil'
|
|
# Optional: 1-second delay to ensure no keystrokes wake it immediately
|
|
sleep 1
|
|
busctl --user call \
|
|
org.kde.kglobalaccel \
|
|
/component/org_kde_powerdevil \
|
|
org.kde.kglobalaccel.Component \
|
|
invokeShortcut s "Turn Off Screen"
|
|
end
|