-Next: Environment variables, -Previous: Invoking ponysay, -Up: Top -
ponysay.| • Extra information: | Displaying extra information. + | |
| • Fortune cookies: | Displaying with fortune cookies. + | |
| • Ponification: | Ponify your fortune cookies. + | |
| • Running on TTY: | Running on TTY (Linux VT). + | |
| • Running on screen: | Running on screen.
+ | |
| • ~/.ponysayrc: | Using the ~/.ponysayrc file. + | |
| • Narcissistic ponies: | Getting ponies to think of themself. + |
-Next: Chakra, -Previous: Arch Linux, -Up: Package repositories -
-community/ponysay from Arch Linux (Arch Linux) is also available
+
community/ponysay from Arch Linux (Arch Linux) is also available
for Arch Linux ARM.
+
-Next: Arch Linux ARM, -Up: Package repositories -
-The official Arch Linux package repositories contains ponysay as +
The official Arch Linux package repositories contains ponysay as
community/ponysay (developer maintained). The Arch Linux User Repository
-(AUR) contains a bleeding edge git version of ponysay as
-ponysay-git (user maintained).
+(AUR) contains a bleeding edge git version of ponysay as
+ponysay-git (user maintained).
+
-Next: Printing in TTY with KMS, -Previous: Pony quote infrastructure, -Up: Inner workings -
-Balloon style files are located in the directory balloons/, the ones ending -with .say applies to ponysay and the ones ending with .think -applies to ponythink. - -
Balloon style consists of 20 strings. Each string is defined on separate lines, by +
Balloon style files are located in the directory balloons/, the ones ending
+with .say applies to ponysay and the ones ending with .think
+applies to ponythink.
+
Balloon style consists of 20 strings. Each string is defined on separate lines, by
their name and their value separated with a colon (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: nw, nnw, n, nne, ne, sw,
ssw, s, sse and se.
-
-
The following strings are used, and must be defined in the files: -
\.
-/.
-The following strings are used, and must be defined in the files: +
The character for the link to the balloon directed as \.
+
The character for the link to the balloon directed as /.
+
The beginning of the balloon’s line where the message is located if and only if the +message contains only one line. +
The end of the balloon’s line where the message is located if and only if the message +contains only one line. +
The top left corner of the balloon. +
If both this string and the nne string fits between the top corners, this is +printed directly to the right of the top left corner. +
The top edge of the balloon. +
If both this string and the nnw string fits between the top corners, this is +printed directly to the right of the top left corner. +
The top right corner of the balloon. +
The end of the balloon’s line where the message’s first line is located if and only +if the message contains more than one line. +
The right edge of the balloon. +
The end of the balloon’s line where the message’s last line is located if and only +if the message contains more than one line. +
The bottom right corner of the balloon. +
If both this string and the ssw string fits between the bottom corners, this +is printed directly to the left of the bottom right corner. +
The bottom edge of the balloon. +
If both this string and the sse string fits between the bottom corners, this +is printed directly to the right of the bottom left corner. +
The bottom left corner of the balloon. +
The beginning of the balloon’s line where the message’s last line is located if and +only if the message contains more than one line. +
The left edge of the balloon. +
The beginning of the balloon’s line where the message’s first line is located if and +only if the message contains more than one line. +
+Next: Printing in TTY with KMS, Previous: Pony quote infrastructure, Up: Inner workings [Contents][Index]
+-Next: Debian GNU/Linux, -Previous: Arch Linux ARM, -Up: Package repositories -
-Chakra users can install from (CCR) a stable version named a ponysay
+
Chakra users can install from (CCR) a stable version named a ponysay
(developer maintained Arch Linux mirror), additionally a git verion of ponysay is
available as ponysay-git (developer maintained Arch Linux mirror).
+
-Next: Ponysay contributors, -Previous: Terminology, -Up: Top -
ponysay-tool command is now installed.
+PONYSAY_TYPO_LIMIT has been added.
+PONYSAY_WRAP_HYPHEN has been added.
+PONYSAY_WRAP_LIMIT has been added.
+PONYSAY_WRAP_EXCEED has been added.
+ponysay-tool is introduced, it can be used to edit, remove and copy pony meta data, and more.
+ponysay-tool --kms generates all kmsponies for the current TTY palette.
+ponysay is executed, extra information is
+printed to it.
+n or i is allowed for -W.
+n or i is allowed for -W.
-./configure and make is no longer support.
+Nothing worth mentioning. +
+Note: Identifies itself as version 2.3 +
-Note: Identifies itself as version 2.3 - +
ponysay
+or ponythink
+Nothing worth mentioning. +
+figlet style messages.
+PONYSAY_COWSAY, PONYSAY_COWTHINK
+unisay’s format instead of cowsay’s Perl based format.
This includes arbitrary position of balloon, mirrored balloon links, and
-minimum size of balloon.
-
-./configure.
+Note: Identifies itself as version 1.3 +
Note: Identifies itself as version 1.3 +
+make,
+the default value is /usr
+Note: Identifies itself as version 1.1 +
Note: Identifies itself as version 1.1 +
+info manual added.
+ponythink added, in addition to ponysay.
+fish completion added.
+ncurses is no longer needed for determining the screen’s size,
+coreutils is used instead.
+PONYSAY_FULL_WIDTH, PONYSAY_SHELL_LINES,
+PONYSAY_TRUNCATE_HEIGHT, PONYSAY_BOTTOM.
+bash completion added.
+zsh completion added.
+Note: Identifies itself as version 0.7 +
Note: Identifies itself as version 0.7 +
+which, using hash instead.
+Note: Identifies itself as version 0.5 +
Note: Identifies itself as version 0.5 +
+which to determine existence of cowsay.
+First release. +
++Next: Ponysay contributors, Previous: Terminology, Up: Top [Contents][Index]
+-Next: Variable and option index, -Previous: GNU Free Documentation License, -Up: Top +Next: Variable and option index, Previous: GNU Free Documentation License, Up: Top [Contents][Index]
+| Jump to: | .
+
+/
+
+9
+
+~
+
+ +A + +B + +C + +D + +E + +F + +G + +H + +I + +K + +L + +M + +N + +O + +P + +Q + +R + +S + +T + +U + +V + +W + +X + +Y + + |
|---|
| Jump to: | .
+
+/
+
+9
+
+~
+
+ +A + +B + +C + +D + +E + +F + +G + +H + +I + +K + +L + +M + +N + +O + +P + +Q + +R + +S + +T + +U + +V + +W + +X + +Y + + |
|---|
+Next: Variable and option index, Previous: GNU Free Documentation License, Up: Top [Contents][Index]
9term: Terminalsaterm: TerminalsEterm: Terminalslinux vt: Terminologylinux vt: Printing in TTY with KMSlinux vt: Optional runtime dependencieslinux vt: Terminalslinux vt: KMS ponieslinux vt: Environment variableslinux vt: Running on TTYmrxvt: Terminalsponythink: Balloon style filesputty: Terminalsrxvt: Terminalsurxvt: Terminalsutil-say: Providing poniesxterm: Terminals-Next: Distributing, -Previous: Inner workings, -Up: Top -
| • Providing ponies: | Providing ponies. + |
-This section describes the limitation of cowsay, but since version 2.1 -cowsay is no longer used because of it. So none of the following limitations +
This section describes the limitation of cowsay, but since version 2.1
+cowsay is no longer used because of it. So none of the following limitations
are present anymore.
-
-
When cowsay determines the length of a word it measures in number of bytes +
+When cowsay determines the length of a word it measures in number of bytes
(in UTF-8), therefore non-ASCII words will malformat the balloon with the message.
-
-
Further, cowsay does not recognise ANSI escape sequences, therefore, using +
+Further, cowsay does not recognise ANSI escape sequences, therefore, using
colours and text styling in messages will also malformat the balloon with the message.
-
-
cowsay does not support balloon, including the link between the message and -the pony, customisation, other than using cowthink. However you can modify -cowsay (written Perl, so you can edit the installed files) to make the +
+cowsay does not support balloon, including the link between the message and
+the pony, customisation, other than using cowthink. However you can modify
+cowsay (written Perl, so you can edit the installed files) to make the
balloon look different, maybe using box drawing characters.
-
-
cowsay does not support setting the minimum size of the balloon, both +
+cowsay does not support setting the minimum size of the balloon, both
directions on the balloon–pony links. or any other placement of the balloon than at
the top to the left.
+
-Previous: Installations basics, -Up: From upstream -
-With the exception for with --with-everything and --with-nothing, -every option that starts with --with- or --without- exists in both -variants. --with- options install parts of the package. --without- +
With the exception for with --with-everything and --with-nothing, +every option that starts with --with- or --without- exists in both +variants. --with- options install parts of the package. --without- options skips installation of parts of the packages. With the same exception, ---without- options take not arguments and --with- optionally takes +--without- options take not arguments and --with- optionally takes an argument, if no argument is provided a default argument is implied. - -
The configuration script recognised the following options, the default values for +
+The configuration script recognised the following options, the default values for
options with arguments are written after the equality sign (=) in the option:
-
-
Install everything that is not explicity excluded. +
+Install only the essentials. Note that this can vary depending on version. Currently
this means that the commands, xterm ponies and legal documents is installed.
-
-
Install nothing, except legal documents, that is not explicity included. +
+Install the ponysay command, and set file name. (Default)
+
Install the ponythink command, and set file name. (Default)
+
Install the ponysay-tool command, and set file name. (Default)
+
Install a user shared cache, this is only used by KMS ponies so far. (Default) +
+Install auto-completion for installed commands in GNU Bash. Select the file name
for the installed script for the ponysay command, the other commands modifies this
file name. (Default)
-
-
Install auto-completion for installed commands in Friendly interactive shell.
Select the file name for the installed script for the ponysay command, the other
commands modifies this file name. (Default)
-
-
Install auto-completion for installed commands in the zsh shell.
Select the file name for the installed script for the ponysay command, the other
commands modifies this file name. (Default)
-
-
Macro for --with-bash, --with-fish and --with-zsh.
The argument is the used share/ directory that all shells have in common.
-
-
Install PDF manual, and select directory for it. +
+Compress PDF manual, select compression by file name extension. This option +does not imply --with-pdf. (Default) +
+Install info manual, and select directory for it. (Default)
+
Use install-info when installing info manual. Set the
+description for the manual. This option does not imply --with-info. (Default)
+
Compress info manual, select compression by file name extension.
+This option does not imply --with-info. (Default)
+
Install English man manual. Set directory for man manuals.
(Default)
-
-
Install Spanish man manual. Set directory for man manuals.
+
Macro for all --with-man-LANG. +
+Compress English man manual, select compression by file name extension.
+This option does not imply --with-man-en. (Default)
+
Compress Spanish man manual, select compression by file name extension.
+This option does not imply --with-man-es. (Default)
+
Macro for all --with-man-LANG-compression. +
+Change the section for the ponysay manpage.
+
Change the section for the cowsay manpage.
+
Change the section for the fortune manpage.
+
Install standard xterm ponies. (Default) +
+Install standard tty ponies. (Default) +
+Install extra xterm ponies. (Default) +
+Install extra tty ponies. (Default) +
+Install pony quotes. (Default) +
+Install balloon styles. (Default) +
+Install UCS pony names. (Default) +
+Let the installer set the env name for python in ponysay.
(Default)
-
-
Set the env name for python in ponysay.
+
Set a prefix to all implicit directories. +
+Change all implicit configurations to fit local user a installation
for the current user.
-
-
Change all implicit directories to fit installation to /opt. +
+Set the system’s directory for command executables. +
+Set the system’s directory for non-command executables. Currently their
is not non-executable library, so this options has no effect, but bleeding
edge distributors should specify it if it differs from prefered.
-
-
Set the system’s directory for non-command executables. Currently their
is not non-command executables, so this options has no effect, but bleeding
edge distributors should specify it if it differs from prefered.
-
-
Set the system’s directory for resource files. +
+Set the system’s local specific configuration directory. +
+Set the system’s directory for cache directories. +
+Set off environment for installation. +
+Set how to link identical files. Directories cannot be hard linked on most
systems, therefore directories or always symbolically linked of hard linked
-is specified.
-Recognised arguments are copy, hard and symbolic.
-copy implies that files and directories are not linked, but duplicated.
-ponysay -L will give the same output as ponysay -l if copy
+is specified.
+Recognised arguments are copy, hard and symbolic.
+copy implies that files and directories are not linked, but duplicated.
+ponysay -L will give the same output as ponysay -l if copy
or hard is used. This is because it does link reading and not content or
-inode comparison.
+inode comparison.
+
Set your freedom. If you the any of the values strict, full, true
+or yes, the setup will make sure that only completly free parts of the package
+is installed. This should be used (--freedom=strict) on distributions for GNU
+endorsed (endorsable) GNU/Linux-libre distributions.
+
If you do not want this, will need to explicity say so (you do also need to say if you
+do want it) by using either of the values sloppy, partial, false
+or no.
+
Recognised compressions are gz which uses gzip -9, and xz -which uses xz -9e. xz is still exotic to most programs, using +
Recognised compressions are gz which uses gzip -9, and xz +which uses xz -9e. xz is still exotic to most programs, using it is not recommended. Distributors are strongly disencouraged to compression for the -PDF manual and should use --without-pdf-compression. - -
You can run ./setup.py [OPTIONS] view to make sure everything is correct +PDF manual and should use --without-pdf-compression. +
+You can run ./setup.py [OPTIONS] view to make sure everything is correct
before building and installing.
+
+Previous: Installations basics, Up: From upstream [Contents][Index]
+-Next: Gentoo Linux, -Previous: Chakra, -Up: Package repositories -
-A .deb file is available at http://roryholland.co.uk/misc.html#ponysay +
A .deb file is available at http://roryholland.co.uk/misc.html#ponysay (user maintained), and PPA:s can be found at https://launchpad.net/~vincent-c/+archive/ppa (user maintained) and https://launchpad.net/~blazemore/+archive/ponysay (user maintained). +
- + + + + diff --git a/pages/ponysay/Dependencies-for-pony-providers.html b/pages/ponysay/Dependencies-for-pony-providers.html index cc82d900..1baf1d65 100644 --- a/pages/ponysay/Dependencies-for-pony-providers.html +++ b/pages/ponysay/Dependencies-for-pony-providers.html @@ -1,58 +1,95 @@ - + + + + --Previous: Package building dependencies, -Up: Dependencies -
bashRequired to run dev/dist.sh.
+
coreutilsln and readlink are used in the ttyponies subscript
+of dev/dist.sh.
+
util-say>=3Used by dev/dist.sh ttyponies to build ttyponies from xterm ponies.
+It can be downloaded at https://github.com/maandree/util-say.
+
-Next: Installing, -Previous: Problems and requests, -Up: Top -
We have provided a script that should run one most, if not all shells, named
+./dependency-test.sh that will help you track down any missing package.
+The script works in bash, dash and zsh, but not
+in fish, so case you sh links to fish, run
+bash dependency-test.sh (or with one of the other compatible shells.)
+
| • Required runtime dependencies: | Required runtime dependencies. + | |
| • Optional runtime dependencies: | Optional runtime dependencies. + | |
| • Package building dependencies: | Package building dependencies. + | |
| • Dependencies for pony providers: | Dependencies for pony providers. + |
-We have provided a script that should run one most, if not all shells, named -./dependency-test.sh that will help you track down any missing package. -
- + + + diff --git a/pages/ponysay/Dimension-files.html b/pages/ponysay/Dimension-files.html new file mode 100644 index 00000000..bcd960f3 --- /dev/null +++ b/pages/ponysay/Dimension-files.html @@ -0,0 +1,91 @@ + + + + + ++Next: Pony browsing, Previous: Metadata collections, Up: The tool chest [Contents][Index]
+Pony dimension files are used by ponysay to determine the size of all
+ponies and use that information to determine which ponies fit the terminal
+and may be randomly selected.
+
Running ponysay-tool --dimensions PONY-DIR will generate three files
+widths, heights and onlyheights to the directory PONY-DIR,
+the contain optimised information about the widths, heigths and heights with printed
+without the balloon, respectively, for each pony the the directory. For use by the
+installer, the files to include can be explicity declared appending their basename to
+the command.
+
-Next: Terminology, -Previous: Contributing, -Up: Top -
-If you are planning on maintaining ponysay in your favourite operating +
If you are planning on maintaining ponysay in your favourite operating
system you should first read Required runtime dependencies and
Optional runtime dependencies. If your OS does not follow Filesystem Hierarchy
-Standard (FHS), e.g. installing amusement binaries in /usr/games instead of
-/usr/bin or only supporting /opt equivalent directories you should
+Standard (FHS), e.g. installing amusement binaries in /usr/games instead of
+/usr/bin or only supporting /opt equivalent directories you should
read about configurations in Custom installations.
-
-
Apart from this, you should configure ponysay before building it with the -option --everything. Otherwise only the info manual and the +
+Apart from this, you should configure ponysay before building it with the
+option --everything. Otherwise only the info manual and the
English manpage will be installed for documentation.
-
-
Please inform us about your distribution so we can list it so everypony can see it. - -
-The following is a reference distribution written in Arch Linux's PKGBUILD format.
+
Please inform us about your distribution so we can list it so everypony can see it. +
+The following is a reference distribution written in Arch Linux’s PKGBUILD format.
It is not complete, proper, verbose enough or well written, it just contains the
-core of an stable git distribution.
+core of an stable git distribution.
+
|
+
+
+pkgname=ponysay
+pkgver=3.0
+pkgrel=1
+arch=(any)
+pkgdesc="Cowsay reimplementation for ponies"
+url="https://github.com/erkin/ponysay"
+license=('GPL3' 'GNU FDL v1.3')
+depends=(python>=3 coreutils)
+optdepends=("util-say>=3: Improved TTY support with KMS and PNG files")
+makedepends=('git' 'texinfo' 'info' 'gzip' 'python>=3', 'zip')
-
|
+Next: Metadata collections, Previous: Metadata pasting, Up: The tool chest [Contents][Index]
+ponysay-tool allows you to edit the metadata in a pony file by running
+ponysay-tool --edit PONY-FILE, where PONY-FILE is the pony file to edit,
+not the pony name. No additional options are available.
+
ponysay-tool --edit PONY-FILE is interative and opens an editor inspired by GNU Emacs.
+The tool will give you the standard tags to fill and will automatically fill in HEIGHT
+and WIDTH for you without allowing you to editing those two tags. Additionally the editor
+will print the pony at the right side of the terminal with the name of the file you are editing.
+
The commands the editor use is a small subset of the standard commands in GNU Emacs. +Currently the commands are only coded for xterm (just about all terminals except Linux VT.) +C-x means x with control held down. +M-x means x with alt (meta) held down. +
+Set mark; only if mark is set and is at the same position +as the point (cursor) the mark is deactivated. +A mark creates a text select, it cannot span between lines. +
+Cut out the rest of the line and add it to the kill ring. +
+Cut out selected text and add it to the kill ring. +
+Add the selected text to the kill ring and unset the mark. +
+Paste (yank) text from the kill ring. +
+Cycle in the kill ring. +
+Insert a next line below the current line and go to it. +This is useful if you want to add another entry for a tag. +
+Go to next line, create a new line if at last line. +
+Go to next line, do not create a new line if at last line. +
+Go to previous line. +
+Go to next column. +
+Go to previous column. +
+Go to the beginning of the line. +
+Go to the end of the line. +
+Remove the previous character on the same line. +
+Remove the current character on the same line. +
+Enter or exit override mode. +
+Swap the mark and the point. +
+Save your changes. +
+Exit the editor, do not forget to save if you have made changes. +
+Next: Metadata collections, Previous: Metadata pasting, Up: The tool chest [Contents][Index]
+-Next: Optional features, -Previous: Advanced usage, -Up: Top -
-ponysay supports the follow environment variables: - -
ponysay supports the follow environment variables:
+
PONYSAY_BOTTOMUnder 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 PONYSAY_BOTTOM
+to be printed rather the the beginning you can export PONYSAY_BOTTOM
with the value yes, y or 1.
-
-
PONYSAY_SHELL_LINESUnder 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
-PONYSAY_SHELL_LINES with the value of how many blank lines you want.
+PONYSAY_SHELL_LINES with the value of how many blank lines you want.
Naturally this takes effect eve n if the output is not actually larger than
the screen.
-
-
yes, y
+
+PONYSAY_FULL_WIDTHYou can export PONYSAY_FULL_WIDTH with the value yes, y
or 1, if you do not want the output to be truncated on the width to
fit the terminal.
-
-
yes, y
+
+PONYSAY_TRUNCATE_HEIGHTExport PONYSAY_TRUNCATE_HEIGHT with the value yes, y
or 1, if you want to truncate the output on the height even if you
-are not running ponysay under TTY.
-
-
yes, y or 1,
+are not running ponysay under TTY.
+
+PONYSAY_UCS_MEExport PONYSAY_UCS_ME with the value yes, y or 1,
if you want [simulated] symlink to pony files using Universal Character Set
in their names. Otherwise pony files uses only ASCII. If you want to remove
-the ASCII:ised names export PONYSAY_UCS_ME with the value harder,
+the ASCII:ised names export PONYSAY_UCS_ME with the value harder,
h or 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 yes UCS names will be usable, suggested and listed. If you
use harder ASCII:ised names will not be suggested or listed, but they
will still be usable.
+
PONYSAY_KMS_PALETTEPONYSAY_KMS_PALETTE_CMDPONYSAY_KMS_PALETTE or 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 KMS ponies for information on how to use this. +
+PONYSAY_TYPO_LIMITSee KMS ponies for information on how to use this. +
ponysay is able to auto correct misspelled pony names and balloon style name. +Without consideration for transpositioning, the distance between two words are +measured in the number of edits needed to get from one word to the other, with +weighting on some character changes used to favour spellos over typos. +
+By default if the weighted distance is greater than 5 for the closest words,
+auto correction ignored. This limit can be changed by exporting the limit to
+PONYSAY_TYPO_LIMIT; setting the limit to zero will disable auto correction.
+
PONYSAY_WRAP_HYPHENYou can export what ponysay should use instead of a hyphen when wrapping messages. +The hythen is red by default, if you want to change the colour or other formating, +should should do so using the option --colour-hyphen (--colour-wrap). +
+PONYSAY_WRAP_LIMITDefines how long a word mush be to be hyphenated. This is used for to wrap words that +are long so the output gets as pretty as possible. This s not the only condition under +which a word can be hyphenated, it can also be hyphenated if the word cannot fit +otherwise. The default value is 8. +
+PONYSAY_WRAP_EXCEEDDefines how much a word must exceed the wrapping point to be hyphenated. This setting
+is used togather with PONYSAY_WRAP_LIMIT. The default value is 5.
+
+Next: Optional features, Previous: Advanced usage, Up: Top [Contents][Index]
++Next: Uninstalling, Previous: Package repositories, Up: Installing [Contents][Index]
+An "exotic operating system" as a operating system that is not GNU (GNU/Linux ("Linux") +and GNU/Hurd are GNU distor:s.) +
+ + +Ponysay is told to be running on Mac OS X, which is Unix-like OS meaning that probably +all future version of ponysay will be able to run without any problems. +
+ + +Ponysay is also reported to be able to run on Windows 8 through Cygwin, provided that
+python3 is installed. It will probabily also run one any other version of Windows
+through Cygwin. Additionally among the preinstalled fonts in Windows 8; Consolas 10pt,
+and larger, can be used for almost perfect ponies (they may be just a little distorted
+on the height), however Consolas is only able print the ASCII based balloons.
+
+Next: Reporting bugs, Up: Problems and requests [Contents][Index]
+There is only one known bug that may occour that is external to ponysay,
+meaning that it is a bug that can occour with ponysay, but is not actually
+a bug in ponysay. This bug is common for programs that prints a lot of
+colours, even with cat; it is only known to happen for VTE-based
+terminals, such as mate-terminal, gnome-terminal and
+terminator.
+
The bug, is that lines (often no more than one line) can skipped when all
+lines move up one step, the next line is skipped instead, and so one; or
+that an escape sequence is interpreted as pure text (this is common in GNU
+Emacs, however GNU Emacs does not support programs such as ponysay.)
+
This bug can often be suppressed by piping the output to cat
+multiple times when using a VTE-based terminal (or always if you prefer).
+The use of VTE-based terminal can often be determined by checking for the
+environment variable COLORTERM, to which VTE-based terminal usually
+export their name (some reported another terminals name.)
+
If you want to do this in GNU Bash you can add this (with possible modifications
+depending on what you also have done with ponysay) code sample
+to your ~/.bashrc file.
+
|
+
+
+[[ ! "$COLORTERM" = "" ]] &&
+ function ponysay
+ {
+ exec ponysay "$@" | cat | cat | cat | cat
+ }
+ |
It is important for this bug workaround that cat is unbuffered, which
+is default in GNU’s version of cat, but not in Unix’s version.
+If this does not work, test adding the option -u to cat.
+
+Next: Reporting bugs, Up: Problems and requests [Contents][Index]
+-Next: Fortune cookies, -Up: Advanced usage -
If file descriptor 3 is definied when ponysay is executed, extra information + + + + +
If file descriptor 3 is definied when ponysay is executed, extra information
is printed to it. The printed information includes the name of the pony file, the name
of the balloon style file, and if definied in the pony file, file meta data and comment.
+
In most shells, a file descriptor 3 can defined using 3> FILE, and linked to
+stderr using 3>&2. For example, you can print the information to ~/info
+by running ponysay I\'m just the cutest pony! 3> ~/info.
+
The message is not stored this way, for that you can use tee. However, if you
+use -q the quote file is printed to file descriptor 3.
+
In most shells, a file descriptor 3 can defined using 3> FILE, and linked to -stderr using 3>&2. For example, you can print the information to ~/info -by running ponysay I\'m just the cutest pony! 3> ~/info. -
The message is not stored this way, for that you can use tee. However, if you -use -q the quote file is printed to file descriptor 3. - + + diff --git a/pages/ponysay/Fill-KMS-cache.html b/pages/ponysay/Fill-KMS-cache.html new file mode 100644 index 00000000..915df9bb --- /dev/null +++ b/pages/ponysay/Fill-KMS-cache.html @@ -0,0 +1,93 @@ + + + + +
++Next: Metadata pasting, Up: The tool chest [Contents][Index]
+Before reading this section you may want to read the earlier section KMS ponies. +
+ +Invoking the command ponysay-tool --kms (no additional options are available)
+will pre-generate all kmsponies for your current TTY palette. This is useful if your
+computer is not fast enough, for you, at converting a pony to a kmspony. As the kmsponies
+may change between versions (noted in the change log if it happens) you may want to
+run this commmend after installing a new version of ponysay. Ponies that are
+already in the cache with the current KMS version will not be re-generated.
+
-Next: Ponification, -Previous: Extra information, -Up: Advanced usage -
-If you have fortune installed – this program may be named -fortune-mod in your GNU/Linux distributions package repository – you can +
If you have fortune installed – this program may be named
+fortune-mod in your GNU/Linux distributions package repository – you can
run fortune | ponysay to get a random pony reading a random fortune cookie.
-
-
By adding fortune | ponysay to the end [easiest way] of your
-~/.bashrc – or equivalent for your shell if you do not use GNU Bash
+
By adding fortune | ponysay to the end [easiest way] of your
+~/.bashrc – or equivalent for your shell if you do not use GNU Bash
(standard shell for most distributions now a days) – you will get the effect
described in the previous paragraph every time you open a terminal.
+
-Next: Package repositories, -Up: Installing -
| • Installations basics: | The basics of installations. + | |
| • Custom installations: | Installation customisation. + |
-Next: Concept and program index, -Previous: Ponysay license, -Up: Top +Next: Concept and program index, Previous: GNU General Public License, Up: Top [Contents][Index]
+Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. +http://fsf.org/ - -Version 1.3, 3 November 2008+Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. - http://fsf.org/ - - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. --
The purpose of this License is to make a manual, textbook, or other -functional and useful document free in the sense of freedom: to +
The purpose of this License is to make a manual, textbook, or other +functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, -with or without modifying it, either commercially or noncommercially. +with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. - -
This License is a kind of “copyleft”, which means that derivative +
+This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. - -
We have designed this License in order to use it for manuals for free +
+We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. +
+This License applies to any manual or other work, in any medium, that +
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that @@ -92,14 +114,14 @@ refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. - -
A “Modified Version” of the Document means any work containing the +
+A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. - -
A “Secondary Section” is a named appendix or a front-matter section +
+A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall +publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain @@ -107,21 +129,21 @@ any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. - -
The “Invariant Sections” are certain Secondary Sections whose titles +
+The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. - -
The “Cover Texts” are certain short passages of text that are listed, +
+The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. - -
A “Transparent” copy of the Document means a machine-readable copy, +
+A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of @@ -130,11 +152,11 @@ drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart -or discourage subsequent modification by readers is not Transparent. +or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”. - -
Examples of suitable formats for Transparent copies include plain +
+Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, @@ -146,35 +168,35 @@ XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. - -
The “Title Page” means, for a printed book, the title page itself, +
+The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means -the text near the most prominent appearance of the work's title, +the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text. - -
The “publisher” means any person or entity that distributes copies +
+The “publisher” means any person or entity that distributes copies of the Document to the public. - -
A section “Entitled XYZ” means a named subunit of the Document whose +
+A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition. - -
The Document may include Warranty Disclaimers next to the notice which +
+The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License. +
+You may copy and distribute the Document in any medium, either +
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other @@ -183,87 +205,87 @@ technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3. - -
You may also lend copies, under the same conditions stated above, and +
+You may also lend copies, under the same conditions stated above, and you may publicly display copies. +
+If you publish printed copies (or copies in media that commonly have +
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the -Document's license notice requires Cover Texts, you must enclose the +Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. +visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. - -
If the required texts for either cover are too voluminous to fit +
+If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. - -
If you publish or distribute Opaque copies of the Document numbering +
+If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols -a complete Transparent copy of the Document, free of added material. +a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. - -
It is requested, but not required, that you contact the authors of the +
+It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document. +
+You may copy and distribute a Modified Version of the Document under +
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: - -
If the Modified Version includes new front-matter sections or +
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the -list of Invariant Sections in the Modified Version's license notice. +list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles. - -
You may add a section Entitled “Endorsements”, provided it contains +
+You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. - -
You may add a passage of up to five words as a Front-Cover Text, and a +
+You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or @@ -319,71 +341,71 @@ includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. - -
The author(s) and publisher(s) of the Document do not by this License +
+The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version. +
+You may combine the Document with other documents released under this +
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. - -
The combined work need only contain one copy of this License, and +
+The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. +author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. - -
In the combination, you must combine any sections Entitled “History” +
+In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.” +
+You may make a collection consisting of the Document and other documents +
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. - -
You may extract a single document from such a collection, and distribute +
+You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document. +
+A compilation of the Document or its derivatives with other separate +
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights -of the compilation's users beyond what the individual works permit. +of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. - -
If the Cover Text requirement of section 3 is applicable to these +
+If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of -the entire aggregate, the Document's Cover Texts may be placed on +the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic form. +electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate. +
+Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. +
Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the @@ -394,48 +416,48 @@ the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. - -
If a section in the Document is Entitled “Acknowledgements”, +
+If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title. +
+You may not copy, modify, sublicense, or distribute the Document +
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License. - -
However, if you cease all violation of this License, then your license +
+However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. - -
Moreover, your license from a particular copyright holder is +
+Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. - -
Termination of your rights under this section does not terminate the +
+Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it. +
+The Free Software Foundation may publish new, revised versions +
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/. - -
Each version of the License is given a distinguishing version number. +
+Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or @@ -444,73 +466,85 @@ Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this -License can be used, that proxy's public statement of acceptance of a +License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document. +
+“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any +
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site. - -
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 +
+“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization. - -
“Incorporate” means to publish or republish a Document, in whole or +
+“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document. - -
An MMC is “eligible for relicensing” if it is licensed under this +
+An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008. - -
The operator of an MMC Site may republish an MMC contained in the site +
+The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing. +
+To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: +
+Copyright (C) year your name. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. A copy of the license is included in the section entitled ``GNU + Free Documentation License''. +
Copyright (C) year your name. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.3 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. A copy of the license is included in the section entitled ``GNU - Free Documentation License''. --
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the “with...Texts.” line with this: +
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the “with…Texts.” line with this: +
+with the Invariant Sections being list their titles, with + the Front-Cover Texts being list, and with the Back-Cover Texts + being list. +
with the Invariant Sections being list their titles, with - the Front-Cover Texts being list, and with the Back-Cover Texts - being list. --
If you have Invariant Sections without Cover Texts, or some other +
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation. - -
If your document contains nontrivial examples of program code, we +
+If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. +
- - - - ++Next: Concept and program index, Previous: GNU General Public License, Up: Top [Contents][Index]
++Next: GNU Free Documentation License, Previous: Ponysay license, Up: Top [Contents][Index]
+Copyright © 2007 Free Software Foundation, Inc. http://fsf.org/ + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. +
The GNU General Public License is a free, copyleft license for +software and other kinds of works. +
+The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program—to make sure it remains +free software for all its users. We, the Free Software Foundation, +use the GNU General Public License for most of our software; it +applies also to any other work released this way by its authors. You +can apply it to your programs, too. +
+When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. +
+To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. +
+For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, +receive or can get the source code. And you must show them these +terms so they know their rights. +
+Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. +
+For the developers’ and authors’ protection, the GPL clearly explains +that there is no warranty for this free software. For both users’ and +authors’ sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. +
+Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users’ freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. +
+Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. +
+The precise terms and conditions for copying, distribution and +modification follow. +
+ +“This License” refers to version 3 of the GNU General Public License. +
+“Copyright” also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. +
+“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations. +
+To “modify” a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a “modified version” of +the earlier work or a work “based on” the earlier work. +
+A “covered work” means either the unmodified Program or a work based +on the Program. +
+To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. +
+To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. +
+An interactive user interface displays “Appropriate Legal Notices” to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. +
+The “source code” for a work means the preferred form of the work for +making modifications to it. “Object code” means any non-source form +of a work. +
+A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. +
+The “System Libraries” of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +“Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. +
+The “Corresponding Source” for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work’s +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. +
+The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. +
+The Corresponding Source for a work in source code form is that same +work. +
+All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. +
+You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. +
+Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. +
+No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. +
+When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work’s users, your or third parties’ legal rights to forbid +circumvention of technological measures. +
+You may convey verbatim copies of the Program’s source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. +
+You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. +
+You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: +
+A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +“aggregate” if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation’s users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. +
+You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: +
+A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. +
+A “User Product” is either (1) a “consumer product”, which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +“normally used” refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. +
+“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. +
+If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). +
+The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. +
+Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. +
+“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. +
+When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. +
+Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: +
+All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. +
+If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. +
+Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. +
+You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). +
+However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. +
+Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. +
+Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. +
+You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. +
+Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. +
+An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party’s predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. +
+You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. +
+A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor’s “contributor version”. +
+A contributor’s “essential patent claims” are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. +
+Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor’s essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. +
+In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To “grant” such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. +
+If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. “Knowingly relying” means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient’s use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. +
+If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. +
+A patent license is “discriminatory” if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. +
+Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. +
+If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey +a covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree +to terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. +
+Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. +
+The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. +
+Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License “or any later version” applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If +the Program does not specify a version number of the GNU General +Public License, you may choose any version ever published by the Free +Software Foundation. +
+If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy’s public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. +
+Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. +
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. +
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. +
+If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. +
+If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. +
+To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the “copyright” line and a pointer to where the full notice is found. +
+one line to give the program's name and a brief idea of what it does. +Copyright (C) year name of author + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/. +
Also add information on how to contact you by electronic and paper mail. +
+If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: +
+program Copyright (C) year name of author +This program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’. +This is free software, and you are welcome to redistribute it +under certain conditions; type ‘show c’ for details. +
The hypothetical commands ‘show w’ and ‘show c’ should show +the appropriate parts of the General Public License. Of course, your +program’s commands might be different; for a GUI interface, you would +use an “about box”. +
+You should also get your employer (if you work as a programmer) or school, +if any, to sign a “copyright disclaimer” for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +http://www.gnu.org/licenses/. +
+The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use +the GNU Lesser General Public License instead of this License. But +first, please read http://www.gnu.org/philosophy/why-not-lgpl.html. +
++Next: GNU Free Documentation License, Previous: Ponysay license, Up: Top [Contents][Index]
++Next: Cowsay, Previous: Terminals, Up: Limitations [Contents][Index]
+ponysay should work just fine on GNU/Hurd, except for in the native virtual
+terminal (TTY). Hurd’s terminal is limited to 16 colours and does not provide the capaility
+of modifing
+
If we are lucky it may be possible draw pictures, in full resultions, as you can in linux;
+which is currently not inplementedin ponysay. Another, not yet implemented
+possiblity, is to use low resoltion with ACSII character for colour interpolation.
+
-Next: Source Mage GNU/Linux, -Previous: Debian GNU/Linux, -Up: Package repositories -
Gentoo users can use the overlay https://github.com/etu/aidstu-overlay, which
+contains ponysay as games-misc/ponysay (developer maintained).
+
-Gentoo users can use the overlay https://github.com/etu/aidstu-overlay, which
-contains ponysay as games-misc/ponysay (developer maintained).
-
+
+
+
diff --git a/pages/ponysay/Inner-workings.html b/pages/ponysay/Inner-workings.html
index 12a96dcb..d972d384 100644
--- a/pages/ponysay/Inner-workings.html
+++ b/pages/ponysay/Inner-workings.html
@@ -1,63 +1,100 @@
-
+
+
+
+
-Next: Contributing, -Previous: Installing, -Up: Top -
| • Pony anatomy: | Anatomy of pony files. + | |
| • Pony metadata extension: | Metadata in pony files. + | |
| • Pony quote infrastructure: | Pony quote infrastructure. + | |
| • Balloon style files: | Balloon style files. + | |
| • Printing in TTY with KMS: | Printing in TTY with KMS support. + | |
| • Truncation: | Output truncation. + | |
| • Languages: | Selection of programming languages. + | |
| • Shell auto-completion: | Things that make auto-completion simpler. + | |
| • Universal Character Set: | Something about Universal Character Set support. + |
-Next: Custom installations, -Up: From upstream -
Before installing ponysay, make sure your system have the packages listed +
Before installing ponysay, make sure your system have the packages listed
under Required runtime dependencies and Package building dependencies
installed.
-
-
Tarballs can be downloaded at https://github.com/erkin/ponysay/tarball/master +
+Tarballs can be downloaded at https://github.com/erkin/ponysay/tarball/master for bleeding edge, or from https://github.com/erkin/ponysay/tags for releases. - -
If you have git you can clone the project URL +
+If you have git you can clone the project URL
https://github.com/erkin/ponysay.git.
+
In the terminal, cd into the ponysay directory and execute
+./setup.py --freedom=parital install or
+python3 setup.py --freedom=parital install. This will install
+ponysay into /usr, normally meaning you need to run as root, e.g. by
+running sudo ./setup.py --freedom=parital install.
+
The --freedom option and manditory, if you only want completely free
+ponies, use --freedom=strict instread of --freedom=partial.
+
Now you will be to use ponysay, run: ponysay "I am just the cutest pony!",
+or if have a specific pony in your mind: ponysay -f pinkie "Partay!~".
+
ponysay comes with this info manual and a manpage in section 6,
+man 6 ponysay (or just man ponysay). The manpage is also available
+in Spanish: man -L es 6 ponysay. To install the Spanish manual add the
+option --with-man-es when running ./setup.py.
+
In the terminal, cd into the ponysay directory and execute -./setup.py install or python3 setup.py install. This will install -ponysay into /usr, normally meaning you need to run as root, e.g. by -running sudo ./setup.py install. -
Now you will be to use ponysay, run: ponysay "I am just the cutest pony!", -or if have a specific pony in your mind: ponysay -f pinkie "Partay!~". -
ponysay comes with this info manual and a manpage in section 6, -man 6 ponysay (or just man ponysay). The manpage is also available -in Spanish: man -L es 6 ponysay. To install the Spanish manual add the -option --with-man-es when running ./setup.py. - + + diff --git a/pages/ponysay/Installing.html b/pages/ponysay/Installing.html index 5fc90b22..a70ebbe5 100644 --- a/pages/ponysay/Installing.html +++ b/pages/ponysay/Installing.html @@ -1,58 +1,90 @@ - + + + +
--Next: Inner workings, -Previous: Dependencies, -Up: Top -
| • From upstream: | Installing manually from upstream (GitHub repository). + | |
| • Package repositories: | Packages distributed in OS package repositories. + | |
| • Exotic operating systems: | Installing on other OS:es than GNU. + | |
| • Uninstalling: | Uninstalling when installed manually. + |
-Next: Advanced usage, -Previous: Overview, -Up: Top -
ponysayThe format for running the ponysay program is:
+
ponysay [option...] [--] [message] +ponythink [option...] [--] [message] +
-The format for running the ponysay program is: - -
ponysay [option...] [--] [message] - ponythink [option...] [--] [message] --
Running ponysay will print a speech balloon, ponythink will -print a thought balloon. Otherwise ponysay and ponythink is +
Running ponysay will print a speech balloon, ponythink will
+print a thought balloon. Otherwise ponysay and ponythink is
the same thing.
-
-
ponysay supports the following options: - -
ponysay supports the following options:
+
Parse the following arguments as parts of message.
+
Show summary of options. +
+Show version of program. +
+Specify the pony that should printed, this can either be a file name or a pony
+name printed by ponysay -l. This option can be used multiple times to
specify a set of ponies from which one will be selected randomly. If no pony is
specified one will be selected randomly.
-
-
If you have util-say installed, you can use .png-files as the arguments +
+ + + + + +If you have util-say installed, you can use .png-files as the arguments
for this options.
-
-
In versions earlier than version 2.0, the if the pony were a file name it had to
-include a `/'. This is not longer required and any existing pony name
+
In versions earlier than version 2.0, the if the pony were a file name it had to
+include a ‘/’. This is not longer required and any existing pony name
supersedes file names.
-
-
Just as +f, but it uses extra (non-MLP:FiM) ponies instead of standard
(MLP:FiM) ponies
-
-
This option combines -f and +f. +
+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 -q. If one or more ponies are added as an argument
-to -q, the pony will be selected randomly from that set of ponies.
-This option requires the extension ponyquotes4ponysay, which is included
+is added as an argument to -q. If one or more ponies are added as an argument
+to -q, the pony will be selected randomly from that set of ponies.
+This option requires the extension ponyquotes4ponysay, which is included
by default since version 1.2.
-
-
The argument can be a file name, but only if it ends with .pony.
-
-
The argument can be a file name, but only if it ends with .pony. +
+Variadic variant of -f, meaning that all arguments added after this one
will parsed as an argument to this option. Additionally, those options are added
-to -f.
-
-
Variadic variant of +f, meaning that all arguments added after this one will parsed as an argument to this option. Additionally, those options are added -to -F. - -
An important feature of this options, is that you can but it in the end of the
-command line, without any argument to get a random non-MLP:FiM pony.
-
-
An important feature of this options, is that you can but it in the end of the +command line, without any argument to get a random non-MLP:FiM pony. However, +altough it is not nice, since version 3.0, +f can also be unargumented +if at the end of the command line. +
+This option combines --f and ++f. +
+Variadic variant of -q, meaning that all arguments added after this one will parsed as an argument to this option. Additionally, those options are added -to -q. - -
An important feature of this options, is that you can but it in the end of the +to -q. +
+An important feature of this options, is that you can but it in the end of the
command line, without any argument to get a quote from any pony with a quote.
-
-
Specify the balloon style that should used, this can either be a file name or a
+balloon name printed by ponysay -B. This option can be used multiple
times to specify a set of styles from which one will be selected randomly. If no
balloon style is specified a fallback style will be used.
-
-
If the argument is not a number, but starts instead with n (for ‘none’ or
+
Specify the screen column where the message should be wrapped, this is by default 40,
+as with cowsay. The balloon’s extra width is taken into consideration.
+
If the argument is not a number, but starts instead with n (for ‘none’ or
‘no’), no wrapping is done, and if it starts with i (for ‘inherit’) the width
of the terminal is used.
-
-
n and i is case insensitive, so you may use N and I
-instead. Additionally, typo correction is for QWERTY and Dvorak is built in to
-ponysay; the nearest key, either to the left or to the right, depending
-on which hand is used to press the key, is also allowed.
-
-
n and i is case insensitive, so you may use N and I
+instead. Additionally, typo correction is for QWERTY (and QWERTZ) and Dvorak is
+built in to ponysay; the nearest key, either to the left or to the
+right, depending on which hand is used to press the key, is also allowed.
+
Compress the message in the same way cowsay does, that is basically
without multiple spaces, and only paragraphs separations. Using this options
-will mean that you cannot display figlet and TOIlet style
+will mean that you cannot display figlet and TOIlet style
messages.
-
-
Lists all installed ponies. The ponies which have quotes, i.e. can be used with
+the -q option, will be marked 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 -q option, will be marked by being printed in bold or bright (depending
+on the terminal.) This options differs from -l by printing alternative
names (symbolic links) inside brackets after their target ponies.
-
-
Just as -l, except it lists extra (non-MLP:FiM) ponies instead of standard
(MLP:FiM) ponies.
-
-
Just as -L, except it lists extra (non-MLP:FiM) ponies instead of standard
(MLP:FiM) ponies.
-
-
Prints a list of all balloon styles. +
+List all ponies, MLP:FiM and non-MLP:FiM, in this case the first list are MLP:FiM
and the second are non-MLP:FiM.
-
-
List all ponies names, including alternatives, these from MLP:FiM and non-MLP:FiM.
The first list are the MLP:FiM and the second one are non-MLP:FiM.
-
-
Print just the pony, nothing else like the speech balloon. Naturally the
+ponysay will not wait for a message from stdin.
+
By adding this flag you will get a metadata for a pony printed, rather than the pony +itself. The output will beformated with bold tag names. The output will be wrapped +according to the -W option. +
+This works just like the -i option, except the pony will use the output +has her message rather that just print that information. +
+This option is used to restrict which ponies can be randomly select based one their +metadata. The restrict is given is disjunctive normal form, and can hence express any +logical combination, however only for tags with one entry. For tags with multiple +values all values are tested and of one of them passes a test passes. +
+The argument for --restrict is a + separated list of values that all
+must be satisfied for a pony to be qualified for random selection. The option
+--restrict can be used multiply times, only one of them need to be satisfied
+for a pony to qualified for random selection.
+
A value in the argument is a combination of the tag name and tag value on the form
+NAME=VALUE. Additionally if the tag names ends with a question mark (?)
+the tag is satsified if the tag is missing; if the value starts with a bang (!)
+the test is inverted. Using just a bang means that the test passes for and only for
+all ponies with the tag definied; using the question mark and a empty value means
+that the test passes for all ponies; finally, using the question mark and just a bang
+for the value means that the test passes for and only for all ponies without the tag
+definied.
+
For most shells, if not all, trick to not need to use disjunctive normal form is to
+use { }. For example if you use
+--restrict={eye={blue,green,cyan}+coat={black,grey},coat=white}
+(note that there is no whitespaces) means that only ponies with white coat will be
+randomly selected as will as ponies with black or grey coat provided that they
+have either blue, green or cyan eyes.
+
Use xterm’s 256-colour support (supported by most X11 terminals), despite
+your terminal’s actual compatibilies.
+
Use Linux VT’s compatbilies without KMS utilisation, despite your terminal’s actual
compatibilies.
-
-
Use Linux VT’s compatbilies with KMS utilisation, despite your terminal’s actual
compatibilies.
-
-
Colour the balloon, including link and message (the parts that are not individually
specified.) The argument, should be a ANSI colour sequence without leading CSI and
without a tailing ‘m’, for example 1;31 will make it in red and bold (or bright
depending on the terminal.)
-
-
Just like --colour, but it only colours the balloon, without the message
or link.
-
-
Just like --colour, but it only colours the balloon link. +
+Just like --colour, but it only colours the message. +
+Just like --colour, but it colours the pony. This colouring has no
effect ony regular pony files, as it has its own colouring.
-
-
Just like --colour, but it colours hyphen added by the word wrapping.
By default this is red (31), if you want uncoloured use 0,
without 0 or 39, the default 31 is presistent.
+
If neither -q is used nor any message is specified, ponysay + +
If neither -q is used nor any message is specified, ponysay
will read the message from stdin (standard input); however, if no arguments are used
and nothing is piped to stdin, a help message will be printed. If you want to use
-ponysay without arguments and enter the message by hand, you can run
+ponysay without arguments and enter the message by hand, you can run
cat | ponysay.
-
-
If no pony is selected, ponysay will look for a best.pony file, +
+ +If no pony is selected, ponysay will look for a best.pony file,
this file should be a symbolic link to the pony you want as a default. If it is not
-a symbolic link, -q cannot determine which quotes to use.
+a symbolic link, -q cannot determine which quotes to use.
+
+Next: Advanced usage, Previous: Overview, Up: Top [Contents][Index]
+-KMS ponies is an optional feature that required that you have util-say>=2 -(util-say<2 for ponysay<2.1) installed. It lets TTY users that +
KMS ponies is an optional feature that required that you have util-say>=3
+(util-say<2 for ponysay<2.1 and util-say<3 for
+ponysay<3) 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.
-util-say can be downloaded at https://github.com/maandree/util-say.
-
-
To use this feature your ~/.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 $PONYSAY_KMS_PALETTE or you
+to lack of published specifications Nvidia drivers does not support KMS.
+util-say can be downloaded at https://github.com/maandree/util-say.
+
To use this feature your ~/.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 $PONYSAY_KMS_PALETTE or you
should export a command to can get the palette string to
-$PONYSAY_KMS_PALETTE_CMD. The palette string should be the stream which sets
-the colour palette to the terminal when echo:ed; preferably, to increase
+$PONYSAY_KMS_PALETTE_CMD. The palette string should be the stream which sets
+the colour palette to the terminal when 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 ~/.bashrc, to reset the colour palette
+to what you set it to last time in the terminal, named reset-palette,
+your ~/.bashrc should, for example, contain:
+
|
+
+
+[ "$TERM" = "linux" ] &&
+ function ponysay
+ { export PONYSAY_KMS_PALETTE="$(reset-palette)"
+ exec ponysay "$@"
+ }
+ |
Assuming you have a function in your ~/.bashrc, to reset the colour palette -to what you set it to last time in the terminal, named reset-palette, -your ~/.bashrc should, for example, contain: -
- [ "$TERM" = "linux" ] &&
- function ponysay
- { export PONYSAY_KMS_PALETTE="$(reset-palette)"
- exec ponysay "$@"
- }
-
- |
KMS ponies uses /var/cache/ponysay/ or, if missing, ~/.cache/ponysay/ +
KMS ponies uses /var/cache/ponysay/ or, if missing, ~/.cache/ponysay/ for cache space. +
+You may also want to read Fill KMS cache. +
- ++Up: Optional features [Contents][Index]
+-Next: Shell auto-completion, -Previous: Truncation, -Up: Inner workings -
-Before version 2.0 ponysay was written primarily in GNU Bash script; the +
Before version 2.0 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 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 +
+Sometimes shell is too slow, in these cases Perl was used; Perl was already required
+by 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. +
- + + + + diff --git a/pages/ponysay/Limitations.html b/pages/ponysay/Limitations.html index f3033cf6..6b67f3b4 100644 --- a/pages/ponysay/Limitations.html +++ b/pages/ponysay/Limitations.html @@ -1,57 +1,87 @@ - + + + + --Next: Problems and requests, -Previous: Optional features, -Up: Top -
| • Terminals: | Limitations on terminals. + | |
| • GNU Hurd: | Limitations of the Hurd. + | |
| • Cowsay: | Limitations on cowsay. + |
+Next: Dimension files, Previous: Editing metadata, Up: The tool chest [Contents][Index]
+Pony metadata collection files are used by ponysay to by just reading
+one file per directory determine all pony files metadata and determine which
+ponies will pass the --restrict option when ponies are randomly selected.
+
A metadata colletion file’s content a list, of pony files with and their corresponding +metadata as a map from tag name to tag value set, serialised with Python’s cPickle module. +
+Running ponysay-tool --metadata PONY-DIR will generate the file metadata
+with the serialised information. For use by the installer, the files to include can be
+explicity declared appending their basename to the command.
+
+Next: Editing metadata, Previous: Fill KMS cache, Up: The tool chest [Contents][Index]
+ponysay-tool allows you to copy, remove, stash and apply stashed pony metadata
+(but not merging, that must be done by hand.) The following commands does not support
+additional options.
+
ponysay-tool --edit-rm PONY-FILE will remove all metadata from the file
+PONY-FILE. To just remove some data you must use ponysay-tool --edit PONY-FILE
+or do it by hand. Note that you always use pony file, not pony names.
+
ponysay-tool --edit-stash PONY-FILE will print all metadata from a file to stdout.
+Cherry-picking cannot be done.
+
ponysay-tool --edit-apply PONY-FILE replace all metadata in a file with the metadata
+used provided in stdin.
+
To copy the metadata from one pony to another (and remove the old metadata) you will have to
+pipe the stashing and the applying command:
+ponysay-tool --edit-stash SOURCE-PONY-FILE | ponysay-tool --edit-apply TARGET-PONY-FILE
+
+Previous: ~/.ponysayrc, Up: Advanced usage [Contents][Index]
+The following will not work if you have line breaks in you file names, but if you do +have that, you may want to rethink that as it will usually cause problems for programs, +especially for shell scripts. +
+The command __pony=$(ponysay -o 3>&1 1>/dev/null | grep ^pony\ file: |
+sed -e s/^pony\ file:\ //g) && (ponysay -of "$__pony" | ponythink -Wn -f "$__pony")
+will give you a pony thinking of herself. The command works on GNU Bash, but may
+not work on less POSIX compatible shells. It works by first getting a random pony and
+use the extra information printed the file descriptor 3 (see Extra information),
+and fetchs the file name with help of grep and sed. The file
+name is stored in a shell variable. It the pipes one an execute of ponysay into
+another executing, using the stored file anme in both executions. This does not
+work on FISH shell because os POSIX incompatibility.
+
Ponysay can use just about anything as a message because it quarantines the message’s +ANSI escape sequences, including colour. And is Unicode aware (including combining +characters) and ANSI escape sequence aware. +
+Naturally this means that you can also make ponies think of eachother,
+for example: ponysay -f rarity -b round 'My little Spiky-wiky' |
+ponythink -f spikefloat -b unicode -W n
+
-Next: Limitations, -Previous: Environment variables, -Up: Top -
| • KMS ponies: | Improved TTY support under KMS support. + |
-Next: Package building dependencies, -Previous: Required runtime dependencies, -Up: Dependencies -
util-say>=3For improved TTY support for user with custom colour palette and KMS support.
It can be downloaded at https://github.com/maandree/util-say. If this is
-used chmod from coreutils is also required.
+used chmod from coreutils is also required.
+
For the purpose of simplifying for pony contributors, ponysay supports -using .png-images (note that the file must not miss the .png at the end of -the file name) in addition to .pony-files or pony names. + + + + +
For the purpose of simplifying for pony contributors, ponysay supports
+using .png-images (note that the file must not miss the .png at the end of
+the file name) in addition to .pony-files or pony names.
+
-Next: Invoking ponysay, -Previous: Top, -Up: Top -
-ponysay displays an image of a My Little Pony pony saying a message provided +
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 ponysay was a wrapper for cowsay, but has since
-version 2.1 become an independent reimplementation of cowsay.
-
-
If a message is not provided, e.g. by piping, it accepts standard input. The pony
+(MLP:FiM). Historically ponysay was a wrapper for cowsay, but has since
+version 2.1 become an independent reimplementation of 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. - -
ponythink is to ponysay as cowthink is to -cowsay. - -
ponysay is generally used to decorate your terminal with a random pony, when +
+ponythink is to ponysay as cowthink is to
+cowsay.
+
ponysay is generally used to decorate your terminal with a random pony, when
you start the terminal. But if you know anypony how does like ponies [fat chance] you
-can always make screen-shots of ponysay --q executions and communication that
+can always make screen-shots of ponysay --q executions and communication that
way over e-mail.
+
-Next: Dependencies for pony providers, -Previous: Optional runtime dependencies, -Up: Dependencies -
python>=32Required to run the ./setup.py file, which is also invoked from the +make script. +
gzipUsed for compressing manuals. (Optional, standard) +
xzUsed for compressing manuals. (Optional, non-standard) +
texinfoUsed to compile this info manual. (Optional, standard)
+
info3Used to install this info manual with install-info.
(Optional, standard)
+
[1] Sometimes distributed as python3 rather than python.
+[2] Normally a part of texinfo.
+Sometimes distributed as python3 rather than python.
Normally a part of texinfo.
-Next: Uninstalling, -Previous: From upstream, -Up: Installing -
| • Arch Linux: | Packages for Arch Linux. + | |
| • Arch Linux ARM: | Packages for Arch Linux ARM. + | |
| • Chakra: | Packages for Chakra. + | |
| • Debian GNU/Linux: | Packages for Debian GNU/Linux and Ubuntu. + | |
| • Gentoo Linux: | Packages for Gentoo Linux. + | |
| • Source Mage GNU/Linux: | Packages for Source Mage GNU/Linux. + |
-Next: Running on TTY, -Previous: Fortune cookies, -Up: Advanced usage -
-You can ponify messages (i.e. replaces words search as `everyone' with `everypony') by
-using fortune | ponypipe instead of using fortune. ponypipe
-can be downloaded from https://github.com/maandree/ponypipe.
-Alternatively you can use pinkie (or pinkiepie), which can be
+
You can ponify messages (i.e. replaces words search as ‘everyone’ with ‘everypony’) by
+using fortune | ponypipe instead of using fortune. ponypipe
+can be downloaded from https://github.com/maandree/ponypipe.
+Alternatively you can use pinkie (or pinkiepie), which can be
downloaded from https://github.com/maandree/pinkie-pie, which is just
-fortune | ponypipe. There is also a large sed script, similar to
-ponypipe: http://www.reddit.com/r/mylittlelinux/comments/srixi/using_ponysay_with_a_ponified_fortune_warning/
-However I think ponypipe as better at replacing words than the sed
-script, but I haven't used the script so I wouldn't know for sure.
+fortune | ponypipe. There is also a large sed script, similar to
+ponypipe: http://www.reddit.com/r/mylittlelinux/comments/srixi/using_ponysay_with_a_ponified_fortune_warning/
+However I think ponypipe as better at replacing words than the sed
+script, but I haven’t used the script so I wouldn’t know for sure.
+
-Next: Pony quote infrastructure, -Up: Inner workings -
-The pony files are simple raw output data that can be printed to the terminal, +
The pony files are simple raw output data that can be printed to the terminal, except it contains scalar variables. The pony images consists of white space, lower half blocks [U+2584], upper half blocks [U+2580] and ANSI colour sequences (CSI m), and, in TTY, colour value change sequences (OSI P). - -
Variables are recalled by putting the variable's name between two dollar signs
-($var$), and are stored by putting the variable's name followed by the value
+
Variables are recalled by putting the variable’s name between two dollar signs
+($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
($var=value$). Variable names cannot include equality signs, but the value
can; dollar signs can be used by placing an ESC character before the dollar sign.
-
-
There are three predefined variables: $$ (empty variable name), $\$
+
There are three predefined variables: $$ (empty variable name), $\$
and $/$. $$ has a dollar sign ($) as its value, while $\$
and $/$ contains the characters for the link to the balloon directed in the
-same direction as the variable name's slash.
-
-
Variables whose name begin with balloon are parsed as balloon inserts, it
+same direction as the variable name’s slash.
+
Variables whose name begin with balloon are parsed as balloon inserts, it
can be either balloon, balloonX, balloon,Y or balloonX,Y,
whether X is the minimum width of the balloon and Y is the minimum
-height of the balloon.
-
-
Prior to version 2.1 the pony files were cow files used by cowsay, they
+height of the balloon. New in Ponysay 3.0 is that the X can also be an range
+of columns, it contains of two numbers, the preferable start column, from the
+column that variables is placedon, the other number is the minimum width of the
+balloon. The two values are separated either by a l, a r or a c.
+If l is used the the balloon is printed as normal, except that it if wrapping
+is enabled and the balloon whould exceed the wrapping column, the balloon continues
+to fill on its left, at most as much as the position value. If r is used, the
+balloon fills the its left first and then to its right. If c is used the
+balloon will try the fill on its left and right side equally.
+
Prior to version 2.1 the pony files were cow files used by cowsay, they
are partial Perl-scripts that assign a value to a scalar variable named
-$the_cow. Cow files use a predefined scalar variable named $thoughts,
+$the_cow. Cow files use a predefined scalar variable named $thoughts,
these are used to create a link between the message and the pony. The message (and
-the balloon) itself was printed by cowsay and is not defined in the cow
+the balloon) itself was printed by cowsay and is not defined in the cow
files.
+
+Next: Pony metadata extension, Up: Inner workings [Contents][Index]
++Previous: Dimension files, Up: The tool chest [Contents][Index]
+Running ponysay-tool --browse PONY-DIR, or ponysay-tool -b PONY-DIR
+will display all ponies in PONY-DIR for you. You can limit the listed ponies by
+using the option --restrict, or -r, that works the same was in with
+the commands ponysay and ponythink. See Invoking ponysay for
+more infomation about the --restrict option.
+
In this browser you will on the right side have all pony files, in your selected +directory, listed except those that does not match your --restrict settings. +In the rest of the free space, the pony select in the list is centered. You can move +the pony, in case it is too big, by using the arrows keys with control held down, +or using the W, A, S, D keys (for QWERTY and QWERTZ layout,) +or with the < (or Ä), A, O, E keys (for Dvorak and Svorak +layout.) To recenter the pony press C-l (dl with control held down.) +
+Browse between ponies using the arrow keys or with C-n and C-p, for next +pony and previous pony, respectivily. Additionally, Q can be used list quotes +for pony, and I for metadata; press the key again to return the pony browsing. +
+The tool can be exited using the key combinations C-q or C-x C-c. +
+ + + + + + + diff --git a/pages/ponysay/Pony-metadata-extension.html b/pages/ponysay/Pony-metadata-extension.html new file mode 100644 index 00000000..59369912 --- /dev/null +++ b/pages/ponysay/Pony-metadata-extension.html @@ -0,0 +1,110 @@ + + + + + ++Next: Pony quote infrastructure, Previous: Pony anatomy, Up: Inner workings [Contents][Index]
+New in ponysay 3.0 is pony metadata, this feature is not supported in util-say
+(at least not yet). It extends the previously described4
+format of the pony files, by letting you specify details about the pony image, and
+the pony itself, as well as adding comments.
+
The metadata entry must be at the absolute beginning of the file (UTF-8 signture
+excluded), and is the file must be encoded in UNIX line breaks. The metadata entry
+begins with a line with exact 3 dollar signs and nothing else ($$$), and
+end in the same way direct follow by the pony image starting from the next line.
+
A metadata tag consists of a tag name in upper case and a tag value, with a colon
+(:), optionally with regular spaces or tab spaces. Multiple tag names can
+be used multiple times or can be completely skipped. There are only a few tags,
+namely BALLOON TOP, BALLOON BOTTOM, MASTER, FREE, that
+absolutely should not be used muliple tag; a general rule is that a tag desribing
+a pony should be duplicated exact as many times as there are ponies in the image.
+
Any line that does not conform to the format of a tag line is a part of the comment +field. Leading line breaks in the comment field is ignored. +
+ + + + + + + diff --git a/pages/ponysay/Pony-metadata.html b/pages/ponysay/Pony-metadata.html new file mode 100644 index 00000000..8cf51cbe --- /dev/null +++ b/pages/ponysay/Pony-metadata.html @@ -0,0 +1,419 @@ + + + + + ++Next: The tool chest, Previous: Optional features, Up: Top [Contents][Index]
+Pony files can contain metadata tags and a multiline comment.
+The following are the standard tags (comma separated lists may
+have whitespace surrounding the comma [,]):
+
If a pony file contains multiple ponies, it should have a GROUP NAME
+tag. The tag is a comma seperated list of the recognised names of the ponies as a
+groups, if the list is empty the tag value must be (none). An officiallity
+tag should be added to each name.
+
Every pony file should have this tag, one entry for each pony on the file.
+The value of the tag must be the pony’s most common name as used on
+the TV show (or other source). If the pony’s name have not been mentioned
+the value must be (not mentioned).
+
If a pony in the pony file has other names then the one in NAME it should
+have this take for this pony. Any pony in the file (in case of multiple ponies) that
+do not need this tag should use the value (none).
+
The tag is a comma seperated list of alternative (to NAME names for the pony, +each name should have an officiallity tag. +
+This tag specifies in which episode the pony first appeared. It reasonable to specify +it even for ponies that appears in every episode. +
+For uniformity the format S%sE%e %t[ %P] is recommended; [ ] denotes
+and optional part, optional in the sence that it does not apply the every episode,
+but it should be used if applyable. %s is the series (season) number
+in two digits, %e is the episode number in two digits. %t is the
+episode title and should use the standardised title format for the used format
+however without surrounding quotes if the used language has that, in the unlike
+event that [ or ] is present in the title it should be backslashed
+(\[, \]). %P is the part in the format [Part %p], where
+[ ] does not denote and optional part but rather is verbatim, and
+%p is the part number in one digit (well, if the part number is not 10 or higher).
+
The standard way to format titles in American English is the same as in British English, +however it is not fully standardised. Capitalisation of the first word, and all other words, +except for articles, prepositions, conjunctions, and forms of ‘to be’ is recommended. +
+Be aware that MLP:FiM episodes use American spelling which include a rather uncommon +why to write for examples abbrevations (like for example Mr. instread of Mr), this may +however not be the case for non-MLP:FiM episodes. And if there are not series (season) +the series number defaults to 1, however other numbers and tags (which the part number +is) may be added if required. +
+This tag decribes what kind of pony a pony is, it is a comma seperated lower case list, +and it cannot be empty, by it can be (but shouldn’t) skipped for every pony in the image. +
+Every fitting value should be used, however an alicorn (also known as alacorn, winged
+unicorn, acorn, pegasus unicorn, unipeg, unisus, horned pegasus, wing-horn, allacorn,
+cerapter pterippus, aquillacorn, pegasos aithiopikos alate unicorns, or pegacorn)
+should have the values alicorn andpony, but neither pegasus nor
+unicorn or another of the possible therms mentioned. Earth ponies should have
+the value pony and earth (not earth pony.)
+
The standard values are (you may use other ones if fitting): unicorn, pegasus,
+alicorn, earth, pony, changeling, crystal, seapony,
+animal (applies to Spike) and item (applies to Tom and Pinkamina’s imaginare friends.)
+
This tag decribes which groups a pony classifies under, it is a comma seperated lower case +list, and it cannot be empty, by it can be (but shouldn’t) skipped for every pony in the +image. +
+The standard values are (you may use other ones if fitting): +
mare
+Adult female pony
+stallion
+Adult male pony
+filly
+Female pony child
+colt
+Male pony child
+dragon
+Dragon (Spike and the other dragons)
+mane
+The mane characters (also known as main characters [unponified] or protagonists)
+wildlife
+Wildlife, for example timberwolfs
+pet
+A pony’s pet, Spike does not count because Twilight does not play with him during
+pony–pet play dates.
+royal
+Royal pony, either by birth, marriage, or conquer (i.e. the old school style).
+Shining Armour is royal by marriage, but is biological family does become royal by this.
+villain
+Villains, normally minions to antagonists or recurring ponies. Applies to changelings.
+antagonist (applies to: nightmare moon, gilda, discord, chrysalis)
+Antagonists are also known as archvillians or archenemies.
+Nightmare Moon, Discord and Chrysalis are such, but Gilda also counts as one.
+deuteragonist (applies to: the cutiemark cruisers)
+Deuteragonists are secondary characters, these are (as of series 2) only the Cutiemark
+Cruisers. The requirement is that thay are somewhat regular characters with dedicated
+episodes, but are not protagonists.
+tritagonist (applies to: celestia, luna, cadance, shining armor, spike)
+Important characters (excluding Derpy Hooves) that are neither protagonists,
+deuteragonists nor antagonists.
+background
+Background characters are not characters that are neither protagonists, deuteragonist,
+tritagonist, antagonist nor pets. They do not need to be strictly background characters,
+for example Big Mac and Cheerilee classifies under this group, as they are not too
+important to be considered tritagonists (as of series 2).
+voiced (only used together with background)
+Only background characters can be voiced. The additional requirement is
+that they have said something (ponies comics can also be voiced).
+imaginary
+Imaginary ponies (or other animal).
+For each balloon in the file (a pony file can have more than one balloon, but
+that is not common) their should one tag entry. There are four values that
+can be used: top (the common setup, the balloon is at the top of the image),
+bottom (the balloon is at the bottom of the image), right (the balloon
+is neither at the top or at the bottom of the image, but is placed to the right of
+the pony) and inside (the balloon is somewhere as inside the image.)
+
Files with only one pony should not use this tag. Specifies to which pony +the link is connected, it is a number, starting from 1. +
+If a file contains Fluttershy and Pinkie (in that order, i.e. Pinkie is to the +right of or below Fluttershy) and the link is connected to Pinkie, than the value +should be 2. +
+In the rare case that the file contains multiple links (and multi ponies), the +metadata should contains multiple entries of this tag, one entry for each link +sorted in the order of the linkes placement in the image, in the same way +ponies are ordered. +
+In the rare case that the file contains multiple links the metadata should contains +multiple entries of this tag, one entry for each link sorted in the order of the +linkes placement in the image, in the same way ponies are ordered. +
+The value for this tag must be either regular or mirrored. regular
+applies to linkes with NNE–SSW (\) direction. mirrored applies to linkes
+with NNW–SSE (/) direction, in version 2.9.1 only rainbowdrag uses this.
+
The name of the colour (as best estimated by you), in lowercase, that the pony’s coat +have. If the creature is (for example) a dragon, the colour of the scales is used. +Common colour names are preferable. Only one colour should be named, but the name may +describe a colour combination. +
+The name of the colour (as best estimated by you), in lowercase, that the pony’s mane +have. Common colour names are preferable. Only one colour should be named, but the name +may describe a colour combination. +
+The name of the colour (as best estimated by you), in lowercase, that the pony’s eyes
+have. Common colour names are preferable. Only one colour should be named, but the name
+may describe a colour combination. If the eyes are closed in the picture, use
+close in addition the the actual eye colour, separated by a comma.
+
The name of the colour (as best estimated by you), in lowercase, that the pony’s magic +aura have. Common colour names are preferable. Only one colour should be named, but the +name may describe a colour combination. +
+The magic aura is the colourisation around items that are affected by magic. +
+If the pony file have multiple ponies, some with magicial abilities and some without,
+the ponies without magicial abilies should use the value (no magic). If the pony
+has magicial abilies but without an aura, use the value (invisible).
+
Only humans [here we must call ourself humnas rather than ponies, otherwise the sentance +does not make sense) can se the magic aura, describe the colour that we humans see, not +ponies and other creatures in the TV Show [proof, see S01E11 Winter Wrap Up and S02E25-26 +A Canterlot Wedding]. +
+This tag describes how a pony is places in the image. The standard values are: full
+(full body), head (just the head), down (upside down), left (pony is
+looking to our left), right (pony is looking to our right), front (pony is
+looking at us). front can be combined with left and right, but
+left and right nor full and head cannot be combined.
+
The width of the pony image measured in text columns. +
+The height of the pony image measured in text lines, this include the balloon +(occupies one line) even if it the first line with nothing else on that line. +
+The number of lines at the beginning of the pony image that should be skipped +if the balloon is not printed. +
+The number of lines at the end of the pony image that should be skipped if the +balloon is not printed. +
+One word (preferably) to distinguish the pony files from other pony files with the +same MASTER. It is preferable that this is written in bare infinitive. +Master files should try to specify this tag but are not required +to, however, non-master files (slave files) are required to specify this tag. +This tag is important for the extras feature to function. +
+Either the name of a pony that the pony is based. If the original pony is not
+from MLP:FiM, the name a value that pony’s MEDIA tag can used inside brackets,
+for example (Tumblr), after the original pony’s name. If the pony is not
+based on any pony the value (original) can be used. If the ponies is
+based on multiple ponies, make a comma separated list.
+
This tag refers to the pony file that is not named with extra attributes. For example,
+all files where Shining Armor is the (sole) speaking pony the this tag should be
+shiningarmor, except for in shiningarmor.pony where this tag may be omitted.
+This tag is important for the ponyquotes feature to function.
+
This tag specifies from where the pony image (not the file itself) originates.
+If the source is unknown the value should be (unknown), if a GitHub user
+draw it the the value should be that user inside square brackets (in case of
+multiple artists, the tag is comma seperated list). Otherwise the source
+should be specified in any reasonable manner.
+
In order the claim authorship (the GitHub user value) it image must have been +written from scratch (using templates is okay) or must be a major edit of another +image. Just converting (including fixing the colours) an image (for example from +the Internet or a screenshot) with or without removing the background is not enough. +
+This tag must not be used for MLP:FiM ponies, but only for extraponies. +It specifies the media from where the pony (not the image) originates. +
+Which licence applies to the image? Full name and version should be used. +In case of multiple license there should be one entry for each license. +Omit this tag is the license is not known. +
+The are two special cases here where this is no license. In which case it
+either uses regular copyright, in which case use the value (regular),
+or everyone is the copyright holder (for example Public Domain), in which
+case use the value (public).
+
Is the image fully free? (For example Linux-libre is fully free, but not regular Linux.)
+The value must either be yes or no, or the tag must be omitted.
+
This is the most important tag as it helps us build a fully free version that can +be officially distributed on GNU endorsed GNU/Linux distributions (GNU/Linux-libre). +
Duplicate tags should be ordered in the order of the pony they describe from top-left +to bottom-right in the image. It is important that if there are for example three ponies +the image then all used tags that depends on the number of ponies in the image is used +three times. +
+ +‘Officiallity tag’ refers the an annotation added to a tag value’s list element.
+If the value is unofficial the string (unofficial) is appended (preferable with
+leading whitespace) to the element. If it is official the appended string is of the
+format (official, %c) (the brackets are verbatim), where %c is a
+comment. For example Chrysalis’ name has not been mentioned in the show, however it
+is used in the manuscript, therefore a pony file with Chrysalis should have the
+(partial) metadata:
+
NAME: (not mentioned) +OTHER NAMES: Chrysalis (official, in manuscript) +
+Next: The tool chest, Previous: Optional features, Up: Top [Contents][Index]
+-Next: Balloon style files, -Previous: Pony anatomy, -Up: Inner workings -
-When compiling, pony quotes are built to quotes/, the file names are lists +
When compiling, pony quotes are built to quotes/, the file names are lists
of ponies joined with plus signs (+) – the pony names are the same as the
-pony files, except they do not end with .pony – with a index at the end,
+pony files, except they do not end with .pony – with a index at the end,
and a full stop (.) before the index.
-
-
The source files are located in ponyquotes/, where their is a file named -ponies. This file is called the pony map, and is the basis for how the +
+The source files are located in ponyquotes/, where their is a file named
+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 (+), if the lines because too long
for file names the line is split into multiple lines with the first pony in common.
-
-
In ponyquotes/ there are also quote files, each contain just one quote, just -as when compiled to quotes/. The source quote files are identical to the +
+In ponyquotes/ there are also quote files, each contain just one quote, just +as when compiled to quotes/. The source quote files are identical to the compiled quote files, except that their name contains just the first pony. +
- + + + + diff --git a/pages/ponysay/Ponysay-contributors.html b/pages/ponysay/Ponysay-contributors.html index 8e2abaf0..a552a79c 100644 --- a/pages/ponysay/Ponysay-contributors.html +++ b/pages/ponysay/Ponysay-contributors.html @@ -1,71 +1,99 @@ - + + + + -+Next: Ponysay license, Previous: Change log, Up: Top [Contents][Index]
+Active developers and major contributors of ponysay: -
Patchers and other contributors of ponysay: +
+Next: GNU General Public License, Previous: Ponysay contributors, Up: Top [Contents][Index]
+Ponysay is release by Erkin Batu Altunbaş et al.
-Copyright © 2012 Erkin Batu Altunbaş et al.
+
Ponysay is release by Erkin Batu Altunbaş et al.
+Copyright © 2012, 2013 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. - -
You have the four essential freedoms: -
Ponysay is Free Software (and Open Source) and in licensed under the terms +of GNU General Public License version 3, or at your option, any later version. +
+You have the four essential freedoms: +
+
If you intend to redistribute ponysay or a fork of it commercially, it contains
+aggregated images, some of which may not be commercially redistribute, you would
+be required to remove those. To determine whether or not you may commercially
+redistribute an image make use that line FREE: yes, is included inside
+the image between two $$$ lines and the FREE is and upper case and
+directly followed by the colon.
+
+
|
+ ponysay is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +ponysay is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with ponysay, and attached to this document. +If not, see <http://www.gnu.org/licenses/>. + |
-DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE - Version 2, December 2004 +- |
-Next: Truncation, -Previous: Balloon style files, -Up: Inner workings -
-Since Linux VT (TTY) does not have capabilities for returning the position of the +
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
-the pony's colours is not lost, i.e. reduced to mare 16 colours, during print. The
-colours are reduced if the pony's position on the screen is changed. This is only
+the pony’s colours is not lost, i.e. reduced to mare 16 colours, during print. The
+colours are reduced if the pony’s position on the screen is changed. This is only
relevant with KMS support. The clear the screen we print “\e[H\e[2J”
(\e is ESC) in at beginning. “\e[H” places the cursor at the
beginning of the screen, and “\e[2J” clears everything on the screen after,
and including at, the cursor. If we would use “\ec” (that is a reset),
we would also turn off num. lock and caps. lock.
+
-Next: Dependencies, -Previous: Limitations, -Up: Top -
| • External bugs: | Known external bugs. + | |
| • Reporting bugs: | Reporting bugs and issues in ponysay. + | |
| • Requesting ponies: | Requesting inclusion of your favourite ponies. + |
-If you find a bug in ponysay, install the last version -from https://github.com/erkin/ponysay, and if it is still -present, please report it at https://github.com/erkin/ponysay/issues. -Please be as descriptive as possible, as it will help us verify it -solve it faster. - - - diff --git a/pages/ponysay/Providing-ponies.html b/pages/ponysay/Providing-ponies.html index c2a71924..003ceccf 100644 --- a/pages/ponysay/Providing-ponies.html +++ b/pages/ponysay/Providing-ponies.html @@ -1,127 +1,180 @@ - + + + +
--Most pony images are browser ponies or desktop ponies, browser ponies is a port of +
Most pony images are browser ponies or desktop ponies, browser ponies is a port of desktop ponies, implementing it in JavaScript. Browser ponies are available at https://github.com/panzi/Browser-Ponies. Desktop ponies are available at http://desktop-pony-team.deviantart.com/. - -
There is also a collection of ponies that are not yet pixelated in a Java +
+There is also a collection of ponies that are not yet pixelated in a Java reimplementation of the early Ponysay: https://github.com/maandree/unisay/tree/develop/dev/newponies - -
There is a checklist named pony-checklist at the dev/ directory. You -can use the check which ponies are added and which are not. Please update it when fit. +
+There is a checklist named pony-checklist at the 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 -at https://github.com/maandree/util-say. -Prior to version 2.1 of ponysay, img2xterm could be used, by since -version 2.1 ponysay is using a new format that only util-say supports. -img2xterm (https://github.com/rossy2401/img2xterm) was used in the +
+New ponies can be created from regular images by using util-say, which is available
+at https://github.com/maandree/util-say.
+Prior to version 2.1 of ponysay, img2xterm could be used, by since
+version 2.1 ponysay is using a new format that only util-say supports.
+img2xterm (https://github.com/rossy2401/img2xterm) was used in the
early stage, but util-say tries to optimise the images in some aspects: as good as
possible for low capability terminals, tries to place the pony–balloon link, displayed
as good as possible when marked in the terminal (somewhat compromised by the first
aspect,) and same width on all rows.
+
|
+
+
+
PONY_FILE should end with .pony and be localed in ponies/,
+or extraponies/ if the pony is not a MLP:FiM pony.
-
The following bash code will print the palette the ponies (the terminals)
+For more information is available in util-say's info manual. |
If you have util-say installed, which is required to build ponies, you can use PNG
+files as argument the for ponysay -f, this requires that the file is named
+.png at the end.
+
The following bash code will print the palette the ponies (the terminals)
use:
-
- c=16
- while ((c < 256)); do
- echo -en "\e[48;5;${c}m \e[49m"
- c=$(( $c + 1 ))
- if (( $(( c % 36 )) == 16 )); then
- echo
- fi
- done; echo
-
- |
|
+
+
+c=16
+while ((c < 256)); do
+ echo -en "\e[48;5;${c}m \e[49m"
+ c=$(( $c + 1 ))
+ if (( $(( c % 36 )) == 16 )); then
+ echo
+ fi
+done; echo
+ |
-For the palette to be correct, which is especially important when you draw ponies, you
+
+
For the palette to be correct, which is especially important when you draw ponies, you must not redefine the colours in the range 16 to 255 (inclusive). - -
When a pony is added please also add a ttypony version, i.e. the pony files used in -TTY, but if you don't please state so in the pull request so we do not miss the -create it; the simplest way to do this is to run dev/dist.sh ttyponies after -adding the ponies to ponies/, running dev/dist.sh ttyponies will build -(or rebuild) all ttyponies with a pony present in ponies/, and creates all +
+ +When a pony is added please also add a ttypony version, i.e. the pony files used in
+TTY, but if you don’t please state so in the pull request so we do not miss the
+create it; the simplest way to do this is to run dev/dist.sh ttyponies after
+adding the ponies to ponies/, running dev/dist.sh ttyponies will build
+(or rebuild) all ttyponies with a pony present in ponies/, and creates all
needed symlinks.
-
-
To be able to run dev/dist.sh ttyponies you must have the packages listed under +
+To be able to run dev/dist.sh ttyponies you must have the packages listed under
Dependencies for pony providers.
-
-
Also when adding new ponies, please map them up in the file ponyquotes/ponies. +
+ + +Also when adding new ponies, please map them up in the file ponyquotes/ponies.
If the pony is a new pony without any other alternative image just add it to a new
-line, without .pony, preferably in its alphabetical position. If the file is
+line, without .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 (+) without any white space. When a line is too
-long for a file name (this has happened to Pinkie Pie [pinkie],) it must be
+long for a file name (this has happened to Pinkie Pie [pinkie],) it must be
split into multiple lines, these lines should have their first pony file in common.
+
+Up: Contributing [Contents][Index]
++Next: Requesting ponies, Previous: External bugs, Up: Problems and requests [Contents][Index]
+If you find a bug in ponysay, install the last version
+from https://github.com/erkin/ponysay, and if it is still
+present, please report it at https://github.com/erkin/ponysay/issues.
+Please be as descriptive as possible, as it will help us verify it
+solve it faster.
+
+Previous: Reporting bugs, Up: Problems and requests [Contents][Index]
+If you want I specific pony added, ask us at +https://github.com/erkin/ponysay/issues and we will add it. +To speed the up the process, if possible, supply good pictures. Full visibly, +transparent background, and pixelated are the properties that makes a picture good. +
+ + + + + + + diff --git a/pages/ponysay/Requests.html b/pages/ponysay/Requests.html deleted file mode 100644 index 78aeb7e1..00000000 --- a/pages/ponysay/Requests.html +++ /dev/null @@ -1,55 +0,0 @@ - - --If you want I specific pony added, ask us at -https://github.com/erkin/ponysay/issues and we will add it. -To speed the up the process, if possible, supply good pictures. Full visibly, -transparent background, and pixelated are the properties that makes a picture good. - - - diff --git a/pages/ponysay/Required-runtime-dependencies.html b/pages/ponysay/Required-runtime-dependencies.html index 98455fbd..fcafa283 100644 --- a/pages/ponysay/Required-runtime-dependencies.html +++ b/pages/ponysay/Required-runtime-dependencies.html @@ -1,60 +1,92 @@ - + + + +
--Next: Optional runtime dependencies, -Up: Dependencies -
coreutilsstty is used to determine the size of the terminal.
+
python>=31ponysay is written in pure Python 3.
+
Sometimes distributed as python3 rather than python.
-Next: Running on screen, -Previous: Ponification, -Up: Advanced usage -
-If you use TTY and have a custom colour palette, you should also add to your
-~/.bashrc, before fortune | ponysay:
-
- [ "$TERM" = "linux" ] &&
- function ponysay
- { exec ponysay "$@"
- #RESET PALETTE HERE
- }
-
- |
If you use TTY and have a custom colour palette, you should also add to your
+~/.bashrc, before fortune | ponysay:
+
|
+
+
+[ "$TERM" = "linux" ] &&
+ function ponysay
+ { exec ponysay "$@"
+ #RESET PALETTE HERE
+ }
+ |
You should read more about this in KMS ponies. +
You should read more about this in KMS ponies. +
- + + + + diff --git a/pages/ponysay/Running-on-screen.html b/pages/ponysay/Running-on-screen.html index 99905590..a79a7ccc 100644 --- a/pages/ponysay/Running-on-screen.html +++ b/pages/ponysay/Running-on-screen.html @@ -1,68 +1,99 @@ - + + + + --Previous: Running on TTY, -Up: Advanced usage -
screen-screen will adapt ANSI colour escape sequences to your terminal's +
screen will adapt ANSI colour escape sequences to your terminal’s
capabilities. This means that if your terminal reports itself as xterm
-in $TERM ponies will lose their colours; they will only use the lower 16
+in $TERM ponies will lose their colours; they will only use the lower 16
colours instead of the top 240 colours. By default, almost all X terminals,
-including xterm and mate-terminal reports themselves as
-xterm in $TERM, and some reports their actual name in $COLORTERM.
-So before opening screen you use set $TERM to xterm-256color,
-if you are using a terminal with support for xterm's 256 colours; this
-can be done by adding to your ~/.bashrc:
-
- [ "$TERM" = "xterm" ] &&
- function screen
- { export TERM="xterm-256color"
- exec screen "$@"
- }
-
- |
xterm and mate-terminal reports themselves as
+xterm in $TERM, and some reports their actual name in $COLORTERM.
+So before opening screen you use set $TERM to xterm-256color,
+if you are using a terminal with support for xterm’s 256 colours; this
+can be done by adding to your ~/.bashrc:
+|
+
+
+[ "$TERM" = "xterm" ] &&
+ function screen
+ { export TERM="xterm-256color"
+ exec screen "$@"
+ }
+ |
-Next: Universal Character Set, -Previous: Languages, -Up: Inner workings -
-To make it easier to write auto-completion for shells, ponysay supports -the two options --onelist, ++onelist and --quoters, -which has no short versions. - -
Executing ponysay --onelist will list every available standard (MLP:FiM) +
To make it easier to write auto-completion for shells, ponysay supports
+the options --onelist, ++onelist, --Onelist and
+--quoters, which has no short versions. To make it even easier we use
+auto-auto-complete (https://www.github.com/maandree/auto-auto-complete)
+to generate auto-completion scripts, currently it supports bash,
+fish and zsh, the built system uses that program to generate
+completion for each shell.
+
Executing ponysay --onelist will list every available standard (MLP:FiM)
pony, independent of where it is located, the output is a sorted and consists only
of one pony per line.
-
-
Executing ponysay ++onelist will list every available extra (non-MLP:FiM) +
+Executing ponysay ++onelist will list every available extra (non-MLP:FiM)
pony, independent of where it is located, the output is a sorted and consists only
of one pony per line.
-
-
ponysay --quoters work just as ponysay --onelist, excepts +
+Executing ponysay --Onelist will list every available standard pony as
+well as extra pony, independent of where it is located, the output is a sorted and
+consists only of one pony per line.
+
ponysay --quoters work just as ponysay --onelist, excepts
it limits the ponies to those that have quotes. Ponies that have quotes,
but does not exist, i.e. does not have a .pony-file, are not listed.
+
Auto-completion scripts should not suggest these options. +
-Auto-completion scripts should not suggest these options. - + + + diff --git a/pages/ponysay/Source-Mage-GNU_002fLinux.html b/pages/ponysay/Source-Mage-GNU_002fLinux.html index fa201406..68af4b63 100644 --- a/pages/ponysay/Source-Mage-GNU_002fLinux.html +++ b/pages/ponysay/Source-Mage-GNU_002fLinux.html @@ -1,54 +1,81 @@ - + + + +
--Previous: Gentoo Linux, -Up: Package repositories -
-The spell util/ponysay (user maintained) is available in Grimoire for
+
The spell util/ponysay (user maintained) is available in Grimoire for
Source Mage GNU/Linux.
+
-Ponysay works perfectly on xterm, xterm like terminals including -putty, settings may however need to be customised for Unicode Character Set + + +
Ponysay works perfectly on xterm, xterm like terminals including
+putty, settings may however need to be customised for Unicode Character Set
(UCS) support, but less well, depending on font, on VTE based terminals including
-mate-terminal.
-
-
On Linux's native terminal Linux VT (TTY) it works less well, and not good at all
+mate-terminal.
+
On Linux’s native terminal Linux VT (TTY) it works less well, and not good at all
without Kernel Mode Setting (KMS) support. See https://github.com/erkin/ponysay/issues/1
-for more information. ponysay clears the screen before printing to TTY, this
+for more information. 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
the height in TTY by default.
-
-
Most terminals have support for 256 colours, we do however only use the top 240 +
+Most terminals have support for 256 colours, we do however only use the top 240 colours; this is because the lower 16 colours are usually, in contrast to the top 240, customised. We assume that the top 240 colours have their standard values. In TTY with -KMS support we dot have any actual limit (except for 2^24 + full +KMS support we dot have any actual limit (except for 2^{24} + full transparency.) - -
ponysay works perfectly on xterm, urxvt and -putty, but rxvt, mrxvt and Eterm do not have -UTF-8 support and are currently not supported. Additionally aterm have +
+ + + + + + + +ponysay works perfectly on xterm, urxvt and
+putty, but rxvt, mrxvt and Eterm do not have
+UTF-8 support and are currently not supported. Additionally aterm have
neither UTF-8 support nor 256 colour support, and is therefore not yet supported.
-
-
Due to extreme limitations in 9term ponysay will never be able to +
+ +Due to extreme limitations in 9term ponysay will never be able to
run on it.
+
-Next: Change log, -Previous: Distributing, -Up: Top -
The television show My Little Pony: Friendship is Magic. +
+The successor to My Pretty Pony, the toy not the short story by Stephen King. +
+Linux’s native terminal emulator. The name TTY comes from the file names for the +devices used for terminals by Linux VT, which is /dev/tty*. +
+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. +
+Pony files used in TTY. +
+Pony files generated for use in TTY with custom TTY colour palette and KMS support. +
+Pony files of ponies that are not a part of MLP:FiM. +
Pony files of ponies that are a part of MLP:FiM. +
Pony files located in /usr/share/ponysay. +
+Pony files located in ${XDG_DATA_HOME}/ponysay or ~/.local/share/ponysay (fallback). +
+A JavaScript program which is the source for most of our ponies. It is a port of
desktop ponies.
-
-
The process of converting English text to 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
+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.
-
-
The pony you think is [the] best pony. It should be a symlink pony. It is a feature +affecting the -f, +f, -F and -q options. +
+A pony file that is a symbolic link to another pony file. Symbolic links can be
+created with the command ln -s TARGET SYMLINK.
+
A feature enabling ponies to quote them self from MLP:FiM. +
+Variables stored to the environment with the command export VARIABLE=VALUE.
The variable name is often written with the prefix $ due to have they are read
-in shell, using the command echo $VARIABLE.
-
-
echo $VARIABLE.
+
+The set of of character, develop by the Unicode Consortium. It defined a partially filled +space of 2^{31} characters, some of which are not glyphs. +
+Character that have zero width and is used to compose characters with diacritical when
there is no precomposed character to use.
-
-
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 a-z.
-
-
-) or exactly one
+
+Command line arguments starting with either exactly one hyphen (-) or exactly one
plus sign (+), and have exactly one character beyond that. They may be argumentless,
argumented, optionally argumented, or variadic (consumes all following arguments).
-
-
-) or at least two
+
+Command line arguments starting with either at least two hyphens (-) or at least two
plus signs (+), beyond that they have at least one character, but often at least one
work. They by be argumentless, argumented, optionally argumented, or variadic (consumes all
following arguments).
-
-
Provided by a shell dependent script, argument suggestion is provided of then by pressing
the tab key.
-
-
Character sequences starting with a ESC character, with a special interpretation for terminals
standardise by ANSI.
-
-
ANSI escape sequences defining a colour or other formatting, known as CSI m, a sequence starting
with CSI and ending with an m. This is extended to 256 colours, from 16 colours, by
-xterm which is de facto standardise.
-
-
[, used in standardised ANSI escape sequences.
-
- ], used in non-standardised ANSI escape
-sequences.
+xterm which is de facto standardise.
+
+The character combination ESC followed by [, used in standardised ANSI escape sequences.
+
The character combination ESC followed by ], used in non-standardised ANSI escape
+sequences.
+
+Next: Change log, Previous: Distributing, Up: Top [Contents][Index]
++Next: Limitations, Previous: Pony metadata, Up: Top [Contents][Index]
+The tool chest is a collection of subcommands under the command ponysay-tool,
+its purpose is to provide tools to ponysay relevant actions that is not printing ponies
+(like the commands ponysay and ponythink).
+
| • Fill KMS cache: | Pre-generate kmsponies to your cache. + | |
| • Metadata pasting: | Copy, remove, stash and apply stashed pony metadata. + | |
| • Editing metadata: | Editing the metadata in a pony file. + | |
| • Metadata collections: | Generate pony metadata collection files. + | |
| • Dimension files: | Generate pony dimension files. + | |
| • Pony browsing: | Browse ponies or find a pony based on metadata. + |
-Next: Languages, -Previous: Printing in TTY with KMS, -Up: Inner workings -
-Ponysay supports three type of output truncations, cutting away overflow on the right +
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 Setting (KMS) support to +
+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 head (keeps -the top) or by piping to tail (keeps the bottom.) head and -tail takes as argument the number of lines to keep at most. - -
The size of the terminal, measured in characters, is fetched from stty size,
-which returns HEIGHT WIDTH, and cut it the used to get either the
-height or the width. This requires only GNU Coreutils; earlier tput rows and
-tput cols were used, this however required, the only de facto standard,
-package ncurses, some shells have environment variables for this.
-
-
Since version 2.1 truncation is done internally in the Python script, before that it
-was done in a custom C program truncater, that was installed to
-/usr/lib/ponysay/truncater. It recognised UTF-8 ANSI escape sequences,
+print. Prior to version 2.0 this was done either by piping to head (keeps
+the top) or by piping to tail (keeps the bottom.) head and
+tail takes as argument the number of lines to keep at most.
+
The size of the terminal, measured in characters, is fetched from stty size,
+which returns HEIGHT WIDTH, and cut it the used to get either the
+height or the width. This requires only GNU Coreutils; earlier tput rows and
+tput cols were used, this however required, the only de facto standard,
+package ncurses, some shells have environment variables for this.
+
Since version 2.1 truncation is done internally in the Python script, before that it
+was done in a custom C program truncater, that was installed to
+/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
@@ -79,6 +104,15 @@ visible. This now fixed internally in Python, but has also been improved to excl
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.
+
+Next: Languages, Previous: Printing in TTY with KMS, Up: Inner workings [Contents][Index]
+-Previous: Package repositories, -Up: Installing -
-If you did not install ponysay with a package manager, but rather -manually from the upstream, you can uninstall it by running make uninstall. - -
Well written package manages will uninstall files that the package is no longer +
If you did not install ponysay with a package manager, but rather
+manually from the upstream, you can uninstall it by running make uninstall.
+
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 Makefile.
-To perform an uninstallation of old files run make uninstall-old.
+used, by the currently installed version you will need that versions Makefile.
+To perform an uninstallation of old files run make uninstall-old.
+
-Previous: Shell auto-completion, -Up: Inner workings -
-In earlier versions of ponysay only the output truncation supported +
In earlier versions of ponysay only the output truncation supported
Universal Character Set, though handcoded UTF-8 character counting. Now
-ponysay lets Python decode the data, Python store all 31 bits of a
+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 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 therefore have a class in the code named UCS
that help us take them into consideration when determine the length of a string.
-
-
Some ponies have names that contain non-ASCII characters, read about it in -Environment variables. The UCS names are stored in the file share/ucsmap, +
+Some ponies have names that contain non-ASCII characters, read about it in
+Environment variables. The UCS names are stored in the file share/ucsmap,
in it lines that are not empty and does not start with a hash (#) are
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.
+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.
+
It is important that the UCS names are stored in a file and not in file names, +because it can cause problems on some platforms. +
- + + + + + diff --git a/pages/ponysay/Variable-and-option-index.html b/pages/ponysay/Variable-and-option-index.html index 24165a4a..c6a721b8 100644 --- a/pages/ponysay/Variable-and-option-index.html +++ b/pages/ponysay/Variable-and-option-index.html @@ -1,291 +1,521 @@ - + + + + --Previous: Concept and program index, -Up: Top +Previous: Concept and program index, Up: Top [Contents][Index]
+| Jump to: | +
+
+-
+
+ +A + +B + +C + +D + +E + +F + +G + +H + +K + +L + +M + +N + +O + +P + +S + +W + + |
|---|
| Jump to: | +
+
+-
+
+ +A + +B + +C + +D + +E + +F + +G + +H + +K + +L + +M + +N + +O + +P + +S + +W + + |
|---|
+Previous: Concept and program index, Up: Top [Contents][Index]
+Next: Narcissistic ponies, Previous: Running on screen, Up: Advanced usage [Contents][Index]
+If you have the file ~/.ponysayrc (.ponysayrc in your home directory,
+the home directory can be spoofed by changing the system environment HOME,)
+the first thing ponysay does is running that file. This can be used for
+modifing environment variables (see Environment variables). For your convience
+this can be done by modifing the map env. The code in ~/.ponysayrc must
+be written in Python 3.
+
For example if you want to set the PONYSAY_SHELL_LINES to 5, but only 1 if you
+are using Linux VT (TTY), your ~/.ponysayrc may look like this:
+
|
+
+
+if env[TERM] == 'linux': + env[PONYSAY_SHELL_LINES] = 1 +else: + env[PONYSAY_SHELL_LINES] = 5 + |
You can examine the source code of ponysay to figure out some nice hacking
+you may want to do, everything in the source code can be used directly as long as it
+is defined before ~/.ponysayrc is interpreted.
+
~/.ponysayrc is a fallback for ~/.config/ponysay/ponysayrc, which in +turn is a fallback for ${XDG_CONFIG_HOME}/ponysay/ponysayrc. If neither of +those exist, /etc/ponysayrc is used if that exists. +
+ + + + + + diff --git a/pages/ponysay/index.html b/pages/ponysay/index.html index 66bab9fe..b33c3bf6 100644 --- a/pages/ponysay/index.html +++ b/pages/ponysay/index.html @@ -1,172 +1,251 @@ - - -This manual is for ponysay -(version 2.9.1), - -
Copyright © 2012 Mattias Andrée - -
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled -“GNU Free Documentation License”. -+"GNU Free Documentation License". --> + + +
This manual is for ponysay +(version 3.0.1). +
+Copyright © 2012, 2013 Mattias Andrée +
+++ + + + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts, and with no Back-Cover +Texts. A copy of the license is included in the section entitled +“GNU Free Documentation License”. +
ponysayponysay.
+