Allow importing directories.
[zeroinstall.git] / 0launch.1
blob210a74f3d54531ee97887462ef9113090f88f35b
1 .TH 0LAUNCH 1 "2005" "Thomas Leonard" ""
2 .SH NAME
3 0launch \- download and run programs by URL
5 .SH SYNOPSIS
7 .B 0launch
8 [\fBOPTION\fP]... \fBINTERFACE\fP [\fBARG\fP]...
10 .B 0launch
11 --list [\fBSEARCH-TERM\fP]
13 .B 0launch
14 --import [\fBINTERFACE-FILES\fP]
16 .SH DESCRIPTION
17 .PP
18 A program is made up of many different components, typically written by
19 different groups of people. Each component is available in multiple versions.
20 The injector is used when starting a program. Its job is to decide which
21 implementation of each required component to use.
23 .PP
24 An interface describes what a component does. The injector starts with the
25 interface for the program you want to run (like 'The Gimp') and chooses an
26 implementation (like 'The Gimp 2.2.0'). However, this implementation will in
27 turn depend on other interfaces, such as 'GTK' (which draws the menus and
28 buttons). Thus, the injector must choose implementations of each dependancy
29 (each of which may require further interfaces, and so on).
31 .SH EXAMPLES
33 .PP
34 When a program is available using 0launch, it will have an associated URL. To
35 run the program, simply invoke 0launch with this as an argument:
37 .B 0launch http://rox.sourceforge.net/2005/interfaces/Edit
39 .PP
40 The first time you do this, details about the program are downloaded and
41 cached, and you will be prompted to confirm the versions to use. In future,
42 the program will run directly from the cache without confirmation.
44 .PP
45 To check for new versions:
47 .B 0launch --refresh http://rox.sourceforge.net/2005/interfaces/Edit
49 .PP
50 To search the list of cached URLs:
52 .B 0launch --list Edit
54 .SH COMMAND-LINE OPTIONS
56 .TP
57 \fB-c\fP, \fB--console\fP
58 Never use the GUI. Normally, 0launch switches to graphical mode if it needs to
59 download anything from the network (unless DISPLAY is not set).
61 .TP
62 \fB-d\fP, \fB--download-only\fP
63 Download any needed files, but stop before actually running the program.
65 .TP
66 \fB-D\fP, \fB--dry-run\fP
67 Just print what actions would be taken.
69 .TP
70 \fB-g\fP, \fB--gui\fP
71 Show the graphical policy editor. This allows you to select which version of
72 a program or library to use.
74 .TP
75 \fB-h\fP, \fB--help\fP
76 Show the built-in help text.
78 .TP
79 \fB-i\fP, \fB--import\fP
80 Import from files, not from the network. This is useful when testing an
81 interface file, to avoid uploading it to a remote server in order to download
82 it again. It might also be useful when installing from a CD or similar.
84 .TP
85 \fB-l\fP, \fB--list\fP
86 List all known interface (program) URIs. If a search term is given, only
87 URIs containing that string are shown (case insensitive).
89 .TP
90 \fB-m\fP, \fB--manifest\fP
91 Generate the manifest for a directory structure. The manifest lists every file
92 and directory in the tree, along with the SHA1 digest of each file, thus
93 uniquely identifying that particular set of files. After the manifest,
94 the last line gives the SHA1 digest of the manifest itself. This value is
95 needed when creating interface files. See the packager's guide on the
96 web site for details.
98 .TP
99 \fB-r\fP, \fB--refresh\fP
100 Fetch a fresh copy of all used interfaces. This will normally switch to GUI
101 mode, unless --console is also given.
104 \fB-v\fP, \fB--verbose\fP
105 More verbose output. Use twice for even more verbose output.
108 \fB-V\fP, \fB--version\fP
109 Display version information.
111 .SH FILES
113 Configuration files (see freedesktop.org basedir spec):
115 .IP "~/.config/0install.net/injector/global"
116 Global configuration settings.
118 .IP "~/.config/0install.net/injector/trust"
119 List of trusted keys.
121 .IP "~/.config/0install.net/injector/user_overrides"
122 Per-interface settings.
124 .IP "~/.config/0install.net/injector/local_interfaces"
125 Extra implementations to add to the upstream list.
128 Cached data (can be re-downloaded if lost):
130 .IP "~/.cache/0install.net/interfaces"
131 Downloaded cached interface files.
133 .IP "~/.cache/0install.net/implementations"
134 Downloaded cached implementations, indexed by manifest digest.
136 .SH LICENSE
138 Copyright (C) 2005 Thomas Leonard.
141 You may redistribute copies of this program under the terms of the GNU General Public License.
142 .SH BUGS
144 Please report bugs to the developer mailing list:
146 http://0install.net/support.html
148 .SH AUTHOR
150 The Zero Install Injector was created by Thomas Leonard.
152 .SH SEE ALSO
153 0alias(1)
155 The Zero Install web-site:
157 .B http://0install.net