summaryrefslogtreecommitdiff
path: root/usr/src/man/man1/shcomp.1
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man1/shcomp.1')
-rw-r--r--usr/src/man/man1/shcomp.1167
1 files changed, 167 insertions, 0 deletions
diff --git a/usr/src/man/man1/shcomp.1 b/usr/src/man/man1/shcomp.1
new file mode 100644
index 0000000000..6c29803983
--- /dev/null
+++ b/usr/src/man/man1/shcomp.1
@@ -0,0 +1,167 @@
+'\" te
+.\" Copyright (c) 1982-2007 AT&T Knowledge Ventures
+.\" To view license terms, see http://www.opensource.org/licenses/cpl1.0.txt
+.\" Portions Copyright (c) 2009, Sun Microsystems, Inc.
+.TH shcomp 1 "27 Jan 2009" "SunOS 5.11" "User Commands"
+.SH NAME
+shcomp \- compile a ksh93 shell script
+.SH SYNOPSIS
+.LP
+.nf
+\fBshcomp\fR [\fB-nv\fR] [\fIinfile\fR [\fIoutfile\fR]]
+.fi
+
+.LP
+.nf
+\fBshcomp\fR \fB-D\fR [\fIinfile\fR [\fIoutfile\fR]]
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+If the \fB-D\fR option is not specified, \fBshcomp\fR takes a shell script,
+\fIinfile\fR, and creates a binary format file, \fIoutfile\fR, that \fBksh93\fR
+reads and executes with the same effect as the original script.
+.sp
+.LP
+Aliases are processed as the script is read. Alias definitions whose value
+requires variable expansion will not work correctly.
+.SH OPTIONS
+.sp
+.LP
+The following options are supported:
+.sp
+.ne 2
+.mk
+.na
+\fB\fB-D\fR\fR
+.ad
+.br
+.na
+\fB\fB--dictionary\fR\fR
+.ad
+.RS 16n
+.rt
+Generate a list of strings that need to be placed in a message catalog for
+internationalization.
+.sp
+With this option, all double quoted strings that are preceded by \fB$\fR are
+printed, one literal per line. A literal \fB$"foo"\fR prints \fB"foo"\fR in the
+output. These are the messages that need to be translated to locale specific
+versions for internationalization.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fB-n\fR\fR
+.ad
+.br
+.na
+\fB\fB--noexec\fR\fR
+.ad
+.RS 16n
+.rt
+Display warning messages for obsolete or non-conforming constructs.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fB-v\fR\fR
+.ad
+.br
+.na
+\fB\fB--verbose\fR\fR
+.ad
+.RS 16n
+.rt
+Display input from \fIinfile\fR onto standard error as it reads it.
+.RE
+
+.SH OPERANDS
+.sp
+.LP
+The following operands are supported:
+.sp
+.ne 2
+.mk
+.na
+\fB\fIinfile\fR\fR
+.ad
+.RS 11n
+.rt
+Specifies the name of the file that contains the shell script to be used as
+input.
+.sp
+If \fIinfile\fR is omitted, the shell script is read from standard input.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIoutfile\fR\fR
+.ad
+.RS 11n
+.rt
+Specifies the name of the output file.
+.sp
+If \fIoutfile\fR is omitted, both modes write their results to standard output.
+.RE
+
+.SH EXIT STATUS
+.sp
+.LP
+The following exit values are returned:
+.sp
+.ne 2
+.mk
+.na
+\fB\fB0\fR\fR
+.ad
+.RS 6n
+.rt
+Successful completion.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fB>0\fR\fR
+.ad
+.RS 6n
+.rt
+An error occurred.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i)
+lw(2.75i) |lw(2.75i)
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+CSIEnabled
+_
+Interface StabilitySee below.
+.TE
+
+.sp
+.LP
+The command-line interface and the system variables are Committed. The compiled
+shell code format is Private. The output of the \fB-D\fR option is Volatile.
+.SH SEE ALSO
+.sp
+.LP
+\fBksh93\fR(1), \fBattributes\fR(5)