Add description for PKGNAME{PRE,SUF}FIX. (Gosh, it was much more work

than I thought....)
This commit is contained in:
Satoshi Asami 2000-04-10 17:57:14 +00:00
parent 3368d0957e
commit bb04c38477
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=7040
4 changed files with 280 additions and 68 deletions

View file

@ -1,7 +1,7 @@
<!--
The FreeBSD Documentation Project
$FreeBSD: doc/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml,v 1.91 2000/03/17 16:46:01 billf Exp $
$FreeBSD: doc/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml,v 1.92 2000/04/07 00:12:43 jim Exp $
-->
<chapter id="ports">
@ -1580,24 +1580,37 @@ lib/X11/oneko/mouse.xpm
<para>You should set <makevar>PORTNAME</makevar> to be the
base name of your port, and <makevar>PORTVERSION</makevar>
to the version number of the port. They are combined to
to the version number of the port.</para>
</sect3>
<sect3>
<title><makevar>PKGNAMEPREFIX</makevar> and <makevar>PKGNAMESUFFIX</makevar></title>
<para>Two optional variables, <makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar>, are combined with
<makevar>PORTNAME</makevar> and
<makevar>PORTVERSION</makevar> to
form <makevar>PKGNAME</makevar> as
<literal>${PORTNAME}-${PORTVERSION}</literal>.
<literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>.
Make sure this conforms to our <link
linkend="porting-pkgname">guidelines for a good package
name</link>. In particular, you are not allowed to use a
hyphen (<literal>-</literal>) in
<makevar>PORTVERSION</makevar>.</para>
<makevar>PORTVERSION</makevar>. Also, if the package name
has the <replaceable>language-</replaceable> or the
<replaceable>compiled.specifics</replaceable> part, use
<makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar>, respectively. Do not make
them part of <makevar>PORTNAME</makevar>.</para>
</sect3>
<sect3>
<title><makevar>DISTNAME</makevar></title>
<para><makevar>DISTNAME</makevar> is the name of the port as
called by the authors of the software.
<makevar>DISTNAME</makevar> defaults to
<makevar>PKGNAME</makevar>, so override it if necessary.
<literal>${PORTNAME}-${PORTVERSION}</literal>, so override it if necessary.
<makevar>DISTNAME</makevar> is only used in two places.
First, the distribution file list
(<makevar>DISTFILES</makevar>) defaults to
@ -1605,6 +1618,10 @@ lib/X11/oneko/mouse.xpm
Second, the distribution file is expected to extract into a
subdirectory named <makevar>WRKSRC</makevar>, which defaults
to <filename>work/<makevar>${DISTNAME}</makevar></filename>.</para>
<para>Note that <makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar> do not affect
<makevar>DISTNAME</makevar>.</para>
</sect3>
<sect3>
@ -2203,16 +2220,17 @@ ${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m ....</programlisting>
use variables cleverly. In the sole <filename>Makefiles</filename>,
you can use <makevar>MASTERDIR</makevar> to specify the directory
where the rest of the files are. Also, use a variable as part of
<link linkend="porting-pkgname"><makevar>PORTNAME</makevar> or
<makevar>PORTVERSION</makevar></link> so
<link linkend="porting-pkgname"><makevar>PKGNAMESUFFIX</makevar></link> so
the packages will have different names.</para>
<para>This will be best demonstrated by an example. This is part of
<filename>japanese/xdvi300/Makefile</filename>;</para>
<programlisting>
PORTNAME= ja-xdvi${RESOLUTION}
PORTNAME= xdvi
PORTVERSION= 17
PKGNAMEPREFIX= ja-
PKGNAMESUFFIX= ${RESOLUTION}
:
# default
RESOLUTION?= 300
@ -3722,7 +3740,8 @@ post-install:
lot of files to be fetched, or contains a file that has a name that
might conflict with other ports (e.g.,
<filename>Makefile</filename>), set <makevar>DIST_SUBDIR</makevar>
to the name of the port (<makevar>PORTNAME</makevar>
to the name of the port (<literal>${PORTNAME}</literal> or
<literal>${PKGNAMEPREFIX}${PORTNAME}</literal>
should work fine). This will change
<makevar>DISTDIR</makevar> from the default
<filename>/usr/ports/distfiles</filename> to
@ -4060,6 +4079,7 @@ this line back to "&dollar;FreeBSD&dollar;". CVS deals with it automatically.]
[section to describe the port itself and the master site - PORTNAME
and PORTVERSION are always first, followed by CATEGORIES,
and then MASTER_SITES, which can be followed by MASTER_SITE_SUBDIR.
PKGNAMEPREFIX and PKGNAMESUFFIX, if needed, will be after that.
Then comes DISTNAME, EXTRACT_SUFX and/or DISTFILES, and then
EXTRACT_ONLY, as necessary.]
PORTNAME= xdvi
@ -4069,6 +4089,7 @@ CATEGORIES= print
if you are not using MASTER_SITE_* macros]
MASTER_SITES= ${MASTER_SITE_XCONTRIB}
MASTER_SITE_SUBDIR= applications
PKGNAMEPREFIX= ja-
DISTNAME= xdvi-pl18
[set this if the source is not in the standard ".tar.gz" form]
EXTRACT_SUFX= .tar.Z
@ -4179,9 +4200,8 @@ pre-install:
<filename><replaceable><optional>language<optional>_region</optional></optional>-name<optional><optional>-</optional>compiled.specifics</optional>-version.numbers</replaceable></filename>.</para>
<para>The package name is defined as
<literal>${PORTNAME}-${PORTVERSION}</literal>. Make sure to
choose your <makevar>PORTNAME</makevar> and
<makevar>PORTVERSION</makevar> to conform to that format.</para>
<literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>.
Make sure to set the variables to conform to that format.</para>
<orderedlist>
<listitem>
@ -4198,6 +4218,9 @@ pre-install:
language area, add the two letter country code as well.
Examples are <literal>en_US</literal> for US English and
<literal>fr_CH</literal> for Swiss French.</para>
<para>The <replaceable>language-</replaceable> part should
be set in the <makevar>PKGNAMEPREFIX</makevar> variable.</para>
</listitem>
<listitem>
@ -4225,6 +4248,10 @@ pre-install:
<replaceable>-compiled.specifics</replaceable> part should state
the compiled-in defaults (the hyphen is optional). Examples are
papersize and font units.</para>
<para>The <replaceable>compiled.specifics</replaceable> part
should be set in the <makevar>PKGNAMESUFFIX</makevar>
variable.</para>
</listitem>
<listitem>
@ -4260,11 +4287,13 @@ pre-install:
name:</para>
<informaltable frame="none">
<tgroup cols="4">
<tgroup cols="6">
<thead>
<row>
<entry>Distribution Name</entry>
<entry><makevar>PKGNAMEPREFIX</makevar></entry>
<entry><makevar>PORTNAME</makevar></entry>
<entry><makevar>PKGNAMESUFFIX</makevar></entry>
<entry><makevar>PORTVERSION</makevar></entry>
<entry>Reason</entry>
</row>
@ -4273,28 +4302,36 @@ pre-install:
<tbody>
<row>
<entry>mule-2.2.2</entry>
<entry></entry>
<entry>mule</entry>
<entry></entry>
<entry>2.2.2</entry>
<entry>No changes required</entry>
</row>
<row>
<entry>XFree86-3.3.6</entry>
<entry></entry>
<entry>XFree86</entry>
<entry></entry>
<entry>3.3.6</entry>
<entry>No changes required</entry>
</row>
<row>
<entry>EmiClock-1.0.2</entry>
<entry>(empty)</entry>
<entry>emiclock</entry>
<entry>(empty)</entry>
<entry>1.0.2</entry>
<entry>No uppercase names for single programs</entry>
</row>
<row>
<entry>rdist-1.3alpha</entry>
<entry>(empty)</entry>
<entry>rdist</entry>
<entry>(empty)</entry>
<entry>1.3.a</entry>
<entry>No strings like <literal>alpha</literal>
allowed</entry>
@ -4302,7 +4339,9 @@ pre-install:
<row>
<entry>es-0.9-beta1</entry>
<entry>(empty)</entry>
<entry>es-0.9</entry>
<entry>(empty)</entry>
<entry>b1</entry>
<entry>No strings like <literal>beta</literal>
allowed</entry>
@ -4310,28 +4349,36 @@ pre-install:
<row>
<entry>v3.3beta021.src</entry>
<entry>(empty)</entry>
<entry>tiff</entry>
<entry>(empty)</entry>
<entry>3.3</entry>
<entry>What the heck was that anyway?</entry>
</row>
<row>
<entry>tvtwm</entry>
<entry>(empty)</entry>
<entry>tvtwm</entry>
<entry>(empty)</entry>
<entry>pl11</entry>
<entry>Version string always required</entry>
</row>
<row>
<entry>piewm</entry>
<entry>(empty)</entry>
<entry>piewm</entry>
<entry>(empty)</entry>
<entry>1.0</entry>
<entry>Version string always required</entry>
</row>
<row>
<entry>xvgr-2.10pl1</entry>
<entry>(empty)</entry>
<entry>xvgr</entry>
<entry>(empty)</entry>
<entry>2.10.1</entry>
<entry><literal>pl</literal> allowed only when no
major/minor version numbers</entry>
@ -4339,21 +4386,27 @@ pre-install:
<row>
<entry>gawk-2.15.6</entry>
<entry>ja-gawk</entry>
<entry>ja-</entry>
<entry>gawk</entry>
<entry>(empty)</entry>
<entry>2.15.6</entry>
<entry>Japanese language version</entry>
</row>
<row>
<entry>psutils-1.13</entry>
<entry>psutils-letter</entry>
<entry>(empty)</entry>
<entry>psutils</entry>
<entry>-letter</entry>
<entry>1.13</entry>
<entry>Papersize hardcoded at package build time</entry>
</row>
<row>
<entry>pkfonts</entry>
<entry>pkfonts300</entry>
<entry>(empty)</entry>
<entry>pkfonts</entry>
<entry>300</entry>
<entry>1.0</entry>
<entry>Package for 300dpi fonts</entry>
</row>

