種類:インスタンスメソッド > バージョン:2.3.0 > クエリ:String > クラス:OptionParser

35件ヒット [1-35件を表示] （0.130秒）

トップページ >

:インスタンスメソッド

:2.3.0

:String

> クラス:OptionParser

別のキーワード

ライブラリ

optparse (35)

キーワード

banner (1)
default_argv (1)
environment (1)
help (1)
on (12)
order (4)
order! (2)
parse (2)
parse! (1)
permute (2)
permute! (1)
program_name (1)
release (1)
summary_indent (1)
to_a (1)
to_s (1)
ver (1)
version (1)

検索結果

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

2.3.0

インスタンスメソッド

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

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

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

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

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

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

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

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

2.3.0

インスタンスメソッド

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

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

2.3.0

インスタンスメソッド

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

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

2.3.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] (319.0)

2.3.0

インスタンスメソッド

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

2.3.0

インスタンスメソッド

OptionParser#help -> String (313.0)

2.3.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#order!(argv = self.default_argv) -> [String] (313.0)

2.3.0

インスタンスメソッド

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

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

2.3.0

インスタンスメソッド

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

絞り込み条件を変える

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

2.3.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] (313.0)

2.3.0

インスタンスメソッド

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

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

2.3.0

インスタンスメソッド

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

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

2.3.0

インスタンスメソッド

OptionParser#to_s -> String (313.0)

2.3.0

インスタンスメソッド

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

絞り込み条件を変える

OptionParser#banner -> String (310.0)

2.3.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#default_argv -> [String] (310.0)

2.3.0

インスタンスメソッド

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

...します。

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

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

opts = OptionParser.new

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

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

2.3.0

インスタンスメソッド

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

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

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

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

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

2.3.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#permute!(argv = self.default_argv) -> [String] (310.0)

2.3.0

インスタンスメソッド

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

絞り込み条件を変える

OptionParser#program_name -> String (310.0)

2.3.0

インスタンスメソッド

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

...字列で返します。

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

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

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

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

OptionParser#release -> String (310.0)

2.3.0

インスタンスメソッド

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

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

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

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

OptionParser#summary_indent -> String (310.0)

2.3.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#to_a -> [String] (310.0)

2.3.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#ver -> String (310.0)

2.3.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 (310.0)

2.3.0

インスタンスメソッド

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

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

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

@see OptionParser#ver...

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

2.3.0

インスタンスメソッド

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

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

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

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

@param...

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

2.3.0

インスタンスメソッド

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

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

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

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