Updated Debian changelog.
[zeroinstall.git] / 0launch.1
blob0b2f4c55e83e761bb18acc60e8a9926e8f3bccb6
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-a\fP, \fB--add-feed\fP
58 Register an additional source of implementations. When you get a CVS
59 version of a project, it may contain an interface XML file. To add this version
60 to the list of available versions, use --add-feed on this file. The file is
61 not copied, so you don't need to re-add the file each time it is updated.
63 Note that if you just want to run the program, you can invoke 0launch on the
64 interface file directly (without using --add-feed). This will force the
65 injector to use that version, but won't affect what happens when you run it
66 using the URI as normal. Use --add-feed when you want to use the CVS version
67 even when using the URI, or if the program is a library (and thus referenced
68 by URI by other programs).
70 Note also that the stability of CVS versions will probably be set
71 to 'developer', so be sure to set this as the preferred stability for the
72 interface (using the GUI).
74 .TP
75 \fB-c\fP, \fB--console\fP
76 Never use the GUI. Normally, 0launch switches to graphical mode if it needs to
77 download anything from the network (unless DISPLAY is not set).
79 .TP
80 \fB-d\fP, \fB--download-only\fP
81 Download any needed files, but stop before actually running the program.
83 .TP
84 \fB-D\fP, \fB--dry-run\fP
85 Just print what actions would be taken.
87 .TP
88 \fB-g\fP, \fB--gui\fP
89 Show the graphical policy editor. This allows you to select which version of
90 a program or library to use.
92 .TP
93 \fB-h\fP, \fB--help\fP
94 Show the built-in help text.
96 .TP
97 \fB-i\fP, \fB--import\fP
98 Import from files, not from the network. This is useful when testing an
99 interface file, to avoid uploading it to a remote server in order to download
100 it again. It might also be useful when installing from a CD or similar.
103 \fB-l\fP, \fB--list\fP
104 List all known interface (program) URIs. If a search term is given, only
105 URIs containing that string are shown (case insensitive).
108 \fB-r\fP, \fB--refresh\fP
109 Fetch a fresh copy of all used interfaces. This will normally switch to GUI
110 mode, unless --console is also given.
113 \fB-v\fP, \fB--verbose\fP
114 More verbose output. Use twice for even more verbose output.
117 \fB-V\fP, \fB--version\fP
118 Display version information.
120 .SH FILES
122 Configuration files (see freedesktop.org basedir spec):
124 .IP "~/.config/0install.net/injector/global"
125 Global configuration settings.
127 .IP "~/.config/0install.net/injector/trust"
128 List of trusted keys.
130 .IP "~/.config/0install.net/injector/user_overrides"
131 Per-interface settings.
133 .IP "~/.config/0install.net/injector/local_interfaces"
134 Extra implementations to add to the upstream list.
137 Cached data (can be re-downloaded if lost):
139 .IP "~/.cache/0install.net/interfaces"
140 Downloaded cached interface files.
142 .IP "~/.cache/0install.net/implementations"
143 Downloaded cached implementations, indexed by manifest digest.
145 .SH LICENSE
147 Copyright (C) 2005 Thomas Leonard.
150 You may redistribute copies of this program under the terms of the GNU General Public License.
151 .SH BUGS
153 Please report bugs to the developer mailing list:
155 http://0install.net/support.html
157 .SH AUTHOR
159 The Zero Install Injector was created by Thomas Leonard.
161 .SH SEE ALSO
162 0alias(1), 0store(1)
164 The Zero Install web-site:
166 .B http://0install.net