検索結果

OptionParser#accept(klass, pat = /.*/) {|str| ...} -> () (7.0)

• 2.2.0

• インスタンスメソッド

OptionParser.accept と同様ですが、 登録したブロックはレシーバーに限定されます。

...
OptionParser.accept と同様ですが、
登録したブロックはレシーバーに限定されます。

@param klass クラスオブジェクトを与えます。

@param pat match メソッドを持ったオブジェクト(Regexp オブジェクトなど)を与えます。

//emlist[例][rub...

...y]{
require "optparse"
require "time"

opts = OptionParser.new
opts.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument, s
end
end

opts.on("-t", "--time [TIME]", Time) do |time|
p time.class # => Time
end

opts.parse!(ARGV)
//}...

• Regexp

OptionParser#banner -> String (7.0)

• 2.2.0

• インスタンスメソッド

サマリの最初に表示される文字列を返します。

...ます。

@return サマリの最初に表示される文字列を返します。

//emlist[例][ruby]{
require "optparse"

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"

opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
options[:verbose] =...

OptionParser#banner=(heading) (7.0)

• 2.2.0

• インスタンスメソッド

サマリの最初に表示される文字列を指定します。

...@param heading サマリの最初に表示される文字列を指定します。

//emlist[例][ruby]{
require "optparse"

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]" # => "Usage: example.rb [options]"

