Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > shellライブラリ > Shellクラス

class Shell

クラスの継承リスト: Shell < Shell::Error < Object < Kernel
extend: Exception2MessageMapper

要約

Shell オブジェクトはカレントディレクトリを持ち, コマンド実行はそこからの相対パスになります.

目次

特異メソッド

alias_command cascade cascade= cd debug debug? debug= def_system_command default_record_separator default_record_separator= default_system_path default_system_path= install_system_commands new notify unalias_command undef_system_command verbose verbose? verbose=

インスタンスメソッド

[] test append atime basename blockdev? cat cd chdir chardev? check_point finish_all_jobs chmod chown cmp compare command_processor concat copy cp ctime cwd dir getwd pwd debug debug? debug= delete rm dir_stack dirs directory? dirname echo executable? executable_real? exist? exists? expand_path file? find_system_command foreach ftype glob grpowned? identical? install jobs join kill link lstat makedirs mkpath mkdir move mv mtime notify open out owned? pipe? popd popdir process_controller pushd pushdir readable? readable_real? readlink record_separator record_separator= rehash rename rm_f safe_unlink rmdir setgid? setuid? size size? socket? split stat sticky? symlink symlink? syscopy system system_path system_path= tee transact truncate umask umask= unlink utime verbose verbose? verbose= writable? writable_real? zero?

特異メソッド

alias_command(alias, command, *opts) {...} -> self[permalink][rdoc]

コマンドの別名(エイリアス)を作成します。 コマンドが無い場合は、Shell.def_system_command などであらかじめ作成します.

[PARAM] alias:

エイリアスの名前を文字列で指定します.

[PARAM] command:

コマンド名を文字列で指定します.

[PARAM] opts:

command で指定したコマンドのオプションを指定します.

使用例: ls -la | sort -k 5 のような例。

Shell.def_system_command("ls")
Shell.alias_command("lsla", "ls", "-a", "-l")
Shell.def_system_command("sort")
sh = Shell.new
sh.transact {
  (lsla | sort("-k 5")).each {|l|
    puts l
  }
}

cascade -> bool[permalink][rdoc]

[TODO]

cascade=(flag)[permalink][rdoc]

[TODO]

cd(path = nil) -> self[permalink][rdoc]

pathをカレントディレクトリとするShellオブジェクトを生成します.

[PARAM] path:

カレントディレクトリとするディレクトリを文字列で指定します。

使用例

require 'shell'
sh = Shell.new
sh.cd("/tmp")

debug -> bool | Integer[permalink][rdoc]

debug? -> bool | Integer

[TODO]

デバッグ用フラグを参照します。

debug=(val)[permalink][rdoc]

デバッグ用のフラグを設定します。

[PARAM] val:

bool 値や整数値を指定します。詳細は下記を参照してください。

# debug: true -> normal debug
# debug: 1    -> eval definition debug
# debug: 2    -> detail inspect debug

def_system_command(command, path = command) -> nil[permalink][rdoc]

Shell のメソッドとして command を登録します.

OS上のコマンドを実行するにはまず, Shellのメソッドとして定義します. 注) コマンドを定義しなくとも直接実行できる Shell#system コマンドもあります.

[PARAM] command:

Shell のメソッドとして定義するコマンドを文字列で指定します。

[PARAM] path:

command のパスを指定します。 指定しない場合はcommand と同じになります。

例)

Shell.def_system_command "ls"
# ls を定義

Shell.def_system_command "sys_sort", "sort"
# sortコマンドをsys_sortとして定義

sh = Shell.new
sh.transact {
  ls.each { |l|
    puts l
  }
  (ls("-l") | sys_sort("-k 5")).each {|l|
    puts l
  }
}

default_record_separator -> String[permalink][rdoc]

default_record_separator=(rs)

執筆者募集

Shell で用いられる入力レコードセパレータを表す文字列を設定および参照します。 なにも指定しない場合は$/ の値が用いられます。

[PARAM] rs:

Shell で用いられる入力レコードセパレータを表す文字列を指定します。

default_system_path -> Array[permalink][rdoc]

default_system_path=(path)

Shellでもちいられるコマンドを検索する対象のパスを設定および、参照します。

[PARAM] path:

Shellでもちいられるコマンドを検索する対象のパスを文字列で指定します。

動作例

