home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / editor / gal210a4.arc / APPE.GAL < prev    next >
Text File  |  1989-02-13  |  34KB  |  1,005 lines

  1. .a js=y nm=1 pn=1 hy=n lp=12 bo=51 te=12 to=90
  2. .st3,14,1
  3. &dAppendix%E:%%Function%Reference%Guide .jc
  4. &d[%Appendix%E%] .hc
  5. .t36 E -  .zl
  6.  
  7.  
  8.  
  9.  
  10. &dINTRODUCTION .jr
  11. .st3,11,1 .x-5
  12.  
  13.      This Appendix is the complete reference for &iall of the Galahad editing
  14. and and text formatting functions.  Each is described in detail.  As discussed
  15. in Chapters One through Eight, many of these function are not assigned to keys.
  16. Galahad itself is actually two seperate programs integrated together to form a
  17. word processor.  One program is an editor.  The other is a text formatter.  The
  18. editor is available to be used independently, and is called Percival (PER.COM).
  19. In the description below the first set of function described are the known to
  20. Percival; the secons set to Galahad.
  21.  
  22.  
  23.  
  24.  
  25. .st3,14,1 &dDEFINITIONS .jr
  26. .st3,11,1 .x-5
  27.  
  28.      A few terms need to be discussed before the functions are defined.  The
  29. &itext%buffer holds a copy of the file being edited.  The &ipoint is the place
  30. at which everything happens in the text buffer.  The &iscreen contains one or
  31. two &iwindows into one or two text buffers.  The &icursor shows on the screen
  32. where the point is in the text buffer.  Some more terms are discussed in the
  33. following paragraphs: &iConfirming&s, &iLine%Input&s, &iPrompting&s,
  34. &iPosition&s, and &iSearch%Strings&s.
  35.  
  36.  
  37.  
  38. .n &oConfirming
  39.  
  40.      A confirmation is a special prompt that ends in a question mark.  A single
  41. character response is needed.
  42.  
  43.      A confirmation expects one of a small set of characters.  You may respond
  44. by typing the first letter of one of the choices (case is insignificant), you
  45. may type Control-C (^C), or you may type Return (^M).  In all cases, Control-C
  46. cancels the confirmation, and Return picks the most usual response.  If you do
  47. not type one of the above characters, the bell is rung and you must wait one
  48. second while the typeahead buffer is cleared.  This protects you when you don't
  49. realize that the question will be asked, and you have started to type the next
  50. command.
  51.  
  52.  
  53. .n &oPrompting
  54.  
  55.      The last line on the screen is used for several purposes: to ask you for a
  56. line of text, to ask you for confirmation of some action, to warn you of some
  57. error that has occurred, and to give advisory messages.  You can very easily
  58. determine which is occurring by looking at the last character of the message.
  59. A line input prompt ends in a colon (:), a confirmation or any other message
  60. that expects a single key response ends in a question (?), an error ends in an
  61. exclaim (!), and advice ends in a dot (.).  (Never give advice; wise men won't
  62. need it, fools won't heed it, and everyone else will tell you what's wrong with
  63. it.)
  64.  
  65.      An error message is different from an advisory message in that it results
  66. from an undesired effect of some action that you have taken.  To ensure that
  67. you pay attention to the message, if you have typed ahead, then the typeahead
  68. buffer is cleared.  In any case the bell is rung.
  69.  
  70.  
  71. .n &oLine%Input
  72.  
  73.      A line input message is prompting you to input a line of text, which will
  74. then be interpreted appropriately.  You are placed into a special mode, in
  75. which some of the keys are interpreted differently.  The prompt may contain a
  76. proposed response enclosed in square brackets.  Typing just a return will
  77. accept the proposed response.
  78.  
  79.      In the general case, you will type several printable characters, followed
  80. by the Return key to cause your input to be accepted.  You may wish to cancel
  81. the action that would ordinarily take place by pressing the Control-C key.  A
  82. mistakenly input character may be removed using the Delete, Back Space or
  83. Control-H keys.
  84.  
  85.      Some other keys are recognized, but will be used less often.  The shift
  86. Break key causes the proposed response to be brought in for editing.  The
  87. Control-O (^O) key causes the next word in the text to be brought in for
  88. editing.  The Enter key is synonymous with Return.  Pressing any key that is
  89. assigned to a string only will cause that string to be brought in for editing.
  90. Pressing any key that is assigned to a function will cancel the input line
  91. operation and execute the function.  The InsertControl function allows you to
  92. input a control character.  Pressing the Control-Return key (producting the
  93. Line Feed character) in command mode causes the function(s) assigned to the
  94. CmdLF.  key to be executed.
  95.  
  96.      The various searching commands assign special meaning to some characters,
  97. namely *[]<>$~ and ?.  These characters, as well as control characters, are
  98. included in the search string using InsertControl, which accepts those
  99. characters and shows them on the screen in inverse video.
  100.  
  101.      The bindings given above may be changed.  When Galahad is &ireading%a%line
  102. (&ireading%a &iline means when Galahad is asking for input on the command
  103. line), it looks first for meta keys prefixed with '?'.  By changing the
  104. assignments in the INI file for the meta '?' keys, you can change the meanings
  105. of keys.  All of the functions that deal with reading a line start with
  106. 'Read...'.
  107.  
  108.  
  109. .n &oPosition
  110.  
  111.      There are several functions that deal with the position of the point in
  112. the text.  All of these functions manipulate a stack of positions.  The
  113. examples following each function show a stack that is four positions long,
  114. while the real stack is sixteen positions long.
  115. .g
  116.  
  117. .n &oSearch%Strings
  118.  
  119.      Search strings may contain special characters.  These special characters
  120. do not literally match themselves but instead match other zero or more normal
  121. characters.  Special characters must be included in the search string by
  122. prefixing them with &dInsertControl command (cF10).  The special characters
  123. are:
  124. .i16
  125. .u8    <    .t16 Matches the left hand edge of a line. .b
  126. .u8    >    .t16 Matches the right hand edge of a line. .b
  127. .u8    ?    .t16 Matches any single character except newline. .b
  128. .u8    ~"    .t16 Matches, for example, any single character but double
  129. quote. .b
  130. .u8    [.;!]    .t16 Matches, for example, any one of dot, semi, or exclaim. .b
  131. .u8    [a-z]    .t16 Matches, for example, any lowercase letter. .b
  132. .u8    [a-]    .t16 Matches, for example, lowercase a and dash. .b
  133. .u8    [-z]    .t16 Matches, for example, dash and lowercase z. .b
  134. .u8    [~xyz]    .t16 Matches, for example, any single character execpt
  135. lowercase x, lowercase y, or lowercase z. .b
  136. .u8    a*    .t16 Matches, for example, zero or more occurrences of
  137. lowercase a. .b
  138. .u8    ?*    .t16 Matches, for example, zero or more occurrences of
  139. anything.  This has the effect of matching an entire line.
  140. .i0
  141. .n4
  142.  
  143.  
  144.  
  145. .st3,14,1
  146. &dTHE%PERCIVAL%FUNCTIONS .jr
  147. .st3,11,1 (Text Editing) .jr
  148. .x-5
  149.  
  150.  
  151. .n &dAppendFile
  152.  
  153.      Prompts for a filename, whose contents are appended to the &icurrent
  154. buffer (i.e., the buffer being displayed).
  155.  
  156.  
  157. .n &dAsciiFile
  158.  
  159.      Causes &iLoadFile to stop loading the file when the terminating Control-Z
  160. character is found, and removes the Control-Z from the end of file.  Causes
  161. &iSaveFile to put the Control-Z back, if there was one.  This action is
  162. required by Standard ASCII files.  It is the normal way to handle text files.
  163.  
  164.      When Percival is running under Galahad, a few control characters are
  165. translated to provide special marks for editing functions.  When Percival is
  166. running stand alone &ino charcater translation is done.
  167.  
  168.  
  169. .n &dBinaryFile
  170.  
  171.      Files are loaded and saved as is.
  172.  
  173.  
  174. .n &dBlockCursor
  175.  
  176.      The cursor is set to a square block.  &iUnderscoreCursor will set the
  177. cursor to an underscore.
  178.  
  179.  
  180. .n &dBufferList
  181.  
  182.      The list of buffers, and the files contained in the buffers, is shown on
  183. the screen (along with some technical data about the buffer contents).
  184.  
  185.  
  186. .n &dBye
  187.  
  188.      If no text buffers have been modified, and you are in command mode, then
  189. you are returned to MS-DOS.  If you are not in command mode, you are asked if
  190. you really want to quit.  Otherwise, you are asked what to do with each
  191. modified text buffer: save, scratch, or cancel the entire operation and start
  192. editing again.
  193.  
  194.  
  195. .n &dCDirectory
  196. .n &dChDirectory
  197.  
  198.      You are prompted for a new directory string.  This function is exactly
  199. identical to the MS-DOS command chdir.
  200.  
  201.  
  202. .n &dCenter
  203.  
  204.      The cursor is centered in the window.
  205.  
  206.  
  207. .n &dChangeCase
  208.  
  209.      The character to the right of the cursor is changed from uppercase to
  210. lowercase or vice versa.  Non-letters are not changed.  The cursor position is
  211. moved one character to the right.
  212.  
  213.  
  214. .n &dChangeHighBit
  215.  
  216.      The character to the right of the cursor has its high bit changed.  The
  217. cursor position is moved one character to the right.
  218.  
  219.  
  220. .n &dCommand
  221.  
  222.      Prompts for a function name, and executes the first matching function.
  223. Gives an error if no function name is matched.
  224.  
  225.  
  226. .n &dCommandMode
  227.  
  228.      Causes the Command function to be repeatedly executed until the &iEditMode
  229. function is executed.  Has no effect if in command mode.
  230.  
  231.  
  232. .n &dCompareWindow
  233.  
  234.      The buffers being shown in both windows are compared character by
  235. character, starting at the cursor position in each buffer.  The comparison
  236. stops at the first mismatch or end of file.  No effect if in OneWindow mode.
  237.  
  238.  
  239. .n &dCutText
  240.  
  241.      The text showing in inverse video (see &iShowSelect) is removed and placed
  242. in the insert buffer.
  243.  
  244.  
  245. .n &dDefaultExtension
  246.  
  247.      If you do not supply an extension when giving a filename, the default
  248. extension will be used.  This function sets the default extension.  'GAL' is
  249. the initial default extension.
  250.  
  251.  
  252. .n &dDeleteFile
  253.  
  254.      Prompts for the name of a file to delete.
  255.  
  256.  
  257. .n &dDeleteLeft
  258.  
  259.      The character to the left of the cursor position is deleted.
  260.  
  261.  
  262. .n &dDeleteUnder
  263.  
  264.      The character under the cursor (to the right of the point) is deleted.
  265.  
  266.  
  267. .n &dDelToEnd
  268.  
  269.      All the characters between the cursor and the end of the current line are
  270. deleted.
  271.  
  272.  
  273. .n &dDelWordLeft
  274.  
  275.      The word to the left of the cursor is deleted.  A word boundary appears
  276. wherever a boundary is formed between the set of characters: 0-9, A-Z, a-z, and
  277. the set of characters consisting of everything else.
  278.  
  279.  
  280. .n &dDelWordRight
  281.  
  282.      The word to the right of the cursor position is deleted.
  283.  
  284.  
  285. .n &dDirectory
  286.  
  287.      Prompts for a file specifier and lists all the files matching it.  If no
  288. disk drive is given, the default disk is used.  If no extension is given, the
  289. default extension is used.
  290.  
  291.  
  292. .n &dDisplayString
  293.  
  294.      The following string is displayed on the screen.  This is most useful in
  295. the definition of the "Init." key to show the use of different INI files.
  296.  
  297.  
  298. .n &dEditFile
  299. .n &dEditMode
  300.  
  301.      Exits command mode and prompts you for a filename to edit.  If no filename
  302. is entered, then the current file is edited.
  303.  
  304.  
  305. .n &dExecuteCommand
  306.  
  307.      ExecuteCommand clears the screen and then runs ExecuteProgram.
  308.  
  309.  
  310. .n &dExecuteFilter
  311.  
  312.      MS-DOS comes with several programs that read their input, modify it, and
  313. write it.  These programs are called filters.  Galahad has the ability to send
  314. part of your text file through one of these filters.  You can select the part
  315. to be filtered by executing &iStorePosition at the top of the text, and
  316. positioning the cursor at the bottom of the text to be "filtered", and
  317. executing &iExecuteFilter followed by the name of the filter and any required
  318. parameters.
  319.  
  320.  
  321. .n &dExecuteKey
  322.  
  323.      ExecuteKey takes the string supplied as an argument, determines a key name
  324. from it, and executes the functions assigned to the key as if the key had been
  325. pressed.
  326.  
  327.  
  328. .n &dExecuteProgram
  329.  
  330.      The editor sends the remainder of the line (after ExecuteProgram -- the
  331. argument) to MS-DOS for execution.  Any command recognized by COMMAND.COM may
  332. be given.
  333.  
  334.  
  335. .n &dExternalCommand
  336.  
  337.      ExecuteCommand takes the string supplied as an argument and interprets it
  338. as a command to be passed to an external program (such as Galahad) so that the
  339. external program can execute them.  If the external program does not execute
  340. the command (or if there is no external program), then the command is
  341. interpreted as a Percival command.  If the command is not a valid Percival
  342. command, Percival will report "Unknown Command.".
  343.  
  344.  
  345. .n &dFileInfo
  346.  
  347.      Various information about the current buffer is displayed.
  348.  
  349.  
  350. .n &dFormatIndented
  351.  
  352.      The current paragraph is filled so that each line is no longer than the
  353. line length specified by the options function.  Unlike FormatPara, you must
  354. position the cursor at the first line of the paragraph, and the column that the
  355. paragraph is to be indented to.  The end is either an empty line or a line
  356. beginning with whitespace or a period.  The ending line is considered to be
  357. part of the next paragraph.
  358.  
  359.  
  360. .n &dFormatPara
  361.  
  362.      The current paragraph is filled so that each line is no longer than the
  363. line length specified by the options function.  A paragraph is bounded at
  364. beginning and end by an empty line or a line beginning with whitespace or a
  365. period.  The ending line is considered to be part of the next paragraph.
  366.  
  367.  
  368. .n &dGiveHelp
  369.  
  370.      Prompts you for a key, and gives you as much help as it can when that key
  371. is pressed.  Help is provided for only the function and keypad keys.
  372.  
  373.  
  374. .n &dGotoLine
  375.  
  376.      Prompts you for a line number where the cursor is to be placed in the
  377. text.
  378.  
  379.  
  380. .n &dGrowWindow
  381.  
  382.      The current window (in the two window mode) is expanded by one line.  No
  383. action occurs if there is only one window.  If the other window is reduced to
  384. zero lines, then it becomes invisible and only one window is used.
  385.  
  386.  
  387. .n &dHelpMode
  388.  
  389.      A synonym for &iGiveHelp, which prompts you for a key, and gives you as
  390. much help as it can when the key is pressed.
  391.  
  392.  
  393. .n &dHideSelect
  394.  
  395.      All text between the cursor position and the most recently saved position
  396. is no longer shown in inverse video.  No action occurs if &iShowSelect has not
  397. been executed first.
  398.  
  399.  
  400. .n &dHistoryEnable
  401.  
  402.      If you have a string of the form 'History:' in the first three lines of
  403. your file, presumably on a line with =.CL or inside a programming language
  404. comment, AND you have executed HistoryEnable, Galahad will store the current
  405. line after the colon.  When a file containing 'History:' is loaded by
  406. &dLoadFile, the cursor is positioned in the file on the line where it was when
  407. the file was saved.
  408.  
  409.  
  410. .n &dInsertControl
  411.  
  412.      Prompts for a control character to insert into the text, or to insert into
  413. the command string of a function (e.g. SearchForNext).  Press the desired
  414. control key.  Some other non-control keys are recognized by &dInsertControl.
  415. The 0 key (not keypad) inserts the "start eighth bit" special character, the 1
  416. key inserts the "stop eighth bit" special character, the 2 key inserts the
  417. "alternate character" special character, and the 3 key inserts the "spelling
  418. check" special character which is placed in the text by Guenevere.  The
  419. following characters cause the equivalent character with the high bit set to be
  420. inserted: <>[]*~$? (used in search strings -- discussed above).  Any other key
  421. rings the bell.
  422.  
  423.      Note that most control characters are represented on the screen by special
  424. characters.  These representations are shown in most IBM compatible printer
  425. manuals.
  426.  
  427.  
  428. .n &dInsertFile
  429.  
  430.      Prompts for a filename, whose contents are inserted into the buffer at the
  431. cursor position.
  432.  
  433.  
  434. .n &dInsertNewline
  435.  
  436.      Inserts a new line at the cursor position.
  437.  
  438.  
  439. .n &dInsertText
  440.  
  441.      The insert buffer is inserted after the cursor position.  The insert
  442. buffer if filled by the SelectText and CutText commands.
  443.  
  444.  
  445. .n &dInsertTextLeft
  446.  
  447.      The insert buffer is inserted before the cursor position.  The insert
  448. buffer if filled by the SelectText and CutText commands.
  449.  
  450.  
  451. .n &dListText
  452.  
  453.      The current buffer is listed to a given device or file, for which you are
  454. prompted.  The device defaults to the screen.  Legal devices are: PRN:, LST:,
  455. COM1, COM2, or any file name.
  456.  
  457.  
  458. .n &dLoadBuffer
  459.  
  460.      Searches for an empty buffer to load a file into.  If there is none, a new
  461. buffer is created.  Prompts you for a file to load.  If you cancel without
  462. giving a filename, you will be in an empty buffer with a filename of NONAME and
  463. the default extension (either GAL or as set by DefaultExtension).
  464.  
  465.  
  466. .n &dLoadCommand
  467.  
  468.      The file(s) mentioned in the MS-DOS command line when you executed either
  469. GAL2 or PER is loaded.  If you are in Command Mode and a file is loaded then
  470. you are placed in Edit Mode, otherwise you are left in Command Mode.  If you
  471. are in EditMode, then you are always left in &iEditMode.  If you mention more
  472. than one file, the first file mentioned is left in the top window, and the last
  473. file mentioned is left in the bottom window.
  474.  
  475.  
  476. .n &dLoadFile
  477.  
  478.      Prompts you for a file name to load into the current text buffer.  If the
  479. current text has been modified, you are given a chance to &iSave it, &iDiscard
  480. it (i.e. not save it), or &iCancel the LoadFile command.
  481.  
  482.  
  483. .n &dLowerCase
  484.  
  485.      The character to the right of the cursor position is changed from
  486. uppercase to lowercase.  Non-uppercase letters are not changed.  The cursor is
  487. moved one character to the right.
  488.  
  489.  
  490. .n &dMakeBufferUnmodified
  491.  
  492.      Galahad remembers whether or not you have modified a buffer.  Executing
  493. &iMakeBufferUnmodified causes Galahad to forget that the buffer has been
  494. modified.
  495.  
  496.  
  497. .n &dMetaKey
  498.  
  499.      When &iMetaKey is assigned to a key, that key when pressed causes the next
  500. key pressed to take on special meaning.  This is similar to the pressing Control
  501. and another key at the same time, except this is a two key sequence: the meta
  502. key and the next key.  Call this second key a "metaized" key.  When the key to
  503. be a meta key is defined using the &iMetaKey function, a string is specified.
  504. The first character specifies the meta code character and the remainder of the
  505. string is printed on the command line when the meta key is pressed.  The
  506. following example should help to see how the metaized key takes on special
  507. meaning.  Assume the following definitions:
  508.  
  509.      Escape==MetaKey "1Meta Active - Press Companion Key";
  510.      ^R==SearchForPrev;
  511.      M1^R==ReplaceQuery;
  512.  
  513.      The Esc key is the meta key, its code is 1.  When Control-R is pressed it
  514. executes SearchForPrev, but when Esc then Control-R are pressed the ReplaceQuery
  515. function is executed.  The lead in M1 to ^R defines its action in the metaized
  516. state.  There can be more than one meta key defined.  See GAL101.INI, Esc and
  517. ^X are both meta keys.
  518.  
  519.      Help for metaized keys is available by pressing a metaized key that
  520. executes &iGiveHelp or by pressing the key that is mapped to the desired
  521. &iMetaKey prior to pressing your key.
  522.  
  523.  
  524. .n &dMoveDown
  525.  
  526.      The cursor is moved down by one line, keeping the cursor as near to the
  527. same column as possible.
  528.  
  529.  
  530. .n &dMoveLeft
  531.  
  532.      The cursor is moved one character to the left.  Nothing happens if you try
  533. to move past the beginning of the file.
  534.  
  535.  
  536. .n &dMoveRight
  537.  
  538.      The cursor is moved one character to the right.  Nothing happens if you
  539. try to move past the end of the file.
  540.  
  541.  
  542. .n &dMoveToBottom
  543.  
  544.      Moves the cursor to the bottom of the file.
  545.  
  546.  
  547. .n &dMoveToLeft
  548.  
  549.      Moves the cursor to the left margin.
  550.  
  551.  
  552. .n &dMoveToMouse
  553.  
  554.      This command is normally executed by pressing a mouse key.  In that event
  555. the cursor is moved to the character that the mouse cursor is pointing to.
  556. This action is repeated until any key is pressed.  (This causes the text cursor
  557. to follow the mouse cursor.)  Typically that key is either LeftUp or RightUp,
  558. the mouse button release codes.
  559.  
  560.  
  561. .n &dMoveToRight
  562.  
  563.      Moves the cursor to the right end of the line.
  564.  
  565.  
  566. .n &dMoveToTop
  567.  
  568.      Moves the cursor to the top of the file.
  569.  
  570.  
  571. .n &dMoveUp
  572.  
  573.      The cursor is moved up by one line, keeping the cursor as near to the same
  574. column as possible.
  575.  
  576.  
  577. .n &dMoveWordLeft
  578.  
  579.      The cursor is moved to the end of the word to the left, or if on a white
  580. space character (Space of Tab) the cursor is moved to the beginning of the next
  581. word.
  582.  
  583.  
  584. .n &dMoveWordRight
  585.  
  586.      The cursor is moved to the beginning of the word to the right, or if on a
  587. white space character (Space of Tab) the cursor is moved to the end of
  588. the previous word.
  589.  
  590.  
  591. .n &dNameText
  592.  
  593.      Prompts you for a new name for the current text.  Caution must be observed
  594. when using this function in an Init. definition because both the filename and
  595. extension default to the current filename and extension.  When Init. executes,
  596. there is no current filename and extension, so be sure to mention both filename
  597. and extension.  A good choice for the filename is "NONAME"
  598.  
  599.  
  600. .n &dNewBuffer
  601.  
  602.      Creates an empty buffer and puts the cursor at the beginning of the new
  603. buffer.
  604.  
  605.  
  606. .n &dNextBuffer
  607.  
  608.      The buffers are arranged as a ring of buffers.  &iNextBuffer takes you to
  609. the next one.  Empty buffers are skipped.
  610.  
  611.  
  612. .n &dOneWindow
  613.  
  614.      The current window is expanded to fill the entire screen.  No action
  615. occurs if there is only one window.
  616.  
  617.  
  618. .n &dOptions
  619.  
  620.      Prompts you for some options whose prompts are self-explanatory, and refer
  621. to the printer actions when the ListText command is used, and the length of the
  622. text line in the Edit mode.
  623.  
  624.  
  625. .n &dOtherWindow
  626.  
  627.      The buffer shown in the other window is selected as the current buffer,
  628. and the cursor is move to its position in that buffer.  No action occurs if
  629. there is only one window.
  630.  
  631.  
  632. .n &dPageDown
  633.  
  634.      Prompts you for a percentage of the screen to move down.  The default is
  635. the same as the previous value.  This parameter will most often be supplied in
  636. the key definition.
  637.  
  638.  
  639. .n &dPageUp
  640.  
  641.      Similar to PageDown, but the cursor is moved up, not down.
  642.  
  643.  
  644. .n &dQuit
  645.  
  646.      If no text buffers have been modified, then you are returned to MS-DOS.
  647. Otherwise, you are asked what to do with each modified text buffer: Save (save
  648. the file), Discard (do not save the file), or Cancel the entire operation and
  649. start editing again.  Pressing either S, D or C causes the action.
  650.  
  651.  
  652. .n &dReadAccept
  653.  
  654.      Used only while reading a line on the Command Line.  The line as shown
  655. will be accepted.
  656.  
  657.  
  658. .n &dReadCancel
  659.  
  660.      Used only while reading a line on the Command Line.  The current line will
  661. be discarded, and the prompt will go away.
  662.  
  663.  
  664. .n &dReadChar
  665.  
  666.      Used only while reading a line on the Command Line.  The next character in
  667. the text buffer gets placed at the end of the input line.
  668.  
  669.  
  670. .n &dReadDelete
  671.  
  672.      Used only while reading a line on the Command Line.  The last character is
  673. removed from the input line.
  674.  
  675.  
  676. .n &dReadHelp
  677.  
  678.      Used only while reading a line on the Command Line.  The help string
  679. assigned to the current key being executed will get printed on the screen.
  680.  
  681.  
  682. .n &dReadInitBuffer
  683.  
  684.      The current buffer is treated as an INI file.  Very useful for creating
  685. temporary key definitions to do some complicated sequence of functions.
  686.  
  687.  
  688. .n &dReadOld
  689.  
  690.      Used only while reading a line on the Command Line.  The "old" string,
  691. given inside square brackets, is appended to the end of the input line.
  692.  
  693.  
  694. .n &dReadWord
  695.  
  696.      Used only while reading a line on the Command Line.  The next word in the
  697. text buffer is appended to the end of the input line.
  698.  
  699.  
  700. .n &dRecordKey
  701.  
  702.      You are prompted for a key name.  All functions executed until the next
  703. time you execute &iRecordKey with the same name are assigned to that key.
  704.  
  705.  
  706. .n &dReferWindow
  707.  
  708.      The current line is examined for an occurrence of the string "Refer:".  If
  709. such a string is found, decimal digits immediately following the colon are
  710. converted into a line number, and the &iother window is positioned to that line
  711. number.  Using this function you can a simplistic form of hypertext.
  712.  
  713.  
  714. .n &dRenameFile
  715.  
  716.      Prompts for two filenames.  The first file is renamed to the second.
  717.  
  718.  
  719. .n &dReplaceInAllBufs
  720.  
  721.      Exactly like &iReplaceQuery, but the replacement operation is performed
  722. for every text buffer in memory.  Very handy for changing multiple chapters, or
  723. multiple source files.
  724.  
  725.  
  726. .n &dReplaceQuery
  727.  
  728.      Prompts you for a string to search for, and a replace string.  The buffer
  729. is searched from the top to the bottom for the string.  When a match is found,
  730. you are given several choices.  You can confirm this replacement with &dY&tes;
  731. deny this replacement with &dN&to or Return; confirm all the remaining
  732. replacements with &dC&thange every match; or deny this and all remaining
  733. replacements with &dQ&tuit replace or Control-C.   The replace string may
  734. contain a special character represented by a special dollar sign ($).  When a
  735. replacement occurs, the entire matched string (i.e., the search string) is
  736. substituted for the $.  The $ is included in the replace string using
  737. Control-F10 (NOT the normal $ character).
  738.  
  739.  
  740. .n &dReplaceToBottom
  741.  
  742.      Identical to &iReplaceQuery but the search starts at the character
  743. following the cursor position.
  744.  
  745.  
  746. .n &dRestorePosition
  747.  
  748.      The point (i.e., cursor position) and top of "point" stack are swapped,
  749. and the point stack is rolled.
  750. .i16 Point
  751. .t40    becomes Top of stack Top of stack
  752. .t40    becomes 2nd on stack 2nd on stack
  753. .t40    becomes 3rd on stack
  754. .t40    last on stack becomes Point
  755. .i0
  756.  
  757.  
  758. .n &dSavePosition
  759.  
  760.      The point (i.e., cursor position) is pushed onto the top of the "point"
  761. stack.
  762. .n5 .i16 Point
  763. .t40   stays the same Top of stack
  764. .t40   becomes Point 2nd on stack
  765. .t40   becomes Top of stack 3rd on stack
  766. .t40   becomes 2nd on stack etc.
  767. .i0
  768.  
  769. .n &dSaveText
  770.  
  771.      Prompts you for a name to save the current buffer into.  Defaults to the
  772. name that you loaded the file with.  If the file already exists then you are
  773. given a choice of &dR&teplacing the old file or making it into a &dB&tackup, or
  774. &dC&tancelling the operation (do nothing and return to Edit or Command mode).
  775. Pressing Return will also &ireplace the old file.
  776.  
  777.  
  778. .n &dScratchText
  779.  
  780.      If the current text has been modified, you are given a chance to &dS&tave
  781. it, &dS&tcratch it (empty the buffer, i.e., discard the text), or &dC&tancel
  782. the scratch command (do nothing).  Sets the filename to NONAME, and the
  783. extension is set to the default.
  784.  
  785.  
  786. .n &dScreenColor
  787.  
  788.      You will be prompted for a foreground and background color.  You may
  789. choose from: white, yellow, magenta, red, cyan, green, blue, black.
  790.  
  791.  
  792. .n &dSearchForNext
  793.  
  794.      Prompts you for a string for which to search.  The buffer is searched
  795. for the string from the first character following the cursor to end of the
  796. text. If the string is not found, then a message to that effect is printed out.
  797.  
  798.  
  799. .n &dSearchForPrev
  800.  
  801.      Prompts you for a string for which to search.  The buffer is searched for
  802. the string from the character preceding the cursor position to the beginning of
  803. the text.  If the string is not found, then a message to that effect is printed
  804. out.
  805.  
  806.  
  807. .n &dSearchFromTop
  808.  
  809.      Prompts you for a string for which to search.  The buffer is searched for
  810. the string from beginning to end of the text.  If the string is not found, then
  811. a message to that effect is printed out.
  812.  
  813.  
  814. .n &dSelectText
  815.  
  816.      The first time that you execute this function, a special mark character is
  817. inserted into the buffer.  The mark character appears as a "squiggle"
  818. similar to that used to mark footnotes in printed texts; call it the mark
  819. character.  The second time that you execute this function, all text between
  820. the cursor position and the mark character is removed (cut) from the buffer and
  821. placed into the special insert buffer.  (See InsertText.)  If you wish to
  822. change your mind and move the mark after you have placed it (but before you
  823. have cut the text), you may do so by deleting the mark character, as any
  824. other character, and continuing as though you hadn't executed this function.
  825.  
  826.      Strings longer than an arbitrary size are treated specially, and take
  827. longer to cut.  Be patient.
  828.  
  829.  
  830. .n &dShowSelect
  831.  
  832.      All text between the cursor position and the most recently saved position
  833. (see SavePosition) is shown in inverse video.  This continues until the
  834. &iHideSelect function is executed.
  835.  
  836.  
  837. .n &dSpellCheck
  838.  
  839.      The word &ipreceding the cursor position will be spell checked (if the
  840. command SpellerOn has been executed).  If the word is misspelled the bell will
  841. ring.  The function is dependent upon the Clarkson Speller being installed
  842. before running Galahad (See Appendix H).
  843.  
  844.  
  845. .n &dSpellerOff
  846.  
  847.      Causes &iSpellCheck to have no effect.
  848.  
  849.  
  850. .n &dSpellerOn
  851.  
  852.      Causes &iSpellCheck to spell check words.
  853.  
  854.  
  855. .n8 &dSwapPosition
  856.  
  857.      The point (cursor position) and the most recently saved position are
  858. swapped.
  859. .n5 .i16 Point
  860. .t40   becomes Top of stack Top of stack
  861. .t40   becomes Point 2nd on stack
  862. .t40   stays the same 3rd on stack
  863. .t40   stays the same etc.
  864. .i0
  865.  
  866.  
  867. .n &dTabToPrev
  868.  
  869.      If the current line is empty then it is tabbed out to the same column as
  870. the previous line.
  871.  
  872.  
  873. .n &dTieWindows
  874.  
  875.      The two windows are tied together so that they scroll in unison.
  876.  
  877.  
  878. .n &dToggleReplace
  879.  
  880.      The insert/replace flag is toggled (changed from on to off, or vise
  881. versa).  The flag is initially off, which means that all characters entered
  882. from the keyboard are inserted into the text at the cursor position.  When the
  883. flag is on, all characters entered from the keyboard replace the characters
  884. under the cursor, if there are any.
  885.  
  886.  
  887. .n &dToggleShowBlanks
  888.  
  889.      The show blanks flag is toggled (changed from on to off, or vise versa).
  890. The flag is intially off, which means that trailing blanks and tabs are not
  891. visible.  When the flag is on, trailing blanks and tabs are displayed visibly
  892. on the screen using special characters.
  893.  
  894.  
  895. .n &dToggleSplit
  896.  
  897.      The split/nosplit flag is toggled (changed from on to off, or vise versa).
  898. The flag is initially off, which means that inserting a character into a line
  899. which exceeds a given line length causes the paragraph containing the line to
  900. be re-formatted starting at the cursor position.  When the flag is on, lines
  901. may be any length and will never be split.
  902.  
  903.  
  904. .n5 &dTransposeChars
  905.  
  906.      The two characters to the right of the cursor position are transposed.  If
  907. either of the characters is the end of line, no action occurs.
  908.  
  909.  
  910. .n &dTwoWindow
  911.  
  912.      The screen is split horizontally into two screens, equal in size.  The
  913. current buffer is shown in the both windows.
  914.  
  915.  
  916. .n &dUnderscoreCursor
  917.  
  918.      The cursor is set to an underscore.  &iBlockCursor will set the cursor to
  919. a block.
  920.  
  921.  
  922. .n &dUndoChange
  923.  
  924.      Any changes made to the current line, including deleting it, may be undone
  925. as long as the cursor remains on the line.
  926.  
  927.  
  928. .n &dUntieWindows
  929.  
  930.      The action of &iTieWindows is undone.
  931.  
  932.  
  933. .n &dUpperCase
  934.  
  935.      The character to the right of the cursor position is changed from
  936. lowercase to uppercase.  Non-letters and uppercase letters are not changed.
  937. The cursor is moved one character to the right.
  938.  
  939.  
  940. .n &dUserPhrase
  941.  
  942.      You are prompted for a key name, and then a phrase to be assigned to that
  943. key.
  944.  
  945.  
  946. .n &dWindowMargin
  947.  
  948.      Prompts you for the top and bottom margins of the screen.  The cursor will
  949. not enter the margin but instead the screen will scroll.  The margin numbers
  950. are expressed as a percentage of the size of the screen.
  951.  
  952.  
  953. .n &dWriteInitBuffer
  954.  
  955.      The INI file that was used to configure your Galahad is reconstructed and
  956. inserted into the current buffer.
  957.  
  958.  
  959. .st3,14,1 &dTHE%GALAHAD%FUNCTIONS .jr
  960. .st3,11,1 (Text Printing) .jr
  961. .x-5
  962.  
  963.  
  964. .n &dImmediate
  965.  
  966.      The &iImmediate command allow the user to supply a set of Dot-A command
  967. which will override the value of Dot-A commands in the text, or supply new
  968. values for those not in the text.  This command is normally entered on the
  969. command line before printing.  For example: imm al==y lp==10
  970.  
  971.  
  972. .n &dConfigurePrinter
  973.  
  974.      This command causes the Printer Configuration Menu to pop up.  This is
  975. the command which is bound key Esc P in the supplied default GAL101.INI or
  976. GAL83.INI files.  Once Galahad is configured for a printer, it remains
  977. configured for that printer until change by this command.
  978.  
  979.  
  980. .n &dGalahadHelp
  981.  
  982.      This command causes the Galahad Help Menu to pop up.  The same as
  983. executing the keys Shift Return H G.
  984.  
  985.  
  986. .n &dPrintText
  987.  
  988.      The command to cause Galahad to format the current buffer and send it to a
  989. device or file.  The default device is the screen.  Legal devices are the
  990. MS-DOS devices LPT, PRN, COM1, etc.  A file may be any legal file name.  In
  991. addition to a device of file name the command takes three optional numbers: 1)
  992. the page to start printing, 2) the page to end printing, and 3) the number of
  993. files to process if the Galahad Dot-F (.F) command is used.
  994. .i34
  995.      Examples:
  996. .u26 print prn .t30 - Print to the prn device (the printer).
  997. .u26 print prn 1,2 .t30 - Print to the printer pages 1 and 2.
  998. .u26 print myfile.txt .t30 - Print all pages to the file myfile.txt.
  999. .u26 print myfile 4,10,2 .t30 - Print only pages 4 thorugh 10, which will be in
  1000. two file for Galahad to process.
  1001. .u26 print com1 ,4 .t30 - Print to the COM1 device pages 1 through 4.
  1002.  
  1003.      NOTE: Be sure that Galahad must first be configured, using
  1004. &iConfigurePrinter, for your printer.
  1005.