種類
- インスタンスメソッド (26)
- 定数 (8)
- ライブラリ (5)
- 文書 (2)
- 特異メソッド (2)
ライブラリ
- getoptlong (1)
-
irb
/ cmd / help (1) -
irb
/ extend-command (1) -
net
/ ftp (1) - openssl (1)
- optparse (13)
-
rubygems
/ command (1) -
rubygems
/ commands / help _ command (2) - socket (4)
- win32ole (11)
クラス
-
Gem
:: Command (1) -
Gem
:: Commands :: HelpCommand (2) - GetoptLong (1)
-
IRB
:: ExtendCommand :: Help (1) -
Net
:: FTP (1) - OptionParser (13)
- Socket (2)
- WIN32OLE (5)
-
WIN32OLE
_ METHOD (3) -
WIN32OLE
_ TYPE (3)
モジュール
-
IRB
:: ExtendCommandBundle (1) -
OpenSSL
:: X509 (1) -
Socket
:: Constants (2)
キーワード
- EXAMPLES (1)
- HELP (1)
-
NEWS for Ruby 3
. 0 . 0 (1) -
PF
_ PIP (2) -
PF
_ RTIP (2) - PLATFORMS (1)
-
PURPOSE
_ OCSP _ HELPER (1) - Rubyの起動 (1)
- debug (1)
- execute (1)
- helpcontext (2)
- helpfile (2)
- helpstring (2)
-
install
_ extend _ commands (1) - irb (1)
-
ole
_ method (1) -
ole
_ method _ help (1) -
ole
_ obj _ help (1) -
ole
_ show _ help (1) -
ole
_ type (1) -
on
_ head (1) -
on
_ tail (1) - parse (2)
- parse! (1)
- rdoc (1)
-
rubygems
/ commands / environment _ command (1) -
rubygems
/ commands / generate _ index _ command (1) - separator (1)
- summarize (2)
-
summary
_ indent (1) -
summary
_ width (1) -
to
_ a (1) -
to
_ s (1)
検索結果
先頭5件
-
irb (79747.0)
-
irb は Interactive Ruby の略です。 irb を使うと、Ruby の式を標準入力から簡単に入力・実行することができます。
irb は Interactive Ruby の略です。
irb を使うと、Ruby の式を標準入力から簡単に入力・実行することができます。
=== irb の使い方
Ruby さえ知っていれば irb を使うのは簡単です。
irb コマンドを実行すると、以下のようなプロンプトが表れます。
$ irb
irb(main):001:0>
あとは Ruby の式を入力するだけで、その式が実行され、結果が表示されます。
irb(main):001:0> 1+2
3
irb(main):002:0> class Foo
irb(main):003:1> def f... -
OptionParser
# help -> String (63922.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... -
Net
:: FTP # help(arg = nil) -> String (54970.0) -
サーバからの help 情報を返します。
サーバからの help 情報を返します。
@param arg HELP コマンドのパラメータを指定します。
@raise Net::FTPTempError 応答コードが 4yz のときに発生します。
@raise Net::FTPPermError 応答コードが 5yz のときに発生します。
@raise Net::FTPProtoError 応答コードが RFC 的に正しくない場合に発生します。 -
WIN32OLE
_ METHOD # helpstring -> String | nil (46201.0) -
メソッドのヘルプ文字列を取得します。
メソッドのヘルプ文字列を取得します。
helpstringは、IDEがメソッドのバルーンヘルプを表示するような場合に利用可
能な、1行程度でメソッドを説明する文字列です。
@return ヘルプ文字列を返します。未定義ならばnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
method = WIN32OLE_METHOD.new(tobj, 'Navigate')
puts method.helpstring # => Navigates to a URL o... -
WIN32OLE
_ TYPE # helpstring -> String | nil (46201.0) -
型のドキュメント文字列を取得します。
型のドキュメント文字列を取得します。
@return ドキュメント文字列を返します。未定義の場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
p tobj.helpstring # => "Web Browser interface"
ドキュメント文字列は、コンテキストヘルプなどに利用可能な型の簡単な説明文です。 -
WIN32OLE
_ TYPE # helpfile -> String | nil (37255.0) -
オブジェクトに関連付けられたヘルプファイルのフルパス名。
オブジェクトに関連付けられたヘルプファイルのフルパス名。
ここで返されたヘルプファイルを表示するには、
WIN32OLE#ole_show_helpメソッドを呼び出します。
オブジェクトがヘルプファイルを持たない場合はnilを返します。
@return オブジェクトに関連付けられたヘルプファイルのフルパス名を文字列で返します。
ヘルプファイルが未定義の場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts tobj.helpf... -
WIN32OLE
_ METHOD # helpfile -> String | nil (37237.0) -
ヘルプファイルのパス名を取得します。
ヘルプファイルのパス名を取得します。
メソッドにヘルプファイルが関連付けられている場合、該当ヘルプファイルの
パス名を返します。
@return ヘルプファイルのパス名を文字列で返します。ヘルプファイルが未定
義ならばnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.helpfile # => C:\...\VBAXL9.CH... -
WIN32OLE
. ole _ show _ help(obj , helpcontext = nil) -> () (28258.0) -
WIN32OLEオブジェクトのヘルプファイルを表示します。
WIN32OLEオブジェクトのヘルプファイルを表示します。
Windows標準のヘルプ表示コンポーネントのHHCtrl.OCXを利用して、オブジェク
トに関連付けられたヘルプファイル(chmファイル)を表示します。
また、chmファイルのフルパス名を指定して表示させることも可能です。
@param obj WIN32OLE_TYPEオブジェクトまたはWIN32OLE_METHODオ
ブジェクト。直接ヘルプファイルのフルパス名を指定することも可
能です。
@param helpcontext obj引数にWIN32OLE_TYPEオブジェクト... -
WIN32OLE
_ METHOD # helpcontext -> Integer | nil (27937.0) -
メソッドのヘルプコンテキストを取得します。
メソッドのヘルプコンテキストを取得します。
ヘルプコンテキストは、関連するヘルプファイル上のトピック位置を示す整数
値です。
@return ヘルプコンテキストを返します。未定義の場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbooks')
method = WIN32OLE_METHOD.new(tobj, 'Add')
puts method.helpcontext # => 65717
WIN32OLE_METHODオブジェクトを引数として、WI... -
WIN32OLE
# ole _ obj _ help -> WIN32OLE _ TYPE | nil (27922.0) -
WIN32OLE_TYPEオブジェクトを返します。
WIN32OLE_TYPEオブジェクトを返します。
WIN32OLE_TYPEオブジェクトは、WIN32OLEオブジェクトの文書情報と型情
報を保持するオブジェクトです。
@return オブジェクトに関連するWIN32OLE_TYPEオブジェクトを返します。
オブジェクトがドキュメント情報を持たない場合はnilを返します。
excel = WIN32OLE.new('Excel.Application')
tobj = excel.ole_obj_help
@see WIN32OLE_TYPE -
WIN32OLE
_ TYPE # helpcontext -> Integer | nil (27901.0) -
この型に関連するヘルプファイルのトピックID(ヘルプコンテキスト)を取得 します。
この型に関連するヘルプファイルのトピックID(ヘルプコンテキスト)を取得
します。
@return 型に関連するヘルプコンテキストを整数で返します。ヘルプコンテキ
ストが登録されていない場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Worksheet')
puts tobj.helpcontext # => 131185 -
OptionParser
# summary _ indent -> String (19009.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 # => " "
opts.summarize
# => [" -i,... -
WIN32OLE
# ole _ method _ help(method) -> WIN32OLE _ METHOD (18922.0) -
メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま す。
メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま
す。
OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別されま
せん。
@param method メソッド情報を取り出す対象のメソッド名を文字列で指定します。
@return WIN32OLE_METHODオブジェクト。
@raise WIN32OLERuntimeError 指定したメソッド名が未定義あるいは型情報ラ
イブラリ(TypeLib)が提供されていない場合など
に発... -
Gem
:: Command :: HELP -> String (18904.0) -
ヘルプメッセージを表す文字列です。
ヘルプメッセージを表す文字列です。 -
OpenSSL
:: X509 :: PURPOSE _ OCSP _ HELPER -> Integer (18901.0) -
OCSP関連でOpenSSLの内部的に利用されます。
OCSP関連でOpenSSLの内部的に利用されます。
OpenSSL::X509::Store#purpose= や
OpenSSL::X509::StoreContext#purpose= で設定し、
OpenSSL::X509::Store#verify や
OpenSSL::X509::StoreContext#verify で
確認します。 -
OptionParser
# on _ tail(*arg , &block) -> self (18727.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
# summarize(to = [] , width = self . summary _ width , max = width - 1 , indent= self . summary _ indent) -> () (18709.0) -
サマリを指定された to へと加えていきます。
サマリを指定された to へと加えていきます。
ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。
@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。
@param width サマリの幅を整数で指定します。
@param max サマリの最大幅を整数で指定します。
@param indent サマリのインデントを文字列で指定します。
//emlist[例][ruby]{
requ... -
OptionParser
# summarize(to = [] , width = self . summary _ width , max = width - 1 , indent= self . summary _ indent) {|line| . . . } -> () (18709.0) -
サマリを指定された to へと加えていきます。
サマリを指定された to へと加えていきます。
ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。
@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。
@param width サマリの幅を整数で指定します。
@param max サマリの最大幅を整数で指定します。
@param indent サマリのインデントを文字列で指定します。
//emlist[例][ruby]{
requ... -
OptionParser
# summary _ width -> Integer (18709.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_width # => 32
opts.summarize
# => [" -i, --init\n", " ... -
IRB
:: ExtendCommand :: Help # execute(*names) -> nil (18673.0) -
RI から Ruby のドキュメントを参照します。
RI から Ruby のドキュメントを参照します。
irb(main):001:0> help String#match
...
@param names 参照したいクラス名やメソッド名などを文字列で指定します。
names を指定しなかった場合は、RI を対話的なモードで起動します。メソッド
名などを入力する事でドキュメントの検索が行えます。入力のタブ補完をする
事ができます。また、空行を入力する事で irb のプロンプトに戻る事ができま
す。
irb(main):001:0> help
Enter the method name you want to look... -
Socket
:: Constants :: PF _ PIP -> Integer (18649.0) -
Help Identify PIP packets。 Socket.open の第一引数 domain に使用します。
Help Identify PIP packets。
Socket.open の第一引数 domain に使用します。
@see socket(2freebsd) -
Socket
:: Constants :: PF _ RTIP -> Integer (18649.0) -
Help Identify RTIP packets。 Socket.open の第一引数 domain に使用します。
Help Identify RTIP packets。
Socket.open の第一引数 domain に使用します。
@see socket(2freebsd) -
Socket
:: PF _ PIP -> Integer (18649.0) -
Help Identify PIP packets。 Socket.open の第一引数 domain に使用します。
Help Identify PIP packets。
Socket.open の第一引数 domain に使用します。
@see socket(2freebsd) -
Socket
:: PF _ RTIP -> Integer (18649.0) -
Help Identify RTIP packets。 Socket.open の第一引数 domain に使用します。
Help Identify RTIP packets。
Socket.open の第一引数 domain に使用します。
@see socket(2freebsd) -
GetoptLong
# set _ options(*arguments) -> self (18637.0) -
あなたのプログラムで、認識させたいオプションをセットします。 個々のオプションは、オプション名と引数のフラグからなる配列でな ければいけません。
あなたのプログラムで、認識させたいオプションをセットします。
個々のオプションは、オプション名と引数のフラグからなる配列でな
ければいけません。
配列中のオプション名は、一文字オプション (例: -d) か長いオプ
ション (例: --debug) を表した文字列のいずれかでなければなり
ません。配列の中の一番左端のオプション名が、オプションの正式名
になります。配列中の引数のフラグは、GetoptLong::NO_ARGUMENT,
GetoptLong::REQUIRE_ARGUMENT, GetoptLong::OPTIONAL_ARGUMENT
のいずれかでなくてはなりません。
オ... -
OptionParser
# to _ s -> String (18622.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... -
WIN32OLE
# ole _ type -> WIN32OLE _ TYPE | nil (18622.0) -
WIN32OLE_TYPEオブジェクトを返します。
WIN32OLE_TYPEオブジェクトを返します。
WIN32OLE_TYPEオブジェクトは、WIN32OLEオブジェクトの文書情報と型情
報を保持するオブジェクトです。
@return オブジェクトに関連するWIN32OLE_TYPEオブジェクトを返します。
オブジェクトがドキュメント情報を持たない場合はnilを返します。
excel = WIN32OLE.new('Excel.Application')
tobj = excel.ole_obj_help
@see WIN32OLE_TYPE -
IRB
:: ExtendCommandBundle . install _ extend _ commands -> object (18619.0) -
定義済みの拡張を読み込みます。
定義済みの拡張を読み込みます。
irb で以下のメソッドが利用できるようになります。(それぞれ 1 つだけ抜粋)
* irb_current_working_workspace
* irb_change_workspace
* irb_workspaces
* irb_push_workspace
* irb_pop_workspace
* irb_load
* irb_require
* irb_source
* irb
* irb_jobs
* irb_fg
* irb_kill
* irb_help
irb/extend-command が requir... -
rubygems
/ commands / environment _ command (18037.0) -
RubyGems の環境に関する情報を表示するためのライブラリです。
RubyGems の環境に関する情報を表示するためのライブラリです。
Usage: gem environment [arg] [options]
Common Options:
-h, --help このコマンドのヘルプを表示します
-V, --[no-]verbose 表示を詳細にします
-q, --quiet 静かに実行します
--config-file FILE 指定された設定ファイル... -
rubygems
/ commands / generate _ index _ command (18037.0) -
ある Gem サーバに対するインデックスを作成するためのライブラリです。
ある Gem サーバに対するインデックスを作成するためのライブラリです。
Usage: gem generate_index [options]
Options:
-d, --directory=DIRNAME repository base dir containing gems subdir
Common Options:
-h, --help このコマンドのヘルプを表示します
-V, --[no-]verbose 表示を詳細にします
... -
OptionParser
# parse!(argv = self . default _ argv , into: nil) -> [String] (9973.0) -
与えられた argv をパースします。
与えられた argv をパースします。
OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。
@param argv パースしたい引数を文字列の配列で指定します。
@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプシ... -
OptionParser
# parse(*args , into: nil) -> [String] (9955.0) -
与えられた argv をパースします。 argv からオプションを取り除いたものを返します。
与えられた argv をパースします。
argv からオプションを取り除いたものを返します。
OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。
@param argv パースしたい引数を文字列の配列で指定します。
@param args パースしたい引数を順に文字列として与えます。
@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、Option... -
OptionParser
# parse(argv , into: nil) -> [String] (9955.0) -
与えられた argv をパースします。 argv からオプションを取り除いたものを返します。
与えられた argv をパースします。
argv からオプションを取り除いたものを返します。
OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。
@param argv パースしたい引数を文字列の配列で指定します。
@param args パースしたい引数を順に文字列として与えます。
@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、Option... -
OptionParser
# to _ a -> [String] (9673.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"]
//} -
WIN32OLE
# ole _ method(method) -> WIN32OLE _ METHOD (9622.0) -
メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま す。
メソッド名を指定して対応するWIN32OLE_METHODオブジェクトを取得しま
す。
OLEオートメーションの仕様により、メソッド名の大文字、小文字は区別されま
せん。
@param method メソッド情報を取り出す対象のメソッド名を文字列で指定します。
@return WIN32OLE_METHODオブジェクト。
@raise WIN32OLERuntimeError 指定したメソッド名が未定義あるいは型情報ラ
イブラリ(TypeLib)が提供されていない場合など
に発... -
Gem
:: Commands :: HelpCommand :: EXAMPLES -> String (9601.0) -
使用例を表す文字列です。
使用例を表す文字列です。 -
Gem
:: Commands :: HelpCommand :: PLATFORMS -> String (9601.0) -
プラットフォームに関する記述を格納している文字列です。
プラットフォームに関する記述を格納している文字列です。 -
OptionParser
# on _ head(*arg , &block) -> self (9391.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
# separator(sep) -> () (9319.0) -
サマリにオプションを区切るための文字列 sep を挿入します。 オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。
サマリにオプションを区切るための文字列 sep を挿入します。
オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。
サマリには on メソッドを呼んだ順にオプションが表示されるので、区切りを挿入したい
ところでこのメソッドを呼びます。
@param sep サマリの区切りを文字列で指定します。
//emlist[][ruby]{
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"
opts.separator ""
opts.separator... -
rdoc (559.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ... -
debug (541.0)
-
Ruby デバッガです。Ruby スクリプトのソースコードデバッグに使用します。
Ruby デバッガです。Ruby スクリプトのソースコードデバッグに使用します。
また、Emacs を使用したインタフェース rubydb3x.el が
https://github.com/ruby/elisp にあるので、活用してください。
=== 使い方
$ ruby -rdebug foo.rb
または、Emacs から
M-x load-library rubydb3x.el
M-x rubydb
=== デバッグコマンド
以下は、デバッガで使用できるコマンド名とその用法の一覧です。
各コマンド名には省略形があります。
ここに挙げたもの以外を入力し... -
Rubyの起動 (451.0)
-
Rubyの起動 * cmd_option * shebang
Rubyの起動
* cmd_option
* shebang
Rubyインタプリタの起動は以下の書式のコマンドラインにより行います。
ruby [ option ...] [ -- ] [ programfile ] [ argument ...]
ここで、option は後述のcmd_option
のいずれかを指定します。-- は、オプション列の終りを明示するため
に使用できます。programfile は、Ruby スクリプトを記述したファイ
ルです。これを省略したり`-' を指定した場合には標準入力を Ruby ス
クリプトとみなします。
programfile が... -
NEWS for Ruby 3
. 0 . 0 (91.0) -
NEWS for Ruby 3.0.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
...r
* Update to Bundler 2.2.3
* CGI
* Update to 0.2.0
* This version is Ractor compatible.
* CSV
* Update to CSV 3.1.9
* Date
* Update to Date 3.1.1
* This version is Ractor compatible.
* Digest
* Update to Digest 3.0.0
* This version is Ractor compatible.
* E...