検索結果

OptionParser#help -> String (21107.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

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

...t[例][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

GetoptLong#set_options(*arguments) -> self (6124.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

あなたのプログラムで、認識させたいオプションをセットします。 個々のオプションは、オプション名と引数のフラグからなる配列でな ければいけません。

...グは、GetoptLong::NO_ARGUMENT,
GetoptLong::REQUIRE_ARGUMENT, GetoptLong::OPTIONAL_ARGUMENT
のいずれかでなくてはなりません。

オプションを設定できるのは、get, get_option, each,
each_option メソッドを呼び出す前だけです。これらのメソッドを
呼び...

...な引数が与えられるた場合、発生します。

parser.set_options(['-d', '--debug', GetoptLong::NO_ARGUMENT],
['--version', GetoptLong::NO_ARGUMENT],
['--help', GetoptLong::NO_ARGUMENT])

オプション名と引数のフラグ...

...の順番に決まりはないので、次のような
形式でも構いません。

parser.set_options([GetoptLong::NO_ARGUMENT, '-d', '--debug'],
[GetoptLong::NO_ARGUMENT, '--version'],
[GetoptLong::NO_ARGUMENT, '--help'])...

• GetoptLong

RDoc::Options (6012.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• クラス

rdoc コマンドのオプションを解析するためのクラスです。

...options] カスタムオプション

RDoc のジェネレータでは、RDoc::Options をフックして独自の
オプションを指定できます。

Object::ARGV に --format が含まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_option...

...る必要があります。rdoc --help を実行すると追加したオプションの一覧が
確認できます。

例:

class RDoc::Generator::Spellcheck
RDoc::RDoc.add_generator self

def self.setup_options rdoc_options
op = rdoc_options.option_parser

op.on('--spell-dic...

...tionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dictionary アクセサの定義が必要
rdoc_options.spell_dictionary = dictionary
end
end
end...

• RDoc
• RDoc::Options

OptionParser#to_s -> String (6007.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

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

...t[例][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

OptionParser (6006.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• クラス

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

...ラスです。

オプションが指定された時に呼ばれるブロックを
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」がコマンドラインで指定されていた場合の動作。...

...ションです。オプションサマリには
出てきません。

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

: --version

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

絞り込み条件を変える

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

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

...登録します。

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

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

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

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

opts = OptionParser.new do |opts|
opts.on_head("-...

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

OptionParser#on_head(*arg, &block) -> self (3018.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

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

...rg 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

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

サマリを指定された 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

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

サマリを指定された 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

OptionParser#summary_indent -> String (3018.0)

• 2.6.0

• インスタンスメソッド

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

...y]{
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_indent = "...

..."
opts.summary_indent # => " "
opts.summarize
# => [" -i, --init\n", " -u, --update\n", " -h, --help\n"]
//}...

• OptionParser

絞り込み条件を変える