require 'shell'
p Shell.default_system_path
# 例
#=> [ "/opt/local/bin", "/opt/local/sbin", "/usr/bin", "/bin", "/usr/sbin", "/sbin", "/usr/local/bin", "/usr/X11/bin", "/Users/kouya/bin"]
Shell.default_system_path = ENV["HOME"] + "/bin"
p Shell.default_system_path
# => "/Users/kouya/bin"

install_system_commands(pre = "sys_") -> ()[permalink][rdoc]

system_path上にある全ての実行可能ファイルをShellに定義する. メソッ ド名は元のファイル名の頭にpreをつけたものとなる.

[PARAM] pre:

Shellに定義するメソッド名の先頭に付加される文字列を指定します。

使用例: ls -l | head -n 5 のような例。

Shell.install_system_commands
sh = Shell.new
sh.verbose = false
sh.transact {
  (sys_ls("-l") | sys_head("-n 5")).each {|l|
    puts l
  }
}

new -> Shell[permalink][rdoc]

プロセスのカレントディレクトリをカレントディレクトリとするShellオ ブジェクトを生成します.

使用例：カレントディレクトリを表示

sh = Shell.new
puts sh.pwd.to_s

notify(*opts) {|message| ... } -> String[permalink][rdoc]

[TODO]

unalias_command(alias) -> ()[permalink][rdoc]

commandのaliasを削除します.

[PARAM] alias:

削除したいエイリアスの名前を文字列で指定します。

[EXCEPTION] NameError:

alias で指定したコマンドが無い場合に発生します。

使用例: ls -la | sort -k 5 のような例。

Shell.def_system_command("ls")
Shell.alias_command("lsla", "ls", "-a", "-l")
Shell.def_system_command("sort")
sh = Shell.new
sh.transact {
  (lsla | sort("-k 5")).each {|l|
    puts l
  }
}
Shell.unalias_command("lsla")
begin
  Shell.unalias_command("lsla")
rescue NameError => err
  puts err
end

undef_system_command(command) -> Shell::CommandProcessor[permalink][rdoc]

commandを削除します.

[PARAM] command:

削除するコマンドの文字列を指定します。

動作例：

Shell.def_system_command("ls")
# ls を定義
Shell.undef_system_command("ls")
# ls を 削除

sh = Shell.new
begin
  sh.transact {
    ls("-l").each {|l|
      puts l
    }
  }
rescue NameError => err
  puts err
end

verbose -> bool[permalink][rdoc]

verbose? -> bool

[TODO]

verbose=(flag)[permalink][rdoc]

true ならば冗長な出力の設定を行います。

[PARAM] flag:

true ならば冗長な出力の設定を行います。

インスタンスメソッド

test(command, file1, file2 = nil) -> bool | Time | Integer | nil[permalink][rdoc]

self[command, file1, file2 = nil] -> bool | Time | Integer | nil

Kernel.#test や FileTest のメソッドに処理を委譲します。

[PARAM] command:

数値、またはサイズが 1 の文字列の場合は Kernel.#test に処理委譲します。 2 文字以上の文字列の場合は FileTest のメソッドとして実行します。

[PARAM] file1:

文字列でファイルへのパスを指定します。

[PARAM] file2:

文字列でファイルへのパスを指定します。

require 'shell'
Shell.verbose = false
sh = Shell.new
begin
  sh.mkdir("foo")
rescue
end
p sh[?e, "foo"]         # => true
p sh[:e, "foo"]         # => true
p sh["e", "foo"]        # => true
p sh[:exists?, "foo"]   # => true
p sh["exists?", "foo"]  # => true

[SEE_ALSO] Kernel.#test, FileTest

append(to, filter) -> Shell::AppendFile | Shell::AppendIO[permalink][rdoc]

[TODO]

[PARAM] to:

文字列か IO を指定します。

[PARAM] filter:

Shell::Filter のインスタンスをしています。

atime(filename) -> Time[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] File.atime

