- Sync with FreeBSD.
authorSascha Wildner <swildner@dragonflybsd.org>
Thu, 27 Jan 2005 18:06:42 +0000 (18:06 +0000)
committerSascha Wildner <swildner@dragonflybsd.org>
Thu, 27 Jan 2005 18:06:42 +0000 (18:06 +0000)
- Mention DragonFly where appropriate.
- Fix some punctuation.

Noticed-by: Heinrich Rebehn <rebehn@ant.uni-bremen.de>
            Freddie Cash <fcash-ml@sd73.bc.ca>

share/man/man7/ports.7

index 2714c45..d66f113 100644 (file)
@@ -24,9 +24,9 @@
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man7/ports.7,v 1.17.2.9 2002/08/07 10:54:39 blackend Exp $
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man7/ports.7,v 1.17.2.9 2002/08/07 10:54:39 blackend Exp $
-.\" $DragonFly: src/share/man/man7/Attic/ports.7,v 1.3 2004/02/25 20:44:30 eirikn Exp $
+.\" $DragonFly: src/share/man/man7/Attic/ports.7,v 1.4 2005/01/27 18:06:42 swildner Exp $
 .\"
 .\"
-.Dd January 25, 1998
+.Dd December 17, 2004
 .Dt PORTS 7
 .Os
 .Sh NAME
 .Dt PORTS 7
 .Os
 .Sh NAME
@@ -74,12 +74,12 @@ For more information about using ports, see
 .Dq "Packages and Ports"
 in
 .%B "The FreeBSD Handbook" ,
 .Dq "Packages and Ports"
 in
 .%B "The FreeBSD Handbook" ,
