るりまサーチ (Ruby 2.1.0)

最速Rubyリファレンスマニュアル検索!
86件ヒット [1-86件を表示] (0.028秒)

検索結果

OptionParser (7.0)

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

...録する。
(3) opt.parse(ARGV) でコマンドラインを実際に parse する。

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

require "optparse"
ProgramConfig = Hash.new
opts = OptionParser.new
opts.on("-a"){|v| ProgramConfig[:a] = true } # オプション「-a」がコマンドライ...

OptionParser#accept(klass, pat = /.*/) {|str| ...} -> () (7.0)

OptionParser.accept と同様ですが、 登録したブロックはレシーバーに限定されます。

...@param pat match メソッドを持ったオブジェクト(Regexp オブジェクトなど)を与えます。

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

opts = OptionParser.new
opts.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument,...

OptionParser#banner -> String (7.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")...

OptionParser#banner=(heading) (7.0)

サマリの最初に表示される文字列を指定します。

...文字列を指定します。

@param heading サマリの最初に表示される文字列を指定します。

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

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]" # => "Usage: example.rb [options]"

opts.on("-v",...

OptionParser#default_argv -> [String] (7.0)

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

...列の配列で返します。

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

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

opts = OptionParser.new

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

絞り込み条件を変える

OptionParser#default_argv=(argv) (7.0)

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

...きに使われます。

@param argv デフォルトでパースしたい文字列の配列を指定します。

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

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

# パラメーター指定なしで実行
opt...

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

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

...実際は OptionParser::ParseError のサブク
ラスになります。

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

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

# HOGE_OPT は hoge というプログラム...

OptionParser#getopts(*opts) -> Hash (7.0)

引数をパースした結果を、Hash として返します。

引数をパースした結果を、Hash として返します。

配列 argv を与えた場合、argv をパースします。そうでない場合は、
default_argv をパースします。

opt = OptionParser.new
params = opt.getopts(ARGV, "ab:", "foo", "bar:")
# params["a"] = true # -a
# params["b"] = "1" # -b1
# params["foo"] = true # --foo
# params["bar"] = "x" # --bar x

@param arg...

OptionParser#getopts(argv, *opts) -> Hash (7.0)

引数をパースした結果を、Hash として返します。

引数をパースした結果を、Hash として返します。

配列 argv を与えた場合、argv をパースします。そうでない場合は、
default_argv をパースします。

opt = OptionParser.new
params = opt.getopts(ARGV, "ab:", "foo", "bar:")
# params["a"] = true # -a
# params["b"] = "1" # -b1
# params["foo"] = true # --foo
# params["bar"] = "x" # --bar x

@param arg...

OptionParser#help -> String (7.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#load(filename = nil) -> bool (7.0)

指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。

...ラムのサフィックスを付けた '~/.options/コマンド名' というファイルをパースします。

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

IO.write("options.txt", %w(-a --b).join("\n"))
options = { a: false, b: false }
OptionParser.new do |opt|
opt.on('-a') { |v| options[:a] = v...

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

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

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

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

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

@param long ロングオプションを表す文字列を指定します。

@param rest 可能な引数を列挙した配列やハッシュを与えます。文字列を与えた場合は、
サマリ...

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

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

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

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

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

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

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

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

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

klass にはクラスを与えます。どのようなクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定された
場合、例外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::I...

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

@param long ロングオプションを表す文字列を指定します。

@param rest 可能な引数を列挙した配列やハッシュを与えます。文字列を与えた場合は、
サマリ...

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

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

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

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

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

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

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

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

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

klass にはクラスを与えます。どのようなクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定された
場合、例外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::I...

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

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

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

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

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

@param long ロングオプションを表す文字列を指定します。

@param rest 可能な引数を列挙した配列やハッシュを与えます。文字列を与えた場合は、
サマリ...

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

klass にはクラスを与えます。どのようなクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定された
場合、例外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::I...

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

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

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

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

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

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

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

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

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

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

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

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

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

...]{
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
//}

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

opts = Op...

絞り込み条件を変える

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

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

...実際は OptionParser::ParseError のサブク
ラスになります。

例:
$ cat opt.rb
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order!(ARGV)
p ARGV

$ ruby opt2.rb -a foo some...

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

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

...実際は OptionParser::ParseError のサブク
ラスになります。

例:
$ cat opt.rb
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order!(ARGV)
p ARGV

$ ruby opt2.rb -a foo some...

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

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

例:
$ cat opt.rb
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV

$ ruby opt2.rb -a foo somef...

OptionParser#order(*args) {|s| ...} -> [String] (7.0)

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

例:
$ cat opt.rb
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV

$ ruby opt2.rb -a foo somef...

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

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

例:
$ cat opt.rb
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV

$ ruby opt2.rb -a foo somef...

絞り込み条件を変える

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

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

例:
$ cat opt.rb
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV

$ ruby opt2.rb -a foo somef...

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

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

...実際は 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] (7.0)

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

...実際は 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) -> [String] (7.0)

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

