summaryrefslogtreecommitdiff
path: root/distrib/notes/packages
blob: 1064e4b7b1c7313dbaababb92946ccc7c93ada5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
dnl	$OpenBSD: packages,v 1.49 2016/09/02 12:17:32 tb Exp $
As complete as your OpenBSD system is, you may want to add any of several
excellent third party software applications.  There are several ways to do
this.  You can:

1) Use the OpenBSD ``package'' collection to grab a pre-compiled
   and tested version of the application for your hardware.

2) Use the OpenBSD ``ports'' collection to automatically get any
   needed source file, apply any required patches, create the
   application, and install it for you.

3) Obtain the source code and build the application based
   upon whatever installation procedures are provided with the
   application.

If you purchased the OpenBSD CD-ROM set you already have a few popular
``packages'', and the ``ports'' collection.

Instructions for installing applications from the various sources using
the different installation methods follow.

You should also refer to the packages(7) manual page.

Installing applications from the CD-ROM package collection:

	The OpenBSD CD-ROM ships with the most commonly installed third-party
	applications pre-built for various hardware architectures.  Limited
	disk space on the CD-ROM unfortunately limits the number of such
	packages.  Check the directory OSREV/packages/MACHINE_ARCH to see which
	packages are available for your hardware architecture.  That directory
	will be on the same CD-ROM containing the OS installation files for
	your architecture.

	To install one or more of these packages you must:
	1) become the superuser (root).
	2) mount the appropriate CD-ROM.
	3) use the ``pkg_add'' command to install the software.

	Example (in which we use su(1) to get superuser privileges, thus
	you have to be in group "wheel", see the manual page for su(1)).

    $ su
    Password: <enter your root password>
    # mkdir -p /cdrom
    # mount /dev/cd0a /cdrom
    {:-#-:} pkg_add /cdrom/OSREV/packages/MACHINE_ARCH/<package-name>
    # <add more packages if desired>
    # umount /cdrom

	Package names are usually the application name and version
	with .tgz appended, e.g. bzip2-1.0.6p0.tgz

Installing applications from the ftp.OpenBSD.org package collection:

	All available packages for your architecture have been placed on
	ftp.OpenBSD.org in the directory pub/OpenBSD/OSREV/packages/MACHINE_ARCH/
	You may want to peruse this to see what packages are available.  The
	packages are also on the OpenBSD mirror sites.  See

		https://www.OpenBSD.org/ftp.html

	for a list of current mirror sites.

	Installation of a package is very easy.
	1) become the superuser (root)
	2) use the ``pkg_add'' command to install the software

	``pkg_add'' is smart enough to know how to download the software
	from the OpenBSD HTTP server.  Example:

    $ su
    Password: <enter your root password>
    # pkg_add \
      http://ftp.OpenBSD.org/pub/OpenBSD/{:--:}OSREV/packages/MACHINE_ARCH/emacs-21.4p32.tgz

Installing applications from the CD-ROM ports collection:

	The CD-ROM ``ports'' collection is a set of Makefiles, patches,
	and other files used to control the building and installation
	of an application from source files.

	Creating an application from sources can require a lot of
	disk space, sometimes 50 megabytes or more.  The first step is
	to determine which of your disks has enough room.  Once you've
	made this determination, read the file PORTS located on the
	CD-ROM which contains the ports tree.

	To build an application you must:

	1) become the superuser (root)
	2) have network access, or obtain the actual source files by
	   some other means.
	3) cd to the ports directory containing the port you wish
	   to build.  To build samba, for example, where you'd
	   previously copied the ports files into the /usr/ports
	   directory: cd /usr/ports/net/samba
	4) make
	5) make install
	6) make clean

Installing applications from the OpenBSD ports collection:

	See https://www.openbsd.org/faq/faq15.html#Ports for current
	instructions on obtaining and installing OpenBSD ports.

	You should also refer to the ports(7) manual page.

Installing other applications:

	If an OpenBSD package or port does not exist for an application
	you're pretty much on your own.  The first thing to do is ask
	<ports@OpenBSD.org> if anyone is working on a port -- there may
	be one in progress.  If no such port exists, you might want to
	look at the FreeBSD ports or NetBSD pkgsrc for inspiration.

	If you can't find an existing port, try to make your own and
	feed it back to OpenBSD.  That's how our ports collection grows.
	Some details can be found in the OpenBSD Porter's Handbook at
	https://www.openbsd.org/faq/ports/
	with more help coming from the mailing list, <ports@OpenBSD.org>.