1 :Info: window_call: wdc:  1985-03-01  window_call, wdc
  2 
  3 Syntax as a command:  wdc OPERATION {-control_args}
  4 
  5 
  6 Syntax as an active function:  [wdc OPERATION {-control_args}]
  7 
  8 
  9 Function: provides a command interface to the video system (see the
 10 Programmer's Reference Manual for a description of the video system).
 11 
 12 
 13 Arguments:
 14 OPERATION
 15    selects the operation to be performed.  See "List of operations"
 16    below.  For details, type:  help wdc.OPERATION
 17 
 18 
 19 List of operations:
 20   For a detailed description of any operation, type:
 21     help wdc.OPERATION
 22 bell
 23 change_window, chgwd
 24 clear_region, clrgn
 25 clear_to_end_of_line, cleol
 26 clear_to_end_of_window, cleowd
 27 clear_window, clwd
 28 create_window, crwd
 29 delete_chars, dlch
 30 delete_window, dlwd
 31 get_echoed_chars, gech
 32 get_first_line, gfl
 33 get_one_unechoed_char, gouch
 34 
 35 
 36 get_position, gpos
 37 get_terminal_height, gtmhgt
 38 get_terminal_width, gtmwid
 39 get_unechoed_chars, guch
 40 get_window_height, gwdhgt
 41 insert_text, itx
 42 invoke
 43 overwrite_text, otx
 44 revoke
 45 scroll_region, scrgn
 46 set_position, spos
 47 set_position_rel, sposrel
 48 
 49 
 50 supported_terminal
 51 sync
 52 video_invoked
 53 write_sync_read, wsr
 54 
 55 
 56 Control arguments:
 57 -control_args
 58    control function performed by each OPERATION.  For details, type:
 59      help wdc.OPERATION
 60 
 61 
 62 :Info: wdc.bell:  1985-03-01  wdc bell operation
 63 
 64 Syntax as a command:  wdc bell {-io_switch STR}
 65 
 66 
 67 Function: activates the terminal bell.  On some terminals, this may
 68 produce a visual indication instead of an audible tone.  The cursor
 69 position must be defined.  The cursor is positioned to the current
 70 position of the specified window, if it is elsewhere on the screen.
 71 
 72 
 73 Arguments:
 74 bell
 75    the operation being performed.
 76 
 77 
 78 Control arguments:
 79 -io_switch STR, -is STR
 80    specifies the name of an I/O switch for a window.  This serves to
 81    identify the window.  If you don't provide it, user_i/o is assumed.
 82 
 83 
 84 :Info: wdc.change_window: wdc.chgwd:  1985-03-01  wdc change_window operation
 85 
 86 Syntax as a command:
 87 wdc chgwd {-line N} {-column N} {-height N} {-width N} {-io_switch STR}
 88 
 89 
 90 Function: changes the origin or size of the specified window.  You
 91 must give at least one of -column, -height, -line, or -width.  If you
 92 give only -line (changing the top line of the window), the window
 93 length is automatically adjusted: i.e., if -line increases the value
 94 of the top line number (moving the window down), the window length
 95 shrinks accordingly; however if -line decreases the top line number
 96 (moving the window up), the length remains the same.  If you supply
 97 only -height (changing the window length), the origin line remains the
 98 same.  If you select only -width (changing the window width), the
 99 origin column remains the same.
100 
101 
102 Arguments:
103 change_window, chgwd
104    the operation being performed.
105 
106 
107 Control arguments:
108 -column N, -col N
109    specifies a column on the screen.  If you don't give it, the default
110    is the remainder of the screen.  (Default: 1, the leftmost column)
111 -height N, -hgt N
112    specifies the height of a region or a window for a request.  If you
113    don't supply it, the default is the remainder of the screen.
114 -io_switch STR, -is STR
115    specifies the name of an I/O switch for a window.  This serves to
116    identify the window.  If you don't provide it, user_i/o is assumed.
117 -line N
118    specifies a line on the screen.  (Default: 1, the top line)
119 -width N, -wid N
120    specifies the width of a region for a request.  If you don't provide
121    it, the default is the remainder of the screen.
122 
123 
124 :Info: wdc.clear_region: wdc.clrgn:  1985-03-01  wdc clear_region operation
125 
126 Syntax as a command:
127    wdc clrgn -line N -column N -height N -width N {-io_switch STR}
128 
129 
130 Function: clears the specified rectangular region of the window to
131 blanks.  The region may be part or all of the window.
132 
133 
134 Arguments:
135 clear_region, clrgn
136    the operation being performed.
137 
138 
139 Control arguments:
140 -column N, -col N
141    specifies a column on the screen.  If you don't give it, the default
142    is the remainder of the screen.  (Default: 1, the leftmost column)
143 -height N, -hgt N
144    specifies the height of a region or a window for a request.  If you
145    don't supply it, the default is the remainder of the screen.
146 -io_switch STR, -is STR
147    specifies the name of an I/O switch for a window.  This serves to
148    identify the window.  If you don't provide it, user_i/o is assumed.
149 -line N
150    specifies a line on the screen.  (Default: 1, the top line)
151 -width N, -wid N
152    specifies the width of a region for a request.  If you don't provide
153    it, the default is the remainder of the screen.
154 
155 
156 :Info: wdc.clear_to_end_of_line: wdc.cleol:  1984-02-09  wdc clear_to_end_of_line operation
157 
158 
159 Syntax as a command:  wdc cleol {-io_switch STR}
160 
161 
162 Function: clears the line from the current cursor position to the end
163 of the line to blanks.  You must define the current cursor position.
164 
165 
166 Arguments:
167 clear_to_end_of_line, cleol
168    the operation being performed.
169 
170 
171 Control arguments:
172 -io_switch STR, -is STR
173    specifies the name of an I/O switch for a window.  This serves to
174    identify the window.  If you don't provide it, user_i/o is assumed.
175 
176 
177 :Info: wdc.clear_to_end_of_window: wdc.cleowd:  1985-03-01  wdc clear_to_end_of_window operation
178 
179 
180 Syntax as a command:  wdc cleowd {-io_switch STR}
181 
182 
183 Function:  clears the window from the current cursor position to the
184 end of the window to blanks.  You must define the current cursor
185 position.
186 
187 
188 Arguments:
189 clear_to_end_of_window, cleowd
190    the operation being performed.
191 
192 
193 Control arguments:
194 -io_switch STR, -is STR
195    specifies the name of an I/O switch for a window.  This serves to
196    identify the window.  If you don't provide it, user_i/o is assumed.
197 
198 
199 :Info: wdc.clear_window: wdc.clwd:  1985-03-01  wdc clear_window operation
200 
201 Syntax as a command:  wdc clwd {-io_switch STR}
202 
203 
204 Function: clears the specified window so that its content becomes
205 entirely blank.  The current cursor position is defined to be at line
206 1, column 1 of the specified window.
207 
208 
209 Arguments:
210 clear_window, clwd
211    the operation being performed.
212 
213 
214 Control arguments:
215 -io_switch STR, -is STR
216    specifies the name of an I/O switch for a window.  This serves to
217    identify the window.  If you don't provide it, user_i/o is assumed.
218 
219 
220 :Info: wdc.create_window: wdc.crwd:  1985-03-01  wdc create_window operation
221 
222 Syntax as a command:
223   wdc crwd -io_switch STR {-line N -column N -height N -width N}
224 
225 
226 Function: creates a new window on the screen with name (and I/O
227 switch) STR.  The window is blank when created, and the cursor position
228 is line 1, column 1 of the new window.
229 
230 
231 Arguments:
232 create_window, crwd
233    the operation being performed.
234 
235 
236 Control arguments:
237 -column N, -col N
238    specifies a column on the screen.  If you don't give it, the default
239    is the remainder of the screen.  (Default: 1, the leftmost column)
240 -height N, -hgt N
241    specifies the height of a region or a window for a request.  If you
242    don't supply it, the default is the remainder of the screen.
243 -io_switch STR, -is STR
244    specifies the name of an I/O switch for a window.  This serves to
245    identify the window.  If you don't provide it, user_i/o is assumed.
246 -line N
247    specifies a line on the screen.  (Default: 1, the top line)
248 -width N, -wid N
249    specifies the width of a region for a request.  If you don't provide
250    it, the default is the remainder of the screen.
251 
252 
253 :Info: wdc.delete_chars: wdc.dlch:  1985-03-01  wdc delete_chars operation
254 
255 
256 Syntax as a command:  wdc dlch -count N {-io_switch STR}
257 
258 
259 Function: deletes N characters to the right of the current cursor
260 position on the current line.  The cursor remains stationary;
261 characters to the right of the deleted characters move to the left to
262 fill the vacated space.  You must define the current cursor position.
263 
264 
265 Arguments:
266 delete_chars, dlch
267    the operation being performed.
268 
269 
270 Control arguments:
271 -count N, -ct N
272    specifies a count.
273 -io_switch STR, -is STR
274    specifies the name of an I/O switch for a window.  This serves to
275    identify the window.  If you don't provide it, user_i/o is assumed.
276 
277 
278 :Info: wdc.delete_window: wdc.dlwd:  1985-03-01  wdc delete_window operation
279 
280 Syntax as a command:  wdc dlwd -io_switch STR
281 
282 
283 Function: destroys the specified window.  The I/O switch is closed and
284 detached.
285 
286 
287 Arguments:
288 delete_window, dlwd
289    the operation being performed.
290 
291 
292 Control arguments:
293 -io_switch STR, -is STR
294    specifies the name of an I/O switch for a window.  This serves to
295    identify the window.  If you don't provide it, user_i/o is assumed.
296 
297 
298 :Info: wdc.get_echoed_chars: wdc.gech:  1985-03-01  wdc get_echoed_chars operation
299 
300 
301 Syntax as a command:  wdc gech -count N {-io_switch STR}
302 
303 
304 Syntax as an active function:  [wdc gech -count N {-io_switch STR}]
305 
306 
307 Function: reads characters from the terminal until either N characters
308 or a break character is read.  All characters except the break are
309 echoed on the screen in the current window.  For information on break
310 characters, see the break_table control order in the description of
311 window_io_.  You must define the current cursor position.  As an active
312 function, two strings are returned:  the first contains any nonbreak
313 characters read, and the second contains the break character, if any.
314 
315 
316 Arguments:
317 get_echoed_chars, gech
318    the operation being performed.
319 
320 
321 Control arguments:
322 -count N, -ct N
323    specifies a count.
324 -io_switch STR, -is STR
325    specifies the name of an I/O switch for a window.  This serves to
326    identify the window.  If you don't provide it, user_i/o is assumed.
327 
328 
329 :Info: wdc.get_first_line: wdc.gfl:  1985-03-01  wdc get_first_line operation
330 
331 Syntax as a command:  wdc gfl {-io_switch STR}
332 
333 
334 Syntax as an active function:  [wdc gfl {-io_switch STR}]
335 
336 
337 Function: prints/returns the line on the screen where the specified
338 window begins.
339 
340 
341 Arguments:
342 get_first_line, gfl
343    the operation being performed.
344 
345 
346 Control arguments:
347 -io_switch STR, -is STR
348    specifies the name of an I/O switch for a window.  This serves to
349    identify the window.  If you don't provide it, user_i/o is assumed.
350 
351 
352 :Info: wdc.get_one_unechoed_char: wdc.gouch:  1985-03-01  wdc get_one_unechoed_char operation
353 
354 Syntax as a command:  wdc gouch {-io_switch STR}
355 
356 
357 Syntax as an active function:  [wdc gouch {-io_switch STR}]
358 
359 
360 Function: reads/returns a single unechoed character from the terminal.
361 
362 
363 Arguments:
364 get_one_unechoed_char, gouch
365    the operation being performed.
366 
367 
368 Control arguments:
369 -io_switch STR, -is STR
370    specifies the name of an I/O switch for a window.  This serves to
371    identify the window.  If you don't provide it, user_i/o is assumed.
372 
373 
374 :Info: wdc.get_position: wdc.gpos:  1985-03-01  wdc get_position operation
375 
376 Syntax as a command:  wdc gpos {-io_switch STR}
377 
378 
379 Syntax as an active function:  [wdc gpos {-io_switch STR}]
380 
381 
382 Function: prints the current line and column position of the cursor.
383 As an active function, returns the line and column position as a pair
384 of integers separated by a space.
385 
386 
387 Arguments:
388 get_position, gpos
389    the operation being performed.
390 
391 
392 Control arguments:
393 -io_switch STR, -is STR
394    specifies the name of an I/O switch for a window.  This serves to
395    identify the window.  If you don't provide it, user_i/o is assumed.
396 
397 
398 :Info: wdc.get_terminal_height: wdc.gtmhgt: 1985-03-01  wdc get_terminal_height operation
399 
400 Syntax as a command:  wdc gtmhgt
401 
402 
403 Syntax as an active function:  [wdc gtmhgt]
404 
405 
406 Function: prints/returns the total number of lines on your terminal.
407 
408 
409 Arguments:
410 get_terminal_height, gtmhgt
411    the operation being performed.
412 
413 
414 :Info: wdc.get_terminal_width: wdc.gtmwid:  1985-03-01  wdc get_terminal_width operation
415 
416 Syntax as a command:  wdc gtmwid
417 
418 
419 Syntax as an active function:  [wdc gtmwid]
420 
421 
422 Function: prints the total number of columns on your terminal.  As an
423 active function, returns the total number of columns on your the
424 terminal until either a break character or N characters are read.  You
425 must define the current cursor position.
426 
427 
428 Arguments:
429 get_terminal_width, gtmwid
430    the operation being performed.
431 
432 
433 :Info: wdc.get_unechoed_chars: wdc.guch:  1985-03-01  wdc get_unechoed_chars operation
434 
435 Syntax as a command:  wdc guch -count N {-io_switch STR}
436 
437 
438 Syntax as an active function:  [wdc guch -count N {-io_switch STR}]
439 
440 
441 Function: reads characters from the terminal until either N characters
442 or a break character are read.  You must define the current cursor
443 position.  As an active string, returns two strings:  the first
444 contains any nonbreak characters read, the second contains the break
445 character, if any.
446 
447 
448 Arguments:
449 get_unechoed_chars, guch
450    the operation being performed.
451 
452 
453 Control arguments:
454 -count N, -ct N
455    specifies a count.
456 -io_switch STR, -is STR
457    specifies the name of an I/O switch for a window.  This serves to
458    identify the window.  If you don't provide it, user_i/o is assumed.
459 
460 
461 :Info: wdc.get_window_height: wdc.gwdhgt:  1085-03-01  wdc get_window_height operation
462 
463 
464 Syntax as a command:  wdc gwdhgt {-io_switch STR}
465 
466 
467 Function: prints the height of the specified window.
468 
469 
470 Arguments:
471 get_window_height, gwdhgt
472    the operation being performed.
473 
474 
475 Control arguments:
476 -io_switch STR, -is STR
477    specifies the name of an I/O switch for a window.  This serves to
478    identify the window.  If you don't provide it, user_i/o is assumed.
479 
480 
481 :Info: wdc.insert_text: wdc.itx:  1985-03-01  wdc insert_text operation
482 
483 Syntax as a command:  wdc itx -string STR {-io_switch STR}
484 
485 
486 Function:  displays the text string STR at the current cursor position.
487 If there are any characters to the right of the current position on the
488 current line, they are moved to the right to accommodate the new
489 string.  There is no wrap-around feature:  if text goes off the screen,
490 it is dropped.  The text string STR must contain only printable ASCII
491 characters.  Use "io_call put_chars" to display nonprintable characters
492 in a readable form.
493 
494 
495 Arguments:
496 insert_text, itx
497    the operation being performed.
498 
499 
500 Control arguments:
501 -io_switch STR, -is STR
502    specifies the name of an I/O switch for a window.  This serves to
503    identify the window.  If you don't provide it, user_i/o is assumed.
504 -string STR, -str STR
505    specifies a text string for display, where N must be quoted if it
506    contains blanks.
507 
508 
509 :Info: wdc.invoke:  1985-03-01  wdc invoke operation
510 
511 
512 Syntax as a command:  wdc invoke {-line_speed N}
513 
514 
515 Function: activates the video system on your terminal.  If you give no
516 line speed, the current one is used.  Your terminal must be attached
517 with the tty_ I/O module.  If graphics or auditing is in use, remove it
518 before you give this command.  The settings of the following tty_ modes
519 are copied when you invoke the video system:  vertsp, can, erkl, esc,
520 red, and ctl_char.  In addition, if ^pl is set on video system
521 invocation, ^more will be set in the video system.  (For more details
522 on modes, see the window_io_ I/O module.)  Similarly, the settings of
523 the current erase and kill characters are copied when the video system
524 is invoked.
525 
526 
527 Arguments:
528 invoke
529    the operation being performed.
530 
531 
532 Control arguments:
533 -line_speed N, -ls N
534    specifies the speed of the terminal's connection to Multics, where N
535    is in characters per second.
536 
537 
538 :Info: wdc.overwrite_text: wdc.otx:  1984-02-09  wdc overwrite_text operation
539 
540 
541 Syntax as a command:  wdc otx -string STR {-io_switch STR}
542 
543 
544 Function: displays the text string STR at the current cursor position
545 in the window.  If there is any text to the right of the current
546 position in the window, it is overwritten with the string supplied.
547 The text string STR must contain only printable ASCII characters.  Use
548 "io_call put_chars" to display nonprintable characters in a readable
549 form.
550 
551 
552 Arguments:
553 overwrite_text, otx
554    the operation being performed.
555 
556 
557 Control arguments:
558 -io_switch STR, -is STR
559    specifies the name of an I/O switch for a window.  This serves to
560    identify the window.  If you don't provide it, user_i/o is assumed.
561 -string STR, -str STR
562    specifies a text string for display, where N must be quoted if it
563    contains blanks.
564 
565 
566 :Info: wdc.revoke:  1985-03-01  wdc revoke operation
567 
568 
569 Syntax as a command:  wdc revoke
570 
571 
572 Function: removes the video system from your terminal.  The standard
573 tty_ attachment is restored.  The settings of the following modes are
574 copied when you revoke the video system:  vertsp, can, erkl, esc, red,
575 and ctl_char.  If ^more is set while in the video system, ^pl mode is
576 set after revoking the video system.  (For more details on modes, see
577 the window_io_ I/O module.)  Similarly, the settings of the current
578 erase and kill characters are copied when the video system is revoked.
579 
580 
581 Arguments:
582 revoke
583    the operation being performed.
584 
585 
586 :Info: wdc.scroll_region: wdc.scrgn:  1985-03-01  wdc scroll_region operation
587 
588 
589 Syntax as a command:
590    wdc scrgn -count N {-line N -height N -io_switch STR}
591 
592 
593 Function: scrolls the specified region N lines as indicated by -count.
594 The specified region is the whole width of the screen.  It can be a
595 whole window or part of a window.  If -count N is negative, the window
596 is scrolled down; if positive, the window is scrolled up.  If lines are
597 scrolled off the screen, they are dropped.
598 
599 
600 Arguments:
601 scroll_region, scrgn
602    the operation being performed.
603 
604 
605 Control arguments:
606 -count N, -ct N
607    specifies a count.
608 -height N, -hgt N
609    specifies the height of a region or a window for a request.  If you
610    don't supply it, the default is the remainder of the screen.
611 -io_switch STR, -is STR
612    specifies the name of an I/O switch for a window.  This serves to
613    identify the window.  If you don't provide it, user_i/o is assumed.
614 -line_speed N, -ls N
615    specifies the speed of the terminal's connection to Multics, where N
616    is in characters per second.
617 
618 
619 :Info: wdc.set_position: wdc.spos:  1985-03-01  wdc set_position operation
620 
621 Syntax as a command:  wdc spos -line N -column N {-io_switch STR}
622 
623 
624 Function:  positions the cursor to the specified line and column of the
625 specific window.
626 
627 
628 Arguments:
629 set_position, spos
630    the operation being performed.
631 
632 
633 Control arguments:
634 -column N, -col N
635    specifies a column on the screen.  If you don't give it, the default
636    is the remainder of the screen.  (Default: 1, the leftmost column)
637 -io_switch STR, -is STR
638    specifies the name of an I/O switch for a window.  This serves to
639    identify the window.  If you don't provide it, user_i/o is assumed.
640 -line_speed N, -ls N
641    specifies the speed of the terminal's connection to Multics, where N
642    is in characters per second.
643 
644 
645 :Info: wdc.set_position_rel: wdc.sposrel:  1985-03-01  wdc set_position_rel operation
646 
647 Syntax as a command:  wdc sposrel -line N -column N {-io_switch STR}
648 
649 
650 Function: changes the cursor position by N lines and N columns.  You
651 must define the current cursor position.  You must give one of -line or
652 -column and can use both; whichever control argument you don't supply
653 defaults to zero.
654 
655 
656 Arguments:
657 set_position_rel, sposrel
658    the operation being performed.
659 
660 
661 Control arguments:
662 -column N, -col N
663    specifies a column on the screen.  If you don't give it, the default
664    is the remainder of the screen.  (Default: 1, the leftmost column)
665 -io_switch STR, -is STR
666    specifies the name of an I/O switch for a window.  This serves to
667    identify the window.  If you don't provide it, user_i/o is assumed.
668 -line_speed N, -ls N
669    specifies the speed of the terminal's connection to Multics, where N
670    is in characters per second.
671 
672 
673 :Info: wdc.supported_terminal:  1985-03-01  wdc supported_terminal operation
674 
675 
676 Syntax as a command:  wdc supported_terminal {-ttp terminal_type}
677 
678 
679 Syntax as an active function:
680    [wdc supported_terminal {-ttp terminal_type}]
681 
682 
683 Function: prints the terminal type that is supported by the video
684 system.  If you don't supply a terminal type, the current one is used.
685 As an active function, returns "true" if you can invoke the video
686 system on the given terminal type, "false" otherwise.
687 
688 
689 Arguments:
690 supported_terminal
691    the operation being performed.
692 
693 
694 Control arguments:
695 -terminal_type STR, -ttp STR
696    states the name of the terminal type, where STR is a terminal type.
697    To see accepted terminal types, type "print_terminal_types."
698 
699 
700 :Info: wdc.sync:  1985-03-01  wdc sync operation
701 
702 Syntax as a command:  wdc sync {-io_switch STR}
703 
704 
705 Function: waits for the last operation performed on the window to be
706 completed.  Over certain networks it may not be possible to actually
707 wait for delivery of the characters to the terminals.
708 
709 
710 Arguments:
711 sync
712    the operation being performed.
713 
714 
715 Control arguments:
716 -io_switch STR, -is STR
717    specifies the name of an I/O switch for a window.  This serves to
718    identify the window.  If you don't provide it, user_i/o is assumed.
719 
720 
721 :Info: wdc.video_invoked:  1985-03-01  wdc video_invoked operation
722 
723 
724 Syntax as a command:  wdc video_invoked
725 
726 
727 Syntax as an active function:  [wdc video_invoked]
728 
729 
730 Function: prints the message "The video system has been invoked" if
731 you are already in the video system; otherwise it prints "The video
732 system has not been invoked."  As an active function, returns "true" if
733 the video system is in use in your process, "false" othewise.
734 
735 
736 Arguments:
737 video_invoked
738    the operation being performed.
739 
740 
741 :Info: wdc.write_sync_read: wdc.wsr:  1984-02-09  wdc write_sync_read operation
742 
743 
744 Syntax as a command:  wdc wsr -string STR -count N {-io_switch STR}
745 
746 
747 Syntax as an active function:
748    [wdc wsr -string STR -count N {-io_switch STR}]
749 
750 
751 Function: displays a prompting string STR at the current cursor
752 position in the window and then reads input typed in response to the
753 prompt.  Characters are read unechoed until either N characters or a
754 break character is read.  As an active function, prints a prompting
755 string and returns the characters read.
756 
757 
758 Arguments:
759 write_sync_read, wsr
760    the operation being performed.
761 
762 
763 Control arguments:
764 -count N, -ct N
765    specifies a count.
766 -io_switch STR, -is STR
767    specifies the name of an I/O switch for a window.  This serves to
768    identify the window.  If you don't provide it, user_i/o is assumed.
769 -string STR, -str STR
770    specifies a text string for display, where N must be quoted if it
771    contains blanks.
772 
773 
774 :hcom:
775 
776 
777 
778 /****^  HISTORY COMMENTS:
779   1) change(2020-06-14,GDixon), approve(2021-02-22,MCR10088),
780      audit(2021-05-27,Swenson), install(2021-05-27,MR12.6g-0056):
781       1) Put info seg into new Operations Format supported by verify_info.
782                                                    END HISTORY COMMENTS */
783 
784 
785