...実際は 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#permute!(argv = self.default_argv) -> [String] (7.0)

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

...実際は OptionParser::ParseError のサブク
ラスになります。

例:

$ cat opt.rb
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV

$ ruby opt2.rb -a foo s...

絞り込み条件を変える

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

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

...実際は OptionParser::ParseError のサブク
ラスになります。

例:

$ cat opt.rb
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV

$ ruby opt2.rb -a foo s...

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

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

...実際は OptionParser::ParseError のサブク
ラスになります。

例:

$ cat opt.rb
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV

$ ruby opt2.rb -a foo s...

OptionParser#program_name -> String (7.0)

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

...字列で返します。

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

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

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

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

OptionParser#program_name=(name) (7.0)

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

...の名前を文字列で指定します。

@param name プログラムの名前を文字列で指定します。

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

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

OptionParser#reject(klass) -> () (7.0)

OptionParser#accept で登録したクラスとブロックを 自身から削除します。

...ックを
自身から削除します。

@param klass 自身から削除したいクラスを指定します。

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

def parse(option_parser)
option_parser.on("-t", "--time [TIME]", Time) do |time|
p time.class
end
option_parser.parse(AR...

絞り込み条件を変える

OptionParser#release -> String (7.0)

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

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

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

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

OptionParser#release=(rel) (7.0)

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

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

@param rel プログラムのリリースを文字列で指定します。


@see OptionParser#ver

OptionParser#separator(sep) -> () (7.0)

サマリにオプションを区切るための文字列 sep を挿入します。 オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。

...たい
ところでこのメソッドを呼びます。

@param sep サマリの区切りを文字列で指定します。

例:
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"

opts.separator ""
opts.separator "Specific optio...

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

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

...大幅を整数で指定します。

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

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

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

...大幅を整数で指定します。

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

絞り込み条件を変える

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

OptionParser#summary_indent=(indent) (7.0)

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

...す。

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

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

OptionParser#summary_width=(width) (7.0)

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

...幅を整数で指定します。

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

OptionParser#to_a -> [String] (7.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#to_s -> String (7.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#ver -> String (7.0)

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

...例][ruby]{
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-0...

OptionParser#version -> String (7.0)

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

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

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


@see OptionParser#ver

OptionParser#version=(ver) (7.0)

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

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

@param ver プログラムのバージョンを文字列で指定します。


@see OptionParser#ver

OptionParser.accept(klass, pat = /.*/) {|str| ...} -> () (7.0)

オプションの引数を文字列から Ruby のオブジェクトに変換するための ブロックを登録します。すべての OptionParser インスタンスに共通です。

...klass のインスタンスに変換されてから、OptionParser#on メソッドで登録したブロックに渡されます。

require "optparse"
require "time"

OptionParser.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument, s...

絞り込み条件を変える

OptionParser.getopts(*opts) -> Hash (7.0)

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

@param argv パースしたい配列を指定します。

@param opts 引数を文字列で指定します。

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


@see OptionParser#getopts

OptionParser.getopts(argv, *opts) -> Hash (7.0)

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

@param argv パースしたい配列を指定します。

@param opts 引数を文字列で指定します。

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


@see OptionParser#getopts

OptionParser.new(banner = nil, width = 32, indent = ' ' * 4) -> OptionParser (7.0)

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

...arser オブジェクトを引数としてブロックを評
価します。つまり、以下のような書き方が可能です。

require 'optparse'
OptionParser.new do |opt|

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

opt.parse!(ARGV)
end

@param banner ヘルプ(サマ...

OptionParser.new(banner = nil, width = 32, indent = ' ' * 4) {|opt| ...} -> OptionParser (7.0)

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

...arser オブジェクトを引数としてブロックを評
価します。つまり、以下のような書き方が可能です。

require 'optparse'
OptionParser.new do |opt|

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

opt.parse!(ARGV)
end

@param banner ヘルプ(サマ...

OptionParser.reject(klass) -> () (7.0)

OptionParser.accept メソッドで登録したブロックを削除します。

...たブロックを削除します。

@param klass 削除したいクラスオブジェクトを指定します。

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

def parse(option_parser)
option_parser.on("-t", "--time [TIME]", Time) do |time|
p time.class
end
option_parser.parse(...

絞り込み条件を変える

OptionParser::AmbiguousArgument (7.0)

オプションの引数が曖昧にしか補完できない場合に投げられます。

オプションの引数が曖昧にしか補完できない場合に投げられます。

OptionParser::AmbiguousOption (7.0)

補完が曖昧にしかできないオプションがあった場合に投げられます。

補完が曖昧にしかできないオプションがあった場合に投げられます。

OptionParser::Arguable (7.0)

主に Object::ARGV を拡張するために用意されたモジュールです。 optparse を require することにより、ARGV は OptionParser::Arguable を Object#extend します。

...主に Object::ARGV を拡張するために用意されたモジュールです。
optparse
を require することにより、ARGV は
OptionParser::Arguable を Object#extend します。

コマンドライン引数を表す文字列の配列を、拡張するためにも使うことができ...

OptionParser::Arguable#getopts(short_opt, *long_opt) -> Hash (7.0)

指定された short_opt や long_opt に応じて自身をパースし、結果を Hash として返します。

...際は OptionParser::ParseError のサブク
ラスの例外になります。

例:

# t.rb の内容
require 'optparse'
params = ARGV.getopts("ab:", "foo", "bar:", "bufsize:1024")
p params

# 実行結果
$ ruby t.rb -b 1 --foo --bar xxx -- -a
{"bufsize"=>"1...

OptionParser::Arguable#options -> OptionParser (7.0)

自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。

...クの実行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。

例:

require 'optparse'

o = nil
ARGV.options{|opt|
opt.on('-a'){ o = true }
opt.parse!
}
p o #=> true...

絞り込み条件を変える

OptionParser::Arguable#options {|opt| ... } -> object | nil (7.0)

自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。

...クの実行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。

例:

require 'optparse'

o = nil
ARGV.options{|opt|
opt.on('-a'){ o = true }
opt.parse!
}
p o #=> true...

OptionParser::Arguable#options=(opt) (7.0)

自身をパースするための OptionParser オブジェクトをセットします。

自身をパースするための OptionParser オブジェクトをセットします。

@param opt 自身をパースする OptionParser 、あるいは nil か false を指定します。
nil か false である場合、自身の options= メソッドと options メソッドを
undef します。

OptionParser::Arguable#order! -> [String] (7.0)

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#order! を参照して下さい。

...生します。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

例:

require 'optparse'

o = nil
ARGV.options.on('-a'){ o = true }
ARGV.order!
p o #=> true...

OptionParser::Arguable#order! {|s| ... } -> [String] (7.0)

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#order! を参照して下さい。

...生します。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

例:

require 'optparse'

o = nil
ARGV.options.on('-a'){ o = true }
ARGV.order!
p o #=> true...

OptionParser::Arguable#parse! -> [String] (7.0)

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#parse! を参照して下さい。

...生します。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

例:

require 'optparse'

o = nil
ARGV.options.on('-a'){ o = true }
ARGV.parse!
p o #=> true...

絞り込み条件を変える

OptionParser::Arguable#permute! -> [String] (7.0)

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#permute! を参照して下さい。

...します。
実際は OptionParser::ParseError のサブク
ラスの例外になります。

例:

require 'optparse'

o = nil
ARGV.options.on('-a'){ o = true }
ARGV.permute!
p o #=> true...

OptionParser::InvalidArgument (7.0)

オプションの引数が指定されたパターンにマッチしない時に投げられます。

オプションの引数が指定されたパターンにマッチしない時に投げられます。

OptionParser::InvalidOption (7.0)

定義されていないオプションが与えられた場合に投げられます。

定義されていないオプションが与えられた場合に投げられます。

OptionParser::MissingArgument (7.0)

引数が必要なオプションに引数が与えられなかった場合に投げられます。

引数が必要なオプションに引数が与えられなかった場合に投げられます。

OptionParser::NeedlessArgument (7.0)

引数を取らないはずのオプションに引数が与えられた場合に投げられます。

引数を取らないはずのオプションに引数が与えられた場合に投げられます。

絞り込み条件を変える

OptionParser::ParseError (7.0)

OptionParser の例外クラスの基底クラスです。

OptionParser の例外クラスの基底クラスです。

OptionParser::ParseError#args -> Array (7.0)

エラーのあったオプションの一覧を配列で返します。

エラーのあったオプションの一覧を配列で返します。

@return エラーのあったオプションの一覧。

OptionParser::ParseError#inspect -> String (7.0)

自身を人間が読みやすい形の文字列表現にして返します。

自身を人間が読みやすい形の文字列表現にして返します。

@return 文字列を返します。

@see Object#inspect

OptionParser::ParseError#message -> String (7.0)

標準エラーに出力するメッセージを返します。

標準エラーに出力するメッセージを返します。

@return 文字列を返します。

OptionParser::ParseError#reason -> String (7.0)

エラーの内容を文字列で返します。

エラーの内容を文字列で返します。

@return 文字列を返します。

絞り込み条件を変える

OptionParser::ParseError#reason=(reason) (7.0)

エラーの内容を指定します。

エラーの内容を指定します。

@param reason 文字列を指定します。

OptionParser::ParseError#recover(argv) -> Array (7.0)

argv の先頭に self.args を戻します。

argv の先頭に self.args を戻します。

argv を返します。

@param argv OptionParser#parse に渡したオブジェクトなどの配列を指定します。

@return argv を返します。

OptionParser::ParseError#set_backtrace(array) -> [String] (7.0)

自身に array で指定したバックトレースを設定します。

自身に array で指定したバックトレースを設定します。

@param array バックトレースを文字列の配列で指定します。

@return array を返します。

OptionParser::ParseError#set_option(opt, eq) -> self (7.0)

エラーのあったオプションを指定します。

エラーのあったオプションを指定します。

eq が真の場合、self が管理するエラーのあったオプションの一覧の先頭を
opt で置き換えます。そうでない場合は先頭に opt を追加します。

@param opt エラーのあったオプションを指定します。

@param eq self が管理するエラーのあったオプションの一覧の先頭を置き換え
るかどうかを指定します。

@return self を返します。

OptionParser::ParseError#to_s -> String (7.0)

標準エラーに出力するメッセージを返します。

標準エラーに出力するメッセージを返します。

@return 文字列を返します。

絞り込み条件を変える

OptionParser::ParseError.filter_backtrace(array) -> [String] (7.0)

array で指定されたバックトレースから optparse ライブラリに関する行を除 外します。

...array で指定されたバックトレースから optparse ライブラリに関する行を除
外します。

デバッグモード($DEBUGが真)の場合は何もしません。

@param array バックトレースを文字列の配列で指定します。

@return array を返します。...