xref: /dragonfly/usr.bin/gcore/gcore.1 (revision 3170ffd7)
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: src/usr.bin/gcore/gcore.1,v 1.8.2.5 2002/07/15 06:25:27 keramida Exp $
30.\" $DragonFly: src/usr.bin/gcore/gcore.1,v 1.2 2003/06/17 04:29:27 dillon Exp $
31.\"
32.Dd April 18, 1994
33.Dt GCORE 1
34.Os
35.Sh NAME
36.Nm gcore
37.Nd get core images of running process
38.Sh SYNOPSIS
39.Nm
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.
55If no executable image is
56specified,
57.Nm
58will use
59.Dq Pa /proc/<pid>/file .
60.Pp
61The following options are available:
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.Sh HISTORY
82A
83.Nm
84utility appeared 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
94The
95.Nm
96utility is not compatible with the original
97.Bx 4.2
98version.
99