summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2013-03-17 12:25:12 +0000
committerLars Wirzenius <liw@liw.fi>2013-03-17 12:25:12 +0000
commit92e01b3584c6783af7d4cbdfb6f37854ff13b372 (patch)
tree8a745a889cbc4dd498d5bc3d2958046a5d688dcf
parent4804fe76e86becdc9afb2dda348133efdc0335d9 (diff)
downloadcachedir-92e01b3584c6783af7d4cbdfb6f37854ff13b372.tar.gz
Add manpage template
-rw-r--r--cachedir.1.in55
1 files changed, 55 insertions, 0 deletions
diff --git a/cachedir.1.in b/cachedir.1.in
new file mode 100644
index 0000000..bb80a8e
--- /dev/null
+++ b/cachedir.1.in
@@ -0,0 +1,55 @@
+.\" Copyright 2013 Lars Wirzenius <liw@liw.fi>
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
+.\"
+.TH CACHEDIR 1
+.SH NAME
+cachedir \- tag/untag/find cache directories
+.SH SYNOPSIS
+.SH DESCRIPTION
+.B cachedir
+tags directories as cache directories,
+or remotes such tags,
+or finds tagged directories.
+A cache directory tag is a file called
+.B CACHEDIR.TAG
+with a specific content.
+See the specification referenced from the "SEE ALSO" section for details.
+.SH OPTIONS
+.SH EXAMPLE
+To tag a directory as a cache directory:
+.PP
+.nf
+.RS
+cachedir tag $HOME/.cache
+.RE
+.fi
+.PP
+To remove a cache directory tag:
+.PP
+.nf
+.RS
+cachedir untag $HOME/.cache
+.RE
+.fi
+.PP
+To find all cache directories below your home directory:
+.PP
+.nf
+.RS
+cachedir find $HOME
+.RE
+.fi
+.SH "SEE ALSO"
+.B http://www.bford.info/cachedir/