Flags and values

You can specify many of these flags and values with the other-transform-options attribute on the pdpr command or with the enq -o, lp -o, qprt -o, or lprafp -o command.

See pdpr command: submits jobs and Attributes for documents and default documents or The -o flag for AIX print commands and the InfoPrint Manager lprafp command for more information.

For a list of the AIX, Linux, or Windows files shipped with the line2afp transform, see Files.

cc={yes | no} DEFAULT=yes

Specifies whether the input file has carriage-control characters.

Values are:

yes: The file contains carriage-control characters. yes is the default.
no: The file does not contain carriage-control characters.

Carriage-control characters, if present, are located in the first byte (column) of each line in a document. They are used to control how the line will be formatted (single space, double space, triple space, and so forth). In addition, other carriage-controls can be used to position the line anywhere on the page. If there are no carriage-controls, single spacing is assumed.

This option and the cctype option, used together, are equivalent to the document attribute carriage-control-type on the pdpr command.

cctype={z | a | m} DEFAULT=z

Specifies the type of carriage-control characters in the input file. The line2afp command supports ANSI carriage-control characters in either ASCII or EBCDIC encoding, as well as machine carriage-control characters. The line2afp command does not allow a mixture of ANSI and machine carriage-control characters in a file. Values are:

z: The file contains ANSI carriage-control characters that are encoded in ASCII. z is the default.
The carriage-control characters are the ASCII hexadecimal values that directly relate to ANSI carriage-controls, which cause the action of the carriage-control character to occur before the line is printed. For example, if the carriage-control character is zero (X'30'), which represents double spacing, double spacing will occur before the line is printed.
a: The file contains ANSI carriage-control characters that are encoded in EBCDIC.
The use of ANSI carriage-control characters cause the action of the carriage-control character to occur before the line of data is printed. For example, if the carriage-control character is a zero (X'F0'), which represents double spacing, the double spacing will occur before the line is printed.
m: The file contains machine code carriage-control characters that are encoded in hexadecimal format.
The use of machine code carriage-control characters cause the action of the carriage-control character to occur after the line of data is printed. For example, if the carriage-control character is a X'11', which represents double spacing, the line will be printed and the double spacing will occur after the line is printed. In addition, machine code carriage-control has a set of carriage-control characters that do the action, but do not print the associated line.

If you specify cc=yes but you do not specify cctype, the line2afp command assumes that the file contains ANSI carriage-control characters encoded in ASCII.

If you are not sure which type of carriage-control characters are in your input file, consult your system support group.

This option and the cc option, used together, are equivalent to the document attribute carriage-control-type on the pdpr command.

chars=FontName1, FontName2, FontName3, FontName4

Specifies the file name of from one to four coded fonts to be used in processing the print file. A coded font specifies a character set and code page pair.

Note: chars is ignored when fontpath or userpath are specified.

The value is:

FontName: The name of the desired coded font. The font name is limited to 4 alphanumeric or national characters, and should not include the 2-character prefix of the coded-font name (X0 through XG). With InfoPrint Manager for AIX or InfoPrint Manager for Linux, the font name is case-sensitive.

With InfoPrint Manager for AIX or InfoPrint Manager for Linux, if you use the ASCII fonts that are supplied with InfoPrint, use the 4-character names. If you use your own coded font that has a file name with more than 6 characters (including the Xn prefix), do one of these actions:

Rename the font file to a shorter name. For example,
```
mv X0423002 X04202
```
Copy the font file to a file that has a shorter name. For example,
```
cp X0423002 X04202
```
Link the original font file to a shorter name. For example,
```
ln -s X0423002 X04202
```

With InfoPrint Manager for Windows, if you use the ASCII fonts that are supplied with InfoPrint, use the 4-character names. If you use your own coded font that has a file name with more than 6 characters (including the Xn prefix), do one of these actions:

Rename the font file to a shorter name. For example,
```
rename X0423002 X04202
```
Copy the font file to a file that has a shorter name. For example,
```
copy X0423002 X04202
```

When you use the line2afp command to convert S/370 line-mode data or unformatted ASCII data, you must specify a page definition (pagedef option). If the page definition names some fonts, the line2afp command uses those fonts, and ignores the chars option. If the page definition does not name any fonts (like the sample page definitions supplied with InfoPrint), and if you want the file to print with more than one font, the input file must contain table reference characters, and you must:

Specify trc=yes.
Use chars to indicate the fonts to be associated with each table reference character (TRC). Fontname1 is associated with TRC 0, FontName2 is associated with TRC 1, and so on.

If the page definition does not name any fonts, and you want the whole file to print with only one font, the input file must not contain table reference characters and you must:

Specify trc=no.
Use chars to indicate the single font in which the file should be printed.

Consider these situations when specifying fonts with the chars option:

