Syntax: FSLIST Procedure | Base SAS 9.1 Procedures Guide, Volumes 1, 2, 3 and 4

PROC FSLIST

FILEREF= file-specification UNIT= nn < option(s) >;

You must specify either the FILEREF= or the UNIT= argument with the PROC FSLIST statement.
Option(s) can be one or more of the following:
- CAPSNOCAPS
- CCFORTCCNOCC
- HSCROLL=HALFPAGE n
- NOBORDER
- NUMNONUM
- OVPNOOVP

Statement Descriptions

The only statement that the FSLIST procedure supports is the PROC FSLIST statement, which starts the procedure.

Requirements

You must specify an external file for PROC FSLIST to browse.

FSLIST Command

The FSLIST procedure can also be initiated by entering the following command on the command line of any SAS window:

FSLIST <*? file-specification < carriage -control-option < overprinting-option >>>

where carriage-control-option can be CC, FORTCC, or NOCC and overprinting-option can be OVP or NOOVP.

Note: OVP is ignored if NOCC is in effect.

PROC FSLIST Statement

The PROC FSLIST statement initiates the FSLIST procedure and specifies the external file to browse. Statement options enable you to modify the default behavior of the procedure.

PROC FSLIST Statement Requirements

The PROC FSLIST statement must include one of the following arguments that specifies the external file to browse.

FILEREF= file-specification

DDNAME= file-specification
DD= file-specification

specifies the external file to browse. file-specification can be one of the following:
external-file
- is the complete operating environment file specification (called the fully qualified pathname under some operating environments) for the external file. You must enclose the name in quotation marks.

fileref
- is a fileref that has been previously assigned to the external file. You can use the FILENAME statement to associate a fileref with an actual filename. For information about the FILENAME statement, see the section on statements in SAS Language Reference: Dictionary .

UNIT= nn
- defines the FORTRAN-style logical unit number of the external file to browse. This option is useful when the file to browse has a fileref of the form FT nn F001, where nn is the logical unit number that is specified in the UNIT= argument. For example, you can specify
```
 proc fslist unit=20; 
```
  instead of
```
 proc fslist fileref=ft20f001; 
```

PROC FSLIST Statement Options

The following options can be used with the PROC FSLIST statement:

CAPS NOCAPS

controls how search strings for the FIND command are treated:

CAPS

converts search strings into uppercase unless they are enclosed in quotation marks. For example, with this option in effect, the command

 find nc

locates occurrences of NC , but not nc . To locate lowercase characters , enclose the search string in quotation marks:

 find 'nc'

NOCAPS

does not perform a translation; the FIND command locates only those text strings that exactly match the search string.

The default is NOCAPS. You can use the CAPS command in the FSLIST window to change the behavior of the procedure while you are browsing a file.

CC FORTCC NOCC

indicates whether carriage-control characters are used to format the display. You can specify one of the following values for this option:

CC	uses the native carriage-control characters of the operating environment.
FORTCC	uses FORTRAN-style carriage control. The first column of each line in the external file is not displayed; the character in this column is interpreted as a carriage-control code. The FSLIST procedure recognizes the following carriage-control characters:
	+	skip zero lines and print (overprint)
	blank	skip one line and print (single space)
		skip two lines and print (double space)
	-	skip three lines and print (triple space)
	1	go to new page and print.
NOCC	treats carriage-control characters as regular text.

If the FSLIST procedure can determine from the file s attributes that the file contains carriage-control information, then that carriage-control information is used to format the displayed text (the CC option is the default). Otherwise, the entire contents of the file are treated as text (the NOCC option the default).

Note: Under some operating environments, FORTRAN-style carriage control is the native carriage control. For these environments, the FORTCC and CC options produce the same behavior.

HSCROLL= n HALFPAGE

indicates the default horizontal scroll amount for the LEFT and RIGHT commands. The following values are valid:

