るりまサーチ

最速Rubyリファレンスマニュアル検索！
120件ヒット [1-100件を表示] （0.026秒）
トップページ > 種類:インスタンスメソッド[x] > クエリ:g[x] > クエリ:help[x] > ライブラリ:optparse[x]

別のキーワード

  1. openssl g
  2. openssl g=
  3. dh g
  4. dh g=
  5. dsa g=

クラス

キーワード

検索結果

先頭5件

  1. OptionParser#help -> String
  2. OptionParser#to_s -> String
  3. OptionParser#parse!(argv = self.default_argv) -> [String]
  4. OptionParser#parse!(argv = self.default_argv, into: nil) -> [String]
  5. OptionParser#on_tail(*arg, &block) -> self
<< 1 2 > >>

OptionParser#help -> String (18210.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, --[n...

OptionParser#to_s -> String (3110.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, --[n...

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

  • インスタンスメソッド

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

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

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

@param argv パースしたい引数を文字列の配...
...quire "optparse"

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

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

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

  • インスタンスメソッド

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

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

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

@param argv パースしたい引数を文字列の配...
...quire "optparse"

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

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

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

  • インスタンスメソッド

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

...最後に登録します。

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

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

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

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

opts = OptionParser.new do |opts|
opts.o...
...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_...

絞り込み条件を変える

OptionParser#on_head(*arg, &block) -> self (121.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
//}

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

OptionParser#summary_indent -> String (121.0)

  • インスタンスメソッド

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

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

OptionParser#summary_width -> Integer (121.0)

  • インスタンスメソッド

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

...list[例][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#to_a -> [String] (115.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", " -u, --update\n", " -h, --help\n"]
//}...

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

  • インスタンスメソッド

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

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

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

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

@param args パースしたい引数を順に文字列として与えます。


@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は 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 # => ["-i", "-u", "-h", "test"]
opts.parse(ARGV) # => ["test"]
//}...

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

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

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

@param args パースしたい引数を順に文字列として与えます。

@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーと...
...ラスになります。

//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 # => ["-i", "-u", "-h", "test"]
opts.parse(ARGV) # => ["test"]
//}...
<< 1 2 > >>

検索対象のドキュメントは るりまプロジェクト の成果物です。

検索エンジンは Groonga 14.1.2 を使っています。

Groongaは Rroonga 12.1.0 経由で利用しています。

Powered by Ruby 3.1.2.

るりまサーチのリポジトリ は GitHub 上にあります。