← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Martin Pool
  • Date: 2010-01-29 10:36:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4992.
  • Revision ID: mbp@sourcefrog.net-20100129103623-hywka5hymo5z13jw
Change url to canonical.com or wiki, plus some doc improvements in passing

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/using_aliases.txt
1
 
=================================
2
 
Using aliases for Bazaar commands
3
 
=================================
4
 
 
5
 
Command aliases are an easy way to customize the behaviour of Bazaar. Aliases
6
 
are an easy way to create shortcuts for commonly-typed commands, or to set
 
1
Using aliases
 
2
=============
 
3
 
 
4
What are aliases?
 
5
-----------------
 
6
 
 
7
Aliases are an easy way to create shortcuts for commonly-typed commands, or to set
7
8
defaults for commands.
8
9
 
 
10
Defining aliases
 
11
----------------
 
12
 
9
13
Command aliases can be defined in the ``[ALIASES]`` section of your
10
 
``.bazaar/bazaar.conf`` file. Aliases start with the alias name, then an
11
 
equal sign, then a command fragment.  Here's an example ALIASES section:
12
 
 
13
 
Examples
14
 
========
15
 
A typical example::
 
14
``bazaar.conf`` file. Aliases start with the alias name, then an
 
15
equal sign, then a command fragment.  Here's an example ALIASES section::
16
16
 
17
17
    [ALIASES]
18
18
    recentlog=log -r-3..-1
20
20
    commit=commit --strict
21
21
    diff=diff --diff-options -p
22
22
 
23
 
Explanation of examples
24
 
=======================
 
23
Here are the explanations of the examples above:
25
24
 
26
25
 * The first alias makes a new ``recentlog`` command that shows the logs for the
27
26
   last three revisions
30
29
   files in the tree are not recognized.
31
30
 * the ``diff`` alias adds the coveted -p option to diff
32
31
 
33
 
Using the Aliases
34
 
=================
 
32
Using the aliases
 
33
-----------------
 
34
 
35
35
The aliases defined above would be used like so: ::
36
36
 
37
37
   % bzr recentlog
39
39
   % bzr commit
40
40
   % bzr diff
41
41
 
42
 
Rules for Aliases
43
 
=================
 
42
Rules for aliases
 
43
-----------------
44
44
 
45
45
 * You can override a portion of the options given in an alias by
46
46
   specifying the new part on the command-line.  For example, if
50
50
   ``commit --no-strict``.
51
51
 
52
52
 * Aliases can override the standard behaviour of existing commands by giving
53
 
   an alias name that is the same as the orignal command. For example, default
 
53
   an alias name that is the same as the original command. For example, default
54
54
   commit is changed with ``commit=commit --strict``.
 
55
 
55
56
 * Aliases cannot refer to other aliases. In other words making a
56
57
   ``lastlog`` alias and referring to it with a ``ll`` alias will not work.
57
 
   This includes aliases that override standard commands
58
 
 * Giving the ``--no-aliases`` to the bzr command will tell it to ignore aliases
 
58
   This includes aliases that override standard commands.
 
59
 
 
60
 * Giving the ``--no-aliases`` option to the bzr command will tell it to ignore aliases
59
61
   for that run. For example, running ``bzr --no-aliases commit`` will perform a
60
 
   standard commit instead not do a ``commit --strict``.
 
62
   standard commit instead, not do a ``commit --strict``.
61
63