.**********************************************************************
.* CRTCSVSTMF: Help text for Create .csv Streamfile
.* Copyright (C) 2001  Martin Rowe  <martin@dbg400.net>
.*
.* This program is free software; you can redistribute it and/or modify
.* it under the terms of the GNU General Public License as published by
.* the Free Software Foundation; either version 2 of the License, or
.* (at your option) any later version.
.*
.* This program is distributed in the hope that it will be useful,
.* but WITHOUT ANY WARRANTY; without even the implied warranty of
.* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.* GNU General Public License for more details.
.*
.* You should have received a copy of the GNU General Public License
.* along with this program; if not, write to the Free Software Foundation,
.* Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307   USA
.**********************************************************************
.* First panel
:PNLGRP.
.**********************************************************************
:HELP NAME=CRTCSVSTMF.
Create .csv Streamfile - Help.
:P.
This command creates a streamfile on the IFS from a standard database file.
The conversion is done in two stages. First the file is converted to .csv
format in a temporary database file (flat format) by the CRTCSVDTA command.
Next the temporary file is converted to a streamfile by the IBM CPYTOSTMF
command. See the respective commands for full details on the options
presented here.
:EHELP.
:HELP NAME='CRTCSVSTMF/SOURCE'.
From file (SOURCE) - Help.
:P.
:HP3. SOURCE :EHP3.
The source file from which data is copied. A valid database file is required.
:P.
:HP2. From file Library :EHP2.
:P.
The source file's library, or *LIBL, is required.
:EHELP.
:HELP NAME='CRTCSVSTMF/MEMBER'.
From file member (MEMBER) - Help.
:P.
:HP3. MEMBER :EHP3.
The source database file member that contains the data to be copied.
*FIRST may be used to pick the first (or only) file member.
:EHELP.
:HELP NAME='CRTCSVSTMF/TARGET'.
Streamfile to create (TARGET) - Help.
:P.
:HP3. TARGET :EHP3.
The streamfile to contain the formatted data.
:EHELP.
:HELP NAME='CRTCSVSTMF/COLHDG'.
Column Headings (COLHDG) - Help.
:P.
:HP3. COLHDG :EHP3.
Specify if the first record of the target file should contain a delimited
list of the column headings for the source file.
:P.
:HP3. *NONE :EHP3.
Column headings will not be used. The first record will contain data from
the source file.
:P.
:HP2. *COLHDG :EHP2.
The column headings from the source file (the COLHDG attribute) are
written as the first record.
:P.
:HP2. *FIELD :EHP2.
The field names from the source file (the COLHDG attribute) are
written as the first record.
:P.
:HP2. *TEXT :EHP2.
The field text from the source file (the COLHDG attribute) are
written as the first record.
:EHELP.
:HELP NAME='CRTCSVSTMF/FLDDLM'.
Field delimiter (FLDDLM) - Help.
:P.
:HP3. FLDDLM :EHP3.
Select the character used to delimit fields in the target file. The default
is a comma, but any character could be used (though not necessarily understood
by the application that processes the resultant file).
:EHELP.
:HELP NAME='CRTCSVSTMF/RPLFLDDLM'.
Replacement Field Delimiter (RPLFLDDLM) - Help.
:P.
:HP3. RPLFLDDLM :EHP3.
Replace occurances of the FLDDLM character in character fields with this
character. Can be used to prevent embedded characters in strings from confusing
applications that process the file. Use the same value as FLDDLM if this isn't
a problem for your applications.
:EHELP.
:HELP NAME='CRTCSVSTMF/STRDLM'.
String delimiter (STRDLM) - Help.
:P.
:HP3. STRDLM :EHP3.
Select the character used to delimit character strings in the target file.
The default is the double quote character. Any character may be used. Leave
blank if no string delimiter is required.
:EHELP.
:HELP NAME='CRTCSVSTMF/RPLSTRDLM'.
Replacement String Delimiter (RPLSTRDLM) - Help.
:P.
:HP3. RPLSTRDLM :EHP3.
Replace occurances of the STRDLM character in character fields with this
character. Can be used to prevent embedded characters in strings from confusing
applications that process the file. Use the same value as STRDLM if this isn't
a problem for your applications. Leave blank if STRDLM is blank.
:EHELP.
:HELP NAME='CRTCSVSTMF/STMFOPT'.
Streamfile option (STMFOPT) - Help.
:P.
:HP3. STMFOPT :EHP3.
Specifies whether the formatted data is added to the target streamfile
or replaces its contents. *ADD to add records, *REPLACE to clear the
file prior to adding records.
:EHELP.
:HELP NAME='CRTCSVSTMF/STMFCODPAG'.
Streamfile code page (STMFCODPAG) - Help.
:P.
:HP3. STMFCODPAG :EHP3.
Set the code page for the resultant streamfile. Use *STMF if the existing
streamfile code page is to be kept. Other values are the same as on the
CPYTOSTMF command (including *STDASCII and *PCASCII).
:EHELP.
:HELP NAME='CRTCSVSTMF/ENDLINFMT'.
End of line character (ENDLINFMT) - Help.
:P.
:HP3. ENDLINFMT :EHP3.
Set the end of line character. See the help text for ENDLINFMT on the
CPYTOSTMF command for full details. This command supports *CR, *LF or
a combination of the two (*CRLF & *LFCR). As a guide, use *CRLF for
files intended for Microsoft systems, *LF for Unix/BSD/Linux systems
and *CR for Macintosh systems.
:EHELP.
:EPNLGRP.