mk/platform/README

   1 $NetBSD: README,v 1.2 2013/04/08 13:29:26 obache Exp $
   2
   3 These files contain platform-specific definitions that are used by the
   4 pkgsrc infrastructure.
   5
   6 TODO: Document all these variables.
   7
   8     CPP
   9
  10     ECHO_N is full command line of BSD `echo -n' compatible.
  11
  12     IMAKE_MAKE is make(1) program which gets invoked by imake(1).
  13
  14     IMAKEOPTS is additional arguments for imake(1)
  15
  16     PKGLOCALEDIR is the directory where locale data directory is put.
  17
  18     PS is fullpath to ps(1) command.
  19
  20     SU is fullpath to su(1) command.
  21
  22     TYPE is fullpath to type(1) command, or just `type' for shell builtin one.
  23
  24     USERADD is fullpath to useradd(8) command.
  25
  26     GROUPADD is fullpath to groupadd(8) command.
  27
  28     _PKG_USER_HOME is home directory for system accounts to match other system
  29         accounts.
  30
  31     _USER_DEPENDS is dependency pattern which USERADD/GROUPADD to be available.
  32
  33     CPP_PRECOMP_FLAGS
  34
  35     DEF_UMASK
  36
  37     EXPORT_SYMBOLS_LDFLAGS is for adding symbols to the dynamic symbol table.
  38
  39     MOTIF_TYPE_DEFAULT is default motif-2.0 compatible libs type.
  40
  41     NOLOGIN is user's login shell to refuse a login.
  42
  43     PKG_TOOLS_BIN is fullpath to pkg_info(8) command.
  44
  45     ROOT_CMD is full command line prefix to invoke subsequent command will be
  46         invoked with privileged user.
  47
  48     ROOT_USER is system privileged user name.
  49
  50     ROOT_GROUP is system privileged group name.
  51
  52     ULIMIT_CMD_datasize is command line to unlimit data segment size of a
  53         process.
  54
  55     ULIMIT_CMD_stacksize is command line to unlimit stack size of a process.
  56
  57     ULIMIT_CMD_memorysize is command line to unlimit total physical memory
  58         that can be in use by a process.
  59
  60     X11_TYPE is X11 implementation used to build X11 packages.
  61
  62         "native" means that platform native X11 is used.
  63         "modular" means that modular X11 from pkgsrc is used.
  64
  65     _OPSYS_EMULDIR.${OPSYS} is sub directory in LOCALBASE where ${OPSYS}
  66         emulation files is put.
  67
  68     _OPSYS_SYSTEM_RPATH is colon separated list of system rpath.
  69
  70     _OPSYS_LIB_DIRS is list of system library directories.
  71
  72     _OPSYS_INCLUDE_DIRS is list of system header file directories.
  73
  74     _OPSYS_HAS_INET6 is "yes" if IPv6 is standard, otherwise "no".
  75
  76     _OPSYS_HAS_JAVA is "yes" if Java is standard, otherwise "no".
  77
  78     _OPSYS_HAS_MANZ is "yes" if MANZ controles gzipping of man pages, or "no".
  79
  80     _OPSYS_HAS_OSSAUDIO is "yes" if libossadio is available
  81
  82     _OPSYS_PERL_REQD is base version of perl required, or empty if not required.
  83
  84     _OPSYS_PTHREAD_AUTO is "yes" if -lpthread is needed for pthreads, or "no".
  85
  86     _OPSYS_SHLIB_TYPE is platform shared lib type.
  87
  88     _PATCH_CAN_BACKUP is "yes if native patch(1) can make backups.
  89
  90     _PATCH_BACKUP_ARG is switch to patch(1) for backup suffix.
  91
  92     _USE_RPATH is "yes" to add rpath to LDFLAGS, otherwise "no"
  93
  94     _OPSYS_WHOLE_ARCHIVE_FLAG
  95
  96     _OPSYS_NO_WHOLE_ARCHIVE_FLAG
  97
  98     LINK_ALL_LIBGCC_HACK
  99
 100     _STRIPFLAG_CC is cc(1) option to strip.
 101
 102     _STRIPFLAG_INSTALL is install(1) option to strip.
 103
 104     DEFAULT_SERIAL_DEVICE is platform default serial device
 105
 106     SERIAL_DEVICES is list of supported serial devices
 107
 108     PKG_HAVE_KQUEUE is defined if kqueue(2) is supported.
 109
 110     _OPSYS_CAN_CHECK_SHLIBS is "yes" if "check-shlibs" in check/check-shlibs.mk
 111         can be performed.
 112
 113     _OPSYS_MAX_CMDLEN_CMD is used to check maximum command line length and
 114         set it in configure's environment, to avoid a test required by the
 115         libtool script that takes forever.
 116
 117 === Implementation notes ===
 118
 119 Do not try to extract the definitions that are common to all files into
 120 another file (maybe common.mk). The code duplication is intentional
 121 here.