.\" $Id: tickle.man,v 1.10 2012/02/29 00:19:11 ksb Exp $
.\" by Kevin Braunsdorf
.\" $Compile: Display%h
.\" $Display: groff -Tascii -man %f |${PAGER:-less}
.\" $Display(*): groff -T%s -man %f
.\" $Install: %b -mDeinstall %o %f && cp %f $DESTDIR/usr/local/man/man8/tickle.8
.\" $Deinstall: ${rm-rm} -f $DESTDIR/usr/local/man/[cm]a[nt]8/tickle.8*
.TH TICKLE 8L LOCAL
.SH NAME
tickle \- remind logins of stale RCS locks
.SH SYNOPSIS
.ds PN "tickle
\fI\*(PN\fP [\fB\-mt\fP] [\fB\-L\fP\~\fIdays\fP] [\fIdirs\fP]
.br
\fI\*(PN\fP \fB\-h\fP
.br
\fI\*(PN\fP \fB\-V\fP
.br

.SH DESCRIPTION
.PP
\fBTickle\fP for each RCS directory under any of \fIdirs\fP
we look for RCS cache files that are locked and have been so
for at least \fIdays\fP.  These cache files are considered to
have "stale" locks.
.PP
For each stale lock \fI\*(PN\fP emits a line including the path
to the cache file, and the number of lines added and deleted
from the checked-out version.
.PP
These lines are output on stdout by default, but can be directed to
e-mail for a simple "poke at the logins" cron job.

.SH OPTIONS
.TP
\fB\-h\fP
Print a help message.
.TP
\fB\-L\fP \fIdays\fP
Consider any RCS lock more \fIdays\fP old as stale.  The
default is 45 days, which is too long in most environments.
.TP
\fB\-m\fP
Emit an e-mail reminder to each login with the list of stale locks
in the body (and a small reminder message).
.TP
\fB\-t\fP
Include a report of any trash files in each RCS cache directory.
.TP
\fB\-V\fP
Show version information.

.SH EXAMPLES
.TP
\fI\*(PN\fP /usr/msrc/local/bin
List stale locks under the master source for local/bin.
.TP
\fI\*(PN\fP \-V /
Display the version of \fBtickle\fP installed.

.SH BUGS
.PP
The default stale time is too long.
.PP
Cache files that do not live under an "RCS" directory are
ignored (which is site policy at the local institution).  There
should be an option to include all RCS cache files in the scan.

.SH AUTHOR
Kevin S Braunsdorf
.br
NonPlayer Character Guild
.br
tickle atNoSpam ksb dot-here npcguild.org

.SH "SEE ALSO"
.hlm 0
rcs(1), rlog(1), diff(1), cron(8), msync(8l), level2s(8l)