126 lines
5.3 KiB
Plaintext
126 lines
5.3 KiB
Plaintext
README for bash-support.vim (Version 2.11) / Mai 18 2009
|
|
|
|
* INSTALLATION
|
|
* RELEASE NOTES
|
|
* FILES
|
|
* ADDITIONAL TIPS
|
|
|
|
Bash Support implements a bash-IDE for Vim/gVim. It is written to considerably
|
|
speed up writing code in a consistent style. This is done by inserting
|
|
complete statements, comments, idioms, and code snippets. Syntax checking,
|
|
running a script, starting a debugger can be done with a keystroke. There
|
|
are many additional hints and options which can improve speed and comfort when
|
|
writing shell scripts.
|
|
|
|
=======================================================================================
|
|
INSTALLATION
|
|
=======================================================================================
|
|
|
|
The subdirectories in the zip archive bash-support.zip mirror the directory structure
|
|
which is needed below the local installation directory $HOME/.vim/ .
|
|
|
|
(1) Copy the zip archive bash-support.zip to $HOME/.vim and run
|
|
|
|
unzip bash-support.zip
|
|
|
|
If you have already an older version of bash-support and you have modified the
|
|
template files you may want to save your templates first or copy the files from the
|
|
archive by hand.
|
|
|
|
(2) Set at least some personal details into .vimrc by overriding some defaults.
|
|
Here the minimal personalization (my settings as an example, of course):
|
|
|
|
let g:BASH_AuthorName = 'Dr.-Ing. Fritz Mehner'
|
|
let g:BASH_AuthorRef = 'Mn'
|
|
let g:BASH_Email = 'mehner@fh-swf.de'
|
|
let g:BASH_Company = 'FH Südwestfalen, Iserlohn'
|
|
|
|
There are a lot of features and options which can be used and influenced:
|
|
|
|
* use of template files and tags
|
|
* using and managing personal code snippets
|
|
* bash dictionary for keyword completion
|
|
* removing the root menu
|
|
|
|
Restart gVim/Vim generate the help tags
|
|
|
|
:helptags ~/.vim/doc
|
|
|
|
and look at the bashsupport help with
|
|
|
|
:help bashsupport
|
|
|
|
+-----------------------------------------------+
|
|
| +-------------------------------------------+ |
|
|
| | ** Please read the documentation ** | |
|
|
| | Actions differ for different modes! | |
|
|
| +-------------------------------------------+ |
|
|
+-----------------------------------------------+
|
|
|
|
|
|
=======================================================================================
|
|
RELEASE NOTES FOR VERSION 2.11
|
|
=======================================================================================
|
|
+ Additions for Bash version 4.0.
|
|
+ Comments menu (\cj): adjustment of end-of-line comments improved.
|
|
+ Two submenus rearranged.
|
|
|
|
=======================================================================================
|
|
OLDER RELEASE NOTES : see file 'ChangeLog'
|
|
=======================================================================================
|
|
|
|
=======================================================================================
|
|
FILES
|
|
=======================================================================================
|
|
|
|
README.bashsupport This file.
|
|
|
|
ftplugin/sh.vim A filetype plugin. Defines hotkeys and more.
|
|
|
|
plugin/bash-support.vim The bash plugin for Vim/gVim.
|
|
bash-support/scripts/wrapper.sh A wrapper script for the use of an xterm.
|
|
|
|
doc/bashsupport.txt The help file for the local online help.
|
|
|
|
bash-support/codesnippets/* Some code snippets as a starting point.
|
|
|
|
bash-support/templates/* bash template files (see bashsupport.txt).
|
|
|
|
bash-support/wordlists/* Additional word lists (dictionaries).
|
|
|
|
----------------------- -------------------------------------------------------------
|
|
----------------------- The following files and extensions are for convenience only.
|
|
bash-support.vim will work without them.
|
|
-------------------------------------------------------------
|
|
|
|
bash-support/rc/costumization.vimrc Additional settings I use in .vimrc: incremental
|
|
search, tabstop, hot keys, font, use of dictionaries,
|
|
... The file is commented. Append it to your .vimrc
|
|
if you like.
|
|
|
|
bash-support/rc/costumization.gvimrc Additional settings I use in .gvimrc: hot keys,
|
|
mouse settings, ... The file is commented.
|
|
Append it to your .gvimrc if you like.
|
|
|
|
bash-support/doc/* Hotkey reference card (PDF), changelog.
|
|
|
|
|
|
=======================================================================================
|
|
ADDITIONAL TIPS
|
|
=======================================================================================
|
|
|
|
(1) gvim. Toggle 'insert mode' <--> 'normal mode' with the right mouse button
|
|
(see mapping in file customization.gvimrc).
|
|
|
|
(2) gvim. Use tear off menus and
|
|
|
|
(3) try 'Focus under mouse' as window behavior (No mouse click when the mouse
|
|
pointer is back from the menu entry).
|
|
|
|
(4) Use Emulate3Buttons "on" (X11) even for a 3-button mouse. Pressing left and
|
|
right button simultaneously without moving your fingers is faster then
|
|
moving a finger to the middle button (often a wheel).
|
|
|
|
|
|
=======================================================================================
|