~bzr-pqm/bzr/bzr.dev

2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
1
Installing Bazaar
2
=================
3
5278.1.5 by Martin Pool
Correct more sloppy use of the term 'Linux'
4
GNU/Linux
5
---------
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
6
5278.1.5 by Martin Pool
Correct more sloppy use of the term 'Linux'
7
Bazaar packages are available for most popular GNU/Linux distributions
8
including Ubuntu, Debian, Red Hat and Gentoo.
5050.22.1 by John Arbash Meinel
Lots of documentation updates.
9
See http://wiki.bazaar.canonical.com/Download for the latest instructions.
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
10
11
Windows
12
-------
13
14
For Windows users, an installer is available that includes
15
the core Bazaar package together with necessary pre-requisites
16
and some useful plug-ins.
5050.22.1 by John Arbash Meinel
Lots of documentation updates.
17
See http://wiki.bazaar.canonical.com/Download for the latest instructions.
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
18
19
Note: If you are running Cygwin on Windows, a Bazaar for Cygwin package
20
is available and ought to be used instead of the Windows version.
21
22
Other operating systems
23
-----------------------
24
25
Beyond Linux and Windows, Bazaar packages are available for a large
26
range of other operating systems include Mac OS X, FreeBSD and Solaris.
5050.22.1 by John Arbash Meinel
Lots of documentation updates.
27
See http://wiki.bazaar.canonical.com/Download for the latest instructions.
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
28
29
30
Installing from scratch
31
-----------------------
32
33
If you wish to install Bazaar from scratch rather than using a
34
pre-built package, the steps are:
35
36
  1. If it is not installed already, install Python 2.4 or later.
37
38
  2. Download the ``bazaar-xxx.tar.gz`` file (where xxx is the version
5050.22.1 by John Arbash Meinel
Lots of documentation updates.
39
     number) from http://wiki.bazaar.canonical.com/Download or from Launchpad
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
40
     (https://launchpad.net/~bzr/).
41
42
  3. Unpack the archive using tar, WinZip or equivalent.
43
44
  4. Put the created directory on your PATH.
45
46
To test the installation, try running the **bzr** command like this::
47
48
  bzr version
49
50
This will display the version of Bazaar you have installed. If this
51
doesn't work, please contact us via email or IRC so we can help you
52
get things working.
53
54
3928.4.2 by John Arbash Meinel
Document the build_ext portion of 'install' when not using extensions.
55
Installing into site-wide locations
56
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57
58
Instead of adding the directory to your PATH, you can install bzr into the
59
system locations using::
60
61
  python setup.py install
62
63
If you do not have a compiler, or do not have the python development tools
64
installed, bzr supplies a (slower) pure-python implementation of all
65
extensions. You can install without compiling extensions with::
66
4300.4.3 by Martin Pool
Typo correction to install instructions (thanks Richard B)
67
  python setup.py install build_ext --allow-python-fallback
3928.4.2 by John Arbash Meinel
Document the build_ext portion of 'install' when not using extensions.
68
69
70
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
71
Running the development version
72
-------------------------------
73
3309.1.1 by Ian Clatworthy
Reduce evangelism in the User Guide
74
You may wish to always be using the very latest development version of
75
Bazaar. Note that this is not recommended for
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
76
the majority of users as there is an increased risk of bugs. On the other
77
hand, the development version is remarkably solid (thanks to the processes
3309.1.1 by Ian Clatworthy
Reduce evangelism in the User Guide
78
we follow) and running it makes it easier for you to send us changes for
79
bugs and improvements. It also helps us by having more people testing
80
the latest software.
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
81
82
Here are the steps to follow:
83
84
  1. Install Bazaar using one of the methods given above.
85
86
  2. Get a copy of the development version like this::
87
4634.39.42 by Ian Clatworthy
Launchpad is now the place to grab bzr.dev from
88
       bzr branch lp:bzr
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
89
4634.39.42 by Ian Clatworthy
Launchpad is now the place to grab bzr.dev from
90
  3. Put the created directory on your PATH.
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
91
92
Advanced users may also wish to build the optional C extensions for greater
93
speed. This can be done using ``make`` and requires ``pyrex`` and a C compiler.
94
Please contact us on email or IRC if you need assistance with this.
95
96
97
Running multiple versions
98
-------------------------
99
3309.1.1 by Ian Clatworthy
Reduce evangelism in the User Guide
100
It's easy to have multiple versions of Bazaar installed and to switch
101
between them. To do this,
2977.1.18 by Ian Clatworthy
chapter 2 tweaks
102
simply provide the full pathname to the **bzr** command you wish to run.
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
103
The relevant libraries will be automatically detected and used. Of course,
2977.1.18 by Ian Clatworthy
chapter 2 tweaks
104
if you do not provide a pathname, then the **bzr** used will be the one
105
found on your system path as normal.
2977.1.1 by Ian Clatworthy
First cut at new look User Guide including chapters 1 and 2
106
107
Note that this capability is particularly useful if you wish to run
108
(or test) both the latest released version and the development version say.