NAME

EBook::Ishmael::ShellQuote - Quote strings to be used in shell commands

SYNOPSIS

use EBook::Ishmael::ShellQuote qw(shell_quote);

my $quote = shell_quote("$ <-- literally a dollar sign");
system "echo $quote";

DESCRIPTION

EBook::Ishmael::ShellQuote is a module that provides the shell_quote() subroutine for quoting strings to be passed as arguments to a shell command. This is a private module, consult the ishmael manual for user documentation.

SUBROUTINES

$quoted = shell_quote($string)

Returns the double-quote-quotted version of the given string. Characters like $, `, and " will be escaped via a backslash, and the string will be wrapped in double quotes.

$quoted = command_quote($string)

Returns quoted version of the given string suitable for using as shell command.

$output = safe_qx($program, [ @args ])

Runs the given $program with arguments @args using the qx// operator and returns the output. The program name and arguments are quoted to prevent unexpected word-splitting.

AUTHOR

Written by Samuel Young, <samyoung12788@gmail.com>.

This project's source can be found on its Codeberg Page. Comments and pull requests are welcome!

COPYRIGHT

Copyright (C) 2025-2026 Samuel Young

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

SEE ALSO

ishmael