xref: /freebsd/usr.bin/gcore/gcore.1 (revision e28a4053)
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 July 14, 2010
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 f
44.Op Fl s
45.Op Fl c Ar core
46.Op Ar executable
47.Ar pid
48.Sh DESCRIPTION
49The
50.Nm
51utility creates a core image of the specified process,
52suitable for use with
53.Xr gdb 1 .
54By default, the core is written to the file
55.Dq Pa core.<pid> .
56The process identifier,
57.Ar pid ,
58must be given on the command line.
59.Pp
60The following options are available:
61.Bl -tag -width indent
62.It Fl c
63Write the core file to the specified file instead of
64.Dq Pa core.<pid> .
65.It Fl f
66Dumps all the available segments, excluding only the malformed ones and
67un-dumpable ones. Unlike the default invocation, it also dumps
68device- and sglist-mapped areas that may invalidate the state of
69some transactions. This flag must be used very carefully, when the
70behavior of the application is fully understood and the fallouts can
71be easily controlled.
72.It Fl s
73Stop the process while gathering the core image, and resume it
74when done.
75This guarantees that the resulting core dump will
76be in a consistent state.
77The process is resumed even if it was
78already stopped.
79The same effect can be achieved manually with
80.Xr kill 1 .
81.El
82.Sh FILES
83.Bl -tag -width /var/log/messages -compact
84.It Pa core.<pid>
85the core image
86.El
87.Sh HISTORY
88A
89.Nm
90utility appeared in
91.Bx 4.2 .
92.Sh BUGS
93Because of the
94.Xr ptrace 2
95usage
96.Nm
97may not work with processes which are actively investigated with
98.Xr truss 1
99or
100.Xr gdb 1 .
101Additionally, interruptable sleeps may exit with EINTR.
102.Pp
103The
104.Nm
105utility is not compatible with the original
106.Bx 4.2
107version.
108