xref: /netbsd-src/usr.bin/gcore/gcore.1 (revision e5548b402ae4c44fb816de42c7bba9581ce23ef5)
1.\"     $NetBSD: gcore.1,v 1.12 2005/01/11 09:46:17 wiz 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.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.\"
38.Dd January 9, 2005
39.Dt GCORE 1
40.Os
41.Sh NAME
42.Nm gcore
43.Nd get core images of running process
44.Sh SYNOPSIS
45.Nm
46.Op Fl c Ar corename
47.Ar pid
48.Op Ar pid ...
49.Sh DESCRIPTION
50.Nm
51creates a core image of the specified processes
52suitable for use with
53.Xr gdb  1 .
54By default, the core is written to the file
55.Dq Pa \*[Lt]progname\*[Gt].core ,
56where
57.Dq Aq Pa progname
58is the program name of the process corresponding to the pid that is given on
59the command line.
60This filename can be changed by supplying the
61.Fl c Ar corename
62argument, or setting
63.Dq Pa proc.\*[Lt]pid\*[Gt].corename
64with
65.Xr sysctl 8 .
66.Sh FILES
67.Bl -tag -width /var/log/messages -compact
68.It Pa \*[Lt]progname\*[Gt].core
69The core image.
70.El
71.Sh SEE ALSO
72.Xr gdb 1 ,
73.Xr sysctl 8
74.Sh HISTORY
75.Nm
76appeared in BSD 4.2, disappeared in
77.Nx 1.2 ,
78and reappeared in
79.Nx 2.0 .
80.Sh BUGS
81The process is not stopped while the core file is generated, so it might
82not be consistent.
83