検索結果

OptionParser (50084.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

• クラス

コマンドラインのオプションを取り扱うためのクラスです。

...るブロックを
OptionParser#on メソッドで登録していきます。
つまり、OptionParser を使う場合、基本的には

(1) OptionParser オブジェクト opt を生成する。
(2) オプションを取り扱うブロックを opt に登録する。
(3) opt.parse(ARGV) で...

...ような流れになります。

//emlist[][ruby]{
require "optparse"
ProgramConfig = Hash.new
opts = OptionParser.new
opts.on("-a"){|v| ProgramConfig[:a] = true } # オプション「-a」がコマンドラインで指定されていた場合の動作。
opts.parse!(ARGV)...

...リを表示してから exit します。

: --version

OptionParser#ver を表示してから exit します。
OptionParser#ver が定義されていない場合は、そのようにエラーメッセージを出力して abort します。
オプション「--version」に「,」で区切ら...

OptionParser.new(banner = nil, width = 32, indent = ' ' * 4) -> OptionParser (45438.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

• 特異メソッド

OptionParser オブジェクトを生成して返します。

...
OptionParser オブジェクトを生成して返します。

ブロックが与えられた場合、生成した OptionParser オブジェクトを引数としてブロックを評
価します。つまり、以下のような書き方が可能です。

//emlist[][ruby]{
require 'optparse'
Optio...

...nParser.new do |opt|

opt.on('-a') {|v| p v }
opt.on('-b') {|v| p v }

opt.parse!(ARGV)
end
//}

@param banner ヘルプ(サマリ)の最初の部分に表示される、アプリケーションの説明などを文字列で与えます。

@param width サマリの幅を整数で与えます...

...。

@param indent サマリのインデントを文字列で与えます。...

• OptionParser

OptionParser.new(banner = nil, width = 32, indent = ' ' * 4) {|opt| ...} -> OptionParser (45438.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

• 特異メソッド

OptionParser オブジェクトを生成して返します。

...
OptionParser オブジェクトを生成して返します。

ブロックが与えられた場合、生成した OptionParser オブジェクトを引数としてブロックを評
価します。つまり、以下のような書き方が可能です。

//emlist[][ruby]{
require 'optparse'
Optio...

...nParser.new do |opt|

opt.on('-a') {|v| p v }
opt.on('-b') {|v| p v }

opt.parse!(ARGV)
end
//}

@param banner ヘルプ(サマリ)の最初の部分に表示される、アプリケーションの説明などを文字列で与えます。

@param width サマリの幅を整数で与えます...

...。

@param indent サマリのインデントを文字列で与えます。...

• OptionParser

OptionParser#summary_width=(width) (33430.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

• インスタンスメソッド

サマリを表示するときの幅を整数で指定します。

...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", " -u, --update\n", " -h, --help\n"]
opts.summary_width = 8 # => 8
opts.summary_width # => 8
opts.summarize
# => [" -i\n", " --init\n", " -u\n", " --update\n", " -h\n", " --help\n"]
//}...

• OptionParser

OptionParser#summary_indent -> String (33330.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

• インスタンスメソッド

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

...@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, --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

絞り込み条件を変える

OptionParser#summary_indent=(indent) (33330.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

• インスタンスメソッド

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

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

OptionParser#on_tail(*arg, &block) -> self (33266.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

• インスタンスメソッド

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

...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.o...

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

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

• OptionParser

OptionParser#summary_width -> Integer (33230.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

• インスタンスメソッド

サマリを表示するときの幅を整数で返します。

...eturn サマリを表示するときの幅を整数で返します。

//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", " -u, --update\n", " -h, --help\n"]
opts.summary_width = 8
opts.summary_width # =>8
opts.summarize
# => [" -i\n", " --init\n", " -u\n", " --update\n", " -h\n", " --help\n"]
//}...

• OptionParser

OptionParser#environment(env) -> [String] (33224.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

• インスタンスメソッド

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

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

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

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

...s.on("-r", "--require LIBRARY"){|lib| config[:lib] = lib }

# HOGE_OPT は hoge というプログラム名に対応した名前です
ENV['HOGE_OPT'] = %q{--require lib1 'remain data'}
p opts.environment('HOGE_OPT') # => ["remain data"]
p config # => {:lib=>"lib1"}
//}...

• OptionParser

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

• 2.5.0

• インスタンスメソッド

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

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

下の例で言うと、order と違いコマンドの引数 somefile よりも後ろにオプションを置くことが
できます。

@param...

...したい引数を文字列の配列で指定します。

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

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

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

opt.on('-...

• OptionParser

絞り込み条件を変える