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 .PP
  43 If the name is "." then it uses the current directory instead of creating a new one.
  44
  45 .SH BUILD
  46
  47 .PP
  48 To compile the code, cd to the directory created by "setup" above, and then:
  49
  50 .B 0compile build
  51
  52 .PP
  53 The resulting package will be in a new gnu-hello-1.3 subdirectory (or whatever version you downloaded).
  54 Temporary build files will be in a new "build" subdirectory. These are kept to make rebuilds faster, but
  55 you can delete them if you don't plan to recompile.
  56
  57 .SH PUBLISH
  58
  59 .PP
  60 To create an archive that other people can download:
  61
  62 .B 0compile publish http://mysite/downloads
  63
  64 The will archive the target directory. Upload the resulting tarball to the downloads directory on your web-server.
  65 The command will also create an XML file which can be used to download and run this version.
  66
  67 .SH COPY-SRC
  68
  69 .PP
  70 To make changes to the code before compiling:
  71
  72 .B 0compile copy-src
  73
  74 This copies the source code from the cache into a new "src" subdirectory. Edit to taste and then "build".
  75
  76 .SH DIFF
  77
  78 To see the differences between the original (cached) source code and the copy in your "src" directory:
  79
  80 .B 0compile diff
  81
  82 .SH INCLUDE-DEPS
  83
  84 To create a self-contained bundle with the source code and build dependencies:
  85
  86 .B 0compile include-deps
  87
  88 This copies all required items from the Zero Install cache to a new "dependencies" subdirectory. The whole
  89 directory tree (including the "dependencies" subdirectory) can then be copied to the build machine. This is
  90 useful if the build machine doesn't have network access, and so can't download them itself.
  91
  92 .PP
  93 Note that this doesn't include the 0compile program itself.
  94
  95 .SH GUI
  96
  97 To bring up the GTK interface, which offers an newbie-friendly interface to some of the features above:
  98
  99 .B 0compile gui
 100
 101 .SH REPORT-BUG
 102
 103 To send a bug-report about a failed build:
 104
 105 .B 0compile report-bug
 106
 107
 108 .SH COMMAND-LINE OPTIONS
 109
 110 .TP
 111 \fB-h\fP, \fB--help\fP
 112 Show the built-in help text.
 113
 114 .TP
 115 \fB-v\fP, \fB--verbose\fP
 116 More verbose output. Use twice for even more verbose output.
 117
 118 .TP
 119 \fB-V\fP, \fB--version\fP
 120 Display version information.
 121
 122 .SH LICENSE
 123 .PP
 124 Copyright (C) 2007 Thomas Leonard.
 125
 126 .PP
 127 You may redistribute copies of this program under the terms of the GNU General Public License.
 128 .SH BUGS
 129 .PP
 130 Please report bugs to the developer mailing list:
 131
 132 http://0install.net/support.html
 133
 134 .SH AUTHOR
 135 .PP
 136 The Zero Install Injector was created by Thomas Leonard.
 137
 138 .SH SEE ALSO
 139 0launch(1), 0store(1)
 140 .PP
 141 The Zero Install web-site:
 142
 143 .B http://0install.net/0compile.html