Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Ports::Port(3)	      User Contributed Perl Documentation	Ports::Port(3)

NAME
       FreeBSD::Ports::Port - Deal with	individual ports from FreeBSD's	ports
       collection

WARNING!
       This is a very early version of this module.  The interface to the
       class may change	in the future.	The documentation needs	improving.

       Consequently, suggestions, comments and patches are extremely welcome!
       I think the correct place to discuss this module	is the freebsd-doc
       mailing list at freebsd-doc@freebsd.org.

SYNOPSIS
	 # Who maintains the 'arc-5.21e' port?
	 # NOTE: Normally the FreeBSD::Ports module is used to do this.
	 use FreeBSD::Ports::Port;
	 use IO::File;
	 my $index = IO::File->new('/usr/ports/INDEX', 'r') or die;
	 my $port = FreeBSD::Ports::Port->new('arc-5.21e', $index);
	 print $port->maintainer,"\n";

DESCRIPTION
       "FreeBSD::Ports::Port" is a simple interface for	parsing	lines in
       FreeBSD's ports INDEX file.

       For further information,	or to obtain the latest	version	of this
       module, see <URL:http://people.FreeBSD.org/~tom/portpm/>.

METHODS
       $port = FreeBSD::Ports::Port->new($port_proto, $handle)
	   Constructor method to create	a new FreeBSD::Ports::Port object.
	   This	method is usually called within	FreeBSD::Ports.	 Most
	   programmers will rarely need	to call	this method.

	   $port_proto may either be the name of a port, or a complete line
	   from	an INDEX file.	If the name of a port is given,	then $handle
	   should be a seekable	handle for an INDEX.  Such a handle is
	   typically created using IO::File.

	   $port is an object representing the specified port.

       $text = $port->as_ascii
	   Describe the	port in	ASCII text format.  $text contains a
	   description of the port.

       $name = $port->name
	   $name is the	name of	the port.

       $path = $port->path
	   $path is the	location on a FreeBSD filesystem where this port is
	   found.

       $prefix = $port->prefix
	   $prefix is the area of the filesystem where this port is installed,
	   usually /usr/local or /usr/X11R6.

       $comment	= $port->comment
	   $comment is a brief comment describing the port.

       $descr_file = $port->descr_file
	   $descr_file is the name of a	file which contains a longer
	   description of the port.

       $maintainer = $port->maintainer
	   $maintainer is the e-mail address of	the person who maintains the
	   port.

       $www_url	= $port->www
	   $www_url is the URL of a resource containing	further	information
	   about the software included in the port.

       $primary_category = $port->primary_category
	   $primary_category is	the name of the	primary	category for the port.
	   A primary category is the first category in which a port is listed.
	   This	represents the directory under /usr/ports in which a port is
	   stored.

       @categories = $port->categories	OR  $categories	= $port->categories
	   Returns a list of categories	which the port is in, excluding	its
	   primary category.

	   If called in	array context, @categories is sorted alphabetically
	   and case insensitively.  In scalar context, $categories is a
	   reference to	a hash.	 The keys of the hash are names	of categories.
	   No importance should	be attached to the values of the hash.

       @categories = $port->all_categories  OR	$categories =
       $port->all_categories
	   Returns a list of categories	which the port is in, including	its
	   primary category.

	   If called in	array context,	@categories is sorted alphabetically
	   and case insensitively.  In scalar context, $categories is a
	   reference to	a hash,	in the same style as the "categories" method.

       @depends	= $port->build_depends	OR  $depends = $port->build_depends
	   Returns a list of other ports which are required to build the port.

	   If called in	array context, @depends	is sorted alphabetically and
	   case	insensitively.	In scalar context, $depends is a reference to
	   a hash, in the same style as	the "categories" method.

       @depends	= $port->run_depends  OR  $depends = $port->run_depends
	   Returns a list of other ports which are required to run the port.

	   If called in	arrary context,	@depends is sorted alphabetically and
	   case	insensitively.	In scalar context, $depends is a reference to
	   a hash, in the same style as	the "categories" method.

       @depends	= $port->all_depends  OR  $depends = $port->all_depends
	   Returns a list of other ports which are required by the port	in any
	   way.	 At present, this means	other ports which are required to
	   build or run	the port.

	   If called in	arrary context,	@depends is sorted alphabetically and
	   case	insensitively.	In scalar context, $depends is a reference to
	   a hash, in the same style as	the "categories" method.

CREDITS
       This module is written by Tom Hukins <tom@FreeBSD.org>.

       Thanks to Nik Clayton, Martin Heinen and	Lars Thegler for
       encouragement, assistance and patches.

COPYRIGHT
       This module is distributed under	the same license as FreeBSD
       <http://www.FreeBSD.org/copyright/freebsd-license.html>.

POD ERRORS
       Hey! The	above document had some	coding errors, which are explained
       below:

       Around line 284:
	   You forgot a	'=back'	before '=head1'

perl v5.32.0			  2004-01-13			Ports::Port(3)

NAME | WARNING! | SYNOPSIS | DESCRIPTION | METHODS | CREDITS | COPYRIGHT | POD ERRORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=FreeBSD::Ports::Port&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help