pkgsrc/templates/README.pkg

<!-- $NetBSD: README.pkg,v 1.35 2021/02/22 08:25:12 nia Exp $ -->
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<link href="../../templates/main.css" rel="stylesheet">
<title>%%PORT%% - The NetBSD Packages Collection</title>
</head>
<body>

<a href="http://www.mckusick.com/beastie/mainpage/copyright.html">
<img src="../../templates/pkg-daemon.gif" alt="Daemon Power" id="logo">
</a>
<h1><em>%%PORT%%</em> - The NetBSD Packages Collection</h1>

<details open>
<summary><em>%%COMMENT%%</em></summary>
<p></p> <!-- spacing hack for older browsers with no details support -->
<pre>
%%DESCR%%
</pre>
</details>

<ul class="package-data">
<li><strong>Source version:</strong> <samp>%%PKG%%</samp></li>
<li><strong>Maintainer:</strong> <em>%%MAINTAINER%%</em></li>
<li><strong>Website:</strong> %%HOMEPAGE%%</li>
<li><strong>License:</strong> %%LICENSE%%</li>
<li><strong>Package history:</strong>
<a href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/%%PORT%%/">cvs</a>,
<a href="https://anonhg.NetBSD.org/pkgsrc/file/tip/%%PORT%%/">hg</a>,
<a href="https://github.com/NetBSD/pkgsrc/tree/trunk/%%PORT%%/">git</a></li>
</ul>

<section>
<h2>Build dependencies</h2>
%%BUILD_DEPENDS%%
</section>

<section>
<h2>Runtime dependencies</h2>
%%RUN_DEPENDS%%
</section>

<section>
<h2>Available binary packages</h2>
<table>
%%BIN_PKGS%%
</table>

<p>
Binary packages can be installed with
<a href="../../pkgtools/pkgin/README.html">pkgin</a> or pkg_add(1).

The NetBSD packages collection is also designed to permit
            easy <a href="../../doc/pkgsrc.html">installation from source</a>.
</p>
</section>

<section>
<h2>Available build options</h2>
<dl>
%%OPTIONS%%
</dl>
</section>

<section>
<h2>Known vulnerabilities</h2>
<ul>
%%VULNERABILITIES%%
</ul>
<p>
The <a href="../../pkgtools/pkg_install/README.html">pkg_admin audit</a>
command locates any installed package which has been mentioned in
security advisories as having vulnerabilities.
</p>
<p>
Please note the vulnerabilities database might not be fully accurate,
and not every bug is exploitable with every configuration.
<p>
</section>

<hr noshade>

<p>Problem reports, updates or suggestions for this package should be
reported with
<a href="http://www.NetBSD.org/support/send-pr.html">send-pr.</a></p>

<hr noshade>
[
<a href="../README.html"> Go up one level</a>
|
<a href="../../README.html"> Go to top of packages tree</a>
|
<a href="../../README-all.html"> List all packages</a>
]
</body>
</html>
README.pkg: open details by default might as well fill the screen with something 2021-02-22 09:25:12 +01:00			`<!-- $NetBSD: README.pkg,v 1.35 2021/02/22 08:25:12 nia Exp $ -->`
templates: "Modernize" markup. Add some CSS based on the NetBSD CSS. Verified in Netsurf, lynx, Firefox 78. 2021-02-21 11:15:24 +01:00			`<!doctype html>`
			`<html lang="en">`
Enhance look & feel of the generated README.html's. 1998-02-20 22:49:04 +01:00			`<head>`
templates: "Modernize" markup. Add some CSS based on the NetBSD CSS. Verified in Netsurf, lynx, Firefox 78. 2021-02-21 11:15:24 +01:00			`<meta charset="utf-8">`
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`<link href="../../templates/main.css" rel="stylesheet">`
			`<title>%%PORT%% - The NetBSD Packages Collection</title>`
