Return to cvswrappers.5 CVS log

Up to [local] / src / usr.bin / cvs

Annotation of src/usr.bin/cvs/cvswrappers.5, Revision 1.2

1.2     ! jmc         1: .\"    $OpenBSD: cvswrappers.5,v 1.1 2005/08/08 14:59:41 xsa Exp $
1.1       xsa         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 CVSWRAPPERS 5
                     19: .Os
                     20: .Sh NAME
                     21: .Nm cvswrappers
                     22: .Nd CVS filters
                     23: .Sh DESCRIPTION
                     24: The
                     25: .Nm
                     26: file, located in
                     27: .Pa $CVSROOT/CVSROOT
                     28: and/or
                     29: .Pa $HOME/.cvswrappers ,
                     30: provides a way to configure filters for
                     31: .Xr cvs 1
                     32: based on file type (name).
                     33: This works by specifying a pattern to match for varying file types.
                     34: .Pp
                     35: The format of each line is as follows:
                     36: .Pp
                     37: .Dl pattern [option 'value'] [option 'value'] ...
                     38: .Pp
                     39: The following options are supported:
                     40: .Bl -tag -width Ds
                     41: .It Fl f Ar filter
                     42: Execute
                     43: .Ar filter
                     44: when the file is extracted from the repository (for the
                     45: .Ic checkout ,
                     46: .Ic export ,
                     47: and
                     48: .Ic update
                     49: commands).
                     50: .It Fl k Ar mode
                     51: Specify the keyword substitution mode.
                     52: See the
                     53: .Sx KEYWORD SUBSTITUTION
                     54: section of
1.2     ! jmc        55: .Xr rcs 1
1.1       xsa        56: for more information.
                     57: .It Fl m Ar method
                     58: Specify the merge methodology to be used when a file is updated.
                     59: .Pp
                     60: The methods are as follows:
                     61: .Bl -tag -width Ds
                     62: .It COPY
                     63: When the
                     64: .Ic update
                     65: command is used,
                     66: .Xr cvs 1
                     67: will merely copy one version over another and let the user do the merge
                     68: by himself.
                     69: This method is used by default on binary files (see the
                     70: .Fl k Ar b
                     71: option).
                     72: .It MERGE
                     73: Try to merge the files.
                     74: This method is the default.
                     75: .El
                     76: .It Fl t Ar filter
                     77: Execute
                     78: .Ar filter
                     79: before the file is archived in the repository (for the
                     80: .Ic commit ,
                     81: and
                     82: .Ic import
                     83: commands).
                     84: .El
                     85: .Sh EXAMPLES
                     86: Handle jpeg files as binaries:
                     87: .Bd -literal -offset indent
                     88: *.jpg -k 'b'
                     89: .Ed
                     90: .Pp
                     91: Indent C files before archiving them:
                     92: .Bd -literal -offset indent
                     93: *.[ch] -t 'indent %s'
                     94: .Ed
                     95: .Sh SEE ALSO
                     96: .Xr cvs 1 ,
                     97: .Xr cvsintro 7