From 6be866e2621c543b710da3ece25d32ce861ece02 Mon Sep 17 00:00:00 2001 From: drbrain Date: Mon, 3 Oct 2011 23:23:24 +0000 Subject: [PATCH] * lib/shellwords.rb: Update toplevel comment with an example. Patch by Samnang Chhun. [Ruby 1.9 - Bug #5388] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33392 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- ChangeLog | 5 +++++ lib/shellwords.rb | 24 +++++++++++++++--------- 2 files changed, 20 insertions(+), 9 deletions(-) diff --git a/ChangeLog b/ChangeLog index c3a8b5f156..a557a572e4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Tue Oct 4 08:21:51 2011 Eric Hodel + + * lib/shellwords.rb: Update toplevel comment with an example. Patch + by Samnang Chhun. [Ruby 1.9 - Bug #5388] + Tue Oct 4 08:15:50 2011 Eric Hodel * proc.c (proc_call): Update documentation to match argument handling diff --git a/lib/shellwords.rb b/lib/shellwords.rb index f1300612bb..5d6ba7544e 100644 --- a/lib/shellwords.rb +++ b/lib/shellwords.rb @@ -1,7 +1,5 @@ -# -# shellwords.rb: Manipulates strings a la UNIX Bourne shell -# - +## +# = Manipulates strings like the UNIX Bourne shell # # This module manipulates strings according to the word parsing rules # of the UNIX Bourne shell. @@ -9,13 +7,21 @@ # The shellwords() function was originally a port of shellwords.pl, # but modified to conform to POSIX / SUSv3 (IEEE Std 1003.1-2001). # -# Authors: -# - Wakou Aoyama -# - Akinori MUSHA +# == Example # -# Contact: -# - Akinori MUSHA (current maintainer) +# argv = Shellwords.split('here are "two words"') # or String#shellsplit +# argv #=> ["here", "are", "two words"] # +# argv = Shellwords.escape("special's.txt") # or String#shellescape +# system("cat " + argv) +# +# == Authors: +# * Wakou Aoyama +# * Akinori MUSHA +# +# == Contact: +# * Akinori MUSHA (current maintainer) + module Shellwords # # Splits a string into an array of tokens in the same way the UNIX