+The official Arch Linux package repositories contains ponysay as
+community/ponysay. The Arch Linux User Repository (AUR) contains a
+bleeding edge git version of ponysay as ponysay-git.
+
+
+
diff --git a/ponysay/Balloon-style-files.html b/ponysay/Balloon-style-files.html
new file mode 100644
index 00000000..93895ea0
--- /dev/null
+++ b/ponysay/Balloon-style-files.html
@@ -0,0 +1,96 @@
+
+
+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: +
\.
+/.
+
+Chakra users can install from (CCR) a stable version named a ponysay,
+additionally a git verion of ponysay is available as ponysay-git.
+
+
+
diff --git a/ponysay/Change-log.html b/ponysay/Change-log.html
new file mode 100644
index 00000000..4eaef82c
--- /dev/null
+++ b/ponysay/Change-log.html
@@ -0,0 +1,452 @@
+
+
Nothing worth mentioning. + +
Note: Identifies itself as version 2.3 + +
Nothing worth mentioning. + +
Note: Identifies itself as version 1.3 + +
Note: Identifies itself as version 1.1 + +
Note: Identifies itself as version 0.7 + +
Note: Identifies itself as version 0.5 + +
First release. + +
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+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 +(in UTF-8), therefore non-ASCII words will malformat the balloon with the message. + +
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 +balloon look different, maybe using box drawing characters. + +
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. + + + diff --git a/ponysay/Custom-installations.html b/ponysay/Custom-installations.html new file mode 100644 index 00000000..9d188af1 --- /dev/null +++ b/ponysay/Custom-installations.html @@ -0,0 +1,183 @@ + +
++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 +an argument, if no argument is provided a default argument is implied. + +
The configuration script recognised the following options, the default values for
+options with arguments are written after the equality sign (=) in the option:
+
+
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.
+Recognised compressions are gz which uses gzip -9, and xz +which uses xz -9e. xz is still exotic to bost programs, use using +it is not recommended. Distributors are strongly disencouraged to compression for the +PDF manual and should use --without-pdf-compression. + +
You can run ./configure [OPTIONS] view to make sure everything is correct +before building and installing. + + + diff --git a/ponysay/Debian-GNU_002fLinux.html b/ponysay/Debian-GNU_002fLinux.html new file mode 100644 index 00000000..fd35e68a --- /dev/null +++ b/ponysay/Debian-GNU_002fLinux.html @@ -0,0 +1,55 @@ + +
++A .deb file is available at http://roryholland.co.uk/misc.html#ponysay, +and PPA:s can be found at https://launchpad.net/~vincent-c/+archive/ppa and +https://launchpad.net/~blazemore/+archive/ponysay. + + + diff --git a/ponysay/Dependencies-for-pony-providers.html b/ponysay/Dependencies-for-pony-providers.html new file mode 100644 index 00000000..896bc2af --- /dev/null +++ b/ponysay/Dependencies-for-pony-providers.html @@ -0,0 +1,58 @@ + +
++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/ponysay/Distributing.html b/ponysay/Distributing.html new file mode 100644 index 00000000..89ba17b0 --- /dev/null +++ b/ponysay/Distributing.html @@ -0,0 +1,95 @@ + + ++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 +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 +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.
+It is not complete, proper, verbose enough or well written, it just contains the
+core of an stable git distribution.
+
+
+ pkgname=ponysay
+ pkgver=2.5
+ pkgrel=1
+ arch=(any)
+ pkgdesc="Cowsay reimplementation for ponies"
+ url="https://github.com/erkin/ponysay"
+ license=(WTFPL "GNU FDL v1.3")
+ depends=(python>=3 coreutils)
+ optdepends=("util-say>=2: Improved TTY support with KMS and PNG files")
+ makedepends=(git texinfo info gzip python>=3)
+
+ build()
+ { cd "$srcdir"; git clone git://github.com/erkin/ponysay.git ponysay
+ cd ponysay ; git checkout "$pkgver"
+
+ ./setup.py --everything --without-pdf-compression \
+ --bin-dir=/usr/bin --dest-dir="$pkgdir" build
+ }
+
+ package()
+ { cd "$srcdir/ponysay"; ./setup.py prebuilt
+ }
+
+ |
+ponysay supports the follow environment variables: + +
yes, y or 1.
+
+ yes, y
+or 1, if you do not want the output to be truncated on the width to
+fit the terminal.
+
+ 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,
+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,
+h or 2 instead.
+
+ 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.
+
+
See KMS ponies for information on how to use this. +
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. + + + diff --git a/ponysay/Fortune-cookies.html b/ponysay/Fortune-cookies.html new file mode 100644 index 00000000..e5b7cece --- /dev/null +++ b/ponysay/Fortune-cookies.html @@ -0,0 +1,61 @@ + +
+
+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
+(standard shell for most distributions now a days) – you will get the effect
+described in the previous paragraph every time you open a terminal.
+
+
+
diff --git a/ponysay/From-upstream.html b/ponysay/From-upstream.html
new file mode 100644
index 00000000..bb6b2b66
--- /dev/null
+++ b/ponysay/From-upstream.html
@@ -0,0 +1,56 @@
+
+
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 +assure everyone the effective freedom to copy and redistribute it, +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 +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 +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 +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 +work under the conditions stated herein. The “Document”, below, +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 +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 +of the Document that deals exclusively with the relationship of the +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 +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 +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, +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, +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 +pixels) generic paint programs or (for drawings) some widely available +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. +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 +ASCII without markup, Texinfo input format, LaTeX input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +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, +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, +preceding the beginning of the body of the text. + +
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 +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 +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 +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 +conditions whatsoever to those of this License. You may not use +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 publicly display copies. + +
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 +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. +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 +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 +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. +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 +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 +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 +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. +These titles must be distinct from any other section titles. + +
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 +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 +through arrangements made by) any one entity. If the Document already +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 +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 +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 +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. +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 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 +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 +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 +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. +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 +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 +covers that bracket the Document within the aggregate, or the +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. +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 +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +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”, +“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 +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 +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, 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 +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. +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 +of any later version that has been published (not as a draft) by the +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 +version permanently authorizes you to choose that version for the +Document. + +
“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 +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 +in part, as part of another Document. + +
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 +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''. ++
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. ++
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 +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. + + + + + + diff --git a/ponysay/Gentoo-Linux.html b/ponysay/Gentoo-Linux.html new file mode 100644 index 00000000..43cd1bce --- /dev/null +++ b/ponysay/Gentoo-Linux.html @@ -0,0 +1,55 @@ + +
+
+Gentoo users can use the overlay https://github.com/etu/aidstu-overlay, which
+contains ponysay as games-misc/ponysay.
+
+
+
diff --git a/ponysay/Inner-workings.html b/ponysay/Inner-workings.html
new file mode 100644
index 00000000..6839f9e8
--- /dev/null
+++ b/ponysay/Inner-workings.html
@@ -0,0 +1,63 @@
+
+
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 +for bleeding edge, or from https://github.com/erkin/ponysay/tags for releases. + +
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 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 ./configure. + + + diff --git a/ponysay/Installing.html b/ponysay/Installing.html new file mode 100644 index 00000000..3b2b6a6e --- /dev/null +++ b/ponysay/Installing.html @@ -0,0 +1,58 @@ + +
++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 +the same thing. + +
ponysay supports the following options: + +
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
+supersedes file names.
+
+
The argument can be a file name, but only if it ends with .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 quote from any pony with a quote.
+
+
1;31 will make it in red and bold (or bright
+depending on the terminal.)
+
+ 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
+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
+cat | ponysay.
+
+
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. + + + diff --git a/ponysay/KMS-ponies.html b/ponysay/KMS-ponies.html new file mode 100644 index 00000000..76b32e83 --- /dev/null +++ b/ponysay/KMS-ponies.html @@ -0,0 +1,81 @@ + +
++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 +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 +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 +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 "$@"
+ }
+
+ |
KMS ponies uses /var/cache/ponysay/ or, if missing, ~/.cache/ponysay/ +for cache space. + + + diff --git a/ponysay/Languages.html b/ponysay/Languages.html new file mode 100644 index 00000000..6d9ae3cb --- /dev/null +++ b/ponysay/Languages.html @@ -0,0 +1,62 @@ + +
++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 +use Python 3, which as been accomplished in version 2.1. + + + diff --git a/ponysay/Limitations.html b/ponysay/Limitations.html new file mode 100644 index 00000000..27bb09f2 --- /dev/null +++ b/ponysay/Limitations.html @@ -0,0 +1,57 @@ + +
++Next: Package building dependencies, +Previous: Required runtime dependencies, +Up: Dependencies +
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. +
+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 +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 +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 +way over e-mail. + + + diff --git a/ponysay/Package-building-dependencies.html b/ponysay/Package-building-dependencies.html new file mode 100644 index 00000000..f6cdf102 --- /dev/null +++ b/ponysay/Package-building-dependencies.html @@ -0,0 +1,69 @@ + +
++Next: Dependencies for pony providers, +Previous: Optional runtime dependencies, +Up: Dependencies +
[1] Sometimes distributed as python3 rather than python.
+ +[2] Normally a part of texinfo.
+ +
+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.
+
+
+
diff --git a/ponysay/Pony-anatomy.html b/ponysay/Pony-anatomy.html
new file mode 100644
index 00000000..86a35a80
--- /dev/null
+++ b/ponysay/Pony-anatomy.html
@@ -0,0 +1,78 @@
+
+
+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
+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), $\$
+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
+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
+are partial Perl-scripts that assign a value to a scalar variable named
+$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
+files.
+
+
+
diff --git a/ponysay/Pony-quote-infrastructure.html b/ponysay/Pony-quote-infrastructure.html
new file mode 100644
index 00000000..fd5c3069
--- /dev/null
+++ b/ponysay/Pony-quote-infrastructure.html
@@ -0,0 +1,67 @@
+
+
+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,
+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
+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 +compiled quote files, except that their name contains just the first pony. + + + diff --git a/ponysay/Ponysay-contributors.html b/ponysay/Ponysay-contributors.html new file mode 100644 index 00000000..7e7d67a6 --- /dev/null +++ b/ponysay/Ponysay-contributors.html @@ -0,0 +1,71 @@ + +
+Active developers and major contributors of ponysay: +
Ponysay is release by Erkin Batu Altunbaş et al.
+Copyright © 2012 Erkin Batu Altunbaş et al.
+
+
+
+
Ponysay is Free Software (yet not Open Source) and in licensed under the terms +of Do What The Fuck You Want To Public License (WTFPL) version 2. + +
You have the four essential freedoms: +
+
+
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + Version 2, December 2004 + +Copyright © 2004 Sam Hocevar <sam@hocevar.net> + +Everyone is permitted to copy and distribute verbatim or modified +copies of this license document, and changing it is allowed as long +as the name is changed. + + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. You just DO WHAT THE FUCK YOU WANT TO. ++ |
+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
+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.
+
+
+
diff --git a/ponysay/Problems-and-requests.html b/ponysay/Problems-and-requests.html
new file mode 100644
index 00000000..20f0688e
--- /dev/null
+++ b/ponysay/Problems-and-requests.html
@@ -0,0 +1,55 @@
+
+
+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/ponysay/Providing-ponies.html b/ponysay/Providing-ponies.html new file mode 100644 index 00000000..0e165335 --- /dev/null +++ b/ponysay/Providing-ponies.html @@ -0,0 +1,127 @@ + +
++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 +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.
+
+
+
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. + +
++ |
+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
+
+ |
+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 +needed symlinks. + +
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.
+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
+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
+split into multiple lines, these lines should have their first pony file in common.
+
+
+
diff --git a/ponysay/Requests.html b/ponysay/Requests.html
new file mode 100644
index 00000000..f1a611aa
--- /dev/null
+++ b/ponysay/Requests.html
@@ -0,0 +1,55 @@
+
+
+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/ponysay/Required-runtime-dependencies.html b/ponysay/Required-runtime-dependencies.html new file mode 100644 index 00000000..7431a463 --- /dev/null +++ b/ponysay/Required-runtime-dependencies.html @@ -0,0 +1,60 @@ + +
+
+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. + + + diff --git a/ponysay/Running-on-screen.html b/ponysay/Running-on-screen.html new file mode 100644 index 00000000..f346dcef --- /dev/null +++ b/ponysay/Running-on-screen.html @@ -0,0 +1,68 @@ + +
+
+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
+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 "$@"
+ }
+
+ |
+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) +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) +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. + + + diff --git a/ponysay/Terminals.html b/ponysay/Terminals.html new file mode 100644 index 00000000..2d4d608b --- /dev/null +++ b/ponysay/Terminals.html @@ -0,0 +1,76 @@ + +
++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 +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 +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 +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 +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 +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 +run on it. + + + diff --git a/ponysay/Terminology.html b/ponysay/Terminology.html new file mode 100644 index 00000000..0259832d --- /dev/null +++ b/ponysay/Terminology.html @@ -0,0 +1,131 @@ + +
+$ due to have they are read
+in shell, using the command echo $VARIABLE.
+
+ a-z.
+
+ -) 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
+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).
+
+ 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.
++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 +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,
+including OSI P and CSI m, which is essential for the truncation to be correct. It
+also expands tabs to every eighth column and resets the background colour when needed,
+and writes ANSI escape sequences that are on the left side of the truncation. The
+truncater stops CSI sequences on the first ASCII letter ([a-zA-Z]), but also
+stops escape sequences after the first character after the initial escape if it is
+not either [ (CSI) or ] (OSI). In the previous, C, program it supported
+UTF-8 by assuming that bytes do not match 10xxxxxx and only those bytes were
+visible. This now fixed internally in Python, but has also been improved to exclude
+combining characters from the set of visible characters. Another difference is that
+the background colours are not reset, instead ANSI colours after the truncation point
+are still printed.
+
+
+
diff --git a/ponysay/Uninstalling.html b/ponysay/Uninstalling.html
new file mode 100644
index 00000000..be53ebab
--- /dev/null
+++ b/ponysay/Uninstalling.html
@@ -0,0 +1,58 @@
+
+
+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. + + + diff --git a/ponysay/Universal-Character-Set.html b/ponysay/Universal-Character-Set.html new file mode 100644 index 00000000..df29a259 --- /dev/null +++ b/ponysay/Universal-Character-Set.html @@ -0,0 +1,67 @@ + +
+
+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
+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,
+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.
+The two names are separated by and simple left to right arrow character [U+2192],
+optionally with surrounding white space.
+
+
+
diff --git a/ponysay/Variable-and-option-index.html b/ponysay/Variable-and-option-index.html
new file mode 100644
index 00000000..811f2feb
--- /dev/null
+++ b/ponysay/Variable-and-option-index.html
@@ -0,0 +1,291 @@
+
+
This manual is for ponysay +(version 2.9), + +
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”. ++ +