0launch.1

   1 .TH 0LAUNCH 1 "2005" "Thomas Leonard" ""
   2 .SH NAME
   3 0launch \- download and run programs by URL
   4
   5 .SH SYNOPSIS
   6
   7 .B 0launch
   8 [\fBOPTION\fP]... \fBINTERFACE\fP [\fBARG\fP]...
   9
  10 .B 0launch
  11 --list [\fBSEARCH-TERM\fP]
  12
  13 .B 0launch
  14 --import [\fBINTERFACE-FILES\fP]
  15
  16 .SH DESCRIPTION
  17 .PP
  18 0launch runs a program, identified by an `INTERFACE'. 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.
  22
  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.
  28
  29 .PP
  30 An INTERFACE can be either a URL in the form `http://site/program' or
  31 a local path name like `/path/to/program.xml'. For HTTP URLs, the remote
  32 file is a GPG-signed XML document. Local interface files are not signed.
  33
  34 .SH EXAMPLES
  35
  36 .PP
  37 When a program is available using 0launch, it will have an associated URL. To
  38 run the program, simply invoke 0launch with this as an argument:
  39
  40 .B 0launch http://rox.sourceforge.net/2005/interfaces/Edit
  41
  42 .PP
  43 The first time you do this, details about the program are downloaded and
  44 cached, and you will be prompted to confirm the versions to use. In future,
  45 the program will run directly from the cache without confirmation.
  46
  47 .PP
  48 To check for new versions:
  49
  50 .B 0launch --refresh http://rox.sourceforge.net/2005/interfaces/Edit
  51
  52 .PP
  53 To search the list of cached URLs:
  54
  55 .B 0launch --list Edit
  56
  57 .PP
  58 To avoid having to keep typing the full URI, use the 0alias(1) command
  59 to create shortcuts to run your programs.
  60
  61 .SH COMMAND-LINE OPTIONS
  62
  63 .TP
  64 \fB-c\fP, \fB--console\fP
  65 Never use the GUI. Normally, 0launch switches to graphical mode if it needs to
  66 download anything from the network (unless DISPLAY is not set).
  67
  68 .TP
  69 \fB-d\fP, \fB--download-only\fP
  70 Download any needed files, but stop before actually running the program.
  71
  72 .TP
  73 \fB-D\fP, \fB--dry-run\fP
  74 Just print what actions would be taken.
  75
  76 .TP
  77 \fB-f\fP, \fB--feed\fP
  78 Register (or unregister) an additional source of implementations. When you get
  79 a CVS version of a project, it may contain an interface XML file. To add this
  80 version to the list of available versions, use --feed on this XML file. The
  81 file is not copied, so you don't need to re-add the file each time it is
  82 updated.
  83
  84 Note that if you just want to run the program, you can invoke 0launch on the
  85 interface file directly (without using --feed). This will force the injector to
  86 use that version, but won't affect what happens when you run it using the URI
  87 as normal. Use --feed when you want to use the CVS version even when using the
  88 URI, or if the program is a library (and thus referenced by URI by other
  89 programs).
  90
  91 Note also that the stability of CVS versions may be set to 'developer', in
  92 which case you must set this as the preferred stability for the interface
  93 (using the GUI).
  94
  95 .TP
  96 \fB-g\fP, \fB--gui\fP
  97 Show the graphical policy editor. This allows you to select which version of
  98 a program or library to use.
  99
 100 .TP
 101 \fB-h\fP, \fB--help\fP
 102 Show the built-in help text.
 103
 104 .TP
 105 \fB-i\fP, \fB--import\fP
 106 Import from files, not from the network. This is useful when testing an
 107 interface file, to avoid uploading it to a remote server in order to download
 108 it again. It might also be useful when installing from a CD or similar.
 109 The file must have a trusted GPG digital signature, as when fetching from
 110 the network. For unsigned interfaces, see --feed.
 111
 112 .TP
 113 \fB-l\fP, \fB--list\fP
 114 List all known interface (program) URIs. If a search term is given, only
 115 URIs containing that string are shown (case insensitive).
 116
 117 .TP
 118 \fB-m\fP, \fB--main=MAIN\fP
 119 Run the specified executable instead of the default. If MAIN starts with '/'
 120 then the path is relative to the implementation's top-level directory,
 121 whereas otherwise it is relative to the directory containing the default
 122 MAIN program. For example, if the default MAIN is \fBbin/svn\fP then
 123 using \fB--main=svnadmin\fP will run \fB.../bin/svnadmin\fP instead.
 124
 125 .TP
 126 \fB-o\fP, \fB--offline\fP
 127 Run in off-line mode, overriding the default setting. In off-line mode, no
 128 interfaces are refreshed even if they are out-of-date, and newer versions of
 129 programs won't be downloaded even if the injector already knows about them
 130 (e.g. from a previous refresh).
 131
 132 .TP
 133 \fB-r\fP, \fB--refresh\fP
 134 Fetch a fresh copy of all used interfaces. This will normally switch to GUI
 135 mode, unless --console is also given. Note that using --refresh and --gui
 136 together will check for updates to the GUI itself.
 137
 138 .TP
 139 \fB-v\fP, \fB--verbose\fP
 140 More verbose output. Use twice for even more verbose output.
 141
 142 .TP
 143 \fB-V\fP, \fB--version\fP
 144 Display version information.
 145
 146 .SH FILES
 147
 148 Configuration files (see freedesktop.org basedir spec):
 149
 150 .IP "~/.config/0install.net/injector/global"
 151 Global configuration settings.
 152
 153 .IP "~/.config/0install.net/injector/trust"
 154 List of trusted keys.
 155
 156 .IP "~/.config/0install.net/injector/user_overrides"
 157 Per-interface settings, and extra feeds.
 158
 159 .PP
 160 Cached data (can be re-downloaded if lost):
 161
 162 .IP "~/.cache/0install.net/interfaces"
 163 Downloaded cached interface files.
 164
 165 .IP "~/.cache/0install.net/implementations"
 166 Downloaded cached implementations, indexed by manifest digest.
 167
 168 .SH LICENSE
 169 .PP
 170 Copyright (C) 2005 Thomas Leonard.
 171
 172 .PP
 173 You may redistribute copies of this program under the terms of the GNU General Public License.
 174 .SH BUGS
 175 .PP
 176 Please report bugs to the developer mailing list:
 177
 178 http://0install.net/support.html
 179
 180 .SH AUTHOR
 181 .PP
 182 The Zero Install Injector was created by Thomas Leonard.
 183
 184 .SH SEE ALSO
 185 0alias(1), 0store(1)
 186 .PP
 187 The Zero Install web-site:
 188
 189 .B http://0install.net