検索結果

Gem::Command#usage -> String (54307.0)

• 2.2.0

• インスタンスメソッド

このメソッドはサブクラスで再定義されます。 個々の gem コマンドの使用方法を返します。

このメソッドはサブクラスで再定義されます。
個々の gem コマンドの使用方法を返します。

• Gem::Command

Gem::Commands::BuildCommand#usage -> String (54307.0)

• 2.2.0

• インスタンスメソッド

使用方法を表す文字列を返します。

使用方法を表す文字列を返します。

• Gem::Commands::BuildCommand

Gem::Commands::DependencyCommand#usage -> String (54307.0)

• 2.2.0

• インスタンスメソッド

使用方法を表す文字列を返します。

使用方法を表す文字列を返します。

• Gem::Commands::DependencyCommand

Net::IMAP::MailboxQuota#usage -> Integer (54307.0)

• 2.2.0

• インスタンスメソッド

現在のメールボックス内の使用量を返します。

現在のメールボックス内の使用量を返します。

• Net::IMAP::MailboxQuota

OptionParser#banner=(heading) (58.0)

• 2.2.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", "--[no-]verbose", "Run verbosely") do |v|
option...

• OptionParser

絞り込み条件を変える

OptionParser#banner -> String (40.0)

• 2.2.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] = v
end
end

p opts.banner # =...

• OptionParser

OptionParser#help -> String (40.0)

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

• OptionParser

OptionParser#to_s -> String (40.0)

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

• OptionParser

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

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

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

• 2.2.0

• インスタンスメソッド

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

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

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

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

• OptionParser

絞り込み条件を変える

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

• 2.2.0

• インスタンスメソッド

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

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

サマリには on メソッドを呼んだ順にオプションが表示されるので、区切りを挿入したい
ところでこのメソッドを呼びます。

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

//emlist[][ruby]{
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"

opts.separator ""
opts.separator...

• OptionParser

OptionParser#to_a -> [String] (22.0)

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

OptionParser#ver -> String (22.0)

• 2.2.0

• インスタンスメソッド

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

program_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 = "2019-05-01"

opts.on_tail("--version", "Show v...

• OptionParser

RDoc::RDoc#document(argv) -> nil (22.0)

• 2.2.0

• インスタンスメソッド

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ
レクトリに出力します。

@param argv コマンドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。

@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。

指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力します。

• RDoc::RDoc