Current File : //proc/thread-self/root/opt/alt/ruby18/share/ri/1.8/system/Shellwords/shellescape-i.yaml

--- !ruby/object:RI::MethodDescription 
aliases: 
- !ruby/object:RI::AliasName 
  name: escape
block_params: 
comment: 
- !ruby/struct:SM::Flow::P 
  body: Escapes a string so that it can be safely used in a Bourne shell command line.
- !ruby/struct:SM::Flow::P 
  body: Note that a resulted string should be used unquoted and is not intended for use in double quotes nor in single quotes.
- !ruby/struct:SM::Flow::VERB 
  body: "  open("| grep #{Shellwords.escape(pattern)} file") { |pipe|\n    # ...\n  }\n"
- !ruby/struct:SM::Flow::P 
  body: +String#shellescape+ is a shorthand for this function.
- !ruby/struct:SM::Flow::VERB 
  body: "  open("| grep #{pattern.shellescape} file") { |pipe|\n    # ...\n  }\n"
full_name: Shellwords#shellescape
is_singleton: false
name: shellescape
params: (str)
visibility: public