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