0store.1

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