├── .github └── FUNDING.yml ├── LICENSE ├── README.org ├── README_cn.org └── todo.org /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | custom: https://afdian.net/@KiteAB 2 | -------------------------------------------------------------------------------- /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) 2022 K1t3AB (KiteAB) 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 | * Emacs Guides 2 | This repository saved the basic usage of GNU/Emacs and personal experiences of members of the studio. 3 | 4 | *PS*: More practice are not just look at sentences, it's can helps you learn quickly! 5 | 6 | *PSS*: Emacs Document is your good friend, ~C-h f~ for functions document, ~C-h v~ for variables document, ~C-h k~ for keybindings document. 7 | 8 | [[./README_cn.org][中文版]] 9 | 10 | ** Table of Contents 11 | * [[#contributors][Contributors]] 12 | * [[#basics-in-basic][Basics in Basic]] 13 | - [[#explore-files][Explore Files]] 14 | - [[#number-argument][Number Argument]] 15 | - [[#disabled-commands][Disabled Commands]] 16 | - [[#file-operations][File Operations]] 17 | - [[#buffer-operations][Buffer Operations]] 18 | - [[#window-management][Window Management]] 19 | - [[#search][Search]] 20 | * [[#configuration-file][Configuration File]] 21 | - [[#emacs-lisp][Emacs Lisp]] 22 | - [[#recommended-settings][Recommended Settings]] 23 | * [[#references][References]] 24 | * [[#license][License]] 25 | 26 | ** Contributors 27 | Thanks all contributors about this repository! (Rank order of contribution date) 28 | | Contributors | Emacs Configuration File Repository | 29 | |--------------+--------------------------------------| 30 | | [[https://github.com/KiteAB][KiteAB]] | [[https://github.com/KiteAB/.emacs.d][.emacs.d]] | 31 | 32 | Contributors must view [[./todo.org][todo.org]] then edit files. 33 | 34 | ** Basics in Basic 35 | In Emacs, we have a rule: 36 | | Keybindings | Means | 37 | |-------------+--------------------------------------------------------| 38 | | ~C-~ | Press control key when entering the ~~ character | 39 | | ~M-~ | Press alt key when entering the ~~ character | 40 | | ~s-~ | Press super key when entering the ~~ character | 41 | 42 | Example: 43 | #+begin_example 44 | C-f means press control and enter "f" character 45 | M-x means press alt and enter "x" character 46 | s-a means press super and enter "a" character (Seldom used) 47 | #+end_example 48 | 49 | And you sometimes encounter multiple consecutive key combinations, example: ~C-x C-c~ to exit the Emacs. 50 | 51 | If you want to exit some running command, use ~C-g~ to exit them. 52 | 53 | You can try press ~M-x~ key, It'll open a "toolbox", you can find all Emacs command in it. 54 | 55 | *** Explore Files 56 | You can use ~C-f~ ~C-b~ ~C-n~ ~C-p~ keybindings to move cursor slowly: 57 | | Keybindings | Actions | 58 | |-------------+-----------------| 59 | | ~C-f~ | Forward a char | 60 | | ~C-b~ | Backward a char | 61 | | ~C-n~ | Next line | 62 | | ~C-p~ | Previous line | 63 | 64 | ----- 65 | 66 | And you can use ~M-f~ ~M-b~ to move cursor by words: 67 | | Keybindings | Actions | 68 | |-------------+-----------------| 69 | | ~M-f~ | Forward a word | 70 | | ~M-b~ | Backward a word | 71 | 72 | ----- 73 | 74 | *What? Not fast enough?* Try page up or page down by ~C-v~ ~M-v~: 75 | | Keybindings | Actions | 76 | |-------------+-----------| 77 | | ~C-v~ | Page Down | 78 | | ~M-v~ | Page Up | 79 | (Alternatively, you can still use the ~~ and ~~ keys to page up and down) 80 | 81 | ----- 82 | 83 | If you want the current line in a different location on the screen, you can use ~C-l~: 84 | | Keybindings | Actions | 85 | |---------------------+------------------------------------------| 86 | | ~C-l~ (first time) | Re-center current line | 87 | | ~C-l~ (second time) | Put current line to top in the screen | 88 | | ~C-l~ (third time) | Put current line to bottom in the screen | 89 | 90 | ----- 91 | 92 | ~C-a~ ~C-e~ ~M-a~ ~M-e~ can help you fast move cursor to beginning of line or end of line, sentences can do that too: 93 | | Keybindings | Actions | 94 | |-------------+-----------------------| 95 | | ~C-a~ | Beginning of line | 96 | | ~C-e~ | End of line | 97 | | ~M-a~ | Beginning of sentence | 98 | | ~M-e~ | End of sentence | 99 | 100 | ----- 101 | 102 | And ~M-<~ ~M->~ is the fastest: 103 | | Keybindings | Actions | 104 | |-------------+---------------------| 105 | | ~M-<~ | Beginning of buffer | 106 | | ~M->~ | End of buffer | 107 | 108 | *** Number Argument 109 | You can add a number argument for some commands. 110 | | Keybindings | Actions | 111 | |-------------------+-------------------------------| 112 | | ~C-u ~ | Execute ~~ times ~~ | 113 | Here is an example: 114 | #+begin_example 115 | "C-u 8 C-n" means do "C-n" 8 times, which's cursor down 8 lines. 116 | "C-u 8 *" will insert "********" 117 | #+end_example 118 | 119 | *** Disabled Commands 120 | Emacs has some disabled commands, they're dangerous commands, so Emacs disabled it. 121 | 122 | If you press ~C-x C-n~, Emacs will create a buffer named ~*Disabled Command*~, and you can enter ~y~ to enable this command or ~n~ to continue disable it. 123 | 124 | *** File Operations 125 | | Keybindings | Actions | 126 | |-------------+------------------------------------------------------------------| 127 | | ~C-x C-s~ | Save current buffer to correspond file | 128 | | ~C-x s~ | Save multiple buffers to the corresponding file at the same time | 129 | | ~C-x C-f~ | Find a file and open it | 130 | 131 | *** Buffer Operations 132 | You must understand the difference between ~delete~ and ~remove~, ~delete~ is remove characters directly, but ~remove~ will cut the characters to clipboard, so you can recall it. 133 | | Keybindings | Actions | 134 | |------------------------+-----------------------------------------------------------------| 135 | | ~C-x b~ | Switch buffer | 136 | | ~C-x k~ | Kill buffer | 137 | | ~(DELETE key)~ | Delete a character before the cursor | 138 | | ~C-d~ or ~~ | Delete a character after the cursor | 139 | | ~M-~ | Remove a word before the cursor | 140 | | ~M-d~ | Remove a word after the cursor | 141 | | ~C-k~ | Remove from between the character cursor to the end of line | 142 | | ~M-k~ | Remove from between the character cursor to the end of sentence | 143 | | ~C-@~ or ~C-~ | Selecting characters | 144 | | ~M-w~ | Copy selected characters | 145 | | ~C-w~ | Cut selected characters | 146 | | ~C-y~ | Paste characters in clipboard | 147 | | ~C-k~ (first time) | Remove current line (Don't remove line breaks) | 148 | | ~C-k~ (second time) | Remove line breaks | 149 | | ~C-/~ or ~C-_~ | Undo or Redo | 150 | | ~C-x u~ | Undo only | 151 | 152 | *** Window Management 153 | You can use some keybindings to manage your windows in Emacs. 154 | | Keybindings | Actions | 155 | |-------------+-----------------------------------| 156 | | ~C-x 0~ | Close current window (Not buffer) | 157 | | ~C-x 1~ | Leaving only the current window | 158 | | ~C-x 2~ | Horizontal split a window | 159 | | ~C-x 3~ | Vertical split a window | 160 | | ~C-x o~ | Switch to next window | 161 | 162 | *** Search 163 | Use ~C-s~ to down search and ~C-r~ to up search. 164 | 165 | ** Configuration File 166 | In general, we need to configure the editing experience suited to their profiles to get better. 167 | 168 | Emacs configuration files are usually stored at home directory ~.emacs.d~ folder, the file structure similar to the following settings: 169 | #+begin_example 170 | - .emacs.d 171 | - init.el ; Emacs retrieves the file to launch the default 172 | - elpa ; Emacs will download the package in here 173 | - etc ; Although not required, it is recommended that the personal configuration file on here 174 | #+end_example 175 | 176 | *** Emacs Lisp 177 | To configure your own Emacs configuration file, you need to know what's Emacs Lisp and how to use it. 178 | 179 | Programming experts usually just look at the code fragment can probably understand a programming language: 180 | #+begin_src emacs-lisp 181 | (+ 1 1) ; 1 + 1 182 | (+ 1 2 (* 2 3)) ; 1 + 2 + ( 2 * 3 ) 183 | 184 | (setq name "Emacs Lisp") ; Variable 185 | (setq list '("1" "2" "3")) ; List 186 | (car list) ; First value extraction list 187 | (cdr list) ; Extracting all but the first value in the variable 188 | (add-to-list 'list "thing") 189 | (add-to-list 'load-path "path-to-path") ; Load Emacs Lisp files in path 190 | (require 'name) ; Require feature 191 | (provide 'name) ; Provide feature 192 | (push "thing" list) ; Push to list 193 | (defun hello (myname) ; Define function 194 | "Function's document" 195 | (message "Hello, %s!" myname)) ; Will display "Hello, Emacs Lisp!" at mini-buffer 196 | (hello name) ; Execute function 197 | #+end_src 198 | BTW: mini-buffer is a blank area below the status bar for displaying messages and documents. 199 | 200 | *** Recommended Settings 201 | #+begin_src emacs-lisp 202 | ;; UI Settings 203 | (menu-bar-mode -1) ; Close the menu bar 204 | (tool-bar-mode -1) ; Close the tool bar 205 | (setq tab-bar-show nil) ; Always not display tab bar 206 | (scroll-bar-mode -1) ; Close Scroll bar 207 | (tab-bar-mode -1) ; Set tab bar not display 208 | (global-hl-line-mode t) ; Highlight current line 209 | (setq display-line-numbers-type 'relative) ; Relative numbers for display numbers mode 210 | (global-display-line-numbers-mode t) ; Set the line numbers 211 | (toggle-frame-fullscreen) ; Set fullscreen 212 | (setq inhibit-splash-screen t) ; Close the startup screen 213 | 214 | ;; Other Basic Settings 215 | (fset 'yes-or-no-p 'y-or-n-p) ; Change the asking's answer way 216 | (show-paren-mode t) ; Highlight the "()" 217 | (electric-pair-mode t) ; Auto complete the "()" 218 | (setq electric-pair-pairs 219 | '((?\" . ?\") 220 | (?\( . ?\)) 221 | (?\< . ?\>) 222 | (?\{ . ?\}))) ; Set the electric-pair-mode's pair keywords 223 | (setq make-backup-files nil ; Don't let Emacs make up backup file 224 | create-lockfiles nil ;Don't make lockfile 225 | auto-save-default nil ; Don't auto save the file 226 | ) 227 | (setq-default tab-width 2) ; The tab width 228 | (setq-default indent-tabs-mode nil) ; Use space indent 229 | (setq user-emacs-directory "~/.emacs.d/var") ;;; The Cache Directory 230 | (setq user-init-file "~/.emacs.d/var/user-init.el") 231 | (save-place-mode t) ; Save the point position 232 | (setq ring-bell-function 'ignore blink-cursor-mode nil) ; Disable Infos 233 | (setq scroll-step 2 234 | scroll-margin 2 235 | hscroll-step 2 236 | hscroll-margin 2 237 | scroll-conservatively 101 238 | scroll-up-aggressively 0.01 239 | scroll-down-aggressively 0.01 240 | scroll-preserve-screen-position 'always) ; Scroll 241 | #+end_src 242 | 243 | ** References 244 | Emacs Tutorial: ~C-h t~ in Emacs, Emacs built-in tutorial 245 | 246 | Learn X in Y Minutes, X = Elisp: https://learnxinyminutes.com/docs/zh-cn/elisp-cn 247 | 248 | Recommended Settings: https://github.com/SpringHan/.emacs.d/blob/master/etc/settings/init-basic.el 249 | 250 | ** License 251 | GPL-3.0 252 | -------------------------------------------------------------------------------- /README_cn.org: -------------------------------------------------------------------------------- 1 | * Emacs 教程 2 | 此仓库储存了 GNU/Emacs 的基础用法和工作室成员的个人经验. 3 | 4 | *注意*: 多练习而不只是看着这些句子, 它能帮助你更快地学习! 5 | 6 | *注意x2*: Emacs 文档是你的好朋友, ~C-h f~ 是函数文档, ~C-h v~ 是变量文档, ~C-h k~ 是快捷键文档. 7 | 8 | [[./README.org][English version]] 9 | 10 | ** 目录 11 | * [[#贡献名单][贡献名单]] 12 | * [[#基础中的基础][基础中的基础]] 13 | - [[#浏览文件][浏览文件]] 14 | - [[#数字参数][数字参数]] 15 | - [[#被关闭的命令][被关闭的命令]] 16 | - [[#文件操作][文件操作]] 17 | - [[#缓冲区操作][缓冲区操作]] 18 | - [[#窗口管理][窗口管理]] 19 | - [[#搜索][搜索]] 20 | * [[#配置文件][配置文件]] 21 | - [[#emacs-lisp][Emacs Lisp]] 22 | - [[#推荐的设置项][推荐的设置项]] 23 | * [[#参考文献][参考文献]] 24 | * [[#开源协议][开源协议]] 25 | 26 | ** 贡献名单 27 | 感谢所有为本仓库做出贡献的贡献者! (排名按照贡献的时间顺序排列) 28 | | 贡献者 | Emacs 配置文件仓库 | 29 | |--------+--------------------| 30 | | [[https://github.com/KiteAB][KiteAB]] | [[https://github.com/KiteAB/.emacs.d][.emacs.d]] | 31 | 32 | 贡献者们必须浏览 [[./todo.org][todo.org]] 再修改文件. 33 | 34 | ** 基础中的基础 35 | 在 Emacs 中, 我们有一条规定: 36 | | 快捷键 | 意义 | 37 | |------------+--------------------------------| 38 | | ~C-<字符>~ | 在输入 ~<字符>~ 时按住 Control | 39 | | ~M-<字符>~ | 在输入 ~<字符>~ 时按住 Alt | 40 | | ~s-<字符>~ | 在输入 ~<字符>~ 时按住 Super | 41 | 42 | 例: 43 | #+begin_example 44 | C-f 的意思是按下 Control 再输入 "f" 字符 45 | M-x 的意思是按下 Alt 再输入 "x" 字符 46 | s-a 的意思是按下 Super 再输入 "a" 字符 (不常用) 47 | #+end_example 48 | 49 | 有时候你会遇到多个快捷键的组合, 例如: ~C-x C-c~ 用于退出 Emacs. 50 | 51 | 如果你需要退出一些正在运行的指令, 使用 ~C-g~ 来退出它们. 52 | 53 | 你可以尝试按下 ~M-x~ 键, 它将会打开一个 "工具箱", 你可以在里面找到所有的 Emacs 指令. 54 | 55 | *** 浏览文件 56 | 你可以使用 ~C-f~ ~C-b~ ~C-n~ ~C-p~ 快捷键来缓慢地移动光标: 57 | | 快捷键 | 作用 | 58 | |--------+----------------| 59 | | ~C-f~ | 向后移一个字符 | 60 | | ~C-b~ | 向前移一个字符 | 61 | | ~C-n~ | 向下移一行 | 62 | | ~C-p~ | 向上移一行 | 63 | 64 | ----- 65 | 66 | 然后你可以使用 ~M-f~ ~M-b~ 以单词为单位移动光标: 67 | | 快捷键 | 作用 | 68 | |--------+----------------| 69 | | ~M-f~ | 向后移一个单词 | 70 | | ~M-b~ | 向前移一个单词 | 71 | 72 | ----- 73 | 74 | *什么? 还不够快?* 试试用 ~C-v~ ~M-v~ 向上翻页或向下翻页: 75 | | 快捷键 | 作用 | 76 | |--------+----------| 77 | | ~C-v~ | 向下翻译 | 78 | | ~M-v~ | 向上翻页 | 79 | (或者你仍然可以使用 ~~ 和 ~~ 键进行翻页) 80 | 81 | ----- 82 | 83 | 如果你想要使当前行在屏幕上的不同位置, 你可以使用 ~C-l~: 84 | | 快捷键 | 作用 | 85 | |----------------+------------------------| 86 | | ~C-l~ (第一次) | 将当前行放至屏幕正中间 | 87 | | ~C-l~ (第二次) | 将当前行放至屏幕最上方 | 88 | | ~C-l~ (第三次) | 将当前行放至屏幕最下方 | 89 | 90 | ----- 91 | 92 | ~C-a~ ~C-e~ ~M-a~ ~M-e~ 能帮你快速将光标移至行首或行尾, 句子也行: 93 | | 快捷键 | 作用 | 94 | |--------+------------| 95 | | ~C-a~ | 跳转至行首 | 96 | | ~C-e~ | 跳转至行尾 | 97 | | ~M-a~ | 跳转至句首 | 98 | | ~M-e~ | 跳转至句尾 | 99 | 100 | ----- 101 | 102 | 然后 ~M-<~ ~M->~ 是最快的移动光标的方式: 103 | | 快捷键 | 作用 | 104 | |--------+----------------| 105 | | ~M-<~ | 跳转至缓冲区开头 | 106 | | ~M->~ | 跳转至缓冲区末尾 | 107 | 108 | *** 数字参数 109 | 你可以为一些命令添加数字参数. 110 | | 快捷键 | 作用 | 111 | |---------------------+---------------------------| 112 | | ~C-u <次数> <命令>~ | 执行 ~<次数>~ 遍 ~<命令>~ | 113 | 这里是一个例子: 114 | #+begin_example 115 | "C-u 8 C-n" 的意思是执行 8 次 "C-n", 也就是让光标向下移动 8 行. 116 | "C-u 8 *" 将会插入 "********" 117 | #+end_example 118 | 119 | *** 被关闭的命令 120 | Emacs 有一些被关闭的命令, 它们都较为危险, 所以 Emacs 关闭了它们. 121 | 122 | 如果你按下了 ~C-x C-n~, Emacs 将会创建一个名为 ~*Disabled Command*~ 的缓冲区, 然后你可以输入 ~y~ 来打开这个命令或输入 ~n~ 来保持关闭它. 123 | 124 | *** 文件操作 125 | | 快捷键 | 作用 | 126 | |-----------+--------------------------| 127 | | ~C-x C-s~ | 保存当前缓冲区至对应文件 | 128 | | ~C-x s~ | 保存所有缓冲区至对应文件 | 129 | | ~C-x C-f~ | 查找文件并打开它 | 130 | 131 | *** 缓冲区操作 132 | 你必须知道 ~删除~ 和 ~移除~ 的区别, ~删除~ 会直接删除字符, 但 ~移除~ 会剪切字符至剪切板, 所以你可以找回它. 133 | | 快捷键 | 作用 | 134 | |------------------------+----------------------------| 135 | | ~C-x b~ | 跳转缓冲区 | 136 | | ~C-x k~ | 关闭缓冲区 | 137 | | ~(DELETE 键)~ | 删除光标前的一个字符 | 138 | | ~C-d~ 或 ~~ | 删除光标后的一个字符 | 139 | | ~M-~ | 移除光标前的一个单词 | 140 | | ~M-d~ | 移除光标后的一个单词 | 141 | | ~C-k~ | 移除光标处至行尾的所有字符 | 142 | | ~M-k~ | 移除光标处至行首的所有字符 | 143 | | ~C-@~ 或 ~C-~ | 选择字符 | 144 | | ~M-w~ | 复制选择的字符 | 145 | | ~C-w~ | 剪切选择的字符 | 146 | | ~C-y~ | 粘贴剪切板中的字符 | 147 | | ~C-k~ (第一次) | 移除当前行 (不移除换行符) | 148 | | ~C-k~ (第二次) | 移除换行符 | 149 | | ~C-/~ 或 ~C-_~ | 撤回或重做 | 150 | | ~C-x u~ | 仅撤回 | 151 | 152 | *** 窗口管理 153 | 你可以使用一些快捷键来管理你在 Emacs 中的窗口. 154 | | 快捷键 | 作用 | 155 | |---------+-------------------------| 156 | | ~C-x 0~ | 关闭当前窗口 (非缓冲区) | 157 | | ~C-x 1~ | 只保留当前窗口 | 158 | | ~C-x 2~ | 水平分裂出一个窗口 | 159 | | ~C-x 3~ | 垂直分裂出一个窗口 | 160 | | ~C-x o~ | 跳转至下一个窗口 | 161 | 162 | *** 搜索 163 | 使用 ~C-s~ 向下搜索, ~C-r~ 为向上搜索. 164 | 165 | ** 配置文件 166 | 通常, 我们需要配置出适合自己的配置文件以获得更好的编辑体验. 167 | 168 | Emacs 的配置文件通常存放在家目录的 ~.emacs.d~ 文件夹下, 里面的文件结构通常如下: 169 | #+begin_example 170 | - .emacs.d 171 | - init.el ; Emacs 默认会寻找此文件并加载 172 | - elpa ; Emacs 将把下载的包裹放在此处 173 | - etc ; 虽然不要求, 但推荐将个人配置放在此处 174 | #+end_example 175 | 176 | *** Emacs Lisp 177 | 要配置出自己的配置文件, 你需要知道什么是 Emacs Lisp 以及如何使用它. 178 | 179 | 编程高手通常只需要阅读示例代码就能大概知道一个编程语言的基本语法. 180 | #+begin_src emacs-lisp 181 | (+ 1 1) ; 1 + 1 182 | (+ 1 2 (* 2 3)) ; 1 + 2 + ( 2 * 3 ) 183 | 184 | (setq name "Emacs Lisp") ; 变量 185 | (setq list '("1" "2" "3")) ; 列表 186 | (car list) ; 提取列表的第一个值 187 | (cdr list) ; 提取列表除第一个以外的值 188 | (add-to-list 'list '("Things")) 189 | (add-to-list 'load-path "path-to-path") ; 加载文件夹中的 Emacs Lisp 文件 190 | (require 'name) ; 引用功能 191 | (provide 'name) ; 提供功能 192 | (push "thing" list) ; 推送到列表 193 | (defun hello (myname) ; 定义函数 194 | "函数文档" 195 | (message "Hello, %s!" myname)) ; 将会在 mini-buffer 中显示 "Hello, Emacs Lisp!" 196 | (hello name) ; 执行函数 197 | #+end_src 198 | 顺便说一句: mini-buffer 是一块在状态栏之下的空白区域, 用于显示输出信息和基本文档. 199 | 200 | *** 推荐设置 201 | #+begin_src emacs-lisp 202 | ;; UI 设置 203 | (menu-bar-mode -1) ; 关闭菜单栏 204 | (tool-bar-mode -1) ; 关闭工具栏 205 | (setq tab-bar-show nil) ; 关闭顶栏 206 | (scroll-bar-mode -1) ; 关闭滚动条 207 | (tab-bar-mode -1) ; 关闭顶栏 208 | (global-hl-line-mode t) ; 高亮当前行 209 | (setq display-line-numbers-type 'relative) ; 为 display-line-numbers-mode 使用相对行号 210 | (global-display-line-numbers-mode t) ; 打开行号 211 | (toggle-frame-fullscreen) ; 全屏 212 | (setq inhibit-splash-screen t) ; 关闭启动界面 213 | 214 | ;; 其它基本设置 215 | (fset 'yes-or-no-p 'y-or-n-p) ; 切换回答是否的方式 216 | (show-paren-mode t) ; 高亮 "()" 217 | (electric-pair-mode t) ; 自动补全 "()" 218 | (setq electric-pair-pairs 219 | '((?\" . ?\") 220 | (?\( . ?\)) 221 | (?\< . ?\>) 222 | (?\{ . ?\}))) ; 设置括号补全的匹配规则 223 | (setq make-backup-files nil ; 不生成备份文件 224 | create-lockfiles nil ; 不生成锁文件 225 | auto-save-default nil ; 关闭自动保存 226 | ) 227 | (setq-default tab-width 2) ; 制表符长度 228 | (setq-default indent-tabs-mode nil) ; 使用空格缩进 229 | (setq user-emacs-directory "~/.emacs.d/var") ;;; 缓存文件夹 230 | (setq user-init-file "~/.emacs.d/var/user-init.el") 231 | (save-place-mode t) ; 在下一次打开文件时恢复上次的光标位置 232 | (setq ring-bell-function 'ignore blink-cursor-mode nil) ; 关闭提示信息 233 | (setq scroll-step 2 234 | scroll-margin 2 235 | hscroll-step 2 236 | hscroll-margin 2 237 | scroll-conservatively 101 238 | scroll-up-aggressively 0.01 239 | scroll-down-aggressively 0.01 240 | scroll-preserve-screen-position 'always) ; 翻页设置 241 | #+end_src 242 | 243 | ** 参考文献 244 | Emacs 教程: 在 Emacs 中按 ~C-h t~, Emacs 内置基础教程 245 | 246 | Y 分钟速成 X, 其中 X = Elisp: https://learnxinyminutes.com/docs/zh-cn/elisp-cn 247 | 248 | 推荐设置: https://github.com/SpringHan/.emacs.d/blob/master/etc/settings/init-basic.el 249 | 250 | ** 开源协议 251 | GPL-3.0 252 | -------------------------------------------------------------------------------- /todo.org: -------------------------------------------------------------------------------- 1 | * Emacs Guides - Todolist 2 | Contributors need to view this file. 3 | 4 | Update at any time. 5 | 6 | ----- 7 | 8 | - Recommended settings 9 | - Configure your own configuration file 10 | --------------------------------------------------------------------------------