View file

@ -1,7 +1,7 @@
<!--
The FreeBSD Documentation Project
$FreeBSD: doc/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml,v 1.91 2000/03/17 16:46:01 billf Exp $
$FreeBSD: doc/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml,v 1.92 2000/04/07 00:12:43 jim Exp $
-->
<chapter id="ports">
@ -1580,24 +1580,37 @@ lib/X11/oneko/mouse.xpm
<para>You should set <makevar>PORTNAME</makevar> to be the
base name of your port, and <makevar>PORTVERSION</makevar>
to the version number of the port. They are combined to
to the version number of the port.</para>
</sect3>
<sect3>
<title><makevar>PKGNAMEPREFIX</makevar> and <makevar>PKGNAMESUFFIX</makevar></title>
<para>Two optional variables, <makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar>, are combined with
<makevar>PORTNAME</makevar> and
<makevar>PORTVERSION</makevar> to
form <makevar>PKGNAME</makevar> as
<literal>${PORTNAME}-${PORTVERSION}</literal>.
<literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>.
Make sure this conforms to our <link
linkend="porting-pkgname">guidelines for a good package
name</link>. In particular, you are not allowed to use a
hyphen (<literal>-</literal>) in
<makevar>PORTVERSION</makevar>.</para>
<makevar>PORTVERSION</makevar>. Also, if the package name
has the <replaceable>language-</replaceable> or the
<replaceable>compiled.specifics</replaceable> part, use
<makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar>, respectively. Do not make
them part of <makevar>PORTNAME</makevar>.</para>
</sect3>
<sect3>
<title><makevar>DISTNAME</makevar></title>
<para><makevar>DISTNAME</makevar> is the name of the port as
called by the authors of the software.
<makevar>DISTNAME</makevar> defaults to
<makevar>PKGNAME</makevar>, so override it if necessary.
<literal>${PORTNAME}-${PORTVERSION}</literal>, so override it if necessary.
<makevar>DISTNAME</makevar> is only used in two places.
First, the distribution file list
(<makevar>DISTFILES</makevar>) defaults to
@ -1605,6 +1618,10 @@ lib/X11/oneko/mouse.xpm
Second, the distribution file is expected to extract into a
subdirectory named <makevar>WRKSRC</makevar>, which defaults
to <filename>work/<makevar>${DISTNAME}</makevar></filename>.</para>
<para>Note that <makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar> do not affect
<makevar>DISTNAME</makevar>.</para>
</sect3>
<sect3>
@ -2203,16 +2220,17 @@ ${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m ....</programlisting>
use variables cleverly. In the sole <filename>Makefiles</filename>,
you can use <makevar>MASTERDIR</makevar> to specify the directory
where the rest of the files are. Also, use a variable as part of
<link linkend="porting-pkgname"><makevar>PORTNAME</makevar> or
<makevar>PORTVERSION</makevar></link> so
<link linkend="porting-pkgname"><makevar>PKGNAMESUFFIX</makevar></link> so
the packages will have different names.</para>
<para>This will be best demonstrated by an example. This is part of
<filename>japanese/xdvi300/Makefile</filename>;</para>
<programlisting>
PORTNAME= ja-xdvi${RESOLUTION}
PORTNAME= xdvi
PORTVERSION= 17
PKGNAMEPREFIX= ja-
PKGNAMESUFFIX= ${RESOLUTION}
:
# default
RESOLUTION?= 300
@ -3722,7 +3740,8 @@ post-install:
lot of files to be fetched, or contains a file that has a name that
might conflict with other ports (e.g.,
<filename>Makefile</filename>), set <makevar>DIST_SUBDIR</makevar>
to the name of the port (<makevar>PORTNAME</makevar>
to the name of the port (<literal>${PORTNAME}</literal> or
<literal>${PKGNAMEPREFIX}${PORTNAME}</literal>
should work fine). This will change
<makevar>DISTDIR</makevar> from the default
<filename>/usr/ports/distfiles</filename> to
@ -4060,6 +4079,7 @@ this line back to "&dollar;FreeBSD&dollar;". CVS deals with it automatically.]
[section to describe the port itself and the master site - PORTNAME
and PORTVERSION are always first, followed by CATEGORIES,
and then MASTER_SITES, which can be followed by MASTER_SITE_SUBDIR.
PKGNAMEPREFIX and PKGNAMESUFFIX, if needed, will be after that.
Then comes DISTNAME, EXTRACT_SUFX and/or DISTFILES, and then
EXTRACT_ONLY, as necessary.]
PORTNAME= xdvi
@ -4069,6 +4089,7 @@ CATEGORIES= print
if you are not using MASTER_SITE_* macros]
MASTER_SITES= ${MASTER_SITE_XCONTRIB}
MASTER_SITE_SUBDIR= applications
PKGNAMEPREFIX= ja-
DISTNAME= xdvi-pl18
[set this if the source is not in the standard ".tar.gz" form]
EXTRACT_SUFX= .tar.Z
@ -4179,9 +4200,8 @@ pre-install:
<filename><replaceable><optional>language<optional>_region</optional></optional>-name<optional><optional>-</optional>compiled.specifics</optional>-version.numbers</replaceable></filename>.</para>
<para>The package name is defined as
<literal>${PORTNAME}-${PORTVERSION}</literal>. Make sure to
choose your <makevar>PORTNAME</makevar> and
<makevar>PORTVERSION</makevar> to conform to that format.</para>
<literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>.
Make sure to set the variables to conform to that format.</para>
<orderedlist>
<listitem>
@ -4198,6 +4218,9 @@ pre-install:
language area, add the two letter country code as well.
Examples are <literal>en_US</literal> for US English and
<literal>fr_CH</literal> for Swiss French.</para>
<para>The <replaceable>language-</replaceable> part should
be set in the <makevar>PKGNAMEPREFIX</makevar> variable.</para>
</listitem>
<listitem>
@ -4225,6 +4248,10 @@ pre-install:
<replaceable>-compiled.specifics</replaceable> part should state
the compiled-in defaults (the hyphen is optional). Examples are
papersize and font units.</para>
<para>The <replaceable>compiled.specifics</replaceable> part
should be set in the <makevar>PKGNAMESUFFIX</makevar>
variable.</para>
</listitem>
<listitem>
@ -4260,11 +4287,13 @@ pre-install:
name:</para>
<informaltable frame="none">
<tgroup cols="4">
<tgroup cols="6">
<thead>
<row>
<entry>Distribution Name</entry>
<entry><makevar>PKGNAMEPREFIX</makevar></entry>
<entry><makevar>PORTNAME</makevar></entry>
<entry><makevar>PKGNAMESUFFIX</makevar></entry>
<entry><makevar>PORTVERSION</makevar></entry>
<entry>Reason</entry>
</row>
@ -4273,28 +4302,36 @@ pre-install:
<tbody>
<row>
<entry>mule-2.2.2</entry>
<entry></entry>
<entry>mule</entry>
<entry></entry>
<entry>2.2.2</entry>
<entry>No changes required</entry>
</row>
<row>
<entry>XFree86-3.3.6</entry>
<entry></entry>
<entry>XFree86</entry>
<entry></entry>
<entry>3.3.6</entry>
<entry>No changes required</entry>
</row>
<row>
<entry>EmiClock-1.0.2</entry>
<entry>(empty)</entry>
<entry>emiclock</entry>
<entry>(empty)</entry>
<entry>1.0.2</entry>
<entry>No uppercase names for single programs</entry>
</row>
<row>
<entry>rdist-1.3alpha</entry>
<entry>(empty)</entry>
<entry>rdist</entry>
<entry>(empty)</entry>
<entry>1.3.a</entry>
<entry>No strings like <literal>alpha</literal>
allowed</entry>
@ -4302,7 +4339,9 @@ pre-install:
<row>
<entry>es-0.9-beta1</entry>
<entry>(empty)</entry>
<entry>es-0.9</entry>
<entry>(empty)</entry>
<entry>b1</entry>
<entry>No strings like <literal>beta</literal>
allowed</entry>
@ -4310,28 +4349,36 @@ pre-install:
<row>
<entry>v3.3beta021.src</entry>
<entry>(empty)</entry>
<entry>tiff</entry>
<entry>(empty)</entry>
<entry>3.3</entry>
<entry>What the heck was that anyway?</entry>
</row>
<row>
<entry>tvtwm</entry>
<entry>(empty)</entry>
<entry>tvtwm</entry>
<entry>(empty)</entry>
<entry>pl11</entry>
<entry>Version string always required</entry>
</row>
<row>
<entry>piewm</entry>
<entry>(empty)</entry>
<entry>piewm</entry>
<entry>(empty)</entry>
<entry>1.0</entry>
<entry>Version string always required</entry>
</row>
<row>
<entry>xvgr-2.10pl1</entry>
<entry>(empty)</entry>
<entry>xvgr</entry>
<entry>(empty)</entry>
<entry>2.10.1</entry>
<entry><literal>pl</literal> allowed only when no
major/minor version numbers</entry>
@ -4339,21 +4386,27 @@ pre-install:
<row>
<entry>gawk-2.15.6</entry>
<entry>ja-gawk</entry>
<entry>ja-</entry>
<entry>gawk</entry>
<entry>(empty)</entry>
<entry>2.15.6</entry>
<entry>Japanese language version</entry>
</row>
<row>
<entry>psutils-1.13</entry>
<entry>psutils-letter</entry>
<entry>(empty)</entry>
<entry>psutils</entry>
<entry>-letter</entry>
<entry>1.13</entry>
<entry>Papersize hardcoded at package build time</entry>
</row>
<row>
<entry>pkfonts</entry>
<entry>pkfonts300</entry>
<entry>(empty)</entry>
<entry>pkfonts</entry>
<entry>300</entry>
<entry>1.0</entry>
<entry>Package for 300dpi fonts</entry>
</row>

