diff --git a/README.md b/README.md index e6c758100759..051371e1c5da 100644 --- a/README.md +++ b/README.md @@ -216,6 +216,10 @@ for more information. # Learning Spacemacs +## Evil-tutor + +Press SPC h T to start the Vimtutor adapted for Evil. + ## The leader key Spacemacs key bindings use a leader key which is set by default to diff --git a/core/spacemacs-mode.el b/core/spacemacs-mode.el index 21677dbc8e27..d8d12b9e3d60 100644 --- a/core/spacemacs-mode.el +++ b/core/spacemacs-mode.el @@ -1,7 +1,9 @@ (setq message-log-max 16384) (defconst emacs-start-time (current-time)) -(defconst spacemacs-version "0.40.1" +(require 'subr-x) + +(defconst spacemacs-version "0.41.0" "Spacemacs version.") (defconst spacemacs-min-version "24.3" diff --git a/spacemacs/extensions.el b/spacemacs/extensions.el index 702ca82150da..ca9e2af90ddf 100644 --- a/spacemacs/extensions.el +++ b/spacemacs/extensions.el @@ -12,6 +12,7 @@ centered-cursor emoji-cheat-sheet evil-plugins + evil-tutor helm-rcirc helm-spacemacs neotree @@ -21,6 +22,16 @@ ;; Initialize the extensions +(defun spacemacs/init-evil-tutor () + (use-package evil-tutor + :commands (evil-tutor/start + evil-tutor/resume) + :init + (progn + (setq evil-tutor-working-directory + (concat spacemacs-cache-directory ".tutor/")) + (evil-leader/set-key "hT" 'evil-tutor/start)))) + (defun spacemacs/init-centered-cursor () (use-package centered-cursor-mode :commands global-centered-cursor-mode diff --git a/spacemacs/extensions/evil-tutor/evil-tutor.el b/spacemacs/extensions/evil-tutor/evil-tutor.el new file mode 100644 index 000000000000..0bfe407b71e6 --- /dev/null +++ b/spacemacs/extensions/evil-tutor/evil-tutor.el @@ -0,0 +1,125 @@ +;;; evil-tutor.el --- Vimtutor adapted to Evil and wrapped in a mode + +;; Copyright (C) 2015 syl20bnr +;; +;; Author: Sylvain Benner +;; Keywords: convenience editing evil +;; Created: 1 Jan 2015 +;; Version: 0.1 +;; Package-Requires: ((evil "1.0.9")) +;; URL: https://github.com/syl20bnr/evil-tutor + +;; This file is not part of GNU Emacs. + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;;; Commentary: + +;;; Code: + +(require 'evil) + +(defcustom evil-tutor-working-directory + (file-name-as-directory (expand-file-name ".tutor" user-emacs-directory)) + "The directory where to create working files." + :type 'string + :group 'evil) + +(define-derived-mode evil-tutor-mode text-mode "evil-tutor" + "Major mode for evil-tutor.") + +;;;###autoload +(defun evil-tutor/start () + "Start a evil-tutor session." + (interactive) + (evil-tutor//restore-or-create-working-file) + (evil-tutor-mode) + (evil-mode)) + +;;;###autoload +(defalias 'evil-tutor/resume 'evil-tutor/start) + +(set-keymap-parent evil-tutor-mode-map text-mode-map) +(define-key evil-tutor-mode-map (kbd "C-j") 'evil-tutor/goto-next-lesson) +(define-key evil-tutor-mode-map (kbd "C-k") 'evil-tutor/goto-previous-lesson) + +(defun evil-tutor//restore-or-create-working-file () + "Create a new working buffer and save it in `evil-tutor-working-directory'. + +If a working file already exists in `evil-tutor-working-directory' then the +found file is visited instead of creating a brand new buffer. + +For now the point location is not saved but this is a functionality which can +be handled by minor modes." + (let* ((files (if (file-exists-p evil-tutor-working-directory) + (directory-files evil-tutor-working-directory t nil t))) + (previous-file (evil-tutor//find-first-working-file files))) + (message "load: %s" (symbol-file 'evil-tutor-mode)) + (if previous-file + (find-file-literally previous-file) + (let* ((date (format-time-string "%d%m%Y")) + (working-file-name (format "evil-tutor-%s.txt" date)) + (tutor-file (concat (file-name-directory (symbol-file + 'evil-tutor-mode)) + "tutor.txt"))) + (switch-to-buffer (get-buffer-create "working-file-name")) + (set-visited-file-name (concat evil-tutor-working-directory + working-file-name)) + (insert-file-contents tutor-file) + (make-directory evil-tutor-working-directory 'parents) + (save-buffer 0))))) + +(defun evil-tutor//find-first-working-file (files) + "Return the first saved working file or nil if there is no such file. + +This function expects full path for each file in FILES." + (when files + (catch 'break + (dolist (f files) + (if (string= ".txt" (file-name-extension f 'period)) + (throw 'break f))) + nil))) + +(defun evil-tutor/goto-next-lesson (&optional arg) + "Move the next lesson. + +If ARG is nil then move to the next lesson, +If ARG is positive then move the ARGth version after the current one, +If ARG is negative then move the ARGth version before the current one." + (interactive "p") + (let ((i 0) + (regexp "^~.*~$") + (count (if arg (abs arg) 1)) + (recenter-positions '(top))) + (dotimes (i count) + (if (or (not arg) + (> arg 0)) + (re-search-forward regexp (buffer-end 1) 'noerror) + (re-search-backward regexp (buffer-end -1) 'noerror))) + (beginning-of-line) + (next-line) + (recenter-top-bottom))) + +(defun evil-tutor/goto-previous-lesson (&optional arg) + "Move to the previous lession. + +If ARG is nil then move to the previous lesson. +If ARG is positive then move to the ARGth lesson before the current one." + (interactive "p") + ;; -1 because we have to skip the current lesson + (evil-tutor/goto-next-lesson (- (if arg (- (abs arg)) -1) 1))) + +(provide 'evil-tutor) + +;;; evil-tutor.el ends here diff --git a/spacemacs/extensions/evil-tutor/tutor.txt b/spacemacs/extensions/evil-tutor/tutor.txt new file mode 100644 index 000000000000..8af391f796a7 --- /dev/null +++ b/spacemacs/extensions/evil-tutor/tutor.txt @@ -0,0 +1,829 @@ +=============================================================================== += 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 = += = += * * * = += = += Version 0.1 = +=============================================================================== + + TL;DR: press C-j (CTRL+j) to jump right to the first lesson. The + tutorial takes approximately 30 minutes. + + At any moment if you feel stuck, you can switch to emacs state with: + + M-x evil-emacs-sate RET + + Then continue the tutorial by going back to the normal state with: + + M-x evil-normal-state RET + + * * * + + Evil is a very powerful emulation of Vim that has many commands, + too many to explain in a tutor such as this. This tutor is designed + to describe enough of the commands that you will be able to easily use + Emacs powered with Evil as an all-purpose editor. + + The approximate time required to complete the tutor is 25-30 minutes, + depending upon how much time is spent with experimentation. + + The commands in the lessons will modify the text. Make a copy of this + file to practise on (if you started "evil-tutor-mode" this is already a + copy). + + It is important to remember that this tutor is set up to teach by + use. That means that you need to execute the commands to learn them + properly. If you only read the text, you will forget the commands! + + Now, make sure that your Shift-Lock key is NOT depressed and press + the j key enough times to move the cursor so that Lesson 1.1 + completely fills the screen. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 1.1: MOVING THE CURSOR + + + ** To move the cursor, press the h,j,k,l keys as indicated. ** + ^ + k Hint: The h key is at the left and moves left. + < h l > The l key is at the right and moves right. + j The j key looks like a down arrow + v + 1. Move the cursor around the screen until you are comfortable. + + 2. Hold down the down key (j) until it repeats. +---> Now you know how to move to the next lesson + + 3. Using the down key, move to Lesson 1.2. + +Note: If you are ever unsure about something you typed, press to place + you in Normal mode. Then retype the command you wanted. + +Note: The cursor keys should also work. But using hjkl you will be able to + move around much faster, once you get used to it. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 1.2: ENTERING AND EXITING VIM + + + !! NOTE: Before executing any of the steps below, read this entire lesson!! + + 1. Press the key (to make sure you are in Normal mode). + + 2. Type: :q! . + +---> This exits the editor WITHOUT saving any changes you have made. + If you want to save the changes and exit type: + :wq + + 3. When you see the shell prompt, type the command that got you into this + tutor. That could be: vimtutor + Normally you would use: vim tutor + +---> 'vim' means enter the vim editor, 'tutor' is the file you wish to edit. + + 4. If you have these steps memorized and are confident, execute steps + 1 through 3 to exit and re-enter the editor. Then move the cursor down + to Lesson 1.3. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 1.3: TEXT EDITING - DELETION + + +** While in Normal mode press x to delete the character under the cursor. ** + + 1. Move the cursor to the line below marked --->. + + 2. To fix the errors, move the cursor until it is on top of the + character to be deleted. + + 3. Press the x key to delete the unwanted character. + + 4. Repeat steps 2 through 4 until the sentence is correct. + +---> The ccow jumpedd ovverr thhe mooon. + + 5. Now that the line is correct, go on to Lesson 1.4. + +NOTE: As you go through this tutor, do not try to memorize, learn by usage. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 1.4: TEXT EDITING - INSERTION + + + ** While in Normal mode press i to insert text. ** + + 1. Move the cursor to the first line below marked --->. + + 2. To make the first line the same as the second, move the cursor on top + of the first character AFTER where the text is to be inserted. + + 3. Press i and type in the necessary additions. + + 4. As each error is fixed press to return to Normal mode. + Repeat steps 2 through 4 to correct the sentence. + +---> There is text misng this . +---> There is some text missing from this line. + + 5. When you are comfortable inserting text move to the summary below. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + LESSON 1 SUMMARY + + + 1. The cursor is moved using either the arrow keys or the hjkl keys. + h (left) j (down) k (up) l (right) + + 2. To enter Vim (from the % prompt) type: vim FILENAME + + 3. To exit Vim type: :q! to trash all changes. + OR type: :wq to save the changes. + + 4. To delete a character under the cursor in Normal mode type: x + + 5. To insert text at the cursor while in Normal mode type: + i type in text + +NOTE: Pressing will place you in Normal mode or will cancel + an unwanted and partially completed command. + +Now continue with Lesson 2. + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 2.1: DELETION COMMANDS + + + ** Type dw to delete to the end of a word. ** + + 1. Press to make sure you are in Normal mode. + + 2. Move the cursor to the line below marked --->. + + 3. Move the cursor to the beginning of a word that needs to be deleted. + + 4. Type dw to make the word disappear. + + NOTE: The letters dw will appear on the last line of the screen as you type + them. If you typed something wrong, press and start over. + +---> There are a some words fun that don't belong paper in this sentence. + + 5. Repeat steps 3 and 4 until the sentence is correct and go to Lesson 2.2. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 2.2: MORE DELETION COMMANDS + + + ** Type d$ to delete to the end of the line. ** + + 1. Press to make sure you are in Normal mode. + + 2. Move the cursor to the line below marked --->. + + 3. Move the cursor to the end of the correct line (AFTER the first . ). + + 4. Type d$ to delete to the end of the line. + +---> Somebody typed the end of this line twice. end of this line twice. + + + 5. Move on to Lesson 2.3 to understand what is happening. + + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 2.3: ON COMMANDS AND OBJECTS + + + The format for the d delete command is as follows: + + [number] d object OR d [number] object + Where: + number - is how many times to execute the command (optional, default=1). + d - is the command to delete. + object - is what the command will operate on (listed below). + + A short list of objects: + w - from the cursor to the end of the word, including the space. + e - from the cursor to the end of the word, NOT including the space. + $ - from the cursor to the end of the line. + +NOTE: For the adventurous, pressing just the object while in Normal mode + without a command will move the cursor as specified in the object list. + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 2.4: AN EXCEPTION TO 'COMMAND-OBJECT' + + + ** Type dd to delete a whole line. ** + + Due to the frequency of whole line deletion, the designers of Vim decided + it would be easier to simply type two d's in a row to delete a line. + + 1. Move the cursor to the second line in the phrase below. + 2. Type dd to delete the line. + 3. Now move to the fourth line. + 4. Type 2dd (remember number-command-object) to delete the two lines. + + 1) Roses are red, + 2) Mud is fun, + 3) Violets are blue, + 4) I have a car, + 5) Clocks tell time, + 6) Sugar is sweet + 7) And so are you. + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 2.5: THE UNDO COMMAND + + + ** Press u to undo the last commands, U to fix a whole line. ** + + 1. Move the cursor to the line below marked ---> and place it on the + first error. + 2. Type x to delete the first unwanted character. + 3. Now type u to undo the last command executed. + 4. This time fix all the errors on the line using the x command. + 5. Now type a capital U to return the line to its original state. + 6. Now type u a few times to undo the U and preceding commands. + 7. Now type CTRL-R (keeping CTRL key pressed while hitting R) a few times + to redo the commands (undo the undo's). + +---> Fiix the errors oon thhis line and reeplace them witth undo. + + 8. These are very useful commands. Now move on to the Lesson 2 Summary. + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + LESSON 2 SUMMARY + + + 1. To delete from the cursor to the end of a word type: dw + + 2. To delete from the cursor to the end of a line type: d$ + + 3. To delete a whole line type: dd + + 4. The format for a command in Normal mode is: + + [number] command object OR command [number] object + where: + number - is how many times to repeat the command + command - is what to do, such as d for delete + object - is what the command should act upon, such as w (word), + $ (to the end of line), etc. + + 5. To undo previous actions, type: u (lowercase u) + To undo all the changes on a line type: U (capital U) + To undo the undo's type: CTRL-R + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 3.1: THE PUT COMMAND + + + ** Type p to put the last deletion after the cursor. ** + + 1. Move the cursor to the first line in the set below. + + 2. Type dd to delete the line and store it in Vim's buffer. + + 3. Move the cursor to the line ABOVE where the deleted line should go. + + 4. While in Normal mode, type p to replace the line. + + 5. Repeat steps 2 through 4 to put all the lines in correct order. + + d) Can you learn too? + b) Violets are blue, + c) Intelligence is learned, + a) Roses are red, + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 3.2: THE REPLACE COMMAND + + + ** Type r and a character to replace the character under the cursor. ** + + 1. Move the cursor to the first line below marked --->. + + 2. Move the cursor so that it is on top of the first error. + + 3. Type r and then the character which should replace the error. + + 4. Repeat steps 2 and 3 until the first line is correct. + +---> Whan this lime was tuoed in, someone presswd some wrojg keys! +---> When this line was typed in, someone pressed some wrong keys! + + 5. Now move on to Lesson 3.2. + +NOTE: Remember that you should be learning by use, not memorization. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 3.3: THE CHANGE COMMAND + + + ** To change part or all of a word, type cw . ** + + 1. Move the cursor to the first line below marked --->. + + 2. Place the cursor on the u in lubw. + + 3. Type cw and the correct word (in this case, type 'ine'.) + + 4. Press and move to the next error (the first character to be changed.) + + 5. Repeat steps 3 and 4 until the first sentence is the same as the second. + +---> This lubw has a few wptfd that mrrf changing usf the change command. +---> This line has a few words that need changing using the change command. + +Notice that cw not only replaces the word, but also places you in insert. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 3.4: MORE CHANGES USING c + + + ** The change command is used with the same objects as delete. ** + + 1. The change command works in the same way as delete. The format is: + + [number] c object OR c [number] object + + 2. The objects are also the same, such as w (word), $ (end of line), etc. + + 3. Move to the first line below marked --->. + + 4. Move the cursor to the first error. + + 5. Type c$ to make the rest of the line like the second and press . + +---> The end of this line needs some help to make it like the second. +---> The end of this line needs to be corrected using the c$ command. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + LESSON 3 SUMMARY + + + 1. To replace text that has already been deleted, type p . This Puts the + deleted text AFTER the cursor (if a line was deleted it will go on the + line below the cursor). + + 2. To replace the character under the cursor, type r and then the + character which will replace the original. + + 3. The change command allows you to change the specified object from the + cursor to the end of the object. eg. Type cw to change from the + cursor to the end of the word, c$ to change to the end of a line. + + 4. The format for change is: + + [number] c object OR c [number] object + +Now go on to the next lesson. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 4.1: LOCATION AND FILE STATUS + + + ** Type CTRL-g to show your location in the file and the file status. + Type SHIFT-G to move to a line in the file. ** + + Note: Read this entire lesson before executing any of the steps!! + + 1. Hold down the Ctrl key and press g . A status line will appear at the + bottom of the page with the filename and the line you are on. Remember + the line number for Step 3. + + 2. Press shift-G to move you to the bottom of the file. + + 3. Type in the number of the line you were on and then shift-G. This will + return you to the line you were on when you first pressed Ctrl-g. + (When you type in the numbers, they will NOT be displayed on the screen.) + + 4. If you feel confident to do this, execute steps 1 through 3. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 4.2: THE SEARCH COMMAND + + + ** Type / followed by a phrase to search for the phrase. ** + + 1. In Normal mode type the / character. Notice that it and the cursor + appear at the bottom of the screen as with the : command. + + 2. Now type 'errroor' . This is the word you want to search for. + + 3. To search for the same phrase again, simply type n . + To search for the same phrase in the opposite direction, type Shift-N . + + 4. If you want to search for a phrase in the backwards direction, use the + command ? instead of /. + +---> When the search reaches the end of the file it will continue at the start. + + "errroor" is not the way to spell error; errroor is an error. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 4.3: MATCHING PARENTHESES SEARCH + + + ** Type % to find a matching ),], or } . ** + + 1. Place the cursor on any (, [, or { in the line below marked --->. + + 2. Now type the % character. + + 3. The cursor should be on the matching parenthesis or bracket. + + 4. Type % to move the cursor back to the first bracket (by matching). + +---> This ( is a test line with ('s, ['s ] and {'s } in it. )) + +Note: This is very useful in debugging a program with unmatched parentheses! + + + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 4.4: A WAY TO CHANGE ERRORS + + + ** Type :s/old/new/g to substitute 'new' for 'old'. ** + + 1. Move the cursor to the line below marked --->. + + 2. Type :s/thee/the . Note that this command only changes the + first occurrence on the line. + + 3. Now type :s/thee/the/g meaning substitute globally on the line. + This changes all occurrences on the line. + +---> thee best time to see thee flowers is in thee spring. + + 4. To change every occurrence of a character string between two lines, + type :#,#s/old/new/g where #,# are the numbers of the two lines. + Type :%s/old/new/g to change every occurrence in the whole file. + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + LESSON 4 SUMMARY + + + 1. Ctrl-g displays your location in the file and the file status. + Shift-G moves to the end of the file. A line number followed + by Shift-G moves to that line number. + + 2. Typing / followed by a phrase searches FORWARD for the phrase. + Typing ? followed by a phrase searches BACKWARD for the phrase. + After a search type n to find the next occurrence in the same direction + or Shift-N to search in the opposite direction. + + 3. Typing % while the cursor is on a (,),[,],{, or } locates its + matching pair. + + 4. To substitute new for the first old on a line type :s/old/new + To substitute new for all 'old's on a line type :s/old/new/g + To substitute phrases between two line #'s type :#,#s/old/new/g + To substitute all occurrences in the file type :%s/old/new/g + To ask for confirmation each time add 'c' :%s/old/new/gc + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 5.1: HOW TO EXECUTE AN EXTERNAL COMMAND + + + ** Type :! followed by an external command to execute that command. ** + + 1. Type the familiar command : to set the cursor at the bottom of the + screen. This allows you to enter a command. + + 2. Now type the ! (exclamation point) character. This allows you to + execute any external shell command. + + 3. As an example type ls following the ! and then hit . This + will show you a listing of your directory, just as if you were at the + shell prompt. Or use :!dir if ls doesn't work. + +---> Note: It is possible to execute any external command this way. + +---> Note: All : commands must be finished by hitting + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 5.2: MORE ON WRITING FILES + + + ** To save the changes made to the file, type :w FILENAME. ** + + 1. Type :!dir or :!ls to get a listing of your directory. + You already know you must hit after this. + + 2. Choose a filename that does not exist yet, such as TEST. + + 3. Now type: :w TEST (where TEST is the filename you chose.) + + 4. This saves the whole file (Vim Tutor) under the name TEST. + To verify this, type :!dir again to see your directory + +---> Note that if you were to exit Vim and enter again with the filename TEST, + the file would be an exact copy of the tutor when you saved it. + + 5. Now remove the file by typing (MS-DOS): :!del TEST + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 5.3: A SELECTIVE WRITE COMMAND + + + ** To save part of the file, type :#,# w FILENAME ** + + 1. Once again, type :!dir or :!ls to obtain a listing of your directory + and choose a suitable filename such as TEST. + + 2. Move the cursor to the top of this page and type Ctrl-g to find the + number of that line. REMEMBER THIS NUMBER! + + 3. Now move to the bottom of the page and type Ctrl-g again. REMEMBER THIS + LINE NUMBER ALSO! + + 4. To save ONLY a section to a file, type :#,# w TEST where #,# are + the two numbers you remembered (top,bottom) and TEST is your filename. + + 5. Again, see that the file is there with :!dir but DO NOT remove it. + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 5.4: RETRIEVING AND MERGING FILES + + + ** To insert the contents of a file, type :r FILENAME ** + + 1. Type :!dir to make sure your TEST filename is present from before. + + 2. Place the cursor at the top of this page. + +NOTE: After executing Step 3 you will see Lesson 5.3. Then move DOWN to + this lesson again. + + 3. Now retrieve your TEST file using the command :r TEST where TEST is + the name of the file. + +NOTE: The file you retrieve is placed starting where the cursor is located. + + 4. To verify that a file was retrieved, cursor back and notice that there + are now two copies of Lesson 5.3, the original and the file version. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + LESSON 5 SUMMARY + + + 1. :!command executes an external command. + + Some useful examples are (MS-DOS): + :!dir - shows a directory listing. + :!del FILENAME - removes file FILENAME. + + 2. :w FILENAME writes the current Vim file to disk with name FILENAME. + + 3. :#,#w FILENAME saves the lines # through # in file FILENAME. + + 4. :r FILENAME retrieves disk file FILENAME and inserts it into the + current file following the cursor position. + + + + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 6.1: THE OPEN COMMAND + + + ** Type o to open a line below the cursor and place you in Insert mode. ** + + 1. Move the cursor to the line below marked --->. + + 2. Type o (lowercase) to open up a line BELOW the cursor and place you in + Insert mode. + + 3. Now copy the line marked ---> and press to exit Insert mode. + +---> After typing o the cursor is placed on the open line in Insert mode. + + 4. To open up a line ABOVE the cursor, simply type a capital O , rather + than a lowercase o. Try this on the line below. +Open up a line above this by typing Shift-O while the cursor is on this line. + + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 6.2: THE APPEND COMMAND + + + ** Type a to insert text AFTER the cursor. ** + + 1. Move the cursor to the end of the first line below marked ---> by + typing $ in Normal mode. + + 2. Type an a (lowercase) to append text AFTER the character under the + cursor. (Uppercase A appends to the end of the line.) + +Note: This avoids typing i , the last character, the text to insert, , + cursor-right, and finally, x , just to append to the end of a line! + + 3. Now complete the first line. Note also that append is exactly the same + as Insert mode, except for the location where text is inserted. + +---> This line will allow you to practice +---> This line will allow you to practice appending text to the end of a line. + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 6.3: ANOTHER VERSION OF REPLACE + + + ** Type a capital R to replace more than one character. ** + + 1. Move the cursor to the first line below marked --->. + + 2. Place the cursor at the beginning of the first word that is different + from the second line marked ---> (the word 'last'). + + 3. Now type R and replace the remainder of the text on the first line by + typing over the old text to make the first line the same as the second. + +---> To make the first line the same as the last on this page use the keys. +---> To make the first line the same as the second, type R and the new text. + + 4. Note that when you press to exit, any unaltered text remains. + + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Lesson 6.4: SET OPTION + + + ** Set an option so a search or substitute ignores case ** + + + 1. Search for 'ignore' by entering: + /ignore + Repeat several times by hitting the n key + + 2. Set the 'ic' (Ignore case) option by typing: + :set ic + + 3. Now search for 'ignore' again by entering: n + Repeat search several more times by hitting the n key + + 4. Set the 'hlsearch' and 'incsearch' options: + :set hls is + + 5. Now enter the search command again, and see what happens: + /ignore + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + LESSON 6 SUMMARY + + + 1. Typing o opens a line BELOW the cursor and places the cursor on the open + line in Insert mode. + Typing a capital O opens the line ABOVE the line the cursor is on. + + 2. Type an a to insert text AFTER the character the cursor is on. + Typing a capital A automatically appends text to the end of the line. + + 3. Typing a capital R enters Replace mode until is pressed to exit. + + 4. Typing ":set xxx" sets the option "xxx" + + + + + + + + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + LESSON 7: ON-LINE HELP COMMANDS + + + ** Use the on-line help system ** + + Vim has a comprehensive on-line help system. To get started, try one of + these three: + - press the key (if you have one) + - press the key (if you have one) + - type :help + + Type :q to close the help window. + + You can find help on just about any subject, by giving an argument to the + ":help" command. Try these (don't forget pressing ): + + :help w + :help c_