← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to README.txt

Added distutils setup script and plugin meta data.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
1
 
=========================================
2
 
  bzr bash-completion script and plugin
3
 
=========================================
 
1
.. comment
 
2
 
 
3
  Copyright (C) 2010  Martin von Gagern
 
4
 
 
5
  This file is part of bzr-bash-completion
 
6
 
 
7
  bzr-bash-completion free software: you can redistribute it and/or
 
8
  modify it under the terms of the GNU General Public License as
 
9
  published by the Free Software Foundation, either version 2 of the
 
10
  License, or (at your option) any later version.
 
11
 
 
12
  bzr-bash-completion is distributed in the hope that it will be
 
13
  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 
14
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
15
  General Public License for more details.
 
16
 
 
17
  You should have received a copy of the GNU General Public License
 
18
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
19
 
 
20
=====================================
 
21
bzr bash-completion script and plugin
 
22
=====================================
4
23
 
5
24
This script generates a shell function which can be used by bash to
6
25
automatically complete the currently typed command when the user
7
26
presses the completion key (usually tab).
8
27
 
9
 
It can be used either as a bzr plugin or directly.
10
 
 
11
 
----------------------------------------
12
 
 Installing as a plugin
13
 
----------------------------------------
 
28
It is intended as a bzr plugin, but can be used to some extend as a
 
29
standalone python script as well.
 
30
 
 
31
| Copyright (C) 2009, 2010 Martin von Gagern <Martin.vGagern@gmx.net>
 
32
 
 
33
.. contents::
 
34
 
 
35
----------
 
36
Installing
 
37
----------
14
38
 
15
39
You only need to do this if you want to use the script as a bzr
16
40
plugin.  Otherwise simply grab the bashcomp.py and place it wherever
17
41
you want.
18
42
 
 
43
Installing from bzr repository
 
44
------------------------------
 
45
 
 
46
To check out the current code from launchpad, use the following commands::
 
47
 
19
48
  mkdir -p ~/.bazaar/plugins
20
49
  cd ~/.bazaar/plugins
21
50
  bzr co lp:bzr-bash-completion bash_completion
22
51
 
23
 
 
24
 
----------------------------------------
25
 
 Using as a plugin
26
 
----------------------------------------
 
52
Installing using easy_install
 
53
-----------------------------
 
54
 
 
55
The following command should install the latest release of the plugin
 
56
on your system::
 
57
 
 
58
  easy_install bzr-bash-completion
 
59
 
 
60
-----
 
61
Using
 
62
-----
 
63
 
 
64
Using as a plugin
 
65
-----------------
27
66
 
28
67
This is the preferred method of generating initializing the
29
68
completion, as it will ensure proper bzr initialization.
30
69
 
 
70
::
 
71
 
31
72
  eval "`bzr bash-completion`"
32
73
 
33
74
 
34
 
----------------------------------------
35
 
 Using as a script
36
 
----------------------------------------
 
75
Using as a script
 
76
-----------------
37
77
 
38
78
As an alternative, if bzrlib is available to python scripts, the
39
79
following invocation should yield the same results without requiring
40
 
you to add a plugin. Might have some issues, though.
 
80
you to add a plugin::
41
81
 
42
82
  eval "`./bashcomp.py`"
43
83
 
44
 
----------------------------------------
45
 
 Design concept
46
 
----------------------------------------
 
84
This approach might have some issues, though, and provides less
 
85
options than the bzr plugin. Therefore if you have the choice, go for
 
86
the plugin setup.
 
87
 
 
88
--------------
 
89
Design concept
 
90
--------------
47
91
 
48
92
The plugin (or script) is designed to generate a completion function
49
93
containing all the required information about the possible
55
99
completions immediately, but only after the completion function has
56
100
been regenerated.
57
101
 
58
 
----------------------------------------
59
 
 License
60
 
----------------------------------------
 
102
-------
 
103
License
 
104
-------
61
105
 
62
106
As this is built upon a bash completion script originally included in
63
107
the bzr source tree, and as the bzr sources are covered by the GPL 2,
67
111
those who contributed code to this plugin, be it for bash or for
68
112
python.
69
113
 
70
 
----------------------------------------
71
 
 History
72
 
----------------------------------------
 
114
.. cut long_description here
 
115
 
 
116
-------
 
117
History
 
118
-------
73
119
 
74
120
The plugin was created by Martin von Gagern in 2009, building on a
75
121
static completion function of very limited scope distributed together
76
122
with bzr.
77
123
 
78
 
----------------------------------------
79
 
 References
80
 
----------------------------------------
81
 
 
82
 
https://launchpad.net/bzr-bash-completion
83
 
http://bazaar.canonical.com/
 
124
----------
 
125
References
 
126
----------
 
127
 
 
128
Plugin homepage
 
129
  https://launchpad.net/bzr-bash-completion
 
130
Bazaar homepage
 
131
  http://bazaar.canonical.com/
 
132
 
 
133
 
 
134
 
 
135
.. vim: ft=rst
 
136
 
 
137
.. emacs
 
138
   Local Variables:
 
139
   mode: rst
 
140
   End: