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