Content-type: text/html Manpage of vimpack

vimpack

Section: User Commands (1)
Index Return to Main Contents

 

NAME

vimpack - navigate and edit files within a pack

 

SYNOPSIS

vimpack [ -i ] [ -d ] [filename]

 

DESCRIPTION

vimpack is a navigator/editor for packs, based on vim.
It requires a version of vim compiled with the embedded Perl interpreter available in your PATH.
vimpack enables you to navigate in the source code, edit files and save your modifications without caring about the branches of code in your pack.


vimpack should be run always from the root directory of a pack.
The first time you run it, vimpack creates an index file. You may create explicitely this index by running 'vimpack -i' the first time you invoke vimpack ; otherwise it will be automatically created as soon as necessary. The creation of this index file may take a couple of minutes.


To edit a file, invoke it with vimpack ; For instance :

        vimpack cnt4.F90


This will edit the last version of this file. If you modify it and save it, it will be saved automatically in the 'local' directory of the pack.
It is possible to commit temporary edited files using the command :C from the editor window. Writing a temporary file (using :w) will automatically commit the file if it has been modified.


To navigate, move the cursor on a word and press <TAB>.
To go back, press <BACKSPACE>.


To dive directly from a subroutine (or a module or a defined type) to another one called by it (or a USE statement or a declaration statement), move the cursor on its name and press <²> or <œ>.
If this definition is not found, then the ordinary search results will be displayed.

To search for a word, use the command :F from the editor window ; for instance :

        :F MYPROC

The text research is such that :
- case are insensitive
- strings and comments are taken into acount
- keywords are searched as well

If the cursor is over a word, this word can be looked up using <TAB> as well.

When viewing a search result, it is possible to jump to a particular location : just move the cursor to a file name or a line number and press <TAB>.


To edit a file in 'diff' mode (assuming this file has been modified in an intermediate or local pack), invoke vimpack with the option -d ; example :

        vimpack -d cnt0.F90


List of commands from the editor window :


:F string Finds all occurrences of string in the code.
:C Commit a temporary file (if modified) to src/local.
:Cq Commit to src/local (if file was modified) and exit.
:E filename Edit filename
:D Difference of the current file with the N-1 version.
<TAB> Search for the word under the cursor.
<²> Search for entity definition and dive to it (when possible).
<œ> same as <²>
<BACKSPACE> Go back in the history.
:NF newfilename Edit a new file named newfilename in the directory src/local
<SHIFT-TAB> Same as <TAB> but in an new split window
:help vimpack On-line help


 

ENVIRONNEMENT

VIMPACKVIM
vim editor used. Default is 'vim'. Export VIMPACKVIM=gvim if you wish to use the graphical interface of vim.

 

AUTHOR

Philippe Marguinaud <philippe.marguinaud@meteo.fr>


 

Index

NAME
SYNOPSIS
DESCRIPTION
ENVIRONNEMENT
AUTHOR

This document was created by man2html, using the manual pages.
Time: 14:15:33 GMT, June 17, 2014