0compile.1

   1 .TH 0COMPILE 1 "2009" "Thomas Leonard" ""
   2 .SH NAME
   3 0compile \- create a Zero Install binary package from source
   4
   5 .SH SYNOPSIS
   6
   7 .B 0compile autocompile SOURCE-URI
   8
   9 .B 0compile setup
  10 [\fB--no-prompt\fP] [\fBSOURCE-URI\fP [\fBDIR\fP] ]
  11
  12 .B 0compile build
  13 [\fB --nosandbox\fP ] [\fB--shell\fP]
  14
  15 .B 0compile publish
  16 [\fBDOWNLOAD-BASE-URL\fP]
  17
  18 .B 0compile clean
  19
  20 .B 0compile copy-src
  21
  22 .B 0compile diff
  23
  24 .B 0compile gui
  25 [\fB--no-prompt\fP] [\fBSOURCE-URI\fP]
  26
  27 .B 0compile include-deps
  28
  29 .B 0compile report-bug
  30
  31 .SH DESCRIPTION
  32 .PP
  33 0compile can be used to compile a Zero Install package from its source code.
  34
  35 .SH AUTOCOMPILE
  36
  37 .PP
  38 Download and build the source code for the given program. Also download and build
  39 any missing dependencies, recursively. The resulting binaries will be placed in the
  40 Zero Install implementation cache (just like normal binary downloads). A feed file
  41 describing each new binary is created under $XDG_CONFIG_DIRS/0install.net/0compile/builds/
  42 and registered with Zero Install (using "0launch --feed").
  43
  44 .PP
  45 On error, 0compile will display the name of the temporary directory in which it was
  46 compiling the component which failed. You can cd to this directory and fix the problem
  47 using the other 0compile commands.
  48
  49 .SH SETUP
  50
  51 .PP
  52 To set up a build environment for the GNU Hello World example:
  53
  54 .B 0compile setup http://0install.net/tests/GNU-Hello.xml GNU-Hello
  55
  56 .PP
  57 This downloads the source and any build dependencies into the Zero Install
  58 cache, and creates a new directory called GNU-Hello.
  59
  60 .PP
  61 If the name is "." then it uses the current directory instead of creating a new one.
  62
  63 .SH BUILD
  64
  65 .PP
  66 To compile the code, cd to the directory created by "setup" above, and then:
  67
  68 .B 0compile build
  69
  70 .PP
  71 The resulting package will be in a new gnu-hello-1.3 subdirectory (or whatever version you downloaded).
  72 Temporary build files will be in a new "build" subdirectory. These are kept to make rebuilds faster, but
  73 you can delete them if you don't plan to recompile.
  74
  75 .SH PUBLISH
  76
  77 .PP
  78 To create an archive that other people can download:
  79
  80 .B 0compile publish http://mysite/downloads
  81
  82 The will archive the target directory. Upload the resulting tarball to the downloads directory on your web-server.
  83 The command will also create an XML file which can be used to download and run this version.
  84
  85 .SH CLEAN
  86
  87 Deletes the 'build' and distribution directories, if present.
  88
  89 .SH COPY-SRC
  90
  91 .PP
  92 To make changes to the code before compiling:
  93
  94 .B 0compile copy-src
  95
  96 This copies the source code from the cache into a new "src" subdirectory. Edit to taste and then "build".
  97
  98 .SH DIFF
  99
 100 To see the differences between the original (cached) source code and the copy in your "src" directory:
 101
 102 .B 0compile diff
 103
 104 .SH INCLUDE-DEPS
 105
 106 To create a self-contained bundle with the source code and build dependencies:
 107
 108 .B 0compile include-deps
 109
 110 This copies all required items from the Zero Install cache to a new "dependencies" subdirectory. The whole
 111 directory tree (including the "dependencies" subdirectory) can then be copied to the build machine. This is
 112 useful if the build machine doesn't have network access, and so can't download them itself.
 113
 114 .PP
 115 Note that this doesn't include the 0compile program itself.
 116
 117 .SH GUI
 118
 119 To bring up the GTK interface, which offers an newbie-friendly interface to some of the features above:
 120
 121 .B 0compile gui
 122
 123 .SH REPORT-BUG
 124
 125 To send a bug-report about a failed build:
 126
 127 .B 0compile report-bug
 128
 129
 130 .SH COMMAND-LINE OPTIONS
 131
 132 .TP
 133 \fB-h\fP, \fB--help\fP
 134 Show the built-in help text.
 135
 136 .TP
 137 \fB-v\fP, \fB--verbose\fP
 138 More verbose output. Use twice for even more verbose output.
 139
 140 .TP
 141 \fB-V\fP, \fB--version\fP
 142 Display version information.
 143
 144 .SH LICENSE
 145 .PP
 146 Copyright (C) 2007 Thomas Leonard.
 147
 148 .PP
 149 You may redistribute copies of this program under the terms of the GNU General Public License.
 150 .SH BUGS
 151 .PP
 152 Please report bugs to the developer mailing list:
 153
 154 http://0install.net/support.html
 155
 156 .SH AUTHOR
 157 .PP
 158 The Zero Install Injector was created by Thomas Leonard.
 159
 160 .SH SEE ALSO
 161 0launch(1), 0store(1)
 162 .PP
 163 The Zero Install web-site:
 164
 165 .B http://0install.net/0compile.html