Ruby 3.0.0 リファレンスマニュアル > ライブラリ一覧 > optparseライブラリ > OptionParserクラス > banner=

instance method OptionParser#banner=

banner=(heading)[permalink][rdoc]

サマリの最初に表示される文字列を指定します。

[PARAM] heading:
サマリの最初に表示される文字列を指定します。


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|
    options[:verbose] = v
  end
end

opts.banner # => "Usage: example.rb [options]"