.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SVN-CLEAN 1"
.TH SVN-CLEAN 1 2024-04-07 "" "User Commands"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
svn\-clean \- Wipes out unversioned files from Subversion working copy
.SH SYNOPSIS
.IX Header "SYNOPSIS"
svn-clean [options] [directory or file ...]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBsvn-clean\fR will scan the given files and directories recursively and find
unversioned files and directories (files and directories that are not present in
the Subversion repository). After the scan is done, these files and directories
will be deleted.
.PP
If no file or directory is given, \fBsvn-clean\fR defaults to the current directory
(".").
.PP
\&\fBsvn-clean\fR uses the SVN Perl modules if they are available. This is much
faster than parsing the output of the \fBsvn\fR command-line client.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-e\fR, \fB\-\-exclude\fR" 8
.IX Item "-e, --exclude"
A regular expression for filenames to be exluded. For example, the following
command will skip files ending in ".zip":
.RS 8
.Sp
.RS 8
svn-clean \-\-exclude '\e.zip$'
.RE
.RE
.RS 8
.Sp
Multiple exclude patterns can be specified. If at least one matches, then the
file is skipped. For example, the following command will skip files ending in
".jpg" or ".png":
.Sp
.RS 8
svn-clean \-\-exclude '\e.jpg$' \-\-exclude '\e.png$'
.RE
.RE
.RS 8
.Sp
The following command will skip the entire "build" subdirectory:
.Sp
.RS 8
svn-clean \-\-exclude '^build(/|$)'
.RE
.RE
.RS 8
.RE
.IP "\fB\-f\fR, \fB\-\-force\fR" 8
.IX Item "-f, --force"
Files to which you do not have delete access (if running under VMS) or write
access (if running under another OS) will not be deleted unless you use this
option.
.IP "\fB\-N\fR, \fB\-\-non\-recursive\fR" 8
.IX Item "-N, --non-recursive"
Do not search recursively for unversioned files and directories. Unversioned
directories will still be deleted along with all their contents.
.IP "\fB\-q\fR, \fB\-\-quiet\fR" 8
.IX Item "-q, --quiet"
Do not print progress info. In particular, do not print a message each time a
file is examined, giving the name of the file, and indicating whether "rmdir" or
"unlink" is used to remove it, or that it's skipped.
.IP "\fB\-p\fR, \fB\-\-print\fR" 8
.IX Item "-p, --print"
Do not delete anything. Instead, print the name of every file and directory that
would have been deleted.
.IP "\fB\-?\fR, \fB\-h\fR, \fB\-\-help\fR" 8
.IX Item "-?, -h, --help"
Prints a brief help message and exits.
.IP \fB\-\-man\fR 8
.IX Item "--man"
Prints the manual page and exits.
.SH AUTHOR
.IX Header "AUTHOR"
Simon Perreault <nomis80@nomis80.org>