├── .gitignore ├── README.md ├── evil-tutor.el ├── tutor.txt └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled 2 | *.elc 3 | 4 | # Packaging 5 | .cask 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # evil-tutor 2 | [![MELPA](http://melpa.org/packages/evil-tutor-badge.svg)](http://melpa.org/#/evil-tutor) [![MELPA Stable](http://stable.melpa.org/packages/evil-tutor-badge.svg)](http://stable.melpa.org/#/evil-tutor) 3 | 4 | 5 | **Table of Contents** 6 | 7 | - [evil-tutor](#evil-tutor) 8 | - [Description](#description) 9 | - [Quick start](#quick-start) 10 | - [Install](#install) 11 | - [Package manager](#package-manager) 12 | - [Manually](#manually) 13 | - [Acknowledgement](#acknowledgement) 14 | 15 | 16 | 17 | ## Description 18 | 19 | Vimtutor adapted for Evil and wrapped in a major mode. 20 | 21 | Features: 22 | - restore last working file 23 | - fast navigation between lessons with `C-j` and `C-k` 24 | 25 | ## Quick start 26 | 27 | M-x evil-tutor-start 28 | 29 | This will create a working file in `evil-tutor-working-directory` (defaults 30 | to `~/.emacs.d/.tutor`) 31 | 32 | ## Install 33 | 34 | ### Package manager 35 | 36 | You can either install `evil-tutor` from [MELPA][] (_available soon_): 37 | 38 | ``` 39 | M-x package-install evil-tutor 40 | ``` 41 | 42 | Or add it to your `Cask` file: 43 | 44 | ```elisp 45 | (source melpa) 46 | 47 | (depends-on "evil-tutor") 48 | ``` 49 | 50 | ### Manually 51 | 52 | Add `evil-tutor.el` to your load path. `evil-tutor` requires `evil` to be 53 | installed. 54 | 55 | ## Acknowledgement 56 | 57 | This major-mode has been inspired by a [post][] on [/r/emacs][]. 58 | 59 | [MELPA]: http://melpa.org/ 60 | [/r/emacs]: http://www.reddit.com/r/emacs/ 61 | [post]: http://redd.it/2r1g3d 62 | -------------------------------------------------------------------------------- /evil-tutor.el: -------------------------------------------------------------------------------- 1 | ;;; evil-tutor.el --- Vimtutor adapted to Evil and wrapped in a major-mode 2 | 3 | ;; Copyright (C) 2015 syl20bnr 4 | ;; 5 | ;; Author: Sylvain Benner 6 | ;; Keywords: convenience editing evil 7 | ;; Created: 1 Jan 2015 8 | ;; Version: 0.1 9 | ;; Package-Requires: ((evil "1.0.9")) 10 | ;; URL: https://github.com/syl20bnr/evil-tutor 11 | 12 | ;; This file is not part of GNU Emacs. 13 | 14 | ;; This program is free software; you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published by 16 | ;; the Free Software Foundation, either version 3 of the License, or 17 | ;; (at your option) any later version. 18 | 19 | ;; This program is distributed in the hope that it will be useful, 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | ;; GNU General Public License for more details. 23 | 24 | ;; You should have received a copy of the GNU General Public License 25 | ;; along with this program. If not, see . 26 | 27 | ;;; Commentary: 28 | 29 | ;; Vimtutor adapted for Evil. 30 | 31 | ;; M-x evil-tutor-start 32 | 33 | ;; This will create a working file in `evil-tutor-working-directory' (defaults 34 | ;; to `~/.emacs.d/.tutor') 35 | 36 | ;; Features: 37 | ;; - restore last working file 38 | ;; - fast navigation between lessons with `C-j' and `C-k' 39 | 40 | ;;; Code: 41 | 42 | (require 'evil) 43 | 44 | (defcustom evil-tutor-working-directory 45 | (file-name-as-directory (expand-file-name ".tutor" user-emacs-directory)) 46 | "The directory where to create working files." 47 | :type 'string 48 | :group 'evil) 49 | 50 | (define-derived-mode evil-tutor-mode text-mode "evil-tutor" 51 | "Major mode for evil-tutor.") 52 | 53 | ;;;###autoload 54 | (defun evil-tutor-start () 55 | "Start a evil-tutor session." 56 | (interactive) 57 | (evil-tutor--restore-or-create-working-file) 58 | (evil-tutor-mode) 59 | (evil-mode)) 60 | 61 | ;;;###autoload 62 | (defalias 'evil-tutor-resume 'evil-tutor-start) 63 | 64 | (set-keymap-parent evil-tutor-mode-map text-mode-map) 65 | (define-key evil-tutor-mode-map (kbd "C-j") 'evil-tutor-goto-next-lesson) 66 | (define-key evil-tutor-mode-map (kbd "C-k") 'evil-tutor-goto-previous-lesson) 67 | 68 | (defun evil-tutor--restore-or-create-working-file () 69 | "Create a new working buffer and save it in `evil-tutor-working-directory'. 70 | 71 | If a working file already exists in `evil-tutor-working-directory' then the 72 | found file is visited instead of creating a brand new buffer. 73 | 74 | For now the point location is not saved but this is a functionality which can 75 | be handled by minor modes." 76 | (let* ((files (if (file-exists-p evil-tutor-working-directory) 77 | (directory-files evil-tutor-working-directory t nil t))) 78 | (previous-file (evil-tutor--find-first-working-file files))) 79 | (message "load: %s" (symbol-file 'evil-tutor-mode)) 80 | (if previous-file 81 | (find-file-literally previous-file) 82 | (let* ((date (format-time-string "%d%m%Y")) 83 | (working-file-name (format "evil-tutor-%s.txt" date)) 84 | (tutor-file (concat (file-name-directory (symbol-file 85 | 'evil-tutor-mode)) 86 | "tutor.txt"))) 87 | (switch-to-buffer (get-buffer-create "working-file-name")) 88 | (set-visited-file-name (concat evil-tutor-working-directory 89 | working-file-name)) 90 | (insert-file-contents tutor-file) 91 | (make-directory evil-tutor-working-directory 'parents) 92 | (save-buffer 0))))) 93 | 94 | (defun evil-tutor--find-first-working-file (files) 95 | "Return the first saved working file or nil if there is no such file. 96 | 97 | This function expects full path for each file in FILES." 98 | (when files 99 | (catch 'break 100 | (dolist (f files) 101 | (if (string= ".txt" (file-name-extension f 'period)) 102 | (throw 'break f))) 103 | nil))) 104 | 105 | (defun evil-tutor-goto-next-lesson (&optional arg) 106 | "Move the next lesson. 107 | 108 | If ARG is nil then move to the next lesson, 109 | If ARG is positive then move the ARGth version after the current one, 110 | If ARG is negative then move the ARGth version before the current one." 111 | (interactive "p") 112 | (let ((i 0) 113 | (regexp "^~.*~$") 114 | (count (if arg (abs arg) 1)) 115 | (recenter-positions '(top))) 116 | (dotimes (i count) 117 | (if (or (not arg) 118 | (> arg 0)) 119 | (re-search-forward regexp (buffer-end 1) 'noerror) 120 | (re-search-backward regexp (buffer-end -1) 'noerror))) 121 | (beginning-of-line) 122 | (next-line) 123 | (recenter-top-bottom))) 124 | 125 | (defun evil-tutor-goto-previous-lesson (&optional arg) 126 | "Move to the previous lession. 127 | 128 | If ARG is nil then move to the previous lesson. 129 | If ARG is positive then move to the ARGth lesson before the current one." 130 | (interactive "p") 131 | ;; -1 because we have to skip the current lesson 132 | (evil-tutor-goto-next-lesson (- (if arg (- (abs arg)) -1) 1))) 133 | 134 | (provide 'evil-tutor) 135 | 136 | ;;; evil-tutor.el ends here 137 | -------------------------------------------------------------------------------- /tutor.txt: -------------------------------------------------------------------------------- 1 | =============================================================================== 2 | = W e l c o m e t o t h e E m a c s E v i l T u t o r = 3 | = = 4 | = * * * = 5 | = = 6 | = Version 1.0 = 7 | =============================================================================== 8 | 9 | TL;DR: press C-j (CTRL+j) to jump right to the first lesson. The 10 | tutorial takes approximately 30 minutes. 11 | 12 | At any moment if you feel stuck, you can switch to emacs state with: 13 | 14 | M-x evil-emacs-state RET 15 | 16 | Then continue the tutorial by going back to the normal state with: 17 | 18 | M-x evil-normal-state RET 19 | 20 | * * * 21 | 22 | Evil is a very powerful emulation of Vim that has many commands, 23 | too many to explain in a tutor such as this. This tutor is designed 24 | to describe enough of the commands that you will be able to easily use 25 | Emacs powered with Evil as an all-purpose editor. 26 | 27 | The approximate time required to complete the tutor is 25-30 minutes, 28 | depending upon how much time is spent with experimentation. 29 | 30 | The commands in the lessons will modify the text. Make a copy of this 31 | file to practise on (if you started "evil-tutor-mode" this is already a 32 | copy). 33 | 34 | It is important to remember that this tutor is set up to teach by 35 | use. That means that you need to execute the commands to learn them 36 | properly. If you only read the text, you will forget the commands! 37 | 38 | Now, make sure that your Shift-Lock key is NOT depressed and press 39 | the j key enough times to move the cursor so that Lesson 1.1 completely 40 | fills the screen. 41 | 42 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 43 | Lesson 1.1: MOVING THE CURSOR 44 | 45 | 46 | ** To move the cursor, press the h,j,k,l keys as indicated. ** 47 | ^ 48 | k Hint: The h key is at the left and moves left. 49 | < h l > The l key is at the right and moves right. 50 | j The j key looks like a down arrow 51 | v 52 | 1. Move the cursor around the screen until you are comfortable. 53 | 54 | 2. Hold down the down key (j) until it repeats. 55 | ---> Now you know how to move to the next lesson 56 | 57 | 3. Using the down key, move to Lesson 1.2. 58 | 59 | Note: If you are ever unsure about something you typed, press to place 60 | you in normal state. Then retype the command you wanted. 61 | 62 | Note: The cursor keys should also work. But using hjkl you will be able to 63 | move around much faster, once you get used to it. 64 | 65 | 66 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 67 | Lesson 1.2: ENTERING AND EXITING EMACS 68 | 69 | 70 | !! NOTE: Before executing any of the steps below, read this entire lesson!! 71 | 72 | 1. Press the key (to make sure you are in normal state). 73 | 74 | 2. Type: :qa! . 75 | 76 | ---> This exits the editor WITHOUT saving any changes you have made. 77 | If you want to save the changes and exit type: 78 | :wqa 79 | 80 | 3. When you see the shell prompt, return in Emacs and resume your tutorial 81 | session by typing: 82 | M-x evil-tutor-start 83 | 84 | 4. If you have these steps memorized and are confident, execute steps 85 | 1 through 3 to exit and re-enter the editor. Then move the cursor down 86 | to Lesson 1.3. 87 | 88 | 89 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 90 | Lesson 1.3: TEXT EDITING - DELETION 91 | 92 | 93 | ** While in normal state press x to delete the character under the cursor. ** 94 | 95 | 1. Move the cursor to the line below marked --->. 96 | 97 | 2. To fix the errors, move the cursor until it is on top of the 98 | character to be deleted. 99 | 100 | 3. Press the x key to delete the unwanted character. 101 | 102 | 4. Repeat steps 2 through 4 until the sentence is correct. 103 | 104 | ---> The ccow jumpedd ovverr thhe mooon. 105 | 106 | 5. Now that the line is correct, go on to Lesson 1.4. 107 | 108 | NOTE: As you go through this tutor, do not try to memorize, learn by usage. 109 | 110 | 111 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 112 | Lesson 1.4: TEXT EDITING - INSERTION 113 | 114 | 115 | ** While in normal state press i to insert text. ** 116 | 117 | 1. Move the cursor to the first line below marked --->. 118 | 119 | 2. To make the first line the same as the second, move the cursor on top 120 | of the first character AFTER where the text is to be inserted. 121 | 122 | 3. Press i and type in the necessary additions. 123 | 124 | 4. As each error is fixed press to return to normal state. 125 | Repeat steps 2 through 4 to correct the sentence. 126 | 127 | ---> There is text misng this . 128 | ---> There is some text missing from this line. 129 | 130 | 5. When you are comfortable inserting text move to the summary below. 131 | 132 | 133 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 134 | LESSON 1 SUMMARY 135 | 136 | 137 | 1. The cursor is moved using either the arrow keys or the hjkl keys. 138 | h (left) j (down) k (up) l (right) 139 | 140 | 2. To exit Emacs type: :qa! to trash all changes. 141 | OR type: :wqa to save the changes. 142 | 143 | 4. To delete a character under the cursor in normal state type: x 144 | 145 | 5. To insert text at the cursor while in normal state type: 146 | i 147 | type in text 148 | 149 | 150 | NOTE: Pressing will place you in normal state or will cancel 151 | an unwanted and partially completed command. 152 | 153 | Now continue with Lesson 2. 154 | 155 | 156 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 157 | Lesson 2.1: DELETION COMMANDS 158 | 159 | 160 | ** Type dw to delete to the end of a word. ** 161 | 162 | 1. Press to make sure you are in normal state. 163 | 164 | 2. Move the cursor to the line below marked --->. 165 | 166 | 3. Move the cursor to the beginning of a word that needs to be deleted. 167 | 168 | 4. Type dw to make the word disappear. 169 | 170 | NOTE: The letters dw will appear on the last line of the screen as you type 171 | them. If you typed something wrong, press and start over. 172 | 173 | ---> There are a some words fun that don't belong paper in this sentence. 174 | 175 | 5. Repeat steps 3 and 4 until the sentence is correct and go to Lesson 2.2. 176 | 177 | 178 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 179 | Lesson 2.2: MORE DELETION COMMANDS 180 | 181 | 182 | ** Type d$ to delete to the end of the line. ** 183 | 184 | 1. Press to make sure you are in normal state. 185 | 186 | 2. Move the cursor to the line below marked --->. 187 | 188 | 3. Move the cursor to the end of the correct line (AFTER the first . ). 189 | 190 | 4. Type d$ to delete to the end of the line. 191 | 192 | ---> Somebody typed the end of this line twice. end of this line twice. 193 | 194 | 195 | 5. Move on to Lesson 2.3 to understand what is happening. 196 | 197 | 198 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 199 | Lesson 2.3: ON COMMANDS AND OBJECTS 200 | 201 | 202 | The format for the d delete command is as follows: 203 | 204 | [number] d object OR d [number] object 205 | 206 | Where: 207 | number - is how many times to execute the command (optional, default=1). 208 | d - is the command to delete. 209 | object - is what the command will operate on (listed below). 210 | 211 | A short list of objects: 212 | w - from the cursor to the end of the word, including the space. 213 | e - from the cursor to the end of the word, NOT including the space. 214 | $ - from the cursor to the end of the line. 215 | 216 | NOTE: For the adventurous, pressing just the object while in normal state 217 | without a command will move the cursor as specified in the object list. 218 | 219 | 220 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 221 | Lesson 2.4: AN EXCEPTION TO 'COMMAND-OBJECT' 222 | 223 | 224 | ** Type dd to delete a whole line. ** 225 | 226 | Due to the frequency of whole line deletion, the designers of Evil (credits 227 | to designers of Vim) decided it would be easier to simply type two d's in a 228 | row to delete a line. 229 | 230 | 1. Move the cursor to the second line in the phrase below. 231 | 2. Type dd to delete the line. 232 | 3. Now move to the fourth line. 233 | 4. Type 2dd (remember number-command-object) to delete the two lines. 234 | 235 | 1) Roses are red, 236 | 2) Mud is fun, 237 | 3) Violets are blue, 238 | 4) I have a car, 239 | 5) Clocks tell time, 240 | 6) Sugar is sweet 241 | 7) And so are you. 242 | 243 | 244 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 245 | Lesson 2.5: THE UNDO COMMAND 246 | 247 | 248 | ** Press u to undo the last commands ** 249 | 250 | 1. Move the cursor to the line below marked ---> and place it on the 251 | first error. 252 | 2. Type x to delete the first unwanted character. 253 | 3. Now type u to undo the last command executed. 254 | 4. This time fix all the errors on the line using the x command. 255 | 5. Now type u a few times to undo all the preceding commands. 256 | 6. Now type CTRL-R (keeping CTRL key pressed while hitting R) a few times 257 | to redo the commands (undo the undo's). 258 | 259 | ---> Fiix the errors oon thhis line and reeplace them witth undo. 260 | 261 | 8. These are very useful commands. Now move on to the Lesson 2 Summary. 262 | 263 | 264 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 265 | LESSON 2 SUMMARY 266 | 267 | 268 | 1. To delete from the cursor to the end of a word type: dw 269 | 270 | 2. To delete from the cursor to the end of a line type: d$ 271 | 272 | 3. To delete a whole line type: dd 273 | 274 | 4. The format for a command in normal state is: 275 | 276 | [number] command object OR command [number] object 277 | where: 278 | number - is how many times to repeat the command 279 | command - is what to do, such as d for delete 280 | object - is what the command should act upon, such as w for word, 281 | $ for "to the end of line", etc. 282 | 283 | 5. To undo previous actions, type: u 284 | To undo the undo's type: CTRL-R 285 | 286 | 287 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 288 | Lesson 3.1: THE PUT COMMAND 289 | 290 | 291 | ** Type p to put the last deletion after the cursor. ** 292 | 293 | 1. Move the cursor to the first line in the set below. 294 | 295 | 2. Type dd to delete the line and store it in Emacs's kill ring. 296 | 297 | 3. Move the cursor to the line ABOVE where the deleted line should go. 298 | 299 | 4. While in normal state, type p to replace the line. 300 | 301 | 5. Repeat steps 2 through 4 to put all the lines in correct order. 302 | 303 | d) Can you learn too? 304 | b) Violets are blue, 305 | c) Intelligence is learned, 306 | a) Roses are red, 307 | 308 | 309 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 310 | Lesson 3.2: THE REPLACE COMMAND 311 | 312 | 313 | ** Type r and a character to replace the character under the cursor. ** 314 | 315 | 1. Move the cursor to the first line below marked --->. 316 | 317 | 2. Move the cursor so that it is on top of the first error. 318 | 319 | 3. Type r and then the character which should replace the error. 320 | 321 | 4. Repeat steps 2 and 3 until the first line is correct. 322 | 323 | ---> Whan this lime was tuoed in, someone presswd some wrojg keys! 324 | ---> When this line was typed in, someone pressed some wrong keys! 325 | 326 | 5. Now move on to Lesson 3.2. 327 | 328 | NOTE: Remember that you should be learning by use, not memorization. 329 | 330 | 331 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 332 | Lesson 3.3: THE CHANGE COMMAND 333 | 334 | 335 | ** To change part or all of a word, type cw ** 336 | 337 | 1. Move the cursor to the first line below marked --->. 338 | 339 | 2. Place the cursor on the u in lubw. 340 | 341 | 3. Type cw and the correct word (in this case, type 'ine'.) 342 | 343 | 4. Press and move to the next error (the first character to be changed.) 344 | 345 | 5. Repeat steps 3 and 4 until the first sentence is the same as the second. 346 | 347 | ---> This lubw has a few wptfd that mrrf changing usf the change command. 348 | ---> This line has a few words that need changing using the change command. 349 | 350 | Notice that cw not only replaces the word, but also places you in insert. 351 | 352 | 353 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 354 | Lesson 3.4: MORE CHANGES USING c 355 | 356 | 357 | ** The change command is used with the same objects as delete. ** 358 | 359 | 1. The change command works in the same way as delete. The format is: 360 | 361 | [number] c object OR c [number] object 362 | 363 | 2. The objects are also the same, such as w (word), $ (end of line) etc... 364 | 365 | 3. Move to the first line below marked --->. 366 | 367 | 4. Move the cursor to the first error. 368 | 369 | 5. Type c$ to make the rest of the line like the second and press . 370 | 371 | ---> The end of this line needs some help to make it like the second. 372 | ---> The end of this line needs to be corrected using the c$ command. 373 | 374 | 375 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 376 | LESSON 3 SUMMARY 377 | 378 | 379 | 1. To replace text that has already been deleted, type p this puts the 380 | deleted text AFTER the cursor (if a line was deleted it will go on the 381 | line below the cursor). 382 | 383 | 2. To replace the character under the cursor, type r and then the 384 | character which will replace the original. 385 | 386 | 3. The change command allows you to change the specified object from the 387 | cursor to the end of the object. eg. Type cw to change from the 388 | cursor to the end of the word, c$ to change to the end of a line. 389 | 390 | 4. The format for change is: 391 | 392 | [number] c object OR c [number] object 393 | 394 | Now go on to the next lesson. 395 | 396 | 397 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 398 | Lesson 4.1: FAST MOVE IN A BUFFER 399 | 400 | 401 | ** Type gg to go to the beginning of a buffer. 402 | Type G to move to the end of a buffer. ** 403 | 404 | Note: Read this entire lesson before executing any of the steps!! 405 | 406 | 1. Remember the current line number where you are for Step 4. 407 | 408 | 2. Press G to move you to the bottom of the buffer. 409 | 410 | 3. Press gg to move you to the beginning of the buffer. 411 | 412 | 4. Type : and the number of the line you were on and then .This 413 | will return you to the line you were on before the step 2. 414 | 415 | 5. If you feel confident to do this, execute steps 1 through 3. 416 | 417 | 418 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 419 | Lesson 4.2: THE SEARCH COMMAND 420 | 421 | 422 | ** Type / followed by a phrase to search for the phrase. ** 423 | 424 | 1. In normal state type the / character. Notice that it and the cursor 425 | appear at the bottom of the screen as with the : command. 426 | 427 | 2. Now type 'errroor' . This is the word you want to search for. 428 | 429 | 3. To search for the same phrase again, simply type: n 430 | To search for the same phrase in the opposite direction, type: N 431 | 432 | 4. If you want to search for a phrase in the backwards direction, use the 433 | command ? instead of / 434 | 435 | ---> When the search reaches the end of the buffer it will continue at the start. 436 | 437 | "errroor" is not the way to spell error; errroor is an error. 438 | 439 | 440 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 441 | Lesson 4.3: MATCHING PARENTHESES SEARCH 442 | 443 | 444 | ** Type % to find a matching ),], or } ** 445 | 446 | 1. Place the cursor on any (, [, or { in the line below marked --->. 447 | 448 | 2. Now type the % character. 449 | 450 | 3. The cursor should be on the matching parenthesis or bracket. 451 | 452 | 4. Type % to move the cursor back to the first bracket (by matching). 453 | 454 | ---> This ( is a test line with ('s, ['s ] and {'s } in it. )) 455 | 456 | Note: This is very useful in debugging a program with unmatched parentheses 457 | (and in elisp)! 458 | 459 | 460 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 461 | Lesson 4.4: A WAY TO CHANGE ERRORS 462 | 463 | 464 | ** Type :s/old/new/g to substitute 'new' for 'old'. ** 465 | 466 | 1. Move the cursor to the line below marked --->. 467 | 468 | 2. Type :s/thee/the 469 | Note that this command only changes the first occurrence on the line. 470 | 471 | 3. Now type :s/thee/the/g meaning substitute globally on the line. 472 | This changes all occurrences on the line. 473 | 474 | ---> thee best time to see thee flowers is in thee spring. 475 | 476 | 4. To change every occurrence of a character string between two lines, 477 | 478 | type :#,#s/old/new/g where #,# are the numbers of the two lines. 479 | 480 | Type :%s/old/new/g to change every occurrence in the whole buffer. 481 | 482 | 483 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 484 | LESSON 4 SUMMARY 485 | 486 | 487 | 1. gg moves to the beginning of the buffer. 488 | G moves to the end of the buffer. 489 | : followed by a line number then moves to that line number. 490 | 491 | 2. Typing / followed by a phrase searches FORWARD for the phrase. 492 | Typing ? followed by a phrase searches BACKWARD for the phrase. 493 | After a search type n to find the next occurrence in the same direction 494 | or N to search in the opposite direction. 495 | 496 | 3. Typing % while the cursor is on a (,),[,],{, or } locates its 497 | matching pair. 498 | 499 | 4. To substitute new for the first old on a line type :s/old/new 500 | To substitute new for all 'old's on a line type :s/old/new/g 501 | To substitute phrases between two line #'s type :#,#s/old/new/g 502 | To substitute all occurrences in the file type :%s/old/new/g 503 | To ask for confirmation each time add 'c' :%s/old/new/gc 504 | 505 | 506 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 507 | Lesson 5.1: HOW TO EXECUTE AN EXTERNAL COMMAND 508 | 509 | 510 | ** Type :! followed by an external command to execute that command. ** 511 | 512 | 1. Type the familiar command : to set the cursor at the bottom of the 513 | screen. This allows you to enter a command (remember we already used 514 | this to go to a line number in a buffer). 515 | 516 | 2. Now type the ! (exclamation point) character. This allows you to 517 | execute any external shell command. 518 | 519 | 3. As an example type ls following the ! and then hit . This 520 | will show you a listing of your directory, just as if you were at the 521 | shell prompt. Or use :!dir if ls doesn't work (on Windows). 522 | 523 | ---> Note: It is possible to execute any external command this way. 524 | 525 | ---> Note: All : commands must be finished by hitting 526 | 527 | 528 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 529 | Lesson 5.2: MORE ON WRITING FILES 530 | 531 | 532 | ** To save the changes made to the file, type :w FILENAME ** 533 | 534 | 1. Type :!ls or :!dir to get a listing of your directory. 535 | You already know you must hit after this. 536 | 537 | 2. Choose a filename that does not exist yet, such as TEST. 538 | 539 | 3. Now type: :w TEST (where TEST is the filename you chose.) 540 | 541 | 4. This saves the whole file under the name TEST. 542 | To verify this, type :!ls or :!dir again to see your directory 543 | 544 | ---> Note that if you were to exit Emacs and enter again with the filename TEST, 545 | the file would be an exact copy of the tutor when you saved it. 546 | 547 | 5. Now remove the file by typing: 548 | on Unix: :!rm TEST 549 | on Windows: :!del TEST 550 | 551 | 552 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 553 | Lesson 5.3: A SELECTIVE WRITE COMMAND 554 | 555 | 556 | ** To save part of the file, type :#,# w FILENAME ** 557 | 558 | 1. Once again, type :!ls or :!dir to obtain a listing of your directory 559 | and choose a suitable filename such as TEST. 560 | 561 | 2. Move the cursor to the top of this lesson by pressing C-k to find the 562 | number of that line. REMEMBER THIS NUMBER! 563 | 564 | 3. Now move to the bottom of the lesson by pressing C-j to find the 565 | number of that line. REMEMBER THIS LINE NUMBER ALSO! 566 | 567 | 4. To save ONLY a section to a file, type :#,# w TEST where #,# are 568 | the two numbers you remembered (top,bottom) and TEST is your filename. 569 | 570 | 5. Again, see that the file is there with :!ls or :!dir but DO NOT 571 | remove it. 572 | 573 | 574 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 575 | Lesson 5.4: RETRIEVING AND MERGING FILES 576 | 577 | 578 | ** To insert the contents of a file, type :r FILENAME ** 579 | 580 | 1. Type :!ls or :!dir to make sure your TEST filename is present from 581 | before. 582 | 583 | 2. Place the cursor at the top of this lesson. 584 | 585 | NOTE: After executing Step 3 you will see Lesson 5.3. Then move DOWN to this 586 | lesson again. 587 | 588 | 3. Now retrieve your TEST file using the command :r TEST where TEST is 589 | the name of the file. 590 | 591 | NOTE: The file you retrieve is placed starting where the cursor is located. 592 | 593 | 4. To verify that a file was retrieved, cursor back and notice that there 594 | are now two copies of Lesson 5.3, the original and the file version. 595 | 596 | 597 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 598 | LESSON 5 SUMMARY 599 | 600 | 601 | 1. :!command executes an external command. 602 | 603 | Some useful examples are: 604 | :!ls or :!dir - shows a directory listing. 605 | :!rm or :!del FILENAME - removes file FILENAME. 606 | 607 | 2. :w FILENAME writes the current buffer to disk with file name FILENAME. 608 | 609 | 3. :#,#w FILENAME saves the lines # through # in file FILENAME. 610 | 611 | 4. :r FILENAME retrieves disk file FILENAME and inserts it into the 612 | current buffer following the cursor position. 613 | 614 | 615 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 616 | Lesson 6.1: THE OPEN COMMAND 617 | 618 | 619 | ** Type o to open a line below the cursor and place you in insert state. ** 620 | 621 | 1. Move the cursor to the line below marked --->. 622 | 623 | 2. Type o to open up a line BELOW the cursor and place you in insert state 624 | 625 | 3. Now copy the line marked ---> and press to exit insert state. 626 | 627 | ---> After typing o the cursor is placed on the open line in insert state. 628 | 629 | 4. To open up a line ABOVE the cursor, simply type a capital O rather 630 | than a lowercase o 631 | Try this on the line below. 632 | Open up a line above this by typing O while the cursor is on this line. 633 | 634 | 635 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 636 | Lesson 6.2: THE APPEND COMMAND 637 | 638 | 639 | ** Type a to insert text AFTER the cursor. ** 640 | 641 | 1. Move the cursor to the end of the first line below marked ---> by 642 | typing $ in normal state. 643 | 644 | 2. Type an a to append text AFTER the character under the cursor. 645 | (Uppercase A appends to the end of the line.) 646 | 647 | Note: This avoids typing i , the last character, the text to insert, , 648 | cursor-right, and finally, x , just to append to the end of a line! 649 | 650 | 3. Now complete the first line. Note also that append is exactly the same 651 | as insert state, except for the location where text is inserted. 652 | 653 | ---> This line will allow you to practice 654 | ---> This line will allow you to practice appending text to the end of a line. 655 | 656 | 657 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 658 | Lesson 6.3: ANOTHER VERSION OF REPLACE 659 | 660 | 661 | ** Type a capital R to replace more than one character. ** 662 | 663 | 1. Move the cursor to the first line below marked --->. 664 | 665 | 2. Place the cursor at the beginning of the first word that is different 666 | from the second line marked ---> (the word 'last'). 667 | 668 | 3. Now type R and replace the remainder of the text on the first line by 669 | typing over the old text to make the first line the same as the second. 670 | 671 | ---> To make the first line the same as the last on this page use the keys. 672 | ---> To make the first line the same as the second, type R and the new text. 673 | 674 | 4. Note that when you press to exit, any unaltered text remains. 675 | 676 | 677 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 678 | LESSON 6 SUMMARY 679 | 680 | 681 | 1. Typing o opens a line BELOW the cursor and places the cursor on the open 682 | line in insert state. 683 | Typing a capital O opens the line ABOVE the line the cursor is on. 684 | 685 | 2. Type an a to insert text AFTER the character the cursor is on. 686 | Typing a capital A automatically appends text to the end of the line. 687 | 688 | 3. Typing a capital R enters Replace mode until is pressed to exit. 689 | 690 | 691 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 692 | 693 | This concludes the Evil Tutor. It was intended to give a brief overview of 694 | Emacs+Evil editor, just enough to allow you to use the editor fairly easily. 695 | It is far from complete as Evil has many many more commands. 696 | 697 | This tutorial was written by Michael C. Pierce and Robert K. Ware, 698 | Colorado School of Mines using ideas supplied by Charles Smith, 699 | Colorado State University. E-mail: bware@mines.colorado.edu. 700 | 701 | Modified for Vim by Bram Moolenaar. 702 | Modified for Emacs+Evil by Sylvain Benner. 703 | 704 | Based on vimtutor 1.5 705 | 706 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 707 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | 676 | --------------------------------------------------------------------------------