← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/using_aliases.txt

  • Committer: Martin Pool
  • Date: 2005-07-04 05:12:59 UTC
  • Revision ID: mbp@sourcefrog.net-20050704051259-a001ad74f39dadb7
- New log --long option

  Patch from William Dodé

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/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
7
 
defaults for commands.
8
 
 
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:
12
 
 
13
 
Examples
14
 
========
15
 
A typical example::
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
 
Explanation of examples
24
 
=======================
25
 
 
26
 
 * The first alias makes a new ``recentlog`` command that shows the logs for the
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
32
 
 
33
 
Using the Aliases
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 orignal command. For example, default
54
 
   commit is changed with ``commit=commit --strict``.
55
 
 * Aliases cannot refer to other aliases. In other words making a
56
 
   ``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
59
 
   for that run. For example, running ``bzr --no-aliases commit`` will perform a
60
 
   standard commit instead not do a ``commit --strict``.
61