usr/src/man/man1/shcomp.1

   1 '\" te
   2 .\" Copyright (c) 1982-2007 AT&T Knowledge Ventures
   3 .\" To view license terms, see http://www.opensource.org/licenses/cpl1.0.txt
   4 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc.
   5 .TH SHCOMP 1 "Jan 27, 2009"
   6 .SH NAME
   7 shcomp \- compile a ksh93 shell script
   8 .SH SYNOPSIS
   9 .LP
  10 .nf
  11 \fBshcomp\fR [\fB-nv\fR] [\fIinfile\fR [\fIoutfile\fR]]
  12 .fi
  13
  14 .LP
  15 .nf
  16 \fBshcomp\fR \fB-D\fR [\fIinfile\fR [\fIoutfile\fR]]
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 If the \fB-D\fR option is not specified, \fBshcomp\fR takes a shell script,
  23 \fIinfile\fR, and creates a binary format file, \fIoutfile\fR, that \fBksh93\fR
  24 reads and executes with the same effect as the original script.
  25 .sp
  26 .LP
  27 Aliases are processed as the script is read. Alias definitions whose value
  28 requires variable expansion will not work correctly.
  29 .SH OPTIONS
  30 .sp
  31 .LP
  32 The following options are supported:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fB-D\fR\fR
  37 .ad
  38 .br
  39 .na
  40 \fB\fB--dictionary\fR\fR
  41 .ad
  42 .RS 16n
  43 Generate a list of strings that need to be placed in a message catalog for
  44 internationalization.
  45 .sp
  46 With this option, all double quoted strings that are preceded by \fB$\fR are
  47 printed, one literal per line. A literal \fB$"foo"\fR prints \fB"foo"\fR in the
  48 output. These are the messages that need to be translated to locale specific
  49 versions for internationalization.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB-n\fR\fR
  56 .ad
  57 .br
  58 .na
  59 \fB\fB--noexec\fR\fR
  60 .ad
  61 .RS 16n
  62 Display warning messages for obsolete or non-conforming constructs.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fB-v\fR\fR
  69 .ad
  70 .br
  71 .na
  72 \fB\fB--verbose\fR\fR
  73 .ad
  74 .RS 16n
  75 Display input from \fIinfile\fR onto standard error as it reads it.
  76 .RE
  77
  78 .SH OPERANDS
  79 .sp
  80 .LP
  81 The following operands are supported:
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fIinfile\fR\fR
  86 .ad
  87 .RS 11n
  88 Specifies the name of the file that contains the shell script to be used as
  89 input.
  90 .sp
  91 If \fIinfile\fR is omitted, the shell script is read from standard input.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fIoutfile\fR\fR
  98 .ad
  99 .RS 11n
 100 Specifies the name of the output file.
 101 .sp
 102 If \fIoutfile\fR is omitted, both modes write their results to standard output.
 103 .RE
 104
 105 .SH EXIT STATUS
 106 .sp
 107 .LP
 108 The following exit values are returned:
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fB0\fR\fR
 113 .ad
 114 .RS 6n
 115 Successful completion.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fB>0\fR\fR
 122 .ad
 123 .RS 6n
 124 An error occurred.
 125 .RE
 126
 127 .SH ATTRIBUTES
 128 .sp
 129 .LP
 130 See \fBattributes\fR(5) for descriptions of the following attributes:
 131 .sp
 132
 133 .sp
 134 .TS
 135 box;
 136 c | c
 137 l | l .
 138 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 139 _
 140 CSI     Enabled
 141 _
 142 Interface Stability     See below.
 143 .TE
 144
 145 .sp
 146 .LP
 147 The command-line interface and the system variables are Committed. The compiled
 148 shell code format is Private. The output of the \fB-D\fR option is Volatile.
 149 .SH SEE ALSO
 150 .sp
 151 .LP
 152 \fBksh93\fR(1), \fBattributes\fR(5)