-- shell.rb
				$Release Version: 0.6.0 $
			   	$Revision: 11708 $
			   	$Date: 2007-02-13 08:01:19 +0900 (Tue, 13 Feb 2007) $
			   	by Keiju ISHITSUKA(keiju@ishitsuka.com)

=begin

= Ū

rubysh/cshΤ褦˥ޥɤμ¹Եڤӥե륿󥰤ڤ˹Ԥ.
sh/cshʸrubyεǽѤƼ¸.

= ʥ饹

== Shell

Shell֥Ȥϥȥǥ쥯ȥ, ޥɼ¹ԤϤ
Хѥˤʤޤ.

--- Shell#cwd
--- Shell#dir
--- Shell#getwd
--- Shell#pwd

      ȥǥ쥯ȥ֤

--- Shell#system_path

      ޥɥѥ֤

--- Shell#umask

      umask֤

== Filter

ޥɤμ¹Է̤Ϥ٤FilterȤƤޤ. Enumerableinclude
Ƥޤ.

= ʥ᥽åɰ

== ޥ

OSΥޥɤ¹ԤˤϤޤ, ShellΥ᥽åɤȤޤ.

) ޥɤʤȤľܼ¹ԤǤShell#systemޥɤ⤢ޤ.

--- Shell.def_system_command(command, path = command)

      ShellΥ᥽åɤȤcommandϿޤ. 

      )
      Shell.def_system_command "ls"
        ls 

      Shell.def_system_command "sys_sort", "sort"
        sortޥɤsys_sortȤ

--- Shell.undef_system_command(command)

      commandޤ.

--- Shell.alias_command(ali, command, *opts) {...}

      commandalias򤷤ޤ. 

      )
        Shell.alias_command "lsC", "ls", "-CBF", "--show-control-chars"
        Shell.alias_command("lsC", "ls"){|*opts| ["-CBF", "--show-control-chars", *opts]}

--- Shell.unalias_command(ali)

      commandaliasޤ.

--- Shell.install_system_commands(pre = "sys_")

      system_pathˤƤμ¹ԲǽեShell. ᥽
      ̾ϸΥե̾ƬpreĤΤȤʤ.

== 

--- Shell.new

      ץΥȥǥ쥯ȥ򥫥ȥǥ쥯ȥȤShell
      ֥Ȥޤ.

--- Shell.cd(path)

      path򥫥ȥǥ쥯ȥȤShell֥Ȥޤ.

== ץ

--- Shell#jobs

      塼󥰤Ƥjobΰ֤.

--- Shell#kill sig, job

      job˥ʥsig

== ȥǥ쥯ȥ

--- Shell#cd(path, &block)
--- Shell#chdir

      ȥǥ쥯ȥpathˤ. ƥ졼ȤƸƤФ줿Ȥˤ
      ֥å¹Τߥȥǥ쥯ȥѹ.

--- Shell#pushd(path = nil, &block)
--- Shell#pushdir

      ȥǥ쥯ȥǥ쥯ȥꥹåˤĤ, ȥǥ쥯
      ȥpathˤ. pathά줿Ȥˤ, ȥǥ쥯ȥ
      ǥ쥯ȥꥹåΥȥåפ򴹤. ƥ졼ȤƸƤФ줿
      ˤ, ֥å¹Τpushd.

--- Shell#popd
--- Shell#popdir

      ǥ쥯ȥꥹåݥåפ, 򥫥ȥǥ쥯ȥˤ.

== ե/ǥ쥯ȥ

--- Shell#foreach(path = nil, &block)

      pathեʤ, File#foreach
      pathǥ쥯ȥʤ, Dir#foreach

--- Shell#open(path, mode)

      pathեʤ, File#open
      pathǥ쥯ȥʤ, Dir#open

--- Shell#unlink(path)

      pathեʤ, File#unlink
      pathǥ쥯ȥʤ, Dir#unlink

--- Shell#test(command, file1, file2)
--- Shell#[command, file1, file2]

      եƥȴؿtestƱ. 
      )
          sh[?e, "foo"]
          sh[:e, "foo"]
          sh["e", "foo"]
          sh[:exists?, "foo"]
          sh["exists?", "foo"]

--- Shell#mkdir(*path)

      Dir.mkdirƱ(ʣ)

--- Shell#rmdir(*path)

      Dir.rmdirƱ(ʣ)

== ޥɼ¹

--- System#system(command, *opts)

      command¹Ԥ.
      )
        print sh.system("ls", "-l")
        sh.system("ls", "-l") | sh.head > STDOUT

--- System#rehash

      ϥå夹

--- Shell#transact &block

      ֥åǤshellselfȤƼ¹Ԥ.
      )
        sh.transact{system("ls", "-l") | head > STDOUT}

