string::shellquote(3pm) [debian man page]

ShellQuote(3pm) 					User Contributed Perl Documentation					   ShellQuote(3pm)

NAME

       String::ShellQuote - quote strings for passing through the shell

SYNOPSIS

	   $string = shell_quote @list;
	   $string = shell_quote_best_effort @list;
	   $string = shell_comment_quote $string;

DESCRIPTION

       This module contains some functions which are useful for quoting strings which are going to pass through the shell or a shell-like object.

       shell_quote [string]...
	   shell_quote quotes strings so they can be passed through the shell.	Each string is quoted so that the shell will pass it along as a
	   single argument and without further interpretation.	If no strings are given an empty string is returned.

	   If any string can't be safely quoted shell_quote will croak.

       shell_quote_best_effort [string]...
	   This is like shell_quote, excpet if the string can't be safely quoted it does the best it can and returns the result, instead of dying.

       shell_comment_quote [string]
	   shell_comment_quote quotes the string so that it can safely be included in a shell-style comment (the current algorithm is that a sharp
	   character is placed after any newlines in the string).

	   This routine might be changed to accept multiple string arguments in the future.  I haven't done this yet because I'm not sure if the
	   strings should be joined with blanks ($") or nothing ($,).  Cast your vote today!  Be sure to justify your answer.

EXAMPLES

	   $cmd = 'fuser 2>/dev/null ' . shell_quote @files;
	   @pids = split ' ', `$cmd`;

	   print CFG "# Configured by: ",
		       shell_comment_quote($ENV{LOGNAME}), "
";

BUGS

       Only Bourne shell quoting is supported.	I'd like to add other shells (particularly cmd.exe), but I'm not familiar with them.  It would be
       a big help if somebody supplied the details.

AUTHOR

       Roderick Schertler <roderick@argon.org>

SEE ALSO

       perl(1).

perl v5.8.4							    2005-05-03							   ShellQuote(3pm)

SHELL-QUOTE(1)						User Contributed Perl Documentation					    SHELL-QUOTE(1)

NAME

       shell-quote - quote arguments for safe use, unmodified in a shell command

SYNOPSIS

       shell-quote [switch]... arg...

DESCRIPTION

       shell-quote lets you pass arbitrary strings through the shell so that they won't be changed by the shell.  This lets you process commands
       or files with embedded white space or shell globbing characters safely.	Here are a few examples.

EXAMPLES

       ssh preserving args
	   When running a remote command with ssh, ssh doesn't preserve the separate arguments it receives.  It just joins them with spaces and
	   passes them to "$SHELL -c".	This doesn't work as intended:

	       ssh host touch 'hi there'	   # fails

	   It creates 2 files, hi and there.  Instead, do this:

	       cmd=`shell-quote touch 'hi there'`
	       ssh host "$cmd"

	   This gives you just 1 file, hi there.

       process find output
	   It's not ordinarily possible to process an arbitrary list of files output by find with a shell script.  Anything you put in $IFS to
	   split up the output could legitimately be in a file's name.	Here's how you can do it using shell-quote:

	       eval set -- `find -type f -print0 | xargs -0 shell-quote --`

       debug shell scripts
	   shell-quote is better than echo for debugging shell scripts.

	       debug() {
		   [ -z "$debug" ] || shell-quote "debug:" "$@"
	       }

	   With echo you can't tell the difference between "debug 'foo bar'" and "debug foo bar", but with shell-quote you can.

       save a command for later
	   shell-quote can be used to build up a shell command to run later.  Say you want the user to be able to give you switches for a command
	   you're going to run.  If you don't want the switches to be re-evaluated by the shell (which is usually a good idea, else there are
	   things the user can't pass through), you can do something like this:

	       user_switches=
	       while [ $# != 0 ]
	       do
		   case x$1 in
		       x--pass-through)
			   [ $# -gt 1 ] || die "need an argument for $1"
			   user_switches="$user_switches "`shell-quote -- "$2"`
			   shift;;
		       # process other switches
		   esac
		   shift
	       done
	       # later
	       eval "shell-quote some-command $user_switches my args"

OPTIONS

       --debug
	   Turn debugging on.

       --help
	   Show the usage message and die.

       --version
	   Show the version number and exit.

AVAILABILITY

       The code is licensed under the GNU GPL.	Check http://www.argon.org/~roderick/ or CPAN for updated versions.

AUTHOR

       Roderick Schertler <roderick@argon.org>

perl v5.16.3							    2010-06-11							    SHELL-QUOTE(1)