るりまサーチ

最速Rubyリファレンスマニュアル検索!
187件ヒット [1-100件を表示] (0.025秒)
トップページ > クエリ:help[x] > クエリ:OptionParser[x]

別のキーワード

  1. win32ole ole_obj_help
  2. win32ole ole_show_help
  3. win32ole ole_method_help
  4. irb/help print_usage
  5. un help

ライブラリ

クラス

キーワード

検索結果

<< 1 2 > >>

OptionParser#help -> String (39113.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: example.rb [options]
# -v, --[no-]verbose...

OptionParser (38054.0)

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

...スです。

オプションが指定された時に呼ばれるブロックを
OptionParser
#on メソッドで登録していきます。
つまり、OptionParser を使う場合、基本的には

(1) OptionParser オブジェクト opt を生成する。
(2) オプションを取り扱うブ...
...を実際に parse する。

というような流れになります。

//emlist[][ruby]{
require "optparse"
ProgramConfig = Hash.new
opts = OptionParser.new
opts.on("-a"){|v| ProgramConfig[:a] = true } # オプション「-a」がコマンドラインで指定されていた場合の動作。
opt...
...ョンです。オプションサマリには
出てきません。

: --help
オプションサマリを表示してから exit します。

: --version

OptionParser
#ver を表示してから exit します。
OptionParser
#ver が定義されていない場合は、そのようにエラーメ...

OptionParser#to_s -> String (24013.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: example.rb [options]
# -v, --[no-]verbose...

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

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

...録します。

--version や --help の説明をサマリの最後に表示したい時に便利です。

@param arg OptionParser#on と同様です。

@param block OptionParser#on と同様です。

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

opts = OptionParser.new do |opts|
opts.on_head("-i",...
...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
end
//}

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

OptionParser#on_head(*arg, &block) -> self (21048.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: t...
...est [options]
# -i, --init
# -u, --update
# -h, --help
//}

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

絞り込み条件を変える

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

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

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

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

@param argv パースしたい引数を文字列の配...
...ョンを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプションが定義されていればロ...
...実際は OptionParser::ParseError のサブク
ラスになります。

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

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

ARGV...

OptionParser#parse(*args, into: nil) -> [String] (21042.0)

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

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

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

@param argv パースしたい引数を...
...ョンを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプションが定義されていればロ...
...実際は OptionParser::ParseError のサブク
ラスになります。

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

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

ARGV...

OptionParser#parse(argv, into: nil) -> [String] (21042.0)

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

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

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

@param argv パースしたい引数を...
...ョンを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプションが定義されていればロ...
...実際は OptionParser::ParseError のサブク
ラスになります。

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

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

ARGV...

OptionParser#parse!(argv = self.default_argv) -> [String] (21036.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")
opts.on_tail("-h", "--help")
end

ARGV...

OptionParser#parse(*args) -> [String] (21036.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...
...s|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

ARGV # => ["-i", "-u", "-h", "test"]
opts.parse(ARGV) # => ["test"]
//}...

絞り込み条件を変える

OptionParser#parse(argv) -> [String] (21036.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...
...s|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

ARGV # => ["-i", "-u", "-h", "test"]
opts.parse(ARGV) # => ["test"]
//}...

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

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

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

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

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

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