Allow * wildcard for os or machine in arch attributes.
[zeroinstall.git] / 0launch.1
blob7e06743c5929c034aa8e931cde684053a9ffb56e
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 0launch runs a program, identified by an `INTERFACE' URL. If the program is not
19 already on your computer, it downloads information about which versions are
20 available, and lets you choose one to download. It will also (automatically)
21 do the same for libraries the program needs.
23 .PP
24 0launch will also check for updates if it has been a long time since the last
25 check (configurable).
26 0launch therefore allows users to download and upgrade software without
27 needing root access.
29 .SH EXAMPLES
31 .PP
32 When a program is available using 0launch, it will have an associated URL. To
33 run the program, simply invoke 0launch with this as an argument:
35 .B 0launch http://rox.sourceforge.net/2005/interfaces/Edit
37 .PP
38 The first time you do this, details about the program are downloaded and
39 cached, and you will be prompted to confirm the versions to use. In future,
40 the program will run directly from the cache without confirmation.
42 .PP
43 To check for new versions:
45 .B 0launch --refresh http://rox.sourceforge.net/2005/interfaces/Edit
47 .PP
48 To search the list of cached URLs:
50 .B 0launch --list Edit
52 .PP
53 To avoid having to keep typing the full URI, use the 0alias(1) command
54 to create shortcuts to run your programs.
56 .SH COMMAND-LINE OPTIONS
58 .TP
59 \fB-a\fP, \fB--feed\fP
60 Register (or unregister) an additional source of implementations. When you get
61 a CVS version of a project, it may contain an interface XML file. To add this
62 version to the list of available versions, use --feed on this XML file. The
63 file is not copied, so you don't need to re-add the file each time it is
64 updated.
66 Note that if you just want to run the program, you can invoke 0launch on the
67 interface file directly (without using --feed). This will force the injector to
68 use that version, but won't affect what happens when you run it using the URI
69 as normal. Use --feed when you want to use the CVS version even when using the
70 URI, or if the program is a library (and thus referenced by URI by other
71 programs).
73 Note also that the stability of CVS versions may be set to 'developer', in
74 which case you must set this as the preferred stability for the interface
75 (using the GUI).
77 .TP
78 \fB-c\fP, \fB--console\fP
79 Never use the GUI. Normally, 0launch switches to graphical mode if it needs to
80 download anything from the network (unless DISPLAY is not set).
82 .TP
83 \fB-d\fP, \fB--download-only\fP
84 Download any needed files, but stop before actually running the program.
86 .TP
87 \fB-D\fP, \fB--dry-run\fP
88 Just print what actions would be taken.
90 .TP
91 \fB-g\fP, \fB--gui\fP
92 Show the graphical policy editor. This allows you to select which version of
93 a program or library to use.
95 .TP
96 \fB-h\fP, \fB--help\fP
97 Show the built-in help text.
99 .TP
100 \fB-i\fP, \fB--import\fP
101 Import from files, not from the network. This is useful when testing an
102 interface file, to avoid uploading it to a remote server in order to download
103 it again. It might also be useful when installing from a CD or similar.
104 The file must have a trusted GPG digital signature, as when fetching from
105 the network. For unsigned interfaces, see --feed.
108 \fB-l\fP, \fB--list\fP
109 List all known interface (program) URIs. If a search term is given, only
110 URIs containing that string are shown (case insensitive).
113 \fB-m\fP, \fB--main=MAIN\fP
114 Run the specified executable instead of the default. If MAIN starts with '/'
115 then the path is relative to the implementation's top-level directory,
116 whereas otherwise it is relative to the directory containing the default
117 MAIN program. For example, if the default MAIN is \fBbin/svn\fP then
118 using \fB--main=svnadmin\fP will run \fB.../bin/svnadmin\fP instead.
121 \fB-r\fP, \fB--refresh\fP
122 Fetch a fresh copy of all used interfaces. This will normally switch to GUI
123 mode, unless --console is also given. Note that using --refresh and --gui
124 together will check for updates to the GUI itself.
127 \fB-v\fP, \fB--verbose\fP
128 More verbose output. Use twice for even more verbose output.
131 \fB-V\fP, \fB--version\fP
132 Display version information.
134 .SH FILES
136 Configuration files (see freedesktop.org basedir spec):
138 .IP "~/.config/0install.net/injector/global"
139 Global configuration settings.
141 .IP "~/.config/0install.net/injector/trust"
142 List of trusted keys.
144 .IP "~/.config/0install.net/injector/user_overrides"
145 Per-interface settings, and extra feeds.
148 Cached data (can be re-downloaded if lost):
150 .IP "~/.cache/0install.net/interfaces"
151 Downloaded cached interface files.
153 .IP "~/.cache/0install.net/implementations"
154 Downloaded cached implementations, indexed by manifest digest.
156 .SH LICENSE
158 Copyright (C) 2005 Thomas Leonard.
161 You may redistribute copies of this program under the terms of the GNU General Public License.
162 .SH BUGS
164 Please report bugs to the developer mailing list:
166 http://0install.net/support.html
168 .SH AUTHOR
170 The Zero Install Injector was created by Thomas Leonard.
172 .SH SEE ALSO
173 0alias(1), 0store(1)
175 The Zero Install web-site:
177 .B http://0install.net