If your input file is unformatted ASCII, you can do one of these actions:
- Specify a font that has the appropriate ASCII code points. To specify a font search path, either use the fontlib option to specify it explicitly, or set the PSFPATH environment variable to search the appropriate directories. See the RICOH Software Information Center at https://help.ricohsoftware.com/swinfocenter for more information about ASCII fonts.
- Use the apka2e or asciinpe input record exit programs to convert the ASCII code points in the input file into EBCDIC, and use EBCDIC fonts. To do this, use the inpexit option, specifying:
  
  For AIX or Linux
  
  inpexit=/usr/lpp/psf/bin/apka2e
  
  For Windows
  
  inpexit=c:\Program Files\RICOH\InfoPrint Manager\bin\apka2e where this path assumes you installed into the default path.
  
  If the ASCII input file contains form feeds or carriage returns, specify:
  
  For AIX or Linux
  
  inpexit=/usr/lpp/psf/bin/asciinpe
  
  For Windows
  
  inpexit=c:\Program Files\RICOH\InfoPrint Manager\bin\asciinpe where this path assumes you installed into the default path.
You can specify fonts with the chars option only if you want the entire file printed in a single printing direction. The line2afp command uses the fonts that have 0-degree character rotation for the specified direction. When a file requires fonts with more than one print direction or character rotation, you must specify the fonts in the page definition.
You can specify from one to four fonts with the chars option. If you specify more than one font with the chars option, the input file must contain table reference characters, and you must specify trc=yes.
If you use chars to specify fonts, but you also use the pagedef option to specify a page definition that names fonts, the chars option is ignored. Therefore, if your page definition names fonts, you should not use chars.
If you do not specify a chars option, and if no fonts are contained in the page definition you specified, the line2afp command uses the default font that is set in the printer's hardware.

This option is equivalent to the document attribute chars on the pdpr command.

fdeflib=PathList

Specifies the directories in which form definitions are stored. The value is:

PathList

Any valid search path. The line2afp command searches the paths in the order in which they are specified.

With AIX or Linux, you must use a colon (:) to separate multiple paths.

With Windows, you must use a semi-colon (;) to separate multiple paths.

For traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by piping line2afp's output to an AIX print command or the pdpr command, you should specify the same form definition search path on both sides of the pipe, unless you are sure that the same form definition will be found by line2afp and InfoPrint using each program's default search path.

With InfoPrint Manager for AIX, for traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by specifying -odatatype=line with an AIX print command, you must specify the form definition search path with -orespath instead of fdeflib. For example:

enq -odatatype=line -oformdef=myfd -opagedef=mypdef
   -orespath=/home/greg/resources -Pprinter myfile

This option is equivalent to the document attribute resource-context-form-definition on the pdpr command.

fileformat={record | record,n | stream | stream,(newline=characters,[encoding])}

Specifies the format of the input file. If you do not specify fileformat, the line2afp command uses stream as the default.

For information about how to specify the correct file format and how to transfer files to ACIF from AIX, Linux, and Windows, see the appendix entitled “Helpful Hints” in the AFP Conversion and Indexing Facility: User's Guide, S544-5285.

The fileformat option does not apply to input files that are resources. Resource files are in MO:DCA-P or AFP data stream format, and the line2afp command automatically determines that the file is a resource.

Values are:

record

The input file is formatted in S/390 record format, where the first two bytes of each line specify the length of the line. Files with record format typically are z/OS or VM files that have a variable record format and are downloaded to AIX, Linux, or Windows using Download for z/OS or are NFS-mounted.

record,n

The input file is formatted in such a way that each record (including AFP data stream and MO:DCA-P records) is a fixed length, n bytes long. The value of n is a number from 1 to 32767. The encapsulated size of the AFP structured field must be less than or equal to the size of n. Files with record,n format typically are z/OS or VM files that have a fixed record format and are downloaded to AIX, Linux, or Windows.

stream

The input file has no length information; it is a stream of data separated by one or more newline characters. The AFP portion (if any) of the input file has its length information encapsulated in the structured field. Files with stream format typically come from a workstation operating system, such as AIX, Linux, or Windows.

If newline is not specified, the line2afp command examines the first six bytes of the first line data record of the input file, to determine whether the input file is ASCII or EBCDIC. If line2afp determines that the input file is ASCII, line2afp looks for ASCII newline characters (X'0A') to delimit the end of a record. If line2afp determines that the input file is EBCDIC, line2afp looks for EBCDIC newline characters (X'25') to delimit the end of a record. The line2afp command does not include newline characters in the MO:DCA-P data stream that line2afp produces.

stream is the default.

stream,(newline=characters[encoding])

Use newline to specify the characters and optional encoding used for determining line breaks in the input data. You can use newline when line2afp's algorithm cannot determine the correct newline character (if blanks are at the beginning of the file, for example). Or you can use newline if you want to specify a newline character that is not the standard default. For example, you could use newline as follows:

fileformat=stream,(newline=X'0D')

If newline is not specified, line2afp uses the algorithm specified under fileformat=stream to determine the end of the record.

characters: Specify one of the keywords cr, lf, or crlf or specify a string of one, two, or four hexadecimal characters.
encoding: Specify encoding as ASCII, EBCDIC, UTF16, or UTF8. encoding is only valid if a keyword is specified with characters.

