usr.bin/gcore/gcore.1

   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. 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 .\"
  31 .Dd April 18, 1994
  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 s
  40 .Op Fl c Ar core
  41 .Op Ar executable
  42 .Ar pid
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility creates a core image of the specified process,
  47 suitable for use with
  48 .Xr gdb 1 .
  49 By default, the core is written to the file
  50 .Dq Pa core.<pid> .
  51 The process identifier,
  52 .Ar pid ,
  53 must be given on the command line.
  54 If no executable image is
  55 specified,
  56 .Nm
  57 will use
  58 .Dq Pa /proc/<pid>/file .
  59 .Pp
  60 The following options are available:
  61 .Bl -tag -width indent
  62 .It Fl c
  63 Write the core file to the specified file instead of
  64 .Dq Pa core.<pid> .
  65 .It Fl s
  66 Stop the process while gathering the core image, and resume it
  67 when done.  This guarantees that the resulting core dump will
  68 be in a consistent state.  The process is resumed even if it was
  69 already stopped.
  70 The same effect can be achieved manually with
  71 .Xr kill 1 .
  72 .El
  73 .Sh FILES
  74 .Bl -tag -width /var/log/messages -compact
  75 .It Pa core.<pid>
  76 the core image
  77 .It Pa /proc/<pid>/file
  78 the executable image
  79 .El
  80 .Sh HISTORY
  81 A
  82 .Nm
  83 utility appeared in
  84 .Bx 4.2 .
  85 .Sh BUGS
  86 Context switches or paging activity that occur while
  87 .Nm
  88 is running may cause the program to become confused.
  89 For best results, use
  90 .Fl s
  91 to temporarily stop the target process.
  92 .Pp
  93 The
  94 .Nm
  95 utility is not compatible with the original
  96 .Bx 4.2
  97 version.