From owner-svn-doc-all@freebsd.org Thu Jul 23 15:05:29 2015 Return-Path: Delivered-To: svn-doc-all@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 3E1A39A9BB4; Thu, 23 Jul 2015 15:05:29 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 2D07A1993; Thu, 23 Jul 2015 15:05:29 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.70]) by repo.freebsd.org (8.14.9/8.14.9) with ESMTP id t6NF5T4L004832; Thu, 23 Jul 2015 15:05:29 GMT (envelope-from mat@FreeBSD.org) Received: (from mat@localhost) by repo.freebsd.org (8.14.9/8.14.9/Submit) id t6NF5TPq004831; Thu, 23 Jul 2015 15:05:29 GMT (envelope-from mat@FreeBSD.org) Message-Id: <201507231505.t6NF5TPq004831@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org using -f From: Mathieu Arnold Date: Thu, 23 Jul 2015 15:05:29 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r47058 - head/en_US.ISO8859-1/books/porters-handbook/uses X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 23 Jul 2015 15:05:29 -0000 Author: mat Date: Thu Jul 23 15:05:28 2015 New Revision: 47058 URL: https://svnweb.freebsd.org/changeset/doc/47058 Log: Reindent/rewrap the USES chapter. Translators can ignore. Approved by: wblock (mentor, implicit) Sponsored by: Absolight Modified: head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml Thu Jul 23 15:05:19 2015 (r47057) +++ head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml Thu Jul 23 15:05:28 2015 (r47058) @@ -69,617 +69,581 @@ - - <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. - - - - <literal>autoreconf</literal> - - 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. - - - - <literal>blaslapack</literal> - - Possible arguments: (none), atlas, - netlib (default), - gotoblas, - openblas - - Adds dependencies on Blas / Lapack libraries. - - - - <literal>bison</literal> - - 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. - - - - <literal>charsetfix</literal> - - 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. - - - - <literal>cmake</literal> - - 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 - . - - - - <literal>compiler</literal> - - 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: - - - - 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. - - - - 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. - - - - 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. - - - - - - <literal>cpe</literal> - - 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: - - - - 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. - - - - 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 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 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. - - - - 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> - - Possible arguments: (none), auto-plist - - Uses the Comprehensive R Archive Network. Specify - auto-plist to automatically generate - pkg-plist. - - - - <literal>desktop-file-utils</literal> - - 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. - - - - <literal>desthack</literal> - - Possible arguments: (none) - - Changes the behavior of GNU configure to properly - support DESTDIR in case the original - software does not. - - - - <literal>display</literal> - - 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. - - - - <literal>dos2unix</literal> - - 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. - - - - DOS2UNIX_REGEX: match file - names based on a regular expression. - - - - DOS2UNIX_FILES: match literal - file names. - - - - DOS2UNIX_GLOB: match file - names based on a glob pattern. - - - - - - <literal>drupal</literal> - - 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. - - - - <literal>execinfo</literal> - - Possible arguments: (none) - - Add a library dependency on devel/libexecinfo if - libexecinfo.so is not present in the - base system. - - - - <literal>fakeroot</literal> - - Possible arguments: (none) - - Changes some default behaviour of build systems to - allow installing as a user. See for - more information on fakeroot. - - - - <literal>fam</literal> - - 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. - - - - <literal>fmake</literal> - - Possible arguments: (none) - - Uses devel/fmake as a - build-time dependency. - - - - <literal>fonts</literal> - - 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}. - - - - <literal>fortran</literal> - - Possible arguments: gcc (default), - ifort - - Uses the Fortran compiler from either GNU or - Intel. - - - - <literal>fuse</literal> - - 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;. - - - - <literal>gecko</literal> - - 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. - - - - <literal>gettext</literal> - - Possible arguments: (none) - - Deprecated. Will include both gettext-runtime - and gettext-tools. - - - - <literal>gettext-runtime</literal> - - 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. - - - - <literal>gettext-tools</literal> - - 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. - - - - <literal>ghostscript</literal> - - 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. - - - - <literal>gmake</literal> - - 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. - - - - <literal>gperf</literal> - - Possible arguments: (none) - - Add a buildtime dependency on devel/gperf if - gperf is not present in the base - system. - - - - <literal>gssapi</literal> - - 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. - - 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: - - - - GSSAPIBASEDIR - - - - GSSAPICPPFLAGS - - - - GSSAPIINCDIR - - - - GSSAPILDFLAGS - - - - GSSAPILIBDIR - - - - GSSAPILIBS - - - - 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 bootstrap option is a special - prefix only for use by - security/krb5 and - security/heimdal. For - example, use bootstrap,mit. + 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> + + 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. + + + + <literal>blaslapack</literal> + + Possible arguments: (none), atlas, + netlib (default), + gotoblas, openblas + + Adds dependencies on Blas / Lapack libraries. + + + + <literal>bison</literal> + + 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. + + + + <literal>charsetfix</literal> + + 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. + + + + <literal>cmake</literal> + + 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 . + + + + <literal>compiler</literal> + + 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: + + + + 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. + + + + 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. + + + + 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. + + + + + + <literal>cpe</literal> + + 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: + + + + 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. + + + + 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 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 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. + + + + 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> + + Possible arguments: (none), + auto-plist + + Uses the Comprehensive R Archive Network. Specify + auto-plist to automatically generate + pkg-plist. + + + + <literal>desktop-file-utils</literal> + + 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. + + + + <literal>desthack</literal> + + Possible arguments: (none) + + Changes the behavior of GNU configure to properly support + DESTDIR in case the original software does + not. + + + + <literal>display</literal> + + 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. + + + + <literal>dos2unix</literal> + + 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. + + + + DOS2UNIX_REGEX: match file names + based on a regular expression. + + + + DOS2UNIX_FILES: match literal file + names. + + + + DOS2UNIX_GLOB: match file names based + on a glob pattern. + + + + + + <literal>drupal</literal> + + 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. + + + + <literal>execinfo</literal> + + Possible arguments: (none) + + Add a library dependency on devel/libexecinfo if + libexecinfo.so is not present in the base + system. + + + + <literal>fakeroot</literal> + + Possible arguments: (none) + + Changes some default behaviour of build systems to allow + installing as a user. See for more + information on fakeroot. + + + + <literal>fam</literal> + + 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. + + + + <literal>fmake</literal> + + Possible arguments: (none) + + Uses devel/fmake as a + build-time dependency. + - - Typical Use + + <literal>fonts</literal> - OPTIONS_SINGLE= GSSAPI + 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}. + + + + <literal>fortran</literal> + + Possible arguments: gcc (default), + ifort + *** DIFF OUTPUT TRUNCATED AT 1000 LINES ***