README.rst

pipes.sh

Animated pipes terminal screensaver.

Screenshot of pipes.sh, click to watch a screencast on YouTube.

Contents

• Requirements
• Installation
• Options
  • -t [#]: pipe types
  • -t c[16 chars]: custom pipe
• Controls
• History
• Reporting an Issue
• Contribution
• Copyright

Requirements

• Bash 4+ since version 1.0.0.

• ncurses for tput

  • >= 6.1 (2018-01-27) for 24-bit colors and TERM=*-direct.

Installation

If you want to install, you can run:

$ make install

By default, it installs to /usr/local; for user home, you can run:

$ make PREFIX=$HOME/.local install

Or any PREFIX you prefer.

The Makefile also provides uninstall target.

If you are a Homebrew user, you can install via:

$ brew install pipes-sh

Options

See pipes.sh(6) for a full list of options.

-t [#]: pipe types

-t #	Characters	Screenshots
-t 0	┃┏ ┓┛━┓ ┗┃┛┗ ┏━
-t 1	│╭ ╮╯─╮ ╰│╯╰ ╭─
-t 2	│┌ ┐┘─┐ └│┘└ ┌─
-t 3	║╔ ╗╝═╗ ╚║╝╚ ╔═
-t 4	|+ ++-+ +|++ +-
-t 5	|/ \/-\ \|/\ /-
-t 6	.. .... .... ..
-t 7	.o oo.o o.oo o.
-t 8	-\ /\|/ /-\/ \| (railway)
-t 9	╿┍ ┑┚╼┒ ┕╽┙┖ ┎╾ (knobby)

-t c[16 chars]: custom pipe

For example, -t cMAYFORCEBWITHYOU.

Controls

Press any key to exit the program, except the following Shift + Key:

Keys	Actions
P / O	Increase/decrease probability of straight pipes
F / D	Increase/decrease frame rate
B	Toggle bold effect
C	Toggle no colors
K	Toggle keeping pipe color and type when crossing edges

History

(Read full history in pipes.sh(6))

pipes.sh was originally created by Matthew Simpson and posted to the Arch Linux Forums in early 2010. It was also later posted to Gist released in the public domain.

In 2015, the MIT License was added and the Pipeseroni collective was formed to maintain pipes.sh.

Reporting an Issue

• Reporting a bug

Contribution

Feel free to fork and/or create pull request following the guideline. If you're contributing, remember your changes will be released under the MIT license.

Copyright

pipes.sh is licensed under the MIT License.