n	sets the default scroll amount to n columns .
HALF	sets the default scroll amount to half the window width.
PAGE	sets the default scroll amount to the full window width.

The default is HSCROLL=HALF. You can use the HSCROLL command in the FSLIST window to change the default scroll amount.

NOBORDER

suppresses the sides and bottom of the FSLIST window s border. When this option is used, text can appear in the columns and row that are normally occupied by the border.

NUM NONUM

controls the display of line sequence numbers in files that have a record length of 80 and contain sequence numbers in columns 73 through 80. NUM displays the line sequence numbers ; NONUM suppresses them. The default is NONUM.

OVP NOOVP

indicates whether the carriage-control code for overprinting is honored:

OVP	causes the procedure to honor the overprint code and print the current line over the previous line when the code is encountered .
NOOVP	causes the procedure to ignore the overprint code and print each line from the file on a separate line of the display.

The default is NOOVP. The OVP option is ignored if the NOCC option is in effect.

FSLIST Command

The FSLIST command provides a handy way to initiate an FSLIST session from any SAS window. The command enables you to use either a fileref or a filename to specify the file to browse. It also enables you to specify how carriage-control information is interpreted.

FSLIST Command Syntax

The general form of the FSLIST command is

FSLIST <*? file-specification < carriage-control-option < overprinting-option >>>

where carriage-control-option can be CC, FORTCC, or NOCC and overprinting-option can be OVP or NOOVP.

Note: OVP is ignored if NOCC is in effect.

FSLIST Command Arguments

You can specify one of the following arguments with the FSLIST command:

opens a dialog window in which you can specify the name of the file to browse, along with various FSLIST procedure options. In the dialog window, you can specify either a physical filename, a fileref, or a directory name. If you specify a directory name, then a selection list of the files in the directory appears, from which you can choose the desired file.

opens a selection window from which you can choose the external file to browse. The selection list in the window includes all external files that are identified in the current SAS session (all files with defined filerefs ).

Note: Only filerefs that are defined within the current SAS session appear in the selection list. Under some operating environments, it is possible to allocate filerefs outside of SAS. Such filerefs do not appear in the selection list that is displayed by the FSLIST command.

To select a file, position the cursor on the corresponding fileref and press ENTER.

Note: The selection window is not opened if no filerefs have been defined in the current SAS session. Instead, an error message is printed, instructing you to enter a filename with the FSLIST command.

file-specification

identifies the external file to browse. file-specification can be one of the following:
external-file
- the complete operating environment file specification (called the fully qualified pathname under some operating environments) for the external file. You must enclose the name in quotation marks.
  
  If the specified file is not found, then a selection window opens that shows all available filerefs.

fileref
- a fileref that is currently assigned to an external file. If you specify a fileref that is not currently defined, then a selection window opens that shows all available filerefs. An error message in the selection window indicates that the specified fileref is not defined.

If you do not specify any of these three arguments, then a selection window opens that enables you to select an external filename.

FSLIST Command Options

If you use a file-specification with the FSLIST command, then you can also use the following options. These options are not valid with the ? argument, or when no argument is used:

CC FORTCC NOCC

indicates whether carriage-control characters are used to format the display. You can specify one of the following values for this option:

CC	uses the native carriage-control characters of the operating environment.
FORTCC	uses FORTRAN-style carriage control. See the discussion of the PROC FSLIST statement s FORTCC option on page 491 for details.
NOCC	treats carriage-control characters as regular text.

If the FSLIST procedure can determine from the file s attributes that the file contains carriage-control information, then that carriage-control information is used to format the displayed text (the CC option is the default). Otherwise, the entire contents of the file are treated as text (the NOCC option is the default).

OVP NOOVP

indicates whether the carriage-control code for overprinting is honored. OVP causes the overprint code to be honored; NOOVP causes it to be ignored. The default is NOOVP. The OVP option is ignored if NOCC is in effect.