Annotation of src/usr.bin/gcore/gcore.1, Revision 1.1
1.1 ! deraadt 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: .\" $NetBSD: gcore.1,v 1.2 1995/09/05 02:50:58 tls Exp $
! 34: .\"
! 35: .Dd "April 18, 1994"
! 36: .Dt GCORE 1
! 37: .Os BSD 4.2
! 38: .Sh NAME
! 39: .Nm gcore
! 40: .Nd get core images of running process
! 41: .Sh SYNOPSIS
! 42: .Nm gcore
! 43: .Op Fl s
! 44: .Op Fl c Ar core
! 45: .Ar exec pid
! 46: .Sh DESCRIPTION
! 47: .Nm Gcore
! 48: creates a core image of the specified process,
! 49: suitable for use with
! 50: .Xr gdb 1 .
! 51: By default, the core is written to the file
! 52: .Dq Pa core.<pid> .
! 53: Both the executable image,
! 54: .Ar exec ,
! 55: and the process identifier,
! 56: .Ar pid ,
! 57: must be given on the command line.
! 58: .Pp
! 59: The options are:
! 60: .Bl -tag -width indent
! 61: .It Fl c
! 62: Write the core file to the specified file instead of
! 63: .Dq Pa core.<pid> .
! 64: .It Fl s
! 65: Stop the process while gathering the core image, and resume it
! 66: when done. This guarantees that the resulting core dump will
! 67: be in a consistent state. The process is resumed even if it was
! 68: already stopped.
! 69: The same effect can be achieved manually with
! 70: .Xr kill 1 .
! 71: .El
! 72: .Sh FILES
! 73: .Bl -tag -width /var/log/messages -compact
! 74: .It Pa core.<pid>
! 75: The core image.
! 76: .EL
! 77: .Dp
! 78: .Sh HISTORY
! 79: .Nm Gcore
! 80: appeared in 4.2BSD.
! 81: .Sh BUGS
! 82: Context switches or paging activity that occur while
! 83: .Nm gcore
! 84: is running may cause the program to become confused.
! 85: For best results, use -s to temporarily stop the target process.
! 86: .Pp
! 87: .Nm Gcore
! 88: is not compatible with the original 4.2BSD version.
! 89: In particular, 4.4BSD requires the
! 90: .Ar exec
! 91: argument.