xref: /freebsd/usr.bin/gcore/gcore.1 (revision 0e1497aefd602cea581d2380d22e67dfdcac6b4e)
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.\" 4. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)gcore.1	8.2 (Berkeley) 4/18/94
29.\" $FreeBSD$
30.\"
31.Dd July 14, 2010
32.Dt GCORE 1
33.Os
34.Sh NAME
35.Nm gcore
36.Nd get core images of running process
37.Sh SYNOPSIS
38.Nm
39.Op Fl f
40.Op Fl s
41.Op Fl c Ar core
42.Op Ar executable
43.Ar pid
44.Sh DESCRIPTION
45The
46.Nm
47utility creates 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> .
52The process identifier,
53.Ar pid ,
54must be given on the command line.
55.Pp
56The following options are available:
57.Bl -tag -width indent
58.It Fl c
59Write the core file to the specified file instead of
60.Dq Pa core.<pid> .
61.It Fl f
62Dumps all the available segments, excluding only the malformed ones and
63un-dumpable ones. Unlike the default invocation, it also dumps
64device- and sglist-mapped areas that may invalidate the state of
65some transactions. This flag must be used very carefully, when the
66behavior of the application is fully understood and the fallouts can
67be easily controlled.
68.It Fl s
69Stop the process while gathering the core image, and resume it
70when done.
71This guarantees that the resulting core dump will
72be in a consistent state.
73The process is resumed even if it was
74already stopped.
75The same effect can be achieved manually with
76.Xr kill 1 .
77.El
78.Sh FILES
79.Bl -tag -width /var/log/messages -compact
80.It Pa core.<pid>
81the core image
82.El
83.Sh HISTORY
84A
85.Nm
86utility appeared in
87.Bx 4.2 .
88.Sh BUGS
89Because of the
90.Xr ptrace 2
91usage
92.Nm
93may not work with processes which are actively investigated with
94.Xr truss 1
95or
96.Xr gdb 1 .
97Additionally, interruptable sleeps may exit with EINTR.
98.Pp
99The
100.Nm
101utility is not compatible with the original
102.Bx 4.2
103version.
104