diff options
Diffstat (limited to 'manuals/ponysay.texinfo')
| -rw-r--r-- | manuals/ponysay.texinfo | 647 |
1 files changed, 412 insertions, 235 deletions
diff --git a/manuals/ponysay.texinfo b/manuals/ponysay.texinfo index 5732fb0..d7b7ef2 100644 --- a/manuals/ponysay.texinfo +++ b/manuals/ponysay.texinfo @@ -8,7 +8,7 @@ @documentlanguage en @finalout @c %**end of header -@set VERSION 2.3 +@set VERSION 2.5 @copying This manual is for ponysay @@ -34,7 +34,11 @@ Texts. A copy of the license is included in the section entitled @titlepage @title Ponysay +@c@subtitle Cowsay reimplementation for ponies. +@c@subtitle Ponies for your terminal. @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}. @c ** start of front page image ** @c If print make a pdf or hard copy with the front cover @@ -59,14 +63,15 @@ Texts. A copy of the license is included in the section entitled * Invoking ponysay:: How to run @command{ponysay}. * Advanced usage:: Advanced usage of @command{ponysay}. * Environment variables:: Getting more from @command{ponysay} with environment variables. +* Optional features:: Get the most out of @command{ponysay} with optional features. * Limitations:: Known limitations that may not be that easy to overcome. * Problems and requests:: Report issues and making requests. -* Dependencies:: Ponysay's Dependencies. +* Dependencies:: Ponysay's dependencies. * Installing:: How to install @command{ponysay}. -* Extensions:: Extensions. * Inner workings:: Useful information for those whom want to help hack @command{ponysay}. * Contributing:: Useful information for those whom want to help improve the world. * Distributing:: Useful information for OS package repository package maintainers. +* Terminology:: Terminology. * Change log:: Differences between the version of @command{ponysay}. * Ponysay contributors:: Ponysay contributors. * Ponysay license:: Ponysay license. @@ -81,19 +86,21 @@ Texts. A copy of the license is included in the section entitled @chapter Overview @cindex overview -@command{ponysay} displays an image of a My Little Pony pony saying some text -provided by the user in a terminal, or a quote from the series. It is was wrapper for -@command{cowsay}, but since version 2.1 it reimplementation @command{cowsay}. -If message is not provided, e.g. by piping, it accepts standard input. The pony -saying the given message is printed on standard output. +@command{ponysay} displays an image of a My Little Pony pony saying a message provided +by the user in a terminal, or a quote from the show My Little Pony: Friendship is Magic +(MLP:FiM). Historically @command{ponysay} was a wrapper for cowsay, but has since +version 2.1 become an independent reimplementation of @command{cowsay}. + +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{cowsay}. @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 -can always make screen-shots of @command{ponysay -q} runs and communication that way -over e-mail. +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} executions and communication that +way over e-mail. @@ -109,7 +116,7 @@ The format for running the @command{ponysay} program is: @example ponysay [@var{option}...] [--] [@var{message}] -ponythink [@var{option}...y] [--] [@var{message}] +ponythink [@var{option}...] [--] [@var{message}] @end example Running @command{ponysay} will print a speech balloon, @command{ponythink} will @@ -190,61 +197,65 @@ 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 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 @itemx --wrap COLUMN @cindex @option{-W} @cindex @option{--wrap} -Specify the screen column where the message should be wrapped, -this is by default 40, which is inherited from @command{cowsay}. +Specify the screen column where the message should be wrapped, this is by default 40, +as with @command{cowsay}. @item -c @itemx --compress @cindex @option{-c} @cindex @option{--compress} -@cindex figlet -@cindex toilet +@cindex @command{figlet} +@cindex @command{TOIlet} Compress the message in the same way @command{cowsay} does, that is basically -without multiple spaces, one only paragraphs seperations. Using this options -will mean that you cannot display @command{filet} and @command{TOIlet} style +without multiple spaces, and only paragraphs separations. Using this options +will mean that you cannot display @command{figlet} and @command{TOIlet} style messages. @item -l @itemx --list @cindex @option{-l} @cindex @option{--list} -Lists all installed ponies. If the extension @command{ponyquotes4ponysay} is -installed the ponies which have quotes, i.e. can be used with the @option{-q} -option, will be mark by being printed in bold or bright (depending on the terminal.) +Lists all installed ponies. The ponies which have quotes, i.e. can be used with +the @option{-q} option, will be marked by being printed in bold or bright (depending +on the terminal.) @item -L @itemx --altlist +@itemx --symlist @cindex @option{-L} +@cindex @option{--symlist} @cindex @option{--altlist} -Lists all installed ponies. If the extension @command{ponyquotes4ponysay} -is installed the ponies which have quotes, i.e. can be used with the @option{-q} -option, will be mark by being printed in bold or bright (depending on the terminal.) -This options differs from @option{-l} by printing alternative names (symbolic links) -inside brackets after their target ponies. +Lists all installed ponies. The ponies which have quotes, i.e. can be used with +the @option{-q} option, will be marked by being printed in bold or bright (depending +on the terminal.) This options differs from @option{-l} by printing alternative +names (symbolic links) inside brackets after their target ponies. @item +l @itemx ++list @cindex @option{+l} @cindex @option{++list} -Just as @option{-l}, but it lists extra (non-MLP:FiM) ponies instead of standard -(MLP:FiM) ponies +Just as @option{-l}, except it lists extra (non-MLP:FiM) ponies instead of standard +(MLP:FiM) ponies. @item +L +@itemx ++symlist @itemx ++altlist @cindex @option{+L} +@cindex @option{++symlist} @cindex @option{++altlist} -Just as @option{-L}, but it lists extra (non-MLP:FiM) ponies instead of standard -(MLP:FiM) ponies +Just as @option{-L}, except it lists extra (non-MLP:FiM) ponies instead of standard +(MLP:FiM) ponies. @item -B @itemx --balloonlist @cindex @option{-B} +@cindex @option{--bubblelist} @cindex @option{--balloonlist} Prints a list of all balloon styles. @end table @@ -252,14 +263,14 @@ Prints a list of all balloon styles. @cindex @var{message} 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 -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 @code{cat | ponysay}. @cindex @file{best.pony} 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 -symbolic link, @option{-q} cannot determine which quotes to use. +this file should be a symbolic link to the pony you want as a default. If it is not +a symbolic link, @option{-q} cannot determine which quotes to use. @node Advanced usage @@ -298,13 +309,13 @@ described in the previous paragraph every time you open a terminal. @cindex text ponification @cindex ponypipe -You can ponify text (i.e. replaces words search as `everyone' with `everypony') -by using @code{fortune | ponypipe} instead of using @command{fortune}. -@command{ponypipe} can be downloaded from @url{https://github.com/maandree/ponypipe}. -Alternatively you can use @command{pinkie} (or @command{pinkiepie}), which can -be downloaded from @url{https://github.com/maandree/pinkie-pie}, which is just -@code{fortune | ponypipe}. There is also a large @command{sed} script, similar -to @command{ponypipe}: @url{http://www.reddit.com/r/mylittlelinux/comments/srixi/using_ponysay_with_a_ponified_fortune_warning/} +You can ponify messages (i.e. replaces words search as `everyone' with `everypony') by +using @code{fortune | ponypipe} instead of using @command{fortune}. @command{ponypipe} +can be downloaded from @url{https://github.com/maandree/ponypipe}. +Alternatively you can use @command{pinkie} (or @command{pinkiepie}), which can be +downloaded from @url{https://github.com/maandree/pinkie-pie}, which is just +@code{fortune | ponypipe}. There is also a large @command{sed} script, similar to +@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} script, but I haven't used the script so I wouldn't know for sure. @@ -328,6 +339,8 @@ If you use TTY and have a custom colour palette, you should also add to your @end example @end cartouche +You should read more about this in @ref{KMS ponies}. + @node Running on screen @section Running on @command{screen} @@ -375,11 +388,11 @@ with the value @code{yes}, @code{y} or @code{1}. @item PONYSAY_SHELL_LINES @cindex @env{PONYSAY_SHELL_LINES} @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 @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 -screen. +Naturally this takes effect eve n if the output is not actually larger than +the screen. @item PONYSAY_FULL_WIDTH @cindex @env{PONYSAY_FULL_WIDTH} @@ -406,33 +419,89 @@ the ASCII:ised names export @env{PONYSAY_UCS_ME} with the value @code{harder}, @code{h} or @code{2} instead. 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 will still be usable. -@item PONYSAY_COWSAY -@itemx PONYSAY_COWTHINK -@cindex @env{PONYSAY_COWSAY} -@cindex @env{PONYSAY_COWTHINK} -@cindex custom cowsay -@cindex replace cowsay -Since version 2.1 this is no longer used as @command{cowsay} has been -reimplemented inside @command{ponysay}, but it is possible we will add -a way to replace that back-end. - -If you want to use another program than @command{cowsay} (the first -@command{cowsay} found in @env{$PATH}), you can export @env{PONYSAY_COWSAY} -with the value of that program. In earlier versions than version 2.0: If, and -only if, @env{PONYSAY_COWSAY} does not have any value, @command{cowsay} is -patch with @code{use utf8;} to the beginning. The @code{use utf8;} patch is -introduced to make it easier to customise cowsay. - -@env{PONYSAY_COWTHINK} will be used instead of @env{PONYSAY_COWSAY} if -you run @command{ponythink}. +@item @env{PONYSAY_KMS_PALETTE} +@itemx @env{PONYSAY_KMS_PALETTE_CMD} +@cindex @env{PONYSAY_KMS_PALETTE} +@cindex @env{PONYSAY_KMS_PALETTE_CMD} +@cindex tty +@cindex linux vt +@cindex kmsponies +@cindex kms +@cindex kernel mode setting + +@env{PONYSAY_KMS_PALETTE} or @env{PONYSAY_KMS_PALETTE_CMD} 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. + +See @ref{KMS ponies} for information on how to use this. @end table -See @ref{kmsponies4ponysay} for additional environment variables used by the -extension @command{kmsponies4ponysay}. + + +@node Optional features +@chapter Optional features +@cindex features, optional +@cindex optional features +@cindex optional dependencies + +@menu +* KMS ponies:: Improved TTY support under KMS support. +@end menu + + +@node KMS ponies +@section KMS ponies +@cindex kmsponies +@cindex tty +@cindex linux vt +@cindex kms +@cindex kernel mode setting +@cindex environment variables +@cindex @env{PONYSAY_KMS_PALETTE} +@cindex @env{PONYSAY_KMS_PALETTE_CMD} +@cindex @file{.bashrc} +@cindex @file{~/.bashrc} +@cindex cache +@cindex @file{/var/cache/ponysay} +@cindex @file{~/.cache/ponysay} + +KMS ponies is an optional feature that required that you have @command{util-say>=2} +(@command{util-say<2} for @command{ponysay<2.1}) installed. It lets TTY users that +have a custom TTY colour palette and KMS support get best TTY images that can be +display at the current state of the art. KMS is supported on most computers, but due +to lack of published specifications Nvidia drivers does not support KMS. +@command{util-say} can be downloaded at @url{https://github.com/maandree/util-say}. + +To use this feature your @file{~/.bashrc} (or equivalent for your shell) must keep +track of your colour palette; it is not possible for a program to ask to terminal. +Either the shell should export a palette string to @env{$PONYSAY_KMS_PALETTE} or you +should export a command to can get the palette string to +@env{$PONYSAY_KMS_PALETTE_CMD}. The palette string should be the stream which sets +the colour palette to the terminal when @command{echo}:ed; preferably, to increase +speed and reduce cache usage, it should be consistent every time it is exported for +every colours palette. So you may want to keep it sorted, always be in either upper +case or lower case, and not contain an character that is not used to set the colour +palette. + +Assuming you have a function in your @file{~/.bashrc}, to reset the colour palette +to what you set it to last time in the terminal, named @command{reset-palette}, +your @file{~/.bashrc} should, for example, contain: +@cartouche +@example +[ "$TERM" = "linux" ] && + function ponysay + @{ export PONYSAY_KMS_PALETTE="$(reset-palette)" + exec ponysay "$@@" + @} +@end example +@end cartouche + +KMS ponies uses @file{/var/cache/ponysay/} or, if missing, @file{~/.cache/ponysay/} +for cache space. @@ -460,11 +529,11 @@ Ponysay works perfectly on @command{xterm}, @command{xterm} like terminals inclu @command{mate-terminal}. @cindex kms -@cindex kernel mode settings +@cindex kernel mode setting @cindex tty @cindex linux vt -On Linux's native terminal Linux VT (TTY) it works less well, and not good at all with -Kernel Mode Settings (KMS) support. See @url{https://github.com/erkin/ponysay/issues/1} +On Linux's native terminal Linux VT (TTY) it works less well, and not good at all +without Kernel Mode Setting (KMS) support. See @url{https://github.com/erkin/ponysay/issues/1} 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 ponies position moves on the screen, this is also reason why the output is truncated on @@ -484,9 +553,9 @@ transparency.) @cindex Eterm @cindex aterm @command{ponysay} works perfectly on @command{xterm}, @command{urxvt} and -@command{putty}, but @command{rxvt}, @command{mrxvt} and @command{Eterm} do not -have UTF-8 support and are currently not supported. Additionally @command{aterm} -have neither UTF-8 support nor 256 colour support, and is therefore not yet support. +@command{putty}, but @command{rxvt}, @command{mrxvt} and @command{Eterm} do not have +UTF-8 support and are currently not supported. Additionally @command{aterm} have +neither UTF-8 support nor 256 colour support, and is therefore not yet supported. @cindex 9term Due to extreme limitations in @command{9term} @command{ponysay} will never be able to @@ -594,8 +663,8 @@ It can be downloaded at @url{https://github.com/maandree/util-say}. @cindex images, png @cindex portable network graphics 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) -in addition of .pony-files or pony names. +using .png-images (note that the file must not miss the @file{.png} at the end of +the file name) in addition to .pony-files or pony names. @end table @@ -677,8 +746,8 @@ If you have @command{git} you can @command{clone} the project URL @url{https://github.com/erkin/ponysay.git}. In the terminal, @command{cd} into the ponysay directory and execute -@command{./configure && make install}. This will install @command{ponysay} into the -@file{/usr}, meaning you may need to run @command{make install} as root, +@command{./configure && make install}. This will install @command{ponysay} into +@file{/usr}, normally meaning you need to run @command{make install} as root, e.g. by running @command{sudo make install}. Now you will be to use ponysay, run: @command{ponysay "I am just the cutest pony!"}, @@ -687,7 +756,7 @@ or if have a specific pony in your mind: @command{ponysay -f pinkie "Partay!~"}. @cindex manpage translations @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 -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}. @@ -717,7 +786,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 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} -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 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} @@ -730,18 +799,18 @@ The following argumentless options are also recognised: @item @option{--without-bash} @cindex @option{--without-bash} @cindex @command{bash}, without -will skip installation of auto-completion for @command{ponysay} and the -GNU Bourne-again shell, @command{bash}. +will skip installation of auto-completion for @command{ponysay} and +@command{ponythink} under the GNU Bourne-again shell, @command{bash}. @item @option{--without-fish} @cindex @option{--without-fish} @cindex @command{fish}, without -will skip installation of auto-completion for @command{ponysay} and the -Friendly interactive shell, @command{fish}. +will skip installation of auto-completion for @command{ponysay} and +@command{ponythink} under the Friendly interactive shell, @command{fish}. @item @option{--without-zsh} @cindex @option{--without-zsh} @cindex @command{zsh}, without -will skip installation of auto-completion for @command{ponysay} and the -shell @command{zsh}. +will skip installation of auto-completion for @command{ponysay} and +@command{ponythink} under the shell @command{zsh}. @item @option{--without-shared-cache} @cindex @option{--without-shared-cache} @cindex cache @@ -754,8 +823,8 @@ shared cache, private one will be used at @file{~/.cache/ponysay}. @cindex @file{/usr/games} 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}. -For example to install @command{ponysay} in @file{/usr/games} you build the -program by running @command{./configure --prefix=/usr/games}, and alike for +For example to install @command{ponysay} in @file{/usr/local} you build the +program by running @command{./configure --prefix=/usr/local}, and alike for installation and uninstallation. Notice the @command{=} cannot be substituted with white space. @@ -775,8 +844,8 @@ add the option @command{--shell=SHELL}. @cindex arch linux The official Arch Linux package repositories contains @command{ponysay} as -@w{@code{community/ponysay}}. The Arch Linux User Repository (AUR) contains a bleeding -edge git version of @command{ponysay} as @code{ponysay-git}. +@w{@code{community/ponysay}}. The Arch Linux User Repository (AUR) contains a +bleeding edge git version of @command{ponysay} as @code{ponysay-git}. @node Gentoo Linux @@ -806,82 +875,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 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}. -To perform the uninstallation of old filed run @command{make uninstall-old}. - - - -@node Extensions -@chapter Extensions -@cindex extensions -@cindex optional dependencies - -Ponysay does not support extensions, per se, but rather have optional features that -are enabled when other packages are installed. - -@menu -* ponyquotes4ponysay:: ponyquotes4ponysay: Quotes from My Little Ponies. -* kmsponies4ponysay:: kmsponies4ponysay: Improved TTY support under KMS support. -@end menu - - -@node ponyquotes4ponysay -@section ponyquotes4ponysay -@cindex ponyquotes4ponysay -@cindex quotes - -@command{ponyquotes4ponysay} is a package that adds support for MLP:FiM quotes that are -displayed with the associated ponies. See @ref{Invoking ponysay} for more information. - -As of version 1.2 @command{ponyquotes4ponysay} is included in @command{ponysay}, -but is still available at @url{https://github.com/maandree/ponyquotes4ponysay}. - - -@node kmsponies4ponysay -@section kmsponies4ponysay -@cindex kmsponies4ponysay -@cindex tty -@cindex linux vt -@cindex kms -@cindex kernel mode settings -@cindex environment variables -@cindex @env{PONYSAY_KMS_PALETTE} -@cindex @env{PONYSAY_KMS_PALETTE_CMD} -@cindex @file{.bashrc} - -@command{kmsponies4ponysay} is an extension for TTY users that have a custom TTY -colour palette and KMS support. KMS is supported on most computers, but due to lack -of published specifications Nvidea drivers does not support KMS. -@command{kmsponies4ponysay} can be downloaded at -@url{https://github.com/maandree/kmsponies4ponysay}. - -To use this extension your @file{~/.bashrc} (or equivalent for your shell) must keep -track of your colour palette, it is not possible for a program to ask to terminal. -Either the shell should export a palette string to @env{$PONYSAY_KMS_PALETTE} or you -should export a command to can get the palette string to -@env{$PONYSAY_KMS_PALETTE_CMD}. The palette string should be the stream which sets -the colour palette to the terminal when @command{echo}:ed; preferably, to increase -speed and reduce cache usage, it should be consistent every time it is exported for -every colours palette. So you may want to keep it sorted, always be in either upper -case or lower case, and not contain an character that is not used to set the colour -palette. - -Assuming you have a function in your @file{~/.bashrc}, to reset the colour palette -to what you set it to last time in the terminal, named @command{reset-palette}, -your @file{~/.bashrc} should, for example, contain: -@cartouche -@example -[ "$TERM" = "linux" ] && - function ponysay - @{ export PONYSAY_KMS_PALETTE="$(reset-palette)" - exec ponysay "$@@" - @} -@end example -@end cartouche - -@command{kmsponies4ponysay} uses @file{/var/cache/kmsponies4ponysay/} for cache space. - -As of version 2.0 @command{kmsponies4ponysay} is included in @command{ponysay}, -but is still available at @url{https://github.com/maandree/kmsponies4ponysay}. +To perform an uninstallation of old files run @command{make uninstall-old}. @@ -898,7 +892,7 @@ but is still available at @url{https://github.com/maandree/kmsponies4ponysay}. * Truncation:: Output truncation. * Languages:: Selection of programming languages. * Shell auto-completion:: Things that make auto-completion simpler. -* Universal Character Set:: Something about Univeral Character Set support. +* Universal Character Set:: Something about Universal Character Set support. @end menu @@ -916,14 +910,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 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 -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 predefined variables: @code{$$} (empty variable name), @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 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}, whether @code{X} is the minimum width of the balloon and @code{Y} is the minimum height of the balloon. @@ -941,20 +935,20 @@ files. @cindex pony quote infrastructure @cindex quote infrastructure -When compiles pony quotes are built to @file{quotes/}, the file names are lists of -ponies joined with plus signs (@code{+}) -- the pony names are the same as the pony -files, except they do not end with @file{.pony} -- with a index at the end, and a -full stop (@code{.}) before the index. +When compiling, pony quotes are built to @file{quotes/}, the file names are lists +of ponies joined with plus signs (@code{+}) -- the pony names are the same as the +pony files, except they do not end with @file{.pony} -- with a index at the end, +and a full stop (@code{.}) before the index. 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 -files are named. In the ponymap ponies with the same quotes are on the same line -join togather with plus signs (@code{+}), if the lines because too long for file -names the line is split into multiple lines with the first pony in common. +@file{ponies}. This file is called the pony map, and is the basis for how the +compiled files are named. In the ponymap ponies with the same quotes are on the +same line join together with plus signs (@code{+}), if the lines because too long +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 -when compiled to @file{quotes/}. The source quote files are indentical to the compiled -quote files, except that there name contains just the first pony. +In @file{ponyquotes/} there are also quote files, each contain just one quote, just +as when compiled to @file{quotes/}. The source quote files are identical to the +compiled quote files, except that their name contains just the first pony. @node Balloon style files @@ -967,13 +961,13 @@ Balloon style files are located in the directory @file{balloons/}, the ones endi with @file{.say} applies to @command{ponysay} and the ones ending with @file{.think} applies to @command{ponythink}. -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 -empty it continues the last one new line in the value. Only 10 of the strings may be -multi-lined: @var{nw}, @var{nnw}, @var{n}, @var{nne}, @var{ne}, @var{sw}, @var{ssw}, -@var{s}, @var{sse} and @var{se}. +Balloon style consists of 20 strings. Each string is defined on separate lines, by +their name and their value separated with a colon (@code{name:value}), if the name is +empty it continues the last one on a new line in the value. Only 10 of the strings +may be multi-lined: @var{nw}, @var{nnw}, @var{n}, @var{nne}, @var{ne}, @var{sw}, +@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 defined in the files: @table @var @item \ The character for the link to the balloon directed as @code{\}. @@ -994,7 +988,7 @@ printed directly to the right of the top left corner. The top edge of the balloon. @item nne 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 The top right corner of the balloon. @item nee @@ -1034,7 +1028,7 @@ only if the message contains more than one line. @cindex linux vt @cindex clearing tty @cindex kms -@cindex kernel mode settings +@cindex kernel mode setting Since Linux VT (TTY) does not have capabilities for returning the position of the cursor, the screen must always be cleared before printing the ponies to make sure @@ -1052,15 +1046,15 @@ we would also turn off num. lock and caps. lock. @cindex truncation @cindex output truncation @cindex kms -@cindex kernel mode settings +@cindex kernel mode setting Ponysay supports three type of output truncations, cutting away overflow on the right and truncation the height by either keeping the bottom or keeping the top. By default the latest is enabled under TTY, cutting away overflow on the right is always enabled by default. -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 +Truncating the height in TTY is required under Kernel Mode Setting (KMS) support to +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 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. @@ -1071,18 +1065,20 @@ height or the width. This requires only GNU Coreutils; earlier @command{tput row @command{tput cols} were used, this however required, the only de facto standard, package @command{ncurses}, some shells have environment variables for this. -Since version 2.1 trunction is done internally in the Python script, before that it -was done in a custom C porgram @command{truncater}, that was installed to +Since version 2.1 truncation is done internally in the Python script, before that it +was done in a custom C program @command{truncater}, that was installed to @file{/usr/lib/ponysay/truncater}. It recognised UTF-8 ANSI escape sequences, including OSI P and CSI m, which is essential for the truncation to be correct. It also expands tabs to every eighth column and resets the background colour when needed, 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 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 -UTF-8 by assumming that bytes do not match @code{10xxxxxx} and only those bytes were +not either @code{[} (CSI) or @code{]} (OSI). In the previous, C, program it supported +UTF-8 by assuming 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 -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 ANSI colours after the truncation point +are still printed. @node Languages @@ -1091,12 +1087,12 @@ combining characters from the set of visible characters. @cindex script languages @cindex programming languages -Before version 2.0 @command{ponysay} was written primarily in GNU Bash script (POSIX -compliant); the truncater was however written in C, because it is simple, fast, does -not pose addition dependencies, and is easy to do byte hacking in. +Before version 2.0 @command{ponysay} was written primarily in GNU Bash script; the +truncater was however written in C, because it is simple, fast, does not pose +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 -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 use Python 3, which as been accomplished in version 2.1. @@ -1106,9 +1102,9 @@ use Python 3, which as been accomplished in version 2.1. @section Shell auto-completion @cindex auto-completion, inner workings @cindex shell, auto-completion -@cindex @command{--onelist} -@cindex @command{++onelist} -@cindex @command{--quoters} +@cindex @option{--onelist} +@cindex @option{++onelist} +@cindex @option{--quoters} To make it easier to write auto-completion for shells, @command{ponysay} supports the two options @option{--onelist}, @option{++onelist} and @option{--quoters}, @@ -1136,22 +1132,22 @@ Auto-completion scripts should not suggest these options. @cindex unicode @cindex pony names -In earlier versions of @command{ponysay} only the output truncationed supported +In earlier versions of @command{ponysay} only the output truncation supported Universal Character Set, though handcoded UTF-8 character counting. Now @command{ponysay} lets Python decode the data, Python store all 31 bits of a 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 character encoding. However in Unicode 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} -that help us take them into consideration when determine the length of strings. +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 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}, 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, -followed by the ASCII:ised name that it should replace or link to. The two names -are separated by and simple left to right arrow character [U+2192], optionally -with surrounding white space. +parsed, and contains a UCS name and a ASCII:ised name. The UCS name comes first, +followed by the ASCII:ised name that the UCS name should replace or link towards. +The two names are separated by and simple left to right arrow character [U+2192], +optionally with surrounding white space. @@ -1176,8 +1172,8 @@ There is also a collection of ponies that are not yet pixelated in a Java reimplementation of the early Ponysay: @url{https://github.com/maandree/unisay/tree/develop/dev/newponies} -There is a checklist named @file{pony-checklist} at the @file{dev/} directory. -You can use the check which ponies are added and which are not. +There is a checklist named @file{pony-checklist} at the @file{dev/} directory. You +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 @@ -1213,9 +1209,9 @@ For more information see: @cindex png images @cindex images, png @cindex portable network graphics -If you have util-say installed, which is required to build ponies, you can run -PNG files as argument for @command{ponysay -f}, this required that the file is -named @file{.png} at the end. +If you have util-say installed, which is required to build ponies, you can use PNG +files as argument the for @command{ponysay -f}, this requires that the file is named +@file{.png} at the end. @cindex palette @cindex xterm palette @@ -1255,13 +1251,12 @@ To be able to run @command{make -B ttyponies} you must have the packages listed @cindex quotes 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 -line, without @file{.pony}, preferably in its alphabetical position. -If the file is a symlink add it to the same line as the target pony, and if the -pony has and alternative image add it the the same line as that pony. Ponies on -the same line are separated with a plus sign (@code{+}) without any white space. -When a line is too long for a file name (this has happened to Pinkie Pie -[@file{pinkie}],) it must be split into multiple lines, this line should have their -first pony file in common. +line, without @file{.pony}, preferably in its alphabetical position. If the file is +a symlink add it to the same line as the target pony, and if the pony has and +alternative image add it the the same line as that pony. Ponies on the same line are +separated with a plus sign (@code{+}) without any white space. When a line is too +long for a file name (this has happened to Pinkie Pie [@file{pinkie}],) it must be +split into multiple lines, these lines should have their first pony file in common. @@ -1274,10 +1269,10 @@ first pony file in common. @cindex fhs @cindex filesystem hierarchy standard -If you are planning on maintaining @command{ponysay} in your favourite Operating -System you should first read @ref{Required runtime dependencies} and +If you are planning on maintaining @command{ponysay} in your favourite operating +system you should first read @ref{Required runtime dependencies} and @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} instead of @file{/usr/bin} or only supporting @file{/opt} equivalent directories you should read about configurations in @ref{Custom installations}. @@ -1285,7 +1280,176 @@ Apart from this, you should configure @command{ponysay} before building it with option @option{--everything}. Otherwise only the @command{info} manual and the 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. + + + +@node Terminology +@chapter Terminology +@cindex terminology + +@table @i +@item MLP:FiM +@cindex MLP:FiM +The television show My Little Pony: Friendship is Magic. + +@item My Little Pony +@cindex my little pony +The successor to My Pretty Pony, the toy not the short story by Stephen King. + +@item TTY +@itemx Linux VT +@cindex tty +@cindex linux vt +Linux's native terminal emulator. The name TTY comes from the file names for the +devices used for terminals by Linux VT, which is @file{/dev/tty*}. + +@item KMS +@itemx Kernel Mode Setting +@cindex kms +@cindex kernel mode setting +A feature in Linux allowing mode setting in kernel-space, this gives the TTY, +for example better colour support. I would go to Wikipedia for more information. + +@item ttyponies +@cindex ttyponies +Pony files used in TTY. + +@item kmsponies +@cindex kmsponies +Pony files generated for use in TTY with custom TTY colour palette and KMS support. + +@item extraponies +@itemx extra ponies +@cindex extraponies +@cindex extra ponies +Pony files of ponies that are not a part of MLP:FiM. +@item standard ponies +@cindex standard ponies + +Pony files of ponies that are a part of MLP:FiM. +@item systemponies +@itemx sysponies +@cindex systemponies +@cindex sysponies +Pony files located in @file{/usr/share/ponysay}. + +@item homeponies +@itemx usrponies +@cindex homeponies +@cindex usrponies +Pony files located in @file{~/.local/share/ponysay}. + +@item browser ponies +@cindex browser ponies +@cindex desktop ponies +A JavaScript program which is the source for most of our ponies. It is a port of +@i{desktop ponies}. + +@item ponification +@cindex ponification +The process of converting English text to Equestrian English. + +@item Equestrian English +@cindex Equestrian English +The English dialect spoken by the ponies in MLP:FiM, the basic role is that it +is American English with as many words and parts of words as possible exchanged +to words having to do with ponies, including the work `pony' itself. This is +normally the language we, the developers, write in, except we may use another +English, e.g. British English, as the base language. + +@item best.pony +@cindex best.pony +The pony you think is [the] best pony. It should be a symlink pony. It is a feature +affecting the @option{-f}, @option{-F} and @option{-q} options. + +@item pony symlink +@itemx symlink pony +@cindex pony symlink +@cindex symlink pony +A pony file that is a symbolic link to another pony file. Symbolic links can be +created with the command @command{ln -s TARGET SYMLINK}. + +@item ponyquotes +@cindex ponyquotes +A feature enabling ponies to quote them self from MLP:FiM. + +@item environment variables +@cindex environment variables +Variables stored to the environment with the command @command{export VARIABLE=VALUE}. +The variable name is often written with the prefix @code{$} due to have they are read +in shell, using the command @command{echo $VARIABLE}. + +@item UCS +@itemx Universal Character Set +@cindex ucs +@cindex universal character set +The set of of character, develop by the Unicode Consortium. It defined a partially filled +space of @math{2^{31}} characters, some of which are not glyphs. + +@item combining characters +@cindex combining characters +Character that have zero width and is used to compose characters with diacritical when +there is no precomposed character to use. + +@item ASCII +@itemx ASCII character +@cindex ascii +@cindex character +American Standard Code for Information Interchange (ASCII) defines 128 characters, some +are not glyphs. It contains control characters, basic punctuation, the decimal digit, +and lower case and upper case English alphabet characters @code{a-z}. + +@item short options +@cindex short options +Command line arguments starting with either exactly one hyphen (@code{-}) or exactly one +plus sign (@code{+}), and have exactly one character beyond that. They may be argumentless, +argumented, optionally argumented, or variadic (consumes are following arguments). + +@item long options +@cindex long options +Command line arguments starting with either at least two hyphens (@code{-}) or at least two +plus signs (@code{+}), beyond that they have at least one character, but often at least one +work. They by be argumentless, argumented, optionally argumented, or variadic (consumes are +following arguments). + +@item completion +@itemx auto-completion +@itemx shell completion +@itemx shell auto-completion +@cindex completion +@cindex auto-completion +@cindex shell completion +@cindex shell auto-completion +Provided by a shell dependent script, argument suggestion is provided of then by pressing +the tab key. + +@item ANSI escape sequences +@itemx escape sequences +@cindex ANSI escape sequences +@cindex escape sequences +Character sequences starting with a ESC character, with a special interpretation for terminals +standardise by ANSI. + +@item ANSI colour sequences +@itemx ANSI colours +@itemx colour sequences +@cindex ANSI colour sequences +@cindex ANSI colours +@cindex colour sequences +ANSI escape sequences defining a colour or other formatting, known as CSI m, a sequence starting +with CSI and ending with an @code{m}. This is extended to 256 colours, from 16 colours, by +@command{xterm} which is de facto standardise. + +@item CSI +@cindex CSI +The character combination ESC followed by @code{[}, used in standardised ANSI escape sequences. + +@item OSI +@cindex OSI +The character combination ESC followed by @code{]}, used in non-standardised ANSI escape +sequences. +@end table @@ -1296,6 +1460,13 @@ Please inform us about your distribution so we can list it, everypony can see it @cindex previous releases +@heading Version 2.4 + +Nothing worth mentioning. + +@b{Note}: Identifies itself as version 2.3 + + @heading Version 2.3 @itemize @bullet @@ -1350,7 +1521,7 @@ or @command{ponythink} @heading Version 2.1.1 -Nothing worth mention. +Nothing worth mentioning. @heading Version 2.1 @@ -1722,6 +1893,7 @@ Patchers and other contributors of ponysay: @item Kyah ``L-four'' Rindlisbacher @item James ``rossy2401'' Ross-Gowan @item Louis ``kragniz'' Taylor +@item Daniel ``gtmanfred'' Wallace @item Jannis ``sycoso'' @item ``spider-mario'' @end itemize @@ -1731,6 +1903,11 @@ Patchers and other contributors of ponysay: @node Ponysay license @appendix Ponysay license +Ponysay is release by Erkin Batu Altunbaş et al. @* +Copyright @copyright{} 2012 Erkin Batu Altunbaş et al. + +@* + Ponysay is Free Software (yet not Open Source) and in licensed under the terms of Do What The Fuck You Want To Public License (WTFPL) version 2. @@ -1752,12 +1929,13 @@ changes. Access to the source code is a precondition for this. @* -@center DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE -@center Version 2, December 2004 +@cartouche +@verbatim + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + Version 2, December 2004 -Copyright @copyright{} 2012 Erkin Batu Altunbaş +Copyright © 2004 Sam Hocevar <sam@hocevar.net> -@quotation Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long as the name is changed. @@ -1766,9 +1944,8 @@ as the name is changed. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. You just DO WHAT THE FUCK YOU WANT TO. -@end quotation - - +@end verbatim +@end cartouche @node GNU Free Documentation License @appendix GNU Free Documentation License |