xref: /freebsd/usr.bin/gcore/gcore.1 (revision 3898680cf705cef4e1cc606b44cd91fc4252bcd5)
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.\" $FreeBSD$
34.\"
35.Dd April 18, 1994
36.Dt GCORE 1
37.Os
38.Sh NAME
39.Nm gcore
40.Nd get core images of running process
41.Sh SYNOPSIS
42.Nm
43.Op Fl s
44.Op Fl c Ar core
45.Op Ar executable
46.Ar pid
47.Sh DESCRIPTION
48The
49.Nm
50utility creates a core image of the specified process,
51suitable for use with
52.Xr gdb  1 .
53By default, the core is written to the file
54.Dq Pa core.<pid> .
55The process identifier,
56.Ar pid ,
57must be given on the command line.
58If no executable image is
59specified,
60.Nm
61will use
62.Dq Pa /proc/<pid>/file .
63.Pp
64The following options are available:
65.Bl -tag -width indent
66.It Fl c
67Write the core file to the specified file instead of
68.Dq Pa core.<pid> .
69.It Fl s
70Stop the process while gathering the core image, and resume it
71when done.  This guarantees that the resulting core dump will
72be in a consistent state.  The process is resumed even if it was
73already stopped.
74The same effect can be achieved manually with
75.Xr kill 1 .
76.El
77.Sh FILES
78.Bl -tag -width /var/log/messages -compact
79.It Pa core.<pid>
80the core image
81.It Pa /proc/<pid>/file
82the executable image
83.El
84.Sh HISTORY
85A
86.Nm
87utility appeared in
88.Bx 4.2 .
89.Sh BUGS
90Context switches or paging activity that occur while
91.Nm
92is running may cause the program to become confused.
93For best results, use
94.Fl s
95to temporarily stop the target process.
96.Pp
97The
98.Nm
99utility is not compatible with the original
100.Bx 4.2
101version.
102