~bzr-pqm/bzr/bzr.dev

1861.2.6 by Alexander Belchenko
branding: change Bazaar-NG to Bazaar
1
=================================
2
Using aliases for Bazaar commands
3
=================================
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
4
1861.2.6 by Alexander Belchenko
branding: change Bazaar-NG to Bazaar
5
Command aliases are an easy way to customize the behaviour of Bazaar. Aliases
1610.2.1 by James Blackwell
Copied in docs for wiki & First round cleanup
6
are an easy way to create shortcuts for commonly-typed commands, or to set
7
defaults for commands.
8
1610.2.2 by James Blackwell
Now they look good in rst2html
9
Command aliases can be defined in the **[ALIASES]** section of your
1610.2.1 by James Blackwell
Copied in docs for wiki & First round cleanup
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
========
1610.2.2 by James Blackwell
Now they look good in rst2html
15
A typical example::
16
1610.2.1 by James Blackwell
Copied in docs for wiki & First round cleanup
17
    [ALIASES]
18
    recentlog=log -r-3..-1
19
    ll=log --line -r-10..-1
20
    commit=commit --strict
21
    diff=diff --diff-options -p
22
23
Explanation of examples
24
=======================
25
26
 * The first alias makes a new 'recentlog' command that shows the logs for the
1610.2.2 by James Blackwell
Now they look good in rst2html
27
   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
30
   files in the tree are not recognized.
31
 * the **diff** alias adds the coveted -p option to diff
1610.2.1 by James Blackwell
Copied in docs for wiki & First round cleanup
32
33
34
Rules for Aliases
35
=================
36
37
 * You can override parts of the options given in an alias by overriding it.
1610.2.2 by James Blackwell
Now they look good in rst2html
38
   For example, if you run **lastlog -r-5..**, you will only get five
1610.2.1 by James Blackwell
Copied in docs for wiki & First round cleanup
39
   line-based log entries instead of 10.
40
 * 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
1610.2.2 by James Blackwell
Now they look good in rst2html
42
   commit is changed with **commit=commit --strict**.
1610.2.1 by James Blackwell
Copied in docs for wiki & First round cleanup
43
 * Aliases can not refer to other aliases. In other words making a
1610.2.2 by James Blackwell
Now they look good in rst2html
44
   **lastlog** alias and referring to it with a **ll** alias will not work.
1610.2.1 by James Blackwell
Copied in docs for wiki & First round cleanup
45
46
This includes aliases that override standard commands
47
1610.2.2 by James Blackwell
Now they look good in rst2html
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**.
51