TTY::Pager Gitter

Gem Version Build Status Build status Code Climate Coverage Status Inline docs

Terminal output paging in a cross-platform way supporting all major ruby interpreters.

TTY::Pager provides independent terminal output paging component for TTY toolkit.

Installation

Add this line to your application's Gemfile:

gem 'tty-pager'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tty-pager

1. Usage

The TTY::Pager on initialization will choose the best available pager out of SystemPager, BasicPager or NullPager. If paging is disabled then a NullPager is used and content is simply printed out to stdout, otherwise a check is performed to find system executable to perform pagination natively with SystemPager. However, if no system executable is found, a BasicPager is used which is a pure Ruby implementation that will work with any ruby interpreter.

pager = TTY::Pager.new

Then to perform actual content pagination invoke page method with the content to paginate as the argument:

pager.page("Very long text...")

If you want to use specific pager you can do so by invoking it directly

pager = TTY::Pager::BasicPager.new

If you want to disable the pager pass the :enabled option:

pager = TTY::Pager.new enabled: false

For the BasicPager you can also pass a :prompt option to change the page break text:

prompt = -> (page_num) { output.puts "Page -#{page_num}- Press enter to continue" }
pager = TTY::Pager::BasicPager.new prompt: prompt

By default the SystemPager will check the PAGER environment variable, if not set it will try one of the less, more, cat, pager. Therefore, if you wish to set your prefered pager you can either set up your shell like so:

PAGER=less
export PAGER

or set PAGER in Ruby script:

ENV['PAGER']='less'

Contributing

  1. Fork it ( https://github.com/piotrmurach/tty-pager/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Copyright

Copyright (c) 2015-2017 Piotr Murach. See LICENSE for further details.