share/man/man1/pargs.1

   1 '\" te
   2 .\"  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 PARGS 1 "Jun 19, 2006"
   7 .SH NAME
   8 pargs \- print  process  arguments,  environment  variables,  or auxiliary
   9 vector
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBpargs\fR [\fB-aceFlx\fR] [\fIpid\fR | \fIcore\fR]...
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBpargs\fR utility examines a target process or process core file and
  20 prints arguments, environment variables and values, or the process auxiliary
  21 vector.
  22 .sp
  23 .LP
  24 \fBpargs\fR outputs unprintable characters as escaped octal in the format
  25 \fB\e\fR\fIxxx\fR, unless the character is  one of the characters specified in
  26 the "\fBEscape Sequences\fR" section of \fBformats\fR(5), in which case the
  27 character is  printed as specified in that section.
  28 .sp
  29 .LP
  30 \fBpargs\fR attempts to be sensitive to the locale of the target process. If
  31 the target process and the \fBpargs\fR process do not share a common character
  32 encoding, \fBpargs\fR attempts to employ the \fBiconv\fR(3C) facility to
  33 generate a printable version of the extracted  strings. In the event that such
  34 a conversion is impossible, strings are displayed as 7-bit \fBASCII\fR.
  35 .SH OPTIONS
  36 .sp
  37 .LP
  38 The following options are supported:
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fB-a\fR\fR
  43 .ad
  44 .RS 6n
  45 Prints process arguments as contained in \fBargv[]\fR (default).
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fB-c\fR\fR
  52 .ad
  53 .RS 6n
  54 Treats strings  in the target process as  though they were encoded in 7-bit
  55 \fBASCII\fR, regardless of the locale of the target. The use of \fBiconv\fR(3C)
  56 is suppressed.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fB-e\fR\fR
  63 .ad
  64 .RS 6n
  65 Prints process environment variables and values as pointed at by the
  66 \fB_environ\fR symbol or by \fBpr_envp\fR in \fB/proc/\fIpid\fR/psinfo\fR.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fB-F\fR\fR
  73 .ad
  74 .RS 6n
  75 Force. Grabs the target process even if another process has control.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fB-l\fR\fR
  82 .ad
  83 .RS 6n
  84 Displays the arguments as a single command line. The command line is printed in
  85 a manner suitable for interpretation by \fB/bin/sh\fR. If the arguments contain
  86 unprintable characters, or if the target process is in a different locale, a
  87 warning message is displayed. The resulting command line might not be
  88 interpreted correctly by \fB/bin/sh\fR.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-x\fR\fR
  95 .ad
  96 .RS 6n
  97 Prints process auxiliary vector.
  98 .RE
  99
 100 .SH OPERANDS
 101 .sp
 102 .LP
 103 The following operands are supported:
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fIpid\fR\fR
 108 .ad
 109 .RS 8n
 110 Process \fBID\fR list.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fIcore\fR\fR
 117 .ad
 118 .RS 8n
 119 Process core file.
 120 .RE
 121
 122 .SH USAGE
 123 .sp
 124 .LP
 125 Caution should be exercised when using the \fB-F\fR flag. Imposing two
 126 controlling processes on one victim process can lead to chaos. Safety is
 127 assured only if the primary controlling process, typically a debugger, has
 128 stopped the victim process and the primary controlling process is doing nothing
 129 at the moment of application of the \fBproc\fR tool in question.
 130 .SH EXIT STATUS
 131 .sp
 132 .LP
 133 The following exit values are returned:
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fB0\fR\fR
 138 .ad
 139 .RS 12n
 140 Successful operation.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fBnon-zero\fR
 147 .ad
 148 .RS 12n
 149 An error has occurred (such as no such process, permission denied, or invalid
 150 option).
 151 .RE
 152
 153 .SH FILES
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB/proc/pid/*\fR\fR
 158 .ad
 159 .RS 15n
 160 Process information and control files.
 161 .RE
 162
 163 .SH ATTRIBUTES
 164 .sp
 165 .LP
 166 See \fBattributes\fR(5) for descriptions of the following attributes:
 167 .sp
 168
 169 .sp
 170 .TS
 171 box;
 172 c | c
 173 l | l .
 174 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 175 _
 176 Interface Stability     Evolving
 177 .TE
 178
 179 .SH SEE ALSO
 180 .sp
 181 .LP
 182 \fBproc\fR(1), \fBiconv\fR(3C), \fBproc\fR(4), \fBascii\fR(5),
 183 \fBattributes\fR(5), \fBenviron\fR(5), \fBformats\fR(5)