ponysay/manuals/manpage.0

.\"                                      
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH PONYSAY 0 "July 12, 2012"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
ponysay \- Cowsay reimplementation for ponies
.SH SYNOPSIS
.B ponysay
.RI [ options ]
[--]
.RI [ message ]
.br
.B ponythink
.RI [ options ]
[--]
.RI [ message ]
.br
.SH DESCRIPTION
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBponysay\fP displays an image of a pony saying some text provided by the user in a terminal.
If \fImessage\fP is not provided, it accepts standard input, word-wraps the message given at
about 40 columns, and prints the pony saying the given message on standard output.
.PP
If no arguments are provided, the program only accepts standard input piped from another
program, a file or either here documents or here strings (see man bash(1) for details on here
document/string.)
.PP
\fBponythink\fP is to \fIponysay\fP as \fIcowthink\fP is to \fIcowsay\fP.
.PP
For an extensive documentation run `info ponysay`.
.SH OPTIONS
A summary of options is included below.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-v, \-\-version
Show version of program.
.TP
.B \-l, \-\-list
List pony files.
.TP
.B \-L, \-\-symlist, \-\-altlist
List pony files with alternative names inside brackets.
.TP
.B \+l, \+\+list
List non-MLP:FiM pony files.
.TP
.B \+L, \+\+symlist, \+\+altlist
List non-MLP:FiM pony files with alternative names inside brackets.
.TP
.B \-f, \-\-file, \-\-pony \fIname\fP
Select a pony (either a file name or a pony name), you can use this options multiple times,
and one of the will be selected randomly.
.TP
.B \-F, \+\+file, \+\+pony \fIname\fP
Select a non-MLP:FiM pony (either a file name or a pony name), you can use this options
multiple times, and one of the will be selected randomly.
.TP
.B \-q, \-\-quote [\fIname\fP...]
By using this option, a pony will be printed with quotes from her in My Little Pony:
Friendship is Magic. The pony will be selected randomly, unless at least one pony
is added as an argument to \fI-q\fP. If one or more ponies are added as an argument
to \fI-q\fP the pony will be selected randomly from that set of ponies.
.TP
.B \-W, \-\-wrap \fIcolumn\fP
The screen column where the message should be wrapped, the balloon's extra width is taken
into consideration. If the argument is not a number, but starts instead with \fIn\fP,
no wrapping is done, and if it starts with \fIi\fP the width of the terminal is used.
.TP
.B \-A, \-\-all
List all pony files, MLP-FiM and non-MLP-FiM, in this case the first list are MLP:FiM
and the second are non-MLP-FiM.
.TP
.B \+A, \+\+all, \-\-symall, \-\-altall
List all pony files, including alternatives names inside brackets, these from MLP:FiM and non-MLP:FiM
the first list are the MLP:FiM and the second one are non-MLP:FiM.
.TP
.B \-o, \-\-pony\-only, \-\-ponyonly
Just print the pony, nothing else like the speech balloon.
.TP
.B \+c, \-\-colour [\fIansi-colour\fP]
Colour the balloon, including link and message. For more colouring features, se the \fIinfo\fP
manual. The argument, \fIansi-colour\fP, should be a ANSI colour sequence without leading CSI
and without a tailing \fIm\fP, for example \fI1;31\fP will make it in red and bold (or bright
depending on the terminal.)
.SH ENVIRONMENT
.TP
.B PONYSAY_BOTTOM
Under TTY (Linux VT), if the output is larger the the screen's height, only the beginning is
printed, leaving two blank lines. If you want the bottom to be printed rather the the beginning
you can export \fIPONYSAY_BOTTOM\fP with the value \fIyes\fP, \fIy\fP or \fI1\fP.
.TP
.B PONYSAY_SHELL_LINES
Under TTY (Linux VT), if the output is larger the the screen's height, two lines are left blank.
If you want more, or less, blank lines you can export \fIPONYSAY_SHELL_LINES\fP with the value
of how many blank lines you want. Naturally this takes effect if the output is not actually
larger than the screen.
.TP
.B PONYSAY_FULL_WIDTH
You can export \fIPONYSAY_FULL_WIDTH\fP with the value \fIyes\fP, \fIy\fP or \fI1\fP, if you
do not want the output to be truncated on the width to fit the terminal.
.TP
.B PONYSAY_TRUNCATE_HEIGHT
Export \fIPONYSAY_TRUNCATE_HEIGHT\fP with the value \fIyes\fP, \fIy\fP or \fI1\fP, if you
want to truncate the output on the height even if you are not running \fIponysay\fP under TTY.
.TP
.B PONYSAY_UCS_ME
Export \fIPONYSAY_UCS_ME\fP with the value \fIyes\fP, \fIy\fP or \fI1\fP,
if you want [simulated] symlink to pony files using Universal Character Set
in their names.
.TP
.B PONYSAY_KMS_PALETTE
.B PONYSAY_KMS_PALETTE_CMD
\fIPONYSAY_KMS_PALETTE\fP or \fIPONYSAY_KMS_PALETTE_CMD\fP is used to tell
ponysay how your TTY palette looks, this feature lets you get the best images
in TTY if you have Kernel Mode Setting (KMS) support.
.SH BUG
Bugs can be reported in <\fBhttps://github.com/erkin/ponysay/issues\fP>.
.SH SEE ALSO
.BR cowsay (0),
.BR fortune (0).
.br
.SH AUTHOR
ponysay was written by Erkin Batu Altunbaş <erkinbatu@gmail.com>
with contributions from Mattias Andrée, Elis Axelsson, Sven-Hendrik Haase,
Pablo Lezaeta, Jan Alexander Steffens et al.
.\" See file CREDITS for full list.
.PP
This manual page was originally written by Louis Taylor <kragniz@gmail.com>
for the Debian GNU/Linux project (and may be used by others), and edited by
Mattias Andrée <maandree@kth.se> for the official ponysay release.
.br
.PP
This program is licensed under WTFPL.
.\" See file COPYING to see the license.