← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/configuration.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-11-04 18:51:39 UTC
  • mfrom: (2961.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20071104185139-kaio3sneodg2kp71
Authentication ring implementation (read-only)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/configuration.txt
64
64
The path where Bazaar should look for shell plugin external commands.
65
65
 
66
66
 
67
 
Location of configuration files
68
 
===============================
69
 
Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first
70
 
one, named ``bazaar.conf``, includes default configuration options. The other
71
 
file, ``locations.conf``, contains configuration information for specific
72
 
branch locations.  These files are sometimes referred to as ``ini files``.
 
67
Configuration files
 
68
===================
 
69
 
 
70
Location
 
71
--------
 
72
 
 
73
Configuration files are located in ``$HOME/.bazaar`` and are
 
74
sometimes referred to as ``ini files``:
 
75
 
 
76
* ``bazaar.conf`` describes default configuration options,
 
77
 
 
78
* ``locations.conf`` describes configuration information for
 
79
  specific branch locations,
 
80
 
 
81
* ``authentication.conf`` describes credential information for
 
82
  remote servers.
73
83
 
74
84
Each branch can also contain a configuration file that sets values specific
75
85
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
78
88
can do so in ``locations.conf``.
79
89
 
80
90
General Format
81
 
==============
 
91
--------------
 
92
 
82
93
An ini file has three types of contructs: section headers, section
83
94
variables and comments.
84
95
 
85
96
Comments
86
 
--------
 
97
~~~~~~~~
87
98
A comment is any line that starts with a "#" (sometimes called a "hash
88
99
mark", "pound sign" or "number sign"). Comment lines are ignored by
89
100
Bazaar when parsing ini files.
90
101
 
91
102
Section Headers
92
 
---------------
 
103
~~~~~~~~~~~~~~~
93
104
A section header is a word enclosed in brackets that starts at the begining
94
105
of a line.  A typical section header looks like this::
95
106
 
109
120
 
110
121
 
111
122
Section Variables
112
 
-----------------
 
123
~~~~~~~~~~~~~~~~~
113
124
 
114
125
A section variable resides within a section. A section variable contains a
115
126
variable name, an equals sign and a value.  For example::
119
130
 
120
131
 
121
132
Variable Policies
122
 
-----------------
 
133
~~~~~~~~~~~~~~~~~
123
134
 
124
135
Variables defined in a section affect the named directory or URL plus
125
136
any locations they contain.  Policies can be used to change how a
164
175
    check_signatures  = check-available
165
176
    create_signatures = when-required
166
177
 
167
 
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for a
168
 
specific branch. The format is almost identical to the default section in
169
 
bazaar.conf with one significant change: The section header, instead of
170
 
saying default, will be the path to a branch that you wish to override a
171
 
value for. The '?' and '*' wildcards are supported::
 
178
 
 
179
The branch location configuration file, locations.conf
 
180
------------------------------------------------------
 
181
 
 
182
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for
 
183
a specific branch. The format is almost identical to the default section in
 
184
bazaar.conf with one significant change: The section header, instead of saying
 
185
default, will be the path to a branch that you wish to override a value
 
186
for. The '?' and '*' wildcards are supported::
172
187
 
173
188
    [/home/jdoe/branches/nethack]
174
189
    email = Nethack Admin <nethack@nethack.com>
180
195
    [http://bazaar-vcs.org/bzr/*]
181
196
    check_signatures  = require
182
197
 
 
198
The authentication configuration file, authentication.conf
 
199
----------------------------------------------------------
 
200
 
 
201
``$HOME/.bazaar/authentication.conf`` allows one to specify credentials for
 
202
remote servers. This can be used for all the supported transports and any part
 
203
of bzr that requires authentication (smtp for example).
 
204
 
 
205
The syntax of the file obeys the same rules as the others except for the
 
206
variable policies which don't apply.
 
207
 
 
208
For more information on the possible uses of the authentication configuration
 
209
file see the `authentication configuration file documentation`_.
 
210
 
 
211
.. _authentication configuration file documentation: authentication_conf.html
 
212
 
183
213
Common Variable Options
184
214
=======================
185
215