ponysay/README.md

117 lines
4.3 KiB
Markdown
Raw Normal View History

`ponysay` - A cowsay wrapper for ponies.
![Derp](http://i.imgur.com/xOJbE.png)
2012-05-02 22:00:09 +00:00
Today your terminal, tomorrow the world!
2012-04-17 09:43:24 +00:00
2012-07-16 23:32:30 +00:00
Installation on GNU/Linux (or other Unix implementations)
---------------------------------------------------------
2012-04-17 09:43:24 +00:00
First of all, you need `cowsay` from your local repositories.
2012-07-18 14:57:23 +00:00
Obtain it from [here](http://www.nog.net/~tony/warez) if you wish to compile it yourself.
2012-07-16 23:41:29 +00:00
This is often sufficient, but if is not you may be missing one of the standard packages: [bash](ftp://ftp.gnu.org/gnu/bash/), [coreutils](ftp://ftp.gnu.org/gnu/coreutils/) or [sed](ftp://ftp.gnu.org/gnu/sed/).
[Download](https://github.com/erkin/ponysay/downloads) or clone the project.
2012-07-16 23:29:25 +00:00
In the terminal, `cd` into the ponysay directory and `make && make install`.
2012-07-17 01:53:36 +00:00
This will install ponysay into the $PREFIX (`/usr` by default, meaning you may need to `make install` as root, e.g. `sudo make install`.)
2012-07-16 23:29:25 +00:00
2012-07-16 23:51:52 +00:00
If either `make` or `make install` fails you be missing one of the standard packages:
[gcc](ftp://ftp.gnu.org/gnu/gcc/), [gzip](ftp://ftp.gnu.org/gnu/gzip/), [make](ftp://ftp.gnu.org/gnu/make/) or [coreutils](ftp://ftp.gnu.org/gnu/coreutils/).
2012-04-17 09:43:24 +00:00
In order to use ponysay, run:
2012-04-17 09:43:24 +00:00
ponysay "I am just the cutest pony!"
2012-05-02 22:00:09 +00:00
Or if you have a specific pony in your mind:
ponysay -f pinkie "Partay!~"
2012-04-17 09:43:24 +00:00
2012-07-16 23:51:52 +00:00
Run `info ponysay`, `man 6 ponysay` or `ponysay -h` for more information.
2012-07-17 01:53:36 +00:00
A Spanish manual is available: `man -L es 6 ponysay`.
2012-07-16 23:51:52 +00:00
#### Gentoo
Theres a package for gentoo, to make install and keeping up to date easy. You can find it in [this overlay](/etu/aidstu-overlay). Package is named `games-misc/ponysay`.
2012-07-16 23:46:02 +00:00
2012-04-17 09:43:24 +00:00
### Pony fortune on terminal startup
2012-07-17 01:53:36 +00:00
This requires that you have the `fortune` utility installed. You can install it from your repositories (may be named `fortune-mod`)
2012-07-16 23:51:52 +00:00
or just fetch the source code from [here](ftp://ftp.ibiblio.org/pub/linux/games/amusements/fortune/).
2012-07-16 23:51:52 +00:00
You can try [this](http://www.reddit.com/r/mylittlelinux/comments/srixi/using_ponysay_with_a_ponified_fortune_warning/) script or
[ponypipe](https://github.com/maandree/ponypipe) to ponify fortunes.
2012-04-17 09:43:24 +00:00
Edit your `~/.bashrc` and add this to the end of the file
fortune | ponysay
2012-04-17 09:43:24 +00:00
Now every time you open a terminal a pony should give your fortune
2012-04-27 09:49:33 +00:00
2012-07-19 02:06:56 +00:00
### Pony quotes
Installing [ponyquotes4ponysay](https://github.com/maandree/ponyquotes4ponysay) will enable My Little Pony quotes with associated pony.
2012-07-20 02:55:29 +00: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 02:06:56 +00: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 14:29:43 +00: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 01:53:36 +00:00
exec ponysay "$@"
2012-05-07 14:30:27 +00:00
#RESET PALETTE HERE
2012-05-07 14:29:43 +00:00
}
fi
Installation on Microsoft™ Windows®
-----------------------------------
2012-05-02 22:07:27 +00:00
[¯\\\_(ツ)\_/¯](http://i.imgur.com/2nP5N.png)
2012-07-17 00:08:37 +00:00
Dependencies
------------
### Required runtime dependencies
`bash`: required for the main script [file: ponysay]
`cowsay`: this is a wrapper for cowsay
2012-07-19 23:44:47 +00:00
`coreutils`: the main script uses stty, cut, ls, cat, sort, readlink, pwd, head and tail
2012-07-17 00:08:37 +00:00
2012-07-19 23:44:47 +00:00
`sed`: used to remove .pony from pony names when running `ponysay -l` and `ponysay -l`
2012-07-17 00:08:37 +00:00
`perl`: required to run `ponysay -l` and `ponysay -L`
2012-07-18 17:39:04 +00:00
2012-07-17 00:08:37 +00:00
### Package building dependencies
`gcc`: used for compiling ponysaytruncater.c
`gzip`: used for compressing manpages
`make`: required to run the make script
`coreutils`: make script uses install, unlink, rm, ln, mkdir and cp
2012-05-02 22:07:27 +00:00
FAQ
---
2012-04-27 09:49:33 +00:00
__Q:__ The output looks like a mess in _(TTY/PuTTY/other)_!
__A:__ Unfortunately, there's nothing much we can do about it. See [issue 1](https://github.com/erkin/ponysay/issues/1).
__Q:__ You are missing _(my-favourite-pony)_!
2012-07-16 23:12:58 +00:00
__A:__ [Ask](https://github.com/erkin/ponysay/issues) and we'll add!
2012-04-27 09:49:33 +00:00
__Q:__ Which programs do you use to generate the pony files?
2012-07-16 23:51:52 +00:00
__A:__ The pony files are actually mostly a bunch of selected [browser ponies](http://web.student.tuwien.ac.at/~e0427417/browser-ponies/ponies.html)
that are generated into cow files via [img2xterm](https://github.com/rossy2401/img2xterm) or [util-say](https://github.com/maandree/util-say).