rootiest
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).
52 lines
1.5 KiB
Fish
52 lines
1.5 KiB
Fish
# Copyright (C) 2026 Rootiest
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
# SYNOPSIS
|
|
# p [args...]
|
|
#
|
|
# DESCRIPTION
|
|
# Outputs clipboard contents to stdout. Uses wl-paste on Wayland,
|
|
# falls back to xclip on X11. Supports -h/--help for usage info.
|
|
#
|
|
# ARGUMENTS
|
|
# -h, --help Show usage help
|
|
# args... Arguments forwarded to the clipboard tool
|
|
#
|
|
# RETURNS
|
|
# 0 Clipboard contents printed successfully
|
|
# 1 No supported clipboard tool found
|
|
#
|
|
# EXAMPLE
|
|
# p | grep foo
|
|
# p > file.txt
|
|
function p --description 'Put from clipboard'
|
|
# Check for help flag
|
|
if contains -- -h $argv; or contains -- --help $argv
|
|
echo "Usage: p [OPTIONS]"
|
|
echo ""
|
|
echo "Description:"
|
|
echo " Pastes content from the system clipboard to stdout."
|
|
echo ""
|
|
echo "Examples:"
|
|
echo " p Print clipboard content"
|
|
echo " p > file.txt Save clipboard to a file"
|
|
echo " p | grep 'foo' Pipe clipboard content to another command"
|
|
echo " cat (p) Use clipboard content as a filename for cat"
|
|
return 0
|
|
end
|
|
|
|
# Determine the clipboard provider
|
|
set -l paste_cmd
|
|
if type -q wl-paste
|
|
set paste_cmd wl-paste
|
|
else if type -q xclip
|
|
set paste_cmd xclip -selection clipboard -o
|
|
else
|
|
echo "Error: No clipboard provider (wl-paste or xclip) found." >&2
|
|
return 1
|
|
end
|
|
|
|
# Execute the paste command with any provided arguments
|
|
$paste_cmd $argv
|
|
end
|