rootiest
e651566e14
RETURNS previously conflated fish's $status exit code with genuine stdout/printed output, e.g. rm listing "0/1" as if they were print values rather than exit codes. Rename RETURNS to EXIT STATUS across all 83 documented functions, and reintroduce RETURNS as a distinct label reserved for the 15 functions that actually print to stdout. Update build-manual.py's ENTRY_HEADS to render Exit Status before Returns, manualtools.py's SECTIONS constant, and AGENTS.md's label order and label-usage guidance to match. Add two verify-manual.py regression tests: EXIT STATUS bodies must never contain stray stdout/printed language, and Returns: must always render after Exit Status: when both are present. Regenerate docs/fish-config.md.
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
|
|
#
|
|
# EXIT STATUS
|
|
# 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
|