~ubuntu-branches/debian/sid/neovim/sid

« back to all changes in this revision

Viewing changes to runtime/doc/starting.txt

  • Committer: Package Import Robot
  • Author(s): James McCoy
  • Date: 2016-04-18 21:42:19 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20160418214219-1e6d4o1fwqarzk46
Tags: 0.1.3-1
* New upstream release.  (Closes: #820562)
* debian/control:
  + Remove unnecessary luarocks Build-Depends
  + Add libkvm-dev Build-Depends for kfreebsd-*
  + Add python(3)-neovim to Recommends.  (Closes: #812737)
  + Declare compiance with policy 3.9.8, no changes needed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
217
217
                        :set      to display option values.
218
218
                When 'verbose' is non-zero messages are printed (for
219
219
                debugging, to stderr).
220
 
                'term' and $TERM are not used.
 
220
                $TERM is not used.
221
221
                If Vim appears to be stuck try typing "qa!<Enter>".  You don't
222
222
                get a prompt thus you can't see Vim is waiting for you to type
223
223
                something.
315
315
                When {vimrc} is equal to "NONE" (all uppercase), all
316
316
                initializations from files and environment variables are
317
317
                skipped, including reading the |ginit.vim| file when the GUI
318
 
                starts.  Loading plugins is also skipped.
 
318
                starts.  Plugins and syntax highlighting are also skipped.
319
319
                When {vimrc} is equal to "NORC" (all uppercase), this has the
320
 
                same effect as "NONE", but loading plugins is not skipped.
 
320
                same effect as "NONE", but plugins and syntax highlighting are
 
321
                not skipped.
321
322
 
322
323
                                                        *-i*
323
324
-i {shada}      The file {shada} is used instead of the default ShaDa
354
355
At startup, Vim checks environment variables and files and sets values
355
356
accordingly.  Vim proceeds in this order:
356
357
 
357
 
1. Set the 'shell' and 'term' option            *SHELL* *COMSPEC* *TERM*
 
358
1. Set the 'shell' option               *SHELL* *COMSPEC* *TERM*
358
359
        The environment variable SHELL, if it exists, is used to set the
359
360
        'shell' option.  On Windows, the COMSPEC variable is used
360
361
        if SHELL is not set.
361
 
        The environment variable TERM, if it exists, is used to set the 'term'
362
 
        option.  However, 'term' will change later when starting the GUI (step
363
 
        8 below).
364
362
 
365
363
2. Process the arguments
366
364
        The options and file names from the command that start Vim are
382
380
        Places for your personal initializations:
383
381
                Unix            $XDG_CONFIG_HOME/nvim/init.vim
384
382
                                (default for $XDG_CONFIG_HOME is ~/.config)
 
383
                Windows         $XDG_CONFIG_HOME/nvim/init.vim
 
384
                                (default for $XDG_CONFIG_HOME is ~/AppData/Local)
385
385
 
386
386
        The files are searched in the order specified above and only the first
387
387
        one that is found is read.
394
394
        All following initializations until 4. are skipped. $MYVIMRC is not
395
395
        set.
396
396
        "vim -u NORC" can be used to skip these initializations without
397
 
        reading a file.  "vim -u NONE" also skips loading plugins.  |-u|
 
397
        reading a file.  "vim -u NONE" also skips plugins and syntax
 
398
        highlighting.  |-u|
398
399
 
399
400
        If Vim was started in Ex mode with the "-s" argument, all following
400
401
        initializations until 4. are skipped.  Only the "-u" option is
427
428
        -  The file ".exrc"  (for Unix)
428
429
                    "_exrc"  (for Win32)
429
430
 
430
 
4. Load the plugin scripts.                                     *load-plugins*
 
431
4. Enable filetype and indent plugins.
 
432
        This does the same as the commands: >
 
433
                :runtime! filetype.vim
 
434
                :runtime! ftplugin.vim
 
435
                :runtime! indent.vim
 
436
<       This step is skipped if ":filetype ..." was called before now or if
 
437
        the "-u NONE" command line argument was given.
 
438
 
 
439
5. Enable syntax highlighting.
 
440
        This does the same as the command: >
 
441
                :runtime! syntax/syntax.vim
 
442
<       Note: This enables filetype detection even if ":filetype off" was
 
443
        called before now.
 
444
        This step is skipped if the "-u NONE" command line argument was given.
 
445
 
 
446
6. Load the plugin scripts.                                     *load-plugins*
431
447
        This does the same as the command: >
432
448
                :runtime! plugin/**/*.vim
433
449
<       The result is that all directories in the 'runtimepath' option will be
443
459
        commands from the command line have not been executed yet.  You can
444
460
        use "--cmd 'set noloadplugins'" |--cmd|.
445
461
 
446
 
5. Set 'shellpipe' and 'shellredir'
 
462
7. Set 'shellpipe' and 'shellredir'
447
463
        The 'shellpipe' and 'shellredir' options are set according to the
448
464
        value of the 'shell' option, unless they have been set before.
449
465
        This means that Vim will figure out the values of 'shellpipe' and
450
466
        'shellredir' for you, unless you have set them yourself.
451
467
 
452
 
6. Set 'updatecount' to zero, if "-n" command argument used
 
468
8. Set 'updatecount' to zero, if "-n" command argument used
453
469
 
454
 
7. Set binary options
 
470
9. Set binary options
455
471
        If the "-b" flag was given to Vim, the options for binary editing will
456
472
        be set now.  See |-b|.
457
473
 
458
 
8. Perform GUI initializations
 
474
10. Perform GUI initializations
459
475
        Only when starting "gvim", the GUI initializations will be done.  See
460
476
        |gui-init|.
461
477
 
462
 
9. Read the ShaDa file
463
 
        If the 'shada' option is not empty, the ShaDa file is read.  See
464
 
        |shada-file|.
 
478
11. Read the ShaDa file
 
479
        See |shada-file|.
465
480
 
466
 
10. Read the quickfix file
 
481
12. Read the quickfix file
467
482
        If the "-q" flag was given to Vim, the quickfix file is read.  If this
468
483
        fails, Vim exits.
469
484
 
470
 
11. Open all windows
 
485
13. Open all windows
471
486
        When the |-o| flag was given, windows will be opened (but not
472
487
        displayed yet).
473
488
        When the |-p| flag was given, tab pages will be created (but not
476
491
        If the "-q" flag was given to Vim, the first error is jumped to.
477
492
        Buffers for all windows will be loaded.
478
493
 
479
 
12. Execute startup commands
 
494
14. Execute startup commands
480
495
        If a "-t" flag was given to Vim, the tag is jumped to.
481
496
        The commands given with the |-c| and |+cmd| arguments are executed.
482
497
        The starting flag is reset, has("vim_starting") will now return zero.
705
720
These commands will write ":map" and ":set" commands to a file, in such a way
706
721
that when these commands are executed, the current key mappings and options
707
722
will be set to the same values.  The options 'columns', 'endofline',
708
 
'fileformat', 'lines', 'modified', 'scroll', and 'term' are not included,
709
 
because these are terminal or file dependent.
 
723
'fileformat', 'lines', 'modified', and 'scroll' are not included, because 
 
724
these are terminal or file dependent.
710
725
Note that the options 'binary', 'paste' and 'readonly' are included, this
711
726
might not always be what you want.
712
727