Break out BATCH note, describe configing only one package but leave deps as default.
[ikiwiki.git] / docs / docs / howtos / HowToDPorts / index.mdwn
1 ## DPorts background:
2
3 Dports is an effort to use FreeBSD’s ports system as a base for DragonFly, and the pkg tool as a way to manage binary packages built from DPorts.  This is complicated, so I’ll explain each part in order.
4
5 FreeBSD ports are a FreeBSD-specific collection of software installation files that automate building 3rd-party software on FreeBSD.  You’ve probably already heard of them.  (Note there’s no mention of DragonFly.)  
6
7 DPorts is a collection of files that map to existing FreeBSD ports, and contain any changes necessary to make that port also build on DragonFly.  Many of those programs build without changes on DragonFly.  DPorts builds from source.
8
9 pkg is used for package management, and is usable on FreeBSD, PC-BSD, and on DragonFly.  The binary packages produced from building with DPorts can be installed from remote locations and managed separately using pkg, so that software upgrades and installation can be performed with binaries only.  (It’s much faster that way.)
10
11 Every port seen in DPorts is known to build on DragonFly.  A port is added only after it builds successfully, using poudriere as a bulk software tool.   Ports are only updated to a newer version when that newer version builds, too, so once something arrives in DPorts, it should never break from being updated at some point in the future.
12
13 ## Installing DPorts
14
15 To use DPorts, you need two things:
16
17 *First thing:* DragonFly 3.3 or later,.
18
19 *Second thing:* You need to rename /usr/pkg so that your existing pkgsrc binary programs don’t get accidentally used while working with DPorts, causing confusion.  If anything goes wrong with DPorts when you are installing it and you want to go back, remove all the DPorts packages and rename /usr/pkg back to normal.  (Don’t confuse pkg, the management tool, with /usr/pkg, the normal installation directory for pkgsrc. ) For the installation of the base port files:
20
21     cd /usr
22     make dports-create-shallow
23
24 If you’ve already renamed your /usr/pkg directory, git won’t be in your path any more.  You can instead download a tarball and unpack it, which also happens to be possible automatically via that same Makefile.
25
26     cd /usr
27     make dports-download
28
29 Downloading via git is fastest, so if you do need to use the tarball via make dports-download, build devel/git, delete /usr/dports, and then pull it again with make dports-create-shallow.  This all comes from [John Marino’s Github site for DPorts](https://github.com/jrmarino/DPorts/#readme).
30
31 ## Managing DPorts
32
33 DPorts doesn’t use pkg_info, pkg_add, and the other tools traditionally seen on DragonFly for pkgsrc.  Instead, package management is done with pkg.   Use pkg info, pkg install, pkg remove, and pkg update to list, install, delete, and upgrade various packages on your system.  Packages built from source or downloaded as prebuilt binaries are managed the same way, using these tools.
34
35 See some of the [other](https://mebsd.com/make-build-your-freebsd-word/pkgng-first-look-at-freebsds-new-package-manager.html) [writing](http://ivoras.net/blog/tree/2012-07-26.pkgng---best-thing-since-sliced-bread!.html) about pkg for FreeBSD for details on how it works.
36
37 Since DPorts doesn’t update a package until it gets a successful build, and installations are of successfully built binary packages, upgrades with prebuilt packages should always succeed.  Since they’re binary, they should be fast.  There’s a lot of ‘shoulds’  in this sentence, but these are reasonable suppositions.
38
39 ## Building from source
40
41 Building from source works similar to ports and pkgsrc: cd into the appropriate program's directory, and type 'make'.  'make install' to install the software, 'make clean' to clean up work files, and so on.  Use 'make config-recursive' if you want to set all the port's options, and the options of its dependencies, immediately instead of during the build.
42
43 *You will eventually want to do this:* Set BATCH=yes to take all default package options without having the build stop to ask questions.
44
45 If you just want to set the options for one package, and accept the default for all of its dependencies, do 'make config' in the package in you want non-default options, and then 'make BATCH=yes'.
46
47 Note that this is only necessary if you want to build from source with a non-default config, or if you don't have a binary repository available to pull files from with pkg.
48
49 ## Installing binaries
50
51 The pkg tool can be used to install packages, manage them, and so on, as mentioned previously.  DragonFly, as of this writing, does not pre-set a repository for package retrieval.
52
53 To set a repository source for binary packages, edit /usr/local/pkg.conf and add a line like this:
54
55     PACKAGESITE: http://URL-TO-REPOSITORY/
56
57 For example, this is a repository for DragonFly 3.4/x86_64:
58
59     PACKAGESITE: http://avalon.dragonflybsd.org/dports/dragonfly:3.4:x86:64
60
61
62
63 ## What about pkgsrc?
64
65 Pkgsrc and DPorts shouldn’t be used at the same time, since one system’s packages may be at different versions but still get picked up during building for the other system.  That’s about it for restrictions.
66
67 DPorts is brand new so the normal caveats apply; don’t install it on a mission-critical machine, and be ready to deal with any surprises from using it if you do try it out.
68
69 ## What packages are available?
70
71 Browsing the Github repo will show you all listed packages.  It changes as more packages are built.  Changes from DragonFly builds are sometimes relevant to the original FreeBSD port, so there’s benefits for everyone here.
72
73 ## What next?
74
75 This is experimental; this will not necessarily replace pkgsrc.  It's available in this release for further testing and feedback.  Remember, this is a new project, so a willingness to deal with problems and contribute to fixes is necessary.