1 12/01/86 display, di
2
3 Syntax: display -control_args
4
5
6 Function: retrieves selected data, creates a report, and displays it
7 on the terminal, to a file, or an io switch. A translated or
8 translatable query must be available.
9
10
11 Control arguments:
12 -all, -a
13 specifies that every page of the report is to be displayed. This
14 argument is incompatible with -pages. -all is the default.
15 -brief, -bf,
16 suppresses warning messages.
17 -character_positions STR1 STR2, -chpsn STR1 STR2
18 where STR1 and STR2 define the left and right character positions of
19 a vertical section of the report. STR1 must be given and defines
20 the left margin position to begin from. STR2 is optional, and if it
21 is not given the default is the rightmost character position of the
22 report. If this control argument is not given the entire page is
23 printed.
24 -discard_report, -dsrp
25 deletes the report on termination. -discard_report is the default.
26
27
28 -discard_retrieval, -dsr
29 deletes retrieved data on termination.
30 -enable_escape_keys, -eek
31 specifies that display is to use the escape keys sequences, rather
32 than the terminal's function keys and arrow keys, for the scrolling
33 functions. This is the default if the -scroll control argument is
34 given and the terminal doesn't have the necessary set of function
35 keys and arrow keys see -enable_function_keys below. In the
36 following description the mnemonic "esc-" means the terminal's
37 escape key. The following escape key sequences are used if this
38 control argument is given, or, the terminal lacks the necessary set
39 of keys: forward -- esc-f; backward -- esc-b; left -- esc-l; right
40 -- esc-r; help -- esc-?; set_key -- esc-k; set_scroll_increment --
41 esc-i; quit -- esc-q; redisplay -- esc-d; start_of_report -- esc-s;
42 end_of_report -- esc-e; multics_mode -- esc-m; and goto -- esc-g.
43
44
45 -enable_function_keys, -efk
46 specifies that display is to try to use the terminal's function keys
47 and arrow keys for the scrolling functions. This is the default
48 when the -scroll control argument is given and the terminal has at
49 least nine function keys and the four arrow keys. In the following
50 description the mnemonic: "fN" means function key N where N is the
51 number of the function key; "down_arrow" means the down arrow key;
52 "up_arrow" means the up arrow key; "left_arrow" means the left arrow
53 key; and "right_arrow" means the right arrow key. The following
54 key sequences are used if this control argument is given and the
55 terminal has the necessary set of keys: forward -- down_arrow;
56 backward -- up_arrow; left -- left_arrow; right -- right_arrow; help
57 -- f1; set_key -- f2; set_scroll_increment -- f3; quit -- f4;
58 redisplay -- f5; start_of_report -- f6; end_of_report -- f7;
59 multics_mode -- f8; and goto -- f9.
60
61
62 -extend
63 specifies that when the -output_file control argument is used and
64 the file exists, the report is appended to the end of the file
65 rather than replacing it. If this control argument isn't used the
66 default is to truncate an existing file.
67 -keep_report, -krp
68 keeps the report on termination. This control argument is necessary
69 in order to use -old_report on subsequent invocations of display.
70 -keep_retrieval, -kr
71 keeps retrieved data to allow re-use on subsequent invocations of
72 the display request. Previously retrieved sorted data retains the
73 sort order.
74
75
76 -long, -lg
77 displays warning messages when a control argument such as
78 -old_retrieval is used and the data from a previous retrieval is not
79 available. Default
80 -new_report, -nrp
81 specifies that display is to create a new report. "-new_report" is
82 the default
83 -new_retrieval, -nr
84 specifies that display should begin a new retrieval from the data
85 base. -new_retrieval is the default
86 -old_report, -orp
87 uses the report created in the previous invocation. Use of this
88 control argument requires that -keep_report be used in the prior
89 invocation of display.
90
91
92 -old_retrieval, -or
93 uses data retrieved during the previous invocation. Use of this
94 control argument requires that -keep_retrieval be used in the prior
95 invocation of display.
96 -output_file path, -of path
97 where path is the name of the file which will contain the formatted
98 report. If this argument and -output_switch are not given the
99 report is displayed on the terminal. This argument is incompatible
100 with -output_switch.
101 -output_switch switch_name, -osw switch_name
102 where switch_name is the name of a switch which will be used to
103 display the report. It is an error to use this control argument if
104 the named switch is not already open and attached when display is
105 invoked. This argument is incompatible with -output_file.
106
107
108 -pages STR, -pgs STR, -page STR, -pg STR
109 where STR is a blank separated list of pages N N or page ranges
110 NN. Page ranges can also be given as "N," or "N,$" which means
111 from page N to the end of the report, or $ which means the last
112 page. This argument is incompatible with "-all".
113 -passes N, -pass N
114 where N is the number of times the report will be formatted. If
115 this control argument isn't given the default value for N is 1. No
116 output is produced until the last formatting pass of the report.
117
118
119 -scroll
120 specifies that display is to scroll the report according to key
121 sequences read from the terminal. Only terminals supported by the
122 Multics video system can use the scrolling feature. If the -window
123 control argument isn't used, display will create a uniquely named
124 window for the display of the report. The user_i/o window will be
125 reduced to four lines and the remaining lines will be used for the
126 uniquely named report display window. The minimum size for this
127 window is five lines, so the user_i/o window must be at least nine
128 lines before invoking display, unless the -window control argument
129 is used.
130
131
132 -set_key STR, -sk STR
133 -set_keys STR, -sks STR
134 specifies that the named scrolling functions are to be set to the
135 provided key sequences. STR is a blank separated list of one or
136 more scrolling function names and key sequences, given as
137 "function_name key_sequence ... function_name key_sequence". The
138 function names can be chosen from the set listed above under the
139 description of the "-enable_escape_keys" or "-enable_function_keys"
140 control arguments. The key sequences can be given as the actual
141 sequences, or, mnemonic key sequences. The provided mnemonic's can
142 be:
143
144
145 "fN" where N is the number of the desired function key; "esc-" or
146 "escape-" where this corresponds to the terminal's "escape"
147 character; "ctl-X" or "control-X" where this corresponds to the
148 character sequence generated by the terminal when the "control"
149 key is held while also pressing the character named by "X";
150 "down_arrow" where this corresponds to the terminal's down arrow
151 key; "up_arrow" where this corresponds to the terminal's up arrow
152 key; "left_arrow" where this corresponds to the terminal's left
153 arrow key; "right_arrow" where this corresponds to the terminal's
154 right arrow key; and "home" where this corresponds to the
155 terminal's home key.
156
157
158 -sort STR -ascending | -descending -case_sensitive |
159 -non_case_sensitive ... STR -asc | -dsc -cs | -ncs
160 where STR is the name of a column as defined in the open
161 model/submodel or a number corresponding to the position of the
162 column in the selection expression. It can be followed by
163 -ascending or -descending, and -case_sensitive or
164 -non_case_sensitive. If -ascending or -descending is not specified,
165 the default is -ascending. If -case_sensitive or
166 -non_case_sensitive is not specified, the default is
167 -case_sensitive.
168
169
170 -temp_dir dir_name, -td dir_name
171 specifies that the given directory should be used for storing the
172 retrieved data, the saved report if "-keep_report" is used, and
173 sorting workspace if "-sort" is used, instead of the process
174 directory. This temp dir will continue to be used until another new
175 temp dir is requested. A new temp dir can only be specified when a
176 new retrieval and new report are requested.
177 -truncate, -tc
178 specifies that when the -output_file control argument is used and
179 the file already exists, the report replaces the contents of the
180 file. If the -extend control argument isn't given the default is
181 -truncate.
182
183
184 -window STR, -win STR
185 specifies that the window named by STR should be used for the
186 display of the report. This argument is only meaningful when the
187 -scroll argument is also used. If this control argument is used the
188 window named by STR must be attached and open under the video
189 system, and it must be at least five lines high.
190
191
192 Examples:
193 display
194 display -output_file foo
195 display -keep_retrieval -sort bar -descending -non_case_sensitive
196 display -keep_retrieval -keep_report -of foo1
197 -character_positions 1 132
198 display -old_retrieval -old_report -of foo2
199 -character_positions 133 260
200 display -pages 1 3 12,19 58,$ -output_switch foo
201 display -sort foo -descending bar -non_case_sensitive
202
203
204
205
206