Skip to content

Latest commit

 

History

History
81 lines (46 loc) · 2.02 KB

README.technical-documentation.md

File metadata and controls

81 lines (46 loc) · 2.02 KB

Options for cursestext

NOTE: VERBOSE is only available for builds from the 'devel' branch

In addition to SCROLL_TEXT and SCROLL_LINE variables, the submodule cursestext understands the variables VERBOSE and SCROLL_BOX.

Setting VERBOSE=1 will create a logfile: 'cursesscroller.log' in the current directory.

Here is an example:

SCROLL_BOX=1 SCROLL_LINE=-1 VERBOSE=1 scrolltext cursestext

The box is enabled by default.

In order to not draw the box, you can switch it off by defining the variable SCROLL_TEXT with an empty value or 0, e.g. use

SCROLL_BOX= SCROLL_LINE=-1 scrolltext cursestext

or

SCROLL_BOX=0 SCROLL_LINE=-1 scrolltext cursestext

Options for both interfaces

You can select the line via SCROLL_LINE variable. Negative values are counting from bottom to top, e.g. the following selects the 2nd last line in the current terminal:

SCROLL_TEXT="Hello, world." SCROLL_LINE=-2 scrolltext

Using a different scrolling speed

The scrolling speed can be altered by setting the environment variable SCROLL_SPEED There are 10 different speeds available. These can be selected by choosing a number between 0 and 9.

Slow scrolling speed (default, if not set)

SCROLL_SPEED=0 scrolltext

Fastest scrolling speed.

SCROLL_SPEED=10 scrolltext

Bugs and quirks

  • attempts to detect term-resize, and clumsily adjusts some things
  • documentation (even in this readme) is vague

Changes

v0.0.11

  • added color animation to cursestext
  • updated default config
  • some refactoring

v0.0.10

  • added config option for color (only linescroller)

v0.0.9

  • attempt to handle term resizes
  • added config-option: endless (see newly generated config-file)
  • removed logging from main branch (you may find it on the devel branch)

v0.0.8

  • doc-comments have never been generated, nor are those validated. (TODO)
  • renamed log-file to "scrolltext.log"
  • uses config file "scrolltextrc" *NIX uses "~/.config/scrolltextrc", windows uses "scrolltextrc" in current directory