--- Shell#out(dev = STDOUT, &block)

      transactƤӽФη̤dev˽Ϥ.

== ޥ

--- Shell#echo(*strings)
--- Shell#cat(*files)
--- Shell#glob(patten)
--- Shell#tee(file)

      ϼ¹Ԥ, ƤȤFilter֥Ȥ֤ޤ. 

--- Filter#each &block

      ե륿ΰԤĤblockϤ.

--- Filter#<(src)

      srcե륿ϤȤ. src, ʸʤХե, IOǤ
      Ф򤽤ΤޤϤȤ.

--- Filter#>(to)

      srcե륿νϤȤ. to, ʸʤХե, IOǤ
      Ф򤽤Τޤ޽ϤȤ.

--- Filter#>>(to)

      srcե륿ɲä. to, ʸʤХե, IOǤ
      򤽤Τޤ޽ϤȤ.

--- Filter#|(filter)

      ѥ׷

--- Filter#+(filter)

      filter1 + filter2  filter1νϤθ, filter2νϤԤ.

--- Filter#to_a
--- Filter#to_s

== ȹߥޥ

--- Shell#atime(file)
--- Shell#basename(file, *opt)
--- Shell#chmod(mode, *files)
--- Shell#chown(owner, group, *file)
--- Shell#ctime(file)
--- Shell#delete(*file)
--- Shell#dirname(file)
--- Shell#ftype(file)
--- Shell#join(*file)
--- Shell#link(file_from, file_to)
--- Shell#lstat(file)
--- Shell#mtime(file)
--- Shell#readlink(file)
--- Shell#rename(file_from, file_to)
--- Shell#split(file)
--- Shell#stat(file)
--- Shell#symlink(file_from, file_to)
--- Shell#truncate(file, length)
--- Shell#utime(atime, mtime, *file)

      File饹ˤƱ̾Υ饹᥽åɤƱǤ.

--- Shell#blockdev?(file)
--- Shell#chardev?(file)
--- Shell#directory?(file)
--- Shell#executable?(file)
--- Shell#executable_real?(file)
--- Shell#exist?(file)/Shell#exists?(file)
--- Shell#file?(file)
--- Shell#grpowned?(file)
--- Shell#owned?(file)
--- Shell#pipe?(file)
--- Shell#readable?(file)
--- Shell#readable_real?(file)
--- Shell#setgid?(file)
--- Shell#setuid?(file)
--- Shell#size(file)/Shell#size?(file)
--- Shell#socket?(file)
--- Shell#sticky?(file)
--- Shell#symlink?(file)
--- Shell#writable?(file)
--- Shell#writable_real?(file)
--- Shell#zero?(file)

      FileTest饹ˤƱ̾Υ饹᥽åɤƱǤ.

--- Shell#syscopy(filename_from, filename_to)
--- Shell#copy(filename_from, filename_to)
--- Shell#move(filename_from, filename_to)
--- Shell#compare(filename_from, filename_to)
--- Shell#safe_unlink(*filenames)
--- Shell#makedirs(*filenames)
--- Shell#install(filename_from, filename_to, mode)

      FileTools饹ˤƱ̾Υ饹᥽åɤƱǤ.

      ¾, ʲΤΤꥢƤޤ.

--- Shell#cmp	<- Shell#compare
--- Shell#mv	<- Shell#move
--- Shell#cp	<- Shell#copy
--- Shell#rm_f	<- Shell#safe_unlink
--- Shell#mkpath	<- Shell#makedirs

= ץ

== ex1

  sh = Shell.cd("/tmp")
  sh.mkdir "shell-test-1" unless sh.exists?("shell-test-1")
  sh.cd("shell-test-1")
  for dir in ["dir1", "dir3", "dir5"]
    if !sh.exists?(dir)
      sh.mkdir dir
      sh.cd(dir) do
	f = sh.open("tmpFile", "w")
	f.print "TEST\n"
	f.close
      end
      print sh.pwd
    end
  end

== ex2

  sh = Shell.cd("/tmp")
  sh.transact do
    mkdir "shell-test-1" unless exists?("shell-test-1")
    cd("shell-test-1")
    for dir in ["dir1", "dir3", "dir5"]
      if !exists?(dir)
	mkdir dir
	cd(dir) do
	  f = open("tmpFile", "w")
	  f.print "TEST\n"
	  f.close
	end
	print pwd
      end
    end
  end

== ex3

  sh.cat("/etc/printcap") | sh.tee("tee1") > "tee2"
  (sh.cat < "/etc/printcap") | sh.tee("tee11") > "tee12"
  sh.cat("/etc/printcap") | sh.tee("tee1") >> "tee2"
  (sh.cat < "/etc/printcap") | sh.tee("tee11") >> "tee12"

== ex4

  print sh.cat("/etc/passwd").head.collect{|l| l =~ /keiju/}

=end