summaryrefslogtreecommitdiff
path: root/pkgtools/url2pkg/files/url2pkg.8
blob: 7662264665defa2d92bef9a726143578343a2131 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
.\"	$NetBSD: url2pkg.8,v 1.10 2013/05/29 14:37:29 wiz 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 May 29, 2013
.Dt URL2PKG 8
.Os
.Sh NAME
.Nm url2pkg
.Nd Automatic pkgsrc 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 its job.
.Pp
.Nm
is intended to help starting to create a package;
it is not intended to fly on autopilot, though.
.Pp
The
.Pa Makefile
contains all the required variables, 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 ENVIRONMENT
.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 EXAMPLES
The following command will generate a template pkgsrc package
for the software that can be found at
.Lk http://www.example.com/bar/buz.tgz :
.Bd -literal
url2pkg http://www.example.com/bar/buz.tgz
.Ed
.Sh SEE ALSO
.Xr pkgsrc 7
.Sh AUTHORS
.Nm
was written by
.An Roland Illig Aq rillig@NetBSD.org ,
enhancing the previous version by
.An Hubert Feyrer Aq hubertf@NetBSD.org .
This man page was written by
.An Emmanuel Dreyfus Aq manu@NetBSD.org .