← 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: Ian Clatworthy
  • Date: 2007-11-14 03:50:56 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071114035056-72l6odzpby4bcmub
First cut at new look User Guide including chapters 1 and 2

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
 
=================================
 
1
Using aliases
 
2
=============
 
3
 
 
4
What are aliases?
 
5
-----------------
4
6
 
5
7
Command aliases are an easy way to customize the behaviour of Bazaar. Aliases
6
8
are an easy way to create shortcuts for commonly-typed commands, or to set
7
9
defaults for commands.
8
10
 
 
11
Defining aliases
 
12
----------------
 
13
 
9
14
Command aliases can be defined in the ``[ALIASES]`` section of your
10
15
``.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
equal sign, then a command fragment.  Here's an example ALIASES section::
16
17
 
17
18
    [ALIASES]
18
19
    recentlog=log -r-3..-1
20
21
    commit=commit --strict
21
22
    diff=diff --diff-options -p
22
23
 
23
 
Explanation of examples
24
 
=======================
 
24
Here are the explanations of the examples above:
25
25
 
26
26
 * The first alias makes a new ``recentlog`` command that shows the logs for the
27
27
   last three revisions
30
30
   files in the tree are not recognized.
31
31
 * the ``diff`` alias adds the coveted -p option to diff
32
32
 
33
 
Using the Aliases
34
 
=================
 
33
Using the aliases
 
34
-----------------
 
35
 
35
36
The aliases defined above would be used like so: ::
36
37
 
37
38
   % bzr recentlog
39
40
   % bzr commit
40
41
   % bzr diff
41
42
 
42
 
Rules for Aliases
43
 
=================
 
43
Rules for aliases
 
44
-----------------
44
45
 
45
46
 * You can override a portion of the options given in an alias by
46
47
   specifying the new part on the command-line.  For example, if