View file

@ -1,7 +1,7 @@
<!--
The FreeBSD Documentation Project
$FreeBSD: doc/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml,v 1.91 2000/03/17 16:46:01 billf Exp $
$FreeBSD: doc/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml,v 1.92 2000/04/07 00:12:43 jim Exp $
-->
<chapter id="ports">
@ -1580,24 +1580,37 @@ lib/X11/oneko/mouse.xpm
<para>You should set <makevar>PORTNAME</makevar> to be the
base name of your port, and <makevar>PORTVERSION</makevar>
to the version number of the port. They are combined to
to the version number of the port.</para>
</sect3>
<sect3>
<title><makevar>PKGNAMEPREFIX</makevar> and <makevar>PKGNAMESUFFIX</makevar></title>
<para>Two optional variables, <makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar>, are combined with
<makevar>PORTNAME</makevar> and
<makevar>PORTVERSION</makevar> to
form <makevar>PKGNAME</makevar> as
<literal>${PORTNAME}-${PORTVERSION}</literal>.
<literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>.
Make sure this conforms to our <link
linkend="porting-pkgname">guidelines for a good package
name</link>. In particular, you are not allowed to use a
hyphen (<literal>-</literal>) in
<makevar>PORTVERSION</makevar>.</para>
<makevar>PORTVERSION</makevar>. Also, if the package name
has the <replaceable>language-</replaceable> or the
<replaceable>compiled.specifics</replaceable> part, use
<makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar>, respectively. Do not make
them part of <makevar>PORTNAME</makevar>.</para>
</sect3>
<sect3>
<title><makevar>DISTNAME</makevar></title>
<para><makevar>DISTNAME</makevar> is the name of the port as
called by the authors of the software.
<makevar>DISTNAME</makevar> defaults to
<makevar>PKGNAME</makevar>, so override it if necessary.
<literal>${PORTNAME}-${PORTVERSION}</literal>, so override it if necessary.
<makevar>DISTNAME</makevar> is only used in two places.
First, the distribution file list
(<makevar>DISTFILES</makevar>) defaults to
@ -1605,6 +1618,10 @@ lib/X11/oneko/mouse.xpm
Second, the distribution file is expected to extract into a
subdirectory named <makevar>WRKSRC</makevar>, which defaults
to <filename>work/<makevar>${DISTNAME}</makevar></filename>.</para>
<para>Note that <makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar> do not affect
<makevar>DISTNAME</makevar>.</para>
</sect3>
<sect3>
@ -2203,16 +2220,17 @@ ${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m ....</programlisting>
use variables cleverly. In the sole <filename>Makefiles</filename>,
you can use <makevar>MASTERDIR</makevar> to specify the directory
where the rest of the files are. Also, use a variable as part of
<link linkend="porting-pkgname"><makevar>PORTNAME</makevar> or
<makevar>PORTVERSION</makevar></link> so
<link linkend="porting-pkgname"><makevar>PKGNAMESUFFIX</makevar></link> so
the packages will have different names.</para>
<para>This will be best demonstrated by an example. This is part of
<filename>japanese/xdvi300/Makefile</filename>;</para>
<programlisting>
PORTNAME= ja-xdvi${RESOLUTION}
PORTNAME= xdvi
PORTVERSION= 17
PKGNAMEPREFIX= ja-
PKGNAMESUFFIX= ${RESOLUTION}
:
# default
RESOLUTION?= 300
@ -3722,7 +3740,8 @@ post-install:
lot of files to be fetched, or contains a file that has a name that
might conflict with other ports (e.g.,
<filename>Makefile</filename>), set <makevar>DIST_SUBDIR</makevar>
to the name of the port (<makevar>PORTNAME</makevar>
to the name of the port (<literal>${PORTNAME}</literal> or
<literal>${PKGNAMEPREFIX}${PORTNAME}</literal>
should work fine). This will change
<makevar>DISTDIR</makevar> from the default
<filename>/usr/ports/distfiles</filename> to
@ -4060,6 +4079,7 @@ this line back to "&dollar;FreeBSD&dollar;". CVS deals with it automatically.]
[section to describe the port itself and the master site - PORTNAME
and PORTVERSION are always first, followed by CATEGORIES,
and then MASTER_SITES, which can be followed by MASTER_SITE_SUBDIR.
PKGNAMEPREFIX and PKGNAMESUFFIX, if needed, will be after that.
Then comes DISTNAME, EXTRACT_SUFX and/or DISTFILES, and then
EXTRACT_ONLY, as necessary.]
PORTNAME= xdvi
@ -4069,6 +4089,7 @@ CATEGORIES= print
if you are not using MASTER_SITE_* macros]
MASTER_SITES= ${MASTER_SITE_XCONTRIB}
MASTER_SITE_SUBDIR= applications
PKGNAMEPREFIX= ja-
DISTNAME= xdvi-pl18
[set this if the source is not in the standard ".tar.gz" form]
EXTRACT_SUFX= .tar.Z
@ -4179,9 +4200,8 @@ pre-install:
<filename><replaceable><optional>language<optional>_region</optional></optional>-name<optional><optional>-</optional>compiled.specifics</optional>-version.numbers</replaceable></filename>.</para>
<para>The package name is defined as
<literal>${PORTNAME}-${PORTVERSION}</literal>. Make sure to
choose your <makevar>PORTNAME</makevar> and
<makevar>PORTVERSION</makevar> to conform to that format.</para>
<literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>.
Make sure to set the variables to conform to that format.</para>
<orderedlist>
<listitem>
@ -4198,6 +4218,9 @@ pre-install:
language area, add the two letter country code as well.
Examples are <literal>en_US</literal> for US English and
<literal>fr_CH</literal> for Swiss French.</para>
<para>The <replaceable>language-</replaceable> part should
be set in the <makevar>PKGNAMEPREFIX</makevar> variable.</para>
</listitem>
<listitem>
@ -4225,6 +4248,10 @@ pre-install:
<replaceable>-compiled.specifics</replaceable> part should state
the compiled-in defaults (the hyphen is optional). Examples are
papersize and font units.</para>
<para>The <replaceable>compiled.specifics</replaceable> part
should be set in the <makevar>PKGNAMESUFFIX</makevar>
variable.</para>
</listitem>
<listitem>
@ -4260,11 +4287,13 @@ pre-install:
name:</para>
<informaltable frame="none">
<tgroup cols="4">
<tgroup cols="6">
<thead>
<row>
<entry>Distribution Name</entry>
<entry><makevar>PKGNAMEPREFIX</makevar></entry>
<entry><makevar>PORTNAME</makevar></entry>
<entry><makevar>PKGNAMESUFFIX</makevar></entry>
<entry><makevar>PORTVERSION</makevar></entry>
<entry>Reason</entry>
</row>
@ -4273,28 +4302,36 @@ pre-install:
<tbody>
<row>
<entry>mule-2.2.2</entry>
<entry></entry>
<entry>mule</entry>
<entry></entry>
<entry>2.2.2</entry>
<entry>No changes required</entry>
</row>
<row>
<entry>XFree86-3.3.6</entry>
<entry></entry>
<entry>XFree86</entry>
<entry></entry>
<entry>3.3.6</entry>
<entry>No changes required</entry>
</row>
<row>
<entry>EmiClock-1.0.2</entry>
<entry>(empty)</entry>
<entry>emiclock</entry>
<entry>(empty)</entry>
<entry>1.0.2</entry>
<entry>No uppercase names for single programs</entry>
</row>
<row>
<entry>rdist-1.3alpha</entry>
<entry>(empty)</entry>
<entry>rdist</entry>
<entry>(empty)</entry>
<entry>1.3.a</entry>
<entry>No strings like <literal>alpha</literal>
allowed</entry>
@ -4302,7 +4339,9 @@ pre-install:
<row>
<entry>es-0.9-beta1</entry>
<entry>(empty)</entry>
<entry>es-0.9</entry>
<entry>(empty)</entry>
<entry>b1</entry>
<entry>No strings like <literal>beta</literal>
allowed</entry>
@ -4310,28 +4349,36 @@ pre-install:
<row>
<entry>v3.3beta021.src</entry>
<entry>(empty)</entry>
<entry>tiff</entry>
<entry>(empty)</entry>
<entry>3.3</entry>
<entry>What the heck was that anyway?</entry>
</row>
<row>
<entry>tvtwm</entry>
<entry>(empty)</entry>
<entry>tvtwm</entry>
<entry>(empty)</entry>
<entry>pl11</entry>
<entry>Version string always required</entry>
</row>
<row>
<entry>piewm</entry>
<entry>(empty)</entry>
<entry>piewm</entry>
<entry>(empty)</entry>
<entry>1.0</entry>
<entry>Version string always required</entry>
</row>
<row>
<entry>xvgr-2.10pl1</entry>
<entry>(empty)</entry>
<entry>xvgr</entry>
<entry>(empty)</entry>
<entry>2.10.1</entry>
<entry><literal>pl</literal> allowed only when no
major/minor version numbers</entry>
@ -4339,21 +4386,27 @@ pre-install:
<row>
<entry>gawk-2.15.6</entry>
<entry>ja-gawk</entry>
<entry>ja-</entry>
<entry>gawk</entry>
<entry>(empty)</entry>
<entry>2.15.6</entry>
<entry>Japanese language version</entry>
</row>
<row>
<entry>psutils-1.13</entry>
<entry>psutils-letter</entry>
<entry>(empty)</entry>
<entry>psutils</entry>
<entry>-letter</entry>
<entry>1.13</entry>
<entry>Papersize hardcoded at package build time</entry>
</row>
<row>
<entry>pkfonts</entry>
<entry>pkfonts300</entry>
<entry>(empty)</entry>
<entry>pkfonts</entry>
<entry>300</entry>
<entry>1.0</entry>
<entry>Package for 300dpi fonts</entry>
</row>

