rootiest
4c51ef7a33
Records each documented function's manual category in its own header, so Section 5 can later be generated from source instead of hand-maintained alongside it. Values reproduce the current grouping in docs/manual/05-functions/ exactly; no documentation changes meaning here. Four functions are skipped because they have no header at all yet (branch, fc, gitup, sudo-toggle); they get one in the merge that follows.
36 lines
1.0 KiB
Fish
36 lines
1.0 KiB
Fish
# Copyright (C) 2026 Rootiest
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
# CATEGORY
|
|
# 14-miscellaneous
|
|
#
|
|
# SYNOPSIS
|
|
# wake-lock <command> [args...]
|
|
#
|
|
# DESCRIPTION
|
|
# Runs a command under systemd-inhibit to prevent the system from idling
|
|
# or sleeping for the duration of the command.
|
|
#
|
|
# ARGUMENTS
|
|
# command Command to run with sleep inhibition active
|
|
# args... Arguments forwarded to the command
|
|
#
|
|
# RETURNS
|
|
# 0 Command ran and completed
|
|
# 1 No command provided
|
|
#
|
|
# EXAMPLE
|
|
# wake-lock rsync -avz src/ dest/
|
|
function wake-lock --description 'Run a command while inhibiting system sleep'
|
|
if test (count $argv) -eq 0
|
|
echo "Usage: wake-lock [command] [args...]"
|
|
return 1
|
|
end
|
|
|
|
echo "Running '$argv' with sleep inhibition active..."
|
|
|
|
# --what=idle:sleep prevents the system from auto-sleeping or being suspended
|
|
# --who identifies your function in 'systemd-inhibit --list'
|
|
systemd-inhibit --why="Manual task inhibition" --who="wake-lock" --what=idle:sleep $argv
|
|
end
|