diff --git a/LICENSE b/LICENSE
index 4c9329c..9cecc1d 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,21 +1,674 @@
-The MIT License (MIT)
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
-Copyright (c) 2016 Ray Lee
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+ Preamble
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
\ No newline at end of file
+ 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.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "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.
+
+ 1. Source Code.
+
+ 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.
+
+ 2. Basic Permissions.
+
+ 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.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ 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.
+
+ 4. Conveying Verbatim Copies.
+
+ 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.
+
+ 5. Conveying Modified Source Versions.
+
+ 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) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ 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.
+
+ 6. Conveying Non-Source Forms.
+
+ 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) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ 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.
+
+ 7. Additional Terms.
+
+ "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:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ 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.
+
+ 8. Termination.
+
+ 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.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ 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.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ 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.
+
+ 11. Patents.
+
+ 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.
+
+ 12. No Surrender of Others' Freedom.
+
+ 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.
+
+ 13. Use with the GNU Affero General Public License.
+
+ 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.
+
+ 14. Revised Versions of this License.
+
+ 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.
+
+ 15. Disclaimer of Warranty.
+
+ 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.
+
+ 16. Limitation of Liability.
+
+ 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.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ 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.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ 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 .
+
+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:
+
+ {project} Copyright (C) {year} {fullname}
+ 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
+.
+
+ 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
+.
diff --git a/README.md b/README.md
index b895a91..618a898 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,52 @@
-A fully-functional [bash](https://en.wikipedia.org/wiki/Bash_%28Unix_shell%29) client for [tldr](https://github.com/rprieto/tldr/). This version aims to be the easiest and smallest to set up on a new account, without sacrificing any features.
+# tldr-bash
-![tldr screenshot](Screenshot.png?raw=true)
+**A fully-functional [bash](https://tiswww.case.edu/php/chet/bash/bashtop.html)
+client for the [tldr](https://github.com/rprieto/tldr/) project, providing
+poignant examples of terminal commands.**
-# Setup
+![tldr screenshot list](tldr-list.png?raw=true)
- mkdir -p ~/bin
- curl -o ~/bin/tldr https://raw.githubusercontent.com/raylee/tldr/master/tldr
- chmod +x ~/bin/tldr
+![tldr screenshot page](tldr-page.png?raw=true)
-Then make sure `~/bin` is in your `$PATH`. On OSX edit ~/.bash_profile (or ~/.bashrc on Linux), and add the following line to the bottom of the file:
+## Installation
+Download the tldr bash script to the install location:
- export PATH=~/bin:$PATH
+```bash
+location=/usr/local/bin/tldr # elevated privileges needed for some locations
+sudo wget -qO $location https://raw.githubusercontent.com/pepa65/tldr/master/tldr
+sudo chmod +x $location
+```
-# Prerequisites
+If the location is not in $PATH, you need to specify the path to run it.
-`curl` needs to be available somewhere in your `$PATH`. The script is otherwise self-contained.
+### Prerequisites
+coreutils, ncurses(tput), less, grep, unzip, curl / wget
-# Usage
- tldr [options] command
+![tldr screenshot usage](tldr-usage.png?raw=true)
- [options]
- -l, --list: show all available pages
- -p, --platform: show page from specific platform rather than autodetecting
- -u, --update: update, force retrieving latest copies of index and
- -h, -?, --help: this help overview
+## Customisation
+The colors and other styling of the 5 elements of tldr pages can be modified
+either by editing the first few lines of the scipt, or by setting the following
+environment variables:
+* TLDR_TITLE_STYLE (defaults to Newline,Space,Bold,Yellow)
+* TLDR_DESCRIPTION_STYLE (defaults to Space,Yellow)
+* TLDR_EXAMPLE_STYLE (defaults to Newline,Bold,Green)
+* TLDR_CODE_STYLE (defaults to Space,Bold,Blue)
+* TLDR_VALUE_STYLE (defaults to Bold,Cyan)
- command
- Show examples for this command
+Also the error color and page expiry can easily be set:
+* TLDR_ERROR_COLOR (defaults to Red)
+* TLDR_EXPIRY (defaults to 60)
-The client caches a copy of all pages and the index locally under
-~/.config/tldr. By default, the cached copies will expire in 14 days.
+![tldr screenshot customize](tldr-customize.png?raw=true)
-# Contributing
+## Contributing
-This is the result of a Sunday afternoon project. It's been lightly tested under Mac OS X 10.9 and Ubuntu Linux 15.10. I've tried to make the project as portable as possible, but if there's something I missed I'd love your help.
+Please file an issue for a question, a bug or a feature request.
+Or even better, send a pull request!
-* Want a new feature? Feel free to file an issue for a feature request.
-* Find a bug? Open an issue please, or even better send me a pull request.
+![tldr screenshot markdown](tldr-markdown.png?raw=true)
-Contributions are always welcome at any time!
+### License
+
+Relicensed under GPL v3+
diff --git a/Screenshot.png b/Screenshot.png
deleted file mode 100644
index c9c9869..0000000
Binary files a/Screenshot.png and /dev/null differ
diff --git a/tldr b/tldr
index 2b294c0..9a79164 100755
--- a/tldr
+++ b/tldr
@@ -1,246 +1,336 @@
#!/bin/bash
-# tldr client by Ray Lee, http://github.com/raylee/tldr
-# a Sunday afternoon's project, I'm sure there's room for improvement. PRs welcome!
+set +x -o pipefail
+[[ $- == *i* ]] && echo "Don't source this script!" && return 1
+# Bash tldr client
+# forked from Ray Lee, http://github.com/raylee/tldr
+# modified and expanded by pepa65: http://github.com/pepa65/tldr
+# Requiring: coreutils, ncurses(tput), less, grep, unzip, curl/wget
-set -uf -o pipefail
+# The 5 elements in TLDR markup that can be styled with these colors and
+# backgrounds (last one specified will be used) and modes (more can apply):
+# Colors: Black, Red, Green, Yellow, Blue, Magenta, Cyan, White
+# BG: BlackBG, RedBG, GreenBG, YellowBG, BlueBG, MagentaBG, CyanBG, WhiteBG
+# Modes: Bold, Underline, Italic, Inverse
+# 'Newline' can be added to the Style list to add a newline before the element
+# and 'Space' to add a space at the start of the line (not for Value element)
+# (The style items are separated by commas, lower or uppercase, no spaces.)
+: ${TLDR_TITLE_STYLE:=Newline,Space,Bold,Yellow}
+: ${TLDR_DESCRIPTION_STYLE:=Space,Yellow}
+: ${TLDR_EXAMPLE_STYLE:=Newline,Bold,Green}
+: ${TLDR_CODE_STYLE:=Space,Bold,Blue}
+: ${TLDR_VALUE_STYLE:=Bold,Cyan}
+# Color and/or background (Newline and Space also allowed) for error messages
+: ${TLDR_ERROR_COLOR=Red}
-# initialize globals, sanity check the environment, etc.
-config() {
- init_term_cmds
+# How long before an attempt will be made to re-download a page
+: ${TLDR_EXPIRY:=60}
- if [ -z $(which curl) ]; then
- echo "${red}tldr requires \`curl\` installed in your path$reset"
- exit 1
- fi
+Usage(){ # $1: optional exit code
+ self=$(basename $0)
+ local exit=${1:-0}
+ Out "$(cat <<-EOF
- configdir=~/.tldr
- [ -d ~/.config ] && configdir=~/.config/tldr
+ USAGE: $GRE$B$self$XB$DEF [$YEL${B}option$XB$DEF] [$BLU${B}platform$XB/$DEF]$CYA$B$XB$DEF
- platform=$(get_platform)
- base_url="https://raw.githubusercontent.com/tldr-pages/tldr/master/pages"
- index_url="http://tldr-pages.github.io/assets/index.json"
- index="$configdir/index.json"
- cache_days=14
- force_update=''
+ $BLU$B platform$XB/$CYA${B}command$XB$DEF: Show page for$CYA$B command$XB$DEF (from$BLU$B platform$XB$DEF)
- #check if config folder exists, otherwise create it
- [ -d "$configdir" ] || mkdir -p "$configdir"
+ $BLU$B platform$XB$DEF is optionally one of:$YEL common$DEF,$YEL linux$DEF,$YEL osx$DEF,$YEL sunos$DEF
- [ ! -f $index ] && update_index
- auto_update_index
+ $YEL$B option$XB$DEF is optionally one of:
+ $B$YEL-l$DEF,$YEL --list$DEF $BLU[platform]$DEF$XB: Show all available pages (from$BLU$B platform$XB$DEF)
+ $B$YEL-m$DEF,$YEL --markdown$DEF$XB $CYA$B$XB$DEF: Show the markdown source for $B$CYAcommand$DEF$XB
+ $B$YEL-c$DEF,$YEL --cache$DEF$XB: Cache all pages from repo$DEF
+ $B$YEL-u$DEF,$YEL --update$DEF$XB: Re-download index file$DEF
+ [$B$YEL-h$DEF,$YEL -?$DEF,$YEL --help$DEF$XB]: This help overview$DEF
+
+ Element styling:$T Title$XT$D Description$XD$E Example$XD$C Code$XC$V Value$XV
+ All pages and the index are cached locally under $YEL$configdir$DEF.
+ By default, the cached copies will be re-downloaded after $YEL$TLDR_EXPIRY$DEF days.
+ EOF
+ )"
+ exit $exit
}
-update_index() {
- curl -sf -o "$index" "$index_url"
- res=$?
- if [ $res -eq 22 ]; then
- echo "Could not download index from $index_url"
- exit 1
- fi
+Err(){ STDERR+="$ERRNL$ERRSP$ERR$B$1$XB$XERR$N";} # $1: error message for later
+
+Out(){ STDOUT+="$1$N";} # $1: message for later
+
+Style(){ # $1: Style specification
+ local style styles=${1// /} # remove spaces
+ STYLES= XSTYLES= COLOR= XCOLOR= NL= SP=
+ for style in ${styles//,/ }
+ do
+ [[ ${style,,} = newline ]] && NL=$N
+ [[ ${style,,} = space ]] && SP=' '
+ COLOR+=${color[${style,,}]:-}${bg[${style,,}]:-}
+ XCOLOR=${xbg[${style,,}]:-}${xcolor[${style,,}]:-}$XCOLOR
+ STYLES+=${color[${style,,}]:-}${bg[${style,,}]:-}${mode[${style,,}]:-}
+ XSTYLES=${xmode[${style,,}]:-}${xbg[${style,,}]:-}${xcolor[${style,,}]:-}$XSTYLES
+ done
+}
+
+Init_term(){
+ # Term codes with tput according to http://mywiki.wooledge.org/BashFAQ/037
+ [[ -t 2 ]] && { # only if interactive session (stderr open)
+ B=$'\e[1m' # $(tput bold || tput md) # Start bold
+ XB=$'\e[0m' # End bold (no tput code...) -- needs echo -e
+ U=$'\e[4m' # $(tput smul || tput us) # Start underline
+ XU=$'\e[24m' # $(tput rmul || tput ue) # End underline
+ I=$'\e[3m' # $(tput sitm || tput ZH) # Start italic
+ XI=$'\e[23m' # $(tput ritm || tput ZR) # End italic
+ R=$'\e[7m' # $(tput smso || tput so) # Start reverse
+ XR=$'\e[27m' # $(tput rmso || tput se) # End reverse
+ X=$'\e[0m' # $(tput sgr0 || tput me) # End all
+
+ [[ $TERM != *-m ]] && {
+ BLA=$'\e[30m' # $(tput setaf 0 || tput AF 0)
+ RED=$'\e[31m' # $(tput setaf 1 || tput AF 1)
+ GRE=$'\e[32m' # $(tput setaf 2 || tput AF 2)
+ YEL=$'\e[33m' # $(tput setaf 3 || tput AF 3)
+ BLU=$'\e[34m' # $(tput setaf 4 || tput AF 4)
+ MAG=$'\e[35m' # $(tput setaf 5 || tput AF 5)
+ CYA=$'\e[36m' # $(tput setaf 6 || tput AF 6)
+ WHI=$'\e[37m' # $(tput setaf 7 || tput AF 7)
+ DEF=$'\e[39m' # $(tput op)
+ BLAB=$'\e[40m' # $(tput setab 0 || tput AB 0)
+ REDB=$'\e[41m' # $(tput setab 1 || tput AB 1)
+ GREB=$'\e[42m' # $(tput setab 2 || tput AB 2)
+ YELB=$'\e[43m' # $(tput setab 3 || tput AB 3)
+ BLUB=$'\e[44m' # $(tput setab 4 || tput AB 4)
+ MAGB=$'\e[45m' # $(tput setab 5 || tput AB 5)
+ CYAB=$'\e[46m' # $(tput setab 6 || tput AB 6)
+ WHIB=$'\e[47m' # $(tput setab 7 || tput AB 7)
+ DEFB=$'\e[49m' # $(tput op)
+ }
+ # osx's termcap doesn't have italics. The below adds support for iTerm2
+ # and is harmless on Terminal.app
+ #[[ $(uname -s) = Darwin ]] && {
+ # I=$(echo -e "\e[3m")
+ # XI=$(echo -e "\e[23m")
+ #}
+ }
+
+ declare -A color=(['black']=$BLA ['red']=$RED ['green']=$GRE ['yellow']=$YEL \
+ ['blue']=$BLU ['magenta']=$MAG ['cyan']=$CYA ['white']=$WHI)
+ declare -A xcolor=(['black']=$DEF ['red']=$DEF ['green']=$DEF ['yellow']=$DEF \
+ ['blue']=$DEF ['magenta']=$DEF ['cyan']=$DEF ['white']=$DEF)
+ declare -A bg=(['blackbg']=$BLAB ['redbg']=$REDB ['greenbg']=$GREB ['yellowbg']=$YELB \
+ ['bluebg']=$BLUB ['magentabg']=$MAGB ['cyanbg']=$CYAB ['whitebg']=$WHIB)
+ declare -A xbg=(['blackbg']=$DEFB ['redbg']=$DEFB ['greenbg']=$DEFB ['yellowbg']=$DEFB \
+ ['bluebg']=$DEFB ['magentabg']=$DEFB ['cyanbg']=$DEFB ['whitebg']=$DEFB)
+ declare -A mode=(['bold']=$B ['underline']=$U ['italic']=$I ['inverse']=$R)
+ declare -A xmode=(['bold']=$XB ['underline']=$XU ['italic']=$XI ['inverse']=$XR)
+
+ # the five main tldr page styles and error message colors
+ Style "$TLDR_TITLE_STYLE"
+ T=$STYLES XT=$XSTYLES TNL=$NL TSP=$SP
+ Style "$TLDR_DESCRIPTION_STYLE"
+ D=$STYLES XD=$XSTYLES DNL=$NL DSP=$SP
+ Style "$TLDR_EXAMPLE_STYLE"
+ E=$STYLES XE=$XSTYLES ENL=$NL ESP=$SP
+ Style "$TLDR_CODE_STYLE"
+ C=$STYLES XC=$XSTYLES CNL=$NL CSP=$SP
+ Style "$TLDR_VALUE_STYLE"
+ V=$STYLES XV=$XSTYLES
+ Style "$TLDR_ERROR_COLOR"
+ ERR=$COLOR XERR=$XCOLOR ERRNL=$NL ERRSP=$SP
}
-# if the file exists and is more recent than $cache_days old
-recent() {
- exists=$(find "$1" -mtime -$cache_days 2>/dev/null)
- [ -n "$exists" -a -z "$force_update" ]
+Recent(){ find "$1" -mtime -$TLDR_EXPIRY &>/dev/null;} # $1: page
+
+Update_index(){
+ $DL "$index" "$index_url" && Out "${GRE}Index file $I$index$XI re-downloaded$DEF" || {
+ Err "Could not download index from $I$index_url$XI"
+ exit 2
+ }
}
-auto_update_index() {
- recent "$index" || update_index
+Config(){ # initialize globals, sanity check the environment, etc.
+ PLATFORM=common STDOUT= STDERR="" Q='"' N=$'\n'
+ case $(uname -s) in
+ Darwin) PLATFORM='osx' ;;
+ Linux) PLATFORM='linux' ;;
+ SunOS) PLATFORM='sunos' ;;
+ esac
+ Init_term
+ trap 'echo -ne "$STDOUT$N$STDERR" |less -RXMQF' EXIT
+
+ # Select download method
+ DL="$(type -p curl) -sfo" || {
+ DL="$(type -p wget) -qNO" || {
+ Err "tldr requires$I curl$XI or$I wget $XI installed in your path"
+ exit 3
+ }
+ }
+
+ base_url='https://raw.githubusercontent.com/tldr-pages/tldr/master/pages'
+ zip_url='https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/master/assets/tldr.zip'
+ index_url='http://tldr-pages.github.io/assets/index.json'
+
+ [[ -d ~/.config ]] && configdir=~/.config/tldr || configdir=~/.tldr
+ [[ -d "$configdir" ]] || mkdir -p "$configdir"
+ index="$configdir/index.json"
+ # if the file doesn't exists, or if it's younger than $TLDR_EXPIRY
+ [[ -f $index ]] && Recent "$index" || Update_index
}
-# function contents via http://mywiki.wooledge.org/BashFAQ/037
-init_term_cmds() {
- # only set if we're on an interactive session
- [[ -t 2 ]] && {
- reset=$( tput sgr0 || tput me ) # Reset cursor
- bold=$( tput bold || tput md ) # Start bold
- under=$( tput smul || tput us ) # Start underline
- italic=$( tput sitm || tput ZH ) # Start italic
- eitalic=$( tput ritm || tput ZH ) # End italic
- default=$( tput op )
- back=$'\b'
-
- [[ $TERM != *-m ]] && {
- black=$( tput setaf 0 || tput AF 0 )
- red=$( tput setaf 1 || tput AF 1 )
- green=$( tput setaf 2 || tput AF 2 )
- yellow=$( tput setaf 3 || tput AF 3 )
- blue=$( tput setaf 4 || tput AF 4 )
- magenta=$( tput setaf 5 || tput AF 5 )
- cyan=$( tput setaf 6 || tput AF 6 )
- white=$( tput setaf 7 || tput AF 7 )
-
- onblue=$( tput setab 4 || tput AB 4 )
- ongrey=$( tput setab 7 || tput AB 7 )
- }
- } 2>/dev/null ||:
-
- # osx's termcap doesn't have italics. The below adds support for iTerm2
- # and is harmless on Terminal.app
- [ "$(get_platform)" = "osx" ] && {
- italic=$(echo -e "\033[3m")
- eitalic=$(echo -e "\033[23m")
- }
+Unlinted(){ # $1: error message
+ Err "Page $I$PAGE$XI not properly linted!${N}Line $I$L$XI:[$U$line$XU]$N$1"
+ exit 4
}
-heading() {
- local line="$*"
- echo "$bold$red${line:2}$reset"
+Get_tldr(){ # $1: page
+ # convert the local platform name to tldr's version
+ # extract the platform key from index.json, return preferred subpath to page
+ local desc=$(tr '{' '\n' <$index |grep "\"name\":\"$1\"")
+ # results in, eg, "name":"netstat","platform":["linux","osx"]},
+
+ [[ $desc ]] || return # not found
+ if [[ $desc =~ \"$platform\" ]]
+ then # user specified platform first
+ PAGE="$platform/$1.md"
+ elif [[ $desc =~ \"common\" ]]
+ then # common platform?
+ PAGE="common/$1.md"
+ else # give warning for sure now
+ # system platform, or first one listed in index
+ [[ $desc =~ \"$PLATFORM\" ]] && PAGE="$PLATFORM/$1.md" \
+ || PAGE=$(cut -d $Q -f 8 <<<"$desc")/"$1.md"
+ Err "tldr page $I$1$XI not found in $I$platform$XI or$I common$XI, page from platform $U${PAGE%/*}$XU instead"
+ fi
+
+ # return the local cached copy of the tldrpage, or retrieve and cache from github
+ CACHED="$configdir/$PAGE"
+ Recent "$CACHED" || {
+ mkdir -p "${CACHED%/*}"
+ $DL "$CACHED" "$base_url/$PAGE" || {
+ Err "Could not download page $I$CACHED$XI from index $U$index_url$XU"
+ exit 5
+ }
+ }
}
-quotation() {
- local line="$*"
- echo "$under${line:2}$reset"
+Title(){ # $1: line
+ line=$1
+ ((${#line} <= 2)) && Unlinted "No title"
+ [[ ! ${line:1:1} = ' ' ]] && Unlinted "2nd character no space"
+ Out "$TNL$TSP$T${line:2}$XT";
}
-list_item() {
- local line="$*"
- echo "$line$reset"
+Description(){ # $1: line
+ line=$1
+ ((${#line} <= 3)) && Unlinted "No valid desciption"
+ [[ ! ${line:1:1} = ' ' ]] && Unlinted "2nd character no space"
+ [[ ! ${line: -1} = '.' ]] && Unlinted "Description doesn't end in full stop"
+ Out "$DNL$DSP$D${line:2}$XD";
+ DNL=
}
-code() {
- local line="$*"
- # I'm sure there's a better way to strip the first and last characters.
- line="${line:1}"
- line="${line%\`}"
- # convert {{variable}} to italics
- line=${line//\{\{/$italic}
- line=${line//\}\}/$eitalic}
-
- echo "$bold$line$reset"
+Example(){ # $1: line
+ line=$1
+ ((${#line} <= 2)) && Unlinted "No example content"
+ [[ ! ${line:1:1} = ' ' ]] && Unlinted "2nd character no space"
+ Out "$ENL$EPS$E$line$XE"
}
-text() {
- local line="$*"
- echo "$line"
+Code(){ # $1: line
+ line=$1
+ ((${#1} <= 2)) && Unlinted "No valid code content"
+ [[ ! ${line: -1} = '`' ]] && Unlinted "Code doesn't end in backtick"
+ line=${line:1:-1}
+ # Value: convert {{value}}
+ line=${line//\{\{/$CX$V}
+ line=${line//\}\}/$XV$C}
+ Out "$CNL$CSP$C$line$XC"
}
-# an idiot-level recognition of tldr's markdown. Needs improvement, or
-# subcontracting out to a markdown -> ANSI formatting command
-display_tldr() {
- # read one line at a time, don't strip whitespace ('IFS='), and process
- # last line even if it doesn't have a newline at the end
- while IFS= read -r line || [[ -n "$line" ]]; do
- start=${line:0:1} # get the first character
- case "$start" in
- '#') heading "$line"
- ;;
- '>') quotation "$line"
- ;;
- '-') list_item "$line"
- ;;
- '`') code "$line"
- ;;
- *) text "$line"
- ;;
- esac
- done
+Display_tldr(){
+ # read one line at a time, don't strip whitespace ('IFS='), and
+ # process last line even if it doesn't have a newline at the end
+ L=0
+ while IFS= read -r line || [[ $line ]]
+ do
+ ((++L))
+ case ${line:0:1} in # first character
+ '#') Title "$line" ;;
+ '>') Description "$line" ;;
+ '-') Example "$line" ;;
+ '`') Code "$line" ;;
+ '') continue ;;
+ *) Unlinted "Bad first character" ;;
+ esac
+ done
}
-# convert the local platorm name to tldr's version
-get_platform() {
- case `uname -s` in
- Darwin) echo "osx" ;;
- Linux) echo "linux" ;;
- SunOS) echo "sunos" ;;
- *) echo "common" ;;
- esac
+List_pages(){ # $1: exit code
+ [[ $platform ]] && platf=" from platform $I$platform$XI"
+ Out "${GRE}Known tldr pages$platf:"
+ Out "$(while read c1 c2 c3; do printf "%-19s %-19s %-19s %-19s$N" $c1 $c2 $c3; done \
+ <<<$(tr '{' '\n' <"$configdir/index.json" |grep "$platform" |cut -d $Q -f4))"
+ exit $1
}
-# extract the platform key from index.json, return preferred subpath to tldrpage
-path_for_cmd() {
- local desc=$(tr '{' '\n' < $index | grep "\"name\":\"$1\"")
- # results in, eg, "name":"netstat","platform":["linux","osx"]},
-
- [ -z "$desc" ] && return
-
- # use the platform specific version of the tldr first
- if [[ $desc =~ \"$platform\" ]]; then
- echo "$platform/$1.md"
- elif [[ $desc =~ \"common\" ]]; then
- echo "common/$1.md"
- else
- # take the first one so we can show something, but warn the user
- local p=$(echo "$desc" | cut -d '"' -f 8)
- >&2 echo -e "${red}tldr page $1 not found in $platform or common, using page from platform $p instead$reset\n"
- echo "$p/$1.md"
- fi
+Cache_fill(){ # $1: exit code
+ tmp=$(mktemp -d)
+ $DL "$tmp/pages.zip" "$zip_url" || {
+ Err "Could not download pages archive from $U$zip_url$XU"
+ exit 6
+ }
+ unzip="$(type -p unzip) -q" || {
+ Err "Unzip is necessary to fill the cache"
+ exit 7
+ }
+ $unzip "$tmp/pages.zip" -d "$tmp" 'pages/*'
+ rm -rf -- "$configdir/"*
+ mv -- "$tmp/pages/"* "$configdir/"
+ rm -rf -- "$tmp"
+ Out "${GRE}Pages cached in $U$configdir$XU$DEF"
+ exit $1
}
-# return the local cached copy of the tldrpage, or retrieve and cache from github
-get_tldr() {
- local p="$(path_for_cmd $1)"
- cached="$configdir/$p"
- recent "$cached" || {
- mkdir -p $(dirname $cached)
- curl -sf -o "$cached" "$base_url/$p"
- }
- # if the curl failed for some reason, keep cat from whinging
- cat "$cached" 2>/dev/null
+Config
+platform=
+markdown=0
+err=0
+arg=${1:-}
+case "$arg" in
+ -l|--list) shift
+ [[ $1 ]] && {
+ platform=$1
+ [[ ,common,linux,osx,sunos, == *,$platform,* ]] || {
+ Err "Unknown platform $I$platform$XI"
+ Usage 8
+ }
+ shift
+ [[ $1 ]] && Err "No more command line arguments allowed" && err=9
+ }
+ List_pages $err ;;
+ -c|--cache) shift;
+ [[ $1 ]] && Err "No more command line arguments allowed" && err=10
+ Cache_fill $err ;;
+ -u|--update) shift
+ [[ $1 ]] && Err "No more command line arguments allowed" && err=11
+ Update_index
+ exit $err ;;
+ -m|--markdown) markdown=1; shift; page=${@:-} ;;
+ ''|-h|-\?|--help) shift
+ [[ $1 ]] && Err "No more command line arguments allowed" && err=12
+ Usage $err ;;
+ -*) Err "Unrecognized option $I$1$XI"; Usage 13 ;;
+ *) page=${@:-} ;;
+esac
+
+[[ -z ${page:-} ]] && Err "No command specified" && Usage 14
+[[ $page =~ ' -' || ${page:0:1} = '-' ]] && Err "Only one option allowed" && Usage 15
+[[ $page == */* ]] && platform=${page%/*} && page=${page##*/}
+[[ $platform && ,common,linux,osx,sunos, != *,$platform,* ]] && {
+ Err "Unknown platform $I$platform$XI"
+ Usage 16
}
+Get_tldr ${page// /-}
+[[ ! -s $CACHED ]] && Err "tldr page for command $I$page$XI not found" && exit 17
-config
-
-usage() {
- cmd=$(basename $0)
- cat <
-
-[options]
- -l, --list: show all available pages
- -p, --platform: show page from specific platform rather than autodetecting
- -u, --update: update, force retrieving latest copies of locally cached files
- -h, -?, --help: this help overview
-
-
- Show examples for this command
-
-The client caches a copy of all pages and the index locally under
-$configdir. By default, the cached copies will expire in $cache_days days.
-
-EOF
+((markdown)) && Out "$(cat "$CACHED")" || Display_tldr <"$CACHED"
+# The error trap will output the accumulated stdout and stderr
exit 0
-}
-
-while [ $# -gt 0 ]
-do
- case "$1" in
- -l|--list)
- >&2 echo -e "Known tldr pages: \n"
- tr '{' '\n' < "$configdir/index.json" | cut -d '"' -f4 | column
- exit 0
- ;;
- -u|--update)
- force_update=yes
- update_index
- ;;
- -h|-\?|--help)
- usage
- ;;
- -p|--platform)
- shift
- platform=$1
- ;;
- -*)
- usage
- ;;
- *)
- page=${1:-''}
- ;;
- esac
- shift
-done
-
-[ -z ${page:-} ] && usage
-
-tldr="$(get_tldr $page)"
-
-if [ -z "$tldr" ]; then
- echo "tldr page for command $page not found"
- exit 1
-fi
-
-display_tldr <<< "$tldr"
-echo
diff --git a/tldr-customize.png b/tldr-customize.png
new file mode 100644
index 0000000..98c6460
Binary files /dev/null and b/tldr-customize.png differ
diff --git a/tldr-list.png b/tldr-list.png
new file mode 100644
index 0000000..08e4344
Binary files /dev/null and b/tldr-list.png differ
diff --git a/tldr-markdown.png b/tldr-markdown.png
new file mode 100644
index 0000000..e363f40
Binary files /dev/null and b/tldr-markdown.png differ
diff --git a/tldr-page.png b/tldr-page.png
new file mode 100644
index 0000000..4da08f7
Binary files /dev/null and b/tldr-page.png differ
diff --git a/tldr-usage.png b/tldr-usage.png
new file mode 100644
index 0000000..0d21442
Binary files /dev/null and b/tldr-usage.png differ