Remove trailing spaces. 2007-10-09 21:19:08 +02:00			`</head>`
templates: "Modernize" markup. Add some CSS based on the NetBSD CSS. Verified in Netsurf, lynx, Firefox 78. 2021-02-21 11:15:24 +01:00			`<body>`
Initial import of the template files for creating HTML READMEs from the FreeBSD ports collection. 1997-11-21 16:47:44 +01:00
Enhance look & feel of the generated README.html's. 1998-02-20 22:49:04 +01:00			`<a href="http://www.mckusick.com/beastie/mainpage/copyright.html">`
templates: "Modernize" markup. Add some CSS based on the NetBSD CSS. Verified in Netsurf, lynx, Firefox 78. 2021-02-21 11:15:24 +01:00			`<img src="../../templates/pkg-daemon.gif" alt="Daemon Power" id="logo">`
Enhance look & feel of the generated README.html's. 1998-02-20 22:49:04 +01:00			`</a>`
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`<h1><em>%%PORT%%</em> - The NetBSD Packages Collection</h1>`
Initial import of the template files for creating HTML READMEs from the FreeBSD ports collection. 1997-11-21 16:47:44 +01:00
README.pkg: open details by default might as well fill the screen with something 2021-02-22 09:25:12 +01:00			`<details open>`
genreadme: Add DESCR to output. Make history useful for not-CVS-fans. 2021-02-22 06:32:02 +01:00			`<summary><em>%%COMMENT%%</em></summary>`
README.pkg: fix spacing in netsurf, etc 2021-02-22 07:39:00 +01:00			`<p></p> <!-- spacing hack for older browsers with no details support -->`
genreadme: Add DESCR to output. Make history useful for not-CVS-fans. 2021-02-22 06:32:02 +01:00			`<pre>`
			`%%DESCR%%`
			`</pre>`
			`</details>`
Initial import of the template files for creating HTML READMEs from the FreeBSD ports collection. 1997-11-21 16:47:44 +01:00
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`<ul class="package-data">`
			`<li><strong>Source version:</strong> <samp>%%PKG%%</samp></li>`
			`<li><strong>Maintainer:</strong> <em>%%MAINTAINER%%</em></li>`
			`<li><strong>Website:</strong> %%HOMEPAGE%%</li>`
			`<li><strong>License:</strong> %%LICENSE%%</li>`
genreadme: Add DESCR to output. Make history useful for not-CVS-fans. 2021-02-22 06:32:02 +01:00			`<li><strong>Package history:</strong>`
			`<a href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/%%PORT%%/">cvs</a>,`
			`<a href="https://anonhg.NetBSD.org/pkgsrc/file/tip/%%PORT%%/">hg</a>,`
			`<a href="https://github.com/NetBSD/pkgsrc/tree/trunk/%%PORT%%/">git</a></li>`
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`</ul>`
The Grand Homepagification: - New, optional Makefile variable HOMEPAGE, specifies a URL for the home page of the software if it has one. - The value of HOMEPAGE is used to add a link from the README.html files. - pkglint updated to know about it. The "correct" location for HOMEPAGE in the Makefile is after MAINTAINER, in that same section. 1998-08-20 17:16:34 +02:00
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`<section>`
			`<h2>Build dependencies</h2>`
			`%%BUILD_DEPENDS%%`
			`</section>`
Add any licensing information to the README.html files which are generated for each package. 1998-07-22 11:18:46 +02:00
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`<section>`
			`<h2>Runtime dependencies</h2>`
			`%%RUN_DEPENDS%%`
			`</section>`
Initial import of the template files for creating HTML READMEs from the FreeBSD ports collection. 1997-11-21 16:47:44 +01:00
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`<section>`
			`<h2>Available binary packages</h2>`
			`<table>`
			`%%BIN_PKGS%%`
			`</table>`
