ponysay/README.md

114 lines
4.1 KiB
Markdown
Raw Normal View History

2012-08-20 14:51:14 +02:00
`ponysay` — cowsay reimplemention for ponies.
![Derp](http://i.imgur.com/xOJbE.png)
2012-05-03 00:00:09 +02:00
Today your terminal, tomorrow the world!
2012-04-17 11:43:24 +02:00
2012-07-25 05:19:26 +02:00
2012-07-17 01:32:30 +02:00
Installation on GNU/Linux (or other Unix implementations)
---------------------------------------------------------
2012-04-17 11:43:24 +02:00
[Download](/erkin/ponysay/downloads) or clone the project.
2012-08-26 15:47:15 +02:00
In the terminal, `cd` into the ponysay directory and `./configure && make install`.
2012-08-19 05:14:48 +02:00
You make need to be super user to run `make install`, on most systems this
can be achieved by running `sudo make install`.
For more information we have provided you with an extensive [manual in PDF](https://github.com/erkin/ponysay/blob/master/ponysay.pdf?raw=true).
2012-07-17 01:29:25 +02:00
In order to use ponysay, run:
2012-04-17 11:43:24 +02:00
ponysay "I am just the cutest pony!"
2012-05-03 00:00:09 +02:00
Or if you have a specific pony in your mind:
ponysay -f pinkie "Partay!~"
2012-04-17 11:43:24 +02:00
2012-07-17 01:51:52 +02:00
Run `info ponysay`, `man 6 ponysay` or `ponysay -h` for more information.
2012-07-17 03:53:36 +02:00
A Spanish manual is available: `man -L es 6 ponysay`.
2012-07-17 01:51:52 +02:00
2012-07-21 15:20:47 +02:00
#### Arch Linux
The package is in the official repositories as `community/ponysay`.
#### Gentoo Linux
There is a package for Gentoo, to make installation and keeping it up to date easy. You can find it in [this overlay](/etu/aidstu-overlay). The package is named `games-misc/ponysay`.
#### Debian GNU/Linux and Ubuntu
2012-07-24 16:53:51 +02:00
The DEB file can be found [here](http://roryholland.co.uk/misc.html#ponysay) and the PPA can be found [here](https://launchpad.net/~blazemore/+archive/ponysay).
2012-07-17 01:46:02 +02:00
2012-04-17 11:43:24 +02:00
### Pony fortune on terminal startup
2012-07-17 03:53:36 +02:00
This requires that you have the `fortune` utility installed. You can install it from your repositories (may be named `fortune-mod`)
2012-07-17 01:51:52 +02:00
or just fetch the source code from [here](ftp://ftp.ibiblio.org/pub/linux/games/amusements/fortune/).
2012-07-17 01:51:52 +02:00
You can try [this](http://www.reddit.com/r/mylittlelinux/comments/srixi/using_ponysay_with_a_ponified_fortune_warning/) script or
[ponypipe](/maandree/ponypipe) to ponify fortunes.
2012-04-17 11:43:24 +02:00
Edit your `~/.bashrc` and add this to the end of the file
fortune | ponysay
2012-04-17 11:43:24 +02:00
Now every time you open a terminal a pony should give your fortune
2012-04-27 11:49:33 +02:00
2012-07-19 04:06:56 +02:00
### Pony quotes
2012-07-20 04:55:29 +02:00
Running `ponysay -q` will give you a random pony saying one it its quote from MLP:FiM. Add one or more argument after `-q` to sepecify a
2012-07-19 04:06:56 +02:00
set of ponies from which one will be selected randomly.
When running `ponysay -l` or `ponysay -L` the ponies which have quotes will be printed bold or bright (depending on terminal).
2012-05-07 16:29:43 +02:00
### Ponies in TTY (Linux VT)
If you have a custom colour palette edit your `~/.bashrc` and add
if [ "$TERM" = "linux" ]; then
function ponysay
{
2012-07-17 03:53:36 +02:00
exec ponysay "$@"
2012-05-07 16:30:27 +02:00
#RESET PALETTE HERE
2012-05-07 16:29:43 +02:00
}
fi
2012-08-20 14:02:05 +02:00
Read the PDF or info manual for more information.
2012-07-25 05:19:26 +02:00
Installation on Microsoft™ Windows®
-----------------------------------
2012-05-03 00:07:27 +02:00
[¯\\\_(ツ)\_/¯](http://i.imgur.com/2nP5N.png)
2012-07-25 05:19:26 +02:00
2012-07-17 02:08:37 +02:00
Dependencies
------------
### Required runtime dependencies
2012-08-20 14:02:05 +02:00
`coreutils`: stty in coreutils used to determine size of the terminal
2012-07-17 02:08:37 +02:00
2012-08-19 03:16:13 +02:00
`python>=3`: Written in python 3
2012-07-18 19:39:04 +02:00
2012-07-17 02:08:37 +02:00
### Package building dependencies
2012-08-26 15:48:01 +02:00
`gzip`: used for compressing manuals (suppressable with `./configure --without-info-compression --without-man-compression`)
2012-07-17 02:08:37 +02:00
2012-08-20 14:39:04 +02:00
`texinfo`: used for building info manual (suppressable with `./configure --without-info`)
2012-07-17 02:08:37 +02:00
2012-08-26 17:49:48 +02:00
`info`: used for installing info manual to info's dir file (suppressable with `./configure --without-info-install`)
2012-08-20 21:49:11 +02:00
Run `./dependency-test.sh` if things are not working for you.
2012-08-20 14:39:04 +02:00
2012-07-25 05:19:26 +02:00
2012-05-03 00:07:27 +02:00
FAQ
---
2012-04-27 11:49:33 +02:00
__Q:__ The output looks like a mess in _(TTY/PuTTY/other)_!
2012-08-22 17:36:33 +02:00
__A:__ Unfortunately we cannot make it perfect, see [issue 1](/erkin/ponysay/issues/1). But we have done a lot, read more about how to get the best the current state of the art has to offer in the [manual](/erkin/ponysay/blob/master/ponysay.pdf?raw=true).
2012-04-27 11:49:33 +02:00
__Q:__ You are missing _(my-favourite-pony)_!
__A:__ [Ask](/erkin/ponysay/issues) and we'll add!
2012-04-27 11:49:33 +02:00
__Q:__ Which programs do you use to generate the pony files?
2012-08-22 17:36:33 +02:00
__A:__ The pony files are actually mostly a bunch of selected [browser ponies](//web.student.tuwien.ac.at/~e0427417/browser-ponies/ponies.html), converted using [util-say](/maandree/util-say).
2012-08-22 17:34:24 +02:00
2012-08-22 17:36:33 +02:00
The [PDF manual](/erkin/ponysay/blob/master/ponysay.pdf?raw=true) should answer most of your questions.