るりまサーチ

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

別のキーワード

  1. _builtin -
  2. open-uri open
  3. irb/input-method new
  4. irb/input-method gets
  5. matrix -

クラス

モジュール

キーワード

検索結果

先頭5件

  1. OptionParser#summary_indent -> String
  2. OptionParser#release -> String
  3. OptionParser#ver -> String
  4. OptionParser#order!(argv = self.default_argv) -> [String]
  5. OptionParser#order!(argv = self.default_argv) {|s| ...} -> [String]
<< 1 2 3 ... > >>

OptionParser#summary_indent -> String (240.0)

  • インスタンスメソッド

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

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

OptionParser#release -> String (228.0)

  • インスタンスメソッド

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

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

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

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

OptionParser#ver -> String (228.0)

  • インスタンスメソッド

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

...require "optparse"

OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"
opts.program_name = "Optparse Example"
opts.version = [0, 1]
opts.release = "2019-05-01"

opts.on_tail("--version", "Show version") do
puts opts.ver # => "Optparse Example 0.1 (2019-05-01)"...

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

  • インスタンスメソッド

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

...argv を返します。

下の例で言うと、コマンドの引数 somefile よりも後ろにオプションを置くことができません。
-b もコマンドのオプションではない引数として扱われてしまいます。

@param argv パースしたい引数を文字列の配...
...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] (223.0)

  • インスタンスメソッド

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

...argv を返します。

下の例で言うと、コマンドの引数 somefile よりも後ろにオプションを置くことができません。
-b もコマンドのオプションではない引数として扱われてしまいます。

@param argv パースしたい引数を文字列の配...
...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] (223.0)

  • インスタンスメソッド

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

...argv を返します。

下の例で言うと、コマンドの引数 somefile よりも後ろにオプションを置くことができません。
-b もコマンドのオプションではない引数として扱われてしまいます。

@param argv パースしたい引数を文字列の配...
...ばロングオプションの値を、
ショートオプションのみの場合はショートオプションの値から、先頭の "-" を除いてシンボル化した値が使用されます。

@raise OptionParser::ParseError パースに失敗した場合、発生します。...
...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) {|s| ...} -> [String] (223.0)

  • インスタンスメソッド

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

...argv を返します。

下の例で言うと、コマンドの引数 somefile よりも後ろにオプションを置くことができません。
-b もコマンドのオプションではない引数として扱われてしまいます。

@param argv パースしたい引数を文字列の配...
...ばロングオプションの値を、
ショートオプションのみの場合はショートオプションの値から、先頭の "-" を除いてシンボル化した値が使用されます。

@raise OptionParser::ParseError パースに失敗した場合、発生します。...
...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#to_a -> [String] (222.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#on(long, klass = String, desc = "") {|v| ...} -> self (219.0)

  • インスタンスメソッド

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

...されてから、ブロックに渡されます。

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

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

@param short ショートオプションを表す...
...場合に発生します。

=== デフォルトで利用可能な引数クラス

: Object
オプションの引数は変換されません。

: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します...
...lass
true か false に変換されます。"yes" や "no"、"true" や "false"、"+"
や "-" を指定できます。オプションの引数を省略した場合は true になります。
また、"no-" をオプションの先頭に付けた場合は値が反転します。

: FalseClass
tru...

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

  • インスタンスメソッド

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

...されてから、ブロックに渡されます。

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

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

@param short ショートオプションを表す...
...場合に発生します。

=== デフォルトで利用可能な引数クラス

: Object
オプションの引数は変換されません。

: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します...
...lass
true か false に変換されます。"yes" や "no"、"true" や "false"、"+"
や "-" を指定できます。オプションの引数を省略した場合は true になります。
また、"no-" をオプションの先頭に付けた場合は値が反転します。

: FalseClass
tru...

絞り込み条件を変える

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

  • インスタンスメソッド

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

...されてから、ブロックに渡されます。

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

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

@param short ショートオプションを表す...
...場合に発生します。

=== デフォルトで利用可能な引数クラス

: Object
オプションの引数は変換されません。

: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します...
...lass
true か false に変換されます。"yes" や "no"、"true" や "false"、"+"
や "-" を指定できます。オプションの引数を省略した場合は true になります。
また、"no-" をオプションの先頭に付けた場合は値が反転します。

: FalseClass
tru...
<< 1 2 3 ... > >>

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

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

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

Powered by Ruby 3.1.2.

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