xref: /openbsd/share/man/man1/portgen.1 (revision 771fbea0)
1.\" $OpenBSD: portgen.1,v 1.5 2021/03/23 13:22:16 abieber Exp $
2.\"
3.\" Copyright (c) 2015 Giannis Tsaraias <tsg@openbsd.org>
4.\" Copyright (c) 2015 Vadim Zhukov <zhuk@openbsd.org>
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd $Mdocdate: March 23 2021 $
19.Dt PORTGEN 1
20.Os
21.Sh NAME
22.Nm portgen
23.Nd port modules on the fly
24.Sh SYNOPSIS
25.Nm portgen
26.Ar type
27.Ar module-name
28.Sh DESCRIPTION
29The
30.Nm
31utility creates ports for the given
32.Ar module-name
33from
34.Ar type
35module framework.
36The module is downloaded, analyzed and translated into a port.
37Any missing dependencies are handled recursively.
38New ports will land under ${PORTSDIR}/mystuff.
39The
40.Ev PORTSDIR
41value will be taken from current user environment, and defaults to
42.Pa /usr/ports .
43.Pp
44The
45.Nm
46utility currently supports the following
47.Ar type
48values:
49.Pp
50.Bl -inset -offset indent -compact
51.It Cm p5
52for Perl modules on CPAN.
53.It Cm py
54for Python modules on PyPI.
55.It Cm ruby
56for Ruby gems.
57.It Cm go
58for Go modules.
59.El
60.Pp
61A
62.Cm go
63module may be used with an
64.Ar @version
65suffix to specify a tag or branch to port.
66The default suffix is
67.Ar @latest ,
68which is interpreted as the latest release.
69.Pp
70The following packages must be installed prior to the invocation of
71.Nm :
72.Pp
73.Bl -item -offset indent -compact
74.It
75.Cm sqlports
76.It
77.Cm p5-DBI
78.It
79.Cm p5-DBD-SQLite
80.El
81.Sh EXIT STATUS
82.Ex -std
83.Sh EXAMPLES
84The following command will download the latest version of Config::AutoConf
85from CPAN, parse it and create a port for it:
86.Bd -ragged -offset indent
87.Nm
88p5 Config::AutoConf
89.Ed
90.Sh SEE ALSO
91.Xr port-modules 5 ,
92.Xr ports 7
93.Sh HISTORY
94The
95.Nm
96utility first appeared in
97.Ox 5.9
98as a result of Google Summer of Code 2015.
99.Sh AUTHORS
100.An Giannis Tsaraias Aq Mt tsg@openbsd.org
101.Sh CAVEATS
102Not every module could be converted to a port.
103