Method: GLI::App#synopsis_format

Defined in:
lib/gli/app.rb

#synopsis_format(format) ⇒ Object

Control how the SYNOPSIS is formatted.

format

one of:

:full

the default, show subcommand options and flags inline

:terminal

if :full would be wider than the terminal, use :compact

:compact

use a simpler and shorter SYNOPSIS. Useful if your app has a lot of options and showing them in the SYNOPSIS makes things more confusing



265
266
267
# File 'lib/gli/app.rb', line 265

def synopsis_format(format)
  @synopsis_format_type = format
end