xref: /openbsd/share/man/man1/build-debug-info.1 (revision 73471bf0)
1.\"	$OpenBSD: build-debug-info.1,v 1.3 2021/03/01 17:56:16 jmc Exp $
2.\"
3.\" Copyright (c) 2019 Marc Espie <espie@openbsd.org>
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: March 1 2021 $
18.Dt BUILD-DEBUG-INFO 1
19.Os
20.Sh NAME
21.Nm build-debug-info
22.Nd generate packing-lists and Makefiles for debug packages
23.Sh SYNOPSIS
24.Ev PORTSDIR Ns = Ns Ar path
25.Nm
26.Op Fl mnqvx
27.Fl P Ar pkgdir
28.Fl -
29.Ar pkg_create_args ...
30.Sh DESCRIPTION
31.Nm
32is a helper script for generating debug package information in
33.Xr bsd.port.mk 5 ,
34with similar calling conventions to
35.Xr update-plist 1 .
36.Pp
37Along with options and environment variables,
38.Nm
39uses the exact same options and arguments that would be passed to
40.Xr pkg_create 1 .
41Since
42.Xr pkg_create 1
43normally takes one single actual
44.Ar pkgname ,
45there is no ambiguity in
46.Ev MULTI_PACKAGES
47situations.
48.Pp
49The first set of arguments correspond to the
50.Sq default package .
51.Pp
52The options are as follows:
53.Bl -tag -width Ds
54.It Fl P Ar pkgdir
55directory used  for generating output (mandatory).
56.It Fl q
57Quiet mode.
58Do not display status progress messages.
59Note that this is not the opposite of verbose mode.
60.It Fl v
61Verbose mode.
62Explain about directories stripped from dependencies.
63Note that this is not the opposite of quiet mode.
64.El
65.Pp
66.Nm
67will read each packing-list
68.Ar list
69and generate a corresponding
70.Ar debug-list
71under
72.Ar pkgdir .
73.Pp
74The full list of Makefile rules needed to generate those files and
75directories will be written as
76.Ar pkgdir/Makefile .
77.Sh SEE ALSO
78.Xr pkg_add 1 ,
79.Xr pkg_create 1 ,
80.Xr update-plist 1 ,
81.Xr bsd.port.mk 5
82