← 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-09-03 09:14:12 UTC
  • mto: This revision was merged to the branch mainline in revision 5417.
  • Revision ID: mbp@sourcefrog.net-20100903091412-1a40klgfg8c6k3xj
Split out user interaction developer guide to a separate file

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/using_aliases.txt
 
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
 
8
defaults for commands.
 
9
 
 
10
Defining aliases
 
11
----------------
 
12
 
 
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
 
 
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
Here are the explanations of the examples above:
 
24
 
 
25
 * The first alias makes a new ``recentlog`` command that shows the logs for the
 
26
   last three revisions
 
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
 
29
   files in the tree are not recognized.
 
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
 
 
52
 * Aliases can override the standard behaviour of existing commands by giving
 
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``.
 
63