0compile.1

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