Mercurial > vim

comparison runtime/doc/usr_02.txt @ 7659:07f11de5efca

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb Author: Bram Moolenaar <Bram@vim.org> Date: Sun Jan 17 22:26:33 2016 +0100 Update help files.
author Christian Brabandt <cb@256bit.org>
date Sun, 17 Jan 2016 22:30:06 +0100
parents 3012eaddb6b2
children 9f48eab77d62
comparison
equal deleted inserted replaced
7658:fc6d585a9726 7659:07f11de5efca
1 *usr_02.txt* For Vim version 7.4. Last change: 2016 Jan 15 1 *usr_02.txt* For Vim version 7.4. Last change: 2016 Jan 16
2 2
3 VIM USER MANUAL - by Bram Moolenaar 3 VIM USER MANUAL - by Bram Moolenaar
4 4
5 The first steps in Vim 5 The first steps in Vim
6 6
552 :help c_% 552 :help c_%
553 553
554 8) Ex-commands always start with ":", so to go to the :s command help: > 554 8) Ex-commands always start with ":", so to go to the :s command help: >
555 :help :s 555 :help :s
556 556
557 9) Key combinations. They usually start with a single letter indicating 557 9) Commands specifically for debugging start with ">". To go to to the help
558 the mode for which they can be used. E.g.: > 558 for the "cont" debug command: >
559 :help >cont
560
561 10) Key combinations. They usually start with a single letter indicating
562 the mode for which they can be used. E.g.: >
559 :help i_CTRL-X 563 :help i_CTRL-X
560 < takes you to the family of Ctrl-X commands for insert mode which can be 564 < takes you to the family of Ctrl-X commands for insert mode which can be
561 used to auto complete different things. Note, that certain keys will 565 used to auto complete different things. Note, that certain keys will
562 always be written the same, e.g. Control will always be CTRL. 566 always be written the same, e.g. Control will always be CTRL.
563 For normal mode commands there is no prefix and the topic is available at 567 For normal mode commands there is no prefix and the topic is available at
564 :h CTRL-<Letter>. E.g. > 568 :h CTRL-<Letter>. E.g. >
565 :help CTRL-W 569 :help CTRL-W
566 < In contrast > 570 < In contrast >
567 :help c_CTRL-R 571 :help c_CTRL-R
568 < will describe what the Ctrl-R does when entering commands in the Command 572 < will describe what the Ctrl-R does when entering commands in the Command
569 line and > 573 line and >
570 :help v_Ctrl-A 574 :help v_Ctrl-A
571 < talks about incrementing numbers in visual mode and > 575 < talks about incrementing numbers in visual mode and >
572 :help g_CTRL-A 576 :help g_CTRL-A
573 < talks about the g<C-A> command (e.g. you have to press "g" then <Ctrl-A>). 577 < talks about the g<C-A> command (e.g. you have to press "g" then <Ctrl-A>).
574 Here the "g" stand for the normal command "g" which always expects a second 578 Here the "g" stand for the normal command "g" which always expects a second
575 key before doing something similar to the commands starting with "z" 579 key before doing something similar to the commands starting with "z"
576 580
577 10) Regexp items always start with /. So to get help for the "\+" quantifier 581 11) Regexp items always start with /. So to get help for the "\+" quantifier
578 in Vim regexes: > 582 in Vim regexes: >
579 :help /\+ 583 :help /\+
580 < If you need to know everything about regular expressions, start reading 584 < If you need to know everything about regular expressions, start reading
581 at: > 585 at: >
582 :help pattern.txt 586 :help pattern.txt
583 587
584 11) Registers always start with "quote". To find out about the special ":" 588 12) Registers always start with "quote". To find out about the special ":"
585 register: > 589 register: >
586 :help quote: 590 :help quote:
587 591
588 12) Vim Script (VimL) is available at > 592 13) Vim Script (VimL) is available at >
589 :help eval.txt 593 :help eval.txt
590 < Certain aspects of the language are available at :h expr-X where "X" is a 594 < Certain aspects of the language are available at :h expr-X where "X" is a
591 single letter. E.g. > 595 single letter. E.g. >
592 :help expr-! 596 :help expr-!
593 < will take you to the topic describing the "!" (Not) operator for 597 < will take you to the topic describing the "!" (Not) operator for
598 VimL functions always include the "()", so: > 602 VimL functions always include the "()", so: >
599 :help append() 603 :help append()
600 < talks about the append VimL function rather than how to append text in the 604 < talks about the append VimL function rather than how to append text in the
601 current buffer. 605 current buffer.
602 606
603 13) Mappings are talked about in the help page :h |map.txt|. Use > 607 14) Mappings are talked about in the help page :h |map.txt|. Use >
604 :help mapmode-i 608 :help mapmode-i
605 < to find out about the |:imap| command. Also use :map-topic 609 < to find out about the |:imap| command. Also use :map-topic
606 to find out about certain subtopics particular for mappings. e.g: > 610 to find out about certain subtopics particular for mappings. e.g: >
607 :help :map-local 611 :help :map-local
608 < for buffer-local mappings or > 612 < for buffer-local mappings or >
609 :help map-bar 613 :help map-bar
610 < for how the '|' is handled in mappings. 614 < for how the '|' is handled in mappings.
611 615
612 14) Command definitions are talked about :h command-topic, so use > 616 15) Command definitions are talked about :h command-topic, so use >
613 :help command-bar 617 :help command-bar
614 < to find out about the '!' argument for custom commands. 618 < to find out about the '!' argument for custom commands.
615 619
616 15) Window management commands always start with CTRL-W, so you find the 620 16) Window management commands always start with CTRL-W, so you find the
617 corresponding help at :h CTRL-W_letter. E.g. > 621 corresponding help at :h CTRL-W_letter. E.g. >
618 :help CTRL-W_p 622 :help CTRL-W_p
619 < for moving the previous accessed window). You can also access > 623 < for moving the previous accessed window. You can also access >
620 :help windows.txt 624 :help windows.txt
621 < and read your way through if you are looking for window handling 625 < and read your way through if you are looking for window handling
622 commands. 626 commands.
623 627
624 16) Use |:helpgrep| to search in all help pages (and also of any installed 628 17) Use |:helpgrep| to search in all help pages (and also of any installed
625 plugins). See |:helpgrep| for how to use it. 629 plugins). See |:helpgrep| for how to use it.
626 To search for a topic: > 630 To search for a topic: >
627 :helpgrep topic 631 :helpgrep topic
628 < This takes you to the first match. To go to the next one: > 632 < This takes you to the first match. To go to the next one: >
629 :cnext 633 :cnext
630 < All matches are available in the quickfix window which can be opened 634 < All matches are available in the quickfix window which can be opened
631 with: > 635 with: >
632 :copen 636 :copen
633 < Move around to the match you like and press Enter to jump to that help. 637 < Move around to the match you like and press Enter to jump to that help.
634 638
635 17) The user manual. This describes help topics for beginners in a rather 639 18) The user manual. This describes help topics for beginners in a rather
636 friendly way. Start at |usr_toc.txt| to find the table of content (as you 640 friendly way. Start at |usr_toc.txt| to find the table of content (as you
637 might have guessed): > 641 might have guessed): >
638 :help usr_toc.txt 642 :help usr_toc.txt
639 < Skim over the contents to find interesting topics. The "Digraphs" and 643 < Skim over the contents to find interesting topics. The "Digraphs" and
640 "Entering special characters" items are in chapter 24, so to go to that 644 "Entering special characters" items are in chapter 24, so to go to that
643 < Also if you want to access a certain chapter in the help, the chapter 647 < Also if you want to access a certain chapter in the help, the chapter
644 number can be accessed directly like this: > 648 number can be accessed directly like this: >
645 :help 10.1 649 :help 10.1
646 < goes to chapter 10.1 in |usr_10.txt| and talks about recording macros. 650 < goes to chapter 10.1 in |usr_10.txt| and talks about recording macros.
647 651
648 18) Highlighting groups. Always start with hl-groupname. E.g. > 652 19) Highlighting groups. Always start with hl-groupname. E.g. >
649 :help hl-WarningMsg 653 :help hl-WarningMsg
650 < talks about the WarningMsg highlighting group. 654 < talks about the WarningMsg highlighting group.
651 655
652 19) Syntax highlighting is namespaced to :syn-topic e.g. > 656 20) Syntax highlighting is namespaced to :syn-topic e.g. >
653 :help :syn-conceal 657 :help :syn-conceal
654 < talks about the conceal argument for the :syn command. 658 < talks about the conceal argument for the :syn command.
655 659
656 20) Quickfix commands usually start with :c while location list commands 660 21) Quickfix commands usually start with :c while location list commands
657 usually start with :l 661 usually start with :l
658 662
659 21) Autocommand events can be found by their name: > 663 22) Autocommand events can be found by their name: >
660 :help BufWinLeave 664 :help BufWinLeave
661 < To see all possible events: > 665 < To see all possible events: >
662 :help autocommands-events 666 :help autocommands-events
663 667
664 22) Command-line switches always start with "-". So for the help of the -f 668 23) Command-line switches always start with "-". So for the help of the -f
665 command switch of Vim use: > 669 command switch of Vim use: >
666 :help -f 670 :help -f
667 671
668 23) Optional features always start with "+". To find out about the 672 24) Optional features always start with "+". To find out about the
669 conceal feature use: > 673 conceal feature use: >
670 :help +conceal 674 :help +conceal
671 675
672 24) Documentation for included filetype specific functionality is usually 676 25) Documentation for included filetype specific functionality is usually
673 available in the form ft-<filetype>-<functionality>. So > 677 available in the form ft-<filetype>-<functionality>. So >
674 :help ft-c-syntax 678 :help ft-c-syntax
675 < talks about the C syntax file and the option it provides. Sometimes, 679 < talks about the C syntax file and the option it provides. Sometimes,
676 additional sections for omni completion > 680 additional sections for omni completion >
677 :help ft-php-omni 681 :help ft-php-omni
678 < or filetype plugins > 682 < or filetype plugins >
679 :help ft-tex-plugin 683 :help ft-tex-plugin
680 < are available. 684 < are available.
681 685
682 25) Error and Warning codes can be looked up directly in the help. So > 686 26) Error and Warning codes can be looked up directly in the help. So >
683 :help E297 687 :help E297
684 < takes you exactly to the description of the swap error message and > 688 < takes you exactly to the description of the swap error message and >
685 :help W10 689 :help W10
686 < talks about the warning "Changing a readonly file". 690 < talks about the warning "Changing a readonly file".
687 Sometimes however, those error codes are not described, but rather are 691 Sometimes however, those error codes are not described, but rather are