0store.1

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