comment.1

speech signal process tools

.\" @(#)comment.1	1.1 6/9/86
.TH COMMENT 1\-SPS 6/9/86
.ds ]W "\fI\s+4\ze\h'0.05'e\s-4\v'-0.4m'\fP\(*p\v'0.4m'\ Entropic Processing, Inc.
.SH "NAME"
comment - displays or adds comments in the header of an existing SPS file
.SH "SYNOPSIS"
.B comment
[
.BI \-a
[
.I commfile
] ]
.I spsfile
.SH "DESCRIPTION"
.PP
When called without the 
.B \-a
option, 
.I comment 
writes the contents of the 
.I variable.comment
field in the header of the SPS file 
.I spsfile
to standard output.  If 
.I spsfile
is not an SPS file,
.I comment
prints an error message and exits.  
.I Comment
prepends the comment with a line containing the current date and time.  
.SH OPTIONS
.PP
The following options are supported:
.TP
.BI \-a
Causes 
.I comment 
to add a comment to 
.I spsfile.
If the argument
.I commfile
is given and is the name of an ASCII file, the contents of 
.I commfile 
are added to 
.I variable.comment
in the header of 
.I spsfile.
Otherwise, the user is prompted for the comment, which is then 
typed in directly and terminated with a ^D.  If the argument
.I commfile
is given but is not the name of an ASCII file, 
.I comment
exits with an error message.
.SH "SPS PARAMETERS"
.PP
The SPS parameter file is not read by 
.I comment.  
.SH SPS HEADERS
.PP
.I Comment
reads the 
.I common.type
field from the header of 
.I spspfile
and modifies
.I variable.comment.
.SH "FUTURE CHANGES"
.PP
.SH "SEE ALSO"
.PP
SPS(5-SPS)
.SH "WARNINGS"
.PP
.SH "BUGS"
.PP
.SH "AUTHOR"
.PP
Alan Parker