xref: /openbsd/share/man/man1/portimport.1 (revision 09467b48)
1.\"     $OpenBSD: portimport.1,v 1.1 2018/06/26 05:38:49 espie Exp $
2.\"
3.\" Copyright (c) 2013 Robert Peichaer
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: June 26 2018 $
18.Dt PORTIMPORT 1
19.Os
20.Sh NAME
21.Nm portimport
22.Nd import a new port to the ports cvs repository
23.Sh SYNOPSIS
24.Nm
25.Op Fl p Ar portsdir
26.Op Fl u Ar username
27.Sh DESCRIPTION
28.Nm
29is used to import the directories and files of a new port to the
30.Ox
31ports
32.Xr cvs 1
33repository, avoiding common mistakes.
34It has to be executed from within the new port's directory.
35.Pp
36.Nm
37calls the
38.Xr portcheck 1
39internally to verify that directory and file structure for a port is in
40place and that no bogus files exist, and also to detect the
41.Ev PKGPATH
42for a port.
43.Pp
44The import is done in two steps.
45In the first step, the
46.Fl n
47option of the cvs command is used to only check for possible problems
48without changing anything and shows the cvs path where the new port will
49be imported.
50In the second step, the current ports directory is imported to the
51.Ox
52ports cvs repository.
53After the import, the new port is checked out in the respective directory
54of the local ports tree.
55.Pp
56The following options are available:
57.Bl -tag -width Ds
58.It Fl p Ar portsdir
59Forces the given directory to be treated as ports root directory.
60Passed through to
61.Xr portcheck 1 .
62.It Fl u Ar username
63Set the username used for
64.Xr ssh 1 ,
65and to compose vendor and release tags.
66Defaults to the local username.
67.El
68.Sh SEE ALSO
69.Xr cvs 1 ,
70.Xr portcheck 1
71.Sh HISTORY
72This command is based on the portimport script of Marc Espie, lightly
73modified by Stuart Henderson and rewritten by Robert Peichaer.
74Later, actual checks were moved to a separate utility,
75.Xr portcheck 1 .
76.Sh CAVEATS
77The
78.Ev CVSROOT
79environment variable is not used.
80