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