Show More
@@ -1,84 +1,84 | |||||
1 | Mercurial supports generating standalone "bundle" files that hold repository |
|
1 | Mercurial supports generating standalone "bundle" files that hold repository | |
2 | data. These "bundles" are typically saved locally and used later or exchanged |
|
2 | data. These "bundles" are typically saved locally and used later or exchanged | |
3 | between different repositories, possibly on different machines. Example |
|
3 | between different repositories, possibly on different machines. Example | |
4 | commands using bundles are :hg:`bundle` and :hg:`unbundle`. |
|
4 | commands using bundles are :hg:`bundle` and :hg:`unbundle`. | |
5 |
|
5 | |||
6 | Generation of bundle files is controlled by a "bundle specification" |
|
6 | Generation of bundle files is controlled by a "bundle specification" | |
7 | ("bundlespec") string. This string tells the bundle generation process how |
|
7 | ("bundlespec") string. This string tells the bundle generation process how | |
8 | to create the bundle. |
|
8 | to create the bundle. | |
9 |
|
9 | |||
10 | A "bundlespec" string is composed of the following elements: |
|
10 | A "bundlespec" string is composed of the following elements: | |
11 |
|
11 | |||
12 | type |
|
12 | type | |
13 | A string denoting the bundle format to use. |
|
13 | A string denoting the bundle format to use. | |
14 |
|
14 | |||
15 | compression |
|
15 | compression | |
16 | Denotes the compression engine to use compressing the raw bundle data. |
|
16 | Denotes the compression engine to use compressing the raw bundle data. | |
17 |
|
17 | |||
18 | parameters |
|
18 | parameters | |
19 | Arbitrary key-value parameters to further control bundle generation. |
|
19 | Arbitrary key-value parameters to further control bundle generation. | |
20 |
|
20 | |||
21 | A "bundlespec" string has the following formats: |
|
21 | A "bundlespec" string has the following formats: | |
22 |
|
22 | |||
23 | <type> |
|
23 | <type> | |
24 | The literal bundle format string is used. |
|
24 | The literal bundle format string is used. | |
25 |
|
25 | |||
26 | <compression>-<type> |
|
26 | <compression>-<type> | |
27 | The compression engine and format are delimited by a hyphen (``-``). |
|
27 | The compression engine and format are delimited by a hyphen (``-``). | |
28 |
|
28 | |||
29 | Optional parameters follow the ``<type>``. Parameters are URI escaped |
|
29 | Optional parameters follow the ``<type>``. Parameters are URI escaped | |
30 | ``key=value`` pairs. Each pair is delimited by a semicolon (``;``). The |
|
30 | ``key=value`` pairs. Each pair is delimited by a semicolon (``;``). The | |
31 | first parameter begins after a ``;`` immediately following the ``<type>`` |
|
31 | first parameter begins after a ``;`` immediately following the ``<type>`` | |
32 | value. |
|
32 | value. | |
33 |
|
33 | |||
34 | Available Types |
|
34 | Available Types | |
35 | =============== |
|
35 | =============== | |
36 |
|
36 | |||
37 | The following bundle <type> strings are available: |
|
37 | The following bundle <type> strings are available: | |
38 |
|
38 | |||
39 | v1 |
|
39 | v1 | |
40 | Produces a legacy "changegroup" version 1 bundle. |
|
40 | Produces a legacy "changegroup" version 1 bundle. | |
41 |
|
41 | |||
42 | This format is compatible with nearly all Mercurial clients because it is |
|
42 | This format is compatible with nearly all Mercurial clients because it is | |
43 | the oldest. However, it has some limitations, which is why it is no longer |
|
43 | the oldest. However, it has some limitations, which is why it is no longer | |
44 | the default for new repositories. |
|
44 | the default for new repositories. | |
45 |
|
45 | |||
46 | ``v1`` bundles can be used with modern repositories using the "generaldelta" |
|
46 | ``v1`` bundles can be used with modern repositories using the "generaldelta" | |
47 | storage format. However, it may take longer to produce the bundle and the |
|
47 | storage format. However, it may take longer to produce the bundle and the | |
48 | resulting bundle may be significantly larger than a ``v2`` bundle. |
|
48 | resulting bundle may be significantly larger than a ``v2`` bundle. | |
49 |
|
49 | |||
50 | ``v1`` bundles can only use the ``gzip``, ``bzip2``, and ``none`` compression |
|
50 | ``v1`` bundles can only use the ``gzip``, ``bzip2``, and ``none`` compression | |
51 | formats. |
|
51 | formats. | |
52 |
|
52 | |||
53 | v2 |
|
53 | v2 | |
54 | Produces a version 2 bundle. |
|
54 | Produces a version 2 bundle. | |
55 |
|
55 | |||
56 | Version 2 bundles are an extensible format that can store additional |
|
56 | Version 2 bundles are an extensible format that can store additional | |
57 | repository data (such as bookmarks and phases information) and they can |
|
57 | repository data (such as bookmarks and phases information) and they can | |
58 | store data more efficiently, resulting in smaller bundles. |
|
58 | store data more efficiently, resulting in smaller bundles. | |
59 |
|
59 | |||
60 | Version 2 bundles can also use modern compression engines, such as |
|
60 | Version 2 bundles can also use modern compression engines, such as | |
61 | ``zstd``, making them faster to compress and often smaller. |
|
61 | ``zstd``, making them faster to compress and often smaller. | |
62 |
|
62 | |||
63 | Available Compression Engines |
|
63 | Available Compression Engines | |
64 | ============================= |
|
64 | ============================= | |
65 |
|
65 | |||
66 | The following bundle <compression> engines can be used: |
|
66 | The following bundle <compression> engines can be used: | |
67 |
|
67 | |||
68 | .. bundlecompressionmarker |
|
68 | .. bundlecompressionmarker | |
69 |
|
69 | |||
70 | Examples |
|
70 | Examples | |
71 | ======== |
|
71 | ======== | |
72 |
|
72 | |||
73 | ``v2`` |
|
73 | ``v2`` | |
74 | Produce a ``v2`` bundle using default options, including compression. |
|
74 | Produce a ``v2`` bundle using default options, including compression. | |
75 |
|
75 | |||
76 | ``none-v1`` |
|
76 | ``none-v1`` | |
77 |
Produce a ``v |
|
77 | Produce a ``v1`` bundle with no compression. | |
78 |
|
78 | |||
79 | ``zstd-v2`` |
|
79 | ``zstd-v2`` | |
80 | Produce a ``v2`` bundle with zstandard compression using default |
|
80 | Produce a ``v2`` bundle with zstandard compression using default | |
81 | settings. |
|
81 | settings. | |
82 |
|
82 | |||
83 | ``zstd-v1`` |
|
83 | ``zstd-v1`` | |
84 | This errors because ``zstd`` is not supported for ``v1`` types. |
|
84 | This errors because ``zstd`` is not supported for ``v1`` types. |
@@ -1,148 +1,148 | |||||
1 | Mercurial colorizes output from several commands. |
|
1 | Mercurial colorizes output from several commands. | |
2 |
|
2 | |||
3 | For example, the diff command shows additions in green and deletions |
|
3 | For example, the diff command shows additions in green and deletions | |
4 | in red, while the status command shows modified files in magenta. Many |
|
4 | in red, while the status command shows modified files in magenta. Many | |
5 | other commands have analogous colors. It is possible to customize |
|
5 | other commands have analogous colors. It is possible to customize | |
6 | these colors. |
|
6 | these colors. | |
7 |
|
7 | |||
8 | To enable color (default) whenever possible use:: |
|
8 | To enable color (default) whenever possible use:: | |
9 |
|
9 | |||
10 | [ui] |
|
10 | [ui] | |
11 | color = yes |
|
11 | color = yes | |
12 |
|
12 | |||
13 | To disable color use:: |
|
13 | To disable color use:: | |
14 |
|
14 | |||
15 | [ui] |
|
15 | [ui] | |
16 | color = no |
|
16 | color = no | |
17 |
|
17 | |||
18 | See :hg:`help config.ui.color` for details. |
|
18 | See :hg:`help config.ui.color` for details. | |
19 |
|
19 | |||
20 | .. container:: windows |
|
20 | .. container:: windows | |
21 |
|
21 | |||
22 | The default pager on Windows does not support color, so enabling the pager |
|
22 | The default pager on Windows does not support color, so enabling the pager | |
23 | will effectively disable color. See :hg:`help config.ui.paginate` to disable |
|
23 | will effectively disable color. See :hg:`help config.ui.paginate` to disable | |
24 | the pager. Alternately, MSYS and Cygwin shells provide `less` as a pager, |
|
24 | the pager. Alternately, MSYS and Cygwin shells provide `less` as a pager, | |
25 | which can be configured to support ANSI color mode. |
|
25 | which can be configured to support ANSI color mode. | |
26 |
|
26 | |||
27 | Mode |
|
27 | Mode | |
28 | ==== |
|
28 | ==== | |
29 |
|
29 | |||
30 | Mercurial can use various system to display color. The supported modes are |
|
30 | Mercurial can use various systems to display color. The supported modes are | |
31 | ``ansi``, ``win32``, and ``terminfo``. See :hg:`help config.color` for details |
|
31 | ``ansi``, ``win32``, and ``terminfo``. See :hg:`help config.color` for details | |
32 | about how to control the mode |
|
32 | about how to control the mode. | |
33 |
|
33 | |||
34 | Effects |
|
34 | Effects | |
35 | ======= |
|
35 | ======= | |
36 |
|
36 | |||
37 | Other effects in addition to color, like bold and underlined text, are |
|
37 | Other effects in addition to color, like bold and underlined text, are | |
38 | also available. By default, the terminfo database is used to find the |
|
38 | also available. By default, the terminfo database is used to find the | |
39 | terminal codes used to change color and effect. If terminfo is not |
|
39 | terminal codes used to change color and effect. If terminfo is not | |
40 | available, then effects are rendered with the ECMA-48 SGR control |
|
40 | available, then effects are rendered with the ECMA-48 SGR control | |
41 | function (aka ANSI escape codes). |
|
41 | function (aka ANSI escape codes). | |
42 |
|
42 | |||
43 | The available effects in terminfo mode are 'blink', 'bold', 'dim', |
|
43 | The available effects in terminfo mode are 'blink', 'bold', 'dim', | |
44 | 'inverse', 'invisible', 'italic', 'standout', and 'underline'; in |
|
44 | 'inverse', 'invisible', 'italic', 'standout', and 'underline'; in | |
45 | ECMA-48 mode, the options are 'bold', 'inverse', 'italic', and |
|
45 | ECMA-48 mode, the options are 'bold', 'inverse', 'italic', and | |
46 | 'underline'. How each is rendered depends on the terminal emulator. |
|
46 | 'underline'. How each is rendered depends on the terminal emulator. | |
47 | Some may not be available for a given terminal type, and will be |
|
47 | Some may not be available for a given terminal type, and will be | |
48 | silently ignored. |
|
48 | silently ignored. | |
49 |
|
49 | |||
50 | If the terminfo entry for your terminal is missing codes for an effect |
|
50 | If the terminfo entry for your terminal is missing codes for an effect | |
51 | or has the wrong codes, you can add or override those codes in your |
|
51 | or has the wrong codes, you can add or override those codes in your | |
52 | configuration:: |
|
52 | configuration:: | |
53 |
|
53 | |||
54 | [color] |
|
54 | [color] | |
55 | terminfo.dim = \E[2m |
|
55 | terminfo.dim = \E[2m | |
56 |
|
56 | |||
57 | where '\E' is substituted with an escape character. |
|
57 | where '\E' is substituted with an escape character. | |
58 |
|
58 | |||
59 | Labels |
|
59 | Labels | |
60 | ====== |
|
60 | ====== | |
61 |
|
61 | |||
62 | Text receives color effects depending on the labels that it has. Many |
|
62 | Text receives color effects depending on the labels that it has. Many | |
63 | default Mercurial commands emit labelled text. You can also define |
|
63 | default Mercurial commands emit labelled text. You can also define | |
64 | your own labels in templates using the label function, see :hg:`help |
|
64 | your own labels in templates using the label function, see :hg:`help | |
65 | templates`. A single portion of text may have more than one label. In |
|
65 | templates`. A single portion of text may have more than one label. In | |
66 | that case, effects given to the last label will override any other |
|
66 | that case, effects given to the last label will override any other | |
67 | effects. This includes the special "none" effect, which nullifies |
|
67 | effects. This includes the special "none" effect, which nullifies | |
68 | other effects. |
|
68 | other effects. | |
69 |
|
69 | |||
70 | Labels are normally invisible. In order to see these labels and their |
|
70 | Labels are normally invisible. In order to see these labels and their | |
71 | position in the text, use the global --color=debug option. The same |
|
71 | position in the text, use the global --color=debug option. The same | |
72 | anchor text may be associated to multiple labels, e.g. |
|
72 | anchor text may be associated to multiple labels, e.g. | |
73 |
|
73 | |||
74 | [log.changeset changeset.secret|changeset: 22611:6f0a53c8f587] |
|
74 | [log.changeset changeset.secret|changeset: 22611:6f0a53c8f587] | |
75 |
|
75 | |||
76 | The following are the default effects for some default labels. Default |
|
76 | The following are the default effects for some default labels. Default | |
77 | effects may be overridden from your configuration file:: |
|
77 | effects may be overridden from your configuration file:: | |
78 |
|
78 | |||
79 | [color] |
|
79 | [color] | |
80 | status.modified = blue bold underline red_background |
|
80 | status.modified = blue bold underline red_background | |
81 | status.added = green bold |
|
81 | status.added = green bold | |
82 | status.removed = red bold blue_background |
|
82 | status.removed = red bold blue_background | |
83 | status.deleted = cyan bold underline |
|
83 | status.deleted = cyan bold underline | |
84 | status.unknown = magenta bold underline |
|
84 | status.unknown = magenta bold underline | |
85 | status.ignored = black bold |
|
85 | status.ignored = black bold | |
86 |
|
86 | |||
87 | # 'none' turns off all effects |
|
87 | # 'none' turns off all effects | |
88 | status.clean = none |
|
88 | status.clean = none | |
89 | status.copied = none |
|
89 | status.copied = none | |
90 |
|
90 | |||
91 | qseries.applied = blue bold underline |
|
91 | qseries.applied = blue bold underline | |
92 | qseries.unapplied = black bold |
|
92 | qseries.unapplied = black bold | |
93 | qseries.missing = red bold |
|
93 | qseries.missing = red bold | |
94 |
|
94 | |||
95 | diff.diffline = bold |
|
95 | diff.diffline = bold | |
96 | diff.extended = cyan bold |
|
96 | diff.extended = cyan bold | |
97 | diff.file_a = red bold |
|
97 | diff.file_a = red bold | |
98 | diff.file_b = green bold |
|
98 | diff.file_b = green bold | |
99 | diff.hunk = magenta |
|
99 | diff.hunk = magenta | |
100 | diff.deleted = red |
|
100 | diff.deleted = red | |
101 | diff.inserted = green |
|
101 | diff.inserted = green | |
102 | diff.changed = white |
|
102 | diff.changed = white | |
103 | diff.tab = |
|
103 | diff.tab = | |
104 | diff.trailingwhitespace = bold red_background |
|
104 | diff.trailingwhitespace = bold red_background | |
105 |
|
105 | |||
106 | # Blank so it inherits the style of the surrounding label |
|
106 | # Blank so it inherits the style of the surrounding label | |
107 | changeset.public = |
|
107 | changeset.public = | |
108 | changeset.draft = |
|
108 | changeset.draft = | |
109 | changeset.secret = |
|
109 | changeset.secret = | |
110 |
|
110 | |||
111 | resolve.unresolved = red bold |
|
111 | resolve.unresolved = red bold | |
112 | resolve.resolved = green bold |
|
112 | resolve.resolved = green bold | |
113 |
|
113 | |||
114 | bookmarks.active = green |
|
114 | bookmarks.active = green | |
115 |
|
115 | |||
116 | branches.active = none |
|
116 | branches.active = none | |
117 | branches.closed = black bold |
|
117 | branches.closed = black bold | |
118 | branches.current = green |
|
118 | branches.current = green | |
119 | branches.inactive = none |
|
119 | branches.inactive = none | |
120 |
|
120 | |||
121 | tags.normal = green |
|
121 | tags.normal = green | |
122 | tags.local = black bold |
|
122 | tags.local = black bold | |
123 |
|
123 | |||
124 | rebase.rebased = blue |
|
124 | rebase.rebased = blue | |
125 | rebase.remaining = red bold |
|
125 | rebase.remaining = red bold | |
126 |
|
126 | |||
127 | shelve.age = cyan |
|
127 | shelve.age = cyan | |
128 | shelve.newest = green bold |
|
128 | shelve.newest = green bold | |
129 | shelve.name = blue bold |
|
129 | shelve.name = blue bold | |
130 |
|
130 | |||
131 | histedit.remaining = red bold |
|
131 | histedit.remaining = red bold | |
132 |
|
132 | |||
133 | Custom colors |
|
133 | Custom colors | |
134 | ============= |
|
134 | ============= | |
135 |
|
135 | |||
136 | Because there are only eight standard colors, Mercurial allows you |
|
136 | Because there are only eight standard colors, Mercurial allows you | |
137 | to define color names for other color slots which might be available |
|
137 | to define color names for other color slots which might be available | |
138 | for your terminal type, assuming terminfo mode. For instance:: |
|
138 | for your terminal type, assuming terminfo mode. For instance:: | |
139 |
|
139 | |||
140 | color.brightblue = 12 |
|
140 | color.brightblue = 12 | |
141 | color.pink = 207 |
|
141 | color.pink = 207 | |
142 | color.orange = 202 |
|
142 | color.orange = 202 | |
143 |
|
143 | |||
144 | to set 'brightblue' to color slot 12 (useful for 16 color terminals |
|
144 | to set 'brightblue' to color slot 12 (useful for 16 color terminals | |
145 | that have brighter colors defined in the upper eight) and, 'pink' and |
|
145 | that have brighter colors defined in the upper eight) and, 'pink' and | |
146 | 'orange' to colors in 256-color xterm's default color cube. These |
|
146 | 'orange' to colors in 256-color xterm's default color cube. These | |
147 | defined colors may then be used as any of the pre-defined eight, |
|
147 | defined colors may then be used as any of the pre-defined eight, | |
148 | including appending '_background' to set the background to that color. |
|
148 | including appending '_background' to set the background to that color. |
General Comments 0
You need to be logged in to leave comments.
Login now