Mercurial > vim

comparison runtime/doc/usr_02.txt @ 19180:8edf0aeb71b9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update runtime files. Commit: https://github.com/vim/vim/commit/1d9215b9aaa120b9d78fee49488556f73007ce78 Author: Bram Moolenaar <Bram@vim.org> Date: Sat Jan 25 13:27:42 2020 +0100 Update runtime files.
author Bram Moolenaar <Bram@vim.org>
date Sat, 25 Jan 2020 13:30:05 +0100
parents 130acb903dbe
children 5c98ea5f5d6e
comparison
equal deleted inserted replaced
19179:539bca3da740 19180:8edf0aeb71b9
507 507
508 Summary: *help-summary* > 508 Summary: *help-summary* >
509 509
510 1) Use Ctrl-D after typing a topic and let Vim show all available topics. 510 1) Use Ctrl-D after typing a topic and let Vim show all available topics.
511 Or press Tab to complete: > 511 Or press Tab to complete: >
512 :help some<Tab> 512 :help some<Tab>
513 < More information on how to use the help: > 513 < More information on how to use the help: >
514 :help helphelp 514 :help helphelp
515 515
516 2) Follow the links in bars to related help. You can go from the detailed 516 2) Follow the links in bars to related help. You can go from the detailed
517 help to the user documentation, which describes certain commands more from 517 help to the user documentation, which describes certain commands more from
518 a user perspective and less detailed. E.g. after: > 518 a user perspective and less detailed. E.g. after: >
519 :help pattern.txt 519 :help pattern.txt
520 < You can see the user guide topics |03.9| and |usr_27.txt| in the 520 < You can see the user guide topics |03.9| and |usr_27.txt| in the
521 introduction. 521 introduction.
522 522
523 3) Options are enclosed in single apostrophes. To go to the help topic for the 523 3) Options are enclosed in single apostrophes. To go to the help topic for the
524 list option: > 524 list option: >
526 < If you only know you are looking for a certain option, you can also do: > 526 < If you only know you are looking for a certain option, you can also do: >
527 :help options.txt 527 :help options.txt
528 < to open the help page which describes all option handling and then search 528 < to open the help page which describes all option handling and then search
529 using regular expressions, e.g. textwidth. 529 using regular expressions, e.g. textwidth.
530 Certain options have their own namespace, e.g.: > 530 Certain options have their own namespace, e.g.: >
531 :help cpo-<letter> 531 :help cpo-<letter>
532 < for the corresponding flag of the 'cpoptions' settings, substitute <letter> 532 < for the corresponding flag of the 'cpoptions' settings, substitute <letter>
533 by a specific flag, e.g.: > 533 by a specific flag, e.g.: >
534 :help cpo-; 534 :help cpo-;
535 < And for the guioption flags: > 535 < And for the guioption flags: >
536 :help go-<letter> 536 :help go-<letter>
537 537
538 4) Normal mode commands do not have a prefix. To go to the help page for the 538 4) Normal mode commands do not have a prefix. To go to the help page for the
539 "gt" command: > 539 "gt" command: >
540 :help gt 540 :help gt
541 541
542 5) Insert mode commands start with i_. Help for deleting a word: > 542 5) Insert mode commands start with i_. Help for deleting a word: >
543 :help i_CTRL-W 543 :help i_CTRL-W
544 544
545 6) Visual mode commands start with v_. Help for jumping to the other side of 545 6) Visual mode commands start with v_. Help for jumping to the other side of
546 the Visual area: > 546 the Visual area: >
547 :help v_o 547 :help v_o
548 548
549 7) Command line editing and arguments start with c_. Help for using the 549 7) Command line editing and arguments start with c_. Help for using the
550 command argument %: > 550 command argument %: >
551 :help c_% 551 :help c_%
552 552
553 8) Ex-commands always start with ":", so to go to the ":s" command help: > 553 8) Ex-commands always start with ":", so to go to the ":s" command help: >
554 :help :s 554 :help :s
555 555
556 9) Commands specifically for debugging start with ">". To go to the help 556 9) Commands specifically for debugging start with ">". To go to the help
557 for the "cont" debug command: > 557 for the "cont" debug command: >
558 :help >cont 558 :help >cont
559 559
560 10) Key combinations. They usually start with a single letter indicating 560 10) Key combinations. They usually start with a single letter indicating
561 the mode for which they can be used. E.g.: > 561 the mode for which they can be used. E.g.: >
562 :help i_CTRL-X 562 :help i_CTRL-X
563 < takes you to the family of CTRL-X commands for insert mode which can be 563 < takes you to the family of CTRL-X commands for insert mode which can be
564 used to auto-complete different things. Note, that certain keys will 564 used to auto-complete different things. Note, that certain keys will
565 always be written the same, e.g. Control will always be CTRL. 565 always be written the same, e.g. Control will always be CTRL.
566 For normal mode commands there is no prefix and the topic is available at 566 For normal mode commands there is no prefix and the topic is available at
567 :h CTRL-<Letter>. E.g. > 567 :h CTRL-<Letter>. E.g. >
568 :help CTRL-W 568 :help CTRL-W
569 < In contrast > 569 < In contrast >
570 :help c_CTRL-R 570 :help c_CTRL-R
571 < will describe what the CTRL-R does when entering commands in the Command 571 < will describe what the CTRL-R does when entering commands in the Command
572 line and > 572 line and >
573 :help v_CTRL-A 573 :help v_CTRL-A
574 < talks about incrementing numbers in visual mode and > 574 < talks about incrementing numbers in visual mode and >
575 :help g_CTRL-A 575 :help g_CTRL-A
576 < talks about the "g<C-A>" command (e.g. you have to press "g" then 576 < talks about the "g<C-A>" command (e.g. you have to press "g" then
577 <CTRL-A>). Here the "g" stand for the normal command "g" which always 577 <CTRL-A>). Here the "g" stands for the normal command "g" which always
578 expects a second key before doing something similar to the commands 578 expects a second key before doing something similar to the commands
579 starting with "z" 579 starting with "z".
580 580
581 11) 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
582 in Vim regexes: > 582 in Vim regexes: >
583 :help /\+ 583 :help /\+
584 < If you need to know everything about regular expressions, start reading 584 < If you need to know everything about regular expressions, start reading
585 at: > 585 at: >
586 :help pattern.txt 586 :help pattern.txt
587 587
588 12) Registers always start with "quote". To find out about the special ":" 588 12) Registers always start with "quote". To find out about the special ":"
589 register: > 589 register: >
590 :help quote: 590 :help quote:
591 591
592 13) Vim script is available at > 592 13) Vim script is available at >
593 :help eval.txt 593 :help eval.txt
594 < 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
595 single letter. E.g. > 595 single letter. E.g. >
596 :help expr-! 596 :help expr-!
597 < will take you to the topic describing the "!" (Not) operator for 597 < will take you to the topic describing the "!" (Not) operator for Vim
598 VimScript. 598 script.
599 Also important is > 599 Also important is >
600 :help function-list 600 :help function-list
601 < to find a short description of all functions available. Help topics for 601 < to find a short description of all functions available. Help topics for
602 Vim script functions always include the "()", so: > 602 Vim script functions always include the "()", so: >
603 :help append() 603 :help append()
604 < talks about the append Vim script function rather than how to append text 604 < talks about the append Vim script function rather than how to append text
605 in the current buffer. 605 in the current buffer.
606 606
607 14) 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 >
608 :help mapmode-i 608 :help mapmode-i
609 < to find out about the |:imap| command. Also use :map-topic 609 < to find out about the |:imap| command. Also use :map-topic
610 to find out about certain subtopics particular for mappings. e.g: > 610 to find out about certain subtopics particular for mappings. e.g: >
611 :help :map-local 611 :help :map-local
612 < for buffer-local mappings or > 612 < for buffer-local mappings or >
613 :help map-bar 613 :help map-bar
614 < for how the '|' is handled in mappings. 614 < for how the '|' is handled in mappings.
615 615
616 15) Command definitions are talked about :h command-topic, so use > 616 15) Command definitions are talked about :h command-topic, so use >
617 :help command-bar 617 :help command-bar
618 < to find out about the '!' argument for custom commands. 618 < to find out about the '!' argument for custom commands.
619 619
620 16) 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
621 corresponding help at :h CTRL-W_letter. E.g. > 621 corresponding help at :h CTRL-W_letter. E.g. >
622 :help CTRL-W_p 622 :help CTRL-W_p
623 < for moving the previous accessed window. You can also access > 623 < for moving the previous accessed window. You can also access >
624 :help windows.txt 624 :help windows.txt
625 < 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
626 commands. 626 commands.
627 627
628 17) 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
629 plugins). See |:helpgrep| for how to use it. 629 plugins). See |:helpgrep| for how to use it.
630 To search for a topic: > 630 To search for a topic: >
631 :helpgrep topic 631 :helpgrep topic
632 < 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: >
633 :cnext 633 :cnext
634 < 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
635 with: > 635 with: >
636 :copen 636 :copen
637 < 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.
638 638
639 18) 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
640 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
641 might have guessed): > 641 might have guessed): >
642 :help usr_toc.txt 642 :help usr_toc.txt
643 < Skim over the contents to find interesting topics. The "Digraphs" and 643 < Skim over the contents to find interesting topics. The "Digraphs" and
644 "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
645 particular help page: > 645 particular help page: >
646 :help usr_24.txt 646 :help usr_24.txt
647 < 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
648 number can be accessed directly like this: > 648 number can be accessed directly like this: >
649 :help 10.1 649 :help 10.1
650 < which goes to chapter 10.1 in |usr_10.txt| and talks about recording 650 < which goes to chapter 10.1 in |usr_10.txt| and talks about recording
651 macros. 651 macros.
652 652
653 19) Highlighting groups. Always start with hl-groupname. E.g. > 653 19) Highlighting groups. Always start with hl-groupname. E.g. >
654 :help hl-WarningMsg 654 :help hl-WarningMsg
655 < talks about the WarningMsg highlighting group. 655 < talks about the WarningMsg highlighting group.
656 656
657 20) Syntax highlighting is namespaced to :syn-topic. E.g. > 657 20) Syntax highlighting is namespaced to :syn-topic. E.g. >
658 :help :syn-conceal 658 :help :syn-conceal
659 < talks about the conceal argument for the ":syn" command. 659 < talks about the conceal argument for the ":syn" command.
660 660
661 21) Quickfix commands usually start with :c while location list commands 661 21) Quickfix commands usually start with :c while location list commands
662 usually start with :l 662 usually start with :l
663 663
664 22) Autocommand events can be found by their name: > 664 22) Autocommand events can be found by their name: >
665 :help BufWinLeave 665 :help BufWinLeave
666 < To see all possible events: > 666 < To see all possible events: >
667 :help autocommand-events 667 :help autocommand-events
668 668
669 23) Command-line switches always start with "-". So for the help of the -f 669 23) Command-line switches always start with "-". So for the help of the -f
670 command switch of Vim use: > 670 command switch of Vim use: >
671 :help -f 671 :help -f
672 672
673 24) Optional features always start with "+". To find out about the 673 24) Optional features always start with "+". To find out about the
674 conceal feature use: > 674 conceal feature use: >
675 :help +conceal 675 :help +conceal
676 676
677 25) Documentation for included filetype specific functionality is usually 677 25) Documentation for included filetype specific functionality is usually
678 available in the form ft-<filetype>-<functionality>. So > 678 available in the form ft-<filetype>-<functionality>. So >
679 :help ft-c-syntax 679 :help ft-c-syntax
680 < talks about the C syntax file and the option it provides. Sometimes, 680 < talks about the C syntax file and the option it provides. Sometimes,
681 additional sections for omni completion > 681 additional sections for omni completion >
682 :help ft-php-omni 682 :help ft-php-omni
683 < or filetype plugins > 683 < or filetype plugins >
684 :help ft-tex-plugin 684 :help ft-tex-plugin
685 < are available. 685 < are available.
686 686
687 26) Error and Warning codes can be looked up directly in the help. So > 687 26) Error and Warning codes can be looked up directly in the help. So >
689 < takes you exactly to the description of the swap error message and > 689 < takes you exactly to the description of the swap error message and >
690 :help W10 690 :help W10
691 < talks about the warning "Changing a readonly file". 691 < talks about the warning "Changing a readonly file".
692 Sometimes, however, those error codes are not described, but rather are 692 Sometimes, however, those error codes are not described, but rather are
693 listed at the Vim command that usually causes this. So: > 693 listed at the Vim command that usually causes this. So: >
694 :help E128 694 :help E128
695 < takes you to the |:function| command 695 < takes you to the |:function| command
696 696
697 697
698 ============================================================================== 698 ==============================================================================
699 699