View file

@ -1,7 +1,7 @@
<!--
The FreeBSD Documentation Project
$FreeBSD: doc/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml,v 1.91 2000/03/17 16:46:01 billf Exp $
$FreeBSD: doc/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml,v 1.92 2000/04/07 00:12:43 jim Exp $
-->
<chapter id="ports">
@ -1580,24 +1580,37 @@ lib/X11/oneko/mouse.xpm
<para>You should set <makevar>PORTNAME</makevar> to be the
base name of your port, and <makevar>PORTVERSION</makevar>
to the version number of the port. They are combined to
to the version number of the port.</para>
</sect3>
<sect3>
<title><makevar>PKGNAMEPREFIX</makevar> and <makevar>PKGNAMESUFFIX</makevar></title>
<para>Two optional variables, <makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar>, are combined with
<makevar>PORTNAME</makevar> and
<makevar>PORTVERSION</makevar> to
form <makevar>PKGNAME</makevar> as
<literal>${PORTNAME}-${PORTVERSION}</literal>.
<literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>.
Make sure this conforms to our <link
linkend="porting-pkgname">guidelines for a good package
name</link>. In particular, you are not allowed to use a
hyphen (<literal>-</literal>) in
<makevar>PORTVERSION</makevar>.</para>
<makevar>PORTVERSION</makevar>. Also, if the package name
has the <replaceable>language-</replaceable> or the
<replaceable>compiled.specifics</replaceable> part, use
<makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar>, respectively. Do not make
them part of <makevar>PORTNAME</makevar>.</para>
</sect3>
<sect3>
<title><makevar>DISTNAME</makevar></title>
<para><makevar>DISTNAME</makevar> is the name of the port as
called by the authors of the software.
<makevar>DISTNAME</makevar> defaults to
<makevar>PKGNAME</makevar>, so override it if necessary.
<literal>${PORTNAME}-${PORTVERSION}</literal>, so override it if necessary.
<makevar>DISTNAME</makevar> is only used in two places.
First, the distribution file list
(<makevar>DISTFILES</makevar>) defaults to
@ -1605,6 +1618,10 @@ lib/X11/oneko/mouse.xpm
Second, the distribution file is expected to extract into a
subdirectory named <makevar>WRKSRC</makevar>, which defaults
to <filename>work/<makevar>${DISTNAME}</makevar></filename>.</para>
<para>Note that <makevar>PKGNAMEPREFIX</makevar> and
<makevar>PKGNAMESUFFIX</makevar> do not affect
<makevar>DISTNAME</makevar>.</para>
</sect3>
<sect3>
@ -2203,16 +2220,17 @@ ${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m ....</programlisting>
use variables cleverly. In the sole <filename>Makefiles</filename>,
you can use <makevar>MASTERDIR</makevar> to specify the directory
where the rest of the files are. Also, use a variable as part of
<link linkend="porting-pkgname"><makevar>PORTNAME</makevar> or
<makevar>PORTVERSION</makevar></link> so
<link linkend="porting-pkgname"><makevar>PKGNAMESUFFIX</makevar></link> so
the packages will have different names.</para>
<para>This will be best demonstrated by an example. This is part of
<filename>japanese/xdvi300/Makefile</filename>;</para>
<programlisting>
PORTNAME= ja-xdvi${RESOLUTION}
PORTNAME= xdvi
PORTVERSION= 17
PKGNAMEPREFIX= ja-
PKGNAMESUFFIX= ${RESOLUTION}
:
# default
RESOLUTION?= 300
@ -3722,7 +3740,8 @@ post-install:
lot of files to be fetched, or contains a file that has a name that
might conflict with other ports (e.g.,
<filename>Makefile</filename>), set <makevar>DIST_SUBDIR</makevar>
to the name of the port (<makevar>PORTNAME</makevar>
to the name of the port (<literal>${PORTNAME}</literal> or
<literal>${PKGNAMEPREFIX}${PORTNAME}</literal>
should work fine). This will change
<makevar>DISTDIR</makevar> from the default
<filename>/usr/ports/distfiles</filename> to
@ -4060,6 +4079,7 @@ this line back to "&dollar;FreeBSD&dollar;". CVS deals with it automatically.]
[section to describe the port itself and the master site - PORTNAME
and PORTVERSION are always first, followed by CATEGORIES,
and then MASTER_SITES, which can be followed by MASTER_SITE_SUBDIR.
PKGNAMEPREFIX and PKGNAMESUFFIX, if needed, will be after that.
Then comes DISTNAME, EXTRACT_SUFX and/or DISTFILES, and then
EXTRACT_ONLY, as necessary.]
PORTNAME= xdvi
@ -4069,6 +4089,7 @@ CATEGORIES= print
if you are not using MASTER_SITE_* macros]
MASTER_SITES= ${MASTER_SITE_XCONTRIB}
MASTER_SITE_SUBDIR= applications
PKGNAMEPREFIX= ja-
DISTNAME= xdvi-pl18
[set this if the source is not in the standard ".tar.gz" form]
EXTRACT_SUFX= .tar.Z
@ -4179,9 +4200,8 @@ pre-install:
<filename><replaceable><optional>language<optional>_region</optional></optional>-name<optional><optional>-</optional>compiled.specifics</optional>-version.numbers</replaceable></filename>.</para>
<para>The package name is defined as
<literal>${PORTNAME}-${PORTVERSION}</literal>. Make sure to
choose your <makevar>PORTNAME</makevar> and
<makevar>PORTVERSION</makevar> to conform to that format.</para>
<literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>.
Make sure to set the variables to conform to that format.</para>
<orderedlist>
<listitem>
@ -4198,6 +4218,9 @@ pre-install:
language area, add the two letter country code as well.
Examples are <literal>en_US</literal> for US English and
<literal>fr_CH</literal> for Swiss French.</para>
<para>The <replaceable>language-</replaceable> part should
be set in the <makevar>PKGNAMEPREFIX</makevar> variable.</para>
</listitem>
<listitem>
@ -4225,6 +4248,10 @@ pre-install:
<replaceable>-compiled.specifics</replaceable> part should state
the compiled-in defaults (the hyphen is optional). Examples are
papersize and font units.</para>
<para>The <replaceable>compiled.specifics</replaceable> part
should be set in the <makevar>PKGNAMESUFFIX</makevar>
variable.</para>
</listitem>
<listitem>
@ -4260,11 +4287,13 @@ pre-install:
name:</para>
<informaltable frame="none">
<tgroup cols="4">
<tgroup cols="6">
<thead>
<row>
<entry>Distribution Name</entry>
<entry><makevar>PKGNAMEPREFIX</makevar></entry>
<entry><makevar>PORTNAME</makevar></entry>
<entry><makevar>PKGNAMESUFFIX</makevar></entry>
<entry><makevar>PORTVERSION</makevar></entry>
<entry>Reason</entry>
</row>
@ -4273,28 +4302,36 @@ pre-install:
<tbody>
<row>
<entry>mule-2.2.2</entry>
<entry></entry>
<entry>mule</entry>
<entry></entry>
<entry>2.2.2</entry>
<entry>No changes required</entry>
</row>
<row>
<entry>XFree86-3.3.6</entry>
<entry></entry>
<entry>XFree86</entry>
<entry></entry>
<entry>3.3.6</entry>
<entry>No changes required</entry>
</row>
<row>
<entry>EmiClock-1.0.2</entry>
<entry>(empty)</entry>
<entry>emiclock</entry>
<entry>(empty)</entry>
<entry>1.0.2</entry>
<entry>No uppercase names for single programs</entry>
</row>
<row>
<entry>rdist-1.3alpha</entry>
<entry>(empty)</entry>
<entry>rdist</entry>
<entry>(empty)</entry>
<entry>1.3.a</entry>
<entry>No strings like <literal>alpha</literal>
allowed</entry>
@ -4302,7 +4339,9 @@ pre-install:
<row>
<entry>es-0.9-beta1</entry>
<entry>(empty)</entry>
<entry>es-0.9</entry>
<entry>(empty)</entry>
<entry>b1</entry>
<entry>No strings like <literal>beta</literal>
allowed</entry>
@ -4310,28 +4349,36 @@ pre-install:
<row>
<entry>v3.3beta021.src</entry>
<entry>(empty)</entry>
<entry>tiff</entry>
<entry>(empty)</entry>
<entry>3.3</entry>
<entry>What the heck was that anyway?</entry>
</row>
<row>
<entry>tvtwm</entry>
<entry>(empty)</entry>
<entry>tvtwm</entry>
<entry>(empty)</entry>
<entry>pl11</entry>
<entry>Version string always required</entry>
</row>
<row>
<entry>piewm</entry>
<entry>(empty)</entry>
<entry>piewm</entry>
<entry>(empty)</entry>
<entry>1.0</entry>
<entry>Version string always required</entry>
</row>
<row>
<entry>xvgr-2.10pl1</entry>
<entry>(empty)</entry>
<entry>xvgr</entry>
<entry>(empty)</entry>
<entry>2.10.1</entry>
<entry><literal>pl</literal> allowed only when no
major/minor version numbers</entry>
@ -4339,21 +4386,27 @@ pre-install:
<row>
<entry>gawk-2.15.6</entry>
<entry>ja-gawk</entry>
<entry>ja-</entry>
<entry>gawk</entry>
<entry>(empty)</entry>
<entry>2.15.6</entry>
<entry>Japanese language version</entry>
</row>
<row>
<entry>psutils-1.13</entry>
<entry>psutils-letter</entry>
<entry>(empty)</entry>
<entry>psutils</entry>
<entry>-letter</entry>
<entry>1.13</entry>
<entry>Papersize hardcoded at package build time</entry>
</row>
<row>
<entry>pkfonts</entry>
<entry>pkfonts300</entry>
<entry>(empty)</entry>
<entry>pkfonts</entry>
<entry>300</entry>
<entry>1.0</entry>
<entry>Package for 300dpi fonts</entry>
</row>