xref: /freebsd/usr.bin/gcore/gcore.1 (revision 8e537d168674d6b65869f73c20813001af875738)
1.\" Copyright (c) 1983, 1990, 1992, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)gcore.1	8.2 (Berkeley) 4/18/94
33.\"
34.Dd "April 18, 1994"
35.Dt GCORE 1
36.Os BSD 4.2
37.Sh NAME
38.Nm gcore
39.Nd get core images of running process
40.Sh SYNOPSIS
41.Nm gcore
42.Op Fl s
43.Op Fl c Ar core
44.Ar exec pid
45.Sh DESCRIPTION
46.Nm Gcore
47creates a core image of the specified process,
48suitable for use with
49.Xr gdb  1 .
50By default, the core is written to the file
51.Dq Pa core.<pid> .
52Both the executable image,
53.Ar exec ,
54and the process identifier,
55.Ar pid ,
56must be given on the command line.
57.Pp
58The options are:
59.Bl -tag -width indent
60.It Fl c
61Write the core file to the specified file instead of
62.Dq Pa core.<pid> .
63.It Fl s
64Stop the process while gathering the core image, and resume it
65when done.  This guarantees that the resulting core dump will
66be in a consistent state.  The process is resumed even if it was
67already stopped.
68The same effect can be achieved manually with
69.Xr kill 1 .
70.El
71.Sh FILES
72.Bl -tag -width /var/log/messages -compact
73.It Pa core.<pid>
74The core image.
75.EL
76.Dp
77.Sh HISTORY
78.Nm Gcore
79appeared in
80.Bx 4.2 .
81.Sh BUGS
82Context switches or paging activity that occur while
83.Nm gcore
84is running may cause the program to become confused.
85For best results, use -s to temporarily stop the target process.
86.Pp
87.Nm Gcore
88is not compatible with the original
89.Bx 4.2
90version.
91In particular,
92.Bx 4.4
93requires the
94.Ar exec
95argument.
96