diff options
| -rw-r--r-- | .gitignore | 22 | ||||
| -rw-r--r-- | COPYING | 16 | ||||
| -rw-r--r-- | LICENSE | 683 | ||||
| -rw-r--r-- | Makefile | 270 | ||||
| -rw-r--r-- | README | 46 | ||||
| -rwxr-xr-x | auto-auto-complete (renamed from src/auto-auto-complete.py) | 33 | ||||
| -rw-r--r-- | auto-auto-complete.1 | 771 | ||||
| -rw-r--r-- | completion (renamed from src/completion) | 1 | ||||
| -rw-r--r-- | config.mk | 2 | ||||
| -rw-r--r-- | doc/example | 1 | ||||
| -rw-r--r-- | doc/info/auto-auto-complete.texinfo | 659 | ||||
| -rw-r--r-- | doc/info/fdl.texinfo | 505 | ||||
| -rw-r--r-- | doc/man/auto-auto-complete.1 | 70 | ||||
| -rw-r--r-- | doc/syntax | 1 |
14 files changed, 884 insertions, 2196 deletions
@@ -1,19 +1,11 @@ -_/ -bin/ -obj/ -\#*\# -.* -!.git* -/dist/*/*/* -!/dist/archlinux/*/PKGBUILD -!/dist/archlinux/*/auto-auto-complete.install +*\#* *~ *.swp *.swo *.bak -*.gz -/auto-auto-complete - -/bash -/fish -/zsh +*.pyc* +*.pyo* +__pycache__/ +/auto-auto-complete.bash +/auto-auto-complete.zsh +/auto-auto-complete.fish diff --git a/COPYING b/COPYING deleted file mode 100644 index 47bb0f6..0000000 --- a/COPYING +++ /dev/null @@ -1,16 +0,0 @@ -auto-auto-complete – Autogenerate shell auto-completion scripts - -Copyright © 2012, 2013, 2014, 2015 Mattias Andrée (m@maandree.se) - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see <http://www.gnu.org/licenses/>. @@ -1,674 +1,15 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 +ISC License - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. +© 2012, 2013, 2014, 2015, 2025 Mattias Andrée <m@maandree.se> - Preamble +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - 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 <http://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<http://www.gnu.org/licenses/>. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -<http://www.gnu.org/philosophy/why-not-lgpl.html>. +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. @@ -1,225 +1,65 @@ -# Copying and distribution of this file, with or without modification, -# are permitted in any medium without royalty provided the copyright -# notice and this notice are preserved. This file is offered as-is, -# without any warranty. - -# The package path prefix, if you want to install to another root, set DESTDIR to that root -PREFIX = /usr -# The command path excluding prefix -BIN = /bin -# The resource path excluding prefix -DATA = /share -# The command path including prefix -BINDIR = $(PREFIX)$(BIN) -# The resource path including prefix -DATADIR = $(PREFIX)$(DATA) -# The generic documentation path including prefix -DOCDIR = $(DATADIR)/doc -# The info manual documentation path including prefix -INFODIR = $(DATADIR)/info -# The man page documentation path including prefix -MANDIR = $(DATADIR)/man -# The man page section 1 path including prefix -MAN1DIR = $(MANDIR)/man1 -# The license base path including prefix -LICENSEDIR = $(DATADIR)/licenses - -# Python 3 command to use in shebangs -SHEBANG = /usr$(BIN)/env python3 -# The name of the command as it should be installed -COMMAND = auto-auto-complete -# The name of the package as it should be installed -PKGNAME = auto-auto-complete - - -# Build rules - -.PHONY: default -default: base info shell - -.PHONY: all -all: base doc shell - -.PHONY: base -base: command - - -# Build rules for the command - -.PHONY: command -command: bin/auto-auto-complete - -bin/auto-auto-complete: src/auto-auto-complete.py - @mkdir -p bin - cp "$<" "$@" - sed -i 's:#!/usr/bin/env python3:#!$(SHEBANG):' "$@" +.POSIX: + +CONFIGFILE = config.mk +include $(CONFIGFILE) + + +all: auto-auto-complete.bash auto-auto-complete.zsh auto-auto-complete.fish + +auto-auto-complete.bash: completion ./auto-auto-complete + ./auto-auto-complete bash --output $@ --source completion + +auto-auto-complete.zsh: completion ./auto-auto-complete + ./auto-auto-complete zsh --output $@ --source completion + +auto-auto-complete.fish: completion ./auto-auto-complete + ./auto-auto-complete fish --output $@ --source completion + +install: auto-auto-complete.bash auto-auto-complete.zsh auto-auto-complete.fish + mkdir -p -- "$(DESTDIR)$(PREFIX)/bin" + mkdir -p -- "$(DESTDIR)$(MANPREFIX)/man1" + mkdir -p -- "$(DESTDIR)$(PREFIX)/share/licenses" + mkdir -p -- "$(DESTDIR)$(PREFIX)/share/doc/auto-auto-complete" + mkdir -p -- "$(DESTDIR)$(PREFIX)/share/bash-completion/completions" + mkdir -p -- "$(DESTDIR)$(PREFIX)/share/zsh/site-functions" + mkdir -p -- "$(DESTDIR)$(PREFIX)/share/fish/completions" + test ! -d "$(DESTDIR)$(PREFIX)/share/licenses/auto-auto-complete" + test ! -d "$(DESTDIR)$(PREFIX)/share/bash-completion/completions/auto-auto-complete" + test ! -d "$(DESTDIR)$(PREFIX)/share/zsh/site-functions/_auto-auto-complete" + test ! -d "$(DESTDIR)$(PREFIX)/share/fish/completions/auto-auto-complete.fish" + cp -- auto-auto-complete "$(DESTDIR)$(PREFIX)/bin/" + cp -- auto-auto-complete.1 "$(DESTDIR)$(MANPREFIX)/man1/" + cp -- LICENSE "$(DESTDIR)$(PREFIX)/share/licenses/auto-auto-complete" + cp -- doc/example "$(DESTDIR)$(PREFIX)/share/doc/auto-auto-complete/" + cp -- auto-auto-complete.bash "$(DESTDIR)$(PREFIX)/share/bash-completion/completions/auto-auto-complete" + cp -- auto-auto-complete.zsh "$(DESTDIR)$(PREFIX)/share/zsh/site-functions/_auto-auto-complete" + cp -- auto-auto-complete.fish "$(DESTDIR)$(PREFIX)/share/fish/completions/auto-auto-complete.fish" +uninstall: + -rm -f -- "$(DESTDIR)$(PREFIX)/bin/auto-auto-complete" + -rm -f -- "$(DESTDIR)$(MANPREFIX)/man1/auto-auto-complete.1" + -rm -f -- "$(DESTDIR)$(PREFIX)/share/licenses/auto-auto-complete" + -rm -f -- "$(DESTDIR)$(PREFIX)/share/doc/auto-auto-complete/example" + -rmdir -- "$(DESTDIR)$(PREFIX)/share/doc/auto-auto-complete" + -rm -f -- "$(DESTDIR)$(PREFIX)/share/bash-completion/completions/auto-auto-complete" + -rmdir -- "$(DESTDIR)$(PREFIX)/share/bash-completion/completions" + -rmdir -- "$(DESTDIR)$(PREFIX)/share/bash-completion" + -rm -f -- "$(DESTDIR)$(PREFIX)/share/zsh/site-functions/_auto-auto-complete" + -rmdir -- "$(DESTDIR)$(PREFIX)/share/zsh/site-functions" + -rmdir -- "$(DESTDIR)$(PREFIX)/share/zsh" + -rm -f -- "$(DESTDIR)$(PREFIX)/share/fish/completions/auto-auto-complete.fish" + -rmdir -- "$(DESTDIR)$(PREFIX)/share/fish/completions" + -rmdir -- "$(DESTDIR)$(PREFIX)/share/fish" -# Build rules for documentation +clean: + -rm -rf -- __pycache__ *.pyc* *.pyo* + -rm -f -- auto-auto-complete.bash auto-auto-complete.zsh auto-auto-complete.fish -.PHONY: doc -doc: info pdf dvi ps +.PHONY: all install uninstall clean -.PHONY: info -info: bin/auto-auto-complete.info -bin/%.info: doc/info/%.texinfo doc/info/fdl.texinfo - @mkdir -p bin - makeinfo $< - mv $*.info $@ -.PHONY: pdf pdf: bin/auto-auto-complete.pdf bin/%.pdf: doc/info/%.texinfo doc/info/fdl.texinfo @mkdir -p obj/pdf bin cd obj/pdf && texi2pdf ../../$< < /dev/null mv obj/pdf/$*.pdf $@ - -.PHONY: dvi -dvi: bin/auto-auto-complete.dvi -bin/%.dvi: doc/info/%.texinfo doc/info/fdl.texinfo - @mkdir -p obj/dvi bin - cd obj/dvi && $(TEXI2DVI) ../../$< < /dev/null - mv obj/dvi/$*.dvi $@ - -.PHONY: ps -ps: bin/auto-auto-complete.ps -bin/%.ps: doc/info/%.texinfo doc/info/fdl.texinfo - @mkdir -p obj/ps bin - cd obj/ps && texi2pdf --ps ../../$< < /dev/null - mv obj/ps/$*.ps $@ - - -# Build rules for shell auto-completion - -.PHONY: shell -shell: bash zsh fish - -.PHONY: bash -bash: bin/auto-auto-complete.bash -bin/auto-auto-complete.bash: src/completion bin/auto-auto-complete - @mkdir -p bin - bin/auto-auto-complete bash --output $@ --source $< - -.PHONY: zsh -zsh: bin/auto-auto-complete.zsh -bin/auto-auto-complete.zsh: src/completion bin/auto-auto-complete - @mkdir -p bin - bin/auto-auto-complete zsh --output $@ --source $< - -.PHONY: fish -fish: bin/auto-auto-complete.fish -bin/auto-auto-complete.fish: src/completion bin/auto-auto-complete - @mkdir -p bin - bin/auto-auto-complete fish --output $@ --source $< - - -# Install rules - -.PHONY: install -install: install-base install-examples install-info install-man install-shell - -.PHONY: install-all -install-all: install-base install-doc install-shell - -# Install base rules - -.PHONY: install-base -install-base: install-command install-license - -.PHONY: install-command-bin -install-command: bin/auto-auto-complete - install -dm755 -- "$(DESTDIR)$(BINDIR)" - install -m755 $< -- "$(DESTDIR)$(BINDIR)/$(COMMAND)" - -.PHONY: install-license -install-license: - install -dm755 -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - install -m644 COPYING LICENSE -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - -# Install documentation - -.PHONY: install-doc -install-doc: install-examples install-info install-pdf install-ps install-dvi install-man - -.PHONY: install-examples -install-examples: doc/example - install -dm755 -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME)" - install -m644 $^ -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME)/example" - -.PHONY: install-info -install-info: bin/auto-auto-complete.info - install -dm755 -- "$(DESTDIR)$(INFODIR)" - install -m644 $< -- "$(DESTDIR)$(INFODIR)/$(PKGNAME).info" - -.PHONY: install-pdf -install-pdf: bin/auto-auto-complete.pdf - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 $< -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME)/$(PKGNAME).pdf" - -.PHONY: install-ps -install-ps: bin/auto-auto-complete.ps - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 $< -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME)/$(PKGNAME).ps" - -.PHONY: install-dvi -install-dvi: bin/auto-auto-complete.dvi - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 $< -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME)/$(PKGNAME).dvi" - -.PHONY: install-man -install-man: doc/man/auto-auto-complete.1 - install -dm755 -- "$(DESTDIR)$(MAN1DIR)" - install -m644 $< -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1" - -# Install shell auto-completion - -.PHONY: install-shell -install-shell: install-bash install-zsh install-fish - -.PHONY: install-bash -install-bash: bin/auto-auto-complete.bash - install -dm755 -- "$(DESTDIR)$(DATADIR)/bash-completion/completions" - install -m644 $< -- "$(DESTDIR)$(DATADIR)/bash-completion/completions/$(COMMAND)" - -.PHONY: install-zsh -install-zsh: bin/auto-auto-complete.zsh - install -dm755 -- "$(DESTDIR)$(DATADIR)/zsh/site-functions" - install -m644 $< -- "$(DESTDIR)$(DATADIR)/zsh/site-functions/_$(COMMAND)" - -.PHONY: install-fish -install-fish: bin/auto-auto-complete.fish - install -dm755 -- "$(DESTDIR)$(DATADIR)/fish/completions" - install -m644 $< -- "$(DESTDIR)$(DATADIR)/fish/completions/$(COMMAND).fish" - - -# Uninstall rules - -uninstall: - -rm -- "$(DESTDIR)$(BINDIR)/$(COMMAND)" - -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/COPYING" - -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/LICENSE" - -rmdir -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - -rm -- "$(DESTDIR)$(INFODIR)/$(PKGNAME).info" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME)/$(PKGNAME).pdf" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME)/$(PKGNAME).ps" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME)/$(PKGNAME).dvi" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME)/example" - -rm -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1" - -rmdir -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME)" - -rm -- "$(DESTDIR)$(DATADIR)/fish/completions/$(COMMAND).fish" - -rmdir -- "$(DESTDIR)$(DATADIR)/fish/completions" - -rmdir -- "$(DESTDIR)$(DATADIR)/fish" - -rm -- "$(DESTDIR)$(DATADIR)/zsh/site-functions/_$(COMMAND)" - -rmdir -- "$(DESTDIR)$(DATADIR)/zsh/site-functions" - -rmdir -- "$(DESTDIR)$(DATADIR)/zsh" - -rm -- "$(DESTDIR)$(DATADIR)/bash-completion/completions/$(COMMAND)" - -rmdir -- "$(DESTDIR)$(DATADIR)/bash-completion/completions" - -rmdir -- "$(DESTDIR)$(DATADIR)/bash-completion" - - -# Clean rules - -.PHONY: clean -clean: - -rm -fr bin obj - @@ -2,28 +2,45 @@ NAME auto-auto-complete - Autogenerate shell auto-completion scripts SYNOPSIS - auto-auto-complete SHELL -o OUTPUT -s SOURCE [VARIABLE=VALUE]... - auto-auto-complete SHELL -w COMMAND + auto-auto-complete shell (-w command | -o output -s source [variable=value] ...) DESCRIPTION - auto-auto-complete generates a shell auto-completion script for - the shell SHELL, from the file SOURCE, and stores it to OUTPUT. - Or, if -w is used, print to stdout where such generate file - installed be stored for the command COMMAND, and the shell SHELL. + auto-auto-complete generates a shell auto-completion script. - When generating a file, a series of variables can defined using - the argument pattern 'VARIABLE=VALUE'. + auto-auto-complete provides a LISP-like declarative language for + creating auto-completion scripts for commands in a shell-agnostic way. + However, auto-auto-complete's language is limited in comparsion to + for example raw auto-completion scripts for the bash shell, however + it is well enough for most projects. OPTIONS - -o, --output OUTPUT + -o, --output output The name of the file to generate. - -s, -f, --source, --file SOURCE + -s, -f, --source, --file source The name of the file to parse. - -w, --where COMMAND - Print where the script shall be installed if - the name of the command is COMMAND. + -w, --where command + Print where, sans the path prefix, the script shall be + installed if the name of the command is command. + + For example, for the command "cmd", auto-auto-complete bash + -w cmd would print "/share/bash-completion/completions/cmd", + meaning that the script shall be installed to + "/usr/share/bash-completion/completions/cmd" or + "/usr/local/share/bash-completion/completions/cmd" depending + on the path prefix used for the package. + +OPERANDS + shell + The shell the auto-completion script shall be generated + for. Currently supported shells are: bash, fish, and zsh. + + variable=value + Define a variable to have a specific value. + + Defining a variable multiple times creates an array + of values for that variable. RATIONALE Noone really wants to write shell auto-completion scripts, @@ -32,6 +49,3 @@ RATIONALE SEE ALSO bash-completion, bash(1), fish(1), zsh(1) - - Full documentation available locally via: info '(auto-auto-complete)' - diff --git a/src/auto-auto-complete.py b/auto-auto-complete index 33d0521..4f32f86 100755 --- a/src/auto-auto-complete.py +++ b/auto-auto-complete @@ -1,30 +1,12 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- -''' -auto-auto-complete – Autogenerate shell auto-completion scripts - -Copyright © 2012, 2013, 2014, 2015 Mattias Andrée (m@maandree.se) - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see <http://www.gnu.org/licenses/>. -''' +# See LICENSE file for copyright and license details. import sys def print(text = '', end = '\n'): ''' - Hack to enforce UTF-8 in output (in the future, if you see anypony not using utf-8 in - programs by default, report them to Princess Celestia so she can banish them to the moon) + Hack to enforce UTF-8 in output @param text:str The text to print (empty string is default) @param end:str The appendix to the text to print (line breaking is default) @@ -832,7 +814,7 @@ class GeneratorZSH: def main(shell, output, source): ''' - mane! + main! @param shell:str Shell for which to generate completion @param output:str Output file @@ -897,7 +879,7 @@ def main(shell, output, source): def where_main(shell, command): ''' - --where mane! + --where main! @param shell:str Shell for which the completion should be installed @param command:str The commmad name @@ -910,11 +892,11 @@ def where_main(shell, command): -# supermane! +# supermain! if __name__ == '__main__': if (len(sys.argv) == 1) or ((len(sys.argv) == 2) and (sys.argv[1] in ('-h', '--help'))): - print("USAGE: auto-auto-complete SHELL --output OUTPUT_FILE --source SOURCE_FILE [VARIABLE=VALUE...]") - print(" or: auto-auto-complete SHELL --where COMMAND") + print("USAGE: auto-auto-complete shell --output output-file --source source-file [variable=value] ...") + print(" or: auto-auto-complete shell --where command") exit(2) shell = None @@ -969,4 +951,3 @@ if __name__ == '__main__': main(shell= shell, output= output, source= source) else: where_main(shell= shell, command= where) - diff --git a/auto-auto-complete.1 b/auto-auto-complete.1 new file mode 100644 index 0000000..1a9fead --- /dev/null +++ b/auto-auto-complete.1 @@ -0,0 +1,771 @@ +.TH AUTO-AUTO-COMPLETE 1 AUTO-AUTO-COMPLETE +.SH NAME +auto-auto-complete - Autogenerate shell auto-completion scripts + +.SH SYNOPSIS +.B auto-auto-complete +.I shell +.RB ( \-w +.I command +| +.B \-o +.I output +.B \-s +.I source +.RI [ variable \fB=\fP value "] ...)" + +.SH DESCRIPTION +.B auto-auto-complete +generates a shell auto-completion script. +.PP +.B auto-auto-complete +provides a LISP-like declarative language for creating auto-completion +scripts for commands in a shell-agnostic way. However, +.BR auto-auto-complete 's +language is limited in comparsion to for example raw auto-completion +scripts for the bash shell, however it is well enough for most projects. +.SH OPTIONS +.BR \-o ,\ \-\-output \ \fIoutput\fP +The name of the file to generate. +.TP +.BR \-s ,\ \-f ,\ \-\-source ,\ \-\-file \ \fIsource\fP +The name of the file to parse. +.TP +.BR \-w ,\ \-\-where \ \fIcommand\fP +Print where, sans the path prefix, the script shall be installed if +the name of the command is +.IR command . + +For example, for the command +.RB \(dq cmd \(dq, +.I auto-auto-complete bash -w cmd +would print +.RB \(dq /share/bash-completion/completions/cmd \(dq, +meaning that the script shall be installed to +.RB \(dq /usr/share/bash-completion/completions/cmd \(dq +or +.RB \(dq /usr/local/share/bash-completion/completions/cmd \(dq +depending on the path prefix used for the package. + +.SH OPERANDS +.TP +.I shell +The shell the auto-completion script shall be generated for. +Currently supported +.IR shell s +are: +.BR bash , +.BR fish , +and +.BR zsh . +.TP +.IB variable = value +Define a variable to have a specific value. + +Defining a variable multiple times creates an array +of values for that variable. + +.SH EXTENDED DESCRIPTION +.B auto-auto-complete +uses a LISP-like free form syntax. +syntax. Valid whitespace is normal blank space, +horizontal tab space, carriage return, line feed (new line) +and form feed (new page). Comments can be started with either +a semicolon +.RB ( ; ) +or a hash +.RB ( # ). +Comments end at the next following new line, which may either +be a carriage return, line feed or form feed. Comments cannot +be started inside quotes. +.PP +The backslash character +.RB ( \e ) +can be used to force the following character to be parsed +verbatim, this is called escaping. It is highly discourage to +use this to escape new lines, especially if the new line +encoding used in the document is carrige return–line feed, as +that would only escape the carrige return. There is also a set +of characters that have a special meaning when they are escaped: +.TP +.B a +Audible bell character. +.TP +.B b +Backspace character. +.TP +.B e +Escape character. +.TP +.B f +Form feed character. +.TP +.B n +Line feed character. +.TP +.B r +Carriage character. +.TP +.B t +Horizontal tab space character. +.TP +.B v +Vertical tab space character. +.TP +.B 0 +Null character. +.PP +Quotes, either simple quotes +.RB ( \(aq ) +or double quotes +.RB ( \(dq ) +can be used to parse all character verbatim except backslash +.RB ( \e ). +A quote ends at the next quote character that is not escaped +by a backslash +.RB ( \e ) +and is identical to the opening quote character. This is +especially useful for escaping whitespace and round brackets. +.PP +The rest of this chapter will demonstrate how to write a script +by example of +.BR ponysay (6) +(because it uses most of the syntax). +.PP +The first thing we do is to declare which command the script +is for. We do this by creating the root brackets and put the +name of the command as the first element. +.PP +.RS +.nf +(ponysay) +.fi +.RE +.PP +However, +.BR ponysay (6) +has a very similar command called +.BR ponythink (6). +It is sensible to let the same script be used for auto-complete +for both commands, to do this we utilise that we can define +variables when we invoke +.BR auto-auto-complete . +.PP +.RS +.nf +((value command)) +.fi +.RE +.PP +Now when we compile this script we need invoke +.B auto-auto-complete +with either +.B command=ponysay +or +.BR command=ponythink . +If we want +.BR ponysay (6) +to be used if we do not specify a value for command we instead +write: +.PP +.RS +.nf +((value command ponysay)) +.fi +.RE +.PP +Remember that we could give a variable multiple values. This can +also be done here. However in this example we only want one value. +For example, +.I ((value var a b)) +would generate +.I (a b) +if var has not been set. +.PP +.BR ponysay (6) +recognises the options +.B -h +and +.B --help +for printing a summary of recognised options. These options does not +take any arguments and hence are specified with +.IR (unargumented) . +.PP +.RS +.nf +((value command ponysay) + (unargumented (options -h --help) + (desc \(aqShow summary of options\(aq)) +) +.fi +.RE +.PP +This only specifies that these option exists, if we also want the +generated scripts to suggest +.B --help +we need to add +.IR "(complete --help)" . +.PP +.RS +.nf +((value command ponysay) + (unargumented (options -h --help) + (complete --help) + (desc \(aqShow summary of options\(aq)) +) +.fi +.RE +.PP +Now that we have our first option, let's add a few others, to keep the +example short, we will skip the most of the options. +.PP +.RS +.nf +((value command ponysay) + (unargumented (options -h --help) + (complete --help) + (desc \(aqShow summary of options\(aq)) + (unargumented (options -l --list) + (complete --list) + (desc \(aqList all MLP:FiM ponies\(aq)) + (unargumented (options +l ++list) + (complete ++list) + (desc \(aqList all non-MLP:FiM ponies\(aq)) + (unargumented (options -X --256-colours --256colours --x-colours) + (desc \(aqUse xterm colours\(aq)) +) +.fi +.RE +.PP +Now (especially if we had added all options) we have many +.I (unargumented) +blocks. We can use +.I (multiple) +so we do not have to write +.B unargumented +so many times. +.PP +.RS +.nf +((value command ponysay) + (multiple unargumented + ((options -h --help) (complete --help) + (desc \(aqShow summary of options\(aq)) + ((options -l --list) (complete --list) + (desc \(aqList all MLP:FiM ponies\(aq)) + ((options +l ++list) (complete ++list) + (desc \(aqList all non-MLP:FiM ponies\(aq)) + ((options -X --256-colours --256colours --x-colours) + (desc \(aqUse xterm colours\(aq)) + ) +) +.fi +.RE +.PP +To keep this example short we will truncate this to: +.PP +.RS +.nf +((value command ponysay) + (multiple unargumented ...) ;We have cut out the options. +) +.fi +.RE +.PP +.BR ponysay (6) +also have a number of options that does take an argument. +We will add a few of them. +.PP +.RS +.nf +((value command ponysay) + (multiple unargumented ...) ;We have cut out the options. + (multiple argumented + ((options -f --file --pony) (complete --file --pony) + (desc \(aqSpecify the pony that should printed\(aq)) + ((options -b --bubble --balloon) (complete --balloon) + (desc \(aqSpecify message balloon style\(aq)) + ((options -W --wrap) (complete --wrap) + (desc \(aqSpecify wrapping column\(aq)) + ((options +c --colour) (complete --colour) + (desc \(aqSpecify colour of the balloon, balloon link and message\(aq)) + ) +) +.fi +.RE +.PP +Just like +.B ponysay --help +prints +.B --wrap COLUMN +to indicate that the argument for +.B --wrap +is an index of the column where the message printed by +.BR ponysay (6) +is wrapped, shells could display the text +.B COLUMN +as a placeholder for the next argument when you have typed +.BR --wrap . +To enable this in shells that support it, we use +.IR (arg) . +.PP +.RS +.nf +((value command ponysay) + (multiple unargumented ...) ;We have cut out the options. + (multiple argumented + ((options -f --file --pony) (complete --file --pony) (arg PONY) + (desc \(aqSpecify the pony that should printed\(aq)) + ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) + (desc \(aqSpecify message balloon style\(aq)) + ((options -W --wrap) (complete --wrap) (arg COLUMN) + (desc \(aqSpecify wrapping column)\(aq) + ((options +c --colour) (complete --colour) (arg ANSI-COLOUR) + (desc \(aqSpecify colour of the balloon, balloon link and message\(aq)) + ) +) +.fi +.RE +.PP +The next step now is to specify the type of argument the +options want. To do this we use +.IR (files) . +The elements in +.I (files) +specify what type of file the shell should suggest. Multiple +type can be used. The recognised ones are: +.TP +.B -0 +Do not suggest files, or do not suggest files of types specified after +.BR -0 . +.TP +.B -a +Suggest all files. +.TP +.B -f +Suggest regular files and pipes. +.TP +.B -r +Suggest regular files but not pipes. +.TP +.B -p +Suggest pipes but not regular files. +.TP +.B -d +Suggest directories. +.TP +.B -l +Suggest symlinks. This is suggest by default, but +.B -0 +can be used to stop this. +.TP +.B -s +Suggest sockets. +.TP +.B -D +Suggest doors. +.TP +.B -b +Suggest block devices. +.TP +.B -c +Suggest character devices. +.TP +.B -S +Suggest block devices and character devices. +.PP +.RS +.nf +((value command ponysay) + (multiple unargumented ...) ;We have cut out the options. + (multiple argumented + ((options -f --file --pony) (complete --file --pony) (arg PONY) + (files -f) + (desc \(aqSpecify the pony that should printed\(aq)) + ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) + (files -f) + (desc \(aqSpecify message balloon style\(aq)) + ((options -W --wrap) (complete --wrap) (arg COLUMN) + (files -0) + (desc Specify wrapping column)) + ((options +c --colour) (complete --colour) (arg ANSI-COLOUR) + (files -0) + (desc \(aqSpecify colour of the balloon, balloon link and message\(aq)) + ) +) +.fi +.RE +.PP +.I (files) +can also be used to specify patterns (using +.BR sh (1)-globbing) +for the filenames of the files to suggest. For example +.B --pony +in +.BR ponysay (6) +should only, in respect to files, suggest files that end with +.BR .pony . +.PP +.RS +.nf +((value command ponysay) + (multiple unargumented ...) ;We have cut out the options. + (multiple argumented + ((options -f --file --pony) (complete --file --pony) (arg PONY) + (files -f *.pony) + (desc \(aqSpecify the pony that should printed\(aq)) + ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) + (files -f *.say) + (desc \(aqSpecify message balloon style\(aq)) + ((options -W --wrap) (complete --wrap) (arg COLUMN) + (files -0) + (desc Specify wrapping column)) + ((options +c --colour) (complete --colour) (arg ANSI-COLOUR) + (files -0) + (desc \(aqSpecify colour of the balloon, balloon link and message\(aq)) + ) +) +.fi +.RE +.PP +For +.B --balloon +files ending with +.B .say +should be suggested if the completion is for +.BR ponysay (6), +but for +.BR ponythink (6) +.BR .think -files +should be suggested. We can use +.I (case) +to select this based on the value of the first element in the root +block, which is the name of the command. +.PP +.RS +.nf +((value command ponysay) + (multiple unargumented ...) ;We have cut out the options. + (multiple argumented + ((options -f --file --pony) (complete --file --pony) (arg PONY) + (files -f *.pony) + (desc \(aqSpecify the pony that should printed\(aq)) + ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) + (files -f (case (ponysay *.say) (ponythink *.think))) + (desc \(aqSpecify message balloon style\(aq)) + ((options -W --wrap) (complete --wrap) (arg COLUMN) + (files -0) + (desc Specify wrapping column)) + ((options +c --colour) (complete --colour) (arg ANSI-COLOUR) + (files -0) + (desc \(aqSpecify colour of the balloon, balloon link and message\(aq)) + ) +) +.fi +.RE +.PP +Another part of options with arguments is suggestions that +are not based on filenames. +.PP +.RS +.nf +((value command ponysay) + (multiple unargumented ...) ;We have cut out the options. + (multiple argumented + ((options -f --file --pony) (complete --file --pony) (arg PONY) + (suggest pony-f) (files -f *.pony) + (desc \(aqSpecify the pony that should printed\(aq)) + ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) + (suggest balloon) + (files -f (case (ponysay *.say) (ponythink *.think))) + (desc \(aqSpecify message balloon style\(aq)) + ((options -W --wrap) (complete --wrap) (arg COLUMN) + (suggest wrap) (files -0) + (desc Specify wrapping column)) + ((options +c --colour) (complete --colour) (arg ANSI-COLOUR) + (files -0) + (desc \(aqSpecify colour of the balloon, balloon link and message\(aq)) + ) + (suggestion pony-f) ;We will fill this in later... + (suggestion balloon) ;We will fill this in later... + (suggestion wrap) ;We will fill this in later... +) +.fi +.RE +.PP +Let's cut out the options again to make this shorter. +.PP +.RS +.nf +((value command ponysay) + (multiple unargumented ...) ;We have cut out the options. + (multiple argumented ...) ;We have cut out the options. + (suggestion pony-f) ;We will fill this in later... + (suggestion balloon) ;We will fill this in later... + (suggestion wrap) ;We will fill this in later... +) +.fi +.RE +.PP +Another part of +.BR ponysay (6) +is that it will take also arguments that are not associated with +any option, operands, which make up the message it prints out. +.PP +.RS +.nf +((value command ponysay) + (default (arg MESSAGE) (files -0) (suggest message) + (desc \(aqMessage spoken by the pony\(aq)) + (multiple unargumented ...) ;We have cut out the options. + (multiple argumented ...) ;We have cut out the options. + (suggestion message) ;We will fill this in later... + (suggestion pony-f) ;We will fill this in later... + (suggestion balloon) ;We will fill this in later... + (suggestion wrap) ;We will fill this in later... +) +.fi +.RE +.PP +A rather unusual part of +.BR ponysay (6) +is that it has variadic options. A variadic option is a option +that takes all following arguments, unconditionally. For example, in +.BR ponysay (6) +you can write +.B --ponies twilight trixie +instead of +.BR "--pony twilight --pony trixie" . +.I (variadic) +is used to declare a variadic option. +.I (bind) +becomes interesting here; because +.BR ponysay (6)'s +variadic options have non-variadic counterparts, it is pleasant +to reuse the non-variadic options' configurations. +.I (bind) +will copy everything that is missing except +.I (options) +and +.IR (complete) . +In this example we will not use +.I (complete) +because we do not want variadic options to be suggest but we will use +.I (desc) +because we want to adjust the descriptions. +.PP +.RS +.nf +((value command ponysay) + (default (arg MESSAGE) (files -0) (suggest message) + (desc \(aqMessage spoken by the pony\(aq)) + (multiple unargumented ...) ;We have cut out the options. + (multiple argumented ...) ;We have cut out the options. + (variadic (options --f --files --ponies) (bind -f) + (desc \(aqSpecify the ponies that may be printed\(aq)) + (suggestion message) ;We will fill this in later... + (suggestion pony-f) ;We will fill this in later... + (suggestion balloon) ;We will fill this in later... + (suggestion wrap) ;We will fill this in later... +) +.fi +.RE +.PP +Notice that we used +.B -f +for the element in +.IR (bind) , +this is because we want +.BR --f , +.B --files +and +.B --ponies +to have the same configurations (with exception for the +description) as the +.B -f +option. +.PP +Once again, to make the example shorter we will cut out +some parts. +.PP +.RS +.nf +( ;We have cut out everything but the (suggestion):s. + (suggestion message) ;We will fill this in later... + (suggestion pony-f) ;We will fill this in later... + (suggestion balloon) ;We will fill this in later... + (suggestion wrap) ;We will fill this in later... +) +.fi +.RE +.PP +For +.I (suggestion message) +we want the word +.RB \(dq MESSAGE \(dq +to be suggested to let the user know that the non-option +arguments make up the message that is printed (if used). +.PP +.RS +.nf +( ;We have cut out everything but the (suggestion):s. + (suggestion message (verbatim MESSAGE)) + (suggestion pony-f) ;We will fill this in later... + (suggestion balloon) ;We will fill this in later... + (suggestion wrap) ;We will fill this in later... +) +.fi +.RE +.PP +For +.I (suggestion pony-f) +we want, in addition to the +.BR .pony -files +which as already been configured, +.BR .pony -files +from +.I /usr/share/ponysay/ponies +to be suggested without the +.IR .pony- suffix. +.PP +.RS +.nf +( ;We have cut out everything but the (suggestion):s. + (suggestion message (verbatim MESSAGE)) + (suggestion pony-f (ls \(dq\(aq/usr/share/ponysay/ponies\(aq\(dq .pony)) + (suggestion balloon) ;We will fill this in later... + (suggestion wrap) ;We will fill this in later... +) +.fi +.RE +.PP +However, if the shell supports executing comments +to get suggetions we want to utilise this. +.PP +.RS +.nf +( ;We have cut out everything but the (suggestion):s. + (suggestion message (verbatim MESSAGE)) + (suggestion pony-f (exec \(dq\(aq/usr/bin/ponysay\(aq\(dq --onelist) + (noexec ls \(dq\(aq/usr/share/ponysay/ponies\(aq\(dq .pony)) + (suggestion balloon) ;We will fill this in later... + (suggestion wrap) ;We will fill this in later... +) +.fi +.RE +.PP +.I (suggestion balloon) +will work very similarly. +.PP +.RS +.nf +( ;We have cut out everything but the (suggestion):s. + (suggestion message (verbatim MESSAGE)) + (suggestion pony-f (exec \(dq\(aq/usr/bin/ponysay\(aq\(dq --onelist) + (noexec ls \(dq\(aq/usr/share/ponysay/ponies\(aq\(dq .pony)) + (suggestion balloon (exec \(dq\(aq/usr/bin/ponysay\(aq\(dq --balloonlist) + (no-exec ls \(dq\(aq/usr/share/ponysay/balloons\(aq\(dq + (case (ponysay .say) (ponythink .think)))) + (suggestion wrap) ;We will fill this in later... +) +.fi +.RE +.PP +The first thing we want to do for +.B --wrap +is to give it some default suggestion. +.PP +.RS +.nf +( ;We have cut out everything but (suggestion wrap). + (suggestion wrap (verbatim none inherit 100 60)) +) +.fi +.RE +.PP +The next step is to suggest the terminal’s width minus 10 columns. +In the POSIX shell this can be calculated with +.IR "$(( $(stty size <&2 | cut -d \(aq \(aq -f 2) - 10 ))" . +.PP +.RS +.nf +( ;We have cut out everything but (suggestion wrap). + (suggestion wrap + (verbatim none inherit 100 60) + (calc (pipe (stdin-fd (stty size) (stderr)) (cut -d \(aq \(aq -f 2)) - 10) + ) +) +.fi +.RE +.PP +As seen here +.I (pipe (a) (b) (c)) +translates into +.IR "(a | b | c)" . +There are a few similar blocks that can be used. +.TP +.I (fullpipe (a) (b) (c)) +.BR "(a |& b |& c)" , +or equivalently: +.B (a 2>&1 | b 2>&1 | c) +.TP +.I (cat (a) (b) (c)) +.B (a ; b ; c) +.TP +.I (and (a) (b) (c)) +.B (a && b && c) +.TP +.I (or (a) (b) (c)) +.B (a || b || c) +.PP +It was also shown that +.I (stdin-fd (a) (stderr)) +translates into +.BR "a <&2 " . +.IR (stdin) , +.IR (stdout) , +and +.I (stderr) +translates into +.BR 0 , +.BR 1 , +and +.BR 2 , +respectively. Additional +.I (stdin-fd a b) +translates into +.BR "a <&b" , +.I (stdout-fd a b) +into +.BR "a >&b" , +.I (stderr-fd a b) +into +.BR "a 2>&b" , +and +.I (fd-fd a b c) +into +.BR "a b<>&c ". +You can also redirect to files: +.TP +.I (stdin a b) +.B a<b +.TP +.I (stdout a b) +.B a>b +.TP +.I (stderr a b) +.B a 2> b +.TP +.I (fd a b c) +.B a b> c + +.SH RATIONALE +Noone really wants to write shell auto-completion scripts, +especially not for more than one shell. But of course we +want to have it. + +.SH SEE ALSO +.BR bash-completion , +.BR bash (1), +.BR fish (1), +.BR zsh (1) diff --git a/src/completion b/completion index 7e5da65..1afbb31 100644 --- a/src/completion +++ b/completion @@ -22,4 +22,3 @@ (suggestion default (verbatim bash zsh fish VARIABLE=VALUE)) ) - diff --git a/config.mk b/config.mk new file mode 100644 index 0000000..59032da --- /dev/null +++ b/config.mk @@ -0,0 +1,2 @@ +PREFIX = /usr +MANPREFIX = $(PREFIX)/share/man diff --git a/doc/example b/doc/example index b2f15ab..58c37b1 100644 --- a/doc/example +++ b/doc/example @@ -64,4 +64,3 @@ ; in addition to `pipe`(|) the following are also possible: `fullpipe`(|&) `cat`(;) `and`(&&) `or`(||) ; in addition to `stdin-fd`(<&) the following are also possible: `stdout-fd` `stderr-fd` `fd-fd` `stdin` `stdout` `stderr` `fd` ) - diff --git a/doc/info/auto-auto-complete.texinfo b/doc/info/auto-auto-complete.texinfo deleted file mode 100644 index d57490a..0000000 --- a/doc/info/auto-auto-complete.texinfo +++ /dev/null @@ -1,659 +0,0 @@ -\input texinfo @c -*-texinfo-*- - -@c %**start of header -@setfilename auto-auto-complete.info -@settitle auto-auto-complete -@afourpaper -@documentencoding UTF-8 -@documentlanguage en -@finalout -@c %**end of header - - -@dircategory Development -@direntry -* auto-auto-complete: (auto-auto-complete). Autogenerate shell auto-completion scripts -@end direntry - - -@copying -Copyright @copyright{} 2014, 2015 Mattias Andrée - -@quotation -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''. -@end quotation -@end copying - -@ifnottex -@node Top -@top auto-auto-complete -- Autogenerate shell auto-completion scripts -@insertcopying -@end ifnottex - -@titlepage -@title auto-auto-complete -@subtitle Autogenerate shell auto-completion scripts -@author by Mattias Andrée (maandree) - -@page -@c @center `' -@vskip 0pt plus 1filll -@insertcopying -@end titlepage - -@contents - - - -@menu -* Overview:: Brief overview of @command{auto-auto-complete}. -* Invoking:: Invocation of @command{auto-auto-complete}. -* Syntax:: The auto-auto-complete syntax. -* GNU Free Documentation License:: Copying and sharing this manual. -@end menu - - - -@node Overview -@chapter Overview - -@command{auto-auto-complete} provides a LISP-like -@footnote{A sane alternative to using XML.} declarative -language for creating auto-completion scripts for commands -in a shell-agnostic way. The current version of -@command{auto-auto-complete} can use such files to generate -auto-completion scripts for the @command{bash}, @command{zsh} -and @command{fish} shells. - -@command{auto-auto-complete}'s language limited in comparsion -to for example raw auto-completion scripts for the @command{bash} -shell, however it is well enough for most projects. - - - -@node Invoking -@chapter Invoking - -@command{auto-auto-complete} recognises two options: - -@table @option -@item -o -@itemx --output OUTPUT_FILE -Specifies the pathname of the generated file. - -@item -s -@itemx -f -@itemx --file -@itemx --source SOURCE_FILE -Specifies the pathname of the auto-auto-complete script. -@end table - -Both of these options must be used. Additionally -the shell that the generate file should be generated -for must be specified; this is done by adding name -of the shell as a stand-along argument, for example -@command{auto-auto-complete bash --output mycmd.bash --source mycmd.autocomplete} - -It is also possible to define variables that can be -used the auto-auto-complete script. If you, for example, -want to give the variable @var{command} the value -@code{mycmd}, add the argument @option{command=mycmd}. -It is also possible to define arrays, for example -if you want the variable @var{srcopt} to be an array -of the for values @code{-s}, @code{-f}, @code{--source} -and @code{--file}, add the arguments @option{srcopt=-s}, -@option{srcopt=-f}, @option{srcopt=--source} and -@option{srcopt=--file}. It is not possible to have -variable whose name begin with a dash (`-'). - -Alternatively you can run -@command{auto-auto-complete SHELL --where COMMAND} -(alternatively with @option{-w} instead of -@option{--where}). This will print the pathname -you should use for the generated file when installing -it. However the path prefix will not be included, -so if your package is installed to @file{/usr} -@footnote{The command being installed to @file{/usr/bin} -or @file{/usr/sbin}.}, you sould prepend @file{/usr} -to the output. - - - -@node Syntax -@chapter Syntax - -@command{auto-auto-complete} uses a LISP-like free form -syntax. Valid whitespace is normal blank space, horizontal -tab space@footnote{Also know simply as tab.}, -carriage return@footnote{The first character in a new line -in for example the HTTP protocol and in Window's encoding -for new lines, it was the new line character in the classical -Mac operating systems}, line feed (new line) and form feed -(new page). Comments can be started with either a semicolon -(;) or a hash (#). Comments end at the next following -new line, which may either be a carriage return, line feed -or form feed. Comments cannot be started inside quotes. - -The backslash character (\) can be used to force the -following character to be parsed verbatim, this is called -escaping. It is highly discourage to use this to escape -new lines, especially if the new line encoding used in the -document is carrige return–line feed, as that would only -escape the carrige return. There is also a set of characters -that have a special meaning when they are escaped: - -@table @asis -@item a -Audible bell character. -@item b -Backspace character. -@item e -Escape character. -@item f -Form feed character. -@item n -Line feed character. -@item r -Carriage character. -@item t -Horizontal tab space character. -@item v -Vertical tab space character. -@item 0 -Null character. -@end table - -Quotes, either simple quotes (') or double quotes (") -can be used to parse all character verbatim except -backslash (\). A quote ends at the next quote character -that is not escaped by a backslash (\) and is identical -to the opening quote character. This is especially useful -for escaping whitespace and round brackets. - -The rest of this chapter will demonstrate how to write a -script by example of @command{ponysay} (because it uses -most of the syntax). - -The first thing we do is to declare which command the -script is for. We do this by creating the root brackets -and put the name of the command as the first element. - -@example -(ponysay) -@end example - -However, @command{ponysay} has a very similar command -called @command{ponythink}. It is sensible to let the -same script be used for auto-complete for both commands, -to do this we utilise that we can define variables -when we invoke @command{auto-auto-complete}. - -@example -((value command)) -@end example - -Now when we compile this script we need invoke -@command{auto-auto-complete} with either -@option{command=ponysay} or @option{command=ponythink}. -If we want @command{ponysay} to be used if we -do not specify a value for @var{command} we instead -write: - -@example -((value command ponysay)) -@end example - -Remember that we could give a variable multiple values. -This can also be done here. However in this example -we only want one value. For example, @command{((value var a b))} -would generate @command{(a b)} if @var{var} has not been set. - -@command{ponysay} recognises the options @option{-h} and -@option{--help} for printing a summary of recognised options. -These options does not take any arguments and hence are specified -with @code{(unargumented)}. - -@example -((value command ponysay) - (unargumented (options -h --help) - (desc 'Show summary of options')) -) -@end example - -This only specifies that these option exists, if we also want -the generated scripts to suggest @option{--help} we need to -add @code{(complete --help)}. - -@example -((value command ponysay) - (unargumented (options -h --help) - (complete --help) - (desc 'Show summary of options')) -) -@end example - -Now that we have our first option, lets add a few others, to -keep the example short, we will skip the most of the options. - -@example -((value command ponysay) - (unargumented (options -h --help) - (complete --help) - (desc 'Show summary of options')) - (unargumented (options -l --list) - (complete --list) - (desc 'List all MLP:FiM ponies')) - (unargumented (options +l ++list) - (complete ++list) - (desc 'List all non-MLP:FiM ponies')) - (unargumented (options -X --256-colours --256colours --x-colours) - (desc 'Use xterm colours')) -) -@end example - -Now (especially if we had added all options) we have many -@code{(unargumented)} blocks. We can use @code{(multiple)} -so we do not have to write @code{unargumented} so many times. - -@example -((value command ponysay) - (multiple unargumented - ((options -h --help) (complete --help) - (desc 'Show summary of options')) - ((options -l --list) (complete --list) - (desc 'List all MLP:FiM ponies')) - ((options +l ++list) (complete ++list) - (desc 'List all non-MLP:FiM ponies')) - ((options -X --256-colours --256colours --x-colours) - (desc 'Use xterm colours')) - ) -) -@end example - -To keep this example short we will truncate this to: - -@example -((value command ponysay) - (multiple unargumented ...) ;We have cut out the options. -) -@end example - -@command{ponysay} also have a number of options that does -take an argument. We will add a few of them. - -@example -((value command ponysay) - (multiple unargumented ...) ;We have cut out the options. - (multiple argumented - ((options -f --file --pony) (complete --file --pony) - (desc 'Specify the pony that should printed')) - ((options -b --bubble --balloon) (complete --balloon) - (desc 'Specify message balloon style')) - ((options -W --wrap) (complete --wrap) - (desc 'Specify wrapping column')) - ((options +c --colour) (complete --colour) - (desc 'Specify colour of the balloon, balloon link and message')) - ) -) -@end example - -Just like @command{ponysay --help} prints @code{--wrap COLUMN} -to indicate that the argument for @option{--wrap} is is an -index of the column where the message printed by @command{ponysay} -is wrapped, shells could display the text @code{COLUMN} as -a placeholder for the next argument when you have typed -@option{--wrap}. To enable this in shells that support it, -we use @code{(arg)}. - -@example -((value command ponysay) - (multiple unargumented ...) ;We have cut out the options. - (multiple argumented - ((options -f --file --pony) (complete --file --pony) (arg PONY) - (desc 'Specify the pony that should printed')) - ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) - (desc 'Specify message balloon style')) - ((options -W --wrap) (complete --wrap) (arg COLUMN) - (desc 'Specify wrapping column)') - ((options +c --colour) (complete --colour) (arg ANSI-COLOUR) - (desc 'Specify colour of the balloon, balloon link and message')) - ) -) -@end example - -The next step now is to specify the type of argument the options -want. To do this we use @code{(files)}. The elements in @code{(files)} -specify what type of file the shell should suggest. Multiple -type can be used. Tehe recognsied ones are: - -@table @code -@item -0 -Do not suggest files, or do not suggest files of types specified -after @code{-0}. -@item -a -Suggest all files. -@item -f -Suggest regular files and pipes. -@item -r -Suggest regular files but not pipes. -@item -p -Suggest pipes but not regular files. -@item -d -Suggest directories. -@item -l -Suggest symlinks. This is suggest by default, -but @code{-0} can be used to stop this. -@item -s -Suggest sockets. -@item -D -Suggest doors. -@item -b -Suggest block devices. -@item -c -Suggest character devices. -@item -S -Suggest block devices and character devices. -@end table - -@example -((value command ponysay) - (multiple unargumented ...) ;We have cut out the options. - (multiple argumented - ((options -f --file --pony) (complete --file --pony) (arg PONY) - (files -f) - (desc 'Specify the pony that should printed')) - ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) - (files -f) - (desc 'Specify message balloon style')) - ((options -W --wrap) (complete --wrap) (arg COLUMN) - (files -0) - (desc Specify wrapping column)) - ((options +c --colour) (complete --colour) (arg ANSI-COLOUR) - (files -0) - (desc 'Specify colour of the balloon, balloon link and message')) - ) -) -@end example - -@code{(files)} can also be used to specify patterns (using -@code{sh}-globbing) for the filenames of the files to suggest. -For example @code{--pony} in @command{ponysay} should only, -in respect to files, suggest files that end with @code{.pony}. - -@example -((value command ponysay) - (multiple unargumented ...) ;We have cut out the options. - (multiple argumented - ((options -f --file --pony) (complete --file --pony) (arg PONY) - (files -f *.pony) - (desc 'Specify the pony that should printed')) - ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) - (files -f *.say) - (desc 'Specify message balloon style')) - ((options -W --wrap) (complete --wrap) (arg COLUMN) - (files -0) - (desc Specify wrapping column)) - ((options +c --colour) (complete --colour) (arg ANSI-COLOUR) - (files -0) - (desc 'Specify colour of the balloon, balloon link and message')) - ) -) -@end example - -For @option{--balloon} files ending with @code{.say} should be -suggested if the completion is for @command{ponysay}, but for -@command{ponythink} @code{.think}-files should be suggest. -We can use @code{(case)} to select this based on the value of -the first element in the root block, which is the name of the command. - -@example -((value command ponysay) - (multiple unargumented ...) ;We have cut out the options. - (multiple argumented - ((options -f --file --pony) (complete --file --pony) (arg PONY) - (files -f *.pony) - (desc 'Specify the pony that should printed')) - ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) - (files -f (case (ponysay *.say) (ponythink *.think))) - (desc 'Specify message balloon style')) - ((options -W --wrap) (complete --wrap) (arg COLUMN) - (files -0) - (desc Specify wrapping column)) - ((options +c --colour) (complete --colour) (arg ANSI-COLOUR) - (files -0) - (desc 'Specify colour of the balloon, balloon link and message')) - ) -) -@end example - -Another part of options with arguments is suggestions that are not -based on filenames. - -@example -((value command ponysay) - (multiple unargumented ...) ;We have cut out the options. - (multiple argumented - ((options -f --file --pony) (complete --file --pony) (arg PONY) - (suggest pony-f) (files -f *.pony) - (desc 'Specify the pony that should printed')) - ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) - (suggest balloon) - (files -f (case (ponysay *.say) (ponythink *.think))) - (desc 'Specify message balloon style')) - ((options -W --wrap) (complete --wrap) (arg COLUMN) - (suggest wrap) (files -0) - (desc Specify wrapping column)) - ((options +c --colour) (complete --colour) (arg ANSI-COLOUR) - (files -0) - (desc 'Specify colour of the balloon, balloon link and message')) - ) - (suggestion pony-f) ;We will fill this in later... - (suggestion balloon) ;We will fill this in later... - (suggestion wrap) ;We will fill this in later... -) -@end example - -Lets cut out the options again to make this shorter. - -@example -((value command ponysay) - (multiple unargumented ...) ;We have cut out the options. - (multiple argumented ...) ;We have cut out the options. - (suggestion pony-f) ;We will fill this in later... - (suggestion balloon) ;We will fill this in later... - (suggestion wrap) ;We will fill this in later... -) -@end example - -Another part of ponysay is that it will take also -argument that are not associated with an option make -make a message it prints out of thiat. - -@example -((value command ponysay) - (default (arg MESSAGE) (files -0) (suggest message) - (desc 'Message spoken by the pony')) - (multiple unargumented ...) ;We have cut out the options. - (multiple argumented ...) ;We have cut out the options. - (suggestion message) ;We will fill this in later... - (suggestion pony-f) ;We will fill this in later... - (suggestion balloon) ;We will fill this in later... - (suggestion wrap) ;We will fill this in later... -) -@end example - -A rather unusual part of @command{ponysay} is that -it has variadic options. A variadic option is a option -that takes all following arguments, unconditionally. -For example, in @command{ponysay} you can write -@code{--ponies twilight trixie} instead of -@code{--pony twilight --pony trixie}. @code{(variadic)} -is used to declare a variadic option. @code{(bind)} -becomes interesting here; because @command{ponysay}'s -variadic options have non-variadic counterparts, it -is pleasant to reuse the non-variadic options' -configurations. @code{(bind)} will copy everything -that is missing except @code{(options)} and -@code{(complete)}. In this example we will not -use @code{(complete)} because we do not want variadic -options to be suggest but we will use @code{(desc)} -because we want to adjust the descriptions. - -@example -((value command ponysay) - (default (arg MESSAGE) (files -0) (suggest message) - (desc 'Message spoken by the pony')) - (multiple unargumented ...) ;We have cut out the options. - (multiple argumented ...) ;We have cut out the options. - (variadic (options --f --files --ponies) (bind -f) - (desc 'Specify the ponies that may be printed')) - (suggestion message) ;We will fill this in later... - (suggestion pony-f) ;We will fill this in later... - (suggestion balloon) ;We will fill this in later... - (suggestion wrap) ;We will fill this in later... -) -@end example - -Notice that we used @code{-f} for the element in @code{(bind)}, -this is because we want @option{--f}, @option{--files} and -@code{--ponies} to have the same configurations (with exception -for the description) as the @option{-f} option. - -Once again, to make the example shorter we will cut out -some parts. - -@example -( ;We have cut out everything but the (suggestion):s. - (suggestion message) ;We will fill this in later... - (suggestion pony-f) ;We will fill this in later... - (suggestion balloon) ;We will fill this in later... - (suggestion wrap) ;We will fill this in later... -) -@end example - -For @code{(suggestion message)} we want the word -`MESSAGE' to be suggested to let the user know -that the non-option arguments make up the message -that is printed (if used). - -@example -( ;We have cut out everything but the (suggestion):s. - (suggestion message (verbatim MESSAGE)) - (suggestion pony-f) ;We will fill this in later... - (suggestion balloon) ;We will fill this in later... - (suggestion wrap) ;We will fill this in later... -) -@end example - -For @code{(suggestion pony-f)} we want, in addition -to the .pony-files which as already been configured, -.pony-files from @file{/usr/share/ponysay/ponies} -to be suggested without the .pony-suffix. - -@example -( ;We have cut out everything but the (suggestion):s. - (suggestion message (verbatim MESSAGE)) - (suggestion pony-f (ls "'/usr/share/ponysay/ponies'" .pony)) - (suggestion balloon) ;We will fill this in later... - (suggestion wrap) ;We will fill this in later... -) -@end example - -However, if the shell supports executing comments to -get suggetions we want to utilise this. - -@example -( ;We have cut out everything but the (suggestion):s. - (suggestion message (verbatim MESSAGE)) - (suggestion pony-f (exec "'/usr/bin/ponysay'" --onelist) - (noexec ls "'/usr/share/ponysay/ponies'" .pony)) - (suggestion balloon) ;We will fill this in later... - (suggestion wrap) ;We will fill this in later... -) -@end example - -@code{(suggestion balloon)} will work very similarly. - -@example -( ;We have cut out everything but the (suggestion):s. - (suggestion message (verbatim MESSAGE)) - (suggestion pony-f (exec "'/usr/bin/ponysay'" --onelist) - (noexec ls "'/usr/share/ponysay/ponies'" .pony)) - (suggestion balloon (exec "'/usr/bin/ponysay'" --balloonlist) - (no-exec ls "'/usr/share/ponysay/balloons'" - (case (ponysay .say) (ponythink .think)))) - (suggestion wrap) ;We will fill this in later... -) -@end example - -The first thing we want to do for @option{--wrap} -is to give it some default suggestion. - -@example -( ;We have cut out everything but (suggestion wrap). - (suggestion wrap (verbatim none inherit 100 60)) -) -@end example - -The next step is to suggest the terminal's -width minus 10 columns. In the Bash shell this -can be calculated with -@command{$(( $(stty size <&2 | cut -d ' ' -f 2) - 10 ))}. - -@example -( ;We have cut out everything but (suggestion wrap). - (suggestion wrap - (verbatim none inherit 100 60) - (calc (pipe (stdin-fd (stty size) (stderr)) (cut -d ' ' -f 2)) - 10) - ) -) -@end example - -As seen here @code{(pipe (a) (b) (c))} translates into -@code{(a | b | c)}. There are a few similar blocks that -can be used. - -@table @code -@item (fullpipe (a) (b) (c)) -@code{(a |& b |& c)}, or equivalently: -@code{(a 2>&1 | b 2>&1 | c)} -@item (cat (a) (b) (c)) -@code{(a ; b ; c)} -@item (and (a) (b) (c)) -@code{(a && b && c)} -@item (or (a) (b) (c)) -@code{(a || b || c)} -@end table - -It was also shown that @code{(stdin-fd (a) (stderr))} translates -into @code{a <&2}. @code{(stdin)}, @code{(stdout)} and @code{(stderr)} -translates into @code{0}, @code{1} and @code{2}, respectively. -Additional @code{(stdin-fd a b)} translates into @code{a <&b}, -@code{(stdout-fd a b)} into @code{a >&b}, @code{(stderr-fd a b)} into @code{a 2>&b} -and @code{(fd-fd a b c)} into @code{a b<>&c}. -You can also redirect to files: - -@table @code -@item (stdin a b) -@code{a < b} -@item (stdout a b) -@code{a > b} -@item (stderr a b) -@code{a 2> b} -@item (fd a b c) -@code{a b> c} -@end table - - - -@node GNU Free Documentation License -@appendix GNU Free Documentation License -@include fdl.texinfo - -@bye - diff --git a/doc/info/fdl.texinfo b/doc/info/fdl.texinfo deleted file mode 100644 index cb71f05..0000000 --- a/doc/info/fdl.texinfo +++ /dev/null @@ -1,505 +0,0 @@ -@c The GNU Free Documentation License. -@center Version 1.3, 3 November 2008 - -@c This file is intended to be included within another document, -@c hence no sectioning command or @node. - -@display -Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. -@uref{http://fsf.org/} - -Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. -@end display - -@enumerate 0 -@item -PREAMBLE - -The purpose of this License is to make a manual, textbook, or other -functional and useful document @dfn{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. - -@item -APPLICABILITY AND DEFINITIONS - -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, La@TeX{} 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. - -@item -VERBATIM COPYING - -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. - -@item -COPYING IN QUANTITY - -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. - -@item -MODIFICATIONS - -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: - -@enumerate A -@item -Use in the Title Page (and on the covers, if any) a title distinct -from that of the Document, and from those of previous versions -(which should, if there were any, be listed in the History section -of the Document). You may use the same title as a previous version -if the original publisher of that version gives permission. - -@item -List on the Title Page, as authors, one or more persons or entities -responsible for authorship of the modifications in the Modified -Version, together with at least five of the principal authors of the -Document (all of its principal authors, if it has fewer than five), -unless they release you from this requirement. - -@item -State on the Title page the name of the publisher of the -Modified Version, as the publisher. - -@item -Preserve all the copyright notices of the Document. - -@item -Add an appropriate copyright notice for your modifications -adjacent to the other copyright notices. - -@item -Include, immediately after the copyright notices, a license notice -giving the public permission to use the Modified Version under the -terms of this License, in the form shown in the Addendum below. - -@item -Preserve in that license notice the full lists of Invariant Sections -and required Cover Texts given in the Document's license notice. - -@item -Include an unaltered copy of this License. - -@item -Preserve the section Entitled ``History'', Preserve its Title, and add -to it an item stating at least the title, year, new authors, and -publisher of the Modified Version as given on the Title Page. If -there is no section Entitled ``History'' in the Document, create one -stating the title, year, authors, and publisher of the Document as -given on its Title Page, then add an item describing the Modified -Version as stated in the previous sentence. - -@item -Preserve the network location, if any, given in the Document for -public access to a Transparent copy of the Document, and likewise -the network locations given in the Document for previous versions -it was based on. These may be placed in the ``History'' section. -You may omit a network location for a work that was published at -least four years before the Document itself, or if the original -publisher of the version it refers to gives permission. - -@item -For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve -the Title of the section, and preserve in the section all the -substance and tone of each of the contributor acknowledgements and/or -dedications given therein. - -@item -Preserve all the Invariant Sections of the Document, -unaltered in their text and in their titles. Section numbers -or the equivalent are not considered part of the section titles. - -@item -Delete any section Entitled ``Endorsements''. Such a section -may not be included in the Modified Version. - -@item -Do not retitle any existing section to be Entitled ``Endorsements'' or -to conflict in title with any Invariant Section. - -@item -Preserve any Warranty Disclaimers. -@end enumerate - -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. - -@item -COMBINING DOCUMENTS - -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.'' - -@item -COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document and other documents -released under this License, and replace the individual copies of this -License in the various documents with a single copy that is included in -the collection, provided that you follow the rules of this License for -verbatim copying of each of the documents in all other respects. - -You may extract a single document from such a collection, and distribute -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. - -@item -AGGREGATION WITH INDEPENDENT WORKS - -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. - -@item -TRANSLATION - -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. - -@item -TERMINATION - -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. - -@item -FUTURE REVISIONS OF THIS LICENSE - -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 -@uref{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. - -@item -RELICENSING - -``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. - -@end enumerate - -@page -@heading ADDENDUM: How to use this License for your documents - -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: - -@smallexample -@group - Copyright (C) @var{year} @var{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''. -@end group -@end smallexample - -If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the ``with@dots{}Texts.''@: line with this: - -@smallexample -@group - with the Invariant Sections being @var{list their titles}, with - the Front-Cover Texts being @var{list}, and with the Back-Cover Texts - being @var{list}. -@end group -@end smallexample - -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. - -@c Local Variables: -@c ispell-local-pdict: "ispell-dict" -@c End: diff --git a/doc/man/auto-auto-complete.1 b/doc/man/auto-auto-complete.1 deleted file mode 100644 index 1369be4..0000000 --- a/doc/man/auto-auto-complete.1 +++ /dev/null @@ -1,70 +0,0 @@ -.TH AUTO-AUTO-COMPLETE 1 AUTO-AUTO-COMPLETE -.SH NAME -auto-auto-complete - Autogenerate shell auto-completion scripts -.SH SYNOPSIS -.B auto-auto-complete -.I SHELL -.B \-o -.I OUTPUT -.B \-s -.I SOURCE -.RI [ VARIABLE \fB=\fP VALUE ]... -.br -.B auto-auto-complete -.I SHELL -.B \-w -.I COMMAND -.SH DESCRIPTION -.B auto-auto-complete -generates a shell auto-completion script for the shell -.IR SHELL , -from the file -.IR SOURCE , -and stores it to -.IR OUTPUT . -Or, if -.B \-w -is used, print to stdout where such generate file should -be installed for the command -.IR COMMAND , -and the shell -.IR SHELL . -.PP -When generating a file, a series of variables can defined -using the argument pattern \(aq'\fIVARIABLE\fP\fB=\fP\fIVALUE\fP\(aq. -.SH OPTIONS -.BR \-o ,\ \-\-output \ \fIOUTPUT\fP -The name of the file to generate. -.TP -.BR \-s ,\ \-f \,\ \-\-source ,\ \-\-file \ \fISOURCE\fP -The name of the file to parse. -.TP -.BR \-w ,\ \-\-where \ \fICOMMAND\fP -Print where the script shall be installed if the name of -the command is -.IR COMMAND . -.SH RATIONALE -Noone really wants to write shell auto-completion scripts, -especially not for more than one shell. But of course we -want to have it. -.SH "SEE ALSO" -.BR bash-completion , -.BR bash (1), -.BR fish (1), -.BR zsh (1) -.PP -Full documentation available locally via: info \(aq(auto-auto-complete)\(aq -.SH AUTHORS -Principal author, Mattias Andrée. See the COPYING file for the full -list of authors. -.SH LICENSE -Copyright \(co 2012, 2013, 2014, 2015 Mattias Andrée -.br -License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. -.br -This is free software: you are free to change and redistribute it. -.br -There is NO WARRANTY, to the extent permitted by law. -.SH BUGS -Please report bugs to https://codeberg.org/maandree/auto-auto-complete/issues or to -m@maandree.se @@ -93,4 +93,3 @@ comment ::= ('#' | ';') [{$any}] \z __ ::= {' ' | \t | \n | \r | \f | comment} _ ::= [__] - |