This table shows the hexidecimal strings used by line2afp for the delimiter characters when encoding is specified. line2afp also checks for a BOM (Byte Order Mark) character and reverses the bytes in the delimiter characters for UTF16 little endian data if the BOM is present.

Note: line2afp only checks for the BOM if a UDTYPE of UTF16 is specified on the PAGEDEF command.

Encoding Parameter	Carriage Return (CR)	Line Feed (LF)	CRLF
ASCII	x'0D'	x'0A'	x'0D0A'
EBCDIC	x'0D'	x'25'	x'0D25'
UTF8	x'0D'	x'0A'	x'0D0A'
UTF16 (with big endian data)	x'000D'	x'000A'	x'000D 000A''
UTF16 (with little endian data)	x'0D00'	x'0A00'	x'0D00 0A00''

For example, you could use newline as follows:

fileformat=stream,(newline=x'0D')
fileformat=stream,(newline=x'01020304')
fileformat=stream,(newline=crlf,utf16)

This option is equivalent to the document attribute new-line-options-data-encoding on the pdeng or lpr command.

fontlib=PathList

Specifies the directories in which fonts are stored.

The value is:

PathList

Any valid search path. The line2afp command searches the paths in the order in which they are specified.

With AIX or Linux, you must use a colon (:) to separate multiple paths.

With Windows, you must use a semi-colon (;) to separate multiple paths.

For traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by piping line2afp's output to an AIX print command or the pdpr command, you should specify the same font search path on both sides of the pipe, unless you are sure that the same fonts will be found by line2afp and InfoPrint using each program's default search path.

With InfoPrint Manager for AIX or InfoPrint Manager for Linux, for traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by specifying -odatatype=line with an print command, you must specify the font search path (if any) with -osrchfontlib instead of fontlib, as shown in this example:

enq -odatatype=line -osrchfontlib=/home/greg/resources
   -oformdef=myfdef -opagedef=mypdef -Pprinter myfile

Note: If the input file is ASCII data that you want to format with a page definition, you can do one of these actions:

Specify a font that has the appropriate ASCII code points. To specify a font search path, either use the fontlib option to specify it explicitly, or set the PSFPATH environment variable to search the appropriate directories.
Use the apka2e or asciinpe input record exit to convert the ASCII code points in the input file into EBCDIC, and use EBCDIC fonts. To do this, use the inpexit option, specifying:

For AIX or Linux

inpexit=/usr/lpp/psf/bin/apka2e

For Windows

inpexit=c:\Program Files\RICOH\InfoPrint Manager\bin\apka2e where this path assumes you installed into the default path.

or

For AIX or Linux

inpexit=/usr/lpp/psf/bin/asciinpe

For Windows

inpexit=c:\Program Files\RICOH\InfoPrint Manager\bin\asciinpe where this path assumes you installed into the default path.

This option is equivalent to the document attribute resource-context-font on the pdpr command.

fontpath=PathList

Specifies the system font path library directories in which TrueType and OpenType fonts are stored. TrueType and OpenType fonts are Unicode-enabled AFP fonts that are not defined by the IBM Font Object Content Architecture (FOCA). The value is:

PathList

Any valid search path. You must use a colon (:) in AIX or Linux and a seimicolon (;) in Windows.

line2afp inputdd-INFILE outputdd=OUTFILE pagedef=PAGTRUE formdef=F1A10110 \
fontpath=('/u/fonts/truetype:/u/fonts/truetype/local')

Note: The backslash (\) tells AIX or Linux to continue reading the command from the next line. In Windows, the backslash is not valid; therefore, the command parameters must be on one continuous line.

The line2afp transform searches the paths in the order in which they are specified.

formdef=FormDefinitionName

Specifies the file name of the form definition. A form definition defines how a page of data is placed on a form, the number of copies of a page, any modifications to that group of copies, the paper source, and duplexing. The form definition is actually used at print time, not at transform time.

The value is:

FormDefinitionName: Any valid form definition file name. The FormDefinitionName can be 1 to 8 alphanumeric or national characters, including the two-character prefix, if there is one. For AIX or Linux, the FormDefinitionName is case-sensitive.
Note: If the file name of the form definition includes a file extension, do not use the file extension when specifying the form definition. For example, to use a form definition named memo.FDEF38PP, specify formdef=memo.

The line2afp command requires a form definition to process the input file (even though the form definition actually gets used at print time). If you do not specify formdef=, or if you specify formdef= without a form definition file name, the line2afp command will not work.

For traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by piping line2afp's output to an AIX print command or the pdpr command, you should specify the same form definition on both sides of the pipe. If you are using the default form definition for the target printer, you do not need to specify a form definition with the AIX print command or pdpr command.

The form definition you use can be located:

In a directory
Inline in the file (that is, in the file itself)

If the form definition file is in a directory, use the userlib option or fdeflib option to specify the path to the file. For example:

For AIX or Linux: formdef=memo userlib=/usr/afp/resources
For Windows: formdef=memo userlib=d:\afp\resources

