after/ftplugin/php.vim: Move syntax settings to vimrc.

[config/dotfiles.git] / vim / bundle / screenpaste / doc / screenpaste.txt

diff --git a/vim/bundle/screenpaste/doc/screenpaste.txt b/vim/bundle/screenpaste/doc/screenpaste.txt
index 11a50e8d10cae5aa1a6831cd13f5a3bb1c00a1af..49cfeb61471cad5dd7f32c747c0504ff92d7bbe5 100644 (file)
--- a/vim/bundle/screenpaste/doc/screenpaste.txt
+++ b/vim/bundle/screenpaste/doc/screenpaste.txt
@@ -1,5 +1,11 @@
 *screenpaste.txt* Paste/insert GNU Screen buffer in (almost) any mode  v5.92
 
 *screenpaste.txt* Paste/insert GNU Screen buffer in (almost) any mode  v5.92
 

+$Id: screenpaste.txt,v 8624db9970aa 2008-11-08 21:33 +0100 blacktrash $
+
+For instructions on installing this file, type
+       :help add-local-help
+inside Vim.
+

 Author:        Christian Ebert <blacktrash@gmx.net>
 
 
 Author:        Christian Ebert <blacktrash@gmx.net>
 
 


@@ -12,13 +18,12 @@ Author:     Christian Ebert <blacktrash@gmx.net>
 1. Contents                                            *screenpaste-toc*
 
        Screen Paste Plugin                             |screenpaste-intro|
 1. Contents                                            *screenpaste-toc*
 
        Screen Paste Plugin                             |screenpaste-intro|

-       Activation                                      |screenpaste-activate|
+       Installation                                    |screenpaste-install|

        Usage                                           |screenpaste-usage|
        Options                                         |screenpaste-options|
        Changing Mappings                               |screenpaste-mappings|
        Commands                                        |screenpaste-commands|
        Bugs and Limitations                            |screenpaste-bugs|
        Usage                                           |screenpaste-usage|
        Options                                         |screenpaste-options|
        Changing Mappings                               |screenpaste-mappings|
        Commands                                        |screenpaste-commands|
        Bugs and Limitations                            |screenpaste-bugs|

-       Credits                                         |screenpaste-credits|

 
 ==============================================================================
 
 
 ==============================================================================
 


@@ -36,7 +41,7 @@ This script provides mappings and commands to get correct results.
 As an additional feature the current Screen buffer is available in any Vim
 instance, even those /outside/ the current Screen session.
 
 As an additional feature the current Screen buffer is available in any Vim
 instance, even those /outside/ the current Screen session.
 

-When pasting into command-line in Vim7 many commands are autodetected and the
+When pasting into command-line many commands are autodetected and the

 behaviour adapts automatically (|getcmdtype()|).
 
 The underlying mechanism of screenpaste consists in getting hold of the
 behaviour adapts automatically (|getcmdtype()|).
 
 The underlying mechanism of screenpaste consists in getting hold of the


@@ -51,15 +56,17 @@ respectively.
 
 ==============================================================================
 
 
 ==============================================================================
 

-3. Activation                                          *screenpaste-activate*
+3. Installation                                                *screenpaste-install*

 
 

-Either copy screenpaste.vim to your plugin directory (|add-global-plugin|),
-or to your macros directory and source it (manually or from |vimrc|): >
-       :runtime macros/screenpaste.vim
-or >
-       :source $HOME/.vim/macros/screenpaste.vim
+The screenpaste plugin comprises three files: screenpastePlugin.vim,
+screenpaste.vim and screenpaste.txt (this file). To install the plugin, copy
+screenpastePlugin.vim into a 'plugin' directory in your runtime path and
+screenpaste.vim into the corresponding 'autoload' directory. See
+|add-global-plugin| and |'runtimepath'|.

 
 

-The Vim Help documentation installs itself when you restart Vim.
+This help file goes into a 'doc' directory in the runtime path. Then execute
+|:helptags|, specifying the full path of the 'doc' directory. See
+|add-local-help| for details.

 
 The GNU Screen executable has to be in $PATH. Otherwise screenpaste bails out
 giving an error message.
 
 The GNU Screen executable has to be in $PATH. Otherwise screenpaste bails out
 giving an error message.


