<h2>Edit File: shell-quote</h2><form method="post"><textarea name="content" rows="20" cols="80">#!/usr/bin/perl -w
use strict;

# $Id: shell-quote,v 1.3 2010-06-11 20:00:24 roderick Exp $
#
# Roderick Schertler &lt;roderick@argon.org&gt;

# Copyright (C) 1999 Roderick Schertler
#
# 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 2 of the License, or (at
# your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# For a copy of the GNU General Public License write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

use String::ShellQuote	qw(shell_quote);

(my $Me		= $0 ne &#039;-e&#039; ? $0 : $^X) =~ s-.*/--;
my $Debug	= 0;
my $Exit	= 0;
my $Version	= q$Revision: 1.3 $ =~ /(\d\S+)/ ? $1 : &#039;?&#039;;

my @Option_spec = (
    &#039;debug!&#039;	=&gt; \$Debug,
    &#039;help!&#039;	=&gt; sub { usage() },
    &#039;version&#039;	=&gt; sub { print &quot;$Me version $Version\n&quot;; exit },
);

my $Usage = &lt;&lt;EOF;
usage: $Me [switch]...
switches:
    --debug	turn debugging on
    --help	show this and then die
    --version	show the version ($Version) and exit
Use \`perldoc $Me\&#039; to see the full documentation.
EOF

sub debug {
    print STDERR &quot;debug: &quot;, @_, &quot;\n&quot; if $Debug;
}

sub usage {
    warn &quot;$Me: &quot;, @_ if @_;
    # Use exit() rather than die(), as Getopt::Long does eval().
    print STDERR $Usage;
    exit 1;
}

# This is basically Getopt::Long but it has the defaults set up the way I
# think they should be.

sub getopt {
    # Don&#039;t bother if there aren&#039;t any switches.  This test works because
    # I&#039;m setting $REQUIRE_ORDER.
    return 1 unless @ARGV &amp;&amp; substr($ARGV[0], 0, 1) eq &#039;-&#039;;

    my $bundling = 0;
    if (@_ &amp;&amp; ($_[0] eq -bundle || $_[0] eq -bundling)) {
	$bundling = 1;
	shift;
    }

    {
	# I&#039;m setting this environment variable when loading Getopt::Long
	# so that the defaults for options added later (which aren&#039;t set
	# explicitly below) are more likely to match what I&#039;d like.
	local $ENV{POSIXLY_CORRECT} = 1;
	require Getopt::Long;
    }

    Getopt::Long-&gt;VERSION(2.19);
    Getopt::Long::Configure(
	&#039;no_auto_abbrev&#039;,
	&#039;no_getopt_compat&#039;,
	&#039;require_order&#039;,
	$bundling ? &#039;bundling&#039; : (),
	&#039;no_ignore_case&#039;,
	&#039;prefix_pattern=(--|-)&#039;,
    ) if 1;

    # The getopt function puts the vars into its caller&#039;s package so
    # it&#039;s necessary to jump to it so that its caller is my caller.
    #goto &amp;Getopt::Long::GetOptions;
    Getopt::Long::GetOptions(@_);
}

sub init {
    getopt -bundle, @Option_spec or usage if @ARGV;
}

sub main {
    init;
    print shell_quote(@ARGV), &quot;\n&quot;
	if @ARGV;
    return 0;
}

$Exit = main || $Exit;
$Exit = 1 if $Exit &amp;&amp; !($Exit % 256);
exit $Exit;

__END__

=head1 NAME

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

=head1 SYNOPSIS

B&lt;shell-quote&gt; [I&lt;switch&gt;]... I&lt;arg&gt;...

=head1 DESCRIPTION

B&lt;shell-quote&gt; lets you pass arbitrary strings through the shell so that
they won&#039;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.

=head1 EXAMPLES

=over

=item B&lt;ssh preserving args&gt;

When running a remote command with ssh, ssh doesn&#039;t preserve the separate
arguments it receives.  It just joins them with spaces and passes them to
C&lt;$SHELL -c&gt;.  This doesn&#039;t work as intended:

    ssh host touch &#039;hi there&#039;		# fails

It creates 2 files, F&lt;hi&gt; and F&lt;there&gt;.  Instead, do this:

    cmd=`shell-quote touch &#039;hi there&#039;`
    ssh host &quot;$cmd&quot;

This gives you just 1 file, F&lt;hi there&gt;.

=item B&lt;process find output&gt;

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

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

=item B&lt;debug shell scripts&gt;

B&lt;shell-quote&gt; is better than B&lt;echo&gt; for debugging shell scripts.

    debug() {
    	[ -z &quot;$debug&quot; ] || shell-quote &quot;debug:&quot; &quot;$@&quot;
    }

With B&lt;echo&gt; you can&#039;t tell the difference between C&lt;debug &#039;foo bar&#039;&gt;
and C&lt;debug foo bar&gt;, but with B&lt;shell-quote&gt; you can.

=item B&lt;save a command for later&gt;

B&lt;shell-quote&gt; 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&#039;re going to run.  If you don&#039;t want the switches to be re-evaluated
by the shell (which is usually a good idea, else there are things the
user can&#039;t pass through), you can do something like this:

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

=back

=head1 OPTIONS

=over 4

=item B&lt;--debug&gt;

Turn debugging on.

=item B&lt;--help&gt;

Show the usage message and die.

=item B&lt;--version&gt;

Show the version number and exit.

=back

=head1 AVAILABILITY

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

=head1 AUTHOR

Roderick Schertler &lt;roderick@argon.org&gt;

=cut
</textarea><br><input type="hidden" name="edit_file" value="shell-quote"><input type="submit" value="Save"></form>