Annotation of src/usr.bin/cvs/cvsignore.5, Revision 1.1
1.1 ! xsa 1: .\" $OpenBSD$
! 2: .\"
! 3: .\" Copyright (c) 2005 Xavier Santolaria <xsa@openbsd.org>
! 4: .\" All rights reserved.
! 5: .\"
! 6: .\" Permission to use, copy, modify, and distribute this software for any
! 7: .\" purpose with or without fee is hereby granted, provided that the above
! 8: .\" copyright notice and this permission notice appear in all copies.
! 9: .\"
! 10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
! 11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
! 12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
! 13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
! 14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
! 15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
! 16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
! 17: .Dd August 01, 2005
! 18: .Dt CVSIGNORE 5
! 19: .Os
! 20: .Sh NAME
! 21: .Nm cvsignore
! 22: .Nd list of files and patterns ignored by CVS
! 23: .Sh DESCRIPTION
! 24: The
! 25: .Nm
! 26: file provides a list of files (or
! 27: .Xr sh 1
! 28: file name patterns) that should be ignored by
! 29: .Xr cvs 1
! 30: during the
! 31: .Ic import ,
! 32: .Ic release ,
! 33: and
! 34: .Ic update
! 35: commands.
! 36: .Pp
! 37: The syntax of the
! 38: .Nm
! 39: file consists of a series of lines, each of which contains a
! 40: space-separated list of filenames.
! 41: There is currently no way of using comments in this file.
! 42: .Pp
! 43: Default patterns that are ignored by
! 44: .Xr cvs 1
! 45: are as follows:
! 46: .Bd -filled
! 47: CVS,
! 48: RCS,
! 49: RCSLOG,
! 50: SCCS,
! 51: TAGS,
! 52: tags,
! 53: core,
! 54: cvslog*,
! 55: *.o,
! 56: *.so,
! 57: *.a,
! 58: *.bak,
! 59: *.orig,
! 60: *.rej,
! 61: *.old,
! 62: *.exe,
! 63: *.depend,
! 64: *.obj,
! 65: *.elc,
! 66: *.ln,
! 67: *.olb,
! 68: *.core,
! 69: .#*,
! 70: *~,
! 71: _$*,
! 72: *$,
! 73: #*,
! 74: ,*.
! 75: .Ed
! 76: .Pp
! 77: The list can be modified using the methods described below:
! 78: .Pp
! 79: .Bl -enum -compact
! 80: .It
! 81: The
! 82: .Pa $CVSROOT/CVSROOT/cvsignore
! 83: file appends patterns to ignore for the whole repository.
! 84: .It
! 85: The
! 86: .Pa $HOME/.cvsignore
! 87: file appends patterns to ignore for user only.
! 88: .It
! 89: The content of the
! 90: .Ev CVSIGNORE
! 91: variable is appended to the list.
! 92: .It
! 93: Options to the command line
! 94: .Fl I
! 95: flag, available for the
! 96: .Ic import
! 97: and
! 98: .Ic update
! 99: commands, appends patterns for the current command line action only.
! 100: .It
! 101: .Pa .cvsignore
! 102: files placed in the repository directories allow to add patterns to
! 103: ignore locally.
! 104: They do not take effect on sub-directories.
! 105: .El
! 106: .Pp
! 107: The
! 108: .Sq !\&
! 109: character can be used to reset the list of patterns using any of these
! 110: five methods.
! 111: .Pp
! 112: For the
! 113: .Ic update
! 114: command,
! 115: .Xr cvs 1
! 116: handles files that are already present in the repository even if they
! 117: are in the list to ignore.
! 118: Files that are in the list to ignore but not in the repository will not
! 119: be listed.
! 120: This way, files preceeded by the
! 121: .Sq ?\&
! 122: character will not appear even if they should.
! 123: .Sh SEE ALSO
! 124: .Xr cvs 1 ,
! 125: .Xr cvsintro 7