バージョン:2.2.0 > クエリ:IO > クエリ:options

コマンドライン引数を解析します。

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

また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。

* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合

RDoc::Options#pipe -> bool (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --pipe オプションを指定していた場合、true を返します。そうでない場合は false を返します。

コマンドライン引数の --pipe オプションを指定していた場合、true を返しま
す。そうでない場合は false を返します。

RDoc::Options#pipe=(val) (18001.0)

2.2.0

インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --pipe オプションと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --pipe オプションと同
様の指定を行います。

@param val --pipe オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。

RDoc::Options#promiscuous (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --promiscuous を指定していた場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --promiscuous を指定していた場合に true を返します。
そうでない場合は false を返します。

RDoc::Options#quiet -> bool (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --quiet オプションを指定していた場合、true を返します。そうでない場合は nil を返します。

コマンドライン引数の --quiet オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。

絞り込み条件を変える

RDoc::Options#rdoc_include -> [String] (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --include オプションで指定したディレクトリを文字列の配列で返します。

コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。

指定しなかった場合は ['.'] を返します。

RDoc::Options#root -> Pathname (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --root オプションで指定したディレクトリを返します。

コマンドライン引数の --root オプションで指定したディレクトリを返します。

指定されていない場合はカレントディレクトリを返します。

RDoc::Options#root=(val) (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --root オプションと同様の指定を行います。

コマンドライン引数の --root オプションと同様の指定を行います。

@param val パスを文字列で指定します。

RDoc::Options#sanitize_path(path) (18001.0)

2.2.0

インスタンスメソッド

ライブラリ内部で使用します。

RDoc::Options#show_all -> bool (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --all オプションを指定していた場合、true を返します。そうでない場合は false を返します。

コマンドライン引数の --all オプションを指定していた場合、true を返しま
す。そうでない場合は false を返します。

絞り込み条件を変える

RDoc::Options#show_all=(val) (18001.0)

2.2.0

インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --all オプションと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --all オプションと同様
の指定を行います。

@param val --all オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。

RDoc::Options#show_hash -> bool (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --show-hash オプションを指定していた場合、true を返します。そうでない場合は false を返します。

コマンドライン引数の --show-hash オプションを指定していた場合、true を
返します。そうでない場合は false を返します。

RDoc::Options#static_path -> [String] (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返します。

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。

RDoc::Options#static_path=(vals) (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --copy-files オプションと同様の指定を行います。

コマンドライン引数の --copy-files オプションと同様の指定を行います。

@param vals パスを文字列の配列で指定します。

RDoc::Options#tab_width -> Integer (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --tab-width オプションで指定した数値を返します。

絞り込み条件を変える

RDoc::Options#template -> String (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --template オプションで指定した名前を文字列の配列で返します。

コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。

指定しなかった場合は 'html' を返します。

RDoc::Options#template_dir -> String | nil (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --template オプションで指定したテンプレートに対応するディレクトリを返します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。

オプションの解析前は nil を返します。

RDoc::Options#template_dir=(val) (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --template オプションで指定したテンプレートに対応するディレクトリを設定します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。

@param val パスを文字列で指定します。

RDoc::Options#title -> String | nil (18001.0)

2.2.0

インスタンスメソッド

ドキュメントのタイトルを返します。指定されていない場合は nil を返します。

RDoc::Options#title=(string) (18001.0)

2.2.0

インスタンスメソッド

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文字列に設定します。

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。

コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。

@param string 設定するタイトルを文字列で指定します。

絞り込み条件を変える

RDoc::Options#verbosity -> 0 | 1 | 2 (18001.0)

2.2.0

インスタンスメソッド

プログラムの解析時に表示する情報の詳細さを数値で返します。

プログラムの解析時に表示する情報の詳細さを数値で返します。

以下の値を指定する事ができます。

: 0(--quiet オプションを指定した場合)

情報を表示しません。

: 1

通常の表示を行います。

: 2(--verbose オプションを指定した場合)

詳細な情報を表示します。

RDoc::Options#visibility -> :public | :protected | :private (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --visibility で指定したオプションを Symbol で返します。

コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。

RDoc::Options#visibility=(val) (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --visibility オプションと同様の指定を行います。

コマンドライン引数の --visibility オプションと同様の指定を行います。

@param val :public、:protected、:private のいずれかを指定します。

RDoc::Options#warn(message) -> nil (18001.0)

2.2.0

インスタンスメソッド

--verbose オプションを指定していた場合に message を標準エラー出力 $stderr に出力します。

--verbose オプションを指定していた場合に message を標準エラー出力
$stderr に出力します。

RDoc::Options#webcvs -> String | nil (18001.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --webcvs オプションで指定した URL を文字列で返します。

コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま
す。

指定しなかった場合は nil を返します。

絞り込み条件を変える

RDoc::Options::DEPRECATED -> {String -> String} (18001.0)

2.2.0

定数

非推奨のオプションの一覧を返します。

RubyVM::InstructionSequence.compile(source, file = nil, path = nil, line = 1, options = nil) -> RubyVM::InstructionSequence (9925.0)

2.2.0

特異メソッド

引数 source で指定した Ruby のソースコードを元にコンパイル済みの RubyVM::InstructionSequence オブジェクトを作成して返します。

引数 source で指定した Ruby のソースコードを元にコンパイル済みの
RubyVM::InstructionSequence オブジェクトを作成して返します。

@param source Ruby のソースコードを文字列で指定します。

@param file ファイル名を文字列で指定します。

@param path 引数 file の絶対パスファイル名を文字列で指定します。

@param line 引数 source の 1 行目の行番号を指定します。

@param options コンパイル時のオプションを true、false、Hash オブ
...

RubyVM::InstructionSequence.new(source, file = nil, path = nil, line = 1, options = nil) -> RubyVM::InstructionSequence (9925.0)

2.2.0

特異メソッド

引数 source で指定した Ruby のソースコードを元にコンパイル済みの RubyVM::InstructionSequence オブジェクトを作成して返します。

RubyVM::InstructionSequence.compile_file(file, options = nil) -> RubyVM::InstructionSequence (9922.0)

2.2.0

特異メソッド

引数 file で指定した Ruby のソースコードを元にコンパイル済みの RubyVM::InstructionSequence オブジェクトを作成して返します。

引数 file で指定した Ruby のソースコードを元にコンパイル済みの
RubyVM::InstructionSequence オブジェクトを作成して返します。

RubyVM::InstructionSequence.compile とは異なり、file、path などの
メタデータは自動的に取得します。

@param file ファイル名を文字列で指定します。

@param options コンパイル時のオプションを true、false、Hash オブ
ジェクトのいずれかで指定します。詳細は
RubyVM::Instr...

OptionParser#load(filename = nil) -> bool (9163.0)

2.2.0

インスタンスメソッド

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

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

パースが成功した場合に true を返します。
ファイルが存在しなかった場合に false を返します。

@param filename 各行をパースしたいファイルの名前を文字列で指定します。
指定されないか nil である場合、~/.options/ に
プログラムのサフィックスを付けた '~/.options/コマンド名' というファイルをパースします。

//emlist[例][ruby]{
re...

絞り込み条件を変える

OptionParser#banner=(heading) (9091.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#banner -> String (9073.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#help -> String (9073.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#separator(sep) -> () (9073.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#to_s -> String (9073.0)

2.2.0

インスタンスメソッド

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

絞り込み条件を変える

Syslog::Option::LOG_CONS -> Integer (9049.0)

2.2.0

定数