From 4a2f9bba6e648daaff6615cbb6478c7eb371d11f Mon Sep 17 00:00:00 2001 From: manu Date: Sun, 28 Jan 2001 23:30:24 +0000 Subject: Added a man page for url2pkg --- pkgtools/url2pkg/files/url2pkg.8 | 123 +++++++++++++++++++++++++++++++++++++++ pkgtools/url2pkg/pkg/PLIST | 3 +- 2 files changed, 125 insertions(+), 1 deletion(-) create mode 100644 pkgtools/url2pkg/files/url2pkg.8 (limited to 'pkgtools/url2pkg') diff --git a/pkgtools/url2pkg/files/url2pkg.8 b/pkgtools/url2pkg/files/url2pkg.8 new file mode 100644 index 00000000000..dbc24683fb6 --- /dev/null +++ b/pkgtools/url2pkg/files/url2pkg.8 @@ -0,0 +1,123 @@ +.\" $NetBSD: url2pkg.8,v 1.1 2001/01/28 23:30:24 manu Exp $ +.\" +.\" Copyright (c) 2001 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Emmanuel Dreyfus. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the NetBSD +.\" Foundation, Inc. and its contributors. +.\" 4. Neither the name of The NetBSD Foundation nor the names of its +.\" contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd January 28, 2001 +.Dt URL2PKG 8 +.Os +.Sh NAME +.Nm url2pkg +.Nd Automatic NetBSD package generator +.Sh SYNOPSIS +.Nm +.Op Ar URL +.Sh DESCRIPTION +.Nm +takes the +.Ar URL +to a package's distfile that should be +turned into a package. The +generated package includes a +.Pa Makefile +and a basic set of files to get the +package going. Any customisations to get the package going need to be +adjusted manually after +.Nm +has finished it's job. +.Pp +.Nm +is intended to help starting to created a package, it is not +intended to fly on autopilot, though. +.Pp +The +.Pa Makefile +contains all the requiered variable, such as DISTNAME or MASTER_SITES, but some of them cannot be automatically set. Hence, the user's usual editor is invoked to edit the +.Pa Makefile. +.Pp +After the +.Pa Makefile +is completed, +.Nm +fetches the archive, and computes its checksum via the +.Ic make makesum +target. Then archive extraction is done, via the +.Ic make extract +target, and finally, +.Nm +attempts to detect if +the software uses a +.Ic configure +script, and if it's from GNU +.Ic autoconf. +.Pp +If the user does not supply the +.Ar URL +on the command line, then +.Nm +will prompt for it. +.Sh EXAMPLES +.Nm +.Ar http://www.foo.com/bar/buz.tgz +.Pp +Will generate a template NetBSD package for the software that can be found at +.Ar http://www.foo.com/bar/buz.tgz +.Sh ENVIRONMENTAL VARIABLES +.Bl -tag -width indent +.It PKGEDITOR, EDITOR +Editor used for +.Pa Makefile +edition. +.It PKGMAINTAINER, REPLYTO +Name used for the MAINTAINER field in the package +.Pa Makefile. +.El +.Sh BUGS +.Nm +does not generate an empty +.Pa patches +directory +.Sh AUTHOR(S) +.Nm +was written by +.An Hubert Feyrer Aq hubertf@netbsd.org +.br +This man page was written by +.An Emmanuel Dreyfus Aq manu@netbsd.org +.Sh SEE ALSO +.Xr package 7 +.br +.Em "Documentation on the NetBSD Package System", +.An Hubert Feyrer Aq hubertf@netbsd.org +.An Alistair Crooks Aq agc@pkgsrc.org diff --git a/pkgtools/url2pkg/pkg/PLIST b/pkgtools/url2pkg/pkg/PLIST index a4bbd3cfa0b..ec29289c704 100644 --- a/pkgtools/url2pkg/pkg/PLIST +++ b/pkgtools/url2pkg/pkg/PLIST @@ -1,2 +1,3 @@ -@comment $NetBSD: PLIST,v 1.1.1.1 1999/05/06 04:24:11 hubertf Exp $ +@comment $NetBSD: PLIST,v 1.2 2001/01/28 23:30:26 manu Exp $ bin/url2pkg +man/man8/url2pkg.8 -- cgit v1.2.3