xref: /netbsd/usr.bin/gcore/gcore.1 (revision 6550d01e)
1.\"     $NetBSD: gcore.1,v 1.13 2008/04/30 13:11:01 martin Exp $
2.\"
3.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Christos Zoulas.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\"
31.Dd January 9, 2005
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 c Ar corename
40.Ar pid
41.Op Ar pid ...
42.Sh DESCRIPTION
43.Nm
44creates a core image of the specified processes
45suitable for use with
46.Xr gdb  1 .
47By default, the core is written to the file
48.Dq Pa \*[Lt]progname\*[Gt].core ,
49where
50.Dq Aq Pa progname
51is the program name of the process corresponding to the pid that is given on
52the command line.
53This filename can be changed by supplying the
54.Fl c Ar corename
55argument, or setting
56.Dq Pa proc.\*[Lt]pid\*[Gt].corename
57with
58.Xr sysctl 8 .
59.Sh FILES
60.Bl -tag -width /var/log/messages -compact
61.It Pa \*[Lt]progname\*[Gt].core
62The core image.
63.El
64.Sh SEE ALSO
65.Xr gdb 1 ,
66.Xr sysctl 8
67.Sh HISTORY
68.Nm
69appeared in BSD 4.2, disappeared in
70.Nx 1.2 ,
71and reappeared in
72.Nx 2.0 .
73.Sh BUGS
74The process is not stopped while the core file is generated, so it might
75not be consistent.
76