$NetBSD: README,v 1.21 2020/05/07 14:20:49 nia Exp $

To try to get pkgsrc working on your system, please try the following
as root:

# ./bootstrap
    [ --workdir <workdir> ]
    [ --prefix <prefix> ]
    [ --pkgdbdir <pkgdbdir> ]
    [ --sysconfdir <sysconfdir> ]
    [ --varbase <varbase> ]
    [ --ignore-case-check ]
    [ --ignore-user-check ]
    [ --preserve-path ]
    [ --help ]

The defaults for the arguments are as follows:

	--prefix	/usr/pkg
	--pkgdbdir	/usr/pkg/pkgdb
	--sysconfdir	/usr/pkg/etc
	--varbase	/var
	--workdir	work

The working directory will be created if it doesn't exist and has to be
writable by the user executing ./bootstrap.

The bootstrap script will exit if the bootstrap directory already exists,
for example if you have run the script before. In this case, clean it up
by running:

# ./cleanup

Make sure that you have a working C compiler and make(1) binary in
your path.  Please note that on some systems (IRIX and SunOS, for example),
the bootstrap script will look into a number of common directories for
alternative implementations of some tools.  If they are found, these
directories will be prepended to the PATH variable, unless the
'--preserve-path' flag is given.

See pkgsrc/doc/pkgsrc.txt or
http://www.NetBSD.org/docs/software/packages.html for
more information about bootstrapping and using pkgsrc.

We'd be very interested in hearing of any successes or failures on
"unknown" (to us) systems.

Please remember to add $prefix/bin to your PATH environment variable
and $prefix/man to your MANPATH environment variable, if necessary.
(See above for --prefix and its default value.)

The bootstrap script will create an example mk.conf file located
in your work directory as "mk.conf.example". It contains the
settings you provided to the bootstrap. Copy it to your
$sysconfdir directory (see above about --sysconfdir and its default
value). If the default mk.conf doesn't already exist, the example is
copied into place.


PER PLATFORM INFORMATION
========================

pkgsrc supports or has supported many operating systems (platforms).
In general, there is a README.os for each platform that can run
pkgsrc, explaining particular considerations.

Because pkgsrc contains many per-platform fixes and accommodations,
and because the presence of those at times causes more work for
others, we list platforms according to whether they are in active use.
(If you feel a platform is miscategorized, send rationale to
pkgsrc-users@.  Include a README.platform with instructions if it is
missing and you are asserting that there are users.  Developers should
of course feel free to make improvements.)

Note that listing a platform as having no users is not a decision to
remove it from pkgsrc; this is merely recording information that
individual developers can use when deciding how much work is justified
for keeping any particular accommodation.  (As always, any large-scale
removals require a proposal and discussion on pkgsrc-users@.)

Note also that pkgsrc policy is that fixes to packages, unless the
fixes are to adjust a package to pkgsrc norms, should be filed
upstream and the upstream tracker URL included in the patch file or
Makefile.

Platforms are listed by the filename in mk/platform, annotated by the
README.platform here if different.  Problems are listed, such as lack
of a README, lack of cwrappers support, and lack of destdir support.


Platforms with active use and maintenance
-----------------------------------------

The following platforms have active users, and people that regularly
fix problems.

  Darwin (README.MacOSX, macOS)
  FreeBSD
  Linux
  NetBSD
  SunOS (README.Solaris, illumos, SmartOS, OmniOS)


Platforms believed to have users
--------------------------------

  OpenBSD


Platforms with at least a tiny number of users
----------------------------------------------
  SCO_SV (README.OpenServer5)


Platforms with unknown status
-----------------------------
  Cygwin
  DragonFly (no README)
  FreeMiNT (no README)
  GNUkFreeBSD
  Minix (no README)
  UnixWare (no README)


Platforms believed to have almost no users
------------------------------------------

  AIX (no cwrappers)
  BSDOS (no README)
  HPUX
  IRIX
  Interix
  MirBSD
  OSF1
  QNX (no README)


Platforms believed to have no users
-----------------------------------

  Bitrig
  Haiku