-.Pa ( file:/usr/share/doc/handbook/ports.html
+.Pa ( file:/usr/share/doc/en_US.ISO8859-1/books/handbook/ports.html
 or
 or
-.Pa http://www.FreeBSD.org/doc/handbook/ports.html ) .
+.Pa http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/ports.html ) .
 For information about creating new ports, see
 .%B "The Porter's Handbook"
 For information about creating new ports, see
 .%B "The Porter's Handbook"
-.Pa ( file:/usr/share/doc/porters-handbook/index.html
+.Pa ( file:/usr/share/doc/en_US.ISO8859-1/books/porters-handbook/index.html
 or
 .Pa http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/porters-handbook/ ) .
 .Sh TARGETS
 or
 .Pa http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/porters-handbook/ ) .
 .Sh TARGETS
@@ -107,6 +107,11 @@ Usually, you will only use the
 .Cm install
 target.
 .Bl -tag -width ".Cm configure"
 .Cm install
 target.
 .Bl -tag -width ".Cm configure"
+.It Cm config
+Configure
+.Va OPTIONS
+for this port using
+.Xr dialog 1 .
 .It Cm fetch
 Fetch all of the files needed to build this port from the sites
 listed in
 .It Cm fetch
 Fetch all of the files needed to build this port from the sites
 listed in
@@ -114,9 +119,9 @@ listed in
 and
 .Va PATCH_SITES .
 See
 and
 .Va PATCH_SITES .
 See
-.Va FETCH_CMD
+.Va FETCH_CMD , MASTER_SITE_OVERRIDE
 and
 and
-.Va MASTER_SITE_OVERRIDE .
+.Va MASTER_SITE_BACKUP .
 .It Cm checksum
 Verify that the fetched distfile's checksum matches the one the port was
 tested against.
 .It Cm checksum
 Verify that the fetched distfile's checksum matches the one the port was
 tested against.
@@ -159,9 +164,22 @@ This is all you really need to do.
 .El
 .Pp
 The following targets are not run during the normal install process.
 .El
 .Pp
 The following targets are not run during the normal install process.
-.Bl -tag -width ".Cm fetch-list"
+.Bl -tag -width ".Cm fetch-recursive"
+.It Cm showconfig
+Display
+.Va OPTIONS
+config for this port.
+.It Cm rmconfig
+Remove
+.Va OPTIONS
+config for this port.
 .It Cm fetch-list
 .It Cm fetch-list
-Show list of files needed to be fetched in order to build the port.
+Show list of files to be fetched in order to build the port.
+.It Cm fetch-recursive
+Fetch the distfiles of the port and all its dependencies.
+.It Cm fetch-recursive-list
+Show list of files that would be retrieved by
+.Cm fetch-recursive .
 .It Cm pretty-print-run-depends-list , pretty-print-build-depends-list
 Print a list of all the compile and run dependencies, and dependencies
 of those dependencies.
 .It Cm pretty-print-run-depends-list , pretty-print-build-depends-list
 Print a list of all the compile and run dependencies, and dependencies
 of those dependencies.
@@ -190,11 +208,15 @@ when you should have used
 .It Cm deinstall
 Remove an installed port from the system, similar to
 .Xr pkg_delete 1 .
 .It Cm deinstall
 Remove an installed port from the system, similar to
 .Xr pkg_delete 1 .
+.It Cm deinstall-all
+Remove all installed ports with the same
+.Va PKGORIGIN
+from the system.
 .It Cm package
 Make a binary package for the port.
 The port will be installed if it has not already been.
 The package is a
 .It Cm package
 Make a binary package for the port.
 The port will be installed if it has not already been.
 The package is a
-.Pa .tgz
+.Pa .tbz
 file that you can use to
 install the port on other machines with
 .Xr pkg_add 1 .
 file that you can use to
 install the port on other machines with
 .Xr pkg_add 1 .
@@ -205,6 +227,10 @@ See
 .Va PKGREPOSITORY
 and
 .Va PKGFILE .
 .Va PKGREPOSITORY
 and
 .Va PKGFILE .
+.It Cm package-recursive
+Like
+.Cm package ,
+but makes a package for each depending port as well.
 .It Cm readmes
 Create a port's
 .Pa README.html .
 .It Cm readmes
 Create a port's
 .Pa README.html .
@@ -214,13 +240,27 @@ to create a browsable web of all ports on your system!
 .It Cm search
 Search the
 .Pa INDEX
 .It Cm search
 Search the
 .Pa INDEX
-file for the pattern specified by either the
+file for the pattern specified by the
 .Va key
 .Va key
-(searches the port name, comment, and dependencies) or
+(searches the port name, comment, and dependencies),
 .Va name
 .Va name
-(searches the port name only)
+(searches the port name only),
+.Va path
+(searches the port path),
+.Va info
+(searches the port info),
+.Va maint
+(searches the port maintainer),
+.Va cat
+(searches the port category),
+.Va bdeps
+(searches the port build-time dependency),
+.Va rdeps
+(searches the port run-time dependency)
 .Xr make 1
 .Xr make 1
-variable.
+variables, and their exclusion counterparts:
+.Va xname , xkey
+etc.
 For example, one would type:
 .Pp
 .Dl "cd /usr/ports && make search name=query"
 For example, one would type:
 .Pp
 .Dl "cd /usr/ports && make search name=query"
@@ -230,6 +270,39 @@ name matches
 .Dq Li query .
 Results include the matching ports' path, comment, maintainer,
 build dependencies, and run dependencies.
 .Dq Li query .
 Results include the matching ports' path, comment, maintainer,
 build dependencies, and run dependencies.
+.Bd -literal -offset indent
+cd /usr/ports && make search name=pear- \e
+    xbdeps=apache
+.Ed
+.Pp
+To find all ports whose
+names contain
+.Dq Li pear-
+and which do not have apache
+listed in build-time dependencies.
+.Bd -literal -offset indent
+cd /usr/ports && make search name=pear- \e
+    xname='ht(tp|ml)'
+.Ed
+.Pp
+To find all ports whose names contain
+.Dq Li pear- ,
+but not
+.Dq Li html
+or
+.Dq Li http .
+.Bd -literal -offset indent
+make search key=apache display=name,path,info keylim=1
+.Ed
+.Pp
+To find ports that contain
+.Dq Li apache
+in either of the name, path, info
+fields, ignore the rest of the record.
+.It Cm describe
+Generate a one-line description of each port for use in the
+.Pa INDEX
+file.
 .It Cm index
 Create
 .Pa /usr/ports/INDEX ,
 .It Cm index
 Create
 .Pa /usr/ports/INDEX ,
@@ -238,14 +311,17 @@ which is used by the
 and
 .Cm search
 targets.
 and
 .Cm search
 targets.
-While the master
-.Pa INDEX
-file in the CVS repository is periodically
-updated, running the
+Running the
 .Cm index
 target will ensure your
 .Pa INDEX
 file is up to date with your ports tree.
 .Cm index
 target will ensure your
 .Pa INDEX
 file is up to date with your ports tree.
+.It Cm fetchindex
+Fetch the
+.Pa INDEX
+file from the
+.Fx
+cluster.
 .El
 .Sh ENVIRONMENT
 You can change all of these.
 .El
 .Sh ENVIRONMENT
 You can change all of these.
@@ -255,6 +331,7 @@ Location of the ports tree.
 This is
 .Pa /usr/ports
 on
 This is
 .Pa /usr/ports
 on
+.Dx ,
 .Fx
 and
 .Ox ,
 .Fx
 and
 .Ox ,
@@ -304,7 +381,27 @@ If set, go to the master
 .Fx
 site for all files.
 .It Va MASTER_SITE_OVERRIDE
 .Fx
 site for all files.
 .It Va MASTER_SITE_OVERRIDE
-Try going to this site for all files and patches, first.
+Try going to these sites for all files and patches, first.
+.It Va MASTER_SITE_BACKUP
+Try going to these sites for all files and patches, last.
+.It Va MASTER_SITE_INDEX
+Where to get
+.Pa INDEX
+source built on
+.Fx
+cluster (for
+.Cm fetchindex
+target).
+Defaults to
+.Pa http://www.FreeBSD.org/ports/ .
+.It Va FETCHINDEX
+Command to get
+.Pa INDEX
+(for
+.Cm fetchindex
+target).
+Defaults to
+.Dq Nm fetch Fl am .
 .It Va NOCLEANDEPENDS
 If defined, do not let
 .Cm clean
 .It Va NOCLEANDEPENDS
 If defined, do not let
 .Cm clean
@@ -322,20 +419,36 @@ Location of
 If defined, only operate on a port if it requires interaction.
 .It Va BATCH
 If defined, only operate on a port if it can be installed 100% automatically.
 If defined, only operate on a port if it requires interaction.
 .It Va BATCH
 If defined, only operate on a port if it can be installed 100% automatically.
+.It Va OPTIONS
+If defined, list of what
+.Va WITH_*
+options this port accepts.
+.Em Note :
+to make
+.Va OPTIONS
+actually work, it is necessary to include
+.Pa bsd.port.pre.mk
+before starting to test the
+.Va WITH_*
+variables.
+.It Va DISABLE_VULNERABILITIES
+If defined, disable check for security vulnerabilities using
+.Xr portaudit 1
+when installing new ports.
 .El
 .Sh FILES
 .Bl -tag -width ".Pa /usr/ports/Mk/bsd.port.mk" -compact
 .It Pa /usr/ports
 The default ports directory
 .El
 .Sh FILES
 .Bl -tag -width ".Pa /usr/ports/Mk/bsd.port.mk" -compact
 .It Pa /usr/ports
 The default ports directory
-.No ( Fx
-, FreeBSD
+.No ( Dx ,
+.Fx
 and
 .Ox ) .
 .It Pa /usr/pkgsrc
 The default ports directory
 .Pq Nx .
 .It Pa /usr/dfports
 and
 .Ox ) .
 .It Pa /usr/pkgsrc
 The default ports directory
 .Pq Nx .
 .It Pa /usr/dfports
-DragonFly override ports
+DragonFly override ports.
 .It Pa /usr/ports/Mk/bsd.port.mk
 The big Kahuna.
 .El
 .It Pa /usr/ports/Mk/bsd.port.mk
 The big Kahuna.
 .El
@@ -358,13 +471,6 @@ The following are part of the ports collection:
 .Pp
 .Pa http://www.FreeBSD.org/ports
 (searchable index of all ports)
 .Pp
 .Pa http://www.FreeBSD.org/ports
 (searchable index of all ports)
-.Sh AUTHORS
-.An -nosplit
-This man page was originated by
-.An David O'Brien .
-The ports collection is maintained by
-.An Satoshi Asami
-and the Awesome Ports Team.
 .Sh HISTORY
 The Ports Collection
 appeared in
 .Sh HISTORY
 The Ports Collection
 appeared in
@@ -373,6 +479,10 @@ It has since spread to
 .Nx
 and
 .Ox .
 .Nx
 and
 .Ox .
+.Sh AUTHORS
+.An -nosplit
+This manual page was originated by
+.An David O'Brien .
 .Sh BUGS
 Ports documentation is split over four places \(em
 .Pa /usr/ports/Mk/bsd.port.mk ,
 .Sh BUGS
 Ports documentation is split over four places \(em
 .Pa /usr/ports/Mk/bsd.port.mk ,
@@ -382,6 +492,4 @@ the
 chapter of
 .%B "The FreeBSD Handbook" ,
 and
 chapter of
 .%B "The FreeBSD Handbook" ,
 and
-.Xr ports 7 .
-.Pp
-This man page is too long.
+this manual page.