*pi_vimball.txt* For
Vim バージョン 7.3. Last change: 2012 Jan 17
----------------
Vimball Archiver
----------------
Author: Charles E. Campbell, Jr. <NdrOchip@ScampbellPfamily.AbizM>
(remove NOSPAM from Campbell's email first)
Copyright: (c) 2004-2012 by Charles E. Campbell, Jr.
*Vimball-copyright*
The VIM LICENSE (see
|copyright|) applies to the files in this
package, including vimballPlugin.vim, vimball.vim, and pi_vimball.txt.
except use "vimball" instead of "VIM". Like anything else that's free,
vimball.vim and its associated files are provided *as is* and comes with
no warranty of any kind, either expressed or implied. No guarantees
of merchantability. No guarantees of suitability for any purpose. By
using this plugin, you agree that in no event will the copyright
holder be liable for any damages resulting from the use of this
software. Use at your own risk!
==============================================================================
1. 目次
*vba* *vimball* *vimball-contents*
1. 目次..........................................:
|vimball-contents|
2. はじめに......................................:
|vimball-intro|
3. マニュアル....................................:
|vimball-manual|
MkVimball.....................................:
|:MkVimball|
UseVimball....................................:
|:UseVimball|
RmVimball.....................................:
|:RmVimball|
4. 開発履歴......................................:
|vimball-history|
==============================================================================
2. はじめに
*vimball-intro*
Vimball はプラグインの利用方法をシンプルにします。vimball は次のように
実行するだけで利用できます:
すると、プラグインが適切なディレクトリにインストールされます。実行前に
適切なディレクトリに移動する必要なんてありません。プラグインのヘルプも
自動的にインストールされます。
AsNeeded プラグインを使っている場合、vimball は .vim/plugin/ に入る予
定のものを適切に .vim/AsNeeded/ に入れます。
vimball でインストールしたプラグインを削除するのは簡単です:
例えば zip や tarball でインストールした場合はこのように簡単ではありま
せん。
Vimball はユーザーの
|'runtimepath'| 設定を見てスクリプトのインストー
ル場所を決定します。通常は runtimepath の最初の使用可能なディレクトリ
が使われます。次のコマンドでディレクトリを確認できます
==============================================================================
3. マニュアル
*vimball-manual*
VIMBALL の作成
*:MkVimball*
:
[range]MkVimball[!] filename
[path]
作成する vimball に含めるファイルのパスを書き、それらの行を範囲指定し
て実行します。パスは runtimepath (
|'rtp'|) からの相対パスです。例:
この二行を範囲指定して次のように実行すると
"filename.vba" という名前のファイルが作成されます。Vimball.vim を使う
ことでこのファイルから元のファイルを再構成できます。"filename.vba" が
既に存在する場合は警告が表示され、ファイルは作成されません。ファイルの
パスは .vim (vimfiles) ディレクトリからの相対パスで、ファイルが存在し
ている必要があります。通常は
|'runtimepath'| の最初のディレクトリが相
対パスのルートとして使われます。特別な理由がない限り絶対パスを使わない
でください。
感嘆符 (!) を指定すると、既存の "filename.vba" は上書きされます。
|:w| コマンドの動作と同じようなものです。
ファイル名にスラッシュを含めたい場合も感嘆符を付ける必要があります
(例: :MkVimball! path/filename)。
http://vim.wikia.com/wiki/Using_VimBall_with_%27Make%27 に、作品の
vimball の作成を make を使って自動化するためのチップが掲載されていま
す。
VIMBALL によるディレクトリの作成
*g:vimball_mkdir*
最初に
|mkdir()| コマンドが試されます (それをサポートしていないシステ
ムもあります)。
|mkdir()| が使えず、g:vimball_mkdir が設定されていない場合は、次の順番
で設定されます:
g:vimball_mkdir にはディレクトリ作成コマンドを指定します。自分で設定す
ることもできます。このコマンドは vimball 展開時にディレクトリを作成す
るために使われます。
VIMBALL を展開するディレクトリの設定
*g:vimball_home*
vimball によって使用される
|'runtimepath'| を指定したい場合は
g:vimball_home 変数を設定してください。
*vimball-extract*
vim filename.vba
ファイルを展開するには、Vimball ファイルを Vim で開き、そのファイルを
実行 (:source %) してください。
Vimball ファイルの一行目が "Vimball Archiver by Charles E. Campbell,
Jr., Ph.D." となっている場合のみ、ファイルを展開できます。
VIMBALL 内のファイルを一覧表示する
*:VimballList*
:VimballList
このコマンドを実行すると、Vimball ファイルに含まれているファイルと、そ
れぞれの行数が表示されます。
VIMBALL の展開を手動で呼び出す
*:UseVimball*
:UseVimball
[path]
このコマンドは vimball に埋め込まれます。これは vimbal#Vimball() を呼
び出して vimball を展開します。vimball を実行する代わりに、このコマン
ドを自分で実行しても構いません。その場合、インストール先のパスを指定で
きます。指定がない場合は
|'runtimepath'| の最初の存在するディレクトリ
が使用されます。
VIMBALL の削除
*:RmVimball*
:RmVimball vimballfile
[path]
vimball に含まれていたすべてのファイルを削除します (ディレクトリは削除
されません)。アンインストール元のパスを指定できます (
|'runtimepath'|参
照)。指定がない場合は
|'runtimepath'| の最初の存在するディレクトリが使
用されます。
この機能を実現するため、インストールパスに .VimballRecord というファイ
ルが作成され、削除すべきファイル (それまでに vimball によってインス
トールされたファイル) が記録されます。
ロードの無効化
もしなんらかの理由で vimballs プラグインを使いたくない場合は、次の二つ
の変数を <.vimrc> で設定すると、vimball.vim の読み込みを無効化できま
す:
WINDOWS *vimball-windows*
多くの vimball ファイルは gzip で圧縮されています。残念ながら Windows
には gzip 圧縮されたファイルを展開するためのツールが含まれていません。
しかし幸運にも、Windows ユーザーにも使える gzip 展開ツールがいくつかあ
ります:
==============================================================================
+-- 91 行:4. 開発履歴 *vimball-history*