From owner-svn-src-head@freebsd.org Thu Aug 16 13:29:24 2018 Return-Path: Delivered-To: svn-src-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id EDA9D105BB0F; Thu, 16 Aug 2018 13:29:23 +0000 (UTC) (envelope-from 0mp@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id A35C182558; Thu, 16 Aug 2018 13:29:23 +0000 (UTC) (envelope-from 0mp@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 849DE19FD8; Thu, 16 Aug 2018 13:29:23 +0000 (UTC) (envelope-from 0mp@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7GDTNNE082753; Thu, 16 Aug 2018 13:29:23 GMT (envelope-from 0mp@FreeBSD.org) Received: (from 0mp@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7GDTNhh082752; Thu, 16 Aug 2018 13:29:23 GMT (envelope-from 0mp@FreeBSD.org) Message-Id: <201808161329.w7GDTNhh082752@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: 0mp set sender to 0mp@FreeBSD.org using -f From: Mateusz Piotrowski <0mp@FreeBSD.org> Date: Thu, 16 Aug 2018 13:29:23 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r337905 - head/share/man/man7 X-SVN-Group: head X-SVN-Commit-Author: 0mp X-SVN-Commit-Paths: head/share/man/man7 X-SVN-Commit-Revision: 337905 X-SVN-Commit-Repository: base MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-src-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the src tree for head/-current List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Aug 2018 13:29:24 -0000 Author: 0mp (ports committer) Date: Thu Aug 16 13:29:23 2018 New Revision: 337905 URL: https://svnweb.freebsd.org/changeset/base/337905 Log: Tidy up the ports.7 manual page. - Use "Dq Li" for inline commands as we do in other manuals. - Pet "igor" and "mandoc -Tlint". - Reword some parts for clarity. - Add missing Xr macros. - Reformat SEE ALSO to make the section more readable. Reviewed by: eadler, krion, mat Approved by: krion (mentor), mat (mentor) Differential Revision: https://reviews.freebsd.org/D15350 Modified: head/share/man/man7/ports.7 Modified: head/share/man/man7/ports.7 ============================================================================== --- head/share/man/man7/ports.7 Thu Aug 16 13:18:40 2018 (r337904) +++ head/share/man/man7/ports.7 Thu Aug 16 13:29:23 2018 (r337905) @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 11, 2018 +.Dd August 16, 2018 .Dt PORTS 7 .Os .Sh NAME @@ -48,9 +48,8 @@ individual ports. Each port is a directory with metadata and patches necessary to make the original application source code compile and run on .Fx . -Compiling an -application is as simple as typing -.Nm make Cm build +Compiling an application is as simple as typing +.Dq Li "make build" in the port directory. The .Pa Makefile @@ -60,18 +59,24 @@ applies the patches, and compiles it. It also recursively handles dependencies \(em other pieces of software the port depends on in order to build and work. Afterwards, -.Nm make Cm install +.Dq Li "make install" installs the application. .Pp For more information about using ports, see the .Dq "Packages and Ports" section in -.%B "The FreeBSD Handbook": +.Sm off +.%B "The FreeBSD Handbook" +.No \&: +.Sm on .Pp .Lk https://www.FreeBSD.org/doc/en/books/handbook/ports.html .Pp For information about creating new ports, see -.%B "The Porter's Handbook": +.Sm off +.%B "The Porter's Handbook" +.No \&: +.Sm on .Pp .Lk https://www.FreeBSD.org/doc/en/books/porters-handbook/ .Sh TARGETS @@ -80,7 +85,7 @@ Some of the targets work recursively through subdirectories. This lets you, for example, install all of the .Dq Li biology -ports. +ports with one command. The targets that do this are .Cm build , checksum , clean , configure , .Cm depends , extract , fetch , install , @@ -91,9 +96,7 @@ The following targets will be run automatically by eac target in order. That is, .Cm build -will be run -(if necessary) -by +will be run (if necessary) by .Cm install , and so on all the way to .Cm fetch . @@ -446,7 +449,7 @@ Command to get .Cm fetchindex target). Defaults to -.Dq Nm fetch Fl am . +.Dq Li "fetch -am" . .It Va NOCLEANDEPENDS If defined, do not let .Cm clean @@ -459,7 +462,7 @@ Normally If set, overwrite any existing package registration on the system. .It Va MOTIFLIB Location of -.Pa libXm. Ns Brq Pa a , Ns Pa so . +.Pa "libXm\&." Ns Brq Pa a , Ns Pa so . .It Va INTERACTIVE If defined, only operate on a port if it requires interaction. .It Va BATCH @@ -528,12 +531,14 @@ If set, enables the use of .Xr ccache 1 for building ports. .It Va CCACHE_DIR -Which directory to use for the ccache data. +Which directory to use for the +.Xr ccache 1 +data. .El .Sh FILES .Bl -tag -width ".Pa /usr/ports/Mk/bsd.port.mk" -compact .It Pa /usr/ports -The default ports directory +The default ports directory. .It Pa /usr/ports/Mk/bsd.port.mk The big Kahuna. .El @@ -546,19 +551,24 @@ make install .Sh SEE ALSO .Xr make 1 , .Xr make.conf 5 , -.Xr pkg 8 , +.Xr pkg 7 , .Xr portsnap 8 .Pp -The following are part of the ports collection: -.Pp -.Xr pkg 7 , +Additional developer documentation: +.Bl -dash -width "" -offset indent +.It .Xr portlint 1 -.Rs -.%B "The FreeBSD Handbook" -.Re +.It +.Pa /usr/ports/Mk/bsd.port.mk +.El .Pp -.Pa https://www.FreeBSD.org/ports -(searchable index of all ports) +Additional user documentation: +.Bl -dash -width "" -offset indent +.It +.Xr pkg 8 +.It +.Lk "https://www.FreeBSD.org/ports" "Searchable index of all ports" +.El .Sh HISTORY The Ports Collection appeared in