~bzr-pqm/bzr/bzr.dev

4634.99.1 by Naoki INADA
import doc-ja rev90
1
プラグインを利用する
2
=====================
3
4
.. Information on how to use plugins in Bazaar.
5
6
プラグインとは?
7
-----------------
8
9
プラグインは主にサードパーティによって作られたBazaarのための外部コンポーネントです。
10
プラグインは新しい機能を追加することでBazaarを補強する能力があります。
11
プラグインは現在の機能を置き換えることでBazaarのふるまいを変更することもできます。
12
プラグインのサンプルのアプリケーションは次のとおりです:
13
14
* コマンドをオーバーライドする
15
* 新しいコマンドを追加する
16
* 追加のネットワーク転送機能を提供する
17
* ログの出力をカスタマイズする
18
19
プラグインを通してできるカスタマイズの可能性は際限がありません。
20
実際、開発者が新しい機能を公式のコードベースに含める前にテストするための方法としてプラグインは機能します。
21
プラグインは機能の引退時でも同様に役立ちます。たとえば廃止されたファイルのフォーマットがある日Bazaarのコアから除外されるかもしれませんが\
22
代わりにプラグインとして利用できます。
23
24
プラグインはユーザーにとって、外部の開発者にとっても、Bazaar自身にもよいものです。
25
26
プラグインが見つかる場所
27
-------------------------
28
29
http://bazaar-vcs.org/BzrPlugins ページでプラグインのリストが見つかります。
30
31
プラグインをインストールする方法
32
---------------------------------
33
34
プラグインのインストール作業はとても簡単です! まだ作られていなければ、
35
Bazaarの設定ディレクトリの元で ``plugins`` ディレクトリを作ります。
36
Linuxの場合は ``~/.bazaar/`` でWindowsの場合は
37
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\`` です。
38
このディレクトリの範囲内では(下記では$BZR_HOMEとして言及される) それぞれのプラグインは独自のサブディレクトリに設置されます。
39
40
プラグインはとりわけBazaarのブランチとよく連携します。
41
たとえば、Linuxのメインのユーザーアカウント用にbzrtoolsプラグインをインストールするためには、次のコマンドを実行します::
42
43
    bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
44
    ~/.bazaar/plugins/bzrtools
45
46
プラグインをインストールするディレクトリの名前はPythonの有効な識別子でなければなりません。
47
このことはディレクトリは特定の文字だけを含まなければならないことを意味します。とりわけハイフン (``-``) を含んではなりません。
48
``bzr-gtk`` を ``$BZR_HOME/plugins/bzr-gtk`` にインストールするよりも、 ``$BZR_HOME/plugins/gtk`` にインストールします。
49
50
プラグインの代替用の場所
51
-------------------------
52
53
必要なパーミッションがあれば、プラグインをシステム全体のベースにインストールすることもできます。
54
現在2つの場所がプラグインのためにチェックされます:
55
56
 1. システムの場所 - bzrlib/plugins
57
 2. 個人の場所 - $BZR_HOME/plugins.
58
59
Linuxにおいて、これらの典型的な場所は
60
``/usr/lib/python2.4/site-packages/bzrlib/plugins/`` と
61
``$HOME/.bazaar/plugins/`` です。
62
Windowsにおいて、システムの場所は
63
``C:\\Program Files\\Bazaar\\plugins`` になり、
64
個人の場所は ``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\plugins`` です。
65
66
環境変数 ``BZR_PLUGIN_PATH`` をプラグインが含まれるディレクトリに設定することで\個人のプラグインの場所を上書きできます。
67
68
69
インストールされたプラグインの一覧を表示する
70
---------------------------------------------
71
72
これを行うためには、次のようにpluginsコマンドを使います::
73
74
    bzr plugins
75
76
それぞれのプラグインの名前、場所とバージョンが表示されます。
77
78
プラグインによって追加された新しいコマンドは ``bzr help commands`` を実行することで見ることができます。
79
プラグインによって提供されたコマンドはブラケットの中のプラグインの名前に従って表示されます。
80
81
人気のあるプラグイン
82
--------------------
83
84
次の表は人気のあるプラグインのサンプルです。
85
86
  ================ ================= ==================================
87
  カテゴリ         名前              説明
88
  ================ ================= ==================================
89
  GUI              QBzr              QtベースのGUIツール
90
  GUI              bzr-gtk           GTKベースのGUIツール
91
  GUI              bzr-eclipse       Eclipseとの統合
92
  General          bzrtools          その他。shelfを含めた機能の強化
93
  General          difftools         外部の差分ツールヘルパー
94
  General          extmerge          外部のマージツールヘルパー
95
  Integration      bzr-svn           Subversionをリポジトリとして利用する
96
  Migration        cvsps             CVSパッチセットを移行させる
97
  ================ ================= ==================================
98
99
あなた独自のプラグインを書きたい場合、難しいことではありません。
100
始めるためには付録の `プラグインを書く <writing_a_plugin.html>`_
101
の項目をご覧ください。