Note how to report problems, or send updates or suggestions. 2001-03-19 18:44:30 +01:00
templates: "Modernize" markup. Add some CSS based on the NetBSD CSS. Verified in Netsurf, lynx, Firefox 78. 2021-02-21 11:15:24 +01:00			`<p>`
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`Binary packages can be installed with`
			`<a href="../../pkgtools/pkgin/README.html">pkgin</a> or pkg_add(1).`

			`The NetBSD packages collection is also designed to permit`
			`easy <a href="../../doc/pkgsrc.html">installation from source</a>.`
			`</p>`
			`</section>`

			`<section>`
			`<h2>Available build options</h2>`
			`<dl>`
			`%%OPTIONS%%`
			`</dl>`
			`</section>`

			`<section>`
			`<h2>Known vulnerabilities</h2>`
templates: "Modernize" markup. Add some CSS based on the NetBSD CSS. Verified in Netsurf, lynx, Firefox 78. 2021-02-21 11:15:24 +01:00			`<ul>`
Add the glue for showing any security vulnerabilities to the README.html files. 2000-09-19 21:29:11 +02:00			`%%VULNERABILITIES%%`
templates: "Modernize" markup. Add some CSS based on the NetBSD CSS. Verified in Netsurf, lynx, Firefox 78. 2021-02-21 11:15:24 +01:00			`</ul>`
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`<p>`
Tell users to use "pkg_admin audit" instead of audit-packages. 2010-03-18 11:18:19 +01:00			`The <a href="../../pkgtools/pkg_install/README.html">pkg_admin audit</a>`
			`command locates any installed package which has been mentioned in`
README.pkg: be more realistic about CVEs in the age of fuzzing 2021-02-18 11:44:07 +01:00			`security advisories as having vulnerabilities.`
templates: "Modernize" markup. Add some CSS based on the NetBSD CSS. Verified in Netsurf, lynx, Firefox 78. 2021-02-21 11:15:24 +01:00			`</p>`
Initial import of the template files for creating HTML READMEs from the FreeBSD ports collection. 1997-11-21 16:47:44 +01:00			`<p>`
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`Please note the vulnerabilities database might not be fully accurate,`
			`and not every bug is exploitable with every configuration.`
Add a list of options to generated README.html files. Patch from Daniel Loffgren on tech-pkg, slightly modified by me to use dl tags. 2015-10-03 15:17:57 +02:00			`<p>`
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`</section>`
Add a list of options to generated README.html files. Patch from Daniel Loffgren on tech-pkg, slightly modified by me to use dl tags. 2015-10-03 15:17:57 +02:00
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`<hr noshade>`
Add "click here to download"-links, s/port/package/, plus some cosmetics. 1998-05-25 02:06:36 +02:00
genreadme: Re-order package summary and attempt to present it better. - Add a maintainer field. - Use lists and sections to separate information. - Make license information a hyperlink. - Move available build options and vulnerabilities listings to the bottom, as they tend to use up a lot of space and create reader fatigue. - Correct stylesheet paths. 2021-02-22 06:10:18 +01:00			`<p>Problem reports, updates or suggestions for this package should be`
			`reported with`
			`<a href="http://www.NetBSD.org/support/send-pr.html">send-pr.</a></p>`
Add "click here to download"-links, s/port/package/, plus some cosmetics. 1998-05-25 02:06:36 +02:00
Enhance look & feel of the generated README.html's. 1998-02-20 22:49:04 +01:00			`<hr noshade>`
			`[`
Initial import of the template files for creating HTML READMEs from the FreeBSD ports collection. 1997-11-21 16:47:44 +01:00			`<a href="../README.html"> Go up one level</a>`
			`\|`
Add NetBSD RCS Ids. Change wording to reflect that this is the NetBSD packages collection. 1997-11-21 16:56:50 +01:00			`<a href="../../README.html"> Go to top of packages tree</a>`
Collect information from pkgsrc/*/README.html into one long list (README-all.html), and reference this file. 1999-08-22 03:30:15 +02:00			`\|`
			`<a href="../../README-all.html"> List all packages</a>`
Enhance look & feel of the generated README.html's. 1998-02-20 22:49:04 +01:00			`]`
Initial import of the template files for creating HTML READMEs from the FreeBSD ports collection. 1997-11-21 16:47:44 +01:00			`</body>`
			`</html>`