Sat May 4 13:11:41 2024 UTC (15d)
Document environment variable use.


(christos)
diff -r1.3 -r1.4 src/external/cddl/osnet/usr.bin/ctfmerge/ctfmerge.1
cvs diff -r1.3 -r1.4 src/external/cddl/osnet/usr.bin/ctfmerge/ctfmerge.1 (expand / switch to unified diff)

--- src/external/cddl/osnet/usr.bin/ctfmerge/ctfmerge.1 2018/05/28 21:05:11 1.3
+++ src/external/cddl/osnet/usr.bin/ctfmerge/ctfmerge.1 2024/05/04 13:11:41 1.4
@@ -1,13 +1,14 @@ @@ -1,13 +1,14 @@
 1.\" $NetBSD: ctfmerge.1,v 1.4 2024/05/04 13:11:41 christos Exp $
1.\" 2.\"
2.\" Copyright (c) 2010 The FreeBSD Foundation  3.\" Copyright (c) 2010 The FreeBSD Foundation
3.\" All rights reserved.  4.\" All rights reserved.
4.\"  5.\"
5.\" This software was developed by Rui Paulo under sponsorship from the 6.\" This software was developed by Rui Paulo under sponsorship from the
6.\" FreeBSD Foundation.  7.\" FreeBSD Foundation.
7.\"  8.\"
8.\" Redistribution and use in source and binary forms, with or without  9.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions  10.\" modification, are permitted provided that the following conditions
10.\" are met:  11.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright  12.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.  13.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright  14.\" 2. Redistributions in binary form must reproduce the above copyright
@@ -18,27 +19,27 @@ @@ -18,27 +19,27 @@
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE  19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE  20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE  21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL  22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS  23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)  24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT  25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY  26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF  27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.  28.\" SUCH DAMAGE.
28.\" 29.\"
29.\" $FreeBSD: head/cddl/usr.bin/ctfmerge/ctfmerge.1 239969 2012-09-01 06:23:13Z joel $ 30.\" $FreeBSD: head/cddl/usr.bin/ctfmerge/ctfmerge.1 239969 2012-09-01 06:23:13Z joel $
30.\" 31.\"
31.Dd July 7, 2010 32.Dd May 4, 2024
32.Dt CTFMERGE 1 33.Dt CTFMERGE 1
33.Os 34.Os
34.Sh NAME 35.Sh NAME
35.Nm ctfmerge 36.Nm ctfmerge
36.Nd merge several CTF data sections into one 37.Nd merge several CTF data sections into one
37.Sh SYNOPSIS 38.Sh SYNOPSIS
38.Nm 39.Nm
39.Op Fl fgstv 40.Op Fl fgstv
40.Fl l Ar label 41.Fl l Ar label
41.Fl L Ar labelenv 42.Fl L Ar labelenv
42.Fl o Ar outfile 43.Fl o Ar outfile
43file ... 44file ...
44.Nm 45.Nm
@@ -96,25 +97,47 @@ Uniquify against @@ -96,25 +97,47 @@ Uniquify against
96.Ar uniqfile . 97.Ar uniqfile .
97.It Fl d Ar uniqlabel 98.It Fl d Ar uniqlabel
98Uniquify against label 99Uniquify against label
99.Ar uniqlabel 100.Ar uniqlabel
100.It Fl w Ar withfile 101.It Fl w Ar withfile
101Additive merge with 102Additive merge with
102.Ar withfile . 103.Ar withfile .
103.It Fl c Ar srcfile Ar destfile 104.It Fl c Ar srcfile Ar destfile
104Copy CTF data from 105Copy CTF data from
105.Ar srcfile 106.Ar srcfile
106into 107into
107.Ar destfile . 108.Ar destfile .
108.El 109.El
 110.Sh ENVIRONMENT VARIABLES
 111The following environment variables are used in
 112.Nm :
 113.Bl -tag -width x
 114.It CTFMERGE_TERMINATE_NO_UNLINK
 115Don't remove temporary files on exit, so that they can be examined
 116for debugging.
 117.It CTFMERGE_MAX_SLOTS
 118Number of round-robin slots in the input queue that it is processed by
 119worker threads.
 120Each slot represents a file batch (default 5).
 121.It CTFMERGE_PHASE1_BATCH_SIZE
 122Number of files in a slot that are needed before processing starts (default 8).
 123.It CTFMERGE_NUM_THREADS
 124Set the number of worker threads.
 125If the number of processors can be determined it defaults to
 126min(processors * 3 / 2, nslots), if not it defaults to 2.
 127.It CTFMERGE_INPUT_THROTTLE
 128Max queue size to queue (defaults to 10).
 129.It CTFMERGE_DEBUG_LEVEL
 130Increase debugging verbosity (maximum is 3).
 131.El
109.Sh EXIT STATUS 132.Sh EXIT STATUS
110.Ex -std 133.Ex -std
111.Sh SEE ALSO 134.Sh SEE ALSO
112.Xr ctfconvert 1 , 135.Xr ctfconvert 1 ,
113.Xr ctfdump 1 136.Xr ctfdump 1
114.Sh HISTORY 137.Sh HISTORY
115The 138The
116.Nm 139.Nm
117utility first appeared in 140utility first appeared in
118.Fx 7.0 . 141.Fx 7.0 .
119.Sh AUTHORS 142.Sh AUTHORS
120The CTF utilities came from OpenSolaris. 143The CTF utilities came from OpenSolaris.