basename(filename, suffix = "") -> String[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[PARAM] suffix:

サフィックスを文字列で与えます。'.*' という文字列を与えた場合、'*' はワイルドカードとして働き '.' を含まない任意の文字列にマッチします。

[SEE_ALSO] File.basename

blockdev?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#blockdev?

cat(*files) -> Shell::Filter[permalink][rdoc]

実行すると, それらを内容とする Filter オブジェクトを返します.

[PARAM] files:

シェルコマンド cat に与えるファイル名を文字列で指定します。

動作例

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
sh.transact {
  glob("*.txt").to_a.each { |file|
    file.chomp!
    cat(file).each { |l|
      echo(l) | tee(file + ".tee") >> "all.tee"
    }
  }
}

cd(path, &block) -> self[permalink][rdoc]

chdir(path, &block) -> self

カレントディレクトリをpathにする. イテレータとして呼ばれたときには ブロック実行中のみカレントディレクトリを変更する.

[PARAM] path:

カレントディレクトリを文字列で指定します.

[PARAM] block:

path で指定したディレクトリで行う操作をブロックで指定します.

使用例

require 'shell'
sh = Shell.new
sh.transact {
  cd("/tmp"){
    p cwd #=> "/tmp"
  }
  p cwd #=> "/Users/kouya/rbmanual"
}

chardev?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#chardev?

check_point[permalink][rdoc]

finish_all_jobs

[TODO]

chmod(mode, *filename) -> Integer[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[PARAM] mode:

chmod(2) と同様に整数で指定します。

[SEE_ALSO] File.chmod

chown(owner, group, *filename) -> Integer[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] owner:

chown(2) と同様に数値で指定します。nil または -1 を指定することで、オーナーを現在の>ままにすることができます。

[PARAM] group:

chown(2) と同様に数値で指定します。nil または -1 を指定することで、グループを現在の>ままにすることができます。

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.chown

compare(file1, file2) -> bool[permalink][rdoc]

cmp(file1, file2) -> bool

File クラスにある同名のクラスメソッドと同じです.

[PARAM] file1:

ファイルの名前を文字列で与えます。

[PARAM] file2:

新しいファイル名を文字列で与えます。

[SEE_ALSO] File.compare

command_processor -> Shell::CommandProcessor[permalink][rdoc]

[TODO]

concat(*jobs) -> Shell::Concat[permalink][rdoc]

[TODO]

copy(from, to) -> bool[permalink][rdoc]

cp(from, to) -> bool

File クラスにある同名のクラスメソッドと同じです.

[PARAM] from:

ファイルの名前を文字列で与えます。

[PARAM] to:

新しいファイル名を文字列で与えます。

[SEE_ALSO] File.copy

ctime(filename) -> Time[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] File.ctime

cwd -> String[permalink][rdoc]

dir -> String

getwd -> String

pwd -> String

カレントディレクトリのパスを文字列で返します。

使用例

require 'shell'
sh = Shell.new
p sh.cwd
# 例
#=> "/Users/kouya/tall"

debug -> bool | Integer[permalink][rdoc]

debug? -> bool | Integer

[TODO]

debug=(flag)[permalink][rdoc]

[TODO]

delete(*filename) -> Integer[permalink][rdoc]

rm(*filename) -> Integer

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.delete

dirs -> [String][permalink][rdoc]

dir_stack -> [String]

[TODO]

directory?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#directory?

dirname(filename) -> String[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.dirname

echo(*strings) -> Shell::Filter[permalink][rdoc]

実行すると, それらを内容とする Filter オブジェクトを返します.

[PARAM] strings:

シェルコマンド echo に与える引数を文字列で指定します。

動作例

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
sh.transact {
  glob("*.txt").to_a.each { |file|
    file.chomp!
    cat(file).each { |l|
      echo(l) | tee(file + ".tee") >> "all.tee"
    }
  }
}

executable?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#executable?

executable_real?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#executable_real?

exist?(file) -> bool[permalink][rdoc]

exists?(file) -> bool

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#exist? FileTest.#exists?

expand_path(path) -> String[permalink][rdoc]

Fileクラスにある同名のクラスメソッドと同じです.

[PARAM] path:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.expand_path

file?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#file?

find_system_command(command)[permalink][rdoc]

[TODO]

foreach(path = nil, &block) -> ()[permalink][rdoc]

pathがファイルなら, File#foreach pathがディレクトリなら, Dir#foreach の動作をします。

[PARAM] path:

ファイルもしくはディレクトリのパスを文字列で指定します。

使用例

require 'shell'
Shell.verbose = false
sh = Shell.new
sh.foreach("/tmp"){|f|
  puts f
}

ftype(filename) -> String[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.ftype

glob(patten) -> Shell::Filter[permalink][rdoc]

実行すると, それらを内容とする Filter オブジェクトを返します.

[PARAM] patten:

シェルコマンド glob に与えるパターンを指定します。 パターンの書式については、Dir.[]を参照してください。

動作例

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
sh.transact {
  glob("*.txt").to_a.each { |file|
    file.chomp!
    cat(file).each { |l|
      echo(l) | tee(file + ".tee") >> "all.tee"
    }
  }
}

[SEE_ALSO] Dir.[]

grpowned?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#grpowned?

identical?[permalink][rdoc]

[TODO]

install(from, to, mode = nil, verbose = false) -> ()[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] from:

コピー元のファイル。

[PARAM] to:

コピー先のファイル。

[PARAM] mode:

ファイルのアクセスモード。8進数で指定します。

[PARAM] verbose:

真を指定すると詳細を表示します。

[SEE_ALSO] File.install

jobs -> Array[permalink][rdoc]

スケジューリングされているjobの一覧を返します。

join(*item) -> String[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] item:

連結したいディレクトリ名やファイル名を文字列で与えます。

[SEE_ALSO] File.join

kill(signal, job) -> Integer[permalink][rdoc]

[TODO]

ジョブにシグナルを送ります。

[PARAM] signal:

[PARAM] job:

link(old, new) -> 0[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] old:

ファイル名を表す文字列を指定します。

[PARAM] new:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.link

lstat(filename) -> File::Stat[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.lstat

makedirs(*dirs) -> Array[permalink][rdoc]

mkpath(*dirs) -> Array

File クラスにある同名のクラスメソッドと同じです.

[PARAM] dirs:

作成するディレクトリを指定します。

[SEE_ALSO] File.makedirs

mkdir(*path) -> Array[permalink][rdoc]

Dir.mkdirと同じです。 (複数可)

[PARAM] path:

作成するディレクトリ名を文字列で指定します。

[RETURN]

作成するディレクトリの一覧の配列を返します。

使用例

require 'shell'
Shell.verbose = false
sh = Shell.new
begin
  p sh.mkdir("foo") #=> ["foo"]
rescue => err
  puts err
end

move(from, to) -> bool[permalink][rdoc]

mv(from, to) -> bool

File クラスにある同名のクラスメソッドと同じです.

[PARAM] from:

ファイルの名前を文字列で与えます。

[PARAM] to:

新しいファイル名を文字列で与えます。

[SEE_ALSO] File.move

mtime(filename) -> Time[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] File.mtime

notify(*opts) { ... } -> ()[permalink][rdoc]

[TODO]

open(path, mode) -> File | Dir[permalink][rdoc]

path がファイルなら、 File.open path がディレクトリなら、 Dir.open の動作をします。

[PARAM] path:

開きたいパスを指定します。

[PARAM] mode:

アクセスモードを指定します。path がディレクトリの場合は無視されます。

[SEE_ALSO] File.open, Dir.open

out(dev = STDOUT, &block) -> ()[permalink][rdoc]

Shell#transact を呼び出しその結果を dev に出力します。

[PARAM] dev:

出力先をIO オブジェクトなどで指定します。

[PARAM] block:

transact 内部で実行するシェルを指定します。

使用例:

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
File.open("out.txt", "w"){ |fp|
  sh.out(fp) {
    system("ls", "-l") | head("-n 3")
  }
}

owned?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#owned?

pipe?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#pipe?

popd -> ()[permalink][rdoc]

popdir -> ()

ディレクトリスタックからポップし, それをカレントディレクトリにする.

動作例

require 'shell'
Shell.verbose = false
sh = Shell.new
sh.pushd("/tmp")
p sh.cwd #=> "/tmp"
sh.pushd("/usr")
p sh.cwd #=> "/usr"
sh.popd
p sh.cwd #=> "/tmp"

process_controller -> Shell::ProcessController[permalink][rdoc]

[TODO]

pushd(path = nil, &block) -> object[permalink][rdoc]

pushdir(path = nil, &block) -> object

カレントディレクトリをディレクトリスタックにつみ, カレントディレク トリをpathにする. pathが省略されたときには, カレントディレクトリと ディレクトリスタックのトップを交換する. イテレータとして呼ばれたと きには, ブロック実行中のみpushdする.

[PARAM] path:

カレントディレクトリをpathにする。文字列で指定します。

[PARAM] block:

イテレータとして呼ぶ場合, ブロックを指定します。

動作例

require 'shell'
Shell.verbose = false
sh = Shell.new
sh.pushd("/tmp")
p sh.cwd #=> "/tmp"
sh.pushd("/usr")
p sh.cwd #=> "/usr"
sh.popd
p sh.cwd #=> "/tmp"
sh.pushd("/usr/local"){
  p sh.cwd #=> "/usr/local"
}
p sh.cwd #=> "/tmp"

readable?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#readable?

readable_real?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#readable_real?

readlink(path) -> String[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] path:

シンボリックリンクを表す文字列を指定します。

[SEE_ALSO] File.readlink

record_separator -> String[permalink][rdoc]

[TODO]

record_separator=(rs)[permalink][rdoc]

[TODO]

rehash -> {}[permalink][rdoc]

登録されているシステムコマンドの情報をクリアします。 通常、使うことはありません。

rename(from, to) -> 0[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] from:

ファイルの名前を文字列で与えます。

[PARAM] to:

新しいファイル名を文字列で与えます。

[SEE_ALSO] File.rename

safe_unlink(*filenames) -> Array[permalink][rdoc]

rm_f(*filenames) -> Array

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filenames:

削除するファイルを指定します。

[SEE_ALSO] File.safe_unlink

rmdir(*path) -> ()[permalink][rdoc]

Dir.rmdirと同じです。 (複数可)

[PARAM] path:

削除するディレクトリ名を文字列で指定します。

setgid?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#setgid?

setuid?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#setuid?

size(file) -> Integer[permalink][rdoc]

size?(file) -> Integer | nil

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#size FileTest.#size?

socket?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#socket?

split(pathname) -> [String][permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] pathname:

パス名を表す文字列を指定します。

[SEE_ALSO] File.split

stat(filename) -> File::Stat[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.stat

sticky?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#sticky?

symlink(old, new) -> 0[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] old:

ファイル名を表す文字列を指定します。

[PARAM] new:

シンボリックリンクを表す文字列を指定します。

[SEE_ALSO] File.symlink

symlink?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#symlink?

syscopy(from, to) -> bool[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] from:

ファイルの名前を文字列で与えます。

[PARAM] to:

新しいファイル名を文字列で与えます。

[SEE_ALSO] File.syscopy

system(command, *opts) -> Shell::SystemCommand[permalink][rdoc]

command を実行する.

[PARAM] command:

実行するコマンドのパスを文字列で指定します。

[PARAM] opts:

command のオプションを文字列で指定します。複数可。

使用例:

require 'shell'
Shell.verbose = false
sh = Shell.new

print sh.system("ls", "-l")
Shell.def_system_command("head")
sh.system("ls", "-l") | sh.head("-n 3") > STDOUT

system_path -> Array[permalink][rdoc]

system_path=(path)

コマンドサーチパスの配列を返す。

[PARAM] path:

コマンドサーチパスの配列を指定します。

使用例

require 'shell'
sh = Shell.new
sh.system_path = [ "./" ]
p sh.system_path #=> ["./"]

tee(file) -> Shell::Filter[permalink][rdoc]

実行すると, それらを内容とする Filter オブジェクトを返します.

[PARAM] file:

シェルコマンドtee に与えるファイル名を文字列で指定します。

動作例

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
sh.transact {
  glob("*.txt").to_a.each { |file|
    file.chomp!
    cat(file).each { |l|
      echo(l) | tee(file + ".tee") >> "all.tee"
    }
  }
}

transact { ... } -> object[permalink][rdoc]

ブロック中で shell を self として実行します。

例:

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
sh.transact{
  system("ls", "-l") | head > STDOUT
  # transact の中では、
  # sh.system("ls", "-l") | sh.head > STDOUT と同じとなる。
}

truncate(path, length) -> 0[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] path:

パスを表す文字列を指定します。

[PARAM] length:

変更したいサイズを整数で与えます。

[SEE_ALSO] File.truncate

umask -> object[permalink][rdoc]

[TODO]

umaskを返します。

umask=(umask)[permalink][rdoc]

[TODO]

unlink(path) -> self[permalink][rdoc]

path がファイルなら File.unlink、path がディレクトリなら Dir.unlink の動作をします。

[PARAM] path:

削除したいパスを指定します。

[SEE_ALSO] File.unlink, Dir.unlink

utime(atime, mtime, *filename) -> Integer[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[PARAM] atime:

最終アクセス時刻を Time か、起算時からの経過秒数を数値で指定します。

[PARAM] utime:

更新時刻を Time か、起算時からの経過秒数を数値で指定します。

[SEE_ALSO] File.utime

verbose -> bool[permalink][rdoc]

verbose? -> bool

[TODO]

verbose=(flag)[permalink][rdoc]

[TODO]

writable?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#writable?

writable_real?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#writable_real?

zero?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#zero?