0store.1

   1 .TH 0STORE 1 "2007" "Thomas Leonard" ""
   2 .SH NAME
   3 0store \- manage the implementation cache
   4
   5 .SH SYNOPSIS
   6
   7 .B 0store add
   8 \fBDIGEST\fP \fBDIRECTORY\fP
   9
  10 .B 0store add
  11 \fBDIGEST\fP \fBARCHIVE\fP [ \fBEXTRACT\fP ]
  12
  13 .B 0store copy
  14 \fBDIRECTORY\fP [ \fBDIRECTORY\fP ]
  15
  16 .B 0store find
  17 \fBDIGEST\fP
  18
  19 .B 0store list
  20
  21 .B 0store manifest
  22 \fBDIRECTORY\fP [ \fBALGORITHM\fP ]
  23
  24 .B 0store optimise
  25 [ \fBCACHE\fP ]
  26
  27 .B 0store verify
  28 ( \fBDIGEST\fP | \fBDIRECTORY\fP )
  29
  30 .SH DESCRIPTION
  31 .PP
  32 0store provides access to the low-level implementation cache. Normally, the
  33 cache is updated automatically using 0launch(1).
  34
  35 .SH ADD
  36 .PP
  37 To add a directory to the store (makes a copy):
  38
  39 .B 0store add sha1=XXX directory
  40
  41 .PP
  42 To add an archive to the store:
  43
  44 .B 0store add sha1=XXX archive.tgz
  45
  46 .PP
  47 To add a subdirectory of an archive to the store:
  48
  49 .B 0store add sha1=XXX archive.tgz subdir
  50
  51 .PP
  52 The actual digest is calculated and compared to the given one. If they don't
  53 match, the operation is rejected.
  54
  55 .SH COPY
  56 .PP
  57 To copy an implementation (a directory with a name in the form
  58 "algorithm=value"), use the copy function. This is similar to performing
  59 a normal recursive directory copy followed by a
  60 .B 0store verify
  61 to check that the name matches the contents. E.g.:
  62
  63 .B 0store copy ~someuser/.cache/0install.net/implementations/sha256=XXX
  64 /var/cache/0install.net/implementations/
  65
  66 .SH FIND
  67 .PP
  68 To find the path of a stored item:
  69
  70 .B 0store find sha1=XXX
  71
  72 .SH LIST
  73
  74 .PP
  75 See the list of implementation caches currently configured:
  76
  77 .B 0store list
  78
  79 To add directories to this list, add them to your 'implementation-dirs'
  80 configuration file.
  81
  82 .SH MANIFEST
  83 .PP
  84 To generate the manifest for a directory structure:
  85
  86 .B 0store manifest DIRECTORY [ALGORITHM]
  87
  88 .PP
  89 The manifest lists every file and directory in the tree, along with the
  90 digest of each file, thus uniquely identifying that particular set of files.
  91 After the manifest, the last line gives the digest of the manifest itself.
  92
  93 .PP
  94 This value is needed when creating interface files. However, the 0publish
  95 command will automatically calculate the required digest for you and add it
  96 to an interface file. See the packager's guide on the Zero Install web site for
  97 details.
  98 .PP
  99 Supported algorithms are 'sha1' (supported by all versions), 'sha1new'
 100 (requires injector 0.20 or later) and 'sha256' (requires injector 0.20 or later
 101 AND the Python hashlib module).
 102
 103 .SH OPTIMISE
 104 .PP
 105 To hard-link duplicate files together to save space:
 106
 107 .B 0store optimise [CACHE]
 108
 109 .PP
 110 This reads in all the manifest files in the cache directory (~/.cache/0install.net/implementations
 111 by default) and looks for duplicates (files with the same permissions, modification time and digest).
 112 When it finds a pair, it deletes one and replaces it (atomically) with a hard-link to the other.
 113
 114 .PP
 115 Implementations using the old 'sha1' algorithm are not optimised.
 116
 117 .SH VERIFY
 118 .PP
 119 To check that an item is stored correctly:
 120
 121 .B 0store verify /path/to/sha1=XXX
 122
 123 This calculates the manifest of the directory and checks that its digest matches
 124 the directory's name. It also checks that it matches the digest of the .manifest
 125 file inside the directory. If the .manifest doesn't correspond to the current
 126 tree, it displays a list of the differences (in unified diff format).
 127
 128 .SH COMMAND-LINE OPTIONS
 129
 130 .TP
 131 \fB-h\fP, \fB--help\fP
 132 Show the built-in help text.
 133
 134 .TP
 135 \fB-v\fP, \fB--verbose\fP
 136 More verbose output. Use twice for even more verbose output.
 137
 138 .TP
 139 \fB-V\fP, \fB--version\fP
 140 Display version information.
 141
 142 .SH FILES
 143
 144 .IP "~/.cache/0install.net/implementations"
 145 Cached implementations, indexed by manifest digest.
 146
 147 .IP "~/.config/0install.net/injector/implementation-dirs"
 148 List of system cache directories, one per line.
 149
 150 .SH LICENSE
 151 .PP
 152 Copyright (C) 2006 Thomas Leonard.
 153
 154 .PP
 155 You may redistribute copies of this program under the terms of the GNU Lesser General Public License.
 156
 157 .SH BUGS
 158 .PP
 159 Please report bugs to the developer mailing list:
 160
 161 http://0install.net/support.html
 162
 163 .SH AUTHOR
 164 .PP
 165 The Zero Install Injector was created by Thomas Leonard.
 166
 167 .SH SEE ALSO
 168 0alias(1), 0launch(1)
 169 .PP
 170 The Zero Install web-site:
 171
 172 .B http://0install.net