Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
BUILDTOOL(1)		FreeBSD	General	Commands Manual		  BUILDTOOL(1)

     buildtool -- build	infrastructure for source packages

     buildtool [-h] target [target_args]

     This manual page is intended as a reference document only,	addressed to
     users who want to build source packages.  If you are interested in	devel-
     opment (and a more	detailed description of	what is	explained here),
     please read the Buildtool's Manual	available online, together with	more
     documentation, at the official documentation page:

     Thank you for choosing buildtool.

     This section provides a quick reference on	how to build source packages.
     After unpacking the source	distribution file, enter the new directory and
     follow the	instructions provided in the next sections.

   Reading documentation
     To	get started, issue the following command, which	will show several in-
     formation useful to build that specific package:

	   $ buildtool doc

   Configuring the sources
     For a standard, automated setup, type this	command:

	   $ buildtool config

     which configures the source package to build cleanly on the host system.
     However, this uses	all default settings, which may	be not suitable	for
     your system.

     To	change the installation	prefix (which defaults to /usr/local), do:

	   $ buildtool config --prefix=/opt

     Aside from	the prefix, you	can customize where things get installed on a
     directory basis and enable	or disable specific features.  The commands:

	   $ buildtool config --help
	   $ buildtool config --help 2>&1 | less

     show a list of all	directories and	features that can be tuned, together
     with their	default	values (use the	later for a paged output).

     To	change the value of a customizable directory, use the --dir flag, as
     in	the following example:

	   $ buildtool config --dir-bin=/usr/local/bin-test

     To	change the value of a customizable feature, use	one of the --feature,
     --enable or --disable flags, as in	the following examples:

	   $ buildtool config --feature-developer=yes
	   $ buildtool config --enable-developer
	   $ buildtool config --disable-developer

     Short options are available too.  All examples shown above	use long op-
     tions because they	are easier to remember.

   Building the	sources
     Assuming the configuration	step finished successfully, issue the follow-
     ing command to build the entire source tree:

	   $ buildtool build

     You can run this command in a specific subdirectory to only build that
     part of the tree.

   Testing the build
     After a successful	build of the sources, you might	want to	run some tests
     to	check that the program behaves properly	in your	system.	 To run	the
     test suite, simply	do:

	   $ buildtool test

     Note that these checks are	specific to each package, and are only avail-
     able if the developer took	care to	write them.

   Installing the results
     Issue the following command to install the	binaries generated by the
     build step:

	   $ buildtool install

     You can run this command in a specific subdirectory to only install that
     part of the tree.

     If	you want to keep the source tree around, you may want to clean all ob-
     ject files	and work stuff to reduce the amount of space it	uses.  The

	   $ buildtool clean
	   $ buildtool cleandir

     will clean	all the	tree, the later	beeing more aggressive than the	for-

FreeBSD	13.0			  May 8, 2004			  FreeBSD 13.0


Want to link to this manual page? Use this URL:

home | help