From 54510b3be80ce395615e8772af6282f77a608560 Mon Sep 17 00:00:00 2001 From: Lars Tveito Date: Sat, 25 Oct 2014 17:42:53 +0200 Subject: [PATCH] Changed LICENSE to GPLv3 and updated README. --- LICENSE.md | 688 +++++++++++++++++++++++++++++++++++++++++++++++++++-- README.md | 375 ++++++++++++++++++----------- init.org | 17 ++ 3 files changed, 927 insertions(+), 153 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index d4acb60..5fdf13c 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,20 +1,676 @@ -The MIT License (MIT) +GNU GENERAL PUBLIC LICENSE +========================== +Version 3, 29 June 2007 +========================== -Copyright (c) 2013 - 2014 larstvei +> Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: +# Preamble + The GNU General Public License is a free, copyleft license for +software and other kinds of works. -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. + 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. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + 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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type 'show c' for details. + + The hypothetical commands _'show w'_ and _'show c'_ should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index 6d24556..b064bb1 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,10 @@ - [Flyspell](#flyspell) - [Org](#org) - [Interactive functions](#interactive-functions) - - [Key bindings](#key-bindings) - [Advice](#advice) - [Presentation-mode](#presentation-mode) -- [Language mode specific](#language-mode-specific) +- [Mode specific](#mode-specific) + - [Shell](#shell) - [Lisp](#lisp) - [Emacs Lisp](#emacs-lisp) - [Common lisp](#common-lisp) @@ -28,6 +28,8 @@ - [Python](#python) - [Haskell](#haskell) - [Matlab](#matlab) +- [Key bindings](#key-bindings) +- [License](#license) # About @@ -88,8 +90,10 @@ the `after-save-hook` ensuring to always tangle and byte-compile the tangled, and the tangled file is compiled." (when (equal (buffer-file-name) (expand-file-name (concat user-emacs-directory "init.org"))) - (org-babel-tangle) - (byte-compile-file (concat user-emacs-directory "init.el")))) + ;; Avoid running hooks when tangling. + (let ((prog-mode-hook nil)) + (org-babel-tangle) + (byte-compile-file (concat user-emacs-directory "init.el"))))) (add-hook 'after-save-hook 'tangle-init) ``` @@ -143,11 +147,14 @@ in handy. "Unless the newest available version of PACKAGE is installed PACKAGE is installed and the current version is deleted." (unless (newest-package-installed-p package) - (let ((pkg-desc (assq package package-alist))) + (let ((get-desc (if (version< emacs-version "24.4") 'cdr 'cadr)) + (pkg-desc (assq package package-alist))) (when pkg-desc - (package-delete (symbol-name package) - (package-version-join - (package-desc-vers (cdr pkg-desc))))) + (if (version< emacs-version "24.4") + (package-delete (symbol-name package) + (package-version-join + (package-desc-vers (get-desc pkg-desc)))) + (package-delete pkg-desc))) (and (assq package package-archive-contents) (package-install package))))) ``` @@ -274,7 +281,7 @@ along with external processes a lot simpler. I also prefer using the (setq mac-option-modifier nil mac-command-modifier 'meta x-select-enable-clipboard t) - (run-with-idle-timer 5 nil 'exec-path-from-shell-initialize)) + (exec-path-from-shell-initialize)) ``` ## Require @@ -314,7 +321,7 @@ These are what *I* consider to be saner defaults. We can set variables to whatever value we'd like using `setq`. ```lisp -(setq default-input-method "TeX" ; Use TeX when toggeling input method. +(setq default-input-method "TeX" ; Use TeX when toggling input method. doc-view-continuous t ; At page edge goto next/previous. echo-keystrokes 0.1 ; Show keystrokes asap. inhibit-startup-message t ; No splash screen please. @@ -431,13 +438,15 @@ default. '(abbrev-mode ; E.g. sopl -> System.out.println. column-number-mode ; Show column number in mode line. delete-selection-mode ; Replace selected text. + dirtrack-mode ; directory tracking in *shell* recentf-mode ; Recently opened files. show-paren-mode ; Highlight matching parentheses. global-undo-tree-mode)) ; Undo as a tree. (funcall mode 1)) -(eval-after-load 'auto-compile - '((auto-compile-on-save-mode 1))) ; compile .el files on save. +(when (version< emacs-version "24.4") + (eval-after-load 'auto-compile + '((auto-compile-on-save-mode 1)))) ; compile .el files on save. ``` This makes `.md`-files open in `markdown-mode`. @@ -461,39 +470,6 @@ Use the [Inconsolata](http://www.levien.com/type/myfonts/inconsolata.html) font (set-face-attribute 'default nil :font "Inconsolata-g-11")) ``` -[Powerline](https://github.com/milkypostman/powerline) is an extension to customize the mode line. This is modified -version `powerline-nano-theme`. - -```lisp -(setq-default - mode-line-format - '("%e" - (:eval - (let* ((active (powerline-selected-window-active)) - ;; left hand side displays Read only or Modified. - (lhs (list (powerline-raw - (cond (buffer-read-only "Read only") - ((buffer-modified-p) "Modified") - (t "")) nil 'l))) - ;; right side hand displays (line,column). - (rhs (list - (powerline-raw - (concat - "(" (number-to-string (line-number-at-pos)) - "," (number-to-string (current-column)) ")") nil 'r))) - ;; center displays buffer name. - (center (list (powerline-raw "%b" nil)))) - (concat (powerline-render lhs) - (powerline-fill-center nil (/ (powerline-width center) 2.0)) - (powerline-render center) - (powerline-fill nil (powerline-width rhs)) - (powerline-render rhs)))))) -``` - -This is what it looks like: - -![img](./powerline.png) - ## Ido Interactive do (or `ido-mode`) changes the way you switch buffers and @@ -533,7 +509,6 @@ the standard `execute-extended-command` with `smex`. ```lisp (smex-initialize) -(global-set-key (kbd "M-x") 'smex) ``` ## Calendar @@ -725,25 +700,61 @@ To search recent files useing `ido-mode` we add this snippet from `just-one-space` removes all whitespace around a point - giving it a negative argument it removes newlines as well. We wrap a interactive -function around it to be able to bind it to a key. +function around it to be able to bind it to a key. In Emacs 24.4 +`cycle-spacing` was introduced, and it works like just one space, but +when run in succession it cycles between one, zero and the original +number of spaces. ```lisp -(defun remove-whitespace-inbetween () +(defun cycle-spacing-delete-newlines () "Removes whitespace before and after the point." (interactive) - (just-one-space -1)) + (if (version< emacs-version "24.4") + (just-one-space -1) + (cycle-spacing -1))) ``` -This interactive function switches you to a `shell`, and if triggered in -the shell it switches back to the previous buffer. +```lisp +(defun jump-to-symbol-internal (symbol forwardp) + (let* ((point (point)) + (thing (prin1-to-string symbol)) + (beg (and (not forwardp) thing (beginning-of-thing 'symbol))) + (end (and forwardp thing (end-of-thing 'symbol))) + (diff (and thing (if forwardp (- point end) (- point beg))))) + (if (and thing + (funcall (if forwardp + 'search-forward 'search-backward) thing nil t) + (eq (intern thing) symbol)) + (forward-char diff) + (goto-char point)))) + +(defun jump-to-symbol-backward () + (interactive) + (jump-to-symbol-internal (symbol-at-point) nil)) + +(defun jump-to-symbol-forward () + (interactive) + (jump-to-symbol-internal (symbol-at-point) t)) +``` + +I sometimes regret killing the `*scratch*`-buffer, and have realized I +never want to actually kill it. I just want to get it out of the way, and +clean it up. The function below does just this for the +`*scratch*`-buffer, and works like `kill-this-buffer` for any other +buffer. It removes all buffer content and buries the buffer (this means +making it the least likely candidate for `other-buffer`). ```lisp -(defun switch-to-shell () - "Jumps to eshell or back." +(defun kill-this-buffer-unless-scratch () + "Works like `kill-this-buffer' unless the current buffer is the +*scratch* buffer. In witch case the buffer content is deleted and +the buffer is buried." (interactive) - (if (string= (buffer-name) "*shell*") - (switch-to-prev-buffer) - (shell))) + (if (not (string= (buffer-name) "*scratch*")) + (kill-this-buffer) + (delete-region (point-min) (point-max)) + (switch-to-buffer (other-buffer)) + (bury-buffer "*scratch*"))) ``` To duplicate either selected text or a line we define this interactive @@ -786,61 +797,7 @@ into the minibuffer, and the file will be evaluated. (eval-region (search-forward-regexp "^$") (point-max)))) ``` -## Key bindings - -Bindings for [expand-region](https://github.com/magnars/expand-region.el). - -```lisp -(global-set-key (kbd "C-'") 'er/expand-region) -(global-set-key (kbd "C-;") 'er/contract-region) -``` - -Bindings for [multiple-cursors](https://github.com/magnars/multiple-cursors.el). - -```lisp -(global-set-key (kbd "C-c e") 'mc/edit-lines) -(global-set-key (kbd "C-c a") 'mc/mark-all-like-this) -(global-set-key (kbd "C-c n") 'mc/mark-next-like-this) -``` - -Bindings for [Magit](http://magit.github.io). - -```lisp -(global-set-key (kbd "C-c m") 'magit-status) -``` - -Bindings for [ace-jump-mode](https://github.com/winterTTr/ace-jump-mode). - -```lisp -(global-set-key (kbd "C-c SPC") 'ace-jump-mode) -``` - -Bindings for `move-text`. - -```lisp -(global-set-key (kbd "") 'move-text-up) -(global-set-key (kbd "") 'move-text-down) -``` - -Bind some native Emacs functions. - -```lisp -(global-set-key (kbd "C-c s") 'ispell-word) -(global-set-key (kbd "C-c t") 'org-agenda-list) -(global-set-key (kbd "C-x k") 'kill-this-buffer) -(global-set-key (kbd "C-x C-r") 'recentf-ido-find-file) -``` - -Bind the functions defined above. - -```lisp -(global-set-key (kbd "C-c j") 'remove-whitespace-inbetween) -(global-set-key (kbd "C-x t") 'switch-to-shell) -(global-set-key (kbd "C-c d") 'duplicate-thing) -(global-set-key (kbd "") 'tidy) -``` - -## Advice +## Advice An advice can be given to a function to make it behave differently. This advice makes `eval-last-sexp` (bound to `C-x C-e`) replace the sexp with @@ -869,7 +826,7 @@ enabled themes. (mapc 'disable-theme custom-enabled-themes)) ``` -## Presentation-mode +## Presentation-mode When giving talks it's nice to be able to scale the text globally. `text-scale-mode` works great for a single buffer, this advice @@ -897,9 +854,50 @@ from the `text-scale-mode`, using `define-globalized-minor-mode`. (lambda () (text-scale-mode 1))) ``` -# Language mode specific +# Mode specific -## Lisp +## Shell + +I use `shell` whenever i want to use access the command line in Emacs. I +keep a symlink between my `~/.bash_profile` (because I run OS X) and +`~/.emacs_bash`, to make the transition between my standard terminal and +the shell as small as possible. To be able to quickly switch back and +forth between a shell I make use of this little function. + +```lisp +(defun toggle-shell () + "Jumps to eshell or back." + (interactive) + (if (string= (buffer-name) "*shell*") + (switch-to-prev-buffer) + (shell))) +``` + +I'd like the `C-l` to work more like the standard terminal (which works +like running `clear`), and resolve this by simply removing the +buffer-content. Mind that this is not how `clear` works, it simply adds a +bunch of newlines, and puts the prompt at the top of the window, so it +does not remove anything. In Emacs removing stuff is less of a worry, +since we can always undo! + +```lisp +(defun clear-shell () + "Runs `comint-truncate-buffer' with the +`comint-buffer-maximum-size' set to zero." + (interactive) + (let ((comint-buffer-maximum-size 0)) + (comint-truncate-buffer))) +``` + +Lastly we should bind our functions. The `toggle-shell` should be a +global binding (because we want to be able to switch to a shell from any +buffer), but the `clear-shell` should only affect `shell-mode`. + +```lisp +(add-hook 'shell-mode-hook (lambda () (local-set-key (kbd "C-l") 'clear-shell))) +``` + +## Lisp `Pretty-lambda` provides a customizable variable `pretty-lambda-auto-modes` that is a list of common lisp modes. Here we @@ -923,7 +921,7 @@ in the `pretty-lambda-auto-modes` list. (add-hook (intern (concat (symbol-name mode) "-hook")) 'paredit-mode)) ``` -### Emacs Lisp +### Emacs Lisp In `emacs-lisp-mode` we can enable `eldoc-mode` to display information about a function or a variable in the echo area. @@ -933,7 +931,7 @@ about a function or a variable in the echo area. (add-hook 'lisp-interaction-mode-hook 'turn-on-eldoc-mode) ``` -### Common lisp +### Common lisp I use [Slime](http://www.common-lisp.net/project/slime/) along with `lisp-mode` to edit Common Lisp code. Slime provides code evaluation and other great features, a must have for a @@ -963,7 +961,15 @@ which uses slime completions as a source. '(add-to-list 'ac-modes 'slime-repl-mode)) ``` -### Scheme +More sensible `loop` indentation, borrowed from [simenheg](https://github.com/simenheg). + +```lisp +(setq lisp-loop-forms-indentation 2 + lisp-simple-loop-indentation 2 + lisp-loop-keyword-indentation 6) +``` + +### Scheme [Geiser](http://www.nongnu.org/geiser/) provides features similar to Slime for Scheme editing. Everything works pretty much out of the box, we only need to add auto completion, @@ -978,7 +984,7 @@ and specify which scheme-interpreter we prefer. '(add-to-list 'geiser-active-implementations 'plt-r5rs)) ;'(racket)) ``` -## Java and C +## Java and C The `c-mode-common-hook` is a general hook that work on all C-like languages (C, C++, Java, etc…). I like being able to quickly compile @@ -1012,7 +1018,7 @@ activated. (add-hook 'java-mode-hook 'java-setup) ``` -## Assembler +## Assembler When writing assembler code I use `#` for comments. By defining `comment-start` we can add comments using `M-;` like in other programming @@ -1026,7 +1032,7 @@ modes. Also in assembler should one be able to compile using `C-c C-c`. (add-hook 'asm-mode-hook 'asm-setup) ``` -## LaTeX +## LaTeX `.tex`-files should be associated with `latex-mode` instead of `tex-mode`. @@ -1063,7 +1069,7 @@ Tex- and LaTeX-mode, we can add the flag with a rather dirty statement '(setcar (cdr (cddaar tex-compile-commands)) " -shell-escape ")) ``` -## Markdown +## Markdown I sometimes use a specialized markdown format, where inline math-blocks can be achieved by surrounding a LaTeX formula with `$math$` and @@ -1096,22 +1102,9 @@ function to a key! (local-set-key (kbd "C-c b") 'insert-markdown-inline-math-block)) t) ``` -## Python +## Python -[Jedi](http://tkf.github.io/emacs-jedi/released/) offers very nice auto completion for `python-mode`. Mind that it is -dependent on some python programs as well, so make sure you follow the -instructions from the site. - -```lisp -;; (setq jedi:server-command -;; (cons "python3" (cdr jedi:server-command)) -;; python-shell-interpreter "python3") -(add-hook 'python-mode-hook 'jedi:setup) -(setq jedi:complete-on-dot t) -(add-hook 'python-mode-hook 'jedi:ac-setup) -``` - -## Haskell +## Haskell `haskell-doc-mode` is similar to `eldoc`, it displays documentation in the echo area. Haskell has several indentation modes - I prefer using @@ -1122,7 +1115,7 @@ the echo area. Haskell has several indentation modes - I prefer using (add-hook 'haskell-mode-hook 'turn-on-haskell-indent) ``` -## Matlab +## Matlab `Matlab-mode` works pretty good out of the box, but we can do without the splash screen. @@ -1131,3 +1124,111 @@ splash screen. (eval-after-load 'matlab '(add-to-list 'matlab-shell-command-switches "-nosplash")) ``` + +# Key bindings + +Inspired by [this StackOverflow post](http://stackoverflow.com/questions/683425/globally-override-key-binding-in-emacs) I keep a `custom-bindings-map` that +holds all my custom bindings. This map can be activated by toggling a +simple `minor-mode` that does nothing more than activating the map. This +inhibits other `major-modes` to override these bindings. I keep this at +the end of the init-file to make sure that all functions are actually +defined. + +```lisp +(defvar custom-bindings-map (make-keymap) + "A keymap for custom bindings.") +``` + +Bindings for [expand-region](https://github.com/magnars/expand-region.el). + +```lisp +(define-key custom-bindings-map (kbd "C-'") 'er/expand-region) +(define-key custom-bindings-map (kbd "C-;") 'er/contract-region) +``` + +Bindings for [multiple-cursors](https://github.com/magnars/multiple-cursors.el). + +```lisp +(define-key custom-bindings-map (kbd "C-c e") 'mc/edit-lines) +(define-key custom-bindings-map (kbd "C-c a") 'mc/mark-all-like-this) +(define-key custom-bindings-map (kbd "C-c n") 'mc/mark-next-like-this) +``` + +Bindings for [Magit](http://magit.github.io). + +```lisp +(define-key custom-bindings-map (kbd "C-c m") 'magit-status) +``` + +Bindings for [ace-jump-mode](https://github.com/winterTTr/ace-jump-mode). + +```lisp +(define-key custom-bindings-map (kbd "C-c SPC") 'ace-jump-mode) +``` + +Bindings for [Helm](http://emacs-helm.github.io/helm/). + +```lisp +(define-key custom-bindings-map (kbd "C-c h g") 'helm-google-suggest) +``` + +Bindings for [smex](https://github.com/nonsequitur/smex). This overrides the standard `M-x`. + +```lisp +(define-key custom-bindings-map (kbd "M-x") 'smex) +``` + +Bindings for `move-text`. + +```lisp +(define-key custom-bindings-map (kbd "") 'move-text-up) +(define-key custom-bindings-map (kbd "") 'move-text-down) +``` + +Bind some native Emacs functions. + +```lisp +(define-key custom-bindings-map (kbd "C-j") 'newline-and-indent) +(define-key custom-bindings-map (kbd "C-c s") 'ispell-word) +(define-key custom-bindings-map (kbd "C-c t") 'org-agenda-list) +(define-key custom-bindings-map (kbd "C-x C-r") 'recentf-ido-find-file) +``` + +Bind the functions defined above. + +```lisp +(define-key custom-bindings-map (kbd "M-p") 'jump-to-symbol-backward) +(define-key custom-bindings-map (kbd "M-n") 'jump-to-symbol-forward) +(define-key custom-bindings-map (kbd "C-x k") 'kill-this-buffer-unless-scratch) +(define-key custom-bindings-map (kbd "C-x t") 'toggle-shell) +(define-key custom-bindings-map (kbd "C-c j") 'cycle-spacing-delete-newlines) +(define-key custom-bindings-map (kbd "C-c d") 'duplicate-thing) +(define-key custom-bindings-map (kbd "") 'tidy) +``` + +Lastly we need to activate the map by creating and activating the +`minor-mode`. + +```lisp +(define-minor-mode custom-bindings-mode + "A mode that activates custom-bindings." + t nil custom-bindings-map) +``` + +# License + +My Emacs configurations written in Org mode +Copyright (c) 2013 - 2014 Lars Tveito + +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 . diff --git a/init.org b/init.org index 51d89fa..efd8157 100644 --- a/init.org +++ b/init.org @@ -1230,3 +1230,20 @@ "A mode that activates custom-bindings." t nil custom-bindings-map) #+END_SRC +* License + + My Emacs configurations written in Org mode + Copyright (c) 2013 - 2014 Lars Tveito + + 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 .