├── LICENSE ├── README.org ├── img ├── biglogo.png ├── boy-1300226.svg ├── logo.svg └── no-symbol-39767.svg ├── logo.png └── lolsmacs.el /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+title: LOLSMacs 2 | 3 | [[file:/logo.png]] 4 | 5 | * About 6 | :properties: 7 | :ID: org_gcr_2019-03-06T17-15-24-06-00_cosmicality:B5FB31EA-EA25-4675-90B0-AE0167BAE092 8 | :end: 9 | 10 | The Law Of Least Surprise Lattice For Emacs: 11 | 12 | Found to to reduce utterances of "What the heck?!" or the less stressful "Really? Really?!" by 16-39 percent of the Emacs user population in a double-blind study of 1742 users funded by Cyberdyne Systems, ENCOM, LexCorp, Protovision, Setec Astronomy, Tyrell Corporation, Wayne Enterprises, and Yoyodyne Propulsion Systems. 13 | 14 | * Overview 15 | 16 | There are countless custom Emacs distributions (including but not limited to [[http://spacemacs.org/][spacemacs]], [[https://github.com/bbatsov/prelude][Prelude]], [[https://github.com/hlissner/doom-emacs][Doom]], [[https://github.com/jkitchin/scimax][scimax]]) and "better" default style configurations ([[https://github.com/technomancy/better-defaults][Better Defaults]], and every init file ever) out there and for good reason they all "scratch an itch". Some of us switch to those distributions and most of copy from them (if you don't you should) or both. The options and information can be overwhelming you ask yourself "Where do I even start here? What is really important and essential?" and the most important question "What are the differences between objectively good features that we can all agree on and features that are almost totally personal preference?" The truth is that we can't but we do have a very good way to move forward anyway. 17 | 18 | A UNIX guru once said that "There are no bad Emacs configurations, only poor applications of them." and I buy that. Magicians hide the menu bar. Neophytes show line numbers. Speed demons use completion skeletons and ido. Terminal junkies only use Control and Meta. GUI people use word wrap. You get the picture. So it is hard to make a generalized application everyone is different but they all share one thing no matter the application: they've all suffered some serious pain using text editors. 19 | 20 | Pain is the best motivator for change in life. Shock horror sadness and dismay follow a number of events using text editors. Emacs included. Other times pain comes in a more diluted form of disappointment. We've all exclaimed "What the heck?!" or the less stressful "Really? Really?!" Common among all of them is their origin the violation of the [[https://en.wikipedia.org/wiki/Principle_of_least_astonishment][Law Of Least Surprise (LOLS)]]. 21 | 22 | The purpose of this lattice LOLSMacs tries to configure Emacs never to break the LOLS. 23 | 24 | P.S. it is a /lattice/ not a /configuration/ /distribution/ or /initialization/ because all it does is establish some objective boundaries for operation that let you stay happy and focus on more important things. 25 | 26 | * Audience 27 | 28 | First time Emacs users you are the audience. You should load this then never look at it and never think about it again. You've got no reason to do so just don't. It was written carefully and thoughtfully just for you please know that. 29 | 30 | Long time Emacs users you are the audience. You should load this then never look at it and never think about it again. You've got no reason to do so just don't. It was written carefully and thoughtfully just for you please know that. But if you must look here are some of the things you might care about that you will be happy to no longer have to care about: 31 | 32 | - Nearly every operational interface setting is persisted (cursor minibuffer, desktop, kill-ring) 33 | - Files are how you expect them on-disk (auto save to a file not a backup, auto save on frame loss, window navigation, and user generated kill events, auto-revert) 34 | - User interface (windows and buffers) ready for programmers of any level 35 | - Extremely boring yet critical details are safely accounted for (comint, delete-selection, register display) 36 | - Uses 100% built in Emacs features and libraries no external dependencies 37 | - Great care taken to avoid subjective preferences (accepting that which surely has failed) 38 | 39 | * Table of Contents 40 | :PROPERTIES: 41 | :toc: all 42 | :END: 43 | - [[#about][About]] 44 | - [[#overview][Overview]] 45 | - [[#audience][Audience]] 46 | - [[#table-of-contents][Table of Contents]] 47 | - [[#requirements-and-compatibility][Requirements And Compatibility]] 48 | - [[#installation][Installation]] 49 | - [[#usage][Usage]] 50 | - [[#subjectivity-fails][Subjectivity Fails]] 51 | - [[#credits][Credits]] 52 | - [[#license][License]] 53 | 54 | * Requirements And Compatibility 55 | 56 | Emacs 26. 57 | 58 | * Installation 59 | 60 | Download [[https://github.com/grettke/lolsmacs/blob/master/lolsmacs.el][lolsmacs.el]] to your computer. 61 | 62 | If you're going to load it without using the package manager then you ought to place it in your preferred source directory for example =~/src=. 63 | 64 | #+BEGIN_SRC sh 65 | git clone https://github.com/grettke/lolsmacs.git 66 | #+END_SRC 67 | 68 | * Usage 69 | 70 | If you want to load the package without using the package manager then add this to your init file 71 | 72 | #+BEGIN_SRC emacs-lisp 73 | (and (load-file "~/src/lolsmacs/lolsmacs.el") 74 | (lolsmacs-init)) 75 | #+END_SRC 76 | 77 | Otherwise you can install it using the package manager by calling ~package-install-file~ and when you're asked "Package file name:" choose =lolsmacs.el= then add this to your init file 78 | 79 | #+BEGIN_SRC emacs-lisp 80 | (require 'lolsmacs) 81 | (lolsmacs-init) 82 | #+END_SRC 83 | 84 | If you want to try out the features on their own before loading them start Emacs like this 85 | 86 | #+BEGIN_SRC sh 87 | emacs --no-init-file --load ~/src/lolsmacs/lolsmacs.el --eval "(lolsmacs-init)" & 88 | #+END_SRC 89 | 90 | * Subjectivity Fails 91 | 92 | They say that when you believe in something you should write it down. So I did 93 | here in this package. There is no better way then writing something down to 94 | reveal what you really think and it's real level of truthiness lol. 95 | 96 | - 80 Column Character Width 97 | - Although it is pretty common it isn't a fair assumption 98 | - Primarily File Based Development 99 | - There are systems whose development cycle isn't strictly based around a 100 | file. For example ~tex-mode~ let's you try things out with making file 101 | changes (behind the scenes it uses temp files). APL is an environment where 102 | you load up an image (XML or binary) containing your definitions and then 103 | persist them at the end. Not sure how GNU APL handles it but you probably 104 | don't want to be saving that big blob all the time. 105 | 106 | * Credits 107 | 108 | Thanks to the [[https://www.gnu.org/software/emacs/manual/][GNU Emacs Manuals Online]] and countless code snippets from other Emacs users. 109 | 110 | Thanks to [[https://pixabay.com/][pixabay (sic)]] for the stock art. 111 | 112 | * License 113 | :properties: 114 | :ID: org_gcr_2019-03-06T17-15-24-06-00_cosmicality:E4196C89-DA78-44C7-9734-B9F37726F02A 115 | :end: 116 | 117 | - [[./LICENSE][GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007]]. 118 | 119 | 120 | -------------------------------------------------------------------------------- /img/biglogo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grettke/lolsmacs/9c7fb9f126c49a7d5828f7e869ce56d021a29d81/img/biglogo.png -------------------------------------------------------------------------------- /img/boy-1300226.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | -------------------------------------------------------------------------------- /img/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 23 | 25 | 29 | 30 | 58 | 67 | 68 | 70 | 71 | 73 | image/svg+xml 74 | 76 | 77 | 78 | 79 | Grant Rettke 80 | 81 | 82 | 83 | 84 | 85 | 92 | 97 | 102 | 107 | 112 | 117 | 122 | 127 | 132 | 137 | 142 | 147 | 152 | 157 | 162 | 167 | 173 | 178 | 183 | 188 | 193 | 198 | 203 | 208 | 213 | 218 | 223 | 228 | 233 | 238 | 243 | 248 | 253 | 254 | 255 | 261 | 267 | 273 | 274 | 275 | -------------------------------------------------------------------------------- /img/no-symbol-39767.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grettke/lolsmacs/9c7fb9f126c49a7d5828f7e869ce56d021a29d81/logo.png -------------------------------------------------------------------------------- /lolsmacs.el: -------------------------------------------------------------------------------- 1 | ;;; lolsmacs.el --- Law Of Least Surprise Lattice -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2025 Grant Rettke 4 | 5 | ;; Author: Grant Rettke 6 | ;; Keywords: convenience, files, frames 7 | ;; Version: 1.0.1 8 | ;; Package-Requires: ((emacs "29.1")) 9 | ;; Homepage: https://github.com/grettke/lolsmacs 10 | 11 | ;; This program is free software; you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation, either version 3 of the License, or 14 | ;; (at your option) any later version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; Intuitive impersonal settings complying with the Law Of Least Surprise 27 | ;; meant for inclusion with any initialization file especially useful to 28 | ;; first-time Emacs users or experienced Emacs users looking for focused 29 | ;; high-value content to copy. 30 | 31 | ;;; Code: 32 | 33 | (defun lolsmacs-this-must-before-everything-else-in-your-init-file () 34 | "When both the source file and its compiled bytecode are present load the source file first. 35 | 36 | It would be safer to add this line of code to the first file and loads in your 37 | initialization sequence. However it is probably good enough if you call this 38 | function before anything else." 39 | (interactive) 40 | (setq load-prefer-newer t)) 41 | 42 | (defun lolsmacs-require-packages () 43 | "Load packages used by this package." 44 | (interactive) 45 | (require 'whitespace) 46 | (require 'eldoc)) 47 | 48 | (defun lolsmacs-persistence () 49 | "Remember what you were doing and how things looked and restore it upon restarting." 50 | (interactive) 51 | (save-place-mode t) 52 | 53 | (setq savehist-save-minibuffer-history t) 54 | (setq savehist-additional-variables 55 | '(kill-ring 56 | search-ring 57 | regexp-search-ring 58 | last-kbd-macro 59 | kmacro-ring 60 | shell-command-history)) 61 | (savehist-mode) 62 | 63 | (setq desktop-restore-eager 5) 64 | (desktop-save-mode) 65 | 66 | (setq make-backup-files nil) 67 | (setq auto-save-default nil) 68 | (auto-save-visited-mode) 69 | 70 | (global-auto-revert-mode)) 71 | 72 | (defvar lolsmacs-save-on-hooks 73 | '( 74 | focus-out-hook 75 | kill-emacs-hook 76 | mouse-leave-buffer-hook 77 | suspend-hook 78 | ) 79 | "Add hook `lolsmacs-save-bufs' to these hooks.") 80 | 81 | (defvar 82 | lolsmacs-save-buffer-only-ons 83 | '( 84 | tex-compile 85 | TeX-command-master 86 | vc-diff 87 | vc-ediff 88 | vc-next-action 89 | vc-revert 90 | ) 91 | "Call `lolsmacs-save-buffer-only-ons-advice' BEFORE executing these functions.") 92 | 93 | (defvar 94 | lolsmacs-save-buffers-ons 95 | '( 96 | byte-compile-file 97 | compile 98 | delete-frame 99 | delete-other-frames 100 | delete-window 101 | dired 102 | eshell 103 | eval-buffer 104 | goto-line 105 | grep 106 | ibuffer 107 | kill-current-buffer 108 | list-buffers 109 | ns-do-hide-emacs 110 | org-babel-detangle 111 | org-babel-execute-buffer 112 | org-babel-execute-src-block 113 | org-babel-execute-subtree 114 | org-babel-tangle 115 | org-edit-src-code 116 | org-export-dispatch 117 | other-frame 118 | other-window 119 | pop-to-buffer 120 | quit-window 121 | save-buffers-kill-emacs 122 | save-buffers-kill-terminal 123 | select-window 124 | shell 125 | suspend-frame 126 | switch-to-buffer 127 | tex-compile 128 | ) 129 | "Call `lolsmacs-save-buffers-ons-advice' BEFORE executing these functions.") 130 | 131 | (defvar lolsmacs-save-bufs-debug nil "When non-nil message debug information for `lolsmacs-save-bufs'.") 132 | 133 | (defun lolsmacs-save-bufs () 134 | "Save all file buffers. 135 | 136 | When `lolsmacs-save-bufs-debug' is non-nil display performance information in 137 | *Messages* buffer." 138 | (interactive) 139 | (let ((time (current-time))) 140 | (save-some-buffers t nil) 141 | (when lolsmacs-save-bufs-debug 142 | (message "lolsmacs-save-bufs completed in: %.06f seconds" (float-time (time-since time)))))) 143 | (defun lolsmacs-save-buffers-ons-advice (&rest _args) 144 | "Delegates work to `lolsmacs-save-bufs'. 145 | 146 | Helper function for advising `lolsmacs-save-buffers-ons' (for advice ignore _ARGS)." 147 | (lolsmacs-save-bufs)) 148 | (defun lolsmacs-save-buffers-ons-advice-add (fn) 149 | "Add save on advice to FN." 150 | (advice-add fn :before #'lolsmacs-save-buffers-ons-advice)) 151 | (defun lolsmacs-save-buffer-only-ons-advice (&rest _args) 152 | "Save the current buffer. 153 | 154 | Helper function for advising `lolsmacs-save-buffer-only-ons' (for advice ignore _ARGS)." 155 | (basic-save-buffer)) 156 | (defun lolsmacs-save-buffer-only-ons-advice-add (fn) 157 | "Add save on advice to FN." 158 | (advice-add fn :before #'lolsmacs-save-buffer-only-ons-advice)) 159 | (defun lolsmacs-persistence-files () 160 | "Granular file-related persistence. 161 | 162 | A single value pervades this set up: all development is performed 163 | using file-based artifacts that are as current as possible and 164 | stored in version control. Its motivated by broken builds and 165 | other bizarre conditions due to files being out of sync between 166 | the file system and the editor. The entire persistence set up 167 | deals with this. This function deals with the granular file 168 | management not covered by existing modes. With that in mind here 169 | is where it begins. 170 | 171 | We must consider the elephant in the living room: given 172 | `auto-save-visited-mode' is enabled why is this additional 173 | granularity even considered? It is considered because sometimes 174 | `auto-save-visited-mode' (ASVM) isn't fast enough. 175 | 176 | For example imagine editing a Makefile in Emacs, switching to a 177 | console terminal (either hosted within Emacs or externally using a 178 | terminal client), hitting the up arrow, and finally returning to execute 179 | Make. You've performed this operation thousands of times and you 180 | do it in milliseconds. Its even faster if you rigged up a macro 181 | to execute an external command to do it. Is ASVM failing you 182 | here? Nope. ASVM is working perfectly well and as expected right 183 | now. 184 | 185 | Here is why: ASVM saves file buffers when you've been idle for 186 | `auto-save-visited-interval' seconds. If you make it too large then you 187 | can lose your work because it waited too long. If you make it too 188 | small then it will waste energy and kill performance. ASVM's default settings are 189 | perfect for 99% of its use cases. Once in a while though you need to perform 190 | the same thing a lot sooner than before `auto-save-visited-interval' seconds. The 191 | best way to consider these cases is splitting them up into three broad groups. 192 | 193 | There are three frames of mind to get into your cognitive workspace when you 194 | want to configure granular file persistence 195 | 196 | 1. Handling Special Events: Events, Hooks, and Keys 197 | 2. Handling Unrelated File Buffers 198 | 3. Handling Related File Buffers 199 | 200 | When do you want to automatically save file buffers? For most of us it is most 201 | of the time and ASVM handles that. There are exceptions though when the save 202 | needs to be performed as quickly as possible. Here is the breakdown and 203 | examples of and how it needs to happen. 204 | 205 | 1. Handling Special Events: Events, Hooks, and Keys 206 | 207 | This section tries to handle quitting Emacs in unhappy 208 | unplanned unpleasant ways. Upon failure Emacs will go away on 209 | gracefully, begrudgingly, and by dying. Usually Emacs closes on 210 | the request of `save-buffers-kill-terminal'. Other times it 211 | might be locked up and you send it a signal `(elisp)Event Examples'. 212 | Other times you must kill `(elisp)Killing Emacs' Emacs' it. 213 | This function sets up the 3 ways to handle them: 214 | 215 | A. Before advice for functions 216 | B. Hooks 217 | C. Key bindings 218 | 219 | It seems to cover most of the worst cases. 220 | 221 | 2. Handling Unrelated File Buffers 222 | 223 | Here is the best example: 224 | 225 | The VC package `(emacs)Version Control' `vc-next-action' operates 226 | on a single file `(emacs) Basic VC Editing'. If you make a change 227 | before calling `vc-next-action' VC will ask you if you want to 228 | save your changes before performing the action. Most of us /want/ 229 | the changes saved before we perform the next action which is 230 | usually and `add' or `commit' operating to the VC backend. In 231 | fact the intent and expectation of the function is that it will 232 | only ever operate on one file: it is safe to expect that. It is 233 | frustrating being prompted `yes-or-no-p' for something you'll 234 | answer yes to nearly every time. Before-advice saves you from 235 | this pain. There is a good case where this is the wrong 236 | functionality though. 237 | 238 | Perhaps you want to be able to perform `vc-next-action' against 239 | the state of the file on the disk, not in the buffer because you 240 | *know* that it is correct. For example if you have an automated 241 | build system that watches for file changes. You made some 242 | changes, saved them, the build system saw them, buiilt them, 243 | and ran all of the unit tests and passed. At the same time, you 244 | notice something in your code and want to add a TODO item. 245 | However you don't want it to be part of the commit. Right now 246 | you have a file on disk that you know is correct and ready to 247 | commit, and changes in your buffer that you don't want to commit. 248 | In this case you want to commit the file without saving the changes. 249 | You need to manage all of this before `auto-save-visited-interval' 250 | and it is realistic to do so. 251 | 252 | 3. Handling Related File Buffers 253 | 254 | Here is an example: 255 | 256 | You've got multiple buffers open working on a single project's source code. For 257 | the build to work correctly all of the files need to be persisted to the disk. 258 | As you work on code and move between buffers you need *all* of the files to be 259 | properly persisted (it is the same for auto-build or manual build setups). 260 | There are three ways to address this: 1. Add `lolsmacs-save-buffers-ons' to 261 | `other-window'. 2. Add the same advice to `shell'. 3. Add a hook that calls 262 | `lolsmacs-save-bufs' to `focus-out-hook'. This configuration addresses the 263 | most common development cycle for file based development. However not all 264 | of the development process is file based. 265 | 266 | Some development environments and development cycles aren't 267 | designed strictly around changes being persisted and working off 268 | of a file. One good example is that of TeX. When you perform a 269 | compilation, \"Run TeX on...\"), a TeX file if the compiler runs 270 | into problems it will stop and prompt you what it should do next. 271 | Suppose you got here by running TeX on a file, it ran into a 272 | problem, and now you want to resolve it. When you use `tex-mode' 273 | you have two ways of running TeX on a file: the functions 274 | `tex-file' or `tex-buffer'. When `tex-offer-save' is non-nil the 275 | former asks if you want to save all file based buffers then runs 276 | TeX. The latter takes the contents of the current buffer, saves 277 | them to a temporary file, and runs TeX over it. The formers seems to be 278 | simpler and more predictable even if you are just playing around with what you 279 | might do next but it is a good example of when you might not want all of your 280 | files to be persisted as quickly as possible. " 281 | (interactive) 282 | (mapc (lambda (hook) 283 | (add-hook hook #'lolsmacs-save-bufs)) 284 | lolsmacs-save-on-hooks) 285 | 286 | (mapc (lambda (fn) 287 | (lolsmacs-save-buffer-only-ons-advice-add fn)) 288 | lolsmacs-save-buffer-only-ons) 289 | 290 | (mapc (lambda (fn) 291 | (lolsmacs-save-buffers-ons-advice-add fn)) 292 | lolsmacs-save-buffers-ons) 293 | 294 | (define-key special-event-map [sigusr1] #'lolsmacs-save-bufs)) 295 | 296 | (defun lolsmacs-display () 297 | "Editor appearance." 298 | (interactive) 299 | (setq echo-keystrokes 0.02) 300 | 301 | (global-font-lock-mode) 302 | 303 | (setq-default indicate-buffer-boundaries 'left) 304 | 305 | (show-paren-mode) 306 | (setq show-paren-delay 0) 307 | (setq show-paren-style 'mixed) 308 | 309 | (setq whitespace-style '(tab-mark)) 310 | (setf 311 | (cdr (assoc 'tab-mark whitespace-display-mappings)) 312 | '(?\t [?↹ ?\t] [?\t])) 313 | (global-whitespace-mode) 314 | 315 | (size-indication-mode) 316 | 317 | (column-number-mode) 318 | (setq column-number-indicator-zero-based nil) 319 | 320 | (setq prettify-symbols-unprettify-at-point 'right-edge) 321 | (global-prettify-symbols-mode)) 322 | 323 | (defun lolsmacs-buffers () 324 | "Buffer behavior." 325 | (interactive) 326 | 327 | (defconst lolsmacs-column-width 80) 328 | 329 | (minibuffer-electric-default-mode) 330 | 331 | (electric-pair-mode) 332 | 333 | (delete-selection-mode 1) 334 | 335 | (setq save-interprogram-paste-before-kill t) 336 | 337 | (require 'uniquify) 338 | (setq uniquify-buffer-name-style 'post-forward-angle-brackets) 339 | (setq uniquify-after-kill-buffer-p t) 340 | (setq uniquify-ignore-buffers-re "^\\*") 341 | 342 | (setq scroll-preserve-screen-position t) 343 | 344 | (setq scroll-conservatively 101) 345 | 346 | (setq make-pointer-invisible t) 347 | 348 | (setq mouse-drag-copy-region t) 349 | (setq mouse-wheel-scroll-amount '(1 ((shift) . 1))) 350 | (setq mouse-wheel-progressive-speed nil) 351 | (setq mouse-wheel-follow-mouse t) 352 | 353 | (setq track-eol t) 354 | 355 | (setq line-move-visual nil) 356 | 357 | (setq ring-bell-function 'ignore) 358 | (setq visible-bell t)) 359 | 360 | (defun lolsmacs-operations () 361 | "Editor operations." 362 | (interactive) 363 | (setq minibuffer-eldef-shorten-default t) 364 | 365 | (setq resize-mini-windows t) 366 | 367 | (setq max-mini-window-height 0.33) 368 | 369 | (setq history-delete-duplicates t) 370 | 371 | (setq register-preview-delay 2) 372 | (setq register-separator "\n\n") 373 | 374 | (setq initial-major-mode 'emacs-lisp-mode) 375 | (with-current-buffer "*scratch*" 376 | (emacs-lock-mode 'kill)) 377 | 378 | (setq-default eval-expression-print-level nil) 379 | 380 | (put #'upcase-region 'disabled nil) 381 | (put #'downcase-region 'disabled nil) 382 | 383 | (setq large-file-warning-threshold (* 1024 1024)) 384 | 385 | (setq help-window-select t) 386 | 387 | (setq search-default-mode #'char-fold-to-regexp) 388 | 389 | (setq kill-read-only-ok t) 390 | 391 | ;; Here is the scenario for this style of Comint configuration: 392 | ;; 393 | ;; You are doing a lot of interactive work via various Comint-supported 394 | ;; buffers. You are working in one buffer (the one with focus) while the 395 | ;; others are doing their own thing. They are probably doing work and output 396 | ;; is scrolling by and that is fine because you are not reading it. In the 397 | ;; buffer you are working in though, you want to go back and read something. 398 | ;; So although it its process continues to output information, you want to 399 | ;; keep the cursor in the same spot. Then when you are ready to type a 400 | ;; command (suppose you know the output has stopped) to do something else, 401 | ;; when you type the cursor will go to the end of the buffer. That is why 402 | ;; you prevent the focused buffer from auto-scrolling and moving the mark, 403 | ;; and leave the other ones alone. 404 | (setq comint-scroll-to-bottom-on-input 'this) 405 | (setq comint-scroll-to-bottom-on-output 'others) 406 | (setq comint-move-point-for-output 'others) 407 | (setq comint-scroll-show-maximum-output t) 408 | (setq comint-prompt-read-only nil)) 409 | 410 | (defun lolsmacs-editing () 411 | "Editing things." 412 | (interactive) 413 | (setq inhibit-eol-conversion t) 414 | 415 | (setq require-final-newline t) 416 | 417 | (setq-default tab-width 2) 418 | 419 | (delete-selection-mode t) 420 | 421 | (setq-default fill-column lolsmacs-column-width) 422 | 423 | (setq sentence-end-double-space nil) 424 | (setq sentence-end-without-period nil) 425 | (setq colon-double-space nil)) 426 | 427 | (defun lolsmacs-init () 428 | "Load entire LOLSMacs configuration." 429 | (interactive) 430 | (lolsmacs-this-must-before-everything-else-in-your-init-file) 431 | (lolsmacs-require-packages) 432 | (lolsmacs-persistence) 433 | (lolsmacs-persistence-files) 434 | (lolsmacs-display) 435 | (lolsmacs-buffers) 436 | (lolsmacs-editing)) 437 | 438 | (provide 'lolsmacs) 439 | ;;; lolsmacs.el ends here 440 | 441 | --------------------------------------------------------------------------------