mirror of
https://github.com/tj/git-extras.git
synced 2026-09-10 07:26:17 -04:00
300 lines
11 KiB
HTML
300 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv='content-type' content='text/html;charset=utf-8'>
|
|
<meta name='generator' content='Ronn-NG/v0.10.1 (http://github.com/apjanke/ronn-ng/tree/0.10.1)'>
|
|
<title>git-ignore(1) - Modify or display .gitignore files</title>
|
|
<style type='text/css' media='all'>
|
|
/* style: man */
|
|
body#manpage {margin:0}
|
|
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
|
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
|
.mp h2 {margin:10px 0 0 0}
|
|
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
|
.mp h3 {margin:0 0 0 4ex}
|
|
.mp dt {margin:0;clear:left}
|
|
.mp dt.flush {float:left;width:8ex}
|
|
.mp dd {margin:0 0 0 9ex}
|
|
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
|
.mp pre {margin-bottom:20px}
|
|
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
|
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
|
.mp img {display:block;margin:auto}
|
|
.mp h1.man-title {display:none}
|
|
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
|
.mp h2 {font-size:16px;line-height:1.25}
|
|
.mp h1 {font-size:20px;line-height:2}
|
|
.mp {text-align:justify;background:#fff}
|
|
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
|
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
|
.mp u {text-decoration:underline}
|
|
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
|
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
|
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
|
.mp b.man-ref {font-weight:normal;color:#434241}
|
|
.mp pre {padding:0 4ex}
|
|
.mp pre code {font-weight:normal;color:#434241}
|
|
.mp h2+pre,h3+pre {padding-left:0}
|
|
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
|
ol.man-decor {width:100%}
|
|
ol.man-decor li.tl {text-align:left}
|
|
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
|
ol.man-decor li.tr {text-align:right;float:right}
|
|
</style>
|
|
</head>
|
|
<!--
|
|
The following styles are deprecated and will be removed at some point:
|
|
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
|
|
|
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
|
.man-navigation should be used instead.
|
|
-->
|
|
<body id='manpage'>
|
|
<div class='mp' id='man'>
|
|
|
|
<div class='man-navigation' style='display:none'>
|
|
<a href="#NAME">NAME</a>
|
|
<a href="#SYNOPSIS">SYNOPSIS</a>
|
|
<a href="#DESCRIPTION">DESCRIPTION</a>
|
|
<a href="#OPTIONS">OPTIONS</a>
|
|
<a href="#EXAMPLES">EXAMPLES</a>
|
|
<a href="#AUTHOR">AUTHOR</a>
|
|
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
|
|
<a href="#SEE-ALSO">SEE ALSO</a>
|
|
</div>
|
|
|
|
<ol class='man-decor man-head man head'>
|
|
<li class='tl'>git-ignore(1)</li>
|
|
<li class='tc'>Git Extras</li>
|
|
<li class='tr'>git-ignore(1)</li>
|
|
</ol>
|
|
|
|
|
|
|
|
<h2 id="NAME">NAME</h2>
|
|
<p class="man-name">
|
|
<code>git-ignore</code> - <span class="man-whatis">Modify or display .gitignore files</span>
|
|
</p>
|
|
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
|
|
|
<p><code>git-ignore</code> [<context>] [<action>] [--] [<pattern> [<pattern>]...]</p>
|
|
|
|
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
|
|
<p>Modifies or shows .gitignore of selected <em>context</em>.</p>
|
|
|
|
<p>Possible actions are: addition of new <em>pattern</em>s, removal of existing <em>pattern</em>s from gitignore files, opening these files in text editor or simply displaying their contents in current terminal (for details see flags/usage).</p>
|
|
|
|
<p>Contexts are global (e.g. $HOME/.gitignore or $HOME/.local/.git/.gitignore), private (e.g. .../project/.git/info/exclude) and local (e.g. .../project/.gitignore)</p>
|
|
|
|
<p>Adding only happens for <em>pattern</em>s that don't already exist in the file; removing <em>pattern</em>s that are not present does not do anything; editing fails if the file is not yet present.</p>
|
|
|
|
<p>At most 1 <em>context</em> and 1 <em>action</em> matter for the program, the ones selected are the latest encountered in the flag list.</p>
|
|
|
|
<p>Default behavior:</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<p>If no flags or arguments are passed, prints gitignores of all 3 <em>context</em>s.</p>
|
|
</li>
|
|
<li>
|
|
<p>Passing arguments with no <em>action</em> implies addition of <em>pattern</em>s to gitignore.</p>
|
|
</li>
|
|
<li>
|
|
<p>If an <em>action</em> is chosen, but not <em>context</em>, <em>action</em> is performed on local gitignore.</p>
|
|
</li>
|
|
<li>
|
|
<p>If <em>context</em> is chosen but not action (not even implied), gitignore of chosen <em>context</em> is printed.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<h2 id="OPTIONS">OPTIONS</h2>
|
|
|
|
<p><context></p>
|
|
|
|
<p>-l, --local</p>
|
|
|
|
<p>Sets the context to the .gitignore file in the current working directory. (default)</p>
|
|
|
|
<p>-g, --global</p>
|
|
|
|
<p>Sets the context to the global gitignore file for the current user.</p>
|
|
|
|
<p>-p, --private</p>
|
|
|
|
<p>Sets the context to the private exclude file for the repository (<code>.git/info/exclude</code>).</p>
|
|
|
|
<p><action></p>
|
|
|
|
<p>-e, --edit</p>
|
|
|
|
<p>Sets action to edit. This will open gitignore in a text editor (editor selection is the same as for git commit). If no <em>context</em> is provided local is assumed. Any <em>pattern</em>; provided in additional arguments is silently omitted.</p>
|
|
|
|
<p>-r, --remove</p>
|
|
|
|
<p>Sets action to remove. This will look for <em>pattern</em>s in gitignore of selected <em>context</em> and remove if finds them. If no <em>pattern</em> is provided does nothing. All characters in <em>pattern</em> are treated literally, no interpretation of metacharacters is performed as would be, for example, for a regex pattern.</p>
|
|
|
|
<p><pattern></p>
|
|
|
|
<p>A space delimited list of patterns to append to the file in context.</p>
|
|
|
|
<p>--</p>
|
|
|
|
<p>End of options delimeter. Everything to the right of it is treated as positional arguments or more precisely a <em>pattern</em>.</p>
|
|
|
|
<p>-h, --help</p>
|
|
|
|
<p>Print a brief usage summary.</p>
|
|
|
|
<h3 id="PATTERN-FORMAT">PATTERN FORMAT</h3>
|
|
|
|
<p>Pattern format as described in the git manual</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<p>A blank line matches no files, so it can serve as a separator for readability. To append a blank line use empty quotes "".</p>
|
|
</li>
|
|
<li>
|
|
<p>A line starting with # serves as a comment. For example, "# This is a comment"</p>
|
|
</li>
|
|
<li>
|
|
<p>An optional prefix ! which negates the pattern; any matching file excluded by a previous pattern will become included again. If a negated pattern matches, this will override lower precedence patterns sources. To use an exclamation ! as command line argument it is best placed between single quotes ''. For example, '!src'</p>
|
|
</li>
|
|
<li>
|
|
<p>If the pattern ends with a slash, it is removed for the purpose of the following description, but it would only find a match with a directory. In other words, foo/ will match a directory foo and paths underneath it, but will not match a regular file or a symbolic link foo (this is consistent with the way how pathspec works in general in git).</p>
|
|
</li>
|
|
<li>
|
|
<p>If the pattern does not contain a slash /, git treats it as a shell glob pattern and checks for a match against the pathname relative to the location of the .gitignore file (relative to the top level of the work tree if not from a .gitignore file).</p>
|
|
</li>
|
|
<li>
|
|
<p>Otherwise, git treats the pattern as a shell glob suitable for consumption by <span class="man-ref">fnmatch<span class="s">(3)</span></span> with the FNM_PATHNAME flag: wildcards in the pattern will not match a / in the pathname. For example, "Documentation/*.html" matches "Documentation/git.html" but not "Documentation/ppc/ppc.html" or "tools/perf/Documentation/perf.html".</p>
|
|
</li>
|
|
<li>
|
|
<p>A leading slash matches the beginning of the pathname. For example, "/*.c" matches "cat-file.c" but not "mozilla-sha1/sha1.c".</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
|
|
<p>All arguments are optional so calling git-ignore alone will display global, local and private gitignore files in order:</p>
|
|
|
|
<pre><code>$ git ignore
|
|
Global gitignore: /home/alice/.gitignore
|
|
# Numerous always-ignore extensions
|
|
*.diff
|
|
*.err
|
|
*.orig
|
|
*.rej
|
|
*.swo
|
|
*.swp
|
|
*.vi
|
|
*~
|
|
*.sass-cache
|
|
|
|
# OS or Editor folders
|
|
.DS_Store
|
|
.Trashes
|
|
._*
|
|
Thumbs.db
|
|
---------------------------------
|
|
Local gitignore: .gitignore
|
|
.cache
|
|
.project
|
|
.settings
|
|
.tmproj
|
|
nbproject
|
|
---------------------------------
|
|
Private gitignore: .git/info/exclude
|
|
notes.txt
|
|
test.sh
|
|
.env.local
|
|
config.json
|
|
</code></pre>
|
|
|
|
<p>If you only want to see the global context use the --global argument (for local use --local, for private use --private):</p>
|
|
|
|
<pre><code>$ git ignore
|
|
Global gitignore: /home/alice/.gitignore
|
|
.DS_Store
|
|
.Trashes
|
|
._*
|
|
Thumbs.db
|
|
</code></pre>
|
|
|
|
<p>To quickly append a new pattern to the default/local context simply:</p>
|
|
|
|
<pre><code>$ git ignore *.log
|
|
Adding pattern(s) to: .gitignore
|
|
... adding '*.log'
|
|
</code></pre>
|
|
|
|
<p>You can now configure any patterns without ever using an editor (or use a shortcut to open file in editor when needed), with a context and pattern arguments:
|
|
The resulting configuration is also returned for your convenience.</p>
|
|
|
|
<pre><code>$ git ignore --local "" "# Temporary files" *.tmp "*.log" tmp/* "" "# Files I'd like to keep" '!work' ""
|
|
Adding pattern(s) to: .gitignore
|
|
... adding ''
|
|
... adding '# Temporary files'
|
|
... adding '*.tmp'
|
|
... adding '*.log'
|
|
... adding 'tmp/*'
|
|
... adding ''
|
|
... adding '# Files I'd like to keep'
|
|
... adding '!work'
|
|
... adding ''
|
|
|
|
Local gitignore: .gitignore
|
|
|
|
# Temporary files
|
|
*.tmp
|
|
*.log
|
|
tmp/*
|
|
|
|
# Files I'd like to keep
|
|
!work
|
|
</code></pre>
|
|
|
|
<p>Removing patterns works in a similar way. Select context and pass patterns to be removed from the gitignore file.</p>
|
|
|
|
<pre><code>$ git ignore -l -r "*.log"
|
|
Removing patterns from local gitignore: .gitignore
|
|
... removing '*.log'
|
|
|
|
Local gitignore: .gitignore
|
|
|
|
# Temporary files
|
|
*.tmp
|
|
tmp/*
|
|
|
|
# Files I'd like to keep
|
|
!work
|
|
</code></pre>
|
|
|
|
<p>If you want to open gitignore in an editor and do changes manually pass -e flag:</p>
|
|
|
|
<pre><code>$ git ignore -p -e
|
|
</code></pre>
|
|
|
|
<h2 id="AUTHOR">AUTHOR</h2>
|
|
|
|
<p>Written by Tj Holowaychuk <<a href="mailto:tj@vision-media.ca" data-bare-link="true">tj@vision-media.ca</a>> and Tema Bolshakov <<a href="mailto:tweekane@gmail.com" data-bare-link="true">tweekane@gmail.com</a>>
|
|
and Nick Lombard <<a href="mailto:github@jigsoft.co.za" data-bare-link="true">github@jigsoft.co.za</a>&gt and Kirill Dergachev <<a href="mailto:kdergachev1062@gmail.com" data-bare-link="true">kdergachev1062@gmail.com</a>></p>
|
|
|
|
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
|
|
|
|
<p><<a href="https://github.com/tj/git-extras/issues" data-bare-link="true">https://github.com/tj/git-extras/issues</a>></p>
|
|
|
|
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
|
|
|
<p><<a href="https://github.com/tj/git-extras" data-bare-link="true">https://github.com/tj/git-extras</a>></p>
|
|
|
|
<ol class='man-decor man-foot man foot'>
|
|
<li class='tl'></li>
|
|
<li class='tc'>June 2026</li>
|
|
<li class='tr'>git-ignore(1)</li>
|
|
</ol>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|