summaryrefslogtreecommitdiff
path: root/cachedir.1.in
blob: bb80a8ef946dca4bbc3e30d6b0136e57c327790b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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/