PonyMirrors/ponysay
1
0
Fork 0
mirror of https://github.com/erkin/ponysay.git synced 2024-11-25 05:47:59 +01:00
Code Issues Projects Releases Packages Wiki Activity

housekeeping

Browse source
This commit is contained in:
Mattias Andrée 2012-08-25 01:36:50 +02:00
parent eac51a5964
commit b58a931c1c
2 changed files with 122 additions and 105 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG
View file

@ -1,3 +1,8 @@
Version 2.4
Nothing worth mentioning.
Version 2.3 Version 2.3
Support for 'best.pony' file. Support for 'best.pony' file.

222
manuals/ponysay.texinfo
View file

@ -8,7 +8,7 @@
@documentlanguage en @documentlanguage en
@finalout @finalout
@c %**end of header @c %**end of header
@set VERSION 2.3 @set VERSION 2.5
@copying @copying
This manual is for ponysay This manual is for ponysay
@ -34,7 +34,11 @@ Texts. A copy of the license is included in the section entitled
@titlepage @titlepage
@title Ponysay @title Ponysay
@c@subtitle Cowsay reimplementation for ponies.
@c@subtitle Ponies for your terminal.
@subtitle Infesting your terminal with ponies. @subtitle Infesting your terminal with ponies.
@c@subtitle Surviving the zombiepony takeover.
@c@subtitle Making your terminal about 20 % cooler.
@subtitle Covers ponysay version @value{VERSION}. @subtitle Covers ponysay version @value{VERSION}.
@c ** start of front page image ** @c ** start of front page image **
@c If print make a pdf or hard copy with the front cover @c If print make a pdf or hard copy with the front cover
@ -61,7 +65,7 @@ Texts. A copy of the license is included in the section entitled
* Environment variables:: Getting more from @command{ponysay} with environment variables. * Environment variables:: Getting more from @command{ponysay} with environment variables.
* Limitations:: Known limitations that may not be that easy to overcome. * Limitations:: Known limitations that may not be that easy to overcome.
* Problems and requests:: Report issues and making requests. * Problems and requests:: Report issues and making requests.
* Dependencies:: Ponysay's Dependencies. * Dependencies:: Ponysay's dependencies.
* Installing:: How to install @command{ponysay}. * Installing:: How to install @command{ponysay}.
* Extensions:: Extensions. * Extensions:: Extensions.
* Inner workings:: Useful information for those whom want to help hack @command{ponysay}. * Inner workings:: Useful information for those whom want to help hack @command{ponysay}.
@ -81,19 +85,21 @@ Texts. A copy of the license is included in the section entitled
@chapter Overview @chapter Overview
@cindex overview @cindex overview
@command{ponysay} displays an image of a My Little Pony pony saying some text @command{ponysay} displays an image of a My Little Pony pony saying a message provided
provided by the user in a terminal, or a quote from the series. It is was wrapper for by the user in a terminal, or a quote from the show My Litte Pony: Friendship is Magic
@command{cowsay}, but since version 2.1 it reimplementation @command{cowsay}. (MLP:FiM). Historically @command{ponysay} was a wrapper fo cowsay, but has since
If message is not provided, e.g. by piping, it accepts standard input. The pony version 2.1 become an independent reimplementation of @command{cowsay}.
saying the given message is printed on standard output.
If a message is not provided, e.g. by piping, it accepts standard input. The pony
quoting the given message is printed on standard output.
@command{ponythink} is to @command{ponysay} as @command{cowthink} is to @command{ponythink} is to @command{ponysay} as @command{cowthink} is to
@command{cowsay}. @command{cowsay}.
@command{ponysay} is generally used to decorate your terminal with a random pony, when @command{ponysay} is generally used to decorate your terminal with a random pony, when
you start the terminal. But if you known anypony how does like ponies [fat chance] you you start the terminal. But if you know anypony how does like ponies [fat chance] you
can always make screen-shots of @command{ponysay -q} runs and communication that way can always make screen-shots of @command{ponysay -q} executions and communication that
over e-mail. way over e-mail.
@ -109,7 +115,7 @@ The format for running the @command{ponysay} program is:
@example @example
ponysay [@var{option}...] [--] [@var{message}] ponysay [@var{option}...] [--] [@var{message}]
ponythink [@var{option}...y] [--] [@var{message}] ponythink [@var{option}...] [--] [@var{message}]
@end example @end example
Running @command{ponysay} will print a speech balloon, @command{ponythink} will Running @command{ponysay} will print a speech balloon, @command{ponythink} will
@ -190,24 +196,24 @@ is added as an argument after @option{-q}. If one or more ponies are added after
This option requires the extension @command{ponyquotes4ponysay}, which is included This option requires the extension @command{ponyquotes4ponysay}, which is included
by default since version 1.2. by default since version 1.2.
The argument can be a file name, but pony if it ends with @file{.pony}. The argument can be a file name, but only if it ends with @file{.pony}.
@item -W COLUMN @item -W COLUMN
@itemx --wrap COLUMN @itemx --wrap COLUMN
@cindex @option{-W} @cindex @option{-W}
@cindex @option{--wrap} @cindex @option{--wrap}
Specify the screen column where the message should be wrapped, Specify the screen column where the message should be wrapped, this is by default 40,
this is by default 40, which is inherited from @command{cowsay}. as with @command{cowsay}.
@item -c @item -c
@itemx --compress @itemx --compress
@cindex @option{-c} @cindex @option{-c}
@cindex @option{--compress} @cindex @option{--compress}
@cindex figlet @cindex @command{figlet}
@cindex toilet @cindex @command{TOIlet}
Compress the message in the same way @command{cowsay} does, that is basically Compress the message in the same way @command{cowsay} does, that is basically
without multiple spaces, one only paragraphs seperations. Using this options without multiple spaces, and only paragraphs seperations. Using this options
will mean that you cannot display @command{filet} and @command{TOIlet} style will mean that you cannot display @command{figlet} and @command{TOIlet} style
messages. messages.
@item -l @item -l
@ -232,15 +238,15 @@ inside brackets after their target ponies.
@itemx ++list @itemx ++list
@cindex @option{+l} @cindex @option{+l}
@cindex @option{++list} @cindex @option{++list}
Just as @option{-l}, but it lists extra (non-MLP:FiM) ponies instead of standard Just as @option{-l}, except it lists extra (non-MLP:FiM) ponies instead of standard
(MLP:FiM) ponies (MLP:FiM) ponies.
@item +L @item +L
@itemx ++altlist @itemx ++altlist
@cindex @option{+L} @cindex @option{+L}
@cindex @option{++altlist} @cindex @option{++altlist}
Just as @option{-L}, but it lists extra (non-MLP:FiM) ponies instead of standard Just as @option{-L}, except it lists extra (non-MLP:FiM) ponies instead of standard
(MLP:FiM) ponies (MLP:FiM) ponies.
@item -B @item -B
@itemx --balloonlist @itemx --balloonlist
@ -252,14 +258,14 @@ Prints a list of all balloon styles.
@cindex @var{message} @cindex @var{message}
If neither @option{-q} is used nor any @var{message} is specified, @command{ponysay} If neither @option{-q} is used nor any @var{message} is specified, @command{ponysay}
will read the message from stdin (standard input); however, if no arguments are used will read the message from stdin (standard input); however, if no arguments are used
that nothing is piped to stdin, a help message will be printed. If you want to use and nothing is piped to stdin, a help message will be printed. If you want to use
@command{ponysay} without arguments and enter the message by hand, you can run @command{ponysay} without arguments and enter the message by hand, you can run
@code{cat | ponysay}. @code{cat | ponysay}.
@cindex @file{best.pony} @cindex @file{best.pony}
If no pony is selected, @command{ponysay} will look for a @file{best.pony} file, If no pony is selected, @command{ponysay} will look for a @file{best.pony} file,
this should be a symbolic link to the pony you want as a default. If it is not a this file should be a symbolic link to the pony you want as a default. If it is not
symbolic link, @option{-q} cannot determine which quotes to use. a symbolic link, @option{-q} cannot determine which quotes to use.
@node Advanced usage @node Advanced usage
@ -298,13 +304,13 @@ described in the previous paragraph every time you open a terminal.
@cindex text ponification @cindex text ponification
@cindex ponypipe @cindex ponypipe
You can ponify text (i.e. replaces words search as `everyone' with `everypony') You can ponify messages (i.e. replaces words search as `everyone' with `everypony') by
by using @code{fortune | ponypipe} instead of using @command{fortune}. using @code{fortune | ponypipe} instead of using @command{fortune}. @command{ponypipe}
@command{ponypipe} can be downloaded from @url{https://github.com/maandree/ponypipe}. can be downloaded from @url{https://github.com/maandree/ponypipe}.
Alternatively you can use @command{pinkie} (or @command{pinkiepie}), which can Alternatively you can use @command{pinkie} (or @command{pinkiepie}), which can be
be downloaded from @url{https://github.com/maandree/pinkie-pie}, which is just downloaded from @url{https://github.com/maandree/pinkie-pie}, which is just
@code{fortune | ponypipe}. There is also a large @command{sed} script, similar @code{fortune | ponypipe}. There is also a large @command{sed} script, similar to
to @command{ponypipe}: @url{http://www.reddit.com/r/mylittlelinux/comments/srixi/using_ponysay_with_a_ponified_fortune_warning/} @command{ponypipe}: @url{http://www.reddit.com/r/mylittlelinux/comments/srixi/using_ponysay_with_a_ponified_fortune_warning/}
However I think @command{ponypipe} as better at replacing words than the @command{sed} However I think @command{ponypipe} as better at replacing words than the @command{sed}
script, but I haven't used the script so I wouldn't know for sure. script, but I haven't used the script so I wouldn't know for sure.
@ -375,11 +381,11 @@ with the value @code{yes}, @code{y} or @code{1}.
@item PONYSAY_SHELL_LINES @item PONYSAY_SHELL_LINES
@cindex @env{PONYSAY_SHELL_LINES} @cindex @env{PONYSAY_SHELL_LINES}
@cindex tty @cindex tty
Under TTY (Linux VT), if the output is larger the the screen's height, two Under TTY (Linux VT), if the output is larger than the screen's height, two
lines are left blank. If you want more, or less, blank lines you can export lines are left blank. If you want more, or less, blank lines you can export
@env{PONYSAY_SHELL_LINES} with the value of how many blank lines you want. @env{PONYSAY_SHELL_LINES} with the value of how many blank lines you want.
Naturally this takes effect if the output is not actually larger than the Naturally this takes effect eve n if the output is not actually larger than
screen. the screen.
@item PONYSAY_FULL_WIDTH @item PONYSAY_FULL_WIDTH
@cindex @env{PONYSAY_FULL_WIDTH} @cindex @env{PONYSAY_FULL_WIDTH}
@ -406,7 +412,7 @@ the ASCII:ised names export @env{PONYSAY_UCS_ME} with the value @code{harder},
@code{h} or @code{2} instead. @code{h} or @code{2} instead.
If you have not enabled this, UCS names are not usable, suggested or listed. If you have not enabled this, UCS names are not usable, suggested or listed.
If you use @code{yes} UCS names will be usable, suggested or listed. If you If you use @code{yes} UCS names will be usable, suggested and listed. If you
use @code{harder} ASCII:ised names will not be suggested or listed, but they use @code{harder} ASCII:ised names will not be suggested or listed, but they
will still be usable. will still be usable.
@ -463,8 +469,8 @@ Ponysay works perfectly on @command{xterm}, @command{xterm} like terminals inclu
@cindex kernel mode settings @cindex kernel mode settings
@cindex tty @cindex tty
@cindex linux vt @cindex linux vt
On Linux's native terminal Linux VT (TTY) it works less well, and not good at all with On Linux's native terminal Linux VT (TTY) it works less well, and not good at all
Kernel Mode Settings (KMS) support. See @url{https://github.com/erkin/ponysay/issues/1} without Kernel Mode Settings (KMS) support. See @url{https://github.com/erkin/ponysay/issues/1}
for more information. @command{ponysay} clears the screen before printing to TTY, this for more information. @command{ponysay} clears the screen before printing to TTY, this
is because if your graphics driver supports KMS, the colours will be messed by when the is because if your graphics driver supports KMS, the colours will be messed by when the
ponies position moves on the screen, this is also reason why the output is truncated on ponies position moves on the screen, this is also reason why the output is truncated on
@ -484,9 +490,9 @@ transparency.)
@cindex Eterm @cindex Eterm
@cindex aterm @cindex aterm
@command{ponysay} works perfectly on @command{xterm}, @command{urxvt} and @command{ponysay} works perfectly on @command{xterm}, @command{urxvt} and
@command{putty}, but @command{rxvt}, @command{mrxvt} and @command{Eterm} do not @command{putty}, but @command{rxvt}, @command{mrxvt} and @command{Eterm} do not have
have UTF-8 support and are currently not supported. Additionally @command{aterm} UTF-8 support and are currently not supported. Additionally @command{aterm} have
have neither UTF-8 support nor 256 colour support, and is therefore not yet support. neither UTF-8 support nor 256 colour support, and is therefore not yet supported.
@cindex 9term @cindex 9term
Due to extreme limitations in @command{9term} @command{ponysay} will never be able to Due to extreme limitations in @command{9term} @command{ponysay} will never be able to
@ -594,8 +600,8 @@ It can be downloaded at @url{https://github.com/maandree/util-say}.
@cindex images, png @cindex images, png
@cindex portable network graphics @cindex portable network graphics
For the purpose of simplifying for pony contributors, @command{ponysay} supports For the purpose of simplifying for pony contributors, @command{ponysay} supports
using .png-images (note that the file must not miss the @file{.png} in the file) using .png-images (note that the file must not miss the @file{.png} at the end of
in addition of .pony-files or pony names. the file name) in addition to .pony-files or pony names.
@end table @end table
@ -677,8 +683,8 @@ If you have @command{git} you can @command{clone} the project URL
@url{https://github.com/erkin/ponysay.git}. @url{https://github.com/erkin/ponysay.git}.
In the terminal, @command{cd} into the ponysay directory and execute In the terminal, @command{cd} into the ponysay directory and execute
@command{./configure && make install}. This will install @command{ponysay} into the @command{./configure && make install}. This will install @command{ponysay} into
@file{/usr}, meaning you may need to run @command{make install} as root, @file{/usr}, normally meaning you need to run @command{make install} as root,
e.g. by running @command{sudo make install}. e.g. by running @command{sudo make install}.
Now you will be to use ponysay, run: @command{ponysay "I am just the cutest pony!"}, Now you will be to use ponysay, run: @command{ponysay "I am just the cutest pony!"},
@ -687,7 +693,7 @@ or if have a specific pony in your mind: @command{ponysay -f pinkie "Partay!~"}.
@cindex manpage translations @cindex manpage translations
@command{ponysay} comes with this @command{info} manual and a manpage in section 6, @command{ponysay} comes with this @command{info} manual and a manpage in section 6,
@command{man 6 ponysay} (or just @command{man ponysay}). The manpage is also available @command{man 6 ponysay} (or just @command{man ponysay}). The manpage is also available
in Spanish: @command{man -L es 6 ponysay}. The install the Spanish manual add the in Spanish: @command{man -L es 6 ponysay}. To install the Spanish manual add the
option @option{--with-man-es} when running @command{./configure}. option @option{--with-man-es} when running @command{./configure}.
@ -717,7 +723,7 @@ After @option{--everything} it is possible to remove unwanted parts, this can of
cause be done without @option{--everything}. If you want to install the PDF manual cause be done without @option{--everything}. If you want to install the PDF manual
to @file{/usr/doc/ponysay.pdf} add the option @option{--with-pdf} when running to @file{/usr/doc/ponysay.pdf} add the option @option{--with-pdf} when running
@command{./configure}. To install a manpage translation add @option{--with-man-LANG} @command{./configure}. To install a manpage translation add @option{--with-man-LANG}
and substitute the the language code for @code{LANG}. Currently the only translation and substitute the language code for @code{LANG}. Currently the only translation
is Spanish with the language code @code{es}. If you do not want the English manpage is Spanish with the language code @code{es}. If you do not want the English manpage
add the option @option{--without-man}. If you do not want the @command{info} manual add the option @option{--without-man}. If you do not want the @command{info} manual
add the option @option{--without-info}. If you are installing the @command{info} add the option @option{--without-info}. If you are installing the @command{info}
@ -730,18 +736,18 @@ The following argumentless options are also recognised:
@item @option{--without-bash} @item @option{--without-bash}
@cindex @option{--without-bash} @cindex @option{--without-bash}
@cindex @command{bash}, without @cindex @command{bash}, without
will skip installation of auto-completion for @command{ponysay} and the will skip installation of auto-completion for @command{ponysay} and
GNU Bourne-again shell, @command{bash}. @command{ponythink} under the GNU Bourne-again shell, @command{bash}.
@item @option{--without-fish} @item @option{--without-fish}
@cindex @option{--without-fish} @cindex @option{--without-fish}
@cindex @command{fish}, without @cindex @command{fish}, without
will skip installation of auto-completion for @command{ponysay} and the will skip installation of auto-completion for @command{ponysay} and
Friendly interactive shell, @command{fish}. @command{ponythink} under the Friendly interactive shell, @command{fish}.
@item @option{--without-zsh} @item @option{--without-zsh}
@cindex @option{--without-zsh} @cindex @option{--without-zsh}
@cindex @command{zsh}, without @cindex @command{zsh}, without
will skip installation of auto-completion for @command{ponysay} and the will skip installation of auto-completion for @command{ponysay} and
shell @command{zsh}. @command{ponythink} under the shell @command{zsh}.
@item @option{--without-shared-cache} @item @option{--without-shared-cache}
@cindex @option{--without-shared-cache} @cindex @option{--without-shared-cache}
@cindex cache @cindex cache
@ -754,8 +760,8 @@ shared cache, private one will be used at @file{~/.cache/ponysay}.
@cindex @file{/usr/games} @cindex @file{/usr/games}
The program is by default installed in @file{/usr}, if you want another target The program is by default installed in @file{/usr}, if you want another target
directory, you can add @option{--prefix=TARGET} when running @command{./configure}. directory, you can add @option{--prefix=TARGET} when running @command{./configure}.
For example to install @command{ponysay} in @file{/usr/games} you build the For example to install @command{ponysay} in @file{/usr/local} you build the
program by running @command{./configure --prefix=/usr/games}, and alike for program by running @command{./configure --prefix=/usr/local}, and alike for
installation and uninstallation. Notice the @command{=} cannot be substituted installation and uninstallation. Notice the @command{=} cannot be substituted
with white space. with white space.
@ -775,8 +781,8 @@ add the option @command{--shell=SHELL}.
@cindex arch linux @cindex arch linux
The official Arch Linux package repositories contains @command{ponysay} as The official Arch Linux package repositories contains @command{ponysay} as
@w{@code{community/ponysay}}. The Arch Linux User Repository (AUR) contains a bleeding @w{@code{community/ponysay}}. The Arch Linux User Repository (AUR) contains a
edge git version of @command{ponysay} as @code{ponysay-git}. bleeding edge git version of @command{ponysay} as @code{ponysay-git}.
@node Gentoo Linux @node Gentoo Linux
@ -806,7 +812,7 @@ manually from the upstream, you can uninstall it by running @command{make uninst
Well written package manages will uninstall files that the package is no longer Well written package manages will uninstall files that the package is no longer
using, i.e. if deleted, moved or renamed. To uninstall files that are not longer using, i.e. if deleted, moved or renamed. To uninstall files that are not longer
used, by the currently installed version you will need that versions @file{Makefile}. used, by the currently installed version you will need that versions @file{Makefile}.
To perform the uninstallation of old filed run @command{make uninstall-old}. To perform an uninstallation of old files run @command{make uninstall-old}.
@ -916,14 +922,14 @@ Variables are recalled by putting the variable's name between two dollar signs
(@code{$var$}), and are stored by putting the variable's name followed by the value (@code{$var$}), and are stored by putting the variable's name followed by the value
between two dollar signs and with a equality sign between the name and the value between two dollar signs and with a equality sign between the name and the value
(@code{$var=value$}). Variable names cannot include equality signs, but the value (@code{$var=value$}). Variable names cannot include equality signs, but the value
can; dollar signs can be used by placin an ESC character before the dollar sign. can; dollar signs can be used by placing an ESC character before the dollar sign.
There are three predefinied variables: @code{$$} (empty variable name), @code{$\$} There are three predefinied variables: @code{$$} (empty variable name), @code{$\$}
and @code{$/$}. @code{$$} has a dollar sign (@code{$}) as its value, while @code{$\$} and @code{$/$}. @code{$$} has a dollar sign (@code{$}) as its value, while @code{$\$}
and @code{$/$} contains the characters for the link to the balloon directed in the and @code{$/$} contains the characters for the link to the balloon directed in the
same direction as the variable name's slash. same direction as the variable name's slash.
Variables those name begin with @code{balloon} are parsed as balloon inserts, it Variables whose name begin with @code{balloon} are parsed as balloon inserts, it
can be either @code{balloon}, @code{balloonX}, @code{balloon,Y} or @code{balloonX,Y}, can be either @code{balloon}, @code{balloonX}, @code{balloon,Y} or @code{balloonX,Y},
whether @code{X} is the minimum width of the balloon and @code{Y} is the minimum whether @code{X} is the minimum width of the balloon and @code{Y} is the minimum
height of the balloon. height of the balloon.
@ -941,20 +947,20 @@ files.
@cindex pony quote infrastructure @cindex pony quote infrastructure
@cindex quote infrastructure @cindex quote infrastructure
When compiles pony quotes are built to @file{quotes/}, the file names are lists of When compiling, pony quotes are built to @file{quotes/}, the file names are lists
ponies joined with plus signs (@code{+}) -- the pony names are the same as the pony of ponies joined with plus signs (@code{+}) -- the pony names are the same as the
files, except they do not end with @file{.pony} -- with a index at the end, and a pony files, except they do not end with @file{.pony} -- with a index at the end,
full stop (@code{.}) before the index. and a full stop (@code{.}) before the index.
The source files are located in @file{ponyquotes/}, where their is a file named The source files are located in @file{ponyquotes/}, where their is a file named
@file{ponies}. This file is called the pony map, is the basis for how the compiled @file{ponies}. This file is called the pony map, and is the basis for how the
files are named. In the ponymap ponies with the same quotes are on the same line compiled files are named. In the ponymap ponies with the same quotes are on the
join togather with plus signs (@code{+}), if the lines because too long for file same line join togather with plus signs (@code{+}), if the lines because too long
names the line is split into multiple lines with the first pony in common. for file names the line is split into multiple lines with the first pony in common.
In @file{ponyquotes/} there are also quote files, each contain just one quote, just as In @file{ponyquotes/} there are also quote files, each contain just one quote, just
when compiled to @file{quotes/}. The source quote files are indentical to the compiled as when compiled to @file{quotes/}. The source quote files are indentical to the
quote files, except that there name contains just the first pony. compiled quote files, except that their name contains just the first pony.
@node Balloon style files @node Balloon style files
@ -969,9 +975,9 @@ applies to @command{ponythink}.
Balloon style consists of 20 strings. Each string is definied on separate lines, by Balloon style consists of 20 strings. Each string is definied on separate lines, by
their name and their value seperated with a colon (@code{name:value}), if the name is their name and their value seperated with a colon (@code{name:value}), if the name is
empty it continues the last one new line in the value. Only 10 of the strings may be empty it continues the last one on a new line in the value. Only 10 of the strings
multi-lined: @var{nw}, @var{nnw}, @var{n}, @var{nne}, @var{ne}, @var{sw}, @var{ssw}, may be multi-lined: @var{nw}, @var{nnw}, @var{n}, @var{nne}, @var{ne}, @var{sw},
@var{s}, @var{sse} and @var{se}. @var{ssw}, @var{s}, @var{sse} and @var{se}.
The following strings are used, and must be definied in the files: The following strings are used, and must be definied in the files:
@table @var @table @var
@ -994,7 +1000,7 @@ printed directly to the right of the top left corner.
The top edge of the balloon. The top edge of the balloon.
@item nne @item nne
If both this string and the @var{nnw} string fits between the top corners, this is If both this string and the @var{nnw} string fits between the top corners, this is
printed directly to the right of the top top corner. printed directly to the right of the top left corner.
@item ne @item ne
The top right corner of the balloon. The top right corner of the balloon.
@item nee @item nee
@ -1060,7 +1066,7 @@ the latest is enabled under TTY, cutting away overflow on the right is always en
by default. by default.
Truncating the height in TTY is required under Kernel Mode Settings (KMS) support to Truncating the height in TTY is required under Kernel Mode Settings (KMS) support to
keep the colours from being messed up ad the ponies is moved in the screen during keep the colours from being messed up when the ponies is moved in the screen during
print. Prior to version 2.0 this was done either by piping to @command{head} (keeps print. Prior to version 2.0 this was done either by piping to @command{head} (keeps
the top) or by piping to @command{tail} (keeps the bottom.) @command{head} and the top) or by piping to @command{tail} (keeps the bottom.) @command{head} and
@command{tail} takes as argument the number of lines to keep at most. @command{tail} takes as argument the number of lines to keep at most.
@ -1079,10 +1085,12 @@ also expands tabs to every eighth column and resets the background colour when n
and writes ANSI escape sequences that are on the left side of the truncation. The and writes ANSI escape sequences that are on the left side of the truncation. The
truncater stops CSI sequences on the first ASCII letter (@code{[a-zA-Z]}), but also truncater stops CSI sequences on the first ASCII letter (@code{[a-zA-Z]}), but also
stops escape sequences after the first character after the initial escape if it is stops escape sequences after the first character after the initial escape if it is
not either @code{[} (CSI) or @code{]} (OSI). In the previus, C, program it supported not either @code{[} (CSI) or @code{]} (OSI). In the previous, C, program it supported
UTF-8 by assumming that bytes do not match @code{10xxxxxx} and only those bytes were UTF-8 by assumming that bytes do not match @code{10xxxxxx} and only those bytes were
visible. This now fixed internally in Python, but has also been improved to exclude visible. This now fixed internally in Python, but has also been improved to exclude
combining characters from the set of visible characters. combining characters from the set of visible characters. Another difference is that
the background colours are not reset, instead ASNI colours after the truncation point
are still printed.
@node Languages @node Languages
@ -1091,12 +1099,12 @@ combining characters from the set of visible characters.
@cindex script languages @cindex script languages
@cindex programming languages @cindex programming languages
Before version 2.0 @command{ponysay} was written primarily in GNU Bash script (POSIX Before version 2.0 @command{ponysay} was written primarily in GNU Bash script; the
compliant); the truncater was however written in C, because it is simple, fast, does truncater was however written in C, because it is simple, fast, does not pose
not pose addition dependencies, and is easy to do byte hacking in. addition dependencies, and is easy to do byte hacking in.
Sometimes shell is too slow, in these cases Perl was used; Perl was already required Sometimes shell is too slow, in these cases Perl was used; Perl was already required
by @command{cowsay}, is similar to shell, but also supports hash tables. by @command{cowsay}, it is also similar to shell, but also supports hash tables.
However since version 2.0 we were trying to move from all there languages and only However since version 2.0 we were trying to move from all there languages and only
use Python 3, which as been accomplished in version 2.1. use Python 3, which as been accomplished in version 2.1.
@ -1142,16 +1150,16 @@ Universal Character Set, though handcoded UTF-8 character counting. Now
character in as one character, not in UTF-16 as some other languages does, this character in as one character, not in UTF-16 as some other languages does, this
means that the code is agnostic to the chararacter encoding. However in Unicode means that the code is agnostic to the chararacter encoding. However in Unicode
6.1 their are four ranges of combining characters, these do not take up any 6.1 their are four ranges of combining characters, these do not take up any
width in proper terminal, we their for have a class in the code named @code{UCS} width in proper terminal, we therefore have a class in the code named @code{UCS}
that help us take them into consideration when determine the length of strings. that help us take them into consideration when determine the length of a string.
Some ponies have names contains non-ASCII characters, read about it in Some ponies have names that contain non-ASCII characters, read about it in
@ref{Environment variables}. The UCS names are stored in the file @file{share/ucsmap}, @ref{Environment variables}. The UCS names are stored in the file @file{share/ucsmap},
in it lines that are not empty and does not start with a hash (@code{#}) are in it lines that are not empty and does not start with a hash (@code{#}) are
parse, and contains a UCS name and a ASCII:ised name. The UCS name comes first, parsed, and contains a UCS name and a ASCII:ised name. The UCS name comes first,
followed by the ASCII:ised name that it should replace or link to. The two names followed by the ASCII:ised name that the UCS name should replace or link towards.
are separated by and simple left to right arrow character [U+2192], optionally The two names are separated by and simple left to right arrow character [U+2192],
with surrounding white space. optionally with surrounding white space.
@ -1176,8 +1184,8 @@ There is also a collection of ponies that are not yet pixelated in a Java
reimplementation of the early Ponysay: reimplementation of the early Ponysay:
@url{https://github.com/maandree/unisay/tree/develop/dev/newponies} @url{https://github.com/maandree/unisay/tree/develop/dev/newponies}
There is a checklist named @file{pony-checklist} at the @file{dev/} directory. There is a checklist named @file{pony-checklist} at the @file{dev/} directory. You
You can use the check which ponies are added and which are not. can use the check which ponies are added and which are not. Please update it when fit.
@* @*
New ponies can be created from regular images by using util-say, which is available New ponies can be created from regular images by using util-say, which is available
@ -1213,9 +1221,9 @@ For more information see:
@cindex png images @cindex png images
@cindex images, png @cindex images, png
@cindex portable network graphics @cindex portable network graphics
If you have util-say installed, which is required to build ponies, you can run If you have util-say installed, which is required to build ponies, you can use PNG
PNG files as argument for @command{ponysay -f}, this required that the file is files as argument the for @command{ponysay -f}, this requires that the file is named
named @file{.png} at the end. @file{.png} at the end.
@cindex palette @cindex palette
@cindex xterm palette @cindex xterm palette
@ -1255,13 +1263,12 @@ To be able to run @command{make -B ttyponies} you must have the packages listed
@cindex quotes @cindex quotes
Also when adding new ponies, please map them up in the file @file{ponyquotes/ponies}. Also when adding new ponies, please map them up in the file @file{ponyquotes/ponies}.
If the pony is a new pony without any other alternative image just add it to a new If the pony is a new pony without any other alternative image just add it to a new
line, without @file{.pony}, preferably in its alphabetical position. line, without @file{.pony}, preferably in its alphabetical position. If the file is
If the file is a symlink add it to the same line as the target pony, and if the a symlink add it to the same line as the target pony, and if the pony has and
pony has and alternative image add it the the same line as that pony. Ponies on alternative image add it the the same line as that pony. Ponies on the same line are
the same line are separated with a plus sign (@code{+}) without any white space. separated with a plus sign (@code{+}) without any white space. When a line is too
When a line is too long for a file name (this has happened to Pinkie Pie long for a file name (this has happened to Pinkie Pie [@file{pinkie}],) it must be
[@file{pinkie}],) it must be split into multiple lines, this line should have their split into multiple lines, these lines should have their first pony file in common.
first pony file in common.
@ -1274,8 +1281,8 @@ first pony file in common.
@cindex fhs @cindex fhs
@cindex filesystem hierarchy standard @cindex filesystem hierarchy standard
If you are planning on maintaining @command{ponysay} in your favourite Operating If you are planning on maintaining @command{ponysay} in your favourite operating
System you should first read @ref{Required runtime dependencies} and system you should first read @ref{Required runtime dependencies} and
@ref{Optional runtime dependencies}. If your OS does not follow Filesystem Hierarchy @ref{Optional runtime dependencies}. If your OS does not follow Filesystem Hierarchy
Standard (FHS), e.g. installing amusement binaries in @file{/usr/games} instread of Standard (FHS), e.g. installing amusement binaries in @file{/usr/games} instread of
@file{/usr/bin} or only supporting @file{/opt} equivalent directories you should @file{/usr/bin} or only supporting @file{/opt} equivalent directories you should
@ -1285,7 +1292,7 @@ Apart from this, you should configure @command{ponysay} before building it with
option @option{--everything}. Otherwise only the @command{info} manual and the option @option{--everything}. Otherwise only the @command{info} manual and the
English manpage will be installed for documentation. English manpage will be installed for documentation.
Please inform us about your distribution so we can list it, everypony can see it. Please inform us about your distribution so we can list it so everypony can see it.
@ -1296,6 +1303,11 @@ Please inform us about your distribution so we can list it, everypony can see it
@cindex previous releases @cindex previous releases
@heading Version 2.4
Nothing worth mentioning.
@heading Version 2.3 @heading Version 2.3
@itemize @bullet @itemize @bullet
@ -1350,7 +1362,7 @@ or @command{ponythink}
@heading Version 2.1.1 @heading Version 2.1.1
Nothing worth mention. Nothing worth mentioning.
@heading Version 2.1 @heading Version 2.1