ライブラリ
- ビルトイン (62)
-
cgi
/ core (1) - csv (25)
-
fiddle
/ import (2) - fileutils (15)
- getoptlong (25)
-
irb
/ cmd / nop (2) -
irb
/ ext / math-mode (1) -
irb
/ ext / use-loader (3) - json (14)
- mkmf (25)
-
net
/ http (1) -
net
/ imap (2) - open-uri (7)
- openssl (2)
- optparse (86)
- pathname (5)
- psych (7)
- rake (1)
-
rake
/ rdoctask (4) -
rake
/ testtask (4) -
rdoc
/ generator / darkfish (1) -
rdoc
/ generator / json _ index (1) -
rdoc
/ generator / ri (1) -
rdoc
/ parser (1) -
rdoc
/ parser / c (1) -
rdoc
/ parser / ruby (1) -
rdoc
/ parser / simple (1) -
rubygems
/ command (8) -
rubygems
/ dependency _ installer (2) -
rubygems
/ installer (1) -
rubygems
/ security (6) -
rubygems
/ specification (2) -
rubygems
/ uninstaller (1) -
rubygems
/ version _ option (2) - shell (5)
-
shell
/ command-processor (4) -
shell
/ filter (1) -
shell
/ system-command (3) - socket (26)
- sync (3)
- syslog (8)
- tempfile (5)
-
webrick
/ httpservlet / abstract (3) -
webrick
/ httpservlet / filehandler (2) -
webrick
/ httpservlet / prochandler (1) -
win32
/ registry (31) - win32ole (2)
-
yaml
/ store (2)
クラス
-
ARGF
. class (2) - Array (1)
- BasicSocket (5)
- CGI (1)
- CSV (21)
-
CSV
:: Table (2) -
Encoding
:: Converter (3) -
Gem
:: Command (8) -
Gem
:: DependencyInstaller (2) -
Gem
:: Installer (1) -
Gem
:: Security :: Policy (1) -
Gem
:: Specification (2) -
Gem
:: Uninstaller (1) - GetoptLong (21)
- IO (24)
-
IRB
:: Context (2) -
IRB
:: ExtendCommand :: Nop (2) -
JSON
:: Parser (1) -
JSON
:: State (4) - Method (1)
-
Net
:: HTTP (1) -
Net
:: IMAP (2) - Object (2)
- OptionParser (59)
-
OptionParser
:: ParseError (10) - Pathname (5)
- Proc (1)
-
Psych
:: Nodes :: Node (2) -
Psych
:: Visitors :: YAMLTree (1) -
RDoc
:: Generator :: Darkfish (1) -
RDoc
:: Generator :: JsonIndex (1) -
RDoc
:: Generator :: RI (1) -
RDoc
:: Options (51) -
RDoc
:: Parser (1) -
RDoc
:: Parser :: C (1) -
RDoc
:: Parser :: Ruby (1) -
RDoc
:: Parser :: Simple (1) -
Rake
:: Application (1) -
Rake
:: RDocTask (4) -
Rake
:: TestTask (4) -
RubyVM
:: InstructionSequence (8) - Shell (5)
-
Shell
:: CommandProcessor (4) -
Shell
:: Filter (1) -
Shell
:: SystemCommand (3) -
Socket
:: Option (8) - String (9)
- Symbol (4)
-
Sync
_ m :: Err (1) -
Sync
_ m :: LockModeFailer (1) -
Sync
_ m :: UnknownLocker (1) - Tempfile (5)
-
WEBrick
:: HTTPServlet :: AbstractServlet (3) -
WEBrick
:: HTTPServlet :: FileHandler (2) -
WEBrick
:: HTTPServlet :: ProcHandler (1) -
WIN32OLE
_ METHOD (1) -
WIN32OLE
_ PARAM (1) -
Win32
:: Registry (8) -
YAML
:: Store (2)
モジュール
-
Fiddle
:: Importer (2) - FileUtils (15)
-
Gem
:: InstallUpdateOptions (2) -
Gem
:: LocalRemoteOptions (9) -
Gem
:: Security (5) -
Gem
:: VersionOption (2) -
IRB
:: ExtendCommandBundle (2) - JSON (9)
- Kernel (38)
-
OpenSSL
:: SSL :: SocketForwarder (2) - OpenURI (2)
-
OpenURI
:: OpenRead (3) -
OptionParser
:: Arguable (8) - Psych (2)
-
Socket
:: Constants (13) - Syslog (5)
-
Syslog
:: Option (3) -
Win32
:: Registry :: API (16) -
Win32
:: Registry :: Constants (7)
キーワード
-
ARGUMENT
_ FLAGS (1) - AmbiguousArgument (1)
- AmbiguousOption (2)
- Arguable (1)
- CloseKey (1)
- CreateKey (1)
-
DEFAULT
_ OPTIONS (2) - DEPRECATED (1)
- DeleteKey (1)
- DeleteValue (1)
- EnumKey (1)
- EnumValue (1)
- Fail (3)
- FlushKey (1)
-
IPPROTO
_ DSTOPTS (1) -
IPPROTO
_ HOPOPTS (1) -
IPV6
_ DSTOPTS (1) -
IPV6
_ HOPOPTS (1) -
IPV6
_ RECVDSTOPTS (1) -
IPV6
_ RECVHOPOPTS (1) -
IPV6
_ RTHDRDSTOPTS (1) -
IP
_ OPTIONS (1) -
IP
_ PKTOPTIONS (1) -
IP
_ RECVOPTS (1) -
IP
_ RECVRETOPTS (1) -
IP
_ RETOPTS (1) - InstallUpdateOptions (1)
- InvalidArgument (1)
- InvalidOption (2)
-
LOG
_ NDELAY (1) -
LOG
_ NOWAIT (1) -
LOG
_ ODELAY (1) - LocalRemoteOptions (1)
- MissingArgument (2)
-
NO
_ ARGUMENT (1) - NeedlessArgument (2)
-
OPTIONAL
_ ARGUMENT (1) -
OPT
_ TABLE (1) - ORDERINGS (1)
- OpenKey (1)
- OptionParser (1)
- Options (1)
- ParseError (1)
- QueryInfoKey (1)
- QueryValue (1)
-
REG
_ LEGAL _ OPTION (1) -
REG
_ OPTION _ BACKUP _ RESTORE (1) -
REG
_ OPTION _ CREATE _ LINK (1) -
REG
_ OPTION _ NON _ VOLATILE (1) -
REG
_ OPTION _ OPEN _ LINK (1) -
REG
_ OPTION _ RESERVED (1) -
REG
_ OPTION _ VOLATILE (1) -
REQUIRED
_ ARGUMENT (1) - SPECIAL (1)
-
STATUS
_ STARTED (1) -
STATUS
_ TERMINATED (1) -
STATUS
_ YET (1) - SetValue (1)
-
TCP
_ NOOPT (1) - [] (1)
- accept (2)
-
accept
_ uri _ http (1) -
add
_ bulk _ threshold _ option (1) -
add
_ common _ option (1) -
add
_ option (1) -
add
_ platform _ option (1) -
add
_ proxy _ option (1) -
add
_ source _ option (1) -
add
_ trusted _ cert (1) -
add
_ update _ sources _ option (1) -
add
_ version _ option (1) -
alias
_ command (3) -
all
_ one _ file (1) - args (1)
- bind (1)
- bool (1)
- both? (1)
-
build
_ cert (1) -
build
_ self _ signed _ cert (1) - capitalize (2)
- capitalize! (1)
-
cc
_ command (1) - charset (1)
- check (1)
-
check
_ signedness (2) - chmod (1)
-
chmod
_ R (1) - chown (1)
-
chown
_ R (1) -
collect
_ method (1) - compile (1)
-
compile
_ option (1) - configure (1)
-
convertible
_ int (2) -
coverage
_ report (1) -
coverage
_ report= (1) -
cpp
_ command (1) - create (5)
- data (1)
-
default
_ argv (1) -
default
_ argv= (1) -
default
_ system _ path (1) -
default
_ system _ path= (1) - diagram (1)
-
dir
_ config (1) - disasm (2)
- disassemble (2)
-
do
_ OPTIONS (2) - downcase (2)
- downcase! (1)
-
dry
_ run= (1) - dump (2)
-
e
_ option _ supplied (1) - each (1)
-
each
_ child (2) -
each
_ entry (1) -
each
_ option (1) -
egrep
_ cpp (2) - encoding= (1)
- entries (1)
- environment (1)
- error (1)
- error? (1)
- exclude= (1)
- exec (4)
- execute (2)
- extern (1)
-
extra
_ accessor _ flags (1) -
extra
_ accessors (1) - family (1)
- filter (3)
-
filter
_ backtrace (1) -
find
_ type (2) -
finish
_ page _ dir (1) -
force
_ output= (1) -
force
_ update (1) - foreach (2)
- formatter (1)
- formatter= (1)
-
from
_ state (1) - generate (1)
-
generate
_ line (1) - generator (1)
- generator= (1)
-
get
_ instance (2) -
get
_ one _ optional _ argument (1) - getopts (5)
- getsockopt (2)
-
have
_ macro (2) -
have
_ option? (1) -
have
_ type (2) - header (1)
- help (1)
-
hyperlink
_ all (1) -
hyperlink
_ all= (1) -
image
_ format (1) - initialize (2)
- inspect (1)
- install (1)
-
install
_ update _ defaults _ str (1) - instance (2)
- int (1)
-
irb
_ load (1) -
irb
_ require (1) -
line
_ numbers= (1) -
link
_ command (1) - load (2)
-
load
_ file (1) -
load
_ file! (1) - local? (1)
-
main
_ page (1) -
main
_ page= (1) - makedirs (1)
- markup (1)
- markup= (1)
-
math
_ mode= (1) - merge (1)
-
method
_ list (1) -
mkdir
_ p (1) - mkmf (1)
- mkpath (1)
- new (26)
- notify (4)
- on (12)
-
on
_ head (1) -
on
_ tail (1) -
op
_ dir= (1) -
op
_ name (1) - open (15)
- open! (1)
-
open
_ uri (2) -
option
_ list (1) -
option
_ parser (1) -
option
_ parser= (1) -
option
_ string (1) - optional? (1)
- optname (1)
- optparse (1)
-
optparse
/ date (1) -
optparse
/ shellwords (1) -
optparse
/ time (1) -
optparse
/ uri (1) - order (4)
- order! (4)
- packdw (1)
- packqw (1)
-
page
_ dir (1) -
page
_ dir= (1) - parameters (2)
- parse (6)
- parse! (3)
-
parse
_ csv (1) -
parse
_ line (1) -
parser
_ for (1) - permute (2)
- permute! (2)
- pipe (4)
- pipe= (1)
- popen (10)
-
pretty
_ generate (1) -
pretty
_ unparse (1) -
primitive
_ convert (1) -
program
_ name (1) -
program
_ name= (1) -
psych
_ to _ yaml (1) - quiet (1)
- quiet= (1)
- quiet? (1)
-
rb
_ scan _ args (1) - read (5)
- readlines (4)
- reason (1)
- reason= (1)
- recover (1)
- recvmsg (1)
-
recvmsg
_ nonblock (1) - reject (2)
- release (1)
- release= (1)
- remote? (1)
-
remove
_ option (1) - reopen (1)
- restore (1)
- root (1)
- root= (1)
-
ruby 1
. 8 . 4 feature (1) -
ruby
_ opts (1) -
ruby
_ opts= (1) -
safe
_ unlink (1) -
sanitize
_ path (1) -
search
_ convpath (1) - separator (1)
-
set
_ backtrace (1) -
set
_ encoding (4) -
set
_ error (1) -
set
_ option (1) - setsockopt (3)
-
show
_ all (1) -
show
_ all= (1) -
show
_ hash (1) -
sign
_ cert (1) -
size
_ opt _ params (1) - spawn (3)
- starttls (1)
-
static
_ path (1) -
static
_ path= (1) - summarize (2)
-
summary
_ indent (1) -
summary
_ indent= (1) -
summary
_ width (1) -
summary
_ width= (1) - swapcase (2)
- swapcase! (1)
- system (7)
-
tab
_ width (1) - table (1)
- template (1)
-
template
_ dir (1) -
template
_ dir= (1) - terminate (1)
- terminated? (1)
-
to
_ a (2) -
to
_ csv (2) -
to
_ s (4) -
to
_ yaml (2) -
trusted
_ cert _ path (1) -
try
_ constant (2) -
try
_ do (2) -
try
_ static _ assert (2) -
try
_ type (2) - unpack (1)
- unpackdw (1)
- unpackqw (1)
- upcase (2)
- upcase! (1)
- uptodate? (1)
-
use
_ loader= (1) - ver (1)
- verbosity= (1)
- version (1)
- version= (1)
- visibility (1)
- visibility= (1)
- warn (1)
-
warn
_ unless _ e _ option (1) -
warning
_ unless _ e _ option (1) - write (3)
- xsystem (1)
- yaml (1)
- 正規表現 (1)
- 環境変数 (1)
検索結果
先頭5件
-
Gem
:: Security :: OPT -> Hash (54604.0) -
ほとんどのメソッドで使用するデフォルトのオプションを返します。
ほとんどのメソッドで使用するデフォルトのオプションを返します。 -
Gem
:: InstallUpdateOptions # add _ install _ update _ options (54601.0) -
インストールとアップデートに関するオプションを追加します。
インストールとアップデートに関するオプションを追加します。 -
Gem
:: LocalRemoteOptions # add _ local _ remote _ options (54601.0) -
オプション --local, --remote, --both を追加します。
オプション --local, --remote, --both を追加します。 -
OptionParser
:: Arguable # getopts(short _ opt , *long _ opt) -> Hash (46393.0) -
指定された short_opt や long_opt に応じて自身をパースし、結果を Hash として返します。
指定された short_opt や long_opt に応じて自身をパースし、結果を Hash として返します。
コマンドラインに - もしくは -- を指定した場合、それ以降の解析を行ないません。
@param short_opt ショートネームのオプション(-f や -fx)を文字列で指定します。オプションが -f と -x の
2つの場合は "fx" の様に指定します。ここでオプションがないときは空文字列を指定します。
オプションが引数をとる場合は直後に ":" を付けます。
@param long_opt ロン... -
RDoc
:: Options # option _ parser -> OptionParser | nil (46201.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。 -
OptionParser
:: Arguable # options -> OptionParser (45976.0) -
自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。
自身をパースするための OptionParser オブジェクトを返します。
初回呼び出し時に自動的に生成されます。
この OptionParser#default_argv には self がセットされています。
ブロックを与えた場合は、OptionParser を引数としてブロックを実行します。
ブロックの実行結果を返します。
ブロックの実行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。
//emlist[][ruby]{
require 'optparse'
o = nil
ARG... -
OptionParser
:: Arguable # options {|opt| . . . } -> object | nil (45676.0) -
自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。
自身をパースするための OptionParser オブジェクトを返します。
初回呼び出し時に自動的に生成されます。
この OptionParser#default_argv には self がセットされています。
ブロックを与えた場合は、OptionParser を引数としてブロックを実行します。
ブロックの実行結果を返します。
ブロックの実行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。
//emlist[][ruby]{
require 'optparse'
o = nil
ARG... -
OptionParser
:: ParseError # set _ option(opt , eq) -> self (45658.0) -
エラーのあったオプションを指定します。
エラーのあったオプションを指定します。
eq が真の場合、self が管理するエラーのあったオプションの一覧の先頭を
opt で置き換えます。そうでない場合は先頭に opt を追加します。
@param opt エラーのあったオプションを指定します。
@param eq self が管理するエラーのあったオプションの一覧の先頭を置き換え
るかどうかを指定します。
@return self を返します。 -
OptionParser
:: Arguable # options=(opt) (45622.0) -
自身をパースするための OptionParser オブジェクトをセットします。
自身をパースするための OptionParser オブジェクトをセットします。
@param opt 自身をパースする OptionParser 、あるいは nil か false を指定します。
nil か false である場合、自身の options= メソッドと options メソッドを
undef します。 -
Gem
:: Command # handle _ options(args) (45601.0) -
与えられた引数のリストをパースして結果を記録します。
与えられた引数のリストをパースして結果を記録します。
@param args 引数のリストを指定します。 -
Gem
:: LocalRemoteOptions # add _ bulk _ threshold _ option (45601.0) -
オプション --bulk-threshold を追加します。
オプション --bulk-threshold を追加します。 -
Gem
:: LocalRemoteOptions # add _ proxy _ option (45601.0) -
オプション --http-proxy を追加します。
オプション --http-proxy を追加します。 -
Gem
:: LocalRemoteOptions # add _ source _ option (45601.0) -
オプション --source を追加します。
オプション --source を追加します。 -
Gem
:: LocalRemoteOptions # add _ update _ sources _ option (45601.0) -
オプション --update-source を追加します。
オプション --update-source を追加します。 -
Gem
:: VersionOption # add _ platform _ option(task = command , *wrap) (45601.0) -
option parser に対して --platform オプションを追加します。
option parser に対して --platform オプションを追加します。
@param task コマンド名を指定します。デフォルト値はインクルードされる側のクラスで指定されます。
@param wrap Gem::Command#add_option に渡すその他のオプションを指定します。 -
Gem
:: VersionOption # add _ version _ option(task = command , *wrap) (45601.0) -
option parser に対して --version オプションを追加します。
option parser に対して --version オプションを追加します。
@param task コマンド名を指定します。デフォルト値はインクルードされる側のクラスで指定されます。
@param wrap Gem::Command#add_option に渡すその他のオプションを指定します。 -
GetoptLong
:: OPTIONAL _ ARGUMENT -> 2 (45601.0) -
オプションにはオプショナル引数があることを表す定数です。
オプションにはオプショナル引数があることを表す定数です。 -
GetoptLong
:: STATUS _ TERMINATED -> 2 (45601.0) -
内部状態を管理するための定数です。ユーザが使用することはありません。
内部状態を管理するための定数です。ユーザが使用することはありません。 -
OptionParser
:: ParseError # args -> Array (45601.0) -
エラーのあったオプションの一覧を配列で返します。
エラーのあったオプションの一覧を配列で返します。
@return エラーのあったオプションの一覧。 -
OptionParser
:: ParseError # set _ backtrace(array) -> [String] (45601.0) -
自身に array で指定したバックトレースを設定します。
自身に array で指定したバックトレースを設定します。
@param array バックトレースを文字列の配列で指定します。
@return array を返します。 -
OptionParser
:: ParseError . filter _ backtrace(array) -> [String] (45601.0) -
array で指定されたバックトレースから optparse ライブラリに関する行を除 外します。
array で指定されたバックトレースから optparse ライブラリに関する行を除
外します。
デバッグモード($DEBUGが真)の場合は何もしません。
@param array バックトレースを文字列の配列で指定します。
@return array を返します。 -
RDoc
:: Options # option _ parser=(val) (45601.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。
コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。
@param val OptionParser オブジェクトを指定します。 -
RDoc
:: Options # static _ path -> [String] (45601.0) -
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。 -
RDoc
:: Options # static _ path=(vals) (45601.0) -
コマンドライン引数の --copy-files オプションと同様の指定を行います。
コマンドライン引数の --copy-files オプションと同様の指定を行います。
@param vals パスを文字列の配列で指定します。 -
Socket
:: Option # optname -> Integer (45601.0) -
ソケットのオプション名を表す整数を返します。
ソケットのオプション名を表す整数を返します。 -
OptionParser
:: Arguable # parse! -> [String] (45319.0) -
自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#parse! を参照して下さい。
自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。
OptionParser#parse! を参照して下さい。
@raise OptionParser::ParseError 自身のパースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスの例外になります。
//emlist[][ruby]{
require 'optparse'
o = nil
ARGV.options.on('-... -
GetoptLong
:: AmbiguousOption (45001.0) -
与えられたオプションは名前の後方が省略されていると思われるが、一意に決まらない 場合に発生する例外です。
与えられたオプションは名前の後方が省略されていると思われるが、一意に決まらない
場合に発生する例外です。 -
GetoptLong
:: InvalidOption (45001.0) -
知らないオプションが与えられた場合に発生する例外です。
知らないオプションが与えられた場合に発生する例外です。 -
OptionParser
:: AmbiguousOption (45001.0) -
補完が曖昧にしかできないオプションがあった場合に投げられます。
補完が曖昧にしかできないオプションがあった場合に投げられます。 -
OptionParser
:: InvalidOption (45001.0) -
定義されていないオプションが与えられた場合に投げられます。
定義されていないオプションが与えられた場合に投げられます。 -
optparse (37621.0)
-
コマンドラインのオプションを取り扱うためのライブラリです。
コマンドラインのオプションを取り扱うためのライブラリです。
=== チュートリアル
optparse を使う場合、基本的には
(1) OptionParser オブジェクト opt を生成する。
(2) オプションを取り扱うブロックを opt に登録する。
(3) opt.parse(ARGV) でコマンドラインを実際に parse する。
というような流れになります。
* optiondef
* optionarg
* longoption
* help
* subcmd
* argv
* hyphen_start_file
====[a:optiondef]... -
Gem
:: Command # add _ option(*opts) {|value , options| . . . } (37201.0) -
コマンドに対するコマンドラインオプションとハンドラを追加します。
コマンドに対するコマンドラインオプションとハンドラを追加します。
ブロックには、コマンドライン引数の値とそのオプションが渡されます。
オプションはハッシュになっています。
@param opts オプションを指定します。
@see OptionParser#make_switch -
GetoptLong
# each _ option {|optname , optarg| . . . } (37201.0) -
get メソッドのイテレータ版です。オプションとその引数の取得を 繰り返し行います。
get メソッドのイテレータ版です。オプションとその引数の取得を
繰り返し行います。
@see GetoptLong#get -
OptionParser
# getopts(*opts) -> Hash (36973.0) -
引数をパースした結果を、Hash として返します。
引数をパースした結果を、Hash として返します。
配列 argv を与えた場合、argv をパースします。そうでない場合は、
default_argv をパースします。
//emlist[][ruby]{
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... -
OptionParser
# getopts(argv , *opts) -> Hash (36973.0) -
引数をパースした結果を、Hash として返します。
引数をパースした結果を、Hash として返します。
配列 argv を与えた場合、argv をパースします。そうでない場合は、
default_argv をパースします。
//emlist[][ruby]{
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... -
FileUtils
. have _ option?(mid , opt) -> bool (36970.0) -
mid というメソッドが opt というオプションを持つ場合、真を返します。 そうでない場合は、偽を返します。
mid というメソッドが opt というオプションを持つ場合、真を返します。
そうでない場合は、偽を返します。
@param mid メソッド名を指定します。
@param opt オプション名を指定します。 -
Gem
:: Command . add _ common _ option(*args) {|value , options| . . . } (36901.0) -
全てのコマンドに共通するオプションを登録するためのメソッドです。
全てのコマンドに共通するオプションを登録するためのメソッドです。
@param args 追加するオプションの情報を指定します。 -
OptionParser
# parse!(argv = self . default _ argv , into: nil) -> [String] (36901.0) -
与えられた argv をパースします。
与えられた argv をパースします。
OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。
@param argv パースしたい引数を文字列の配列で指定します。
@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプシ... -
OptionParser
# program _ name=(name) (36901.0) -
プログラムの名前を文字列で指定します。
プログラムの名前を文字列で指定します。
@param name プログラムの名前を文字列で指定します。
//emlist[例][ruby]{
require "optparse"
OptionParser.new do |opts|
$0 # => /path/to/filename.rb
opts.program_name # => filename
opts.program_name = 'test' # => "test"
opts.program_name # => "test"... -
OptionParser
# summarize(to = [] , width = self . summary _ width , max = width - 1 , indent= self . summary _ indent) -> () (36901.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| . . . } -> () (36901.0) -
サマリを指定された to へと加えていきます。
サマリを指定された to へと加えていきます。
ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。
@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。
@param width サマリの幅を整数で指定します。
@param max サマリの最大幅を整数で指定します。
@param indent サマリのインデントを文字列で指定します。
//emlist[例][ruby]{
requ... -
OptionParser
. getopts(*opts) -> Hash (36901.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 (36901.0) -
引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)
引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)
@param argv パースしたい配列を指定します。
@param opts 引数を文字列で指定します。
@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。
@see OptionParser#getopts -
WIN32OLE
_ METHOD # size _ opt _ params -> Integer | nil (36622.0) -
オプションパラメータ数を取得します。
オプションパラメータ数を取得します。
@return オプションパラメータ数を整数で返します。メソッドの詳細情報を取
得できない場合はnilを返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 14.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
puts method.size_opt_params # => 5 -
FileUtils
:: OPT _ TABLE -> Hash (36604.0) -
内部で使用します。
内部で使用します。 -
CSV
:: DEFAULT _ OPTIONS -> Hash (36601.0) -
このオプションは呼び出し側で上書きしなかったときに使用するオプションです。
このオプションは呼び出し側で上書きしなかったときに使用するオプションです。
: :col_sep
","
: :row_sep
:auto
: :quote_char
'"'
: :field_size_limit
nil
: :converters
nil
: :unconverted_fields
nil
: :headers
false
: :return_headers
false
: :header_converters
nil
: :skip_blanks
false
: :force_quotes
false
: :skip_lin... -
Gem
:: Command # get _ one _ optional _ argument -> String (36601.0) -
コマンドラインからオプショナルな引数を取得して返します。
コマンドラインからオプショナルな引数を取得して返します。
@return 一つ以上、指定した場合は最初の値を返します。一つも指定していない場合は nil を返します。 -
Gem
:: DependencyInstaller :: DEFAULT _ OPTIONS -> Hash (36601.0) -
自身を初期化する際に使用するデフォルトのオプションです。
自身を初期化する際に使用するデフォルトのオプションです。
:env_shebang => false,
:domain => :both, # HACK dup
:force => false,
:format_executable => false, # HACK dup
:ignore_dependencies => false,
:security_policy => nil, # HACK NoSecurity requires OpenSSL. Al... -
OptionParser
# parse(*args , into: nil) -> [String] (36601.0) -
与えられた argv をパースします。 argv からオプションを取り除いたものを返します。
与えられた argv をパースします。
argv からオプションを取り除いたものを返します。
OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。
@param argv パースしたい引数を文字列の配列で指定します。
@param args パースしたい引数を順に文字列として与えます。
@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、Option... -
OptionParser
# parse(argv , into: nil) -> [String] (36601.0) -
与えられた argv をパースします。 argv からオプションを取り除いたものを返します。
与えられた argv をパースします。
argv からオプションを取り除いたものを返します。
OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。
@param argv パースしたい引数を文字列の配列で指定します。
@param args パースしたい引数を順に文字列として与えます。
@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、Option... -
OptionParser
# program _ name -> String (36601.0) -
プログラムの名前を文字列で返します。
プログラムの名前を文字列で返します。
デフォルトは $0 が使われます。
@return プログラムの名前を文字列で返します。
//emlist[例][ruby]{
require "optparse"
OptionParser.new do |opts|
p $0 # => /path/to/filename.rb
p opts.program_name # => filename
end
//} -
OptionParser
:: ParseError # reason=(reason) (36601.0) -
エラーの内容を指定します。
エラーの内容を指定します。
@param reason 文字列を指定します。 -
WIN32OLE
_ PARAM # optional? -> bool (36601.0) -
パラメータがオプションかどうかを取得します。
パラメータがオプションかどうかを取得します。
@return パラメータがオプション(省略可能)であれば真を返します。
tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
param1 = method.params[0]
puts "#{param1.name} #{param1.optional?}" # => Filename true -
Win32
:: Registry :: Constants :: REG _ LEGAL _ OPTION (36601.0) -
@todo
@todo -
Win32
:: Registry :: Constants :: REG _ OPTION _ BACKUP _ RESTORE (36601.0) -
@todo
@todo -
Win32
:: Registry :: Constants :: REG _ OPTION _ CREATE _ LINK (36601.0) -
@todo
@todo -
Win32
:: Registry :: Constants :: REG _ OPTION _ NON _ VOLATILE (36601.0) -
@todo
@todo -
Win32
:: Registry :: Constants :: REG _ OPTION _ VOLATILE (36601.0) -
@todo
@todo -
static void warn
_ unless _ e _ option(const char *str) (36601.0) -
ruby -e で与えたプログラムの評価中ではないなら、 警告メッセージ str を出力する。
ruby -e で与えたプログラムの評価中ではないなら、
警告メッセージ str を出力する。 -
static void warning
_ unless _ e _ option(const char *str) (36601.0) -
ruby -e で与えたプログラムの評価中ではなく、 しかも $VERBOSE が真ならば、警告メッセージ str を出力する。
ruby -e で与えたプログラムの評価中ではなく、
しかも $VERBOSE が真ならば、警告メッセージ str を出力する。 -
Gem
:: InstallUpdateOptions # install _ update _ defaults _ str -> String (36301.0) -
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
デフォルトのオプションは以下の通りです。
--rdoc --no-force --no-test --wrappers -
Gem
:: LocalRemoteOptions # local? -> bool (36301.0) -
ローカルの情報を取得する場合は真を返します。 そうでない場合は偽を返します。
ローカルの情報を取得する場合は真を返します。
そうでない場合は偽を返します。 -
OptionParser
# default _ argv -> [String] (36301.0) -
自身がデフォルトでパースする引数を文字列の配列で返します。
自身がデフォルトでパースする引数を文字列の配列で返します。
@param argv デフォルトでパースする文字列の配列を返します。
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new
# --hoo param1 --bar param2 をパラメーターに指定して実行
opts.default_argv # => ["--foo", "param1", "--bar", "param2"]
//} -
OptionParser
# default _ argv=(argv) (36301.0) -
自身がデフォルトでパースする引数を文字列の配列で指定します。
自身がデフォルトでパースする引数を文字列の配列で指定します。
OptionParser#parse の引数が指定されなかったときに使われます。
@param argv デフォルトでパースしたい文字列の配列を指定します。
//emlist[例][ruby]{
require "optparse"
config = {}
opts = OptionParser.new
opts.on("-r", "--require LIBRARY"){|lib| config[:lib] = lib }
# パラメーター指定なしで実行
opts.default_argv # => []
opts.p... -
OptionParser
# separator(sep) -> () (36301.0) -
サマリにオプションを区切るための文字列 sep を挿入します。 オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。
サマリにオプションを区切るための文字列 sep を挿入します。
オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。
サマリには on メソッドを呼んだ順にオプションが表示されるので、区切りを挿入したい
ところでこのメソッドを呼びます。
@param sep サマリの区切りを文字列で指定します。
//emlist[][ruby]{
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"
opts.separator ""
opts.separator... -
OptionParser
# summary _ indent -> String (36301.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,... -
OptionParser
# summary _ indent=(indent) (36301.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_indent # => " "
opts.summarize
# ... -
OptionParser
# summary _ width -> Integer (36301.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", " ... -
OptionParser
# summary _ width=(width) (36301.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_width # => 32
opts.summarize
# => [" -i, --init\n"... -
OptionParser
:: ParseError # message -> String (36301.0) -
標準エラーに出力するメッセージを返します。
標準エラーに出力するメッセージを返します。
@return 文字列を返します。 -
OptionParser
:: ParseError # reason -> String (36301.0) -
エラーの内容を文字列で返します。
エラーの内容を文字列で返します。
@return 文字列を返します。 -
OptionParser (36109.0)
-
コマンドラインのオプションを取り扱うためのクラスです。
コマンドラインのオプションを取り扱うためのクラスです。
オプションが指定された時に呼ばれるブロックを
OptionParser#on メソッドで登録していきます。
つまり、OptionParser を使う場合、基本的には
(1) OptionParser オブジェクト opt を生成する。
(2) オプションを取り扱うブロックを opt に登録する。
(3) opt.parse(ARGV) でコマンドラインを実際に parse する。
というような流れになります。
//emlist[][ruby]{
require "optparse"
ProgramConfig = Ha... -
optparse
/ shellwords (36037.0) -
OptionParser#on で使用可能な引数に Shellwords 追加されます。 オプションの引数は Shellwords.#shellwords によって配列に変換されてから、 OptionParser#on のブロックに渡されます。
OptionParser#on で使用可能な引数に Shellwords
追加されます。
オプションの引数は Shellwords.#shellwords によって配列に変換されてから、
OptionParser#on のブロックに渡されます。
//emlist[][ruby]{
require 'optparse/shellwords'
opts = OptionParser.new
opts.on("-s VAL", Shellwords){|a|
p a #=> ["hoge", "foo", "bar"]
}
opts.parse!
# ruby command -s hog... -
Gem
:: InstallUpdateOptions (36001.0) -
Gem::Command で使用するインストールとアップデートに関するオプションを 扱うためのモジュールです。
Gem::Command で使用するインストールとアップデートに関するオプションを
扱うためのモジュールです。 -
Gem
:: LocalRemoteOptions (36001.0) -
Gem::Command で使用する --local, --remote オプションのためのモジュールです。
Gem::Command で使用する --local, --remote オプションのためのモジュールです。 -
OptionParser
:: AmbiguousArgument (36001.0) -
オプションの引数が曖昧にしか補完できない場合に投げられます。
オプションの引数が曖昧にしか補完できない場合に投げられます。 -
OptionParser
:: Arguable (36001.0) -
主に Object::ARGV を拡張するために用意されたモジュールです。 optparse を require することにより、ARGV は OptionParser::Arguable を Object#extend します。
主に Object::ARGV を拡張するために用意されたモジュールです。
optparse を require することにより、ARGV は
OptionParser::Arguable を Object#extend します。
コマンドライン引数を表す文字列の配列を、拡張するためにも使うことができます。 -
OptionParser
:: InvalidArgument (36001.0) -
オプションの引数が指定されたパターンにマッチしない時に投げられます。
オプションの引数が指定されたパターンにマッチしない時に投げられます。 -
OptionParser
:: MissingArgument (36001.0) -
引数が必要なオプションに引数が与えられなかった場合に投げられます。
引数が必要なオプションに引数が与えられなかった場合に投げられます。 -
OptionParser
:: NeedlessArgument (36001.0) -
引数を取らないはずのオプションに引数が与えられた場合に投げられます。
引数を取らないはずのオプションに引数が与えられた場合に投げられます。 -
OptionParser
:: ParseError (36001.0) -
OptionParser の例外クラスの基底クラスです。
OptionParser の例外クラスの基底クラスです。 -
optparse
/ date (36001.0) -
OptionParser#on で使用可能なクラスに Date と DateTime が 追加されます。 オプションの引数はそれぞれのクラスのインスタンスに変換されてから、 OptionParser#on のブロックに渡されます。
OptionParser#on で使用可能なクラスに Date と DateTime が
追加されます。
オプションの引数はそれぞれのクラスのインスタンスに変換されてから、
OptionParser#on のブロックに渡されます。
//emlist[][ruby]{
require 'optparse/date'
opts = OptionParser.new
opts.on("-d DATE", Date){|d|
p d.to_s #=> 2000-01-01
}
opts.parse!
# ruby command -d 2000/1/1
//} -
optparse
/ time (36001.0) -
OptionParser#on で使用可能なクラスに Time が 追加されます。 オプションの引数は Time クラスのインスタンスに変換されてから、 OptionParser#on のブロックに渡されます。
OptionParser#on で使用可能なクラスに Time が
追加されます。
オプションの引数は Time クラスのインスタンスに変換されてから、
OptionParser#on のブロックに渡されます。
//emlist[][ruby]{
require 'optparse/time'
opts = OptionParser.new
opts.on("-t TIME", Time){|t|
p t #=> Sat, Jan 01 2000 00:00:00 +0900
}
opts.parse!
# ruby command -t '2000/01/01 00:00'
//}... -
optparse
/ uri (36001.0) -
OptionParser#on で使用可能なクラスに URI が 追加されます。 オプションの引数は URI クラスのインスタンスに変換されてから、 OptionParser#on のブロックに渡されます。
OptionParser#on で使用可能なクラスに URI が
追加されます。
オプションの引数は URI クラスのインスタンスに変換されてから、
OptionParser#on のブロックに渡されます。
//emlist[][ruby]{
require 'optparse/uri'
opts = OptionParser.new
opts.on("-u URI", URI){|u|
p u #=> #<URI::HTTP:0x201267d4 URL:http://www.example.com>
}
opts.parse!
# ruby command -u http://w... -
rubygems
/ install _ update _ options (36001.0) -
Gem::Command で使用するインストールとアップデートに関するオプションを 扱うためのモジュールを定義したライブラリです。
Gem::Command で使用するインストールとアップデートに関するオプションを
扱うためのモジュールを定義したライブラリです。 -
rubygems
/ local _ remote _ options (36001.0) -
Gem::Command で使用する --local, --remote オプションのためのモジュールを 定義したライブラリです。
Gem::Command で使用する --local, --remote オプションのためのモジュールを
定義したライブラリです。 -
BasicSocket
# getsockopt(level , optname) -> Socket :: Option (28273.0) -
ソケットのオプションを取得します。getsockopt(2) を参照してください。 取得したオプションのデータを Socket::Option で返します。
ソケットのオプションを取得します。getsockopt(2)
を参照してください。
取得したオプションのデータを Socket::Option で返します。
level, optname には Socket::SOL_SOCKET や Socket::SO_REUSEADDR
といった整数値の他、文字列("SOL_SOCKET", prefixなしの "SOCKET")や
シンボル(:SO_REUSEADDR, :REUSEADDR)を用いることができます。
@param level getsockopt(2) の 第二引数のlevel
@param optname gets... -
BasicSocket
# setsockopt(level , optname , optval) -> 0 (28201.0) -
ソケットのオプションを設定します。setsockopt(2) を参照してください。
ソケットのオプションを設定します。setsockopt(2)
を参照してください。
level, optname には Socket::SOL_SOCKET や Socket::SO_REUSEADDR
といった整数値の他、文字列("SOL_SOCKET", prefixなしの "SOCKET")や
シンボル(:SO_REUSEADDR, :REUSEADDR)を用いることができます。
optval には文字列、整数、真偽値(true or false)を渡すことができます。
文字列の場合には setsockopt(2) にはその文字列と
長さが渡されます。整数の場合はintへのポイン... -
OpenSSL
:: SSL :: SocketForwarder # setsockopt(level , optname , optval) -> 0 (28201.0) -
ラップされているソケットのオプションを設定します。
ラップされているソケットのオプションを設定します。
BasicSocket#setsockopt と同様です。
@param level setsockopt(2) の level に相当する整数を指定します
@param optname setsockopt(2) の option_name に相当する整数を指定します
@param optval 設定される値を文字列で指定します。
@raise Errno::EXXX オプションの設定に失敗した場合発生します。 -
Gem
:: Command # merge _ options(new _ options) -> Hash (27901.0) -
与えられたオプションとデフォルトのオプションをマージします。 しかし、新しいオプションに同一のキーがあってもデフォルトのオプションは変更されません。
与えられたオプションとデフォルトのオプションをマージします。
しかし、新しいオプションに同一のキーがあってもデフォルトのオプションは変更されません。
@param new_options 新しいコマンドオプションをハッシュで指定します。 -
GetoptLong
# each {|optname , optarg| . . . } (27901.0) -
get メソッドのイテレータ版です。オプションとその引数の取得を 繰り返し行います。
get メソッドのイテレータ版です。オプションとその引数の取得を
繰り返し行います。
@see GetoptLong#get -
JSON
:: State . from _ state(options) -> JSON :: State (27901.0) -
与えられた options によって生成した JSON::State のインスタンスを返します。
与えられた options によって生成した JSON::State のインスタンスを返します。
@param options JSON::State のインスタンスか、ハッシュを指定します。
@return options がハッシュである場合は、それによって初期化した JSON::State を
返します。options が JSON::State のインスタンスである場合は単に
options を返します。いずれでも無い場合は、何も設定されていない JSON::State の
インスタンスを返します。
//emlist[例 Hash... -
OpenSSL
:: SSL :: SocketForwarder # getsockopt(level , optname) -> String (27901.0) -
ラップされているソケットのオプションを設定します。
ラップされているソケットのオプションを設定します。
BasicSocket#getsockopt と同様です。
@param level getsockopt(2) の 第二引数のlevel に相当する整数を指定します
@param optname getsockopt(2) の 第三引数のoption_name に相当する整数を指定します -
RDoc
:: Parser . parser _ for(top _ level , file _ name , body , options , stats) -> RDoc :: Parser (27901.0) -
file_name を解析できるパーサのインスタンスを返します。 見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。
file_name を解析できるパーサのインスタンスを返します。
見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
Shell
:: CommandProcessor . alias _ command(alias , command , *opts) -> self (27901.0) -
@todo
@todo
@param alias エイリアスの名前を指定します。
@param command コマンド名を指定します。
@param opts コマンドに与えるオプションを指定します。
@raise SyntaxError コマンドのエイリアス作成に失敗した時に発生します。 -
Shell
:: CommandProcessor . alias _ command(alias , command , *opts) { . . . } -> self (27901.0) -
@todo
@todo
@param alias エイリアスの名前を指定します。
@param command コマンド名を指定します。
@param opts コマンドに与えるオプションを指定します。
@raise SyntaxError コマンドのエイリアス作成に失敗した時に発生します。 -
OpenURI
:: OpenRead # read(options = {}) -> String (27619.0) -
自身が表す内容を読み込んで文字列として返します。 self.open(options={}) {|io| io.read } と同じです。 このメソッドによって返される文字列は OpenURI::Meta によって extend されています。
自身が表す内容を読み込んで文字列として返します。
self.open(options={}) {|io| io.read } と同じです。
このメソッドによって返される文字列は OpenURI::Meta
によって extend されています。
@param options ハッシュを与えます。
require 'open-uri'
uri = URI.parse('http://www.example.com/')
str = uri.read
p str.is_a?(OpenURI::Meta) # => true
p str.content_type -
BasicSocket
# setsockopt(socketoption) -> 0 (27601.0) -
ソケットのオプションを設定します。setsockopt(2) を参照してください。
ソケットのオプションを設定します。setsockopt(2)
を参照してください。
level, optname には Socket::SOL_SOCKET や Socket::SO_REUSEADDR
といった整数値の他、文字列("SOL_SOCKET", prefixなしの "SOCKET")や
シンボル(:SO_REUSEADDR, :REUSEADDR)を用いることができます。
optval には文字列、整数、真偽値(true or false)を渡すことができます。
文字列の場合には setsockopt(2) にはその文字列と
長さが渡されます。整数の場合はintへのポイン... -
Gem
:: Command # options -> Hash (27601.0) -
コマンドで使用するオプションを返します。
コマンドで使用するオプションを返します。 -
Gem
:: Command # remove _ option(name) (27601.0) -
与えられた名前に一致するコマンドラインオプションを削除します。
与えられた名前に一致するコマンドラインオプションを削除します。
@param name 削除したいコマンドラインオプションの名前を指定します。