0store.1

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