usr/src/man/man1/gcore.1

   1 '\" te
   2 .\"  Copyright 1989 AT&T Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GCORE 1 "Jun 19, 2006"
   7 .SH NAME
   8 gcore \- get core images of running processes
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBgcore\fR [\fB-pgF\fR] [\fB-o\fR \fIfilename\fR] [\fB-c\fR \fIcontent\fR] \fIprocess-id\fR...
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBgcore\fR utility creates a core image of each specified process. By
  19 default, the name of the core image file for the process whose process \fBID\fR
  20 is \fIprocess-id\fR is \fBcore.\fR\fIprocess-id\fR.
  21 .SH OPTIONS
  22 .sp
  23 .LP
  24 The following options are supported:
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fB-c\fR \fIcontent\fR\fR
  29 .ad
  30 .RS 15n
  31 Produces core image files with the specified content. The content description
  32 uses the same tokens as in \fBcoreadm\fR(1M). The \fB-c\fR option does not
  33 apply to cores produced due to the \fB-p\fR or \fB-g\fR flags.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fB-F\fR\fR
  40 .ad
  41 .RS 15n
  42 Force. Grabs the target process even if another process has control.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fB-g\fR\fR
  49 .ad
  50 .RS 15n
  51 Produces core image files in the global core file repository with the global
  52 content as configured by \fBcoreadm\fR(1M). The command fails if the user does
  53 not have permissions to the global core file repository.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB\fR\fB-o\fR \fIfilename\fR\fR
  60 .ad
  61 .RS 15n
  62 Substitutes \fIfilename\fR in place of \fBcore\fR as the first part of the name
  63 of the core image files. \fIfilename\fR can contain the same tokens to be
  64 expanded as the paths in \fBcoreadm\fR(1M).
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fB-p\fR\fR
  71 .ad
  72 .RS 15n
  73 Produces a core image file in the process-specific location with the
  74 process-specific content for each process as configured by \fBcoreadm\fR(1M).
  75 The command fails if the user does not have permissions to the per-process core
  76 file repository.
  77 .RE
  78
  79 .SH OPERANDS
  80 .sp
  81 .LP
  82 The following operand is supported:
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fIprocess-id\fR\fR
  87 .ad
  88 .RS 14n
  89 process \fBID\fR
  90 .RE
  91
  92 .SH USAGE
  93 .sp
  94 .LP
  95 Caution should be exercised when using the \fB-F\fR flag. Imposing two
  96 controlling processes on one victim process can lead to chaos. Safety is
  97 assured only if the primary controlling process, typically a debugger, has
  98 stopped the victim process and the primary controlling process is doing nothing
  99 at the moment of application of the \fBproc\fR tool in question.
 100 .SH EXIT STATUS
 101 .sp
 102 .LP
 103 The following exit values are returned:
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB0\fR\fR
 108 .ad
 109 .RS 12n
 110 On success.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fBnon-zero\fR
 117 .ad
 118 .RS 12n
 119 On failure, such as non-existent process \fBID\fR.
 120 .RE
 121
 122 .SH FILES
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fB\fR\fBcore.\fR\fB\fIprocess-id\fR\fR\fR
 127 .ad
 128 .RS 19n
 129 core images
 130 .RE
 131
 132 .SH ATTRIBUTES
 133 .sp
 134 .LP
 135 See \fBattributes\fR(5) for descriptions of the following attributes:
 136 .sp
 137
 138 .sp
 139 .TS
 140 box;
 141 c | c
 142 l | l .
 143 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 144 _
 145 Interface Stability     See below.
 146 .TE
 147
 148 .sp
 149 .LP
 150 The command syntax is Evolving. The Output Formats are Unstable.
 151 .SH SEE ALSO
 152 .sp
 153 .LP
 154 \fBkill\fR(1), \fBcoreadm\fR(1M), \fBsetrlimit\fR(2), \fBcore\fR(4),
 155 \fBproc\fR(4), \fBattributes\fR(5)
 156 .SH NOTES
 157 .sp
 158 .LP
 159 \fBgcore\fR is unaffected by the \fBsetrlimit\fR(2) system call using the
 160 \fBRLIMIT_CORE\fR value.