home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / new / util / edit / jade / man / jade.info-9 (.txt) < prev    next >
GNU Info File  |  1994-10-16  |  50KB  |  961 lines
  1. This is Info file jade.info, produced by Makeinfo-1.55 from the input
  2. file jade.texi.
  3. START-INFO-DIR-ENTRY
  4. * Jade: (jade).            An editor for X11 and AmigaDOS
  5. END-INFO-DIR-ENTRY
  6.    This is Edition 1.3, last updated 7 October 1994, of `The Jade
  7. Manual', for Jade, Version 3.2.
  8.    Jade is a text editor for X11 (on Unix) and the Amiga.
  9.    Copyright 1993, 1994 John Harper.
  10.    Permission is granted to make and distribute verbatim copies of this
  11. manual provided the copyright notice and this permission notice are
  12. preserved on all copies.
  13.    Permission is granted to copy and distribute modified versions of
  14. this manual under the conditions for verbatim copying, provided that
  15. the entire resulting derived work is distributed under the terms of a
  16. permission notice identical to this one.
  17. File: jade.info,  Node: Indentation Functions,  Next: Translation Functions,  Prev: Transpose Functions,  Up: Text
  18. Indentation Functions
  19. ---------------------
  20.  - Function: indent-pos &optional POS BUFFER
  21.      This function returns the *glyph* position (*note Glyph
  22.      Positions::.) of the first character in the line pointed to by POS
  23.      (or the cursor) which is not a TAB or SPC character.
  24.  - Function: set-indent-pos INDENT-POS &optional BUFFER ONLY-SPACES
  25.      Sets the indentation of the line pointed to by POS to the column
  26.      pointed to by POS by putting the optimal sequence of TAB and SPC
  27.      characters at the start of the line.
  28.      If the ONLY-SPACES argument is non-`nil' no TAB characters will be
  29.      used.
  30.  - Command: indent-to COLUMN &optional ONLY-SPACES
  31.      This function inserts enough TAB and SPC characters to move the
  32.      cursor to glyph column COLUMN.
  33.      If the ONLY-SPACES argument is non-`nil' no TAB characters are
  34.      used.
  35.      Note that COLUMN counts from zero.
  36.      When called interactively the COLUMN argument is either the
  37.      numeric value of the prefix argument or, if no prefix argument has
  38.      been entered, the result of prompting for a number.
  39.  - Command: tab-with-spaces
  40.      This command inserts enough spaces at the cursor position to move
  41.      the cursor to the next tab stop.
  42.    Some major modes provide their own method of indentation (for example
  43. Lisp mode will indent Lisp programs in the proper style), see *Note
  44. Mode-Specific Indentation::.
  45.  - Command: indent-line
  46.      If the current buffer has a method for indentation installed, use
  47.      it to indent the current line to its correct depth.
  48.  - Command: newline-and-indent
  49.      Insert a newline character, then indent the new line; if no
  50.      function for indenting lines has been installed in this buffer a
  51.      single TAB character is inserted.
  52.  - Command: indent-area START-POS END-POS
  53.      Uses the buffer's indentation method to indent all lines in the
  54.      specified region to their correct depth.
  55.      When called interactively the currently-marked block is used to
  56.      get the values of the two arguments, the block is then unmarked.
  57. File: jade.info,  Node: Translation Functions,  Next: Search and Match Functions,  Prev: Indentation Functions,  Up: Text
  58. Translation Functions
  59. ---------------------
  60.  - Function: translate-area START-POS END-POS TRANSLATION-TABLE
  61.           &optional BUFFER
  62.      This function applies the mapping TRANSLATION-TABLE to each
  63.      character in the region starting at the position START-POS up to,
  64.      but not including, END-POS.
  65.      TRANSLATION-TABLE is a string, each character represents the
  66.      mapping for an ASCII character of that character's position in the
  67.      string. If the string is less than 256 characters in length any
  68.      undefined characters will remain unchanged (i.e. a
  69.      TRANSLATION-TABLE of `' would leave the region unaltered).
  70.  - Function: translate-string STRING TRANSLATION-TABLE
  71.      This function uses a similar method to that used in the
  72.      `translate-area' function. Instead of applying the mapping to a
  73.      region of a buffer it applies it to the string STRING. STRING is
  74.      returned (after being modified).
  75.      Note that the STRING really is modified, no copy is made!
  76.           (translate-string "abc" upcase-table)
  77.               => "ABC"
  78.  - Variable: upcase-table
  79.      This is a 256-character long string which may be used as a
  80.      translation table to convert from lower-case to upper-case with
  81.      the functions `translate-string' and `translate-area'.
  82.  - Variable: downcase-table
  83.      Similar to `upcase-table' except that it is used to convert from
  84.      upper-case to lower-case.
  85.    The following functions use the translation functions and the two
  86. translation tables described above.
  87.  - Command: upcase-area START-POS END-POS &optional BUFFER
  88.      Makes all alphabetic characters in the specified region of text
  89.      upper-case.
  90.      When called interactively uses the block marks for its arguments;
  91.      note that this won't work properly with rectangular blocks.
  92.  - Command: downcase-area START-POS END-POS &optional BUFFER
  93.      Similar to `upcase-area' but makes all alphabetic characters
  94.      lower-case.
  95.  - Command: upcase-word COUNT
  96.      For the next COUNT words starting at the cursor position, make
  97.      their alphabetic characters upper-case.
  98.  - Command: downcase-word COUNT
  99.      Does the opposite of `upcase-word', makes words lower-case!
  100.  - Command: capitalize-word
  101.      The first character of this word (normally the one under the
  102.      cursor) is made upper-case, the rest lower.
  103. File: jade.info,  Node: Search and Match Functions,  Next: Rectangular Editing,  Prev: Translation Functions,  Up: Text
  104. Searching and Matching Functions
  105. --------------------------------
  106.    The most powerful of the searching and matching functions are those
  107. using regular expressions, for details of the regexp syntax used by
  108. Jade see *Note Regular Expressions::.
  109.    Note that the regexp matcher *does not work across lines*, at the
  110. moment no regexp may span more than one line. Also the regexp routines
  111. choke on NUL bytes; hopefully I'll correct these problems soon...
  112. * Menu:
  113. * Searching Buffers::           Scanning buffers for something
  114. * String Matching::             Matching regexps to text
  115. * Replacing Strings::           Replacing a found string or regexp with
  116.                                   something else
  117. * Regexp Functions::            General regexp utility functions
  118. File: jade.info,  Node: Searching Buffers,  Next: String Matching,  Up: Search and Match Functions
  119. Searching Buffers
  120. .................
  121.  - Function: find-next-regexp REGEXP &optional POS BUFFER IGNORE-CASE
  122.      This function returns the position of the next substring in the
  123.      buffer matching the regular expression string REGEXP. It starts
  124.      searching at POS, or the cursor position if POS is undefined.
  125.      If no match of the regexp occurs before the end of the buffer `nil'
  126.      is returned.
  127.      If the IGNORE-CASE argument is non-`nil' then the case of matched
  128.      strings is ignored (note that character ranges are still
  129.      case-significant).
  130.  - Function: find-prev-regexp REGEXP &optional POS BUFFER IGNORE-CASE
  131.      Similar to `find-next-regexp' except this searches in the opposite
  132.      direction, from POS (or the cursor) to the *start* of the buffer.
  133.  - Function: find-next-string STRING &optional POS BUFFER
  134.      Scans forwards from POS (or the cursor), in BUFFER (or the current
  135.      buffer), looking for a match with the string STRING. Returns the
  136.      position of the next match or `nil'.
  137.      Note that matches can't span more than one line.
  138.  - Function: find-prev-string STRING &optional POS BUFFER
  139.      A backwards-searching version of `find-next-string'.
  140.  - Function: find-next-char CHARACTER &optional POS BUFFER
  141.      Search forwards for an occurrence of the character CHARACTER and
  142.      returns its position, or `nil' if no occurrence exists.
  143.  - Function: find-prev-char CHARACTER &optional POS BUFFER
  144.      This function searches backwards for an occurrence of the character
  145.      CHARACTER.
  146. File: jade.info,  Node: String Matching,  Next: Replacing Strings,  Prev: Searching Buffers,  Up: Search and Match Functions
  147. String Matching
  148. ...............
  149.  - Function: looking-at REGEXP &optional POS BUFFER IGNORE-CASE
  150.      Returns `t' if the regular expression REGEXP matches the text at
  151.      position POS