For AIX or Linux: formdef=memo fdeflib=/usr/lib/formdefns
For Windows: formdef=memo fdeflib=d:\lib\formdefns

If the form definition is an inline resource, you must:

Specify cc=yes to indicate that the file contains carriage-control characters.
Specify formdef=FormDefinitionName, where FormDefinitionName is the name of the inline form definition; or specify formdef=dummy.
If you specify formdef=dummy but the file does not include an inline form definition, the line2afp command looks for the form definition named dummy.

If you use formdef to specify an inline form definition that is different than the actual form definition used inline, the line2afp command looks for the formdef value instead of the inline form definition.

An input file can contain multiple form definitions, but only one form definition can be used for printing. If a file contains more than one inline form definition, and you specify formdef=FormDefinitionName, line2afp uses the first inline form definition named FormDefinitionName. If a file contains more than one inline form definition, and you specify formdef=dummy, line2afp uses the first inline form definition in the input file.

This option is equivalent to the document attribute form-definition on the pdpr command.

imageout={asis | ioca}

Specifies the format of the image data produced by the line2afp command in the output document.

Values are:

asis: The line2afp command produces all image data in the same format that it was in the input file.
ioca: The line2afp command produces all image data in the Image Object Content Architecture uncompressed format. ioca is the default.

This option is similar to the document attribute image-out-format on the pdpr command.

inpccsid=nnnn

Specifies the Coded Character Set ID (CCSID) for the input data that you want to convert. The inpccsid parameter can be used by an input exit, such as apka2e, to specify the encoding of the input data. The CCSID consists of a numeric character string, such as 1200, that represents any valid CCSID registered by the Character Data Representation Architecture (CDRA). For information about CCSIDs, see the CDRA Reference and Registry, SC09-2190.

inpexit=ProgramName

Specifies the name or the full path name of the input record exit program. The line2afp command calls this program for every record (every line) it reads from the input file (inputdd). If you specify the file name without a path, the line2afp command searches for the exit program in the paths specified by the PATH environment variable. If you do not specify this option, the line2afp command will not use an input record exit program.

The value is:

ProgramName: Any valid input record exit program name. With InfoPrint Manager for AIX or InfoPrint Manager for Linux, the exit program name is case-sensitive.

If the input file is unformatted ASCII, but the fonts you are using contain EBCDIC, not ASCII, code points (for example, you specify chars=GT15), you can specify:

With AIX or Linux:

/usr/lpp/psf/bin/apka2e

Converts ASCII stream data to EBCDIC stream data, unless you specify inpccsid or outccsid.

Note: The default conversion is from code page 805 to code page 037. You can override the defaults with the inpccsid and outccsid parameters.

/usr/lpp/psf/bin/asciinpe

Converts unformatted ASCII data into a record format that contains an American National Standards Institute (ANSI) carriage control character in byte 0 of every record, and then converts the ASCII stream data to EBCDIC stream data, unless you specify inccsid or outccsid.

/usr/lpp/psf/bin/asciinp

Converts unformatted ASCII data that contains carriage returns and form feeds into a record format that contains an American National Standards Institute (ANSI) carriage control character. This exit encodes the ANSI carriage control character in byte 0 of every record. You might want to specify the asciinp exit program supplied with InfoPrint if your unformatted ASCII file contains carriage returns and form feeds.

/usr/lpp/psf/bin/dbblank

Processes EBCDIC double-byte line data downloaded from the z/OS spool by adding an extra blank to the end of the input record if:

The last byte in the record is a blank (x'40' in EBCIDIC).
The second to the last byte is not a blank.
The input record is line data; that is, it is not a structured field.

This exit also updates the record length by 1 if the blank is added. The exit has no way of determining if the data is DBCS or not, so this will happen to every input record that ends in a single blank. The exit assumes that the input data is EBCIDIC, and that the output data is also EBCIDIC. In other words, the exit does not do any code page translation, but it simply adds an extra blank if needed.

Note:

This exit is only intended to be used if the spool file consists of double-byte or mixed single- or double-byte data that has blank truncation. Adding a blank to other types of data files could cause formatting errors, depending on how the page definition is coded.
This exit only checks for a single trailing blank, so if a different number of odd blanks is present in the data, it is up to you to make sure the data is formatted with the correct font.

With Windows:

c:\Program Files\IBM Printitng Systems\bin\apka2e

Converts ASCII stream data to EBCDIC stream data, unless you specify inpccsid or outccsid. This path assumes you installed into the default directory.

Note: The default conversion is from code page 805 to code page 037. You can override the defaults with the inpccsid and outccsid parameters.

c:\Program Files\IBM Printitng Systems\bin\asciinpe

c:\Program Files\IBM Printitng Systems\bin\asciinp

c:\Program Files\IBM Printitng Systems\bin\dbblank

Processes EBCDIC double-byte line data downloaded from the z/OS spool by adding an extra blank to the end of the input record if:

The last byte in the record is a blank (x'40' in EBCIDIC).
The second to the last byte is not a blank.
The input record is line data; that is, it is not a structured field.

