Date: Mon, 19 Apr 2021 15:23:24 GMT From: Mateusz Piotrowski <0mp@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: c8171ff858 - main - Handbook: Move Ports Collection installation to a new section Message-ID: <202104191523.13JFNOBS091170@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch main has been updated by 0mp: URL: https://cgit.FreeBSD.org/doc/commit/?id=c8171ff8588d3eaa5b8ff105c9ada23fea8d3c12 commit c8171ff8588d3eaa5b8ff105c9ada23fea8d3c12 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2021-04-19 15:08:03 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2021-04-19 15:23:30 +0000 Handbook: Move Ports Collection installation to a new section This way we can cross-reference it from other places in the documentation. --- .../content/en/books/handbook/ports/_index.adoc | 26 ++++++++++++---------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/documentation/content/en/books/handbook/ports/_index.adoc b/documentation/content/en/books/handbook/ports/_index.adoc index c880d1e3b5..68d2d09676 100644 --- a/documentation/content/en/books/handbook/ports/_index.adoc +++ b/documentation/content/en/books/handbook/ports/_index.adoc @@ -579,6 +579,20 @@ pkg, by default, tracks quarterly branch-releases of the ports tree and not HEAD If the Ports Collection and pkg must be used in conjunction, then be sure that your Ports Collection and pkg are on the same branch release of the ports tree. ==== +The Ports Collection contains directories for software categories. Inside each category are subdirectories for individual applications. Each application subdirectory contains a set of files that tells FreeBSD how to compile and install that program, called a _ports skeleton_. Each port skeleton includes these files and directories: + +* [.filename]#Makefile#: contains statements that specify how the application should be compiled and where its components should be installed. +* [.filename]#distinfo#: contains the names and checksums of the files that must be downloaded to build the port. +* [.filename]#files/#: this directory contains any patches needed for the program to compile and install on FreeBSD. This directory may also contain other files used to build the port. +* [.filename]#pkg-descr#: provides a more detailed description of the program. +* [.filename]#pkg-plist#: a list of all the files that will be installed by the port. It also tells the ports system which files to remove upon deinstallation. + +Some ports include [.filename]#pkg-message# or other files to handle special situations. For more details on these files, and on ports in general, refer to the link:{porters-handbook}[FreeBSD Porter's Handbook]. + +The port does not include the actual source code, also known as a [.filename]#distfile#. The extract portion of building a port will automatically save the downloaded source to [.filename]#/usr/ports/distfiles#. + +=== Installing the Ports Collection + Before an application can be compiled using a port, the Ports Collection must first be installed. If it was not installed during the installation of FreeBSD, use one of the following methods to install it: [[ports-using-portsnap-method]] @@ -669,18 +683,6 @@ If the ports tree is not available, or pkg is being used to manage packages, Git .... **** -The Ports Collection contains directories for software categories. Inside each category are subdirectories for individual applications. Each application subdirectory contains a set of files that tells FreeBSD how to compile and install that program, called a _ports skeleton_. Each port skeleton includes these files and directories: - -* [.filename]#Makefile#: contains statements that specify how the application should be compiled and where its components should be installed. -* [.filename]#distinfo#: contains the names and checksums of the files that must be downloaded to build the port. -* [.filename]#files/#: this directory contains any patches needed for the program to compile and install on FreeBSD. This directory may also contain other files used to build the port. -* [.filename]#pkg-descr#: provides a more detailed description of the program. -* [.filename]#pkg-plist#: a list of all the files that will be installed by the port. It also tells the ports system which files to remove upon deinstallation. - -Some ports include [.filename]#pkg-message# or other files to handle special situations. For more details on these files, and on ports in general, refer to the link:{porters-handbook}[FreeBSD Porter's Handbook]. - -The port does not include the actual source code, also known as a [.filename]#distfile#. The extract portion of building a port will automatically save the downloaded source to [.filename]#/usr/ports/distfiles#. - === Installing Ports This section provides basic instructions on using the Ports Collection to install or remove software. The detailed description of available `make` targets and environment variables is available in man:ports[7].
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202104191523.13JFNOBS091170>