Index: head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml =================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml (revision 47057) +++ head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml (revision 47058) @@ -1,1491 +1,1415 @@ Using <varname>USES</varname> Macros An Introduction to <varname>USES</varname> USES macros make it easy to declare requirements and settings for a port. They can add dependencies, change building behavior, add metadata to packages, and so on, all by selecting simple, preset values.. Each section in this chapter describes a possible value for USES, along with its possible arguments. Arguments are appeneded to the value after a colon (:). Multiple arguments are separated by commas (,). Using Multiple Values USES= bison perl Adding an Argument USES= gmake:lite Adding Multiple Arguments USES= drupal:7,theme Mixing it All Together USES= pgsql:9.3+ cpe python:2.7,build - - <literal>ada</literal> + + <literal>ada</literal> - Possible arguments: (none), 47, 49, - 5 + Possible arguments: (none), 47, + 49, 5 - Depends on an Ada-capable - compiler, and sets CC accordingly. - Defaults to a gcc 4.9 based - compiler, use :47 to use the older - gcc 4.7 based one and - :5 to use the newer - gcc 5 based one. - + Depends on an Ada-capable + compiler, and sets CC accordingly. Defaults + to a gcc 4.9 based compiler, use + :47 to use the older + gcc 4.7 based one and + :5 to use the newer + gcc 5 based one. + - - <literal>autoreconf</literal> + + <literal>autoreconf</literal> - Possible arguments: (none), build + Possible arguments: (none), build - Runs autoreconf. It encapsulates - the aclocal, - autoconf, - autoheader, - automake, autopoint, - and libtoolize commands. Each command - applies to - ${CONFIGURE_WRKSRC}/configure.ac or - its old name, - ${CONFIGURE_WRKSRC}/configure.in. If - configure.ac defines subdirectories - with their own configure.ac using - AC_CONFIG_SUBDIRS, - autoreconf will recursively update - those as well. The :build argument - only adds build time dependencies on those tools but does - not run autoreconf. - + Runs autoreconf. It encapsulates the + aclocal, autoconf, + autoheader, automake, + autopoint, and libtoolize + commands. Each command applies to + ${CONFIGURE_WRKSRC}/configure.ac or its old + name, ${CONFIGURE_WRKSRC}/configure.in. If + configure.ac defines subdirectories with + their own configure.ac using + AC_CONFIG_SUBDIRS, + autoreconf will recursively update those as + well. The :build argument only adds build + time dependencies on those tools but does not run + autoreconf. + - - <literal>blaslapack</literal> + + <literal>blaslapack</literal> - Possible arguments: (none), atlas, - netlib (default), - gotoblas, - openblas + Possible arguments: (none), atlas, + netlib (default), + gotoblas, openblas - Adds dependencies on Blas / Lapack libraries. - + Adds dependencies on Blas / Lapack libraries. + - - <literal>bison</literal> + + <literal>bison</literal> - Possible arguments: (none), build, - run, both + Possible arguments: (none), build, + run, both - Uses devel/bison - By default, with no arguments or with the - build argument, it implies - bison is a build-time dependency, - run implies a run-time dependency, and - both implies both run-time and - build-time dependencies. - + Uses devel/bison By default, + with no arguments or with the build argument, + it implies bison is a build-time dependency, + run implies a run-time dependency, and + both implies both run-time and build-time + dependencies. + - - <literal>charsetfix</literal> + + <literal>charsetfix</literal> - Possible arguments: (none) + Possible arguments: (none) - Prevents the port from installing - charset.alias. This must be - installed only by - converters/libiconv. - CHARSETFIX_MAKEFILEIN can be set to a - path relative to WRKSRC if - charset.alias is not installed by - ${WRKSRC}/Makefile.in. - + Prevents the port from installing + charset.alias. This must be installed only + by converters/libiconv. + CHARSETFIX_MAKEFILEIN can be set to a path + relative to WRKSRC if + charset.alias is not installed by + ${WRKSRC}/Makefile.in. + - - <literal>cmake</literal> + + <literal>cmake</literal> - Possible arguments: (none), outsource, - run + Possible arguments: (none), outsource, + run - Uses CMake for configuring - and building. With the outsource - argument, an out-of-source build will be performed. With - the run argument, a run-time dependency - is registered. For more information see - . - + Uses CMake for configuring and + building. With the outsource argument, an + out-of-source build will be performed. With the + run argument, a run-time dependency is + registered. For more information see . + - - <literal>compiler</literal> + + <literal>compiler</literal> - Possible arguments: (none), c++0x, - c++11-lang, - gcc-c++11-lib, - c++11-lib, c11, - openmp, nestedfct, - features + Possible arguments: (none), c++0x, + c++11-lang, gcc-c++11-lib, + c++11-lib, c11, + openmp, nestedfct, + features - Determines which compiler to use based on any given - wishes. Use c++11-lang if the port - needs a C++11-capable compiler, - gcc-c++11-lib if the port needs the - g++ compiler with a C++11 library, and - c++11-lib if the port also needs a - C++11-ready standard library. If the port needs a - compiler understanding C++0X, C11, OpenMP, or nested - functions, the corresponding parameters can be used. Use - features to request a list of features - supported by the default compiler. After including - bsd.port.pre.mk the port can inspect - the results using these variables: + Determines which compiler to use based on any given wishes. + Use c++11-lang if the port needs a + C++11-capable compiler, gcc-c++11-lib if the + port needs the g++ compiler with a C++11 + library, and c++11-lib if the port also needs + a C++11-ready standard library. If the port needs a compiler + understanding C++0X, C11, OpenMP, or nested functions, the + corresponding parameters can be used. Use + features to request a list of features + supported by the default compiler. After including + bsd.port.pre.mk the port can inspect the + results using these variables: - - - COMPILER_TYPE: the default - compiler on the system, either gcc or clang - + + + COMPILER_TYPE: the default compiler + on the system, either gcc or clang + - - ALT_COMPILER_TYPE: the - alternative compiler on the system, either gcc or - clang. Only set if two compilers are present in the - base system. - + + ALT_COMPILER_TYPE: the alternative + compiler on the system, either gcc or clang. Only set if + two compilers are present in the base system. + - - COMPILER_VERSION: the first - two digits of the version of the default - compiler. - + + COMPILER_VERSION: the first two + digits of the version of the default compiler. + - + + ALT_COMPILER_VERSION: the first two + digits of the version of the alternative compiler, if + present. + - ALT_COMPILER_VERSION: the - first two digits of the version of the alternative - compiler, if present. - + + CHOSEN_COMPILER_TYPE: the chosen + compiler, either gcc or clang + - - CHOSEN_COMPILER_TYPE: the - chosen compiler, either gcc or clang - + + COMPILER_FEATURES: the features + supported by the default compiler. It currently lists the + C++ library. + + + - - COMPILER_FEATURES: the - features supported by the default compiler. It - currently lists the C++ library. - - - + + <literal>cpe</literal> - - <literal>cpe</literal> + Possible arguments: (none) - Possible arguments: (none) + Include Common Platform Enumeration + (CPE) information in package manifest as a + CPE 2.3 formatted string. See the CPE + specification for details. To add + CPE information to a port, follow these + steps: - - Include Common Platform Enumeration - (CPE) information in package manifest - as a CPE 2.3 formatted string. See the - CPE - specification for details. To add - CPE information to a port, follow these - steps: + + + Search for the official CPE para for the software + product either by using the NVD's CPE + search engine or in the official + CPE dictionary (warning, very + large XML file). Do not ever + make up CPE data. + - - - Search for the official CPE para for the - software product either by using the NVD's CPE - search engine or in the official - CPE dictionary (warning, - very large XML file). - Do not ever make up CPE - data. - + + Add cpe to USES + and compare the result of make -V CPE_STR + to the CPE dictionary para. Continue one + step at a time until make -V CPE_STR is + correct. + - - Add cpe to - USES and compare the result of - make -V CPE_STR to the - CPE dictionary para. Continue - one step at a time until make -V - CPE_STR is correct. - + + If the product name (second field, defaults to + PORTNAME) is incorrect, define + CPE_PRODUCT. + - - If the product name (second field, defaults to - PORTNAME) is incorrect, define - CPE_PRODUCT. - + + If the vendor name (first field, defaults to + CPE_PRODUCT) is incorrect, define + CPE_VENDOR. + - - If the vendor name (first field, defaults to - CPE_PRODUCT) is incorrect, define - CPE_VENDOR. - + + If the version field (third field, defaults to + PORTVERSION) is incorrect, define + CPE_VERSION. + - - If the version field (third field, defaults to - PORTVERSION) is incorrect, define - CPE_VERSION. - + + If the update field (fourth field, defaults to empty) is + incorrect, define CPE_UPDATE. + - - If the update field (fourth field, defaults to - empty) is incorrect, define - CPE_UPDATE. - + + If it is still not correct, check + Mk/Uses/cpe.mk for additional details, + or contact the &a.ports-secteam;. + - - If it is still not correct, check - Mk/Uses/cpe.mk for additional - details, or contact the &a.ports-secteam;. - + + Derive as much as possible of the CPE + name from existing variables such as + PORTNAME and + PORTVERSION. Use variable modifiers to + extract the relevant portions from these variables rather + than hardcoding the name. + - - Derive as much as possible of the - CPE name from existing variables - such as PORTNAME and - PORTVERSION. Use variable - modifiers to extract the relevant portions from - these variables rather than hardcoding the - name. - + + Always run make -V + CPE_STR and check the output before committing + anything that changes PORTNAME or + PORTVERSION or any other variable which + is used to derive CPE_STR. + + + - - Always run make -V - CPE_STR and check the output before - committing anything that changes - PORTNAME or - PORTVERSION or any other variable - which is used to derive - CPE_STR. - - - + + <literal>cran</literal> - - <literal>cran</literal> + Possible arguments: (none), + auto-plist - Possible arguments: (none), auto-plist + Uses the Comprehensive R Archive Network. Specify + auto-plist to automatically generate + pkg-plist. + - Uses the Comprehensive R Archive Network. Specify - auto-plist to automatically generate - pkg-plist. - + + <literal>desktop-file-utils</literal> - - <literal>desktop-file-utils</literal> + Possible arguments: (none) - Possible arguments: (none) + Uses update-desktop-database from + devel/desktop-file-utils. An + extra post-install step will be run without interfering with any + post-install steps already in the port + Makefile. A line with @desktop-file-utils + will be added to the plist. + - Uses - update-desktop-database from - devel/desktop-file-utils. - An extra post-install step will be run without interfering - with any post-install steps already in the port - Makefile. A line with @desktop-file-utils - will be added to the plist. - + + <literal>desthack</literal> - - <literal>desthack</literal> + Possible arguments: (none) - Possible arguments: (none) + Changes the behavior of GNU configure to properly support + DESTDIR in case the original software does + not. + - Changes the behavior of GNU configure to properly - support DESTDIR in case the original - software does not. - + + <literal>display</literal> - - <literal>display</literal> + Possible arguments: (none), ARGS - Possible arguments: (none), ARGS + Set up a virtual display environment. If the environment + variable DISPLAY is not set, then + Xvfb is added as a build dependency, + and CONFIGURE_ENV is extended with the port + number of the currently running instance of + Xvfb. The ARGS + parameter defaults to install and controls + the phase around which to start and stop the virtual + display. + - Set up a virtual display environment. If the - environment variable DISPLAY is not - set, then Xvfb is added as a - build dependency, and CONFIGURE_ENV is - extended with the port number of the currently running - instance of Xvfb. The - ARGS parameter defaults to - install and controls the phase around - which to start and stop the virtual display. - + + <literal>dos2unix</literal> - - <literal>dos2unix</literal> + Possible arguments: (none) - Possible arguments: (none) + The port has files with line endings in + DOS format which need to be converted. Three + variables can be set to control which files will be converted. + The default is to convert all files, + including binaries. See for + examples. - The port has files with line endings in - DOS format which need to be converted. - Three variables can be set to control which files will be - converted. The default is to convert - all files, including binaries. See - for - examples. + + + DOS2UNIX_REGEX: match file names + based on a regular expression. + - - - DOS2UNIX_REGEX: match file - names based on a regular expression. - + + DOS2UNIX_FILES: match literal file + names. + - - DOS2UNIX_FILES: match literal - file names. - + + DOS2UNIX_GLOB: match file names based + on a glob pattern. + + + - - DOS2UNIX_GLOB: match file - names based on a glob pattern. - - - + + <literal>drupal</literal> - - <literal>drupal</literal> + Possible arguments: 6, + 7, module, + theme - Possible arguments: 6, 7, - module, - theme + Automate installation of a port that is a + Drupal theme or module. Use with the + version of Drupal that the port is expecting. For example, + USES=drupal:6,module says that this port + creates a Drupal 6 module. A Drupal 7 theme can be specified + with USES=drupal:7,theme. + - Automate installation of a port that is a - Drupal - theme or module. Use with the version of Drupal that the - port is expecting. For example, - USES=drupal:6,module says that this - port creates a Drupal 6 module. A Drupal 7 theme can be - specified with - USES=drupal:7,theme. - + + <literal>execinfo</literal> - - <literal>execinfo</literal> + Possible arguments: (none) - Possible arguments: (none) + Add a library dependency on devel/libexecinfo if + libexecinfo.so is not present in the base + system. + - Add a library dependency on devel/libexecinfo if - libexecinfo.so is not present in the - base system. - + + <literal>fakeroot</literal> - - <literal>fakeroot</literal> + Possible arguments: (none) - Possible arguments: (none) + Changes some default behaviour of build systems to allow + installing as a user. See for more + information on fakeroot. + - Changes some default behaviour of build systems to - allow installing as a user. See for - more information on fakeroot. - + + <literal>fam</literal> - - <literal>fam</literal> + Possible arguments: (none), fam, gamin - Possible arguments: (none), fam, gamin + Uses a File Alteration Monitor as a library dependency, + either devel/fam or devel/gamin. End users can set + WITH_FAM_SYSTEM to specify their preference. + - Uses a File Alteration Monitor as a library - dependency, either - devel/fam or - devel/gamin. End users can - set WITH_FAM_SYSTEM to specify their preference. - + + <literal>fmake</literal> - - <literal>fmake</literal> + Possible arguments: (none) - Possible arguments: (none) + Uses devel/fmake as a + build-time dependency. + - Uses devel/fmake as a - build-time dependency. - + + <literal>fonts</literal> - - <literal>fonts</literal> + Possible arguments: (none) - Possible arguments: (none) + Adds a runtime dependency on tools needed to register fonts, + and add an @fcfontsdir + ${FONTSDIR} para to the plist. + FONTSDIR defaults to + ${PREFIX}/lib/X11/fonts/${FONTNAME} and + FONTNAME to + ${PORTNAME}. + - Adds a runtime dependency on tools needed to register - fonts, and add an @fcfontsdir - ${FONTSDIR} para to the plist. - FONTSDIR defaults to - ${PREFIX}/lib/X11/fonts/${FONTNAME} - and FONTNAME to - ${PORTNAME}. - + + <literal>fortran</literal> - - <literal>fortran</literal> + Possible arguments: gcc (default), + ifort - Possible arguments: gcc (default), - ifort + Uses the Fortran compiler from either GNU or Intel. + - Uses the Fortran compiler from either GNU or - Intel. - + + <literal>fuse</literal> - - <literal>fuse</literal> + Possible arguments: (none) - Possible arguments: (none) + The port will depend on the FUSE library and handle the + dependency on the kernel module depending on the version of + &os;. + - The port will depend on the FUSE library and handle - the dependency on the kernel module depending on the - version of &os;. - + + <literal>gecko</literal> - - <literal>gecko</literal> + Possible arguments: libxul (default), + firefox, seamonkey, + thunderbird, build, + XY, + XY+ - Possible arguments: libxul (default), - firefox, seamonkey, - thunderbird, build, - XY, - XY+ + Add a dependency on different + gecko based applications. If + libxul is used, it is the only argument + allowed. When the argument is not libxul, + the firefox, seamonkey, or + thunderbird arguments can be used, along with + optional build and + XY/XY+ + version arguments. + - Add a dependency on different - gecko based applications. If - libxul is used, it is the only argument - allowed. When the argument is not - libxul, the firefox, - seamonkey, or - thunderbird arguments can be used, - along with optional build and - XY/XY+ - version - arguments. - + + <literal>gettext</literal> - - <literal>gettext</literal> + Possible arguments: (none) - Possible arguments: (none) + Deprecated. Will include both gettext-runtime + and gettext-tools. + - Deprecated. Will include both gettext-runtime - and gettext-tools. - + + <literal>gettext-runtime</literal> - - <literal>gettext-runtime</literal> + Possible arguments: (none), lib + (default), build, + run - Possible arguments: (none), lib (default), - build, run + Uses devel/gettext-runtime. + By default, with no arguments or with the lib + argument, implies a library dependency on + libintl.so. build and + run implies, respectively a build-time and a + run-time dependency on gettext. + - Uses devel/gettext-runtime. By - default, with no arguments or with the - lib argument, implies a library - dependency on libintl.so. - build and run - implies, respectively a build-time and a run-time - dependency on gettext. - + + <literal>gettext-tools</literal> - - <literal>gettext-tools</literal> + Possible arguments: (none), build + (default), run - Possible arguments: (none), build (default), - run + Uses devel/gettext-tools. By + default, with no argument, or with the build + argument, a build time dependency on msgfmt + is registered. With the run argument, a + run-time dependency is registered. + - Uses devel/gettext-tools. By default, - with no argument, or with the build - argument, a build time dependency on - msgfmt is registered. With the - run argument, a run-time dependency is - registered. - + + <literal>ghostscript</literal> - - <literal>ghostscript</literal> + Possible arguments: X, + build, run, + nox11 - Possible arguments: X, - build, run, - nox11 + A specific version X can be used. + Possible versions are 7, + 8, 9 (default), and + agpl. nox11 indicates + that the -nox11 version of the port is + required. build and run + add build- and run-time dependencies on + Ghostscript. The default is both + build- and run-time dependencies. + - A specific version - X can be - used. Possible versions are 7, - 8, 9 (default), and - agpl. - nox11 indicates that the - -nox11 version of the port is required. - build and run add - build- and run-time dependencies on - Ghostscript. The default is both - build- and run-time dependencies. - + + <literal>gmake</literal> - - <literal>gmake</literal> + Possible arguments: (none), lite - Possible arguments: (none), lite + Uses devel/gmake, or devel/gmake-lite if the + lite argument is used, as a build-time + dependency and sets up the environment to use + gmake as the default make + for the build. + - Uses devel/gmake, or - devel/gmake-lite if the - lite argument is used, as a - build-time dependency and sets up the environment to use - gmake as the default - make for the build. - + + <literal>gperf</literal> - - <literal>gperf</literal> + Possible arguments: (none) - Possible arguments: (none) + Add a buildtime dependency on devel/gperf if gperf + is not present in the base system. + - Add a buildtime dependency on devel/gperf if - gperf is not present in the base - system. - + + <literal>gssapi</literal> - - <literal>gssapi</literal> + Possible arguments: (none), base + (default), heimdal, mit, + flags, bootstrap - Possible arguments: (none), base (default), - heimdal, mit, - flags, - bootstrap + Handle dependencies needed by consumers of the + GSS-API. Only libraries that provide the + Kerberos mechanism are available. By + default, or set to base, the + GSS-API library from the base system is used. + Can also be set to heimdal to use security/heimdal, or + mit to use security/krb5. - Handle dependencies needed by consumers of the - GSS-API. Only libraries that provide - the Kerberos mechanism are - available. By default, or set to - base, the GSS-API - library from the base system is used. Can also be set - to heimdal to use - security/heimdal, or - mit to use - security/krb5. + When the local Kerberos + installation is not in LOCALBASE, set + HEIMDAL_HOME (for heimdal) + or KRB5_HOME (for krb5) to + the location of the Kerberos + installation. - When the local Kerberos - installation is not in LOCALBASE, set - HEIMDAL_HOME (for - heimdal) or - KRB5_HOME (for - krb5) to the location of the - Kerberos installation. + These variables are exported for the ports to use: - These variables are exported for the ports to - use: + + + GSSAPIBASEDIR + - - - GSSAPIBASEDIR - + + GSSAPICPPFLAGS + - - GSSAPICPPFLAGS - + + GSSAPIINCDIR + - - GSSAPIINCDIR - + + GSSAPILDFLAGS + - - GSSAPILDFLAGS - + + GSSAPILIBDIR + - - GSSAPILIBDIR - + + GSSAPILIBS + - - GSSAPILIBS - + + GSSAPI_CONFIGURE_ARGS + + - - GSSAPI_CONFIGURE_ARGS - - + The flags option can be given alongside + base, heimdal, or + mit to automatically add + GSSAPICPPFLAGS, + GSSAPILDFLAGS, and + GSSAPILIBS to CFLAGS, + LDFLAGS, and LDADD, + respectively. For example, use + base,flags. - The flags option can be given - alongside base, - heimdal, or mit to - automatically add GSSAPICPPFLAGS, - GSSAPILDFLAGS, and - GSSAPILIBS to - CFLAGS, LDFLAGS, - and LDADD, respectively. For - example, use base,flags. + The bootstrap option is a special prefix + only for use by security/krb5 and + security/heimdal. For example, + use bootstrap,mit. - The bootstrap option is a special - prefix only for use by - security/krb5 and - security/heimdal. For - example, use bootstrap,mit. + + Typical Use - - Typical Use - - OPTIONS_SINGLE= GSSAPI + OPTIONS_SINGLE= GSSAPI OPTIONS_SINGLE_GSSAPI= GSSAPI_BASE GSSAPI_HEIMDAL GSSAPI_MIT GSSAPI_NONE GSSAPI_BASE_USES= gssapi GSSAPI_BASE_CONFIGURE_ON= --with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_ARGS} GSSAPI_HEIMDAL_USES= gssapi:heimdal GSSAPI_HEIMDAL_CONFIGURE_ON= --with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_ARGS} GSSAPI_MIT_USES= gssapi:mit GSSAPI_MIT_CONFIGURE_ON= --with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_ARGS} GSSAPI_NONE_CONFIGURE_ON= --without-gssapi - - + + - - <literal>horde</literal> + + <literal>horde</literal> - Possible arguments: (none) + Possible arguments: (none) - Add buildtime and runtime dependencies on devel/pear-channel-horde. Other - Horde dependencies can be added - with USE_HORDE_BUILD and - USE_HORDE_RUN. See for more information. - + Add buildtime and runtime dependencies on devel/pear-channel-horde. Other + Horde dependencies can be added + with USE_HORDE_BUILD and + USE_HORDE_RUN. See for more information. + - - <literal>iconv</literal> + + <literal>iconv</literal> - Possible arguments: (none), lib, - build, - patch, translit, - wchar_t + Possible arguments: (none), lib, + build, + patch, translit, + wchar_t - Uses iconv functions, either from - the port - converters/libiconv as a - build-time and run-time dependency, or from the base - system on 10-CURRENT after a native - iconv was committed in - 254273. By default, with no - arguments or with the lib argument, - implies iconv with build-time and - run-time dependencies. build implies a - build-time dependency, and patch - implies a patch-time dependency. If the port uses the - WCHAR_T or - //TRANSLIT iconv extensions, add the - relevant arguments so that the correct iconv is used. For - more information see - . - + Uses iconv functions, either from the + port converters/libiconv as a + build-time and run-time dependency, or from the base system on + 10-CURRENT after a native iconv was committed + in 254273. By default, with no arguments + or with the lib argument, implies + iconv with build-time and run-time + dependencies. build implies a build-time + dependency, and patch implies a patch-time + dependency. If the port uses the WCHAR_T or + //TRANSLIT iconv extensions, add the relevant + arguments so that the correct iconv is used. For more + information see . + - - <literal>imake</literal> + + <literal>imake</literal> - Possible arguments: (none), env, - notall, - noman + Possible arguments: (none), env, + notall, noman - Add devel/imake as a - build-time dependency and run xmkmf -a - during the configure stage. If - the env argument is given, the - configure target is not set. - If the flag is a problem for the port, - add the notall argument. If - xmkmf does not generate a - install.man target, add the - noman argument. - + Add devel/imake as a + build-time dependency and run xmkmf -a during + the configure stage. If the + env argument is given, the + configure target is not set. If the + flag is a problem for the port, add the + notall argument. If xmkmf + does not generate a install.man + target, add the noman argument. + - - <literal>kmod</literal> + + <literal>kmod</literal> - Possible arguments: (none) + Possible arguments: (none) - Fills in the boilerplate for kernel module ports, - currently: + Fills in the boilerplate for kernel module ports, + currently: - - - Add kld to - CATEGORIES. - + + + Add kld to + CATEGORIES. + - - Set SSP_UNSAFE. - + + Set SSP_UNSAFE. + - - Set IGNORE if the kernel - sources are not found in - SRC_BASE. - + + Set IGNORE if the kernel sources are + not found in SRC_BASE. + - - Define KMODDIR to - /boot/modules - by default, add it to PLIST_SUB - and MAKE_ENV, and create it upon - installation. If KMODDIR is set - to /boot/kernel, it will be - rewritten to /boot/modules. This - prevents breaking packages when upgrading the kernel - due to /boot/kernel being - renamed to /boot/kernel.old in - the process. - + + Define KMODDIR to + /boot/modules by default, add it to + PLIST_SUB and + MAKE_ENV, and create it upon + installation. If KMODDIR is set to + /boot/kernel, it will be rewritten to + /boot/modules. This prevents breaking + packages when upgrading the kernel due to + /boot/kernel being renamed to + /boot/kernel.old in the process. + - - Handle cross-referencing kernel modules upon - installation and deinstallation, using @kld. - - - + + Handle cross-referencing kernel modules upon + installation and deinstallation, using @kld. + + + - - <literal>lha</literal> - Possible arguments: (none) - Set EXTRACT_SUFX to - .lzh - + + <literal>lha</literal> - - <literal>libarchive</literal> + Possible arguments: (none) - Possible arguments: (none) + Set EXTRACT_SUFX to + .lzh + - Registers a dependency on archivers/libarchive. Any ports - depending on libarchive must - include USES=libarchive. - + + <literal>libarchive</literal> - - <literal>libedit</literal> + Possible arguments: (none) - Possible arguments: (none) + Registers a dependency on archivers/libarchive. Any ports + depending on libarchive must include + USES=libarchive. + - Registers a dependency on devel/libedit. Any ports - depending on libedit must - include USES=libedit. - + + <literal>libedit</literal> - - <literal>libtool</literal> + Possible arguments: (none) - Possible arguments: (none), keepla, - build + Registers a dependency on devel/libedit. Any ports depending on + libedit must include + USES=libedit. + - Patches libtool scripts. This - must be added to all ports that use - libtool. The keepla - argument can be used to keep .la - files. Some ports do not ship with their own copy of - libtool and need a build time dependency on devel/libtool, use the - :build argument to add such - dependency. - + + <literal>libtool</literal> - - <literal>localbase</literal> + Possible arguments: (none), keepla, + build - Possible arguments: (none) + Patches libtool scripts. This must be + added to all ports that use libtool. The + keepla argument can be used to keep + .la files. Some ports do not ship with + their own copy of libtool and need a build time dependency on + devel/libtool, use the + :build argument to add such + dependency. + - Ensures that libraries from dependencies in - LOCALBASE are used instead of the ones - from the base system. Ports that depend on libraries that - are also present in the base system should use this. It - is also used internally by a few other - USES. - + + <literal>localbase</literal> - - <literal>lua</literal> + Possible arguments: (none) - Possible arguments: (none), - XY+, - XY, - build, - run + Ensures that libraries from dependencies in + LOCALBASE are used instead of the ones from + the base system. Ports that depend on libraries that are also + present in the base system should use this. It is also used + internally by a few other USES. + - Adds a dependency on Lua. - By default this is a library dependency, unless - overridden by the build or - run option. The default version is - 5.2, unless set by the - XY parameter - (for example, 51 or - 52+). - + + <literal>lua</literal> - - <literal>makeinfo</literal> + Possible arguments: (none), + XY+, + XY, + build, run - Possible arguments: build (default), - run, both + Adds a dependency on Lua. By + default this is a library dependency, unless overridden by the + build or run option. The + default version is 5.2, unless set by the + XY parameter (for + example, 51 or + 52+). + - Add the corresponding dependencies on - makeinfo. - + + <literal>makeinfo</literal> - - <literal>makeself</literal> + Possible arguments: build (default), + run, both - Possible arguments: (none) + Add the corresponding dependencies on + makeinfo. + - Indicates that the distribution files are makeself - archives and sets the appropriate dependencies. - + + <literal>makeself</literal> - - <literal>metaport</literal> + Possible arguments: (none) - Possible arguments: (none) + Indicates that the distribution files are makeself archives + and sets the appropriate dependencies. + - Sets the following variables to make it easier to - create a metaport: MASTER_SITES, - DISTFILES, - EXTRACT_ONLY, - NO_BUILD, NO_INSTALL, - NO_MTREE, NO_ARCH. - - + + <literal>metaport</literal> - - <literal>mono</literal> + Possible arguments: (none) - Possible arguments: (none) + Sets the following variables to make it easier to create a + metaport: MASTER_SITES, + DISTFILES, EXTRACT_ONLY, + NO_BUILD, NO_INSTALL, + NO_MTREE, NO_ARCH. + - Adds a dependency on the - Mono (currently only C#) - framework by setting the appropriate dependencies. - + + <literal>mono</literal> - - <literal>motif</literal> + Possible arguments: (none) - Possible arguments: (none) + Adds a dependency on the Mono + (currently only C#) framework by setting the appropriate + dependencies. + - Uses - x11-toolkits/open-motif as - a library dependency. End users can set - WANT_LESSTIF for the dependency to be - on x11-toolkits/lesstif - instead of x11-toolkits/open-motif. - + + <literal>motif</literal> - - <literal>ncurses</literal> + Possible arguments: (none) - Possible arguments: (none), base, - port + Uses x11-toolkits/open-motif + as a library dependency. End users can set + WANT_LESSTIF for the dependency to be on + x11-toolkits/lesstif instead of + x11-toolkits/open-motif. + - Uses ncurses, and causes - some useful variables to be set. - + + <literal>ncurses</literal> - - <literal>ninja</literal> + Possible arguments: (none), base, + port - Possible arguments: (none) + Uses ncurses, and causes some + useful variables to be set. + - Uses ninja to build the - port. End users can set NINJA_VERBOSE - for verbose output. - + + <literal>ninja</literal> - - <literal>objc</literal> + Possible arguments: (none) - Possible arguments: (none) + Uses ninja to build the port. + End users can set NINJA_VERBOSE for verbose + output. + - Add objective C dependencies (compiler, runtime - library) if the base system does not support it. - + + <literal>objc</literal> - - <literal>openal</literal> + Possible arguments: (none) - Possible arguments: al, soft - (default), si, - alut + Add objective C dependencies (compiler, runtime library) if + the base system does not support it. + - Uses OpenAL. The backend - can be specified, with the software implementation as the - default. The user can specify a preferred backend with - WANT_OPENAL. Valid values for - this knob are soft (default) and - si. - + + <literal>openal</literal> - - <literal>pathfix</literal> + Possible arguments: al, + soft (default), si, + alut - Possible arguments: (none) + Uses OpenAL. The backend can be + specified, with the software implementation as the default. The + user can specify a preferred backend with + WANT_OPENAL. Valid values for this knob are + soft (default) and + si. + - Look for Makefile.in and - configure in the port's - associated sources and fix common paths to make sure they - respect the &os; hierarchy. If the port uses - automake, set - PATHFIX_MAKEFILEIN to - Makefile.am if needed. - + + <literal>pathfix</literal> - - <literal>pear</literal> + Possible arguments: (none) - Possible arguments: (none) + Look for Makefile.in and + configure in the port's associated sources + and fix common paths to make sure they respect the &os; + hierarchy. If the port uses automake, set + PATHFIX_MAKEFILEIN to + Makefile.am if needed. + - Adds a dependency on devel/pear. It will setup default - behavior for software using the - PHP Extension and Application - Repository. See for more - information. - + + <literal>pear</literal> - - <literal>perl5</literal> + Possible arguments: (none) - Possible arguments: (none) + Adds a dependency on devel/pear. It will setup default + behavior for software using the PHP + Extension and Application Repository. See for more information. + - Depends on Perl. These - variables can be set: + + <literal>perl5</literal> - - - PERL_VERSION: Full version of - Perl to use, or the - default if not set - + Possible arguments: (none) - - PERL_ARCH: Directory name of - architecture dependent libraries, defaults to - mach - + Depends on Perl. These variables + can be set: - - PERL_PORT: Name of the - Perl port to be - installed, the default is derived from - PERL_VERSION - + + + PERL_VERSION: Full version of + Perl to use, or the default if + not set + - - SITE_PERL: Directory name for - site specific Perl - packages - + + PERL_ARCH: Directory name of + architecture dependent libraries, defaults to + mach + - - USE_PERL5: Phases in which to - use Perl, can be - extract, - patch, build, - install, or - run. It can also be - configure, - modbuild, or - modbuildtiny when - Makefile.PL, - Build.PL, or the - Module::Build::Tiny flavor of - Build.PL is required. It - defaults to build run. - - - + + PERL_PORT: Name of the + Perl port to be installed, the + default is derived from + PERL_VERSION + - - <literal>pgsql</literal> + + SITE_PERL: Directory name for site + specific Perl packages + - Possible arguments: (none), - X.Y, - X.Y+, - X.Y- + + USE_PERL5: Phases in which to use + Perl, can be + extract, patch, + build, install, or + run. It can also be + configure, modbuild, + or modbuildtiny when + Makefile.PL, + Build.PL, or the Module::Build::Tiny + flavor of Build.PL is required. It + defaults to build run. + + + - Provide support for PostgreSQL. Maintainer can - set version required. Minimum and maximum versions can - be specified; for example, 9.0-, 8.4+. + + <literal>pgsql</literal> - Add PostgreSQL component dependency, using - WANT_PGSQL=component[:target]. for example, - WANT_PGSQL=server:configure pltcl - plperl For the full list use - make -V _USE_PGSQL_DEP. - + Possible arguments: (none), + X.Y, + X.Y+, + X.Y- - - <literal>pkgconfig</literal> + Provide support for PostgreSQL. Maintainer can set version + required. Minimum and maximum versions can be specified; for + example, 9.0-, 8.4+. - Possible arguments: (none), build (default), - run, both + Add PostgreSQL component dependency, using + WANT_PGSQL=component[:target]. for example, + WANT_PGSQL=server:configure pltcl plperl For + the full list use make -V + _USE_PGSQL_DEP. + - Uses devel/pkgconf. - With no arguments or with the build - argument, it implies pkg-config as a - build-time dependency. run implies a - run-time dependency and both implies - both run-time and build-time dependencies. - + + <literal>pkgconfig</literal> - - <literal>pure</literal> + Possible arguments: (none), build + (default), run, + both - Possible arguments: (none), ffi + Uses devel/pkgconf. With no + arguments or with the build argument, it + implies pkg-config as a build-time + dependency. run implies a run-time + dependency and both implies both run-time and + build-time dependencies. + - Uses lang/pure. - Largely used for building related - pure ports. With the - ffi argument, it implies - devel/pure-ffi as a - run-time dependency. - + + <literal>pure</literal> - - <literal>python</literal> - Possible arguments: (none), - X.Y, - X.Y+, - -X.Y, - X.Y-Z.A, - build, - run - - Uses Python. A supported - version or version range can be specified. If Python is - only needed at build or run time, it can be set as a build - or run dependency with build or - run. See - for more information. - + Possible arguments: (none), ffi - - <literal>qmail</literal> + Uses lang/pure. Largely used + for building related pure ports. + With the ffi argument, it implies devel/pure-ffi as a run-time + dependency. + - Possible arguments: (none), build, - run, - both, vars + + <literal>python</literal> - Uses mail/qmail. With - the build argument, it implies - qmail as a build-time dependency. - run implies a run-time dependency. - Using no argument or the both argument - implies both run-time and build-time dependencies. - vars will only set QMAIL variables for - the port to use. - + Possible arguments: (none), + X.Y, + X.Y+, + -X.Y, + X.Y-Z.A, + build, run - - <literal>qmake</literal> + Uses Python. A supported version + or version range can be specified. If Python is only needed at + build or run time, it can be set as a build or run dependency + with build or run. See + for more information. + - Possible arguments: (none), norecursive, - outsource + + <literal>qmail</literal> - Uses QMake for - configuring. For more information see - . - + Possible arguments: (none), build, + run, both, + vars - - <literal>readline</literal> + Uses mail/qmail. With the + build argument, it implies + qmail as a build-time dependency. + run implies a run-time dependency. Using no + argument or the both argument implies both + run-time and build-time dependencies. vars + will only set QMAIL variables for the port to use. + - Possible arguments: (none), port + + <literal>qmake</literal> - Uses readline as a library - dependency, and sets CPPFLAGS and - LDFLAGS as necessary. If the - port argument is used or if readline - is not present in the base system, add a dependency on - devel/readline - + Possible arguments: (none), norecursive, + outsource - - <literal>scons</literal> + Uses QMake for configuring. For + more information see . + - Possible arguments: (none) + + <literal>readline</literal> - Provide support for the use of - devel/scons - + Possible arguments: (none), port - - <literal>shared-mime-info</literal> + Uses readline as a library + dependency, and sets CPPFLAGS and + LDFLAGS as necessary. If the + port argument is used or if readline is not + present in the base system, add a dependency on devel/readline + - Possible arguments: (none) + + <literal>scons</literal> - Uses update-mime-database - from misc/shared-mime-info. - This uses will automatically add a post-install step in - such a way that the port itself still can specify there - own post-install step if needed. It also add an @shared-mime-info - para to the plist. - + Possible arguments: (none) - - <literal>shebangfix</literal> + Provide support for the use of devel/scons + - Possible arguments: (none) + + <literal>shared-mime-info</literal> - A lot of software uses incorrect locations for script - interpreters, most notably - /usr/bin/perl and - /bin/bash. This fixes shebang lines - in scripts listed in SHEBANG_FILES. - Currently Bash, - Java, - Ksh, - Perl, - PHP, - Python, - Ruby, - Tcl, and - Tk are supported by default. - To support another interpreter, set - SHEBANG_LANG, - lua_OLD_CMD and - lua_CMD. For example - SHEBANG_LANG=lua, then - lua_OLD_CMD=/usr/bin/lua and - lua_CMD=${LOCALBASE}/bin/lua. - + Possible arguments: (none) - - <literal>tar</literal> + Uses update-mime-database from + misc/shared-mime-info. This uses + will automatically add a post-install step in such a way that + the port itself still can specify there own post-install step if + needed. It also add an @shared-mime-info + para to the plist. + - Possible arguments: (none), Z, bz2, - bzip2, lzma, - tbz, tgz, - txz, xz + + <literal>shebangfix</literal> - Set EXTRACT_SUFX to - .tar, .tar.Z, - .tar.bz2, .tar.bz2, - .tar.lzma, .tbz, - .tgz, .txz or - .tar.xz respectively. - + Possible arguments: (none) - - <literal>tcl</literal> + A lot of software uses incorrect locations for script + interpreters, most notably /usr/bin/perl + and /bin/bash. This fixes shebang lines in + scripts listed in SHEBANG_FILES. Currently + Bash, + Java, Ksh, + Perl, PHP, + Python, + Ruby, Tcl, + and Tk are supported by default. To + support another interpreter, set + SHEBANG_LANG, lua_OLD_CMD + and lua_CMD. For example + SHEBANG_LANG=lua, then + lua_OLD_CMD=/usr/bin/lua and + lua_CMD=${LOCALBASE}/bin/lua. + - Possible arguments: PORT + + <literal>tar</literal> - Add a dependency on Tcl. - The PORT parameter can be either - tcl or tk. Either a - version or wrapper dependency can be appended using - PORT:version or - PORT:wrapper. The version can be - empty, one or more exact version numbers (currently - 84, 85, or - 86), or a minimal version number - (currently 84+, 85+ - or 86+). A build- or run-time only - dependency can be specified using - PORT,build or - PORT,run. After including - bsd.port.pre.mk the port can inspect - the results using these variables: + Possible arguments: (none), Z, + bz2, bzip2, + lzma, tbz, + tgz, txz, + xz - - - TCL_VER: chosen major.minor - version of Tcl - + Set EXTRACT_SUFX to + .tar, .tar.Z, + .tar.bz2, .tar.bz2, + .tar.lzma, .tbz, + .tgz, .txz or + .tar.xz respectively. + - - TCLSH: full path of the - Tcl interpreter - + + <literal>tcl</literal> - - TCL_LIBDIR: path of the - Tcl libraries - + Possible arguments: PORT - - TCL_INCLUDEDIR: path of the - Tcl C header files - + Add a dependency on Tcl. The + PORT parameter can be either + tcl or tk. Either a + version or wrapper dependency can be appended using + PORT:version or + PORT:wrapper. The version can be empty, one + or more exact version numbers (currently 84, + 85, or 86), or a minimal + version number (currently 84+, + 85+ or 86+). A build- or + run-time only dependency can be specified using + PORT,build or PORT,run. + After including bsd.port.pre.mk the port + can inspect the results using these variables: - - TK_VER: chosen major.minor - version of Tk - + + + TCL_VER: chosen major.minor version + of Tcl + - - WISH: full path of the - Tk interpreter - + + TCLSH: full path of the + Tcl interpreter + - - TK_LIBDIR: path of the - Tk libraries - + + TCL_LIBDIR: path of the + Tcl libraries + - - TK_INCLUDEDIR: path of the - Tk C header files - - - + + TCL_INCLUDEDIR: path of the + Tcl C header files + - - <literal>tk</literal> + + TK_VER: chosen major.minor version of + Tk + - Same as arguments for tcl + + WISH: full path of the + Tk interpreter + - Small wrapper when using both - Tcl and - Tk. The same variables are - returned as when using - Tcl. - + + TK_LIBDIR: path of the + Tk libraries + - - <literal>twisted</literal> + + TK_INCLUDEDIR: path of the + Tk C header files + + + - Possible arguments: (none), ARGS + + <literal>tk</literal> - Add a dependency on - twistedCore. The list of - required components can be specified as a value of this - variable. ARGS can be one of: + Same as arguments for tcl - - - build: add - twistedCore or any - specified component as build dependency. - + Small wrapper when using both Tcl + and Tk. The same variables are + returned as when using Tcl. + - - run: add - twistedCore or any - specified component as run dependency. - - + + <literal>twisted</literal> - Besides build and - run, one or more other supported - twisted components can be - specified. Supported values are listed in - Uses/twisted.mk. - + Possible arguments: (none), ARGS - - <literal>uidfix</literal> + Add a dependency on twistedCore. + The list of required components can be specified as a value of + this variable. ARGS can be one of: - Possible arguments: (none) + + + build: add + twistedCore or any specified + component as build dependency. + - Changes some default behavior (mostly variables) of - the build system to allow installing this port as a normal - user. Try this in the port before adding - NEED_ROOT=yes - + + run: add + twistedCore or any specified + component as run dependency. + + - - <literal>uniquefiles</literal> + Besides build and run, + one or more other supported twisted + components can be specified. Supported values are listed in + Uses/twisted.mk. + - Possible arguments: (none), dirs + + <literal>uidfix</literal> - Make files or directories 'unique', by adding a - prefix or suffix. If the dirs argument - is used, the port needs a prefix (a only a prefix) based - on UNIQUE_PREFIX for standard - directories DOCSDIR, - EXAMPLESDIR, - DATADIR, WWWDIR, - ETCDIR. These variables are - available for ports: + Possible arguments: (none) - - - UNIQUE_PREFIX: The prefix to - be used for directories and files. Default: - ${PKGNAMEPREFIX}. - + Changes some default behavior (mostly variables) of + the build system to allow installing this port as a normal + user. Try this in the port before adding + NEED_ROOT=yes + - - UNIQUE_PREFIX_FILES: A list - of files that need to be prefixed. Default: - empty. - + + <literal>uniquefiles</literal> - - UNIQUE_SUFFIX: The suffix to - be used for files. Default: - ${PKGNAMESUFFIX}. - + Possible arguments: (none), dirs - - UNIQUE_SUFFIX_FILES: A list - of files that need to be suffixed. Default: - empty. - - - + Make files or directories 'unique', by adding a prefix or + suffix. If the dirs argument is used, the + port needs a prefix (a only a prefix) based on + UNIQUE_PREFIX for standard directories + DOCSDIR, EXAMPLESDIR, + DATADIR, WWWDIR, + ETCDIR. These variables are available for + ports: - - <literal>webplugin</literal> + + + UNIQUE_PREFIX: The prefix to be used + for directories and files. Default: + ${PKGNAMEPREFIX}. + - Possible arguments: (none), ARGS + + UNIQUE_PREFIX_FILES: A list of files + that need to be prefixed. Default: empty. + - Automatically create and remove symbolic links for - each application that supports the webplugin framework. - ARGS can be one of: + + UNIQUE_SUFFIX: The suffix to be used + for files. Default: + ${PKGNAMESUFFIX}. + - - - gecko: support plug-ins based - on Gecko - + + UNIQUE_SUFFIX_FILES: A list of files + that need to be suffixed. Default: empty. + + + - - native: support plug-ins for - Gecko, Opera, and WebKit-GTK - + + <literal>webplugin</literal> - - linux: support Linux - plug-ins - + Possible arguments: (none), ARGS - - all (default, implicit): - support all plug-in types - + Automatically create and remove symbolic links for each + application that supports the webplugin framework. + ARGS can be one of: - - (individual entries): support only the browsers - listed - - + + + gecko: support plug-ins based on + Gecko + - These variables can be adjusted: + + native: support plug-ins for Gecko, + Opera, and WebKit-GTK + - - - WEBPLUGIN_FILES: No default, - must be set manually. The plug-in files to - install. - + + linux: support Linux plug-ins + - - WEBPLUGIN_DIR: The directory - to install the plug-in files to, default - PREFIX/lib/browser_plugins/WEBPLUGIN_NAME. - Set this if the port installs plug-in files outside - of the default directory to prevent broken symbolic - links. - + + all (default, implicit): support all + plug-in types + - - WEBPLUGIN_NAME: The final - directory to install the plug-in files into, default - PKGBASE. - - - + + (individual entries): support only the browsers + listed + + - - <literal>xfce</literal> + These variables can be adjusted: - Possible arguments: (none), gtk3 + + + WEBPLUGIN_FILES: No default, must be + set manually. The plug-in files to install. + - Provide support for Xfce - related ports. See for - details. + + WEBPLUGIN_DIR: The directory to + install the plug-in files to, default + PREFIX/lib/browser_plugins/WEBPLUGIN_NAME. + Set this if the port installs plug-in files outside of the + default directory to prevent broken symbolic links. + - The gtk3 argument specifies that - the port requires GTK3 - features provided by x11/libxfce4menu. - + + WEBPLUGIN_NAME: The final directory + to install the plug-in files into, default + PKGBASE. + + + - - <literal>zip</literal> + + <literal>xfce</literal> - Possible arguments: (none), infozip + Possible arguments: (none), gtk3 - Indicates that the distribution files use the ZIP - compression algorithm. For files using the InfoZip - algorithm the infozip argument must be - passed to set the appropriate dependencies. - + Provide support for Xfce related + ports. See for details. - - <literal>zope</literal> + The gtk3 argument specifies that the port + requires GTK3 features provided by + x11/libxfce4menu. + - Possible arguments: (none) + + <literal>zip</literal> - Uses www/zope. Mostly - used for building zope related - ports. ZOPE_VERSION can be used by a - port to indicate that a specific version of - zope shall be used. - + Possible arguments: (none), + infozip + + Indicates that the distribution files use the ZIP + compression algorithm. For files using the InfoZip algorithm + the infozip argument must be passed to set + the appropriate dependencies. + + + + <literal>zope</literal> + + Possible arguments: (none) + + Uses www/zope. Mostly used + for building zope related ports. + ZOPE_VERSION can be used by a port to + indicate that a specific version of + zope shall be used. +