##// END OF EJS Templates
hgignore.5: wrap lines at 70 chars (whitespace cleanup)
Martin Geisler -
r8729:f67e5aac default
parent child Browse files
Show More
@@ -1,91 +1,90 b''
1 1 HGIGNORE(5)
2 2 ===========
3 3 Vadim Gelfer <vadim.gelfer@gmail.com>
4 4
5 5 NAME
6 6 ----
7 7 hgignore - syntax for Mercurial ignore files
8 8
9 9 SYNOPSIS
10 10 --------
11 11
12 12 The Mercurial system uses a file called .hgignore in the root
13 13 directory of a repository to control its behavior when it finds files
14 14 that it is not currently managing.
15 15
16 16 DESCRIPTION
17 17 -----------
18 18
19 19 Mercurial ignores every unmanaged file that matches any pattern in an
20 20 ignore file. The patterns in an ignore file do not apply to files
21 managed by Mercurial. To control Mercurial's handling of files that
22 it manages, see the hg(1) man page. Look for the "-I" and "-X"
23 options.
21 managed by Mercurial. To control Mercurial's handling of files that it
22 manages, see the hg(1) man page. Look for the "-I" and "-X" options.
24 23
25 24 In addition, a Mercurial configuration file can point to a set of
26 25 per-user or global ignore files. See the hgrc(5) man page for details
27 26 of how to configure these files. Look for the "ignore" entry in the
28 27 "ui" section.
29 28
30 29 SYNTAX
31 30 ------
32 31
33 32 An ignore file is a plain text file consisting of a list of patterns,
34 with one pattern per line. Empty lines are skipped. The "#"
35 character is treated as a comment character, and the "\" character is
36 treated as an escape character.
33 with one pattern per line. Empty lines are skipped. The "#" character
34 is treated as a comment character, and the "\" character is treated as
35 an escape character.
37 36
38 37 Mercurial supports several pattern syntaxes. The default syntax used
39 38 is Python/Perl-style regular expressions.
40 39
41 40 To change the syntax used, use a line of the following form:
42 41
43 42 syntax: NAME
44 43
45 44 where NAME is one of the following:
46 45
47 46 regexp::
48 47 Regular expression, Python/Perl syntax.
49 48 glob::
50 49 Shell-style glob.
51 50
52 51 The chosen syntax stays in effect when parsing all patterns that
53 52 follow, until another syntax is selected.
54 53
55 54 Neither glob nor regexp patterns are rooted. A glob-syntax pattern of
56 55 the form "*.c" will match a file ending in ".c" in any directory, and
57 a regexp pattern of the form "\.c$" will do the same. To root a
58 regexp pattern, start it with "^".
56 a regexp pattern of the form "\.c$" will do the same. To root a regexp
57 pattern, start it with "^".
59 58
60 59 EXAMPLE
61 60 -------
62 61
63 62 Here is an example ignore file.
64 63
65 64 # use glob syntax.
66 65 syntax: glob
67 66
68 67 *.elc
69 68 *.pyc
70 69 *~
71 70
72 71 # switch to regexp syntax.
73 72 syntax: regexp
74 73 ^\.pc/
75 74
76 75 AUTHOR
77 76 ------
78 77 Vadim Gelfer <vadim.gelfer@gmail.com>
79 78
80 79 Mercurial was written by Matt Mackall <mpm@selenic.com>.
81 80
82 81 SEE ALSO
83 82 --------
84 83 hg(1), hgrc(5)
85 84
86 85 COPYING
87 86 -------
88 87 This manual page is copyright 2006 Vadim Gelfer.
89 88 Mercurial is copyright 2005-2007 Matt Mackall.
90 89 Free use of this software is granted under the terms of the GNU General
91 90 Public License (GPL).
General Comments 0
You need to be logged in to leave comments. Login now