Note:

This exit is only intended to be used if the spool file consists of double-byte or mixed single- or double-byte data that has blank truncation. Adding a blank to other types of data files could cause formatting errors, depending on how the page definition is coded.
This exit only checks for a single trailing blank, so if a different number of odd blanks is present in the data, it is up to you to make sure the data is formatted with the correct font.

If your input file uses fonts that have ASCII code points (for example, you specify chars=H292, or any of the fonts listed in IBM AFP Fonts for ASCII Data in AFP Conversion and Indexing Facility: User's Guide) you should not use the apka2e or asciinpe exit programs.

This option is equivalent to the document attribute input-exit on the pdpr command.

For a list of the AIX, Linux, and Windows files shipped with the line2afp transform, see Files.

inputdd=FileName

Specifies the full path name of the input file that the line2afp command will process. If you do not specify inputdd, the line2afp command uses standard input.

You cannot use inputdd=FileName on the command line with the enq, lp, qprt, or lprafp. commands, or with the other-transform-options attribute on the pdpr command. You can only use inputdd=FileName with the line2afp command.

msgdd=FileName

Specifies the name or the full path name of the file where the line2afp command writes error messages. If you specify the file name without a path, the line2afp command puts the error file into your current directory. If you do not specify msgdd, the line2afp command uses standard error for its message output.

This option is equivalent to the document attribute transform-message-file-name on the pdpr command.

outccsid=nnnn

Specifies the Coded Character Set ID (CCSID) for the output data that you want to have converted. The outccsid parameter can be used by an input exit, such as apka2e, to specify the encoding of the output data. The CCSID consists of a numeric character string, such as 1200, that represents any valid CCSID registered by the Character Data Representation Architecture (CDRA). For information about CCSIDs, see the CDRA Reference and Registry, SC09-2190.

outexit=ProgramName

Specifies the name or the full path name of the output record exit program. The line2afp command calls this program for every output record (every line) it writes to the output document file (outputdd). If you specify the file name without a path, the line2afp command searches for the file name in the paths specified by the PATH environment variable. If you do not specify this option, the line2afp command will not use an output record exit program.

The value is:

ProgramName: Any valid output record exit program name. With InfoPrint Manager for AIX or InfoPrint Manager for Linux, the exit program name is case-sensitive.

outputdd=FileName

Specifies the name or the full path name of the output document file. If you specify the file name without a path, the line2afp command puts the output file into your current directory. If you do not specify outputdd, the line2afp command writes the output to standard output.

You cannot use outputdd=FileName on the command line with the enq, lp, or qprt commands, or with the other-transform-options attribute on the pdpr command. You can only use outputdd=FileName with the line2afp command.

This option is equivalent to the document attribute transform-output-file-name on the pdpr command.

ovlylib=PathList

The value is:

PathList

Any valid search path. The line2afp command searches the paths in the order in which they are specified.

With AIX or Linux, you must use a colon (:) to separate multiple paths.

With Windows, you must use a semi-colon (;) to separate multiple paths.

For traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by piping line2afp's output to an AIX print command or the pdpr command, you should specify the same overlay search path on both sides of the pipe, unless you are sure that the same overlays will be found by line2afp and InfoPrint using each program's default search path.

InfoPrint Manager for AIX or InfoPrint Manager for Linux, for traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by specifying -odatatype=line with an print command, you must specify the overlay search path with -orespath instead of ovlylib. For example:

enq -odatatype=line -oformdef=myfd -opagedef=mypd
   -orespath=/home/greg/resources -Pprinter myfile

This option is equivalent to the document attribute resource-context-overlay on the pdpr command.

pagedef=PageDefinitionName

Specifies the file name of the page definition. A page definition defines the page format that the line2afp command uses to compose the input file into pages. The page definition is actually used at transform time, not at print time.

The value is:

PageDefinitionName: Any valid page definition file name. The PageDefinitionName can be 1 to 8 alphanumeric or national characters, including the two-character prefix, if there is one. With AIX or Linux, the pdefname is case-sensitive.
Note: If the file name of the page definition includes a file extension, do not use the file extension when specifying the page definition. For example, to use a page definition named memo.PDEF38PP, specify pagedef=memo.

The line2afp command requires a page definition to process the input file. If you do not specify pagedef=, or if you specify pagedef= without a page definition file name, the line2afp command will not work.

The page definition you use can be located:

In a directory
Inline in the file (that is, in the file itself)

If the page definition file is in a directory, use the userlib option or pdeflib option to specify the path to the file. For example:

For AIX or Linux: pagedef=memo userlib=/usr/afp/resource
For Windows: pagedef=memo userlib=d:\afp\resource

For AIX or Linux: pagedef=memo pdeflib=/usr/lib/pagedefns
For Windows: pagedef=memo pdeflib=d:\lib\pagedefns

If the page definition is an inline resource, you must:

Specify cc=yes to indicate that the file contains carriage-control characters.
Specify pagedef=PageDefinitionName, where PageDefinitionName is the name of the inline page definition; or specify pagedef=dummy.
If you specify pagedef=dummy but the file does not include an inline page definition, the line2afp command looks for the page definition named dummy.

If you use pagedef to specify an inline page definition that is different than the actual page definition used inline, the line2afp command looks for the pagedef value instead of the inline page definition.

An input file can contain multiple page definitions, but only one page definition can be used by the line2afp command. If a file contains more than one inline page definition, and you specify pagedef=PageDefinitionName, line2afp uses the first inline page definition named PageDefinitionName. If a file contains more than one inline page definition, and you specify pagedef=dummy, the line2afp command uses the first inline page definition in the input file.

This option is equivalent to the document attribute page-definition on the pdpr command.

parmdd=FileName

Specifies the name or the full path name of a file that contains the line2afp options and their values. If you specify the file name without a path, the line2afp command searches for the file name in your current directory.

You might find it convenient to put the line2afp options and values into a file, so that you do not have to type all of them on the command line whenever you use line2afp.

Values are:

FileName: The name of the file containing line2afp command options and values.

Note:

The beginning delimiter for comments is /*. For example:
```
formdef=F1TEMP  /* Temporary formdef
formdef=F1PROD  /* Production-level formdef
```
Comments can appear anywhere, but the line2afp command ignores all information in the line following the /* character string.
Each option must be on a separate line. For example:
```
chars=GT10 cctype=a  /* This is NOT allowed.
```
If the option file contains the name of the input file (inputdd=FileName), you cannot specify the option file with an AIX print command's -o flag or with the other-transform-options attribute on the pdpr command. For example, these commands are not valid:
```
enq -odatatype=line -oparmdd=myparms
pdpr -x "document-format=line-data
   other-transform-options='parmdd=myparms'"
```
However, these are valid:
```
line2afp parmdd=myparms | enq
line2afp parmdd=myparms | pdpr -d my-printer
```

pdeflib=PathList

Specifies the directories in which page definitions are stored.

The value is:

PathList

Any valid search path. The line2afp command searches the paths in the order in which they are specified.

With AIX or Linux, you must use a colon (:) to separate multiple paths.

With Windows, you must use a semi-colon (;) to separate multiple paths.

This option is equivalent to the document attribute resource-context-page-definition on the pdpr command.

prmode={SOSI1 | SOSI2 | SOSI3 | SOSI4 | aaaaaaaa}

Specifies the type of data in the input file and whether the line2afp command must do optional processing of that data.

Values are:

SOSI1: Specifies that each shift-out, shift-in code be converted to a blank and a Set Coded Font Local text control.
SOSI2: Specifies that each shift-out, shift-in code be converted to a Set Coded Font Local text control.
SOSI3: Specifies that each shift-out character be converted to a Set Coded font Local text control. Each shift-in character is converted to a Set Control Font Local text control followed by two blanks.
SOSI4: Specifies that each shift-out, shift-in code be skipped and not counted when calculating offsets for the input file. SOSI4 is used when double-byte character set (DBCS) text is converted from ASCII to EBCDIC. When SOSI4 is specified, the page definition offsets are correct after conversion; therefore, you do not need to account for SOSI characters when computing FIELD offsets. The processing of shift-out and shift-in codes for SOSI4 is the same as for SOSI2.
aaaaaaaa: Any 8-byte alphanumeric string. This value is supplied to all of the ACIF user exits. (See AFP Conversion and Indexing Facility: User's Guide, S550-0436, for information about ACIF user exits.)

For the SOSI process modes to work correctly, the first font specified in the chars option (or in a font list in a page definition) must be a single-byte font, and the second font must be a double-byte font.

This option is equivalent to the document attribute shift-out-shift-in on the pdpr command.

pseglib=PathList

Specifies the directories in which page segments and BCOCA, GOCA, and IOCA objects are stored.

The value is:

PathList

Any valid search path. The line2afp command searches the paths in the order in which they are specified.

With AIX or Linux, you must use a colon (:) to separate multiple paths.

With Windows, you must use a semi-colon (;) to separate multiple paths.

For traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by piping line2afp's output to an AIX print command or the pdpr command, you should specify the same page segment search path on both sides of the pipe, unless you are sure that the same page segments will be found by line2afp and InfoPrint using each program's default search path.

For traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by specifying -odatatype=line with an AIX print command, you must specify the page segment search path with -orespath instead of pseglib. For example:

enq -odatatype=line -oformdef=myfd -opagedef=mypd
   -orespath=/home/greg/resources -Pprinter myfile

This option is equivalent to the document attribute resource-context-page-segment on the pdpr command.

resexit=ProgramName

Specifies the name or the full path name of the resource exit program. This is the program the line2afp command calls each time it tries to retrieve a requested resource from a directory. If you specify the file name without a path, the line2afp command searches for the file name in the paths specified by the PATH environment variable. If you do not specify this option, the line2afp command does not use a resource exit program. The exit program name is case-sensitive.

The value is:

ProgramName: Any valid resource exit program name.

This option is equivalent to the document attribute resource-exit on the pdpr command.

reslib=PathList

Specifies the paths for the system resource directories. System resource directories typically contain resources that are shared by many users. The directories can contain any AFP resources (fonts, page segments, overlays, page definitions, or form definitions).

For traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by piping line2afp's output to an AIX print command or the pdpr command, you should specify the same resource search path on both sides of the pipe, unless you are sure that the same resources will be found by line2afp and InfoPrint using each program's default search path.

For traditional line data and for ASCII data that you want to format with a page definition, if you are transforming and printing a file by specifying -odatatype=line with an AIX print command, you must specify the search path for AFP resources with -orespath instead of reslib. For example:

enq -odatatype=line -oformdef=myfd -opagedef=mypd
  -orespath=/home/greg/resources -Pprinter myfile

The value is:

PathList

Any valid search path. The line2afp command searches the paths in the order in which they are specified.

With AIX or Linux, you must use a colon (:) to separate multiple paths.

With Windows, you must use a semi-colon (;) to separate multiple paths.

This option is equivalent to the document attribute resource-context on the pdpr command.

RESTYPE={NONE | ALL | [ FDEF][,PSEG][,OVLY][ ,FONT][,OBJCON][,BCOCA] [ ,GOCA][,IOCA][,CMRALL][ ,CMRGEN][,INLINE][,INLONLY]}

Specifies the type of AFP print resources ACIF should retrieve from the resource directories or libraries for inclusion in the resource file (specified with the RESOBJDD parameter).

Values are:

NONE

Specifies that no resource file be created.

ALL

Specifies that all resources required to print or view the output document file (specified with the OUTPUTDD parameter) be included in the resource file.

Important: Specifying this value can create extremely large resource files, particularly when color management resources (CMRs) are included.

FDEF

Specifies that the form definition (specified with the FORMDEF parameter) used in processing the file be included in the resource file.

PSEG

Specifies that all page segments required to print or view the output document file be included in the resource file.

OVLY

Specifies that all overlays required to print or view the output document file be included in the resource file.

FONT

Specifies that all font character sets and code pages required to print or view the output file be included in the resource file. Also used for TrueType and OpenType fonts and specifies that all base fonts, linked fonts, and font collections required to print the output file be included in the resource file. If MCF2REF=CF is specified, ACIF also includes coded fonts in the resource file; otherwise, coded fonts are not included in the resource file.

Note:

Specifying RESTYPE=FONT is not recommended with double-byte raster fonts because of the size and large number of library members needed to process double-byte raster fonts.
If RESTYPE=FONT is not specified, you might want to specify MCF2REF=CF, which can improve ACIF performance by reducing the number of font members ACIF processes.
When specifying RESTYPE=FONT with TrueType and OpenType fonts, the embed flag must be set “on” to save the font in the resource file. See Using OpenType Fonts in an AFP System for more information.
ACIF wraps TrueType and OpenType fonts in MO:DCA-P structured fields when it saves them in the resource file.
When EXTENSIONS=RESORDER is specified with RESTYPE=FONT, TrueType and OpenType fonts that were originally inline in the input file are not saved in the resource library.

OBJCON

Specifies that all object container files requested by the input data stream be included in the resource file. These object container files include TrueType and OpenType fonts, color management resources (CMRs), data objects, and the COM setup file specified by the COMSETUP parameter.

BCOCA

Specifies that all BCOCA objects included by an IOB structured field required to print or view the output document file be included in the resource file.

GOCA

Specifies that all GOCA objects included by an IOB structured field required to print or view the output document file be included in the resource file.

IOCA

Specifies that all IOCA objects included by an IOB structured field required to print or view the output document file be included in the resource file.

CMRALL

Specifies that all CMRs required to process the output document file be included in the resource file. These CMRs include all CMRs referenced in the data stream, all CMRs referenced through a data object or color management Resource Access Table (RAT), and all generic halftone and tone transfer curve CMRs.

CMRGEN

Specifies that all CMRs referenced in the data stream plus any non-device specific CMRs referenced through a data object or color management RAT be included in the resource file.

INLINE

Specifies that all inline resources contained in the ACIF input file (specified with the INPUTDD parameter) are written to the output file as well as to the resource file. Otherwise, if INLINE is not specified, inline resources in the input file are only written to the resource file. For example, RESTYPE=FONT,PSEG,INLINE causes any inline fonts and page segments to be written to the output file, in addition to writing all inline and library fonts and page segments to the resource file. The inline resources precede the document in the output file.

INLONLY

Specifies that all inline resources contained in the ACIF input file are written to the output file, regardless of resource type. Only inline resources are written to the output file because those are the only resources ACIF looks for. Also, ACIF does not create a resource file, even if the RESOBJDD parameter is specified.

Because multiple resource types are contained in the page segment and object container libraries, and ACIF does not enforce a prefix for the eight-character resource name, you should define a naming convention that identifies each type of resource in the library. We recommend these two-character prefixes:

B1 for BCOCA objects
E1 for encapsulated PostScript objects
G1 for GOCA objects
H1 for microfilm setup objects
I1 for IOCA objects
IT for IOCA tile objects
M1 for color mapping table objects
PP for PDF single-page objects
PR for PDF resource objects
S1 for page segments

ACIF supports the specification of BCOCA, CMRALL, CMRGEN, FDEF, FONT, GOCA, IOCA, INLINE, OBJCON, OVLY, and PSEG in any combination. For example, if you want to specify form definitions, page segments, and overlays as the resource types, you can enter RESTYPE=FDEF,PSEG,OVLY or RESTYPE=OVLY,FDEF,PSEG.

On the other hand, ALL, INLONLY, and NONE are order dependent and override any individual resource types specified. If more than one is entered, the last one specified is used. For example, if you specify RESTYPE=FDEF,INLONLY,PSEG,NONE,OVLY,ALL, all resources are included.

Note:

CMRALL and CMRGEN are not supported in VM and VSE.
When creating AFP files to view on the AFP Workbench Viewer, do not specify RESTYPE=FONT or RESTYPE=ALL. The AFP Workbench Viewer uses font definition files for font substitution instead of retrieving fonts from a resource file when displaying documents. Therefore, you do not need to download fonts to the resource file, which is time consuming and increases the number of bytes sent when the file is transferred to the workstation or archived.
If you have a resource type that you want saved in a resource file, and it is included in another resource type, you must specify both resource types. For example, if you request that only page segments be saved in a resource file, and the page segments are included in overlays, the page segments are not saved in the resource file because the overlays are not searched. In this case, you need to request that both page segments and overlays be saved.
ACIF saves specified inline resources in the resource file, even if they are not needed to print the job. However, if you specify EXTENSIONS=RESORDER , ACIF saves only the inline resources actually needed to print the job. You can also use a resource exit to filter out any resources you do not want included in the resource file.

trc={yes | no | yes,fix | yes,strict | yes,discard | yes,ignore}

Specifies whether the input file contains table reference characters (TRCs). Some applications can produce output that uses different fonts on different lines of a file by specifying TRCs at the beginning of each line after the carriage-control character, if one is present.

Values are:

yes: The input file contains table reference characters.
no: The input file does not contain table reference characters. no is the default.
fix: ACIF allows zero-length line data records, including single spacing.; When specified, fix is also used for the CC parameter.
discard: ACIF discards zero-length line data records.; When specified, discard is also used for the CC parameter.
ignore: ACIF allows zero-length line data records, including the selection of font 0. However, ACIF does not correct and does not report missing TRC bytes.; When specified, ignore is also used for the CC parameter.

Consider these situations when you use TRCs:

The order in which the fonts are specified in the chars option establishes which number is assigned to each associated TRC. For example, the first font specified is assigned 0, the second font 1, and so on.
If you specify trc=yes but TRCs are not contained in the file, the line2afp command interprets the first character (or second, if carriage-control characters are used) of each line as the font identifier. Consequently, the font used to process each line of the file might not be the one you expect, and one byte of data will be lost from each line.
If you specify trc=no or you do not specify trc at all, but your data contains a TRC as the first character (or second if carriage-control characters are used) of each line, the line2afp command interprets the TRC as a text character in the processed output, rather than using it as a font identifier.
Table reference characters may cause line data records to contain an odd number of bytes with UTF-16 encoding.

This option is equivalent to the document attribute table-reference-characters on the pdpr command.

userlib=PathList

Specifies the names of user directories containing AFP resources for processing the input file. The directories can contain any AFP resources (fonts, page segments, overlays, page definitions, or form definitions).

By convention, these resources are typically used by one user, as opposed to the system resources (specified with the reslib option) that are shared by many users. Therefore, you should use the userlib option to specify resources that are not retrieved with the fdeflib, fontlib, ovlylib, pdeflib, or pseglib options.

The value is:

PathList

Any valid search path. The line2afp command searches the paths in the order in which they are specified.

With AIX or Linux, you must use a colon (:) to separate multiple paths.

With Windows, you must use a semi-colon (;) to separate multiple paths.

userpath=PathList

Specifies the names of user directories containing TrueType and OpenType fonts, color management resources (CMRs), and data object resources (DORs). TrueType and OpenType fonts are Unicode-enabled AFP fonts that are not defined by the IBM Font Object Content Architecture (FOCA).

By convention, these fonts are typically used by one user, as opposed to the system fonts (specified with fontpath) that are shared by many users. The value is:

PathList

Any valid search path. You must use a colon (:) in AIX or Linux and a semicolon (;) in Windows. For example:

line2afp inputdd=INFILE outputdd=OUTFILE pagedef=PAGTRUE 
formdef=F1A10110 \
userpath=('/jdoe/fonts/truetype:/jdoe/fonts/truetype/myfonts/')

Note: The backslash (\) tells AIX or Linux to continue reading the command from the next line. In Windows, the backslash is not valid; therefore, the values must be on one continuous line.

The line2afp transform searches the paths in the order in which they are specified.

RICOH InfoPrint Manager™ for Linux

Flags and values