クラス
- OptionParser (516)
-
OptionParser
:: ParseError (48)
モジュール
キーワード
- accept (12)
-
default
_ argv (12) -
default
_ argv= (12) - environment (12)
- getopts (36)
- load (12)
- on (144)
-
on
_ head (12) -
on
_ tail (12) - order (48)
- order! (24)
- parse! (12)
- permute (24)
- permute! (12)
-
program
_ name= (12) - reason= (12)
- recover (12)
- reject (12)
- release= (12)
- separator (12)
-
set
_ backtrace (12) -
set
_ option (12) - summarize (24)
-
summary
_ indent= (12) -
summary
_ width= (12) - version= (12)
検索結果
先頭5件
-
OptionParser
# on _ tail(*arg , &block) -> self (9115.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
# => Usage: test......[options]
# -i, --init
# -u, --update
# -h, --help
//}
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new
opts.on_tail("-h", "--help", "Show this message") do
puts opts
exit
end
opts.on_tail("--version", "Show version") do
puts OptionParser::Version.join('.')
exit
en......d
//}
@see OptionParser#on, OptionParser#on_head... -
OptionParser
# permute!(argv = self . default _ argv , into: nil) -> [String] (9115.0) -
与えられた argv を破壊的にパースします。argv からオプションがすべて取り除かれます。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv を返します。
...が
できます。
@param argv パースしたい引数を文字列の配列で指定します。
@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロ......@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。
//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new
opt.on('-a......[VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }
opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile -b
:a
:b
["somefile"]... -
OptionParser
# permute(*args) -> [String] (9115.0) -
与えられた argv をパースします。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。
...@param argv パースしたい引数を文字列の配列で指定します。
@param args パースしたい引数を順に文字列として与えます。
@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser......::ParseError のサブク
ラスになります。
//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new
opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }
opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile -b
:a
:b
["somefile... -
OptionParser
# permute(argv) -> [String] (9115.0) -
与えられた argv をパースします。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。
...@param argv パースしたい引数を文字列の配列で指定します。
@param args パースしたい引数を順に文字列として与えます。
@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser......::ParseError のサブク
ラスになります。
//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new
opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }
opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile -b
:a
:b
["somefile... -
OptionParser
# permute!(argv = self . default _ argv) -> [String] (9109.0) -
与えられた argv を破壊的にパースします。argv からオプションがすべて取り除かれます。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv を返します。
...を置くことが
できます。
@param argv パースしたい引数を文字列の配列で指定します。
@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク......ラスになります。
//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new
opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }
opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile -b
:a
:b
["somefile"]... -
OptionParser
# separator(sep) -> () (9109.0) -
サマリにオプションを区切るための文字列 sep を挿入します。 オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。
...す。
@param sep サマリの区切りを文字列で指定します。
//emlist[][ruby]{
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"
opts.separator ""
opts.separator "Specific options:"
opts.on("-r", "--require LIBRARY") do |lib|
options.libra......ry << lib
end
opts.separator ""
opts.separator "Common options:"
opts.on_tail("-h", "--help", "Show this message") do
puts opts
exit
end
//}... -
OptionParser
# summary _ indent=(indent) (9109.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
# => [" -i, --init\n", " -u, --update\n", " -h, --help\n"]
opts.summary_indent = " " # => " "
opts.summary_indent # => " "
opts.summarize
# => [" -i, --init\n", " -u, --update\n", " -h, --help\n"]
//}... -
OptionParser
:: ParseError # recover(argv) -> Array (9015.0) -
argv の先頭に self.args を戻します。
...argv の先頭に self.args を戻します。
argv を返します。
@param argv OptionParser#parse に渡したオブジェクトなどの配列を指定します。
@return argv を返します。... -
OptionParser
:: ParseError # reason=(reason) (9009.0) -
エラーの内容を指定します。
...エラーの内容を指定します。
@param reason 文字列を指定します。... -
OptionParser
# on(long , pat = / . * / , desc = "") {|v| . . . } -> self (6144.0) -
オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。
...ばれます。
pat にはオプションの引数に許すパターンを表す正規表現で与えます。
コマンドに与えられた引数がパターンにマッチしない場合、
例外 OptionParser::InvalidArgument が parse 実行時に投げられます。
opts.on("--username VA......y.user #=> Error
@param short ショートオプションを表す文字列を指定します。
@param long ロングオプションを表す文字列を指定します。
@param pat オプションの引数に許すパターンを表す正規表現で指定します。
@param desc オプショ... -
OptionParser
# on(short , long , pat = / . * / , desc = "") {|v| . . . } -> self (6144.0) -
オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。
...ばれます。
pat にはオプションの引数に許すパターンを表す正規表現で与えます。
コマンドに与えられた引数がパターンにマッチしない場合、
例外 OptionParser::InvalidArgument が parse 実行時に投げられます。
opts.on("--username VA......y.user #=> Error
@param short ショートオプションを表す文字列を指定します。
@param long ロングオプションを表す文字列を指定します。
@param pat オプションの引数に許すパターンを表す正規表現で指定します。
@param desc オプショ...