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