diff --git a/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml b/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml index d5d713fe60..3ea5df2207 100644 --- a/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml +++ b/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml @@ -14,57 +14,82 @@ format is easy to grasp from the already-added entries below (or use this scheme below as a skeleton): - - FEATURE + + <literal>FEATURE</literal> - ARGUMENTS + Possible arguments: ARGUMENTS - DESCRIPTION - + DESCRIPTION + --> - Values of - <varname>USES</varname> + Using <varname>USES</varname> + Macros - - Values of <varname>USES</varname> + + An Introduction to <varname>USES</varname> - - - - Feature + 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.. - Arguments + 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 (,). - Description - - + + Using Multiple Values - - - ada + USES= bison perl + - (none), 47, 49, - 5 + + Adding an Argument - Depends on an Ada-capable + 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> + + 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. - + gcc 5 based one. + - - autoreconf + + <literal>autoreconf</literal> - (none), build + Possible arguments: (none), build - Runs autoreconf. It encapsulates + Runs autoreconf. It encapsulates the aclocal, autoconf, autoheader, @@ -80,75 +105,75 @@ autoreconf will recursively update those as well. The :build argument only adds build time dependencies on those tools but does - not run autoreconf. - + not run autoreconf. + - - blaslapack + + <literal>blaslapack</literal> - (none), atlas, + Possible arguments: (none), atlas, netlib (default), gotoblas, - openblas + openblas - Adds dependencies on Blas / Lapack libraries. - + Adds dependencies on Blas / Lapack libraries. + - - bison + + <literal>bison</literal> - (none), build, - run, both + Possible arguments: (none), build, + run, both - Uses devel/bison + 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. - + build-time dependencies. + - - charsetfix + + <literal>charsetfix</literal> - (none) + Possible arguments: (none) - Prevents the port from installing + 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. - + ${WRKSRC}/Makefile.in. + - - cmake + + <literal>cmake</literal> - (none), outsource, - run + Possible arguments: (none), outsource, + run - Uses CMake for configuring + 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 - . - + . + - - compiler + + <literal>compiler</literal> - (none), c++0x, + Possible arguments: (none), c++0x, c++11-lang, gcc-c++11-lib, c++11-lib, c11, openmp, nestedfct, - features + features - Determines which compiler to use based on any given + 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 @@ -198,15 +223,15 @@ features supported by the default compiler. It currently lists the C++ library. - - + + - - cpe + + <literal>cpe</literal> - (none) + Possible arguments: (none) - + Include Common Platform Enumeration (CPE) information in package manifest as a CPE 2.3 formatted string. See the @@ -218,7 +243,7 @@ - Search for the official CPE entry for the + Search for the official CPE para for the software product either by using the NVD's CPE search engine or in the Add cpe to USES and compare the result of make -V CPE_STR to the - CPE dictionary entry. Continue + CPE dictionary para. Continue one step at a time until make -V CPE_STR is correct. @@ -288,50 +313,50 @@ CPE_STR. - - + + - - cran + + <literal>cran</literal> - (none), auto-plist + Possible arguments: (none), auto-plist - Uses the Comprehensive R Archive Network. Specify + Uses the Comprehensive R Archive Network. Specify auto-plist to automatically generate - pkg-plist. - + pkg-plist. + - - desktop-file-utils + + <literal>desktop-file-utils</literal> - (none) + Possible arguments: (none) - Uses + 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. - + will be added to the plist. + - - desthack + + <literal>desthack</literal> - (none) + Possible arguments: (none) - Changes the behavior of GNU configure to properly + Changes the behavior of GNU configure to properly support DESTDIR in case the original - software does not. - + software does not. + - - display + + <literal>display</literal> - (none), ARGS + Possible arguments: (none), ARGS - Set up a virtual display environment. If the + 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 @@ -339,15 +364,15 @@ instance of Xvfb. The ARGS parameter defaults to install and controls the phase around - which to start and stop the virtual display. - + which to start and stop the virtual display. + - - dos2unix + + <literal>dos2unix</literal> - (none) + Possible arguments: (none) - The port has files with line endings in + 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 @@ -370,114 +395,114 @@ DOS2UNIX_GLOB: match file names based on a glob pattern. - - + + - - drupal + + <literal>drupal</literal> - 6, 7, + Possible arguments: 6, 7, module, - theme + theme - Automate installation of a port that is a + 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. - + USES=drupal:7,theme. + - - execinfo + + <literal>execinfo</literal> - (none) + Possible arguments: (none) - Add a library dependency on Add a library dependency on devel/libexecinfo if libexecinfo.so is not present in the - base system. - + base system. + - - fakeroot + + <literal>fakeroot</literal> - (none) + Possible arguments: (none) - Changes some default behaviour of build systems to + Changes some default behaviour of build systems to allow installing as a user. See for - more information on fakeroot. - + more information on fakeroot. + - - fam + + <literal>fam</literal> - (none), fam, gamin + Possible arguments: (none), fam, gamin - Uses a File Alteration Monitor as a library + 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. - + set WITH_FAM_SYSTEM to specify their preference. + - - fmake + + <literal>fmake</literal> - (none) + Possible arguments: (none) - Uses devel/fmake as a - build-time dependency. - + Uses devel/fmake as a + build-time dependency. + - - fonts + + <literal>fonts</literal> - (none) + Possible arguments: (none) - Adds a runtime dependency on tools needed to register + Adds a runtime dependency on tools needed to register fonts, and add an @fcfontsdir - ${FONTSDIR} entry to the plist. + ${FONTSDIR} para to the plist. FONTSDIR defaults to ${PREFIX}/lib/X11/fonts/${FONTNAME} and FONTNAME to - ${PORTNAME}. - + ${PORTNAME}. + - - fortran + + <literal>fortran</literal> - 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. + - - fuse + + <literal>fuse</literal> - (none) + Possible arguments: (none) - The port will depend on the FUSE library and handle + The port will depend on the FUSE library and handle the dependency on the kernel module depending on the - version of &os;. - + version of &os;. + - - gecko + + <literal>gecko</literal> - libxul (default), + Possible arguments: libxul (default), firefox, seamonkey, thunderbird, build, XY, - XY+ + XY+ - Add a dependency on different + Add a dependency on different gecko based applications. If libxul is used, it is the only argument allowed. When the argument is not @@ -487,59 +512,59 @@ along with optional build and XY/XY+ version - arguments. - + arguments. + - - gettext + + <literal>gettext</literal> - (none) + Possible arguments: (none) - Deprecated. Will include both Deprecated. Will include both gettext-runtime and gettext-tools. - + linkend="uses-gettext-tools">gettext-tools. + - - gettext-runtime + + <literal>gettext-runtime</literal> - (none), lib (default), - build, run + Possible arguments: (none), lib (default), + build, run - Uses 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. - + dependency on gettext. + - - gettext-tools + + <literal>gettext-tools</literal> - (none), build (default), - run + Possible arguments: (none), build (default), + run - Uses 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. - + registered. + - - ghostscript + + <literal>ghostscript</literal> - X, + Possible arguments: X, build, run, - nox11 + nox11 - A specific version + A specific version X can be used. Possible versions are 7, 8, 9 (default), and @@ -549,42 +574,41 @@ build and run add build- and run-time dependencies on Ghostscript. The default is both - build- and run-time dependencies. - + build- and run-time dependencies. + - - gmake + + <literal>gmake</literal> - (none), lite + Possible arguments: (none), lite - Uses devel/gmake, or + 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. - + make for the build. + - - gperf + + <literal>gperf</literal> - (none) + Possible arguments: (none) - Add a buildtime dependency on Add a buildtime dependency on devel/gperf if gperf is not present in the base - system. - + system. + - - gssapi + + <literal>gssapi</literal> - (none), base (default), + Possible arguments: (none), base (default), heimdal, mit, flags, - bootstrap + bootstrap - Handle dependencies needed by consumers of the GSS-API. Only libraries that provide the Kerberos mechanism are @@ -666,31 +690,31 @@ GSSAPI_HEIMDAL_CONFIGURE_ON= --with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_A GSSAPI_MIT_USES= gssapi:mit GSSAPI_MIT_CONFIGURE_ON= --with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_ARGS} GSSAPI_NONE_CONFIGURE_ON= --without-gssapi - - + + - - horde + + <literal>horde</literal> - (none) + Possible arguments: (none) - Add buildtime and runtime dependencies on 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. - + linkend="php-horde"/> for more information. + - - iconv + + <literal>iconv</literal> - (none), lib, + Possible arguments: (none), lib, build, patch, translit, - wchar_t + wchar_t - Uses iconv functions, either from + Uses iconv functions, either from the port converters/libiconv as a build-time and run-time dependency, or from the base @@ -706,17 +730,17 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi //TRANSLIT iconv extensions, add the relevant arguments so that the correct iconv is used. For more information see - . - + . + - - imake + + <literal>imake</literal> - (none), env, + Possible arguments: (none), env, notall, - noman + noman - Add devel/imake as a + Add devel/imake as a build-time dependency and run xmkmf -a during the configure stage. If the env argument is given, the @@ -725,16 +749,16 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi add the notall argument. If xmkmf does not generate a install.man target, add the - noman argument. - + noman argument. + - - kmod + + <literal>kmod</literal> - (none) + Possible arguments: (none) - Fills in the boilerplate for kernel module ports, - currently: + Fills in the boilerplate for kernel module ports, + currently: @@ -771,45 +795,45 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi installation and deinstallation, using @kld. - - + + - - lha - (none) - Set EXTRACT_SUFX to - .lzh - + + <literal>lha</literal> + Possible arguments: (none) + Set EXTRACT_SUFX to + .lzh + - - libarchive + + <literal>libarchive</literal> - (none) + Possible arguments: (none) - Registers a dependency on Registers a dependency on archivers/libarchive. Any ports depending on libarchive must - include USES=libarchive. - + include USES=libarchive. + - - libedit + + <literal>libedit</literal> - (none) + Possible arguments: (none) - Registers a dependency on Registers a dependency on devel/libedit. Any ports depending on libedit must - include USES=libedit. - + include USES=libedit. + - - libtool + + <literal>libtool</literal> - (none), keepla, - build + Possible arguments: (none), keepla, + build - Patches libtool scripts. This + Patches libtool scripts. This must be added to all ports that use libtool. The keepla argument can be used to keep .la @@ -817,175 +841,175 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi libtool and need a build time dependency on devel/libtool, use the :build argument to add such - dependency. - + dependency. + - - localbase + + <literal>localbase</literal> - (none) + Possible arguments: (none) - Ensures that libraries from dependencies in + 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. - + USES. + - - lua + + <literal>lua</literal> - (none), + Possible arguments: (none), XY+, XY, build, - run + run - Adds a dependency on Lua. + 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+). - + 52+). + - - makeinfo + + <literal>makeinfo</literal> - build (default), - run, both + Possible arguments: build (default), + run, both - Add the corresponding dependencies on - makeinfo. - + Add the corresponding dependencies on + makeinfo. + - - makeself + + <literal>makeself</literal> - (none) + Possible arguments: (none) - Indicates that the distribution files are makeself - archives and sets the appropriate dependencies. - + Indicates that the distribution files are makeself + archives and sets the appropriate dependencies. + - - metaport + + <literal>metaport</literal> - (none) + Possible arguments: (none) - Sets the following variables to make it easier to + 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. - - + + - - mono + + <literal>mono</literal> - (none) + Possible arguments: (none) - Adds a dependency on the + Adds a dependency on the Mono (currently only C#) - framework by setting the appropriate dependencies. - + framework by setting the appropriate dependencies. + - - motif + + <literal>motif</literal> - (none) + Possible arguments: (none) - Uses + 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. - + role="port">x11-toolkits/open-motif. + - - ncurses + + <literal>ncurses</literal> - (none), base, - port + Possible arguments: (none), base, + port - Uses ncurses, and causes - some useful variables to be set. - + Uses ncurses, and causes + some useful variables to be set. + - - ninja + + <literal>ninja</literal> - (none) + Possible arguments: (none) - Uses ninja to build the + Uses ninja to build the port. End users can set NINJA_VERBOSE - for verbose output. - + for verbose output. + - - objc + + <literal>objc</literal> - (none) + Possible arguments: (none) - Add objective C dependencies (compiler, runtime - library) if the base system does not support it. - + Add objective C dependencies (compiler, runtime + library) if the base system does not support it. + - - openal + + <literal>openal</literal> - al, soft + Possible arguments: al, soft (default), si, - alut + alut - Uses OpenAL. The backend + 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. - + si. + - - pathfix + + <literal>pathfix</literal> - (none) + Possible arguments: (none) - Look for Makefile.in and + 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. - + Makefile.am if needed. + - - pear + + <literal>pear</literal> - (none) + Possible arguments: (none) - Adds a dependency on Adds a dependency on devel/pear. It will setup default behavior for software using the PHP Extension and Application Repository. See for more - information. - + information. + - - perl5 + + <literal>perl5</literal> - (none) + Possible arguments: (none) - Depends on Perl. These + Depends on Perl. These variables can be set: @@ -1030,18 +1054,17 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi Build.PL is required. It defaults to build run. - - + + - - pgsql + + <literal>pgsql</literal> - (none), + Possible arguments: (none), X.Y, X.Y+, - X.Y- + X.Y- - Provide support for PostgreSQL. Maintainer can set version required. Minimum and maximum versions can be specified; for example, 9.0-, 8.4+. @@ -1051,124 +1074,123 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi WANT_PGSQL=server:configure pltcl plperl For the full list use make -V _USE_PGSQL_DEP. - - + - - pkgconfig + + <literal>pkgconfig</literal> - (none), build (default), - run, both + Possible arguments: (none), build (default), + run, both - Uses devel/pkgconf. + 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. - + both run-time and build-time dependencies. + - - pure + + <literal>pure</literal> - (none), ffi + Possible arguments: (none), ffi - Uses lang/pure. + Uses lang/pure. Largely used for building related pure ports. With the ffi argument, it implies devel/pure-ffi as a - run-time dependency. - + run-time dependency. + - - python - (none), + + <literal>python</literal> + Possible arguments: (none), X.Y, X.Y+, -X.Y, X.Y-Z.A, build, run - - Uses Python. A supported + + 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. - + for more information. + - - qmail + + <literal>qmail</literal> - (none), build, + Possible arguments: (none), build, run, - both, vars + both, vars - Uses mail/qmail. With + 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. - + the port to use. + - - qmake + + <literal>qmake</literal> - (none), norecursive, - outsource + Possible arguments: (none), norecursive, + outsource - Uses QMake for + Uses QMake for configuring. For more information see - . - + . + - - readline + + <literal>readline</literal> - (none), port + Possible arguments: (none), port - Uses readline as a library + 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 - + devel/readline + - - scons + + <literal>scons</literal> - (none) + Possible arguments: (none) - Provide support for the use of - devel/scons - + Provide support for the use of + devel/scons + - - shared-mime-info + + <literal>shared-mime-info</literal> - (none) + Possible arguments: (none) - Uses update-mime-database + 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 - entry to the plist. - + para to the plist. + - - shebangfix + + <literal>shebangfix</literal> - (none) + Possible arguments: (none) - A lot of software uses incorrect locations for script + A lot of software uses incorrect locations for script interpreters, most notably /usr/bin/perl and /bin/bash. This fixes shebang lines @@ -1188,31 +1210,31 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi lua_CMD. For example SHEBANG_LANG=lua, then lua_OLD_CMD=/usr/bin/lua and - lua_CMD=${LOCALBASE}/bin/lua. - + lua_CMD=${LOCALBASE}/bin/lua. + - - tar + + <literal>tar</literal> - (none), Z, bz2, + Possible arguments: (none), Z, bz2, bzip2, lzma, tbz, tgz, - txz, xz + txz, xz - Set EXTRACT_SUFX to + Set EXTRACT_SUFX to .tar, .tar.Z, .tar.bz2, .tar.bz2, .tar.lzma, .tbz, .tgz, .txz or - .tar.xz respectively. - + .tar.xz respectively. + - - tcl + + <literal>tcl</literal> - PORT + Possible arguments: PORT - Add a dependency on Tcl. + Add a dependency on Tcl. The PORT parameter can be either tcl or tk. Either a version or wrapper dependency can be appended using @@ -1269,27 +1291,27 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi TK_INCLUDEDIR: path of the Tk C header files - - + + - - tk + + <literal>tk</literal> - Same as arguments for tcl + Same as arguments for tcl - Small wrapper when using both + Small wrapper when using both Tcl and Tk. The same variables are returned as when using - Tcl. - + Tcl. + - - twisted + + <literal>twisted</literal> - (none), ARGS + Possible arguments: (none), ARGS - Add a dependency on + Add a dependency on twistedCore. The list of required components can be specified as a value of this variable. ARGS can be one of: @@ -1312,26 +1334,26 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi run, one or more other supported twisted components can be specified. Supported values are listed in - Uses/twisted.mk. - + Uses/twisted.mk. + - - uidfix + + <literal>uidfix</literal> - (none) + Possible arguments: (none) - Changes some default behavior (mostly variables) of + 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 - + NEED_ROOT=yes + - - uniquefiles + + <literal>uniquefiles</literal> - (none), dirs + Possible arguments: (none), dirs - Make files or directories 'unique', by adding a + 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 @@ -1365,15 +1387,15 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi of files that need to be suffixed. Default: empty. - - + + - - webplugin + + <literal>webplugin</literal> - (none), ARGS + Possible arguments: (none), ARGS - Automatically create and remove symbolic links for + Automatically create and remove symbolic links for each application that supports the webplugin framework. ARGS can be one of: @@ -1427,15 +1449,14 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi directory to install the plug-in files into, default PKGBASE. - - + + - - xfce + + <literal>xfce</literal> - (none), gtk3 + Possible arguments: (none), gtk3 - Provide support for Xfce related ports. See for details. @@ -1444,32 +1465,28 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi the port requires GTK3 features provided by x11/libxfce4menu. - - + - - zip + + <literal>zip</literal> - (none), infozip + Possible arguments: (none), infozip - Indicates that the distribution files use the ZIP + 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. - + passed to set the appropriate dependencies. + - - zope + + <literal>zope</literal> - (none) + Possible arguments: (none) - Uses www/zope. Mostly + 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. - - - -
+ zope shall be used. +