← 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

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
 
9
 
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:
 
10
Defining aliases
 
11
----------------
12
12
 
13
 
Examples
14
 
========
15
 
A typical example::
 
13
Command aliases can be defined in the ``[ALIASES]`` section of your
 
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
 
 * The first alias makes a new 'recentlog' command that shows the logs for the
 
25
 * The first alias makes a new ``recentlog`` command that shows the logs for the
27
26
   last three revisions
28
 
 * The **ll** alias shows the last 10 log entries in line format.
29
 
 * the **commit** alias sets the default for commit to refuse to commit if new
 
27
 * The ``ll`` alias shows the last 10 log entries in line format.
 
28
 * the ``commit`` alias sets the default for commit to refuse to commit if new
30
29
   files in the tree are not recognized.
31
 
 * the **diff** alias adds the coveted -p option to diff
32
 
 
33
 
 
34
 
Rules for Aliases
35
 
=================
36
 
 
37
 
 * You can override parts of the options given in an alias by overriding it.
38
 
   For example, if you run **lastlog -r-5..**, you will only get five
39
 
   line-based log entries instead of 10.
 
30
 * the ``diff`` alias adds the coveted -p option to diff
 
31
 
 
32
Using the aliases
 
33
-----------------
 
34
 
 
35
The aliases defined above would be used like so: ::
 
36
 
 
37
   % bzr recentlog
 
38
   % bzr ll
 
39
   % bzr commit
 
40
   % bzr diff
 
41
 
 
42
Rules for aliases
 
43
-----------------
 
44
 
 
45
 * You can override a portion of the options given in an alias by
 
46
   specifying the new part on the command-line.  For example, if
 
47
   you run ``lastlog -r-5..``, you will only get five line-based log
 
48
   entries instead of 10.  Note that all boolean options have an
 
49
   implicit inverse, so you can override the commit alias with
 
50
   ``commit --no-strict``.
 
51
 
40
52
 * Aliases can override the standard behaviour of existing commands by giving
41
 
   an alias name that is thesame as the orignal command. For example, default
42
 
   commit is changed with **commit=commit --strict**.
43
 
 * Aliases can not refer to other aliases. In other words making a
44
 
   **lastlog** alias and referring to it with a **ll** alias will not work.
45
 
 
46
 
This includes aliases that override standard commands
47
 
 
48
 
 * Giving the **--no-aliases** to the bzr command will tell it to ignore aliases
49
 
   for that run. For example, running **bzr --no-aliases commit** will perform a
50
 
   standard commit instead not do a **commit --strict**.
 
53
   an alias name that is the same as the original command. For example, default
 
54
   commit is changed with ``commit=commit --strict``.
 
55
 
 
56
 * Aliases cannot refer to other aliases. In other words making a
 
57
   ``lastlog`` alias and referring to it with a ``ll`` alias will not work.
 
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
 
61
   for that run. For example, running ``bzr --no-aliases commit`` will perform a
 
62
   standard commit instead, not do a ``commit --strict``.
51
63