検索結果

OptionParser#on(short, desc = "") {|v| ... } -> self (102.0)

• 2.4.0
• 2.5.0
• 3.0
• 3.4

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...n("-r", "--require LIBRARY"){|lib| ...}
これは以下と同値です。
opts.on("-r LIBRARY"){|lib| ...}
opts.on("--require LIBRARY"){|lib| ...}

複数の異なるオプションに同じブロックを一度に登録することもできます。

opt.on('-v', '-vv'){|boolean| ...}
opt.o...

...ョートオプションを表す文字列を指定します。
そのオプションが引数をとらない場合は、
//emlist{
on("-x"){|boolean| ...}
//}
となります。コマンドラインにオプションが存在した場合 true を引数と...

...//emlist{
on("-x MANDATORY"){|val| ...} # " MANDATORY" の部分は任意の文字列で構いません
on("-xSTRING"){|val| ...} # スペース無しで任意の文字列を入れても同様
//}
オプションの引数が必須でない場合は [ ] をつけて、
//emlist{
o...

OptionParser#on(short, klass = String, desc = "") {|v| ...} -> self (102.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...定されていれば呼ばれます。

klass にはクラスを与えます。どのようなクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
る...

...ある場合、例外
OptionParser::InvalidArgument を投げます。

オプションの引数は accept で登録したブロックで klass のインスタンス
に変換されてから、ブロックに渡されます。

opts.on("-w", "--width N", Integer){|w|
p w.class #=> Integer
}...

...2

opts.on("-o", "--overwrite VALUE", TrueClass){|boolean| ...}
# ruby command --overwrite yes

@param short ショートオプションを表す文字列を指定します。

@param long ロングオプションを表す文字列を指定します。

@param klass オプションの引数の...

• ArgumentError
• OptionParser::InvalidArgument

OptionParser#on(short, long, *rest) {|v| ...} -> self (102.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...数が配列やハッシュに含まれない場合、例外
OptionParser::InvalidArgument が OptionParser#parse 実行時
に発生します。

@param short ショートオプションを表す文字列を指定します。

@param long ロングオプションを表す文字列を指定します...

...マリに表示されるオプションの説明と見なします。

//emlist[][ruby]{
opts.on("--protocol VALUE", [:http, :ftp, :https]){|w|
p w
}
# ruby command --protocol=http #=> :http

opts.on("-c", "--charset VALUE", {"jis" => "iso-2022-jp", "sjis" => "shift_jis"}){|w|
p w
}
# ruby comma...

• OptionParser::InvalidArgument

OptionParser#on(short, long, desc = "") {|v| ... } -> self (102.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...n("-r", "--require LIBRARY"){|lib| ...}
これは以下と同値です。
opts.on("-r LIBRARY"){|lib| ...}
opts.on("--require LIBRARY"){|lib| ...}

複数の異なるオプションに同じブロックを一度に登録することもできます。

opt.on('-v', '-vv'){|boolean| ...}
opt.o...

...ョートオプションを表す文字列を指定します。
そのオプションが引数をとらない場合は、
//emlist{
on("-x"){|boolean| ...}
//}
となります。コマンドラインにオプションが存在した場合 true を引数と...

...//emlist{
on("-x MANDATORY"){|val| ...} # " MANDATORY" の部分は任意の文字列で構いません
on("-xSTRING"){|val| ...} # スペース無しで任意の文字列を入れても同様
//}
オプションの引数が必須でない場合は [ ] をつけて、
//emlist{
o...

OptionParser#on(short, long, klass = String, desc = "") {|v| ...} -> self (102.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...定されていれば呼ばれます。

klass にはクラスを与えます。どのようなクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
る...

...ある場合、例外
OptionParser::InvalidArgument を投げます。

オプションの引数は accept で登録したブロックで klass のインスタンス
に変換されてから、ブロックに渡されます。

opts.on("-w", "--width N", Integer){|w|
p w.class #=> Integer
}...

...2

opts.on("-o", "--overwrite VALUE", TrueClass){|boolean| ...}
# ruby command --overwrite yes

@param short ショートオプションを表す文字列を指定します。

@param long ロングオプションを表す文字列を指定します。

@param klass オプションの引数の...

• ArgumentError
• OptionParser::InvalidArgument

絞り込み条件を変える

OptionParser#on(short, long, pat = /.*/, desc = "") {|v| ...} -> self (102.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...ます。
コマンドに与えられた引数がパターンにマッチしない場合、
例外 OptionParser::InvalidArgument が parse 実行時に投げられます。

opts.on("--username VALUE", /[a-zA-Z0-9_]+/){|name| ...}
# ruby command --username=ruby_user
# ruby command --username=r...

...uby.user #=> Error

@param short ショートオプションを表す文字列を指定します。

@param long ロングオプションを表す文字列を指定します。

@param pat オプションの引数に許すパターンを表す正規表現で指定します。

@param desc オプシ...

OptionParser#on(short, pat = /.*/, desc = "") {|v| ...} -> self (102.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...ます。
コマンドに与えられた引数がパターンにマッチしない場合、
例外 OptionParser::InvalidArgument が parse 実行時に投げられます。

opts.on("--username VALUE", /[a-zA-Z0-9_]+/){|name| ...}
# ruby command --username=ruby_user
# ruby command --username=r...

...uby.user #=> Error

@param short ショートオプションを表す文字列を指定します。

@param long ロングオプションを表す文字列を指定します。

@param pat オプションの引数に許すパターンを表す正規表現で指定します。

@param desc オプシ...

OptionParser#on_head(*arg, &block) -> self (102.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。

...。

@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: t...

...est [options]
# -i, --init
# -u, --update
# -h, --help
//}

@see OptionParser#on, OptionParser#on_tail...

OptionParser#order!(argv = self.default_argv) -> [String] (102.0)

• 2.1.0
• 2.2.0
• 2.3.0

• インスタンスメソッド

与えられた argv を順番に破壊的にパースします。 argv からオプションがすべて取り除かれます。 argv を返します。

...file)に出会うと、パースを中断します。
ブロックが与えられている場合は、パースを中断せずに
引数をブロックに渡してブロックを評価し、パースを継続します。argv を返します。

下の例で言うと、コマンドの引数 somefile...

...e 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.order!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile -b
:a
["somefile", "-b"]...

OptionParser#order!(argv = self.default_argv) {|s| ...} -> [String] (102.0)

• 2.1.0
• 2.2.0
• 2.3.0

• インスタンスメソッド

与えられた argv を順番に破壊的にパースします。 argv からオプションがすべて取り除かれます。 argv を返します。

...file)に出会うと、パースを中断します。
ブロックが与えられている場合は、パースを中断せずに
引数をブロックに渡してブロックを評価し、パースを継続します。argv を返します。

下の例で言うと、コマンドの引数 somefile...

...e 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.order!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile -b
:a
["somefile", "-b"]...

絞り込み条件を変える

OptionParser#order!(argv = self.default_argv, into: nil) -> [String] (102.0)

• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.1
• 3.2

• インスタンスメソッド

与えられた argv を順番に破壊的にパースします。 argv からオプションがすべて取り除かれます。 argv を返します。

...file)に出会うと、パースを中断します。
ブロックが与えられている場合は、パースを中断せずに
引数をブロックに渡してブロックを評価し、パースを継続します。argv を返します。

下の例で言うと、コマンドの引数 somefile...

...ョンを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプションが定義されていればロ...

...e OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]...