Remove __P macros from src/usr.bin and src/usr.sbin.
[dragonfly.git] / usr.bin / gcore / gcore.1
CommitLineData
984263bc
MD
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: src/usr.bin/gcore/gcore.1,v 1.8.2.5 2002/07/15 06:25:27 keramida Exp $
1de703da 34.\" $DragonFly: src/usr.bin/gcore/gcore.1,v 1.2 2003/06/17 04:29:27 dillon Exp $
984263bc
MD
35.\"
36.Dd April 18, 1994
37.Dt GCORE 1
38.Os
39.Sh NAME
40.Nm gcore
41.Nd get core images of running process
42.Sh SYNOPSIS
43.Nm
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.
59If no executable image is
60specified,
61.Nm
62will use
63.Dq Pa /proc/<pid>/file .
64.Pp
65The following options are available:
66.Bl -tag -width indent
67.It Fl c
68Write the core file to the specified file instead of
69.Dq Pa core.<pid> .
70.It Fl s
71Stop the process while gathering the core image, and resume it
72when done. This guarantees that the resulting core dump will
73be in a consistent state. The 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.It Pa /proc/<pid>/file
83the executable image
84.El
85.Sh HISTORY
86A
87.Nm
88utility appeared in
89.Bx 4.2 .
90.Sh BUGS
91Context switches or paging activity that occur while
92.Nm
93is running may cause the program to become confused.
94For best results, use
95.Fl s
96to temporarily stop the target process.
97.Pp
98The
99.Nm
100utility is not compatible with the original
101.Bx 4.2
102version.