Added test interface.
[zeroinstall.git] / 0store.1
blobb92cfe3f359879321b429ff6049a94d7e373e393
1 .TH 0STORE 1 "2005" "Thomas Leonard" ""
2 .SH NAME
3 0store \- manage the implementation cache
5 .SH SYNOPSIS
7 .B 0store clean
8 \fBINTERFACE\fP
10 .B 0store manifest
11 \fBDIRECTORY\fP
13 .B 0store delete
14 (\fBDIGEST\fP | \fBDIRECTORY\fP)
16 .B 0store store
17 \fBDIGEST\fP \fBDIRECTORY\fP
19 .B 0store verify
20 (\fBDIGEST\fP | \fBDIRECTORY\fP)
22 .SH DESCRIPTION
23 .PP
24 0store provides access to the low-level implementation cache. Normally, the
25 cache is updated automatically using 0launch(1).
27 .SH LIST
29 .PP
30 See the list of implementation caches currently configured:
32 .B 0store list
34 To add directories to this list, add them to your 'implementation-dirs'
35 configuration file.
37 .SH MANIFEST
38 .PP
39 To generate the manifest for a directory structure:
41 .B 0store manifest DIRECTORY
43 .PP
44 The manifest lists every file and directory in the tree, along with the SHA1
45 digest of each file, thus uniquely identifying that particular set of files.
46 After the manifest, the last line gives the SHA1 digest of the manifest itself.
47 This value is needed when creating interface files. See the packager's guide on
48 the Zero Install web site for details.
50 .SH FIND
51 .PP
52 To find the path of a stored item:
54 .B 0store find sha1=XXX
56 .SH STORE
57 .PP
58 To add a directory to the store (makes a copy):
60 .B 0store add sha1=XXX directory
62 .PP
63 To add an archive to the store:
65 .B 0store add sha1=XXX archive.tgz
67 .PP
68 To add a subdirectory of an archive to the store:
70 .B 0store add sha1=XXX archive.tgz subdir
72 .PP
73 The actual digest is calculated and compared to the given one. If they don't
74 match, the operation is rejected.
76 .SH VERIFY
77 .PP
78 To check that an item is stored correctly:
80 .B 0store verify /path/to/sha1=XXX
82 This calculates the manifest of the directory and checks that its digest matches
83 the directory's name. It also checks that it matches the digest of the .manifest
84 file inside the directory. If the .manifest doesn't correspond to the current
85 tree, it displays a list of the differences (in unified diff format).
87 .SH COMMAND-LINE OPTIONS
89 .TP
90 \fB-h\fP, \fB--help\fP
91 Show the built-in help text.
93 .TP
94 \fB-v\fP, \fB--verbose\fP
95 More verbose output. Use twice for even more verbose output.
97 .TP
98 \fB-V\fP, \fB--version\fP
99 Display version information.
101 .SH FILES
103 .IP "~/.cache/0install.net/implementations"
104 Cached implementations, indexed by manifest digest.
106 .IP "~/.config/0install.net/injector/implementation-dirs"
107 List of system cache directories, one per line.
109 .SH LICENSE
111 Copyright (C) 2005 Thomas Leonard.
114 You may redistribute copies of this program under the terms of the GNU General Public License.
116 .SH BUGS
118 Please report bugs to the developer mailing list:
120 http://0install.net/support.html
122 .SH AUTHOR
124 The Zero Install Injector was created by Thomas Leonard.
126 .SH SEE ALSO
127 0alias(1), 0launch(1)
129 The Zero Install web-site:
131 .B http://0install.net