opts.on("-v", "--[no-]verbose", "Run verbose...

OptionParser#default_argv -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

自身がデフォルトでパースする引数を文字列の配列で返します。

...します。

@param argv デフォルトでパースする文字列の配列を返します。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new

# --hoo param1 --bar param2 をパラメーターに指定して実行
opts.default_argv # => ["--foo", "param1", "--bar", "param2"]
//}...

OptionParser#default_argv=(argv) (7.0)

• 2.2.0

• インスタンスメソッド

自身がデフォルトでパースする引数を文字列の配列で指定します。

...配列で指定します。

OptionParser#parse の引数が指定されなかったときに使われます。

@param argv デフォルトでパースしたい文字列の配列を指定します。

//emlist[例][ruby]{
require "optparse"

config = {}
opts = OptionParser.new
opts.on("-r", "--requ...

絞り込み条件を変える

OptionParser#environment(env) -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

環境変数 env に対して Shellwords.#shellwords を呼 んで配列にしてから parse を行ないます。

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

//emlist[例][ruby]{
require "optparse"

config = {}
opts = OptionParser.new
o...

OptionParser#getopts(*opts) -> Hash (7.0)

• 2.2.0

• インスタンスメソッド

引数をパースした結果を、Hash として返します。

...rgv を与えた場合、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...

...を指定します。

@param opts 引数を文字列で指定します。

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

OptionParser#getopts(argv, *opts) -> Hash (7.0)

• 2.2.0

• インスタンスメソッド

引数をパースした結果を、Hash として返します。

...rgv を与えた場合、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...

...を指定します。

@param opts 引数を文字列で指定します。

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

OptionParser#help -> String (7.0)

• 2.2.0

• インスタンスメソッド

サマリの文字列を返します。

...サマリの文字列を返します。

//emlist[例][ruby]{
require "optparse"

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"

opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
options[:verbose] = v
end
end

puts opts.help

# => Usage:...

OptionParser#load(filename = nil) -> bool (7.0)

• 2.2.0

• インスタンスメソッド

指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。

...指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。

パースが成功した場合に true を返します。
ファイルが存在しなかった場合に false を返します。

@param filename 各行をパースしたい...

...パースします。

//emlist[例][ruby]{
require "optparse"

IO.write("options.txt", %w(-a --b).join("\n"))
options = { a: false, b: false }
OptionParser.new do |opt|
opt.on('-a') { |v| options[:a] = v }
opt.on('--b') {|v| options[:b] = v }
opt.load("options.txt") # => true
opt.load("no...

絞り込み条件を変える

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

• 2.2.0

• インスタンスメソッド

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

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

コマンドに与えられた引数が配列やハッシュに含まれない場合、例外
OptionParser::InvalidArgument が OptionParser#parse 実行時
に発生します。

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

@param...

• OptionParser::InvalidArgument

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

• 2.2.0

• インスタンスメソッド

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

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

ショートオプションとロングオプションを同時に登録することもできます。
opts.on("-r", "--require LIBRARY"){|lib| ...}
これは以下と同値です。
opts.on("-r LIBRARY"){|lib| ...}
opts.on("--require LIBRARY"){|lib| ...}

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

opt.on('-v', '-vv')...

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

• 2.2.0

• インスタンスメソッド

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

...なクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定され...

...外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::InvalidArgument を投げます。

オプションの引数は accept で登録したブロックで klass のインスタンス
に変換さ...

...の引数は変換されません。

: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します。

: Integer
Integer オブジェクトに変換されます。"0b1"、"07"、"99"、"0xff" といった...

• ArgumentError
• OptionParser::InvalidArgument

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

• 2.2.0

• インスタンスメソッド

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

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

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

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

• 2.2.0

• インスタンスメソッド

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

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

コマンドに与えられた引数が配列やハッシュに含まれない場合、例外
OptionParser::InvalidArgument が OptionParser#parse 実行時
に発生します。

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

@param...

• OptionParser::InvalidArgument

絞り込み条件を変える

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

• 2.2.0

• インスタンスメソッド

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

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

ショートオプションとロングオプションを同時に登録することもできます。
opts.on("-r", "--require LIBRARY"){|lib| ...}
これは以下と同値です。
opts.on("-r LIBRARY"){|lib| ...}
opts.on("--require LIBRARY"){|lib| ...}

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

opt.on('-v', '-vv')...

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

• 2.2.0

• インスタンスメソッド

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

...なクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定され...

...外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::InvalidArgument を投げます。

オプションの引数は accept で登録したブロックで klass のインスタンス
に変換さ...

...の引数は変換されません。

: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します。

: Integer
Integer オブジェクトに変換されます。"0b1"、"07"、"99"、"0xff" といった...

• ArgumentError
• OptionParser::InvalidArgument

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

• 2.2.0

• インスタンスメソッド

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

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

コマンドに与えられた引数が配列やハッシュに含まれない場合、例外
OptionParser::InvalidArgument が OptionParser#parse 実行時
に発生します。

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

@param...

• OptionParser::InvalidArgument

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

• 2.2.0

• インスタンスメソッド

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

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

ショートオプションとロングオプションを同時に登録することもできます。
opts.on("-r", "--require LIBRARY"){|lib| ...}
これは以下と同値です。
opts.on("-r LIBRARY"){|lib| ...}
opts.on("--require LIBRARY"){|lib| ...}

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

opt.on('-v', '-vv')...

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

• 2.2.0

• インスタンスメソッド

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

...なクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定され...

...外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::InvalidArgument を投げます。

オプションの引数は accept で登録したブロックで klass のインスタンス
に変換さ...

...の引数は変換されません。

: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します。

: Integer
Integer オブジェクトに変換されます。"0b1"、"07"、"99"、"0xff" といった...

• ArgumentError
• OptionParser::InvalidArgument

絞り込み条件を変える

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

• 2.2.0

• インスタンスメソッド

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

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

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

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

• 2.2.0

• インスタンスメソッド

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

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

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

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

• 2.2.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")
opt...

...s.on_tail("-h", "--help")
end

puts opts.help

# => Usage: test [options]
# -i, --init
# -u, --update
# -h, --help
//}

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

OptionParser#on_tail(*arg, &block) -> self (7.0)

• 2.2.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")
opt...

..., --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
end
//}

@see OptionParser#on, OptionParser#on_head...

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

• 2.2.0

• インスタンスメソッド

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

...。


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

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

opt.o...

絞り込み条件を変える

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

• 2.2.0

• インスタンスメソッド

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

...。


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

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

opt.o...

OptionParser#order(*args) -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...。


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

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

opt.o...

OptionParser#order(*args) {|s| ...} -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...。


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

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

opt.o...

OptionParser#order(argv) -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...。


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

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

opt.o...

OptionParser#order(argv) {|s| ...} -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...。


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

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

opt.o...

絞り込み条件を変える

OptionParser#parse!(argv = self.default_argv) -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

与えられた argv をパースします。

...

OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。


@raise OptionParser...

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

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update...

OptionParser#parse(*args) -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

...す。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を...

...。


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

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opt...

OptionParser#parse(argv) -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

...す。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を...

...。


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

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opt...

OptionParser#permute!(argv = self.default_argv) -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

与えられた argv を破壊的にパースします。argv からオプションがすべて取り除かれます。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv を返します。

...。


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

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

opt.o...

OptionParser#permute(*args) -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

与えられた argv をパースします。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。

...。


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

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

opt.o...

絞り込み条件を変える

OptionParser#permute(argv) -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

与えられた argv をパースします。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。

...。


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

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

opt.o...

OptionParser#program_name -> String (7.0)

• 2.2.0

• インスタンスメソッド

プログラムの名前を文字列で返します。

...字列で返します。

デフォルトは $0 が使われます。

@return プログラムの名前を文字列で返します。

//emlist[例][ruby]{
require "optparse"

OptionParser.new do |opts|
p $0 # => /path/to/filename.rb
p opts.program_name # => filename
end
//}...

OptionParser#program_name=(name) (7.0)

• 2.2.0

• インスタンスメソッド

プログラムの名前を文字列で指定します。

...文字列で指定します。

@param name プログラムの名前を文字列で指定します。

//emlist[例][ruby]{
require "optparse"

OptionParser.new do |opts|
$0 # => /path/to/filename.rb
opts.program_name # => filename
opts.program_name = 'test' #...

OptionParser#reject(klass) -> () (7.0)

• 2.2.0

• インスタンスメソッド

OptionParser#accept で登録したクラスとブロックを 自身から削除します。

...
OptionParser#accept で登録したクラスとブロックを
自身から削除します。

@param klass 自身から削除したいクラスを指定します。

//emlist[例][ruby]{
require "optparse"
require "time"

def parse(option_parser)
option_parser.on("-t", "--time [TIME]", Time) do...

...|time|
p time.class
end
option_parser.parse(ARGV)
end

opts = OptionParser.new
opts.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument, s
end
end

parse(opts) # => Time
opts.reject(Time)
parse(opts) # => unsupported argument type: Time (Arg...

OptionParser#release -> String (7.0)

• 2.2.0

• インスタンスメソッド

プログラムのリリースを文字列で返します。

...プログラムのリリースを文字列で返します。

//emlist[例][ruby]{
require "optparse"

OptionParser.new do |opts|
opts.release # => nil
opts.release = "2019-05-01"
opts.release # => "2019-05-01"
end
//}...

絞り込み条件を変える

OptionParser#release=(rel) (7.0)

• 2.2.0

• インスタンスメソッド

プログラムのリリースを文字列で指定します。

...プログラムのリリースを文字列で指定します。

@param rel プログラムのリリースを文字列で指定します。


@see OptionParser#ver...

OptionParser#separator(sep) -> () (7.0)

• 2.2.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 |li...

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) -> () (7.0)

• 2.2.0

• インスタンスメソッド

サマリを指定された to へと加えていきます。

...指定します。

@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.summarize
# => [" -i, --in...

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) {|line| ... } -> () (7.0)

• 2.2.0

• インスタンスメソッド

サマリを指定された to へと加えていきます。

...指定します。

@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.summarize
# => [" -i, --in...

OptionParser#summary_indent -> String (7.0)

• 2.2.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 # => "...

絞り込み条件を変える

OptionParser#summary_indent=(indent) (7.0)

• 2.2.0

• インスタンスメソッド

サマリを表示する時のインデントを文字列で指定します。

...dent サマリを表示する時に使われるインデントを文字列で指定します。

//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 # =>...

OptionParser#summary_width -> Integer (7.0)

• 2.2.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
opt...

OptionParser#summary_width=(width) (7.0)

• 2.2.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...

OptionParser#to_a -> [String] (7.0)

• 2.2.0

• インスタンスメソッド

サマリの各行を要素とした配列を返します。

...サマリの各行を要素とした配列を返します。

//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.to_a # => ["Usage: test [options]", " -i, --init\n", " -...

OptionParser#to_s -> String (7.0)

• 2.2.0

• インスタンスメソッド

サマリの文字列を返します。

...サマリの文字列を返します。

//emlist[例][ruby]{
require "optparse"

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"

opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
options[:verbose] = v
end
end

puts opts.help

# => Usage:...

絞り込み条件を変える

OptionParser#ver -> String (7.0)

• 2.2.0

• インスタンスメソッド

program_name、version と release から生成したバージョンを表す文字列を返します。

...ogram_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 =...

OptionParser#version -> String (7.0)

• 2.2.0

• インスタンスメソッド

プログラムのバージョンを文字列で返します。

...プログラムのバージョンを文字列で返します。

@return プログラムのバージョンを文字列で返します。


@see OptionParser#ver...

OptionParser#version=(ver) (7.0)

• 2.2.0

• インスタンスメソッド

プログラムのバージョンを文字列で指定します。

...プログラムのバージョンを文字列で指定します。

@param ver プログラムのバージョンを文字列で指定します。


@see OptionParser#ver...