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. 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$
  34 .\"
  35 .Dd July 14, 2010
  36 .Dt GCORE 1
  37 .Os
  38 .Sh NAME
  39 .Nm gcore
  40 .Nd get core images of running process
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl f
  44 .Op Fl s
  45 .Op Fl c Ar core
  46 .Op Ar executable
  47 .Ar pid
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility creates a core image of the specified process,
  52 suitable for use with
  53 .Xr gdb 1 .
  54 By default, the core is written to the file
  55 .Dq Pa core.<pid> .
  56 The process identifier,
  57 .Ar pid ,
  58 must be given on the command line.
  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 f
  66 Dumps all available segments, excluding only malformed and undumpable segments.
  67 Unlike the default invocation, this flag dumps mappings of devices which
  68 may invalidate the state of device transactions or trigger other unexpected
  69 behavior.
  70 As a result, this flag should only be used when the behavior of the
  71 application and any devices it has mapped is fully understood and any side
  72 effects can be controlled or tolerated.
  73 .It Fl s
  74 Stop the process while gathering the core image, and resume it
  75 when done.
  76 This guarantees that the resulting core dump will
  77 be in a consistent state.
  78 The process is resumed even if it was
  79 already stopped.
  80 The same effect can be achieved manually with
  81 .Xr kill 1 .
  82 .El
  83 .Sh FILES
  84 .Bl -tag -width /var/log/messages -compact
  85 .It Pa core.<pid>
  86 the core image
  87 .El
  88 .Sh HISTORY
  89 A
  90 .Nm
  91 utility appeared in
  92 .Bx 4.2 .
  93 .Sh BUGS
  94 Because of the
  95 .Xr ptrace 2
  96 usage
  97 .Nm
  98 may not work with processes which are actively being investigated with
  99 .Xr truss 1
 100 or
 101 .Xr gdb 1 .
 102 Additionally, interruptable sleeps may exit with EINTR.
 103 .Pp
 104 The
 105 .Nm
 106 utility is not compatible with the original
 107 .Bx 4.2
 108 version.