Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
97 lines (76 sloc) 3.77 KB
SaveSigns.csv - A Vim Plugin to Save and Restore your Signs
I) Directory layout
=====================
This repository contains the Join.vim plugin, the unit tests and the
documentation. The current directory structure looks like this:
doc/
plugin/
autoload/
Makefile
README
The subdirectory doc/ contains the documentation for the plugin.
The subdirectory plugin/ contains the Vim plugin and the autoloaded
file is located below autoload/
II) Installation
===============
This plugin comes as vimball, which makes it really easy to install it
into the right place.
1) Edit savesigns.vba with your vim (:e csv.vba)
2) From within vim, simply source the file (using :so %)
3) Restart vim to autoload the plugin and the documentation (:q)
4) Read the help at :h savesigns.txt
III) Documentation
==================
*savesigns.txt* Plugin to save Signs - Vers 0.2 Feb 25, 2010
Author: Christian Brabandt <cb@256bit.org>
*savesigns-copyright*
Copyright: (c) 2009 by Christian Brabandt
The VIM LICENSE applies to savesigns.vim, savesignsPlugin.vim
and savesigns.txt (see |copyright|) except use savesigns instead
of "Vim".
NO WARRANTY, EXPRESS OR IMPLIED. USE AT-YOUR-OWN-RISK.
{only available when compiled with the |+signs| feature}
==============================================================================
1. Contents *savesigns-contents*
1. Contents................................................|savesigns-contents|
2. Functionality...........................................|savesigns-plugin|
2.1 :SaveSigns...........................................|:SaveSigns|
3. History.................................................|savesigns-history|
==============================================================================
*savesigns-plugin*
2. Functionality
This plugin was written to allow you to save your |signs| easily. Signs can be
used to specific highlight certains rows in a buffer. This might be useful
when using a debugger or display a |mark|. Note however, that this works only
when the signs feature has been compiled into your vim.
If you have defined signs in your file, you might want to save these signs to
be able to reload these signs later on (e.g. with a |Session|). Therefore this
plugin defines the |:SaveSigns| command, which will store all defined signs in
a file in such a way that reloading that file will restore all defined signs.
When saving Signs, the plugin creates a Vim Script, that can be read in using
|:source| It will save Sign Definitions (see |:sign-define|), Sign placements
(see |:sign-place|) and the Sign hilighting (see |hl-SignColumn|).
Since signs are usually associated with a buffer or a file, sourcing this file
using |:source| will only restore those signs whose buffers are loaded in that
vim session. Note: All Signs that were defined before reloading this file will
be lost.
2.1 :SaveSigns *:SaveSigns*
:SaveSigns Store all currently defined signs in a temporary file.
This file will be opened in a new split window and you
can edit it further. Note: This file won't be saved.
You need to explicitly save it.
:SaveSigns[!] {name} Store all currently defined signs in a file called
{name}. If this file exists, it won't be used a new
temporary file will be created. Use ! to force storing
the info in that file. This will however erase the
file {name}. So use with caution.
==============================================================================
*savesigns-history*
3. savesigns History
0.2 - Uploaded to http://www.vim.org/
- Created autoload script
- Created documentation
- added some more error handling.
0.1 - First initial version
==============================================================================
vim:tw=78:ts=8:ft=help