@@ -199,16 +206,26 @@ Default Value     'screen'
        "screen", or if you like to specify it's full path: >
                let g:screen_executable = "/usr/local/bin/screen"
 
        "screen", or if you like to specify it's full path: >
                let g:screen_executable = "/usr/local/bin/screen"
 

+g:screen_wait                                          *screen_wait*
+
+Type           String or Number
+Valid Values   See |:sleep|
+Default Value  '333m'
+
+       How long Vim should wait for Screen to write its exchange file.  If
+       you get messages that the Screen buffer is empty even though you know
+       that it actually is not, bump up this setting.
+

 g:screen_visualselect                                  *screen_visualselect*
 Type           Boolean
 Default Value  0
 
 g:screen_visualselect                                  *screen_visualselect*
 Type           Boolean
 Default Value  0
 

-        If set to 1 and in Visual mode the text from the Screen buffer is
-        visually selected after the put operation.
+       If set to 1 and in Visual mode the text from the Screen buffer is
+       visually selected after the put operation.

 
 g:screen_register                                      *screen_register*
 
 
 g:screen_register                                      *screen_register*
 

-Type           String
+Type           String or Number

 Valid Values   "a-z0-9A-Z
 Default Value  '"'
 
 Valid Values   "a-z0-9A-Z
 Default Value  '"'
 


@@ -228,12 +245,9 @@ Default Value      '"'
        For a one time operation with a special register the use of
        |ScreenPut| ex-command and its register argument is recommended.
 
        For a one time operation with a special register the use of
        |ScreenPut| ex-command and its register argument is recommended.
 

-       Note: Due to the mechanics of the script even a numbered register has
-       to be passed as string, ie. it has to quoted when you set it; eg. >
-               :let g:screen_register = "8"
-<      Note as well that specifying an uppercase letter means that the
-       contents of the Screen buffer will be appended to the register named
-       with the corresponding lowercase character (|quote_alpha|).
+       Note: Specifying an uppercase letter means that the contents of the
+       Screen buffer will be appended to the register named with the
+       corresponding lowercase character (|quote_alpha|).

 
 g:screen_clmode                                                *screen_clmode*
 
 
 g:screen_clmode                                                *screen_clmode*
 


@@ -291,7 +305,6 @@ Modes and their behaviour:
        Use this mode to paste current Screen buffer literally into command
        line.
 
        Use this mode to paste current Screen buffer literally into command
        line.
 

-Vim7:

        |/|, |?|, |input()|, |:insert|, and |:append| commands are
        autodetected when not in 'noesc' |screen_clmode|. This means that even
        when you are in 'sub' mode you can type: >
        |/|, |?|, |input()|, |:insert|, and |:append| commands are
        autodetected when not in 'noesc' |screen_clmode|. This means that even
        when you are in 'sub' mode you can type: >


@@ -305,9 +318,6 @@ Vim7:
        without clobbering a parallel Screen session, and Vim would insert
        <Nul> characters instead (see |NL-used-for-Nul|).
 
        without clobbering a parallel Screen session, and Vim would insert
        <Nul> characters instead (see |NL-used-for-Nul|).
 

-Vim6:
-       For |:insert| and |:append| commands use Screen's "C-a ]"
-

 ==============================================================================
 
 6. Changing Mappings                                   *screenpaste-mappings*
 ==============================================================================
 
 6. Changing Mappings                                   *screenpaste-mappings*


@@ -425,13 +435,6 @@ the end of a selection in a different manner than Vim's visual yank does.
 Screen expands tabs, expect incorrect results if the Screen buffer contains
 tabs.
 
 Screen expands tabs, expect incorrect results if the Screen buffer contains
 tabs.
 

-==============================================================================
-
-Credits                                                        *screenpaste-credits*
-
-Mathieu Clabaut, Guo-Peng Wen  let me steal and tweak the inline
-                               self-install code for this Help document.
-

 ==============================================================================
 
  vim:tw=78:ts=8:ft=help:norl:
 ==============================================================================
 
  vim:tw=78:ts=8:ft=help:norl: