ライブラリ
- ビルトイン (24)
-
fiddle
/ import (2) -
irb
/ cmd / nop (2) -
irb
/ ext / use-loader (2) - mkmf (13)
-
net
/ telnet (6) - open3 (3)
- optparse (46)
- pathname (1)
-
rake
/ testtask (2) -
rubygems
/ command (1) - shell (4)
-
shell
/ builtin-command (1) -
shell
/ command-processor (4) -
shell
/ filter (2) -
shell
/ system-command (3) - socket (22)
-
yaml
/ store (1)
クラス
- BasicSocket (2)
-
Gem
:: Command (1) - IO (20)
-
IRB
:: ExtendCommand :: Nop (2) -
Net
:: Telnet (6) - OptionParser (44)
- Pathname (1)
-
Rake
:: TestTask (2) - RubyVM (1)
-
RubyVM
:: InstructionSequence (2) - Shell (4)
-
Shell
:: CommandProcessor (4) -
Shell
:: Filter (2) -
Shell
:: SystemCommand (3) -
Shell
:: Void (1) - Socket (10)
-
YAML
:: Store (1)
モジュール
-
Fiddle
:: Importer (2) - GC (1)
-
IRB
:: ExtendCommandBundle (2) - Kernel (13)
- Open3 (3)
-
OptionParser
:: Arguable (1) -
Socket
:: Constants (10)
キーワード
-
IPPROTO
_ DSTOPTS (2) -
IPPROTO
_ HOPOPTS (2) -
IPV6
_ DSTOPTS (2) -
IPV6
_ HOPOPTS (2) -
IPV6
_ RECVDSTOPTS (2) -
IPV6
_ RECVHOPOPTS (2) -
IPV6
_ RTHDRDSTOPTS (2) -
IP
_ RECVOPTS (2) -
IP
_ RECVRETOPTS (2) -
IP
_ RETOPTS (2) - OptionParser (1)
- accept (2)
-
add
_ option (1) -
alias
_ command (3) - bind (1)
- capture2 (1)
- capture2e (1)
- capture3 (1)
-
check
_ signedness (2) - cmd (2)
-
convertible
_ int (2) -
default
_ argv (1) -
default
_ argv= (1) - disasm (1)
- disassemble (1)
- environment (1)
- execute (2)
- extern (1)
-
for
_ fd (1) - getopts (5)
- help (1)
- irb (1)
-
irb
_ load (1) -
irb
_ require (1) - login (2)
- new (6)
- notify (6)
- on (12)
-
on
_ head (1) -
on
_ tail (1) - open (2)
-
optparse
/ date (1) -
optparse
/ shellwords (1) -
optparse
/ time (1) -
optparse
/ uri (1) - parse (2)
- parse! (1)
- pipe (8)
-
program
_ name (1) -
program
_ name= (1) - readlines (3)
- recvmsg (1)
-
recvmsg
_ nonblock (1) - reject (2)
- release (1)
-
ruby
_ opts (1) -
ruby
_ opts= (1) - separator (1)
-
set
_ encoding (3) - summarize (2)
-
summary
_ indent (1) -
summary
_ indent= (1) -
summary
_ width (1) -
summary
_ width= (1) - system (3)
-
to
_ a (1) -
to
_ s (1) -
try
_ compile (2) -
try
_ cpp (2) -
try
_ do (2) - ver (1)
-
with
_ werror (2) - write (3)
- xsystem (1)
検索結果
先頭5件
-
GC
:: OPTS -> [String] (54322.0) -
コンパイル時に指定したGCのオプションです。
コンパイル時に指定したGCのオプションです。
可能性があるオプション文字列は以下の通りです。
* "GC_DEBUG"
* "USE_RGENGC"
* "RGENGC_DEBUG"
* "RGENGC_CHECK_MODE"
* "RGENGC_PROFILE"
* "RGENGC_ESTIMATE_OLDMALLOC"
* "GC_PROFILE_MORE_DETAIL"
* "GC_ENABLE_LAZY_SWEEP"
* "CALC_EXACT_MALLOC_SIZE"
* "MALLOC_ALLOCATED_SIZE"
* "MALL... -
RubyVM
:: OPTS -> [String] (54304.0) -
RubyVM のビルドオプションの一覧を返します。
RubyVM のビルドオプションの一覧を返します。 -
OptionParser
# getopts(*opts) -> Hash (18625.0) -
引数をパースした結果を、Hash として返します。
引数をパースした結果を、Hash として返します。
配列 argv を与えた場合、argv をパースします。そうでない場合は、
default_argv をパースします。
//emlist[][ruby]{
opt = OptionParser.new
params = opt.getopts(ARGV, "ab:", "foo", "bar:")
# params["a"] = true # -a
# params["b"] = "1" # -b1
# params["foo"] = true # --foo
# params["bar"] = "x" # --bar x... -
OptionParser
# getopts(argv , *opts) -> Hash (18625.0) -
引数をパースした結果を、Hash として返します。
引数をパースした結果を、Hash として返します。
配列 argv を与えた場合、argv をパースします。そうでない場合は、
default_argv をパースします。
//emlist[][ruby]{
opt = OptionParser.new
params = opt.getopts(ARGV, "ab:", "foo", "bar:")
# params["a"] = true # -a
# params["b"] = "1" # -b1
# params["foo"] = true # --foo
# params["bar"] = "x" # --bar x... -
OptionParser
. getopts(*opts) -> Hash (18625.0) -
引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)
引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)
@param argv パースしたい配列を指定します。
@param opts 引数を文字列で指定します。
@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。
@see OptionParser#getopts -
OptionParser
. getopts(argv , *opts) -> Hash (18625.0) -
引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)
引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)
@param argv パースしたい配列を指定します。
@param opts 引数を文字列で指定します。
@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。
@see OptionParser#getopts -
Rake
:: TestTask # ruby _ opts -> Array (18304.0) -
テスト実行時に Ruby コマンドに渡されるオプションを返します。
テスト実行時に Ruby コマンドに渡されるオプションを返します。 -
Rake
:: TestTask # ruby _ opts=(options) (18304.0) -
テスト実行時に Ruby コマンドに渡されるオプションをセットします。
テスト実行時に Ruby コマンドに渡されるオプションをセットします。
@param options 配列でオプションを指定します。 -
OptionParser
:: Arguable # getopts(short _ opt , *long _ opt) -> Hash (18301.0) -
指定された short_opt や long_opt に応じて自身をパースし、結果を Hash として返します。
指定された short_opt や long_opt に応じて自身をパースし、結果を Hash として返します。
コマンドラインに - もしくは -- を指定した場合、それ以降の解析を行ないません。
@param short_opt ショートネームのオプション(-f や -fx)を文字列で指定します。オプションが -f と -x の
2つの場合は "fx" の様に指定します。ここでオプションがないときは空文字列を指定します。
オプションが引数をとる場合は直後に ":" を付けます。
@param long_opt ロン... -
Socket
:: Constants :: IPPROTO _ DSTOPTS -> Integer (18301.0) -
IPv6 destination option。 BasicSocket#getsockopt, BasicSocket#setsockopt の level 引数に使用します。
IPv6 destination option。
BasicSocket#getsockopt, BasicSocket#setsockopt の
level 引数に使用します。
また、Socket.open の protocol 引数に渡す利用法もあります。
@see 2292 -
Socket
:: Constants :: IPPROTO _ HOPOPTS -> Integer (18301.0) -
IPv6 hop-by-hop options。 BasicSocket#getsockopt, BasicSocket#setsockopt の level 引数に使用します。
IPv6 hop-by-hop options。
BasicSocket#getsockopt, BasicSocket#setsockopt の
level 引数に使用します。
また、Socket.open の protocol 引数に渡す利用法もあります。
@see 2292 -
Socket
:: Constants :: IPV6 _ DSTOPTS -> Integer (18301.0) -
Destination options。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Destination options。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IPV6,
ip6(4freebsd), ipv6(7linux),
3542 -
Socket
:: Constants :: IPV6 _ HOPOPTS -> Integer (18301.0) -
Hop-by-hop options。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Hop-by-hop options。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IPV6,
ip6(4freebsd), ipv6(7linux),
3542 -
Socket
:: Constants :: IPV6 _ RECVDSTOPTS -> Integer (18301.0) -
Receive all IP6 options for response。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Receive all IP6 options for response。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IPV6,
3542 -
Socket
:: Constants :: IPV6 _ RECVHOPOPTS -> Integer (18301.0) -
Receive hop-by-hop options。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Receive hop-by-hop options。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IPV6,
3542 -
Socket
:: Constants :: IPV6 _ RTHDRDSTOPTS -> Integer (18301.0) -
Allows removal of sticky destination options header。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Allows removal of sticky destination options header。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IPV6,
3542 -
Socket
:: Constants :: IP _ RECVOPTS -> Integer (18301.0) -
Receive IP destination address with datagram。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Receive IP destination address with datagram。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IP,
ip(7linux) -
Socket
:: Constants :: IP _ RECVRETOPTS -> Integer (18301.0) -
@todo Receive all IP options for response
@todo
Receive all IP options for response -
Socket
:: Constants :: IP _ RETOPTS -> Integer (18301.0) -
IP options to be included in datagrams。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
IP options to be included in datagrams。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IP,
ip(7linux) -
Socket
:: IPPROTO _ DSTOPTS -> Integer (18301.0) -
IPv6 destination option。 BasicSocket#getsockopt, BasicSocket#setsockopt の level 引数に使用します。
IPv6 destination option。
BasicSocket#getsockopt, BasicSocket#setsockopt の
level 引数に使用します。
また、Socket.open の protocol 引数に渡す利用法もあります。
@see 2292 -
Socket
:: IPPROTO _ HOPOPTS -> Integer (18301.0) -
IPv6 hop-by-hop options。 BasicSocket#getsockopt, BasicSocket#setsockopt の level 引数に使用します。
IPv6 hop-by-hop options。
BasicSocket#getsockopt, BasicSocket#setsockopt の
level 引数に使用します。
また、Socket.open の protocol 引数に渡す利用法もあります。
@see 2292 -
Socket
:: IPV6 _ DSTOPTS -> Integer (18301.0) -
Destination options。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Destination options。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IPV6,
ip6(4freebsd), ipv6(7linux),
3542 -
Socket
:: IPV6 _ HOPOPTS -> Integer (18301.0) -
Hop-by-hop options。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Hop-by-hop options。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IPV6,
ip6(4freebsd), ipv6(7linux),
3542 -
Socket
:: IPV6 _ RECVDSTOPTS -> Integer (18301.0) -
Receive all IP6 options for response。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Receive all IP6 options for response。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IPV6,
3542 -
Socket
:: IPV6 _ RECVHOPOPTS -> Integer (18301.0) -
Receive hop-by-hop options。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Receive hop-by-hop options。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IPV6,
3542 -
Socket
:: IPV6 _ RTHDRDSTOPTS -> Integer (18301.0) -
Allows removal of sticky destination options header。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Allows removal of sticky destination options header。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IPV6,
3542 -
Socket
:: IP _ RECVOPTS -> Integer (18301.0) -
Receive IP destination address with datagram。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
Receive IP destination address with datagram。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IP,
ip(7linux) -
Socket
:: IP _ RECVRETOPTS -> Integer (18301.0) -
@todo Receive all IP options for response
@todo
Receive all IP options for response -
Socket
:: IP _ RETOPTS -> Integer (18301.0) -
IP options to be included in datagrams。 BasicSocket#getsockopt, BasicSocket#setsockopt の第2引数(optname)に使用します。
IP options to be included in datagrams。
BasicSocket#getsockopt, BasicSocket#setsockopt
の第2引数(optname)に使用します。
@see Socket::Constants::IPPROTO_IP,
ip(7linux) -
Kernel
# with _ werror(opt , opts = nil) {|opt , opts| . . . } -> object (628.0) -
@todo 内部用?
@todo 内部用?
???
@param opt ????
@param opts ????
@return ブロックを評価した結果を返します。 -
Net
:: Telnet # cmd(opts) -> String (361.0) -
コマンドをホストに送ります。
コマンドをホストに送ります。
より正確にいうと、文字列をホストに送り、プロンプト、もしくは指定した
正規表現にマッチするまでホストからのデータを読み込みます。
ブロックを指定した場合、ホストからの文字列を引数にブロックを逐次実行します。
ホストから受け取った文字列を返します。
opts が文字列であれば、その文字列をホストに送り、
デフォルトオプションでプロンプトを待ちます。
opts がハッシュである場合には、送る文字列とオプションを指定することができます。
その場合には以下の
"String" 送る文字列です。必ず指定する必要があります。
"Match" ホストからのデータを... -
Net
:: Telnet # cmd(opts) {|mesg| . . . } -> String (361.0) -
コマンドをホストに送ります。
コマンドをホストに送ります。
より正確にいうと、文字列をホストに送り、プロンプト、もしくは指定した
正規表現にマッチするまでホストからのデータを読み込みます。
ブロックを指定した場合、ホストからの文字列を引数にブロックを逐次実行します。
ホストから受け取った文字列を返します。
opts が文字列であれば、その文字列をホストに送り、
デフォルトオプションでプロンプトを待ちます。
opts がハッシュである場合には、送る文字列とオプションを指定することができます。
その場合には以下の
"String" 送る文字列です。必ず指定する必要があります。
"Match" ホストからのデータを... -
Net
:: Telnet # login(opts , password=nil) -> String (361.0) -
指定したユーザ名とパスワードでログインします。
指定したユーザ名とパスワードでログインします。
opts が文字列である場合は、 それをユーザ名、passwordをパスワードと
してログインします。
opts がハッシュである場合には、"Name" と "Password" をキーとする文字列を
ユーザ名、パスワードとしてログインします。
また、opts がハッシュの場合には以下のオプションが利用できます。
"LoginPrompt" ログインプロンプトを正規表現で指定します。
デフォルト値は /[Ll]ogin[: ]*\z/n です。
"PasswordPrompt" パスワード入力プロンプトを正規表現で指定します。
デフォルト値... -
Net
:: Telnet # login(opts , password=nil) {|mesg| . . . } -> String (361.0) -
指定したユーザ名とパスワードでログインします。
指定したユーザ名とパスワードでログインします。
opts が文字列である場合は、 それをユーザ名、passwordをパスワードと
してログインします。
opts がハッシュである場合には、"Name" と "Password" をキーとする文字列を
ユーザ名、パスワードとしてログインします。
また、opts がハッシュの場合には以下のオプションが利用できます。
"LoginPrompt" ログインプロンプトを正規表現で指定します。
デフォルト値は /[Ll]ogin[: ]*\z/n です。
"PasswordPrompt" パスワード入力プロンプトを正規表現で指定します。
デフォルト値... -
IO
. readlines(path , limit , opts={}) -> [String] (346.0) -
path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。
path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。
Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。
テキスト読み込みメソッドとして動作します。
limit で最大読み込みバイト数を指定します。ただしマルチバイト文字が途中で
切れないように余分に読み込む場合があります。
opts でファイルを開くときのオプションを指定します。エンコーディングなど
を指定できます。
File.open と同様なのでそちらを参照してください。
@param path ファイル名を表す文字列か "|コ... -
IO
. readlines(path , rs = $ / , opts={}) -> [String] (346.0) -
path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。
path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。
Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。
テキスト読み込みメソッドとして動作します。
limit で最大読み込みバイト数を指定します。ただしマルチバイト文字が途中で
切れないように余分に読み込む場合があります。
opts でファイルを開くときのオプションを指定します。エンコーディングなど
を指定できます。
File.open と同様なのでそちらを参照してください。
@param path ファイル名を表す文字列か "|コ... -
IO
. readlines(path , rs , limit , opts={}) -> [String] (346.0) -
path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。
path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。
Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。
テキスト読み込みメソッドとして動作します。
limit で最大読み込みバイト数を指定します。ただしマルチバイト文字が途中で
切れないように余分に読み込む場合があります。
opts でファイルを開くときのオプションを指定します。エンコーディングなど
を指定できます。
File.open と同様なのでそちらを参照してください。
@param path ファイル名を表す文字列か "|コ... -
Net
:: Telnet . new(opts) -> Net :: Telnet (343.0) -
Telnet オブジェクトを生成します。
Telnet オブジェクトを生成します。
このときリモートホストへの接続も行います("Proxy"を指定しない場合)。
opts には Telnet オブジェクトに設定する以下のオプションをハッシュで指定します。
オプションは省略時にはそれぞれ右に示すデフォルト値が適用されます。
"Host" => "localhost"
"Port" => 23
"Prompt" => /[$%#>] \z/n
"Timeout" => 10 # 接続待ちタイムアウト値(sec)
"Waittime" => 0 # Prompt を待ち合わせる... -
Net
:: Telnet . new(opts) {|message| . . . } -> Net :: Telnet (343.0) -
Telnet オブジェクトを生成します。
Telnet オブジェクトを生成します。
このときリモートホストへの接続も行います("Proxy"を指定しない場合)。
opts には Telnet オブジェクトに設定する以下のオプションをハッシュで指定します。
オプションは省略時にはそれぞれ右に示すデフォルト値が適用されます。
"Host" => "localhost"
"Port" => 23
"Prompt" => /[$%#>] \z/n
"Timeout" => 10 # 接続待ちタイムアウト値(sec)
"Waittime" => 0 # Prompt を待ち合わせる... -
BasicSocket
# recvmsg(maxmesglen=nil , flags=0 , maxcontrollen=nil , opts={}) -> [String , Addrinfo , Integer , *Socket :: AncillaryData] (340.0) -
recvmsg(2) を用いてメッセージを受け取ります。
recvmsg(2) を用いてメッセージを受け取ります。
このメソッドはブロックします。ノンブロッキング方式で通信したい
場合は BasicSocket#recvmsg_nonblock を用います。
maxmesglen, maxcontrollen で受け取るメッセージおよび補助データ
(Socket::AncillaryData)の最大長をバイト単位で指定します。
省略した場合は必要なだけ内部バッファを拡大して
データが切れないようにします。
flags では Socket::MSG_* という名前の定数の biwsise OR を取った
ものを渡します。
opts にはその他... -
Fiddle
:: Importer # bind(signature , *opts) { . . . } -> Fiddle :: Function (340.0) -
Ruby のブロックを C の関数で wrap し、その関数をモジュールに インポートします。
Ruby のブロックを C の関数で wrap し、その関数をモジュールに
インポートします。
これでインポートされた関数はモジュール関数として定義されます。
また、Fiddle::Importer#[] で Fiddle::Function オブジェクトとして
取り出すことができます。
signature で関数の名前とシネグチャを指定します。例えば
"int compare(void*, void*)" のように指定します。
opts には :stdcall もしくは :cdecl を渡すことができ、
呼出規約を明示することができます。
@return インポートした関数を表す ... -
Fiddle
:: Importer # extern(signature , *opts) -> Fiddle :: Function (340.0) -
Fiddle::Importer#dlload で取り込んだライブラリから C の関数をインポートします。
Fiddle::Importer#dlload で取り込んだライブラリから
C の関数をインポートします。
インポートした関数はそのモジュールにモジュール関数として定義されます。
signature で関数の名前とシネグチャを指定します。例えば
"int strcmp(char*, char*)" のように指定することができます。
opts には :stdcall もしくは :cdecl を渡すことができ、
呼出規約を明示することができます。
@return インポートした関数を表す Fiddle::Function オブジェクトを返します。
@param signature 関数... -
IO
. for _ fd(fd , mode = "r" , **opts) -> IO (331.0) -
オープン済みのファイルディスクリプタ fd に対する新しい IO オブジェクトを生成して返します。
オープン済みのファイルディスクリプタ fd に対する新しい
IO オブジェクトを生成して返します。
IO.open にブロックが与えられた場合、IO オブジェクトを生成しそれを引数としてブロックを
実行します。ブロックの終了とともに fd はクローズされます。ブロックの結果を返します。
IO.new, IO.for_fd はブロックを受け付けません。
=== キーワード引数
このメソッドは以下のキーワード引数を利用できます。
* :mode mode引数と同じ意味です
* :external_encoding 外部エンコーディング。"-" はデフォルト外部エンコーディングの
... -
IO
. new(fd , mode = "r" , **opts) -> IO (331.0) -
オープン済みのファイルディスクリプタ fd に対する新しい IO オブジェクトを生成して返します。
オープン済みのファイルディスクリプタ fd に対する新しい
IO オブジェクトを生成して返します。
IO.open にブロックが与えられた場合、IO オブジェクトを生成しそれを引数としてブロックを
実行します。ブロックの終了とともに fd はクローズされます。ブロックの結果を返します。
IO.new, IO.for_fd はブロックを受け付けません。
=== キーワード引数
このメソッドは以下のキーワード引数を利用できます。
* :mode mode引数と同じ意味です
* :external_encoding 外部エンコーディング。"-" はデフォルト外部エンコーディングの
... -
IO
. open(fd , mode = "r" , **opts) -> IO (331.0) -
オープン済みのファイルディスクリプタ fd に対する新しい IO オブジェクトを生成して返します。
オープン済みのファイルディスクリプタ fd に対する新しい
IO オブジェクトを生成して返します。
IO.open にブロックが与えられた場合、IO オブジェクトを生成しそれを引数としてブロックを
実行します。ブロックの終了とともに fd はクローズされます。ブロックの結果を返します。
IO.new, IO.for_fd はブロックを受け付けません。
=== キーワード引数
このメソッドは以下のキーワード引数を利用できます。
* :mode mode引数と同じ意味です
* :external_encoding 外部エンコーディング。"-" はデフォルト外部エンコーディングの
... -
IO
. open(fd , mode = "r" , **opts) {|io| . . . } -> object (331.0) -
オープン済みのファイルディスクリプタ fd に対する新しい IO オブジェクトを生成して返します。
オープン済みのファイルディスクリプタ fd に対する新しい
IO オブジェクトを生成して返します。
IO.open にブロックが与えられた場合、IO オブジェクトを生成しそれを引数としてブロックを
実行します。ブロックの終了とともに fd はクローズされます。ブロックの結果を返します。
IO.new, IO.for_fd はブロックを受け付けません。
=== キーワード引数
このメソッドは以下のキーワード引数を利用できます。
* :mode mode引数と同じ意味です
* :external_encoding 外部エンコーディング。"-" はデフォルト外部エンコーディングの
... -
IO
. pipe(enc _ str , **opts) -> [IO] (331.0) -
pipe(2) を実行して、相互につながった2つの IO オブジェクトを要素とする配列を返します。
pipe(2) を実行して、相互につながった2つの
IO オブジェクトを要素とする配列を返します。
戻り値の配列は最初の要素が読み込み側で、次の要素が書き込み側です。
ブロックが渡された場合は、そのブロックに2つの IO オブジェクトが渡され、
ブロックの返り値がこのメソッドの返り値となります。
ブロック終了時に IO オブジェクトがもし close されていないならば
close します(close されていてるオブジェクトはそのままです)。
得られる2つの IO オブジェクトのエンコーディングを引数で指定することが
できます。
@param enc_str 読み込み側の外部エンコ... -
IO
. pipe(enc _ str , **opts) {|read _ io , write _ io| . . . } -> object (331.0) -
pipe(2) を実行して、相互につながった2つの IO オブジェクトを要素とする配列を返します。
pipe(2) を実行して、相互につながった2つの
IO オブジェクトを要素とする配列を返します。
戻り値の配列は最初の要素が読み込み側で、次の要素が書き込み側です。
ブロックが渡された場合は、そのブロックに2つの IO オブジェクトが渡され、
ブロックの返り値がこのメソッドの返り値となります。
ブロック終了時に IO オブジェクトがもし close されていないならば
close します(close されていてるオブジェクトはそのままです)。
得られる2つの IO オブジェクトのエンコーディングを引数で指定することが
できます。
@param enc_str 読み込み側の外部エンコ... -
IO
. pipe(ext _ enc , int _ enc , **opts) -> [IO] (331.0) -
pipe(2) を実行して、相互につながった2つの IO オブジェクトを要素とする配列を返します。
pipe(2) を実行して、相互につながった2つの
IO オブジェクトを要素とする配列を返します。
戻り値の配列は最初の要素が読み込み側で、次の要素が書き込み側です。
ブロックが渡された場合は、そのブロックに2つの IO オブジェクトが渡され、
ブロックの返り値がこのメソッドの返り値となります。
ブロック終了時に IO オブジェクトがもし close されていないならば
close します(close されていてるオブジェクトはそのままです)。
得られる2つの IO オブジェクトのエンコーディングを引数で指定することが
できます。
@param enc_str 読み込み側の外部エンコ... -
IO
. pipe(ext _ enc , int _ enc , **opts) {|read _ io , write _ io| . . . } -> object (331.0) -
pipe(2) を実行して、相互につながった2つの IO オブジェクトを要素とする配列を返します。
pipe(2) を実行して、相互につながった2つの
IO オブジェクトを要素とする配列を返します。
戻り値の配列は最初の要素が読み込み側で、次の要素が書き込み側です。
ブロックが渡された場合は、そのブロックに2つの IO オブジェクトが渡され、
ブロックの返り値がこのメソッドの返り値となります。
ブロック終了時に IO オブジェクトがもし close されていないならば
close します(close されていてるオブジェクトはそのままです)。
得られる2つの IO オブジェクトのエンコーディングを引数で指定することが
できます。
@param enc_str 読み込み側の外部エンコ... -
Kernel
# with _ werror(opt , opts = nil) {|opt| . . . } -> object (328.0) -
@todo 内部用?
@todo 内部用?
???
@param opt ????
@param opts ????
@return ブロックを評価した結果を返します。 -
IO
# set _ encoding(enc _ str , **opts) -> self (325.0) -
IO のエンコーディングを設定します。
IO のエンコーディングを設定します。
引数が "A:B" のようにコロンで区切られた文字列の場合は、
A を外部エンコーディング、 B を内部エンコーディングに指定します。
引数が一つで、上のような形式でない場合には、
それが外部エンコーディングと見なされます。
引数が2つの場合はそのそれぞれを外部エンコーディング、内部エンコーディング
に設定します。
キーワード引数で外部エンコーディングを内部エンコーディングに変換する際の
オプションを指定します。
詳しくは String#encode を参照してください。
@param enc_str エンコーディングを表す文字列を指定します... -
IO
# set _ encoding(ext _ enc , int _ enc , **opts) -> self (325.0) -
IO のエンコーディングを設定します。
IO のエンコーディングを設定します。
引数が "A:B" のようにコロンで区切られた文字列の場合は、
A を外部エンコーディング、 B を内部エンコーディングに指定します。
引数が一つで、上のような形式でない場合には、
それが外部エンコーディングと見なされます。
引数が2つの場合はそのそれぞれを外部エンコーディング、内部エンコーディング
に設定します。
キーワード引数で外部エンコーディングを内部エンコーディングに変換する際の
オプションを指定します。
詳しくは String#encode を参照してください。
@param enc_str エンコーディングを表す文字列を指定します... -
IO
. write(path , string , **opts) -> Integer (325.0) -
path で指定されるファイルを開き、string を書き込み、 閉じます。
path で指定されるファイルを開き、string を書き込み、
閉じます。
Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドを実行し、コマンドの出力を標準出力に書き込みます。
offset を指定するとその位置までシークします。
offset を指定しないと、書き込みの末尾でファイルを
切り捨てます。
キーワード引数はファイルを開くときに使われ、エンコーディングなどを指定することができます。
詳しくは IO.open を見てください。
@param path ファイル名文字列
@param string 書き込む文字列
@param of... -
IO
. write(path , string , offset=nil , **opts) -> Integer (325.0) -
path で指定されるファイルを開き、string を書き込み、 閉じます。
path で指定されるファイルを開き、string を書き込み、
閉じます。
Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドを実行し、コマンドの出力を標準出力に書き込みます。
offset を指定するとその位置までシークします。
offset を指定しないと、書き込みの末尾でファイルを
切り捨てます。
キーワード引数はファイルを開くときに使われ、エンコーディングなどを指定することができます。
詳しくは IO.open を見てください。
@param path ファイル名文字列
@param string 書き込む文字列
@param of... -
Kernel
# try _ do(src , command , *opts) -> () (325.0) -
@param src C プログラムのソースコードを指定します。
@param src C プログラムのソースコードを指定します。
@param command コマンドを指定します。
@param opts オプションを Hash で指定します。
@raise RuntimeError 開発環境がインストールされていない場合に発生します。
@see Kernel#xsystem -
Kernel
# try _ do(src , command , *opts) { . . . } -> () (325.0) -
@param src C プログラムのソースコードを指定します。
@param src C プログラムのソースコードを指定します。
@param command コマンドを指定します。
@param opts オプションを Hash で指定します。
@raise RuntimeError 開発環境がインストールされていない場合に発生します。
@see Kernel#xsystem -
Shell
:: CommandProcessor . alias _ command(alias , command , *opts) -> self (325.0) -
@todo
@todo
@param alias エイリアスの名前を指定します。
@param command コマンド名を指定します。
@param opts コマンドに与えるオプションを指定します。
@raise SyntaxError コマンドのエイリアス作成に失敗した時に発生します。 -
Shell
:: CommandProcessor . alias _ command(alias , command , *opts) { . . . } -> self (325.0) -
@todo
@todo
@param alias エイリアスの名前を指定します。
@param command コマンド名を指定します。
@param opts コマンドに与えるオプションを指定します。
@raise SyntaxError コマンドのエイリアス作成に失敗した時に発生します。 -
Shell
:: SystemCommand # notify(*opts) -> String (325.0) -
@todo
@todo
@param opts
@see Shell#notify -
Shell
:: SystemCommand # notify(*opts) {|message| . . . } -> String (325.0) -
@todo
@todo
@param opts
@see Shell#notify -
BasicSocket
# recvmsg _ nonblock(maxmesglen=nil , flags=0 , maxcontrollen=nil , opts={}) -> [String , Addrinfo , Integer , *Socket :: AncillaryData] (322.0) -
recvmsg(2) を用いてノンブロッキング方式でメッセージを受け取ります。
recvmsg(2) を用いてノンブロッキング方式でメッセージを受け取ります。
ブロッキングの有無以外は BasicSocket#recvmsg と同じです。
詳しくはそちらを参照してください。
@param maxmesglen 受け取るメッセージの最大長
@param flags フラグ
@param maxcontrollen 受け取る補助データの最大長
@param opts ハッシュオプション -
Gem
:: Command # add _ option(*opts) {|value , options| . . . } (322.0) -
コマンドに対するコマンドラインオプションとハンドラを追加します。
コマンドに対するコマンドラインオプションとハンドラを追加します。
ブロックには、コマンドライン引数の値とそのオプションが渡されます。
オプションはハッシュになっています。
@param opts オプションを指定します。
@see OptionParser#make_switch -
IRB
:: ExtendCommand :: Nop # execute(*opts) -> () (322.0) -
何もしません。サブクラスでオーバーライドして使用します。
何もしません。サブクラスでオーバーライドして使用します。
@param opts irb 中でコマンドに渡す引数を指定します。 -
IRB
:: ExtendCommand :: Nop . execute(conf , *opts) -> () (322.0) -
コマンドを実行します。ユーザが直接使用するものではありません。
コマンドを実行します。ユーザが直接使用するものではありません。
@param conf IRB::Context オブジェクトを指定します。
@param opts irb 中でコマンドに渡す引数を指定します。 -
Kernel
# xsystem(command , opts = nil) -> () (322.0) -
Kernel.#system と同じですが、コマンドの出力は(標準出力、標準エラー 出力ともに)ログファイルに出力します。ログファイル名は mkmf.log です。
Kernel.#system と同じですが、コマンドの出力は(標準出力、標準エラー
出力ともに)ログファイルに出力します。ログファイル名は mkmf.log です。
@param command コマンドを指定します。
@param opts オプションを Hash で指定します。
:werror というキーに真を指定すると
@see Kernel.#system -
Pathname
# write(string , offset=nil , **opts) -> Integer (322.0) -
IO.write(self.to_s, string, offset, **opts)と同じです。
@see IO.write -
Shell
# system(command , *opts) -> Shell :: SystemCommand (322.0) -
command を実行する.
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 -
Shell
. alias _ command(alias , command , *opts) { . . . } -> self (322.0) -
コマンドの別名(エイリアス)を作成します。 コマンドが無い場合は、Shell.def_system_command などであらかじめ作成します.
コマンドの別名(エイリアス)を作成します。
コマンドが無い場合は、Shell.def_system_command などであらかじめ作成します.
@param alias エイリアスの名前を文字列で指定します.
@param command コマンド名を文字列で指定します.
@param opts command で指定したコマンドのオプションを指定します.
使用例: ls -la | sort -k 5 のような例。
require 'shell'
Shell.def_system_command("ls")
Shell.alias_command("lsla", "... -
Shell
:: CommandProcessor # system(command , *opts) -> Shell :: SystemCommand (322.0) -
command を実行する.
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 -
Shell
:: Filter # system(command , *opts) -> Shell :: SystemCommand (322.0) -
command を実行する.
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 -
Shell
:: SystemCommand . new(sh , command , *opts) (322.0) -
@todo
@todo
@param sh
@param command
@param opts -
YAML
:: Store . new(file _ name , yaml _ opts = {}) -> YAML :: Store (322.0) -
自身を初期化します。
自身を初期化します。
@param file_name 格納先のファイル名。ファイルがない場合は作成します。既
にファイルが存在する場合はその内容を読み込みます。
@param yaml_opts YAML 出力時のオプションを Hash で指定します。
詳しくは Psych.dump を参照してください。 -
Kernel
# check _ signedness(type , headers = nil , opts = nil) -> "signed" | "unsigned" | nil (307.0) -
Returns the signedness of the given +type+. You may optionally specify additional +headers+ to search in for the +type+. If the +type+ is found and is a numeric type, a macro is passed as a preprocessor constant to the compiler using the +type+ name, in uppercase, prepended with 'SIGNEDNESS_OF_', followed by the +type+ name, followed by '=X' where 'X' is positive integer if the +type+ is unsigned, or negative integer if the +type+ is signed. For example, if size_t is defined as unsigned, then check_signedness('size_t') would returned +1 and the SIGNEDNESS_OF_SIZE_T=+1 preprocessor macro would be passed to the compiler, and SIGNEDNESS_OF_INT=-1 if check_signedness('int') is done.
Returns the signedness of the given +type+. You may optionally
specify additional +headers+ to search in for the +type+.
If the +type+ is found and is a numeric type, a macro is passed as a
preprocessor constant to the compiler using the +type+ name, in
uppercase, prepended with 'SIGNEDNESS... -
Kernel
# check _ signedness(type , headers = nil , opts = nil) { . . . } -> "signed" | "unsigned" | nil (307.0) -
Returns the signedness of the given +type+. You may optionally specify additional +headers+ to search in for the +type+. If the +type+ is found and is a numeric type, a macro is passed as a preprocessor constant to the compiler using the +type+ name, in uppercase, prepended with 'SIGNEDNESS_OF_', followed by the +type+ name, followed by '=X' where 'X' is positive integer if the +type+ is unsigned, or negative integer if the +type+ is signed. For example, if size_t is defined as unsigned, then check_signedness('size_t') would returned +1 and the SIGNEDNESS_OF_SIZE_T=+1 preprocessor macro would be passed to the compiler, and SIGNEDNESS_OF_INT=-1 if check_signedness('int') is done.
Returns the signedness of the given +type+. You may optionally
specify additional +headers+ to search in for the +type+.
If the +type+ is found and is a numeric type, a macro is passed as a
preprocessor constant to the compiler using the +type+ name, in
uppercase, prepended with 'SIGNEDNESS... -
Kernel
# convertible _ int(type , headers = nil , opts = nil) (307.0) -
Returns the convertible integer type of the given +type+. You may optionally specify additional +headers+ to search in for the +type+. _Convertible_ means actually same type, or typedefed from same type. If the +type+ is a integer type and _convertible_ type is found, following macros are passed as preprocessor constants to the compiler using the +type+ name, in uppercase. * 'TYPEOF_', followed by the +type+ name, followed by '=X' where 'X' is the found _convertible_ type name. * 'TYP2NUM' and 'NUM2TYP, where 'TYP' is the +type+ name in uppercase with replacing '_t' suffix with 'T', followed by '=X' where 'X' is the macro name to convert +type+ to +Integer+ object, and vice versa. For example, if foobar_t is defined as unsigned long, then convertible_int("foobar_t") would return "unsigned long", and define macros: #define TYPEOF_FOOBAR_T unsigned long #define FOOBART2NUM ULONG2NUM #define NUM2FOOBART NUM2ULONG
Returns the convertible integer type of the given +type+. You may
optionally specify additional +headers+ to search in for the +type+.
_Convertible_ means actually same type, or typedefed from same type.
If the +type+ is a integer type and _convertible_ type is found,
following macros are p... -
Kernel
# convertible _ int(type , headers = nil , opts = nil) { . . . } (307.0) -
Returns the convertible integer type of the given +type+. You may optionally specify additional +headers+ to search in for the +type+. _Convertible_ means actually same type, or typedefed from same type. If the +type+ is a integer type and _convertible_ type is found, following macros are passed as preprocessor constants to the compiler using the +type+ name, in uppercase. * 'TYPEOF_', followed by the +type+ name, followed by '=X' where 'X' is the found _convertible_ type name. * 'TYP2NUM' and 'NUM2TYP, where 'TYP' is the +type+ name in uppercase with replacing '_t' suffix with 'T', followed by '=X' where 'X' is the macro name to convert +type+ to +Integer+ object, and vice versa. For example, if foobar_t is defined as unsigned long, then convertible_int("foobar_t") would return "unsigned long", and define macros: #define TYPEOF_FOOBAR_T unsigned long #define FOOBART2NUM ULONG2NUM #define NUM2FOOBART NUM2ULONG
Returns the convertible integer type of the given +type+. You may
optionally specify additional +headers+ to search in for the +type+.
_Convertible_ means actually same type, or typedefed from same type.
If the +type+ is a integer type and _convertible_ type is found,
following macros are p... -
Kernel
# try _ compile(src , opt = "" , *opts) -> bool (307.0) -
与えられた C のソースコードがコンパイルできた場合は真を返します。 コンパイルできなかった場合は偽を返します。
与えられた C のソースコードがコンパイルできた場合は真を返します。
コンパイルできなかった場合は偽を返します。
ブロックを与えた場合、そのブロックはコンパイル前に評価されます。
ブロック内でソースコードを変更することができます。
@param src C のソースコードを指定します。
@param opt コンパイラに渡すオプションを指定します。
$CFLAGS もコンパイラには渡されます。 -
Kernel
# try _ compile(src , opt = "" , *opts) { . . . } -> bool (307.0) -
与えられた C のソースコードがコンパイルできた場合は真を返します。 コンパイルできなかった場合は偽を返します。
与えられた C のソースコードがコンパイルできた場合は真を返します。
コンパイルできなかった場合は偽を返します。
ブロックを与えた場合、そのブロックはコンパイル前に評価されます。
ブロック内でソースコードを変更することができます。
@param src C のソースコードを指定します。
@param opt コンパイラに渡すオプションを指定します。
$CFLAGS もコンパイラには渡されます。 -
Kernel
# try _ cpp(src , opt = "" , *opts) -> bool (307.0) -
C プログラムのソースコード src をプリプロセスします。
C プログラムのソースコード src をプリプロセスします。
$CPPFLAGS, $CFLAGS の値もプリプロセッサにコマンドライン引数
として渡します。
このメソッドはヘッダファイルの存在チェックなどに使用します。
@param src C プログラムのソースコードを指定します。
@param opt プリプロセッサにコマンドライン引数として渡す値を指定します。
@return 問題なくプリプロセスできたら true を返します。
プリプロセスに失敗したら false を返します。
例:
require 'mkmf'
if try_cpp("#in... -
Kernel
# try _ cpp(src , opt = "" , *opts) { . . . } -> bool (307.0) -
C プログラムのソースコード src をプリプロセスします。
C プログラムのソースコード src をプリプロセスします。
$CPPFLAGS, $CFLAGS の値もプリプロセッサにコマンドライン引数
として渡します。
このメソッドはヘッダファイルの存在チェックなどに使用します。
@param src C プログラムのソースコードを指定します。
@param opt プリプロセッサにコマンドライン引数として渡す値を指定します。
@return 問題なくプリプロセスできたら true を返します。
プリプロセスに失敗したら false を返します。
例:
require 'mkmf'
if try_cpp("#in... -
IRB
:: ExtendCommandBundle # irb _ load(*opts , &b) -> nil (304.0) -
現在の irb に関する IRB::Context に対して irb_load コマンドを実行 します。
現在の irb に関する IRB::Context に対して irb_load コマンドを実行
します。
@see IRB::ExtendCommand::Load#execute -
IRB
:: ExtendCommandBundle # irb _ require(*opts , &b) -> bool (304.0) -
現在の irb に関する IRB::Context に対して irb_require コマンドを 実行します。
現在の irb に関する IRB::Context に対して irb_require コマンドを
実行します。
@see IRB::ExtendCommand::Require#execute -
Shell
# notify(*opts) { . . . } -> () (304.0) -
@todo
@todo -
Shell
. notify(*opts) {|message| . . . } -> String (304.0) -
@todo
@todo -
Shell
:: CommandProcessor # notify(*opts) { . . . } -> () (304.0) -
@todo
@todo -
Shell
:: Filter # notify(*opts) { . . . } -> () (304.0) -
@todo
@todo -
Shell
:: Void . new(sh , *opts) (304.0) -
-
OptionParser
# on _ tail(*arg , &block) -> self (181.0) -
オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。
オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。
--version や --help の説明をサマリの最後に表示したい時に便利です。
@param arg OptionParser#on と同様です。
@param block OptionParser#on と同様です。
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tai... -
OptionParser
# summary _ indent -> String (181.0) -
サマリを表示する時のインデントを文字列で返します。
サマリを表示する時のインデントを文字列で返します。
@return サマリを表示する時のインデントを文字列で返します。
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end
opts.summary_indent # => " "
opts.summarize
# => [" -i,... -
OptionParser
# summary _ indent=(indent) (181.0) -
サマリを表示する時のインデントを文字列で指定します。
サマリを表示する時のインデントを文字列で指定します。
@param indent サマリを表示する時に使われるインデントを文字列で指定します。
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end
opts.summary_indent # => " "
opts.summarize
# ... -
OptionParser
# summary _ width -> Integer (181.0) -
サマリを表示するときの幅を整数で返します。
サマリを表示するときの幅を整数で返します。
@return サマリを表示するときの幅を整数で返します。
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end
opts.summary_width # => 32
opts.summarize
# => [" -i, --init\n", " ... -
OptionParser
# summary _ width=(width) (181.0) -
サマリを表示するときの幅を整数で指定します。
サマリを表示するときの幅を整数で指定します。
@param width サマリを表示するときの幅を整数で指定します。
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end
opts.summary_width # => 32
opts.summarize
# => [" -i, --init\n"... -
OptionParser
# separator(sep) -> () (163.0) -
サマリにオプションを区切るための文字列 sep を挿入します。 オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。
サマリにオプションを区切るための文字列 sep を挿入します。
オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。
サマリには on メソッドを呼んだ順にオプションが表示されるので、区切りを挿入したい
ところでこのメソッドを呼びます。
@param sep サマリの区切りを文字列で指定します。
//emlist[][ruby]{
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"
opts.separator ""
opts.separator... -
OptionParser
# ver -> String (145.0) -
program_name、version と release から生成したバージョンを表す文字列を返します。
program_name、version と release から生成したバージョンを表す文字列を返します。
//emlist[例][ruby]{
require "optparse"
OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"
opts.program_name = "Optparse Example"
opts.version = [0, 1]
opts.release = "2019-05-01"
opts.on_tail("--version", "Show v... -
OptionParser
# default _ argv=(argv) (127.0) -
自身がデフォルトでパースする引数を文字列の配列で指定します。
自身がデフォルトでパースする引数を文字列の配列で指定します。
OptionParser#parse の引数が指定されなかったときに使われます。
@param argv デフォルトでパースしたい文字列の配列を指定します。
//emlist[例][ruby]{
require "optparse"
config = {}
opts = OptionParser.new
opts.on("-r", "--require LIBRARY"){|lib| config[:lib] = lib }
# パラメーター指定なしで実行
opts.default_argv # => []
opts.p... -
OptionParser
# parse!(argv = self . default _ argv) -> [String] (127.0) -
与えられた argv をパースします。
与えられた argv をパースします。
OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。
@param argv パースしたい引数を文字列の配列で指定します。
@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
... -
OptionParser
# summarize(to = [] , width = self . summary _ width , max = width - 1 , indent= self . summary _ indent) -> () (127.0) -
サマリを指定された to へと加えていきます。
サマリを指定された to へと加えていきます。
ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。
@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。
@param width サマリの幅を整数で指定します。
@param max サマリの最大幅を整数で指定します。
@param indent サマリのインデントを文字列で指定します。
//emlist[例][ruby]{
requ... -
OptionParser
# summarize(to = [] , width = self . summary _ width , max = width - 1 , indent= self . summary _ indent) {|line| . . . } -> () (127.0) -
サマリを指定された to へと加えていきます。
サマリを指定された to へと加えていきます。
ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。
@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。
@param width サマリの幅を整数で指定します。
@param max サマリの最大幅を整数で指定します。
@param indent サマリのインデントを文字列で指定します。
//emlist[例][ruby]{
requ... -
OptionParser
# on _ head(*arg , &block) -> self (109.0) -
オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。
オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。
@param arg OptionParser#on と同様です。
@param block OptionParser#on と同様です。
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end
puts opts.help
# => ...