home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / new / util / edit / jade / doc < prev    next >
Text File  |  1994-10-16  |  103KB  |  1,963 lines

  1. make-buffer-name NAME
  2.  
  3. Construct a unique buffer-name from NAME. make-buffer NAME
  4.  
  5. Return a new buffer, it's name is the result of (make-buffer-name NAME). destory-buffer BUFFER
  6.  
  7. Throw away everything associated with buffer. All resident marks are made
  8. non-resident. get-file-buffer NAME
  9.  
  10. Scan all buffers for one containing the file NAME. get-buffer NAME
  11.  
  12. Scan all buffers for one whose name is NAME. current-buffer [WINDOW]
  13.  
  14. Return the buffer that WINDOW (or the current window) is displaying. set-current-buffer BUFFER [WINDOW]
  15.  
  16. Set the buffer that WINDOW (or the current window) is displaying. Returns
  17. the buffer which was being displayed before. buffer-file-name [BUFFER]
  18.  
  19. Return the name of the file being edited in BUFFER. set-buffer-file-name BUFFER NAME
  20.  
  21. Set the name of the file being edited in BUFFER to NAME. buffer-name [BUFFER]
  22.  
  23. Return the name of BUFFER. set-buffer-name BUFFER NAME
  24.  
  25. Set the name of BUFFER to NAME. buffer-changes [BUFFER]
  26.  
  27. Return the number of modifications to BUFFER. buffer-modified-p [BUFFER]
  28.  
  29. Returns t if the buffer has changed since it was last saved. set-buffer-modified BUFFER STATUS
  30.  
  31. If STATUS is nil make it look as though buffer hasn't changed, else make
  32. it look as though it has. set-buffer-special BUFFER SPECIALP
  33.  
  34. When a buffer is `special' it means that it is controlled by some Lisp code,
  35. not by the user typing into it (although this can still happen as well). This
  36. is used for things like the `*jade*' or `*Info*' buffers (in fact most of
  37. the buffers whose names are surrounded by asterisks are special).
  38.  
  39. What the `special' attribute actually does is make sure that the buffer is
  40. never truely killed (`kill-buffer' removes it from each window's `buffer-list'
  41. but doesn't detroy the actual contents) and modifications don't cause the
  42. `+' marker to appear in the status line. buffer-special-p [BUFFER]
  43.  
  44. Returns t if BUFFER is ``special''. See `set-buffer-special' for the meaning of
  45. the ``special'' attribute. set-buffer-read-only BUFFER READ-ONLY-P
  46.  
  47. If a buffer is read-only no modification of its contents is allowed. buffer-read-only-p [BUFFER]
  48.  
  49. Returns t if BUFFER is read-only. See `set-buffer-read-only'. buffer-length [BUFFER]
  50.  
  51. Returns the number of lines in BUFFER. line-length [LINE-POS] [BUFFER]
  52.  
  53. Returns the length (not including newline) of the specified line, or
  54. using current cursor position if specifiers are not provided. with-buffer BUFFER FORMS...
  55.  
  56. Temporarily switches to buffer, then executes the FORMS in it before
  57. returning to the original buffer. bufferp ARG
  58.  
  59. Returns t if ARG is a buffer. The number of modifications which must be made to a buffer before it
  60. is considered for auto-saving. A value of zero means that this buffer
  61. is not to be auto-saved. Number of changes the last time this buffer was saved (could be auto-save). Number of changes the last time this buffer was saved (not from auto-save). System time at last save of this buffer (could be from an auto-save). Sets the size of tab-stops. This is used to display the name of the edit-mode being used in the status
  62. line. List of strings naming all minor-modes enabled in this buffer. make-mark [POS] [BUFFER | FILE-NAME]
  63.  
  64. Creates a new mark pointing to position POS either in the current file
  65. or in FILE-NAME, or BUFFER.
  66.  
  67. Note that FILE-NAME doesn't have to be a file that has been loaded, it's
  68. stored as a string, the file it points to is only opened when needed.
  69.  
  70. Unlike position objects, the position in a file that a mark points to is
  71. updated as the file changes -- it will always point to the same character
  72. (for as long as that character exists, anyway). set-mark MARK [POS] [FILE-NAME | BUFFER]
  73.  
  74. Sets the position which MARK points to POS in FILE-NAME or BUFFER. mark-pos MARK
  75.  
  76. Returns the position that MARK points to. (note that this is the *same*
  77. object that the mark stores internally -- so don't modify it unless you're
  78. really sure you know what you're doing) mark-file MARK
  79.  
  80. Returns the file-name or buffer that MARK points to. mark-resident-p MARK
  81.  
  82. Returns t if the file that MARK points to is in a buffer. markp ARG
  83.  
  84. Return t if ARG is a mark. prompt PROMPT [STRING]
  85.  
  86. Displays PROMPT and waits for the user to enter a string, which is
  87. then returned. If STRING is provided it is used as the starting value
  88. of the string. This variable holds the command currently being evaluated, or nil if no
  89. command is active. The `command' is whatever is being evaluated; it could
  90. be a function, a form or even a list of forms (from a menu). This variable holds the last interactive command evaluated. This will either
  91. be from a keybinding or a menu. Setting the value of the `next-keymap-path'
  92. variable is not considered a command. After a command finishes this variable
  93. takes the value of `this-command'. Value of the prefix argument for the next command. Value of the prefix argument for the current command. call-command COMMAND [PREFIX-ARG]
  94.  
  95. Invoke the command COMMAND. This can be one of,
  96.  1. A symbol whose function value is to be called, the symbol must be of
  97.     type `commandp'; any interactive calling specification will be
  98.     used to find arguments to give to the function. (see `interactive')
  99.  2. A lambda-expression to call as a function name
  100.  3. A single Lisp form to be evaluated by eval
  101.  
  102. If PREFIX-ARG is non-nil it specifies the value of the COMMAND's
  103. current-prefix-arg. This is used in call-command's interactive spec so that
  104. any entered arg is given to the invoked COMMAND. prefix-numeric-argument ARG
  105.  
  106. Returns the numeric value of the raw prefix argument ARG. interactive CALLING-SPEC
  107.  
  108. This is a declaration used by the `call-command' function. For each Lisp
  109. function which may be invoked as a command (interactively by the user) the
  110. first *actual* form of the function (after the arguments and optional doc
  111. string) must be an `interactive' declaration. For example,
  112.  
  113. (defun foo (bar)
  114.   "An illustration"
  115.   (interactive ...)
  116.   ...
  117.  
  118. When called, the interactive special form just returns nil.
  119.  
  120. The CALLING-SPEC defines the arguments which are given to the command, it
  121. can be either,
  122.  
  123.  1. nil -- no arguments are given to the function, this is just used to show
  124.     that this function may be called as a command.
  125.  
  126.  2. A Lisp form -- it is evaluated and expected to provide a *list* of
  127.     arguments which will be given to the function
  128.  
  129.  3. A string -- zero or more lines (separated by `\n'); each line tells
  130.     how to get one argument. The first character of each line is a code
  131.     letter, the rest of the line is an optional prompt-string which the
  132.     user will see when entering the argument's value.
  133.  
  134.     The code letters available are,
  135.     a    A function
  136.     b    An existing buffer
  137.     B    A buffer, it will be created if it doesn't exist
  138.     c    A character
  139.     C    A command
  140.     d    The position of the cursor
  141.     D    The name of a directory
  142.     e    The event which caused this command
  143.     E    The event which caused this command as a string
  144.     f    The name of an existing file
  145.     F    The name of a file
  146.     k    An event
  147.     m    The start position of the currently-marked block
  148.     M    The end of the block
  149.     n    A number
  150.     N    The numeric prefix arg, or an entered number
  151.     p    The numeric prefix arg
  152.     P    The raw prefix arg
  153.     s    A string
  154.     S    A symbol
  155.     t    The symbol `t'
  156.     v    A variable
  157.     x    A Lisp object
  158.     X    A Lisp object, read then evaluated
  159.  
  160.     A null line produces an argument of nil.
  161.  
  162.     Any non-alphabetic characters at the beginning of the CALLING-SPEC
  163.     are used as flags, the currently recognised flags are,
  164.  
  165.     *    If the active buffer is read-only an error will be signalled
  166.     -    After building the argument list the block marked in the
  167.         current window will be unmarked.
  168.  
  169. Example usage,
  170.  
  171.     (interactive)            -- No arguments but function may
  172.                        be called as a command
  173.     (interactive "bBuffer to kill:")    -- One arg, an existing buffer
  174.     (interactive "*\nxLisp form:\nt")    -- If not read-only, three arguments;
  175.                        `nil', a lisp form and `t'. commandp COMMAND
  176.  
  177. Returns t if COMMAND may be called interactively. 256-byte string holding translations to turn each character into its
  178. upper-case equivalent. 256-byte string holding translations to turn each character into its
  179. lower-case equivalent. When bound and non-nil this variable cancels the effect of the set-buffer-
  180. read-only command; in that the buffer is always writeable. This is
  181. intended to be bound while a command is executing that is allowed to
  182. modify a buffer. split-line
  183.  
  184. Splits the line into two at the cursor position. insert STRING [POS] [BUFFER]
  185.  
  186. Inserts STRING into BUFFER at POS. Returns the first position of the first
  187. character after the end of the inserted text. delete-area START-POS END-POS [BUFFER]
  188.  
  189. Deletes from START-POS up to (but not including) END-POS. copy-area START-POS END-POS [BUFFER]
  190.  
  191. Returns the string from START-POS up to END-POS. cut-area START-POS END-POS [BUFFER]
  192.  
  193. The same as `copy-area' except that the section of text copied (START-POS to
  194. END-POS) is deleted from the file after being duplicated. block-toggle block-start [POS]
  195.  
  196. Always returns the position of the block-start as it is, if POS is given
  197. it is used as the new position of the start of the block. block-end [POS]
  198.  
  199. Always returns the position of the block-end as it is, if POS is given
  200. it is used as the new position of the end of the block. block-kill
  201.  
  202. Unmarks the block. blockp
  203.  
  204. Returns true if a block is currently marked. translate-area START-POS END-POS TRANSLATION-TABLE [BUFFER]
  205.  
  206. Applies the TRANSLATION-TABLE to the text between START-POS and END-POS.
  207. TRANSLATION-TABLE is a string, each character represents the translation
  208. for an ascii character of that characters position in the string. If the
  209. string is less than 256 chars long any undefined characters will remain
  210. unchanged. translate-string STRING TRANSLATION-TABLE
  211.  
  212. Applies the TRANSLATION-TABLE to each character in the string STRING.
  213. TRANSLATION-TABLE is a string, each character represents the translation
  214. for an ascii character of that characters position in the string. If the
  215. string is less than 256 chars long any undefined characters will remain
  216. unchanged.
  217. Note that the STRING really is modified, no copy is made! get-char [POS] [BUFFER]
  218.  
  219. Returns the numerical value of the character at position POS in BUFFER. If no
  220. character exists at that position, nil is returned. set-char CHARACTER [POS] [BUFFER]
  221.  
  222. Sets the character at position POS in BUFFER to CHARACTER. alpha-char-p CHAR
  223.  
  224. Returns t if CHAR is an alphabetic character. upper-case-p CHAR
  225.  
  226. Returns t if CHAR is upper case. lower-case-p CHAR
  227.  
  228. Returns t if CHAR is lower case. digit-char-p CHAR
  229.  
  230. Returns t if CHAR is a digit. alphanumericp CHAR
  231.  
  232. Returns t if CHAR is alpha-numeric. space-char-p CHAR
  233.  
  234. Returns t if CHAR is whitespace. char-upcase CHAR
  235.  
  236. Returns the upper-case equivalent of CHAR. char-downcase CHAR
  237.  
  238. Returns the lower-case equivalent of CHAR. pos-line POS
  239.  
  240. Returns the line number which POS points to. pos-col POS
  241.  
  242. Return the column number which POS points to. set-pos-line POS LINE
  243.  
  244. Sets the line number of POS to LINE. set-pos-col POS COL
  245.  
  246. Sets the column number of POS to COL. posp ARG
  247.  
  248. Returns t if ARG is a position object. cursor-pos
  249.  
  250. Returns the position of the cursor in the current window. empty-line-p [POS] [BUFFER]
  251.  
  252. Returns t if the line pointer to by POS (or the cursor) in BUFFER is
  253. empty, ie, blank or only containing spaces. indent-pos [POS] [BUFFER]
  254.  
  255. Returns the glyph position of the first non-space character in the line
  256. pointed to by POS (or the cursor), in BUFFER. set-indent-pos POS [BUFFER] [ONLY-SPACES]
  257.  
  258. Sets the indentation of the line pointed to by POS to the column pointed
  259. to by POS by putting the optimal sequence of TAB and SPC characters at the
  260. start of the line.
  261.  
  262. If ONLY-SPACES in non-nil no tab characters are used. indent-to COLUMN [ONLY-SPACES]
  263.  
  264. Inserts enough tabs and spaces to move the cursor to glyph column COLUMN.
  265. If ONLY-SPACES is non-nil no tabs are used.
  266. COLUMN counts from zero. clear-buffer [BUFFER]
  267.  
  268. Remove all text from BUFFER, leaving just one empty line. pos-to-offset [POS] [BUFFER]
  269.  
  270. Returns the number of characters (counting from zero) that POS (or the cursor)
  271. is from the beginning of the buffer. offset-to-pos OFFSET [BUFFER]
  272.  
  273. Returns the position which is OFFSET characters from the start of the buffer. insert-rect STRING [POS] [BUFFER]
  274.  
  275. Inserts STRING into BUFFER at POS treating it as a ``rectangle'' of
  276. text -- that is, each separate line in STRING (separated by newlines) is
  277. inserted at the *same* column in successive lines. delete-rect START-POS END-POS [BUFFER]
  278.  
  279. Deletes the rectangle of text from one corner, START-POS, to the opposite
  280. corner, END-POS. copy-rect START-POS END-POS [BUFFER]
  281.  
  282. Returns the rectangle of text marked out by START-POS and END-POS. cut-rect START-POS END-POS [BUFFER]
  283.  
  284. The same as `copy-rect' except that the section of text copied (START-POS
  285. to END-POS) is deleted from the file after being duplicated. find-next-regexp REGEXP [POS] [BUFFER] [IGNORE-CASE-P]
  286.  
  287. Scans forwards from POS (or the cursor), in BUFFER, looking for a match
  288. with REGEXP. Returns the position of the next match or nil.
  289.  
  290. When IGNORE-CASE-P is non-nil the case of matched strings are ignored. Note
  291. that character classes are still case-significant. find-prev-regexp REGEXP [POS] [BUFFER] [IGNORE-CASE-P]
  292.  
  293. Scans backwards from POS (or the cursor), in BUFFER, looking for a match
  294. with REGEXP. Returns the position of the next match or nil.
  295.  
  296. When IGNORE-CASE-P is non-nil the case of matched strings are ignored. Note
  297. that character classes are still case-significant. find-next-string STRING [POS] [BUFFER]
  298.  
  299. Scans forwards from POS (or the cursor), in BUFFER, looking for a match
  300. with STRING. Returns the position of the next match or nil. find-prev-string STRING [POS] [BUFFER]
  301.  
  302. Scans backwards from POS (or the cursor), in BUFFER, looking for a match
  303. with STRING. Returns the position of the next match or nil. find-next-char CHAR [POS] [BUFFER]
  304.  
  305. Scans forwards from POS (or the cursor), in BUFFER, looking for a match
  306. with CHAR. Returns the position of the next match or nil. find-prev-char CHAR [POS] [BUFFER]
  307.  
  308. Scans backwards from POS (or the cursor), in BUFFER, looking for a match
  309. with CHAR. Returns the position of the next match or nil. replace-regexp REGEXP TEMPLATE [POS] [BUFFER] [IGNORE-CASE-P]
  310.  
  311. If the text at POS or the cursor, matches REGEXP replace it with TEMPLATE,
  312. this is a string that can have the following escape characters,
  313.   \0, \&   whole string matched by REGEXP
  314.   \N       N'th parenthensized expression (1 <= N <= 9)
  315.  
  316. When IGNORE-CASE-P is non-nil the case of matched strings are ignored. Note
  317. that character classes are still case-significant. replace-string ORIGINAL NEW [POS] [BUFFER]
  318.  
  319. If the text at POS, or the cursor, matches ORIGINAL, replace it with the
  320. string NEW. regexp-expand REGEXP MATCHSTR TEMPLATE [IGNORE-CASE-P]
  321.  
  322. If REGEXP matches MATCHSTR then return the string made by expanding the
  323. string TEMPLATE in a similar way to in the function `replace-regexp'.
  324.  
  325. When IGNORE-CASE-P is non-nil the case of matched strings are ignored. Note
  326. that character classes are still case-significant. regexp-match REGEXP STRING [IGNORE-CASE-P]
  327.  
  328. Return t if REGEXP matches STRING.
  329.  
  330. When IGNORE-CASE-P is non-nil the case of matched strings are ignored. Note
  331. that character classes are still case-significant. regexp-expand REGEXP TEMPLATE [POS] [BUFFER] [IGNORE-CASE-P]
  332.  
  333. If REGEXP matches the line at POS in BUFFER then return the string made
  334. by expanding the string TEMPLATE in a similar way to in the function
  335. `replace-regexp' and the variables `find-last-start-pos' and
  336. `find-last-end-pos' are set to the start and end of the match.
  337.  
  338. When IGNORE-CASE-P is non-nil the case of matched strings are ignored. Note
  339. that character classes are still case-significant. regexp-match-line REGEXP [LINE-POS] [BUFFER] [IGNORE-CASE-P]
  340.  
  341. Attempts to match the regular-expression REGEXP to the line pointed to by
  342. LINE-POS and BUFFER. If the match succeeds t is returned and the variables
  343. `find-last-start-pos' and `find-last-end-pos' are set to the start and end
  344. of the match.
  345.  
  346. When IGNORE-CASE-P is non-nil the case of matched strings are ignored. Note
  347. that character classes are still case-significant. looking-at REGEXP [POS] [BUFFER] [IGNORE-CASE-P]
  348.  
  349. Returns t if REGEXP matches the text at POS. Only the text from POS to the
  350. end of the line is matched against. match-start [EXPRESSION-INDEX]
  351.  
  352. Return the position which the EXPRESSION-INDEX'th parenthesised expression
  353. started at in the last successful regexp match. If EXPRESSION-INDEX is
  354. nil or 0 the start of the whole match is returned instead.
  355. The returned value will either be a position if the last match was in a
  356. buffer, or an integer if the last match was in a string (i.e. regexp-match). match-end [EXPRESSION-INDEX]
  357.  
  358. Return the position which the EXPRESSION-INDEX'th parenthesised expression
  359. ended at in the last successful regexp match. If EXPRESSION-INDEX is
  360. nil or 0 the end of the whole match is returned instead.
  361. The returned value will either be a position if the last match was in a
  362. buffer, or an integer if the last match was in a string (i.e. regexp-match). regexp-quote STRING
  363.  
  364. Returns a new version of STRING, any characters which the regexp routines
  365. treat specially (asterisks, square brackets, etc...) is quoted by the escape
  366. character `\'. If the STRING does not contain any regexp meta-characters
  367. it is returned as-is (un-copied). glyph-table-p ARG
  368.  
  369. Returns t if ARG is a glyph-table. char-to-glyph-pos [POS] [BUFFER]
  370.  
  371. From the character position POS, find its true *physical* position when
  372. rendered. glyph-to-char-pos POS [BUFFER]
  373.  
  374. For the physical position POS, find the closest matching actual character
  375. position. default-glyph-table
  376.  
  377. Returns the standard glyph-table. make-glyph-table SRC
  378.  
  379. Creates a new glyph-table. If SRC is a glyph-table it will be copied, else if
  380. SRC is a buffer that buffer's glyph-table will be copied. If SRC is nil the
  381. default glyph-table will be copied. set-glyph GLYPH-TABLE CHARACTER GLYPH-STRING
  382.  
  383. Make the renderer draw the string GLYPH-STRING (no more than 4 characters)
  384. for each character CHARACTER in any buffers which use the GLYPH-TABLE. get-glyph GLYPH-TABLE CHARACTER
  385.  
  386. Return the string which is the rendered representation of CHARACTER in
  387. GLYPH-TABLE. buffer-glyph-table [BUFFER]
  388.  
  389. Returns the glyph-table being used in BUFFER. set-buffer-glyph-table [BUFFER] GLYPH-TABLE
  390.  
  391. Sets the glyph-table being used in BUFFER to GLYPH-TABLE. read-buffer FILE [BUFFER]
  392.  
  393. Overwrites the text in BUFFER with that from the file FILE.
  394. FILE is either a string naming the file to be opened or a Lisp file object
  395. (from `open') to be used. write-buffer [FILE-NAME] [BUFFER]
  396.  
  397. Saves the contents of BUFFER to file FILE-NAME. write-buffer-area START-POS END-POS [FILE-NAME] [BUFFER]
  398.  
  399. Writes the text between START-POS and END-POS in BUFFER to file
  400. FILE-NAME. cd [DIRECTORY]
  401.  
  402. If DIRECTORY is given set the editor's current directory to it, else
  403. return the name of the current directory. write-file FILE-NAME STRING
  404.  
  405. Writes STRING to file FILE-NAME. read-file FILE-NAME
  406.  
  407. Return the contents of file FILE-NAME. read-file-from-to FILENAME OFFSET CHAR write-clip UNIT STRING
  408.  
  409. Writes STRING to unit UNIT of the standard clipboard. read-clip UNIT
  410.  
  411. Returns the string which unit UNIT of the clipboard holds. A list of keymaps (ie, keylists and/or keytables). When an event occurs
  412. each keymap in the list is searched for an event binding which matches
  413. it. These bindings are installed in a keymap by the function `bind-keys'.
  414. See also `next-keymap-path'. When no event binding can be found for an event this hook is evaluated in
  415. the standard manner (see the function `eval-hook' for details). When this variable is non-nil the `ESC' key means that the next event
  416. is qualified by the `Meta' modifier.
  417. This feature is included mainly for compatibility with GNU Emacs. This hook gets evaluated every second while the editor is idle. Don't depend
  418. on how regularly this gets called, any events from the window-system will
  419. delay it. Also, auto-saving files and garbage-collection take precedence
  420. when there's idle time available. Use this hook sparingly, or for short
  421. periods only! make-keytab
  422.  
  423. Return a new key-table suitable for storing bindings in. This is a 127
  424. element vector, each element is an empty list of bindings. make-keylist
  425.  
  426. Return a new key-list suitable for storing bindings in. This is a cons
  427. cell looking like `(keymap . LIST-OF-BINDINGS)', LIST-OF-BINDINGS starts
  428. off empty. bind-keys KEY-MAP { EVENT-DESCRIPTION COMMAND }... unbind-keys KEY-MAP EVENT-DESCRIPTION... The value of `keymap-path' to be used for the *next* keypress. This is
  429. usually used to chain together multi-key bindings. current-event-string
  430.  
  431. Returns the string which would have been inserted by the current event if
  432. a Lisp function hadn't been called instead. current-event
  433.  
  434. Return the event which caused the current command to be invoked. last-event
  435.  
  436. Return the previous event which occurred. event-name EVENT
  437.  
  438. Returns a string naming the event EVENT. lookup-event EVENT-NAME
  439.  
  440. Return the event whose name is EVENT-NAME. lookup-event-binding EVENT [RESET-PATH]
  441.  
  442. Return the command currently associated with the event EVENT.
  443. If RESET-PATH is non-nil the value of `next-keymap-path' will be cleared
  444. after being used. keymapp ARG
  445.  
  446. Returns t if ARG can be used as a keymap. eventp ARG
  447.  
  448. Returns t if the ARG is an input event. eval FORM
  449.  
  450. Evaluates FORM and returns its value. funcall FUNCTION ARGS...
  451.  
  452. Calls FUNCTION with arguments ARGS... and returns its result. progn FORMS...
  453.  
  454. Eval's each of the FORMS in order returning the value of the last
  455. one. break
  456.  
  457. The next form to be evaluated will be done so through the Lisp debugger. step FORM
  458.  
  459. Use the Lisp debugger to evaluate FORM. macroexpand FORM [ENVIRONMENT]
  460.  
  461. If FORM is a macro call, expand it until it isn't. If ENVIRONMENT is
  462. specified it is an alist of `(MACRO-NAME . DEFINITION)'. get-doc-string INDEX
  463.  
  464. Returns the document-string number INDEX. add-doc-string STRING
  465.  
  466. Appends STRING to the end of the doc-file and returns the index position of
  467. it's first character (a number). When an error is signalled this variable controls whether or not to enter the
  468. Lisp debugger immediately. If the variable's value is t or a list of symbols
  469. - one of which is the signalled error symbol - the debugger is entered.
  470. See `signal'. signal ERROR-SYMBOL DATA
  471.  
  472. Signal that an error has happened. ERROR-SYMBOL is the name of a symbol
  473. classifying the type of error, it should have a property `error-message' (a
  474. string) with a short description of the error message.
  475. DATA is a list of objects which are relevant to the error -- they will
  476. be made available to any error-handler or printed by the default error
  477. -handler. error-protect FORM HANDLERS...
  478.  
  479. Evaluates FORM with error-handlers in place, if no errors occur return the
  480. value returned by FORM, else the value of whichever handler's body was
  481. evaluated.
  482. Each HANDLER is a list looking like `(ERROR-SYMBOL BODY...)'. If an error
  483. of type ERROR-SYMBOL occurs BODY is evaluated with the symbol `error-info'
  484. temporarily set to `(ERROR-SYMBOL . DATA)' (these were the arguments given to
  485. the `signal' which caused the error). backtrace [STREAM]
  486.  
  487. Prints a backtrace of the current Lisp call stack to STREAM (or to
  488. `standard-output').
  489. The format is something like:
  490.   FUNCTION (ARGLIST) ARGS-EVALLED-P
  491. where ARGS-EVALLED-P is either `t' or `nil', depending on whether or not
  492. ARGLIST had been evaluated or not before being put into the stack. The maximum number of times that eval and funcall can be called recursively.
  493. This is intended to stop infinite recursion, if the default value of 250 is
  494. too small (you get errors in normal use) set it to something larger. A list of directory names. When `load' opens a lisp-file it searches each
  495. directory named in this list in turn until the file is found or the list
  496. is exhausted. The name of the directory in which the standard lisp files live. quote ARG
  497. 'ARG
  498.  
  499. Returns ARG. function ARG
  500. #'ARG
  501.  
  502. Normally the same as `quote'. When being compiled, if ARG is not a symbol
  503. it causes ARG to be compiled as a lambda expression. defmacro NAME LAMBDA-LIST [DOC-STRING] BODY...
  504.  
  505. Defines a macro called NAME with argument spec. LAMBDA-LIST, documentation
  506. DOC-STRING (optional) and body BODY. The actual function value is
  507.     `(macro lambda LAMBDA-LIST [DOC-STRING] BODY...)'
  508. Macros are called with their arguments un-evaluated, they are expected to
  509. return a form which will be executed to provide the result of the expression.
  510.  
  511. A pathetic example could be,
  512.   (defmacro foo (x) (list 'cons nil x))
  513.    => foo
  514.   (foo 'bar)
  515.    => (nil . bar)
  516. This makes `(foo X)' a pseudonym for `(cons nil X)'.
  517.  
  518. Note that macros are expanded at *compile-time* (unless, of course, the Lisp
  519. code has not been compiled). defun NAME LAMBDA-LIST [DOC-STRING] BODY...
  520.  
  521. Defines a function called NAME with argument specification LAMBDA-LIST,
  522. documentation DOC-STRING (optional) and body BODY. The actual function
  523. value is,
  524.     `(lambda LAMBDA-LIST [DOC-STRING] BODY...)' defvar NAME DEFAULT-VALUE [DOC-STRING]
  525.  
  526. Define a variable called NAME whose standard value is DEFAULT-
  527. VALUE. If NAME is already bound to a value it is left as it is.
  528. If the symbol NAME is marked buffer-local the *default value* of the
  529. variable will be set (if necessary) not the local value. defconst NAME VALUE [DOC-STRING]
  530.  
  531. Define a constant NAME whose (default) value is VALUE. If NAME is already
  532. bound an error is signalled.
  533.  
  534. Constants are treated specially by the Lisp compiler, basically they are
  535. hard-coded into the byte-code. For more details see the comments in
  536. the compiler source (`lisp/compiler.jl'). car CONS-CELL
  537.  
  538. Returns the value stored in the car slot of CONS-CELL, or nil if CONS-CELL
  539. is nil. cdr CONS-CELL
  540.  
  541. Returns the value stored in the cdr slot of CONS-CELL, or nil if CONS-CELL
  542. is nil. list ARGS...
  543.  
  544. Returns a new list with elements ARGS... make-list LENGTH [INITIAL-VALUE]
  545.  
  546. Returns a new list with LENGTH members, each of which is initialised to
  547. INITIAL-VALUE, or nil. append LISTS...
  548.  
  549. Non-destructively concatenates each of it's argument LISTS... into one
  550. new list which is returned. nconc LISTS...
  551.  
  552. Destructively concatenates each of it's argument LISTS... into one new
  553. list. Every LIST but the last is modified so that it's last cdr points
  554. to the beginning of the next list. Returns the new list. rplaca CONS-CELL NEW-CAR
  555.  
  556. Sets the value of the car slot in CONS-CELL to NEW-CAR. Returns the new
  557. value. rplacd CONS-CELL NEW-CDR
  558.  
  559. Sets the value of the cdr slot in CONS-CELL to NEW-CAR. Returns the new
  560. value. reverse LIST
  561.  
  562. Returns a new list which is a copy of LIST except that the members are in
  563. reverse order. nreverse LIST
  564.  
  565. Returns LIST altered so that it's members are in reverse order to what they
  566. were. This function is destructive towards it's argument. assoc ELT ASSOC-LIST
  567.  
  568. Searches ASSOC-LIST for a list whose first element is ELT. `assoc' uses
  569. `equal' to compare elements. Returns the sub-list starting from the first 
  570. matching association.
  571. For example,
  572.     (assoc 'three '((one . 1) (two . 2) (three . 3) (four . 4)))
  573.      => (three . 3) assq ELT ASSOC-LIST
  574.  
  575. Searches ASSOC-LIST for a list whose first element is ELT. `assq' uses `eq'
  576. to compare elements. Returns the sub-list starting from the first matching
  577. association. rassoc ELT ASSOC-LIST
  578.  
  579. Searches ASSOC-LIST for a cons-cell whose cdr element is `equal' to ELT. 
  580. Returns the first cons-cell which matches, or nil.
  581. For example,
  582.     (rassoc 3 '((one . 1) (two . 2) (three . 3) (four . 4)))
  583.      => (three . 3) rassq ELT ASSOC-LIST
  584.  
  585. Searches ASSOC-LIST for a cons-cell whose cdr is `eq' to ELT.
  586. Returns the first matching cons-cell, else nil. nth INDEX LIST
  587.  
  588. Returns the INDEXth element of LIST. The first element has an INDEX of zero. nthcdr INDEX LIST
  589.  
  590. Returns the INDEXth cdr of LIST. The first is INDEX zero. last LIST
  591.  
  592. Returns the last element of LIST. mapcar FUNCTION LIST
  593.  
  594. Calls FUNCTION-NAME with each element of LIST as an argument in turn and
  595. returns a new list constructed from the results, ie,
  596.   (mapcar (function (lambda (x) (1+ x))) '(1 2 3))
  597.    => (2 3 4) mapc FUNCTION LIST
  598.  
  599. Applies FUNCTION to each element in LIST, discards the results. member ELT LIST
  600.  
  601. If ELT is a member of list LIST then return the tail of the list starting
  602. from the matched ELT, ie,
  603.   (member 1 '(2 1 3))
  604.    => (1 3)
  605. `member' uses `equal' to compare atoms. memq ELT LIST
  606.  
  607. If ELT is a member of list LIST then return the tail of the list starting
  608. from the matched ELT, ie,
  609.   (memq 1 '(2 1 3))
  610.    => (1 3)
  611. `memq' uses `eq' to compare atoms. delete ELT LIST
  612.  
  613. Returns LIST with any members `equal' to ELT destructively removed. delq ELT LIST
  614.  
  615. Returns LIST with any members `eq' to ELT destructively removed. delete-if FUNCTION LIST
  616.  
  617. Similar to `delete' except that a predicate function, FUNCTION-NAME, is
  618. used to decide which elements to delete (remove destructively).
  619. `delete-if' deletes an element if FUNCTION-NAME returns non-nil when 
  620. applied to that element, ie,
  621.   (delete-if '(lambda (x) (= x 1)) '(1 2 3 4 1 2))
  622.    => (2 3 4 2) delete-if-not FUNCTION LIST
  623.  
  624. Similar to `delete' except that a predicate function, FUNCTION-NAME, is
  625. used to decide which elements to delete (remove destructively).
  626. `delete-if-not' deletes an element if FUNCTION-NAME returns nil when 
  627. applied to that element, ie,
  628.   (delete-if-not '(lambda (x) (= x 1)) '(1 2 3 4 1 2))
  629.    => (1 1) vector ARGS...
  630.  
  631. Returns a new vector with ARGS... as its elements. make-vector SIZE [INITIAL-VALUE]
  632.  
  633. Creates a new vector of size SIZE. If INITIAL-VALUE is provided each element
  634. will be set to that value, else they will all be nil. arrayp ARG
  635.  
  636. Returns t when ARG is an array. aset ARRAY INDEX NEW-VALUE
  637.  
  638. Sets element number INDEX (a positive integer) of ARRAY (can be a vector
  639. or a string) to NEW-VALUE, returning NEW-VALUE. Note that strings
  640. can only contain characters (ie, integers). aref ARRAY INDEX
  641.  
  642. Returns the INDEXth (a non-negative integer) element of ARRAY, which
  643. can be a vector or a string. INDEX starts at zero. make-string LENGTH [INITIAL-VALUE]
  644.  
  645. Returns a new string of length LENGTH, each character is initialised to
  646. INITIAL-VALUE, or to space if INITIAL-VALUE is not given. concat ARGS...
  647.  
  648. Concatenates all ARGS... into a single string, each argument can be a string,
  649. a character or a list or vector of characters. length SEQUENCE
  650.  
  651. Returns the number of elements in SEQUENCE (a string, list or vector). copy-sequence SEQUENCE
  652.  
  653. Returns a new sequence whose elements are eq to those in SEQUENCE. elt SEQUENCE INDEX
  654.  
  655. Return the element of SEQUENCE at position INDEX (counting from zero). prog1 FORM1 FORMS...
  656.  
  657. First evals FORM1 then FORMS, returns the value that FORM1 gave. prog2 FORM1 FORM2 FORMS...
  658.  
  659. Evals FORM1 then FORM2 then the rest. Returns whatever FORM2 gave. while CONDITION FORMS...
  660.  
  661. Eval CONDITION, if it is non-nil then execute FORMS and repeat the
  662. procedure, else return nil. if CONDITION THEN-FORM [ELSE-FORMS...]
  663.  
  664. Eval CONDITION, if it is non-nil then eval THEN-FORM and return it's 
  665. result, else do an implicit progn with the ELSE-FORMS returning its value. when CONDITION FORMS...
  666.  
  667. Evaluates CONDITION, if it is non-nil evaluates FORMS. unless CONDITION FORMS...
  668.  
  669. Evaluates CONDITION, if it is nil evaluates FORMS. cond (CONDITION FORMS... ) ...
  670.  
  671. Find the first CONDITION which has a value of t when eval'ed, then perform
  672. a progn on its associated FORMS. If there are no FORMS with the CONDITION
  673. then the value of the CONDITION is returned. If no CONDITION is t then
  674. return nil.
  675. An example,
  676.   (cond
  677.     ((stringp foo)
  678.       (title "foo is a string"))
  679.     ((numberp foo)
  680.       (setq bar foo)
  681.       (title "foo is a number"))
  682.     (t
  683.       (title "foo is something else...")))
  684. Note the use of plain `t' on it's own for the last CONDITION, this is
  685. like the last else in an else-if statement in C. apply FUNCTION ARGS... ARG-LIST
  686.  
  687. Calls FUNCTION passing all of ARGS to it as well as all elements in ARG-LIST.
  688. ie,
  689.   (apply '+ 1 2 3 '(4 5 6))
  690.    => 21 load FILE [NO-ERROR-P] [NO-PATH-P] [NO-SUFFIX-P]
  691.  
  692. Attempt to open and then read-and-eval the file of Lisp code FILE.
  693.  
  694. For each directory named in the variable `load-path' tries the value of
  695. FILE with `.jlc' (compiled-lisp) appended to it, then with `.jl' appended
  696. to it, finally tries FILE without modification.
  697.  
  698. If NO-ERROR-P is non-nil no error is signalled if FILE can't be found.
  699. If NO-PATH-P is non-nil the `load-path' variable is not used, just the value
  700. of FILE.
  701. If NO-SUFFIX-P is non-nil no suffixes are appended to FILE.
  702.  
  703. If the compiled version is older than it's source code, the source code is
  704. loaded and a warning is displayed. + NUMBERS...
  705.  
  706. Adds all NUMBERS together. - NUMBER [NUMBERS...]
  707.  
  708. Either returns the negation of NUMBER or the value of NUMBER minus
  709. NUMBERS * NUMBERS...
  710.  
  711. Multiplies all NUMBERS together / NUMBERS...
  712.  
  713. Divides NUMBERS (in left-to-right order), ie,
  714.   (/ 100 2
  715.    => 10 % NUMBERS...
  716.  
  717. Applies the remainder operator between each of NUMBERS. lognot NUMBER
  718.  
  719. Returns the bitwise logical `not' of NUMBER. not ARG
  720.  
  721. If ARG is nil returns t, else returns nil. logior NUMBERS...
  722.  
  723. Returns the bitwise logical `inclusive-or' of its arguments. logxor NUMBERS...
  724.  
  725. Returns the bitwise logical `exclusive-or' of its arguments. or FORMS...
  726.  
  727. Evals each FORM while they return nil, returns the first non-nil result or
  728. nil if all FORMS return nil. logand NUMBERS...
  729.  
  730. Returns the bitwise logical `and' of its arguments. and FORMS...
  731.  
  732. Evals each FORM until one returns nil, it returns that value, or t if all
  733. FORMS return t. equal VALUE1 VALUE2
  734.  
  735. Compares VALUE1 and VALUE2, compares the actual structure of the objects not
  736. just whether the objects are one and the same. ie, will return t for two
  737. strings built from the same characters in the same order even if the strings'
  738. location in memory is different. eq VALUE1 VALUE2
  739.  
  740. Returns t if VALUE1 and VALUE2 are one and the same object. Note that
  741. this may or may not be true for numbers of the same value (see `eql'). eql ARG1 ARG2
  742. Similar to `eq' except that numbers (integers, characters) with the same
  743. value will always be considered `eql' (this may or may not be the case
  744. with `eq'. string-head-eq STRING1 STRING2
  745.  
  746. Returns t if STRING2 matches the beginning of STRING1, ie,
  747.   (string-head-eq "foobar" "foo")
  748.    => t
  749.   (string-head-eq "foo" "foobar")
  750.    => nil = NUMBER1 NUMBER2
  751.  
  752. Returns t if NUMBER1 and NUMBER2 are equal. /= NUMBER1 NUMBER2
  753.  
  754. Returns t if NUMBER1 and NUMBER2 are unequal. > ARG1 ARG2
  755.  
  756. Returns t if ARG1 is greater than ARG2. Note that this command isn't
  757. limited to numbers, it can do strings, positions, marks, etc as well. >= ARG1 ARG2
  758.  
  759. Returns t if ARG1 is greater-or-equal than ARG2. Note that this command
  760. isn't limited to numbers, it can do strings, positions, marks, etc as well. < ARG1 ARG2
  761.  
  762. Returns t if ARG1 is less than ARG2. Note that this command isn't limited to
  763. numbers, it can do strings, positions, marks, etc as well. <= ARG1 ARG2
  764.  
  765. Returns t if ARG1 is less-or-equal than ARG2. Note that this command isn't
  766. limited to numbers, it can do strings, positions, marks, etc as well. 1+ NUMBER
  767.  
  768. Return NUMBER plus 1. 1- NUMBER
  769.  
  770. Return NUMBER minus 1. lsh NUMBER COUNT
  771.  
  772. Shift the bits in NUMBER by COUNT bits to the left, a negative COUNT means
  773. shift right. ash NUMBER COUNT
  774.  
  775. Use an arithmetic shift to shift the bits in NUMBER by COUNT bits to the left,
  776. a negative COUNT means shift right. zerop NUMBER
  777.  
  778. t if NUMBER is zero. null ARG
  779.  
  780. Returns t if ARG is nil. atom ARG
  781.  
  782. Returns t if ARG is not a cons-cell. consp ARG
  783.  
  784. Returns t if ARG is a cons-cell. listp ARG
  785.  
  786. Returns t if ARG is a list, (either a cons-cell or nil). numberp ARG
  787.  
  788. Return t if ARG is a number. integerp ARG
  789.  
  790. Return t if ARG is a integer. stringp ARG
  791.  
  792. Returns t is ARG is a string. vectorp ARG
  793.  
  794. Returns t if ARG is a vector. functionp ARG
  795.  
  796. Returns t if ARG is a function (ie, a symbol or a list whose car is the
  797. symbol `lambda' special-form-p ARG
  798.  
  799. Returns t if ARG is a special-form. subrp ARG
  800.  
  801. Returns t if arg is a primitive function. sequencep ARG
  802.  
  803. Returns t is ARG is a sequence (a list, vector or string). subr-documentation SUBR [USE-VAR]
  804.  
  805. Returns the doc-string associated with SUBR. subr-name SUBR [USE-VAR]
  806.  
  807. Returns the name (a string) associated with SUBR. eval-hook HOOK ARGS...
  808.  
  809. Evaluate the hook, HOOK (a symbol), with arguments ARGS
  810.  
  811. The way hooks work is that the hook-symbol's value is a list of functions
  812. to call. Each function in turn is called with ARGS until one returns non-nil,
  813. this non-nil value is then the result of `eval-hook'. If all functions return
  814. nil then `eval-hook' returns nil. eval-hook2 HOOK ARG
  815.  
  816. Similar to `eval-hook', the only reason this function exists is because it
  817. is easier to call a 2-argument function from C than an N-argument function. catch TAG FORMS...
  818.  
  819. Evaluates FORMS, non-local exits are allowed with `(throw TAG)'.
  820. The value of `catch' is either the value of the last FORM or the
  821. value given to the throw command.
  822.  
  823. There are several pre-defined `catch'es which are,
  824.   'defun
  825.      Around all defuns, the `return' command uses this, it basically does
  826.      (throw 'defun X).
  827.   'exit
  828.      Exits one level of recursive-editing (but doesn't work in the top
  829.      level.
  830.   'top-level
  831.      At the top-level recursive-edit (ie, the one which you're in when
  832.      the editor is started).
  833.   'quit
  834.      Kills the editor. throw TAG VALUE
  835.  
  836. Performs a non-local exit to the `catch' waiting for TAG and return
  837. VALUE from it. TAG and VALUE are both evaluated fully. return [VALUE]
  838.  
  839. Arranges it so that the innermost defun returns VALUE (or nil) as its result. unwind-protect BODY CLEANUP-FORMS...
  840.  
  841. Eval and return the value of BODY guaranteeing that the CLEANUP-FORMS will
  842. be evalled no matter what happens (ie, error, non-local exit, etc) while
  843. BODY is being evaluated. jade-byte-code CODE-STRING CONST-VEC MAX-STACK
  844.  
  845. Evaluates the string of byte codes CODE-STRING, the constants that it
  846. references are contained in the vector CONST-VEC. MAX-STACK is a number
  847. defining how much stack space is required to evaluate the code.
  848.  
  849. Do *not* attempt to call this function manually, the lisp file `compiler.jl'
  850. contains a simple compiler which translates files of lisp forms into files
  851. of byte code. See the functions `compile-file', `compile-directory' and
  852. `compile-lisp-lib' for more details. recursive-edit
  853.  
  854. Enter a new recursive-edit. recursion-depth
  855.  
  856. Returns the number of recursive-edit's deep we are, zero signifies the
  857. original level. input-lock [STATUS]
  858.  
  859. Sets or returns the status of the input lock. When this value is non-zero
  860. no user input is accepted, only messages from ARexx can get through. file-name-concat PARTS...
  861.  
  862. Returns a string made from all the PARTS, each of which is one component of
  863. a file name. Add's `/' characters between each PART if necessary. expand-file-name FILENAME [FULLY-QUALIFY]
  864.  
  865. Returns a valid file name from the string FILENAME. Currently this just expands
  866. any `~' characters it finds (if we're running on Unix) to the user's home
  867. directory.
  868.  
  869. If FULLY-QUALIFY is t then the FILENAME is made absolute system SHELL-COMMAND
  870.  
  871. Tells the operating-system to execute SHELL-COMMAND, returns the exit code
  872. of that command. substring STRING START [END]
  873.  
  874. Returns the portion of STRING starting at character number START and ending
  875. at the character before END (or the end of the string is END is not given).
  876. All indices start at zero. beep
  877.  
  878. Rings a bell. file-name-nondirectory FILE-NAME
  879.  
  880. Returns the nondirectory part of FILE-NAME. file-name-directory FILE-NAME
  881.  
  882. Returns the directory part of FILE-NAME. balance-brackets OPEN-STRING CLOSE-STRING STRING strtoc STRING
  883.  
  884. Returns the first character of STRING. ctostr CHAR
  885.  
  886. Returns a one-character string containing CHAR. amiga-p
  887.  
  888. t if running on an Amiga. x11-p
  889.  
  890. t if running on the X Window System V11. unix-p
  891.  
  892. t if running under some flavour of unix. tmp-file-name
  893.  
  894. Returns the name of a unique file. make-completion-string EXISTING [POSSIBLE | POSIIBLE...] current-time
  895.  
  896. Return some number denoting the current system time. current-time-string
  897.  
  898. Returns a human-readable string defining the current date and time. major-version-number minor-version-number getenv NAME
  899.  
  900. Returns the value of environment variable NAME as a string, or nil if it is
  901. undefined. screen-top-line
  902.  
  903. Returns the line number of the first line being shown in the current window. screen-bottom-line
  904.  
  905. Returns the line number of the last line being shown in the current window. screen-first-column
  906.  
  907. Returns the line number of the first column being shown in the current window. screen-last-column
  908.  
  909. Returns the line number of the last column being shown in the current window. goto-char POS
  910.  
  911. Set the cursor position in the current window to the character position POS. goto-glyph POS
  912.  
  913. Set the cursor position in the current window to the glyph position POS. centre-display [WINDOW]
  914.  
  915. Arrange it so that the line that the cursor is on is displayed in the
  916. middle of the window (if possible). next-screen [NUMBER]
  917.  
  918. Move NUMBER (default: 1) screens forwards in the current window. prev-screen [NUMBER]
  919.  
  920. Move NUMBER (default: 1) screens backwards in the current window. buffer-end [BUFFER]
  921.  
  922. Return the position of the last character in BUFFER. goto-buffer-end
  923.  
  924. Move to the last character in the current window. buffer-start
  925.  
  926. Return the position of the start of the buffer. goto-buffer-start
  927.  
  928. Move to the first character in the buffer displayed in the current window. line-end [POS] [BUFFER]
  929.  
  930. Return the position of the last character in the line pointed to by POS (or
  931. the cursor). goto-line-end
  932.  
  933. Move to the last character in the line. line-start [POS]
  934.  
  935. Return the position of the first character in the line pointed to by POS
  936. (or the cursor). goto-line-start
  937.  
  938. Move to the start of the current line. next-line [NUMBER] [POS]
  939.  
  940. Return the position of the NUMBERth (def: 1) line down from that pointed to
  941. by POS (or the cursor). POS is altered. goto-next-line [NUMBER]
  942.  
  943. Move NUMBER lines (def: 1) downwards. Adjusts the cursor's column position
  944. so that it is drawn as near to where it was previously as possible. prev-line [NUMBER] [POS]
  945.  
  946. Return the position of the NUMBERth (def: 1) line up from that pointed to
  947. by POS (or the cursor). POS is altered. goto-next-line [NUMBER]
  948.  
  949. Move NUMBER lines (def: 1) upwards. Adjusts the cursor's column position
  950. so that it is drawn as near to where it was previously as possible. left-char [NUMBER] [POS]
  951.  
  952. Return the position of the NUMBERth character (def: 1) to the left of the
  953. one pointed to by POS (or the cursor). If that position is before the
  954. beginning of the line, returns nil. POS is altered. goto-left-char [NUMBER]
  955.  
  956. Move NUMBER chars (def: 1) to the left. right-char [NUMBER] [POS]
  957.  
  958. Return the position of the NUMBERth character (def: 1) to the right of the
  959. one pointed to by POS (or the cursor). Doesn't pay any attention to newlines.
  960. POS is altered. goto-right-char [NUMBER]
  961.  
  962. Move NUMBER chars (def: 1) to the right prev-tab [NUMBER] [POS] [TAB-SIZE]
  963.  
  964. Return the position of the NUMBERth (def: 1) tab stop to the left of POS (or
  965. the cursor). Returns nil if that position is past the beginning of the line.
  966. Note that this doesn't return the actual *character* position of the tab
  967. stop, but the number of glyphs which have to be displayed. POS is altered. goto-prev-tab [NUMBER] [TAB-SIZE]
  968.  
  969. Move NUMBER (def: 1) tab stops to the left. next-tab [NUMBER] [POS] [TAB-SIZE]
  970.  
  971. Return the position of the NUMBERth (def: 1) tab stop to the right of POS (or
  972. the cursor).
  973. Note that this doesn't return the actual *character* position of the tab
  974. stop, but the number of glyphs which have to be displayed. POS is altered. goto-next-tab [NUMBER] [TAB-SIZE]
  975.  
  976. Move NUMBER (def: 1) tab stops to the right next-char [COUNT] [POS] [BUFFER]
  977.  
  978. Returns the position of the character COUNT (default: 1) characters after POS
  979. (or the cursor). POS is altered. goto-next-char [COUNT]
  980.  
  981. Moves to the character COUNT characters after the cursor. prev-char [COUNT] [POS] [BUFFER]
  982.  
  983. Returns the position of the character COUNT characters before POS (or the
  984. cursor). POS is altered. goto-prev-char [COUNT]
  985.  
  986. Moves to the character COUNT characters before the cursor. match-brackets [POS] [BUFFER] [ESCAPE-CHAR]
  987.  
  988. Find a bracket matching the one at POS (or the cursor). The things that match
  989. each other are,  { }, ( ), [ ], ` ', < >. POS is altered.
  990. Brackets preceded by ESCAPE-CHAR (`\' by default) are not counted. mouse-pos
  991.  
  992. Return the position of the mouse pointer, relative to the display origin of
  993. the buffer in the current window. cursor STATUS
  994.  
  995. Turns cursor on or off, normally cursor is always off when an event is being
  996. evaluated. refresh-all
  997.  
  998. Redraw anything that has been changed since the last refresh. write STREAM DATA [LENGTH]
  999.  
  1000. Writes DATA, which can either be a string or a character, to the stream
  1001. STREAM, returning the number of characters actually written. If DATA is
  1002. a string LENGTH can define how many characters to write. read-char STREAM
  1003.  
  1004. Reads the next character from the input-stream STREAM, if no more characters
  1005. are available returns nil. read-line STREAM
  1006.  
  1007. Read one line of text from STREAM. copy-stream SOURCE-STREAM DEST-STREAM
  1008.  
  1009. Copy all characters from SOURCE-STREAM to DEST-STREAM until an EOF is read. read [STREAM]
  1010.  
  1011. Reads one lisp-object from the input-stream STREAM (or the value of the
  1012. variable `standard-input' if STREAM is unspecified) and return it. print OBJECT [STREAM]
  1013.  
  1014. First outputs a newline, then prints a text representation of OBJECT to
  1015. STREAM (or the contents of the variable `standard-output') in a form suitable
  1016. for `read'. prin1 OBJECT [STREAM]
  1017.  
  1018. Prints a text representation of OBJECT to STREAM (or the contents of the
  1019. variable `standard-output') in a form suitable for `read'. princ OBJECT [STREAM]
  1020.  
  1021. Prints a text representation of OBJECT to STREAM (or the contents of the
  1022. variable standard-output), no strange characters are quoted and no quotes
  1023. are printed around strings. format STREAM FORMAT-STRING ARGS...
  1024.  
  1025. Writes a string created from the format specification FORMAT-STRING and
  1026. the argument-values ARGS to the stream, STREAM. If STREAM is nil a string
  1027. is created and returned.
  1028.  
  1029. FORMAT-STRING is a template for the result, any `%' characters introduce
  1030. a substitution, using the next unused ARG. These format specifiers are
  1031. implemented:
  1032.    d      print next ARG as decimal integer
  1033.    x      print next ARG as hexadecimal integer
  1034.    o      print next ARG in octal
  1035.    c      print next ARG as ASCII character
  1036.    s      unquoted representation (as from `princ') of next ARG
  1037.    S      normal print'ed representation of next ARG
  1038.    %      literal percentage character make-string-input-stream STRING [START]
  1039.  
  1040. Returns a input stream, it will supply, in order, the characters in STRING,
  1041. starting from START (or the beginning of the string). make-string-output-stream
  1042.  
  1043. Returns an output stream which will accumulate the characters written to
  1044. it for the use of the `get-output-stream-string' function. get-output-stream-string STRING-OUTPUT-STREAM
  1045.  
  1046. Returns a string containing the characters written to the stream STRING-
  1047. OUTPUT-STREAM (created by `make-string-output-stream'). The stream is then
  1048. reset so that the next call to this function with this stream will only
  1049. return the new characters. streamp ARG
  1050.  
  1051. Returns t if ARG is a stream. open [FILE-NAME MODE-STRING] [FILE]
  1052.  
  1053. Opens a file called FILE-NAME with modes MODE-STRING (standard c-library
  1054. modes, ie `r' == read, `w' == write, etc). If FILE is given it is an
  1055. existing file object which is to be closed before opening the new file on it. close FILE
  1056.  
  1057. Kills any association between object FILE and the file in the filesystem that
  1058. it has open. flush-file FILE
  1059.  
  1060. Flushes any buffered output on FILE. filep ARG
  1061.  
  1062. Returns t if ARG is a file object. file-bound-p FILE
  1063.  
  1064. Returns t if FILE is currently bound to a physical file. file-binding FILE
  1065.  
  1066. Returns the name of the physical file FILE is bound to, or nil. file-eof-p FILE
  1067.  
  1068. Returns t when the end of FILE is reached. read-file-until FILE REGEXP [IGNORE-CASE-P]
  1069.  
  1070. Read lines from the Lisp file object FILE until one matching the regular
  1071. expression REGEXP is found. The matching line is returned, or nil if no
  1072. lines match.
  1073. If IGNORE-CASE-P is non-nil the regexp matching is not case-sensitive. stdin-file
  1074.  
  1075. Returns the file object representing the editor's standard input. stdout-file
  1076.  
  1077. Returns the file object representing the editor's standard output. make-symbol NAME
  1078.  
  1079. Returns a new, uninterned, symbol with print-name NAME. It's value and
  1080. function definition are both void and it has a nil property-list. make-obarray SIZE
  1081.  
  1082. Creates a new structure for storing symbols in. This is basically a vector
  1083. with a few slight differences (all elements initialised to a special value). find-symbol NAME [OBARRAY]
  1084.  
  1085. Returns the symbol with print-name NAME, found by searching OBARRAY (or
  1086. the default `obarray' if nil), or nil if no such symbol exists. intern-symbol SYMBOL [OBARRAY]
  1087.  
  1088. Stores SYMBOL in OBARRAY (or the default). If SYMBOL has already been interned
  1089. somewhere an error is signalled. intern NAME [OBARRAY]
  1090.  
  1091. If a symbol with print-name exists in OBARRAY (or the default) return it.
  1092. Else use `(make-symbol NAME)' to create a new symbol, intern that into the
  1093. OBARRAY, then return it. unintern SYMBOL [OBARRAY]
  1094.  
  1095. Removes SYMBOL from OBARRAY (or the default). Use this with caution. symbol-value SYMBOL
  1096.  
  1097. Returns the value of SYMBOL, if SYMBOL is flagged as having buffer-local
  1098. values look for one of those first. set SYMBOL VALUE
  1099.  
  1100. Sets the value of SYMBOL to VALUE. If SYMBOL has a buffer-local binding
  1101. in the current buffer or `make-variable-buffer-local' has been called on
  1102. SYMBOL the buffer-local value in the current buffer is set. Returns VALUE. setplist SYMBOL PROP-LIST
  1103.  
  1104. Sets the property list of SYMBOL to PROP-LIST, returns PROP-LIST. symbol-name SYMBOL
  1105.  
  1106. Returns the print-name of SYMBOL. symbol-function SYMBOL
  1107.  
  1108. Returns the function value of SYMBOL. default-value SYMBOL
  1109.  
  1110. Returns the default value of the symbol SYMBOL. This will be the value of
  1111. SYMBOL in buffers or windows which do not have their own local value. default-boundp SYMBOL
  1112.  
  1113. Returns t if SYMBOL has a default value. set-default SYMBOL VALUE
  1114.  
  1115. Sets the default value of SYMBOL to VALUE, then returns VALUE. fboundp SYMBOL
  1116.  
  1117. Returns t if the function-slot of SYMBOL has a value. boundp SYMBOL
  1118.  
  1119. Returns t if SYMBOL has a value as a variable. symbol-plist SYMBOL
  1120.  
  1121. Returns the property-list of SYMBOL. gensym
  1122.  
  1123. Returns a new (non-interned) symbol with a unique print name. symbolp ARG
  1124.  
  1125. Returns t if ARG is a symbol. setq { SYMBOL FORM }...
  1126.  
  1127. Sets the value of each SYMBOL to the value of its corresponding FORM
  1128. evaluated, returns the value of the last evaluation. ie,
  1129.   (setq x 1 y (symbol-name 'nil))
  1130.    => "nil"
  1131.   x
  1132.    => 1
  1133.   y
  1134.    => "nil" setq-default { SYMBOL FORM }...
  1135.  
  1136. Sets the default value of each SYMBOL to the value of its corresponding
  1137. FORM evaluated, returns the value of the last evaluation. See also setq. fset SYMBOL VALUE
  1138.  
  1139. Sets the function value of SYMBOL to VALUE, returns VALUE. makunbound SYMBOL
  1140.  
  1141. Make SYMBOL have no value as a variable. fmakunbound SYMBOL
  1142.  
  1143. Make the function slot of SYMBOL have no value. let (SYMBOL-BINDINGS...) BODY...
  1144.  
  1145. Binds temporary values to symbols while BODY is being evaluated.
  1146. Each SYMBOL-BINDING is either a symbol, in which case that symbol is bound to
  1147. nil, or a list. The symbol at the head of this list is bound to the progn'ed
  1148. value of the forms making up the tail. ie,
  1149.   (let
  1150.       ((foo 1 2 3)
  1151.        bar)
  1152.     (cons foo bar))
  1153.    => (3 . nil)
  1154.  
  1155. All values of the new bindings are evaluated before any symbols are bound. let* (SYMBOL-BINDINGS...) BODY...
  1156.  
  1157. Binds temporary values to symbols while BODY is being evaluated.
  1158. Each SYMBOL-BINDING is either a symbol, in which case that symbol is bound to
  1159. nil, or a list. The symbol at the head of this list is bound to the progn'ed
  1160. value of the forms making up the tail. ie,
  1161.   (let*
  1162.       ((foo 1 2 3)
  1163.        bar)
  1164.     (cons foo bar))
  1165.    => (3 . nil)
  1166.  
  1167. The value of each binding is evaluated just before that symbol is bound,
  1168. this means that,
  1169.   (setq x 'foo)
  1170.   (let*
  1171.       ((x 10)
  1172.        (y x))
  1173.     (cons x y))
  1174.    => (10 . 10) get SYMBOL PROPERTY
  1175.  
  1176. Returns the value of SYMBOL's property PROPERTY. See `put'. put SYMBOL PROPERTY VALUE
  1177.  
  1178. Sets the value of SYMBOL's property PROPERTY to VALUE, this value can be
  1179. retrieved with the `get' function. make-local-variable SYMBOL
  1180.  
  1181. Gives the variable SYMBOL a buffer-local binding in the current buffer. It
  1182. will be the same as the default value to start with. If the current buffer
  1183. alread has a buffer-local binding for SYMBOL nothing happens.
  1184. Returns SYMBOL. make-variable-buffer-local SYMBOL
  1185.  
  1186. Marks the variable SYMBOL as being automatically buffer-local. Any attempts
  1187. at setting SYMBOL result in the current buffer being given its own binding.
  1188. Returns SYMBOL. buffer-variables [BUFFER]
  1189.  
  1190. Returns a list of (SYMBOL . VALUE) bindings which take effect when the
  1191. current buffer is BUFFER. kill-all-local-variables [BUFFER]
  1192.  
  1193. Remove all buffer-local variables from BUFFER. kill-local-variable SYMBOL [BUFFER]
  1194.  
  1195. Remove the buffer-local value of the symbol SYMBOL in the specified buffer. apropos REGEXP [PREDICATE] [OBARRAY]
  1196.  
  1197. Returns a list of symbols from OBARRAY (or the default) whose print-name
  1198. matches the regular-expression REGEXP. If PREDICATE is given and non-nil,
  1199. each symbol which matches is applied to the function PREDICATE, if the value
  1200. is non-nil it is considered a match. set-const-variable SYMBOL
  1201.  
  1202. Flags that the value of SYMBOL may not be changed. const-variable-p SYMBOL
  1203.  
  1204. Return t is `set-const-variable' has been called on SYMBOL. trace SYMBOL
  1205.  
  1206. Flag that whenever SYMBOL is evaluated (as a variable or a function) the
  1207. debugger is entered. untrace SYMBOL
  1208.  
  1209. Cancel the effect of (trace SYMBOL). The obarray used by the Lisp reader. undo [BUFFER]
  1210.  
  1211. In the buffer BUFFER, undo everything back to the start of the previous
  1212. command. Consecutive undo commands work backwards through the BUFFER's
  1213. history. The maximum amount of storage that a single buffer may devote to recording
  1214. undo information. When nil no undo information is kept in this buffer. This buffer's list of undo information. cons CAR-VALUE CDR-VALUE
  1215.  
  1216. Returns a new cons-cell with car CAR-VALUE and cdr CDR-VALUE. pos X Y
  1217.  
  1218. Returns a new position object with coordinates (X , Y). copy-pos POS
  1219.  
  1220. Returns a new copy of POS. The number of bytes of storage which must be used before a garbage-
  1221. collection is triggered. The number of bytes of storage which must be used before a garbage-
  1222. collection is triggered when the editor is idle. garbage-collect
  1223.  
  1224. Scans all allocated storage for unusable data, and puts it onto the free-
  1225. list. This is done automatically when the amount of storage used since the
  1226. last garbage-collection is greater than `garbage-threshold'. make-window [X] [Y] [WIDTH] [HEIGHT]
  1227.  
  1228. Return a new window, it will be displaying the same buffer as the currently
  1229. active window. destroy-window [WINDOW]
  1230.  
  1231. Close WINDOW (or the current window), if this was the last one all files in
  1232. memory are flushed and jade will exit. sleep-window [WINDOW]
  1233.  
  1234. Iconifies the current window. unsleep-window [WINDOW]
  1235.  
  1236. Uniconifies the current window. next-window [WINDOW] [ACTIVATE]
  1237.  
  1238. Cycles through the open windows forwards. message STRING [DISPLAY-NOW]
  1239.  
  1240. Temporarily sets the status display to STRING, this won't happen until the
  1241. window is next refreshed unless DISPLAY-NOW is non-nil. font-name [WINDOW]
  1242.  
  1243. Returns the name of the font being used in this window. Maximum scroll distance (number of lines). If a set of lines has to be
  1244. scrolled further than this the whole window is redrawn. Controls the actual number of lines scrolled when the cursor moves out of
  1245. view. The number of lines to move the display origin is calcualted with the
  1246. formula:
  1247.   LINES_TO_SCROLL = TOTAL_LINES_IN_WINDOW / y-scroll-step-ratio
  1248. If the value is 0 then the window will be scrolled by one line. Controls the actual number of columns scrolled when the cursor moves out of
  1249. view. The number of lines to move the display origin is calcualted with the
  1250. formula:
  1251.   COLUMNS_TO_SCROLL = TOTAL_COLUMNS_IN_WINDOW / x-scroll-step-ratio
  1252. If the value is 0 then the window will be scrolled by one column. rect-blocks-p [WINDOW]
  1253.  
  1254. Returns t if blocks marked in WINDOW (or the current one) are treated as
  1255. rectangles. set-rect-blocks WINDOW STATUS
  1256.  
  1257. Controls whether or not blocks are taken as contiguous regions of text or as
  1258. rectangles in WINDOW. When STATUS is t rectangles are used. window-asleep-p
  1259.  
  1260. Returns t if window is currently iconified. window-count
  1261.  
  1262. Number of opened windows. position-window LEFT TOP WIDTH HEIGHT
  1263.  
  1264. Sets the position and dimensions of the current window. These are all
  1265. *pixel* measurememnts. current-window
  1266.  
  1267. Returns the currently active window. Note that this is the editor's notion
  1268. of `current' -- it doesn't necessarily mean that this is the window to which
  1269. your window system will send input events to. with-window WINDOW FORMS...
  1270.  
  1271. Set the editor's current window to WINDOW and evaluate FORMS, then
  1272. reinstall the original window as the current one. set-current-window WINDOW [ACTIVATE-P]
  1273.  
  1274. Sets the window which jade reguards as current.
  1275. If ACTIVATE-P is non-nil the window will be activated with respect to the
  1276. window-system (under X11 this means warping the pointer to the top left corner
  1277. of the window as well). window-id [WINDOW]
  1278.  
  1279. Returns the identifier of the physical window that the Lisp window WINDOW
  1280. points to. This is window-system dependant, under X11 it will be some integer,
  1281. under Intuition a pointer (integer) to the window structure. font-x-size [WINDOW]
  1282.  
  1283. Returns the width of the window's font (in pixels). font-y-size [WINDOW]
  1284.  
  1285. Returns the height of the window's font (in pixels). When this window-local variable is non-nil the window's cursor is drawn at
  1286. the end of the message in the status line, not in the main display. List of buffers in most-recently-used order. Each window has it's own. set-font FONT-NAME [WINDOW]
  1287.  
  1288. FONT-NAME specifies the font to use in WINDOW (or the active one).
  1289. Under X11 FONT-NAME is a standard font description, under AmigaDOS it is the
  1290. name of the font followed by a dash and then the point size to use (for
  1291. example "topaz.font-8" to get an 8-point topaz font). screen-width
  1292.  
  1293. Returns the width of the root window or screen in pixels. screen-height
  1294.  
  1295. Returns the height of the root window or screen in pixels. window-left-edge
  1296.  
  1297. Returns the x position of the current window relative to the origin of the
  1298. root window or screen. window-top-edge
  1299.  
  1300. Returns the y position of the current window relative to the origin of the
  1301. root window or screen. window-width
  1302.  
  1303. Returns the width, in pixels, of the current window. window-height
  1304.  
  1305. Returns the height, in pixels, of the current window. window-bar-height
  1306.  
  1307. On an Amiga returns the number of pixels high the title bar of the window
  1308. is. This is 0 in X11. flush-output
  1309.  
  1310. Forces any cached window output to be drawn. This is usually unnecessary. delete-file FILE-NAME
  1311.  
  1312. Attempts to delete the file called FILE-NAME. rename-file SRC DEST
  1313.  
  1314. Tries to rename the file SRC as DEST, this doesn't work across filesystems, or
  1315. if a file DEST already exists. copy-file SRC DEST
  1316.  
  1317. Copies the file called SRC to the file DEST. file-readable-p FILE
  1318.  
  1319. Returns t if FILE available for reading from. file-writable-p FILE
  1320.  
  1321. Returns t if FILE available for writing to. file-exists-p FILE
  1322.  
  1323. Returns t if FILE exists. file-regular-p FILE
  1324.  
  1325. Returns t if FILE is a ``normal'' file, ie, not a directory, device, symbolic
  1326. link, etc... file-directory-p FILE
  1327.  
  1328. Returns t if FILE is a directory. file-symlink-p FILE
  1329.  
  1330. Returns t if FILE is a symbolic link to another file. file-owner-p FILE
  1331.  
  1332. Returns t if the ownership (uid & gid) of file FILE (a string) is the same
  1333. as that of any files written by the editor. file-nlinks FILE
  1334.  
  1335. Returns the number of links pointing to the file called FILE. This will be
  1336. one if FILE has only one name. Doesn't count symbolic links. file-modes FILE
  1337.  
  1338. Return the access permissions of the file called FILE, an integer. Note that
  1339. the format of this integer is not defined, it differs from system to system. set-file-modes FILE MODES
  1340.  
  1341. Sets the access permissions of FILE to MODES, an integer. The only real way
  1342. you can get this integer is from `file-modes' since it changes from system
  1343. to system. file-modtime FILE
  1344.  
  1345. Return the time (an integer) that FILE was last modified. directory-files DIRECTORY
  1346.  
  1347. Returns a list of the names of all files in directory DIRECTORY, directories
  1348. in DIRECTORY have a `/' character appended to their name. user-login-name
  1349.  
  1350. Returns the login name of the user (a string).
  1351. On the Amiga this is taken from the environment variable `USERNAME'. user-full-name
  1352.  
  1353. Returns the real name of the user (a string).
  1354. On the Amiga this is taken from the environment variable `REALNAME'. user-home-directory
  1355.  
  1356. Returns the user's home directory (a string). It will be terminated by a slash
  1357. (or whatever is appropriate) so that it can be glued together with a file name
  1358. making a valid path name.
  1359.  
  1360. The first place we look for the directory name is the `HOME' environment
  1361. variable. If this doesn't exist we either use the `SYS:' assignment when
  1362. on AmigaDOS or look in the /etc/passwd file if on Unix. system-name
  1363.  
  1364. Returns the name of the host which the editor is running on.
  1365. On the Amiga this is taken from the environment variable `HOSTNAME'. setenv VARIABLE [VALUE]
  1366.  
  1367. Sets the value of the environment variable called VARIABLE (a string) to
  1368. the string VALUE. If VALUE is undefined or nil the variable is removed from
  1369. the environment. make-process [OUTPUT-STREAM] [FUN] [DIR] [PROGRAM] [ARGS]
  1370. <UNIX-ONLY>
  1371.  
  1372. Creates a new process-object, OUTPUT-STREAM is where all output from this
  1373. process goes, FUN is a function to call each time the process running
  1374. on this object changes state. DIR is the process' current directory,
  1375. PROGRAM the filename of the program to run and ARGS a list of arguments
  1376. passed to the process.
  1377.  
  1378. Any of the arguments may be unspecified, in which case they can be set
  1379. either by the functions provided or by the function called to create the
  1380. actual running process. start-process [PROCESS] [PROGRAM] [ARGS...]
  1381. <UNIX-ONLY>
  1382.  
  1383. Starts a process running on process-object PROCESS. The child-process runs
  1384. asynchronously with the editor. If PROCESS is unspecified the make-process
  1385. function will be called (with zero arguments) to create one.
  1386.  
  1387. PROGRAM is the filename of the binary image, it will be searched for in
  1388. all directories listed in the `PATH' environment variable.
  1389. ARGS are the arguments to give to the process.
  1390.  
  1391. If any of the optional parameters are unspecified they should have been
  1392. set in the PROCESS prior to calling this function. run-process [PROCESS] [IN-FILE] [PROGRAM] [ARGS...]
  1393. <UNIX-ONLY>
  1394.  
  1395. Starts a process running on process-object PROCESS. Waits for the child to
  1396. exit, then returns the exit-value of the child. If PROCESS is unspecified
  1397. the make-process function will be called (with zero arguments) to create one.
  1398.  
  1399. IN-FILE is the name of the file to connect to the process' standard input,
  1400. if this is not defined `/dev/null' is used.
  1401. PROGRAM is the filename of the binary image, it will be searched for in
  1402. all directories listed in the `PATH' environment variable.
  1403. ARGS are the arguments to give to the process.
  1404.  
  1405. If any of the optional parameters are unspecified they should have been
  1406. set in the PROCESS prior to calling this function. signal-process PROCESS SIGNAL [SIGNAL-GROUP]
  1407. <UNIX-ONLY>
  1408.  
  1409. If PROCESS is running asynchronously then send signal number SIGNAL to it.
  1410.  
  1411. If SIGNAL-GROUP is non-nil also send the signal to all processes in the
  1412. process group of PROCESS. interrupt-process PROCESS [SIGNAL-GROUP]
  1413. <UNIX-ONLY>
  1414.  
  1415. Do (signal-process PROCESS SIGINT SIGNAL-GROUP) or equivalent. kill-process PROCESS [SIGNAL-GROUP]
  1416. <UNIX-ONLY>
  1417.  
  1418. Do (signal-process PROCESS SIGKILL SIGNAL-GROUP) or equivalent. stop-process PROCESS [SIGNAL-GROUP]
  1419. <UNIX-ONLY>
  1420.  
  1421. Suspends execution of PROCESS, see `continue-process'. If SIGNAL-GROUP is
  1422. non-nil also suspends the processes in the process group of PROCESS. continue-process PROCESS [SIGNAL-GROUP]
  1423. <UNIX-ONLY>
  1424.  
  1425. Restarts PROCESS after it has been stopped (via `stop-process'). If
  1426. SIGNAL-GROUP is non-nil also continues the processes in the process group of
  1427. PROCESS. process-exit-status PROCESS
  1428. <UNIX-ONLY>
  1429.  
  1430. Returns the unprocessed exit-status of the last process to be run on the
  1431. process-object PROCESS. If PROCESS is currently running, return nil. process-exit-value PROCESS
  1432. <UNIX-ONLY>
  1433.  
  1434. Returns the return-value of the last process to be run on PROCESS, or nil if:
  1435.   a) no process has run on PROCESS
  1436.   b) PROCESS is still running
  1437.   c) PROCESS exited abnormally process-id PROCESS
  1438. <UNIX-ONLY>
  1439.  
  1440. If PROCESS is running, return the process-identifier associated with it
  1441. (ie, its pid). process-running-p PROCESS
  1442. <UNIX-ONLY>
  1443.  
  1444. Return t if PROCESS is running. process-stopped-p PROCESS
  1445. <UNIX-ONLY>
  1446.  
  1447. Return t if PROCESS has been stopped. process-in-use-p PROCESS
  1448. <UNIX-ONLY>
  1449.  
  1450. Similar to `process-running-p' except that this returns t even when the
  1451. process has stopped, or has exited but the pty connected to `PROCESS' is still
  1452. in use. processp ARG
  1453. <UNIX-ONLY>
  1454.  
  1455. Return t is ARG is a process-object. process-prog PROCESS
  1456. <UNIX-ONLY>
  1457.  
  1458. Return the name of the program in PROCESS. set-process-prog PROCESS PROGRAM
  1459. <UNIX-ONLY>
  1460.  
  1461. Sets the name of the program to run on PROCESS to FILE. process-args PROCESS
  1462. <UNIX-ONLY>
  1463.  
  1464. Return the list of arguments to PROCESS. set-process-args PROCESS ARG-LIST
  1465. <UNIX-ONLY>
  1466.  
  1467. Set the arguments to PROCESS. process-output-stream PROCESS
  1468. <UNIX-ONLY>
  1469.  
  1470. Return the stream to which all output from PROCESS is sent. set-process-output-stream PROCESS STREAM
  1471. <UNIX-ONLY>
  1472.  
  1473. Set the output-stream of PROCESS to STREAM. process-function PROCESS
  1474. <UNIX-ONLY>
  1475.  
  1476. Return the function which is called when PROCESS changes state (i.e. it
  1477. exits or is stopped). set-process-function PROCESS FUNCTION
  1478. <UNIX-ONLY>
  1479.  
  1480. Set the function which is called when PROCESS changes state to FUNCTION. process-dir PROCESS
  1481. <UNIX-ONLY>
  1482.  
  1483. Return the name of the directory which becomes the working directory of
  1484. PROCESS when it is started. set-process-dir PROCESS DIR
  1485. <UNIX-ONLY>
  1486.  
  1487. Set the directory of PROCESS to DIR. process-connection-type PROCESS
  1488. <UNIX-ONLY>
  1489.  
  1490. Returns a symbol defining the type of stream (i.e. pipe or pty) used to
  1491. connect PROCESS with its physical process. set-process-connection-type PROCESS TYPE
  1492. <UNIX-ONLY>
  1493.  
  1494. Define how PROCESS communicates with it's child process, TYPE can be one of
  1495. the following symbols,
  1496.   pty        Use a pty
  1497.   pty-echo    Similar to `pty' but the ECHO flag is set in the slave
  1498.   pipe        Two pipes are used
  1499.  
  1500. This function can only be used when PROCESS is not in use. server-open-p
  1501.  
  1502. t if the edit-server is open. server-open
  1503.  
  1504. Creates the socket (or whatever) so that the editor's client program can
  1505. send us messages. server-close
  1506.  
  1507. Stops listening for client messages. server-reply [FILE-NAME] [RETURN-CODE]
  1508.  
  1509. Replies to the editor client which asked us to edit the file FILE-NAME.
  1510. RETURN-CODE is the optional result for the client, by default it is zero
  1511. which denotes no errors. Returns nil if the file doesn't have a client. set-menu-enabled ENABLED-P [WINDOW]
  1512. <AMIGA-ONLY>
  1513.  
  1514. If ENABLED-P is non-nil the menu will be active in WINDOW, if WINDOW is not
  1515. specified, menus will be enabled in *all* windows. When a menu is not enabled
  1516. in a window right mouse button events will be detectable.
  1517.  
  1518. Note that for a menu to be displayed the `set-menu' command must be used first
  1519. to create a menu strip. menu-enabled-p [WINDOW]
  1520. <AMIGA-ONLY>
  1521.  
  1522. Returns t if a menu is being displayed in WINDOW (or the current window). set-menu MENUS...
  1523. <AMIGA-ONLY>
  1524.  
  1525. Creates a new menustrip, each window then has these menus.
  1526. Each MENU defines a single menu block, it has this format,
  1527.  
  1528.     (MENU-NAME MENU-ITEM...)
  1529.  
  1530. MENU-NAME is the name of the block, each MENU-ITEM defines a single menuitem,
  1531. they are either nil (empty menu item) or look like,
  1532.  
  1533.     (ITEM-NAME [SHORTCUT] COMMAND)
  1534.  
  1535. ITEM-NAME is the item name, SHORTCUT is an optional keyboard shortcut (a one
  1536. character long string) and COMMAND is the command to be called when the
  1537. menu is selected (see the function `call-command').
  1538.  
  1539. The shortcuts may be upper or lower case. Menu shortcuts are only
  1540. considered to be case-significant when two shortcuts of the same letter (but
  1541. different case) are defined. rexx-async-macro NAME
  1542. <AMIGA-ONLY>
  1543.  
  1544. Asynchronously invokes the ARexx macro called NAME. rexx-async-str STRING
  1545. <AMIGA-ONLY>
  1546.  
  1547. Gets ARexx to asynchronously interpret the string of REXX code STRING. rexx-sync-macro NAME
  1548. <AMIGA-ONLY>
  1549.  
  1550. Invokes the ARexx macro NAME synchronously, returning its value when it
  1551. exits (this will either be a number or a string. rexx-sync-str STRING
  1552. <AMIGA-ONLY>
  1553.  
  1554. Synchronously executes the string of ARexx commands STRING, returning their
  1555. exit value. Variable holding the name of our ARexx port. (Amiga only). file-req TITLE [FILE-NAME] [FOR-WRITING-P]
  1556. <AMIGA ONLY>
  1557.  
  1558. Displays a file requester (standard one from asl.library) asking for the name
  1559. of a file. FOR-WRITING-P should be non-nil if the file being requested for
  1560. will be written to. TITLE is the name of the requester. FILE-NAME is
  1561. the starting value for the filename.
  1562.  
  1563. If a filename is selected its name is returned (a string), else this
  1564. function returns nil. req BODY-STRING GADGETS-STRING
  1565. <AMIGA-ONLY>
  1566.  
  1567. Function to do a request.
  1568. Result is number of gadget pressed (starting at 1 for leftmost gadget and
  1569. incrementing by one, rightmost gadget is 0. This variable controls the name of the public-screen which the window
  1570. opens onto. It is only available when running on an Amiga. List of buffers marked for deletion. List of buffers marked to be saved. Buffer Menu Mode:
  1571.  
  1572. This major mode is used in the `*Buffer Menu*' buffer; it provides
  1573. interactive commands for manipulating the list of buffers loaded into
  1574. the editor.
  1575.  
  1576. Commands available are,
  1577.  
  1578.   `d'            Mark buffer for deletion.
  1579.   `s', `Ctrl-s'        Mark buffer to be saved.
  1580.   `x'            Execute marked saves and deletions.
  1581.   `u'            Unmark the current line.
  1582.   `1'            Select the current line's buffer in this window.
  1583.   `o'            Display the current line's buffer in a different
  1584.             window.
  1585.   `~'            Toggle the buffer's `modified' flag.
  1586.   `%', `-'        Toggle the buffer's read-only status.
  1587.   `Ctrl-f', `TAB'    Move forwards through the menu.
  1588.   `Ctrl-b', `Shift-TAB' Cycle backwards through the menu.
  1589.   `Ctrl-l'        Redraw the menu, incorporating any changes to the
  1590.             buffer-list.
  1591.   `q'            Quit the buffer menu. The file name of the gdb program to run. When non-nil the current line in the source window is automatically
  1592. centred each time it changes. (FILE . LINE-NUMBER) representing the last frame we displayed. This is the last *gdb* buffer which was used. Flag that says this buffer is for running a gdb process. Run the gdb debugger in an editor buffer (called `*gdb*'). PROG is the
  1593. program which is to be debugged.
  1594. See the `gdb-mode' documentation for details of the available commands.
  1595. There is no limit to the number of gdb processes you may run at once. Gdb Mode:
  1596.  
  1597. This major-mode is used to run the GDB debugger in an editor buffer. To
  1598. start a gdb subprocess use the `ESC x gdb' command.
  1599.  
  1600. Each time the target process stops executing the source line of the
  1601. current frame is highlighted in a separate window.
  1602.  
  1603. The following commands are available in the `*gdb*' buffer,
  1604.  
  1605.   `Ctrl-c Ctrl-n'    Next line
  1606.   `Ctrl-c Ctrl-s'    Step 
  1607.   `Ctrl-c Ctrl-i'    Step the next instruction
  1608.   `Ctrl-c Ctrl-I'    Next instruction
  1609.   `Ctrl-c Ctrl-f'    Finish this frame
  1610.   `Ctrl-c Ctrl-r'    Continue execution
  1611.   `Ctrl-c Ctrl-<'    Move up one frame
  1612.   `Ctrl-c Ctrl->'    Move down one frame
  1613.   `Ctrl-c Ctrl-b'    Set a breakpoint at the current line
  1614.   `Ctrl-c Ctrl-t'    Set a temporary breakpoint
  1615.   `Ctrl-c Ctrl-d'    Delete the breakpoint at the current line
  1616.   `Ctrl-c Ctrl-l'    Redisplay the current frame
  1617.  
  1618. They are also accessible in any buffer by replacing the `Ctrl-c' prefix
  1619. with `Ctrl-x Ctrl-a'.
  1620.  
  1621. Since this command is built on top of the shell-mode all commands from
  1622. that mode are available as well. The name of the shell program. When non-nil the whole line (minus the prompt) is sent to the shell
  1623. process when `RET' is typed, even if the cursor is not at the end of the
  1624. line. The program to run, by default the standard shell. The arguments to give to the program when it's started. A regexp matching the prompt of the shell. Holds the function to call when the process changes state. Stream to output to from subprocess. If nil the process' buffer is
  1625. written to. This is only consulted when the process is started. The process that the Shell mode created in the current buffer. Keymap for shell-mode. Keymap for ctrl-c in shell-mode. Shell Mode:
  1626.  
  1627. Major mode for running a subprocess in a buffer. Special commands are,
  1628.  
  1629.   `Ctrl-a'        Move to the start of this line (after the prompt)
  1630.   `Ctrl-d'        If at the end of the buffer send the ^D character,
  1631.             otherwise delete the current character.
  1632.   `RET'            Send the current line to the process
  1633.   `Ctrl-c Ctrl-c'    Send the `intr' character to the process (`^C')
  1634.   `Ctrl-c Ctrl-z'    Send the `susp' character (`^Z')
  1635.   `Ctrl-c Ctrl-d'    Send the `eof' character (`^D')
  1636.   `Ctrl-c Ctrl-\'    Send the `quit' character (`^\')
  1637.   `Ctrl-c Ctrl-n'    Move to the next prompt
  1638.   `Ctrl-c Ctrl-p'    Move to the previous prompt Go to the beginning of this shell line (but after the prompt). When at the very end of the buffer send the subprocess the EOF character,
  1639. otherwise delete the first COUNT characters under the cursor. Send the current line to the shell process. If the current line is not the
  1640. last in the buffer the current command is copied to the end of the buffer. Run a subshell in a buffer called `*shell*' using the major mode
  1641. `shell-mode'. Prints a description of the installed keymaps in the current buffer. Read the next event and return a cons cell containing the two integers that
  1642. define that event. Read an event sequence from the user then display details of the command it
  1643. would invoke. Indentation of code with respect to its containing block. Extra indentation of braces relative to the body of the code they
  1644. contain. Extra indentation for case statements. Extra indentation for labels. Indent the line at POS (or the cursor) assuming that it's C source code. List of all opened windows. Hook called when an input event saying that a window should be closed
  1645. is received. Creates a new window display BUFFER or the buffer that the current window is
  1646. showing. Close window WIN, or the current window. Close all windows except for WIN, or the current one. Make sure that BUFFER is in the `buffer-list' of all open windows. It gets
  1647. put at the end of the list. Delete all references to BUFFER in any of the windows' `buffer-list' Switches to the `other' window then calls the command COMMAND in it. Switch to the `other' window. (other-window)
  1648. Return the `other' window. Toggle the current window between iconified and normal states. Mode for editing English text in. Variant of `text-mode' in which the TAB key indents to the depth of the
  1649. previous line, then works as normal. Centre the line at POS. Centre the paragraph surrounding POS. Texinfo Mode:
  1650.  
  1651. Major mode for editing Texinfo source files.
  1652.  
  1653. Special commands available are,
  1654.  
  1655.   `Ctrl-c Ctrl-c c'    Insert `@code'
  1656.   `Ctrl-c Ctrl-c d'    Insert `@dfn'
  1657.   `Ctrl-c Ctrl-c e'    Insert the correct `@end' command for the current
  1658.             context.
  1659.   `Ctrl-c Ctrl-c f'    Insert `@file'
  1660.   `Ctrl-c Ctrl-c i'    Insert `@item'
  1661.   `Ctrl-c Ctrl-c l'    Insert `@lisp'
  1662.   `Ctrl-c Ctrl-c m'    Insert `@menu'
  1663.   `Ctrl-c Ctrl-c Ctrl-m' Insert a menu item.
  1664.   `Ctrl-c Ctrl-c n'    Prompt for each part of an `@node' line and insert
  1665.             the constructed line.
  1666.   `Ctrl-c Ctrl-c s'    Insert `@samp'
  1667.   `Ctrl-c Ctrl-c v'    Insert `@var'
  1668.   `Ctrl-c Ctrl-c {'    Insert a pair of braces and place the cursor between
  1669.             them.
  1670.   `Ctrl-c Ctrl-c }',
  1671.   `Ctrl-c Ctrl-c ]'    Move the cursor to the character after the next closing
  1672.             brace. Determines which window a client file gets displayed in. There are three
  1673. possible values,
  1674.   nil    - Use the current window
  1675.   other - Use the `other' window
  1676.   t    - Open a new window This function is called by the editor's main event loop when a client
  1677. process asks us to edit a file -- its job is to load the specified file
  1678. into a new buffer and display it at line LINE-NUMBER. Tell the client program which asked us to edit the file in the current
  1679. buffer that we've finished with it. *The file will NOT be saved* automatically
  1680. -- you're supposed to do that before calling this function if you want to. Replace all occurrences of the regexp FROM with the expansion from TEMPLATE
  1681. for that particular occurrence (see the `replace-regexp' function for details
  1682. of what can be in TEMPLATE). Command to interactively replace all occurrences of the regexp
  1683. QUERY-REPLACE-FROM with the expansion of the template QUERY-RFEPLACE-TO.
  1684. If FROM or TO are not given they are prompted for.
  1685.   As each occurrence is found the editor pauses, waiting for the user to
  1686. type one of the following special commands,
  1687.  
  1688.   `SPC', `y'         replace this occurrence and find the next
  1689.   `BS', `n'          ignore this occurrence and search for the next
  1690.   `,'                replace this match and wait for another command
  1691.   `RET', `ESC', `q'  exit the query-replace
  1692.   `.'                replace this occurrence then exit the query-replace
  1693.   `!'                replace all matches from here to the end of the buffer
  1694.   `^'                return to the previous match
  1695.   `Ctrl-r'           enter a recursive edit (`ESC Ctrl-c' to exit)
  1696.   `Ctrl-w'           delete the match, then enter a recursive edit
  1697.   `Ctrl-h'           show some help text Stack of buffers which can be used for prompts. Optional function taking one argument, the string to be completed. It
  1698. should return a list of all matches. Optional function taking one argument, the string which has been entered.
  1699. Should return non-nil when this string may be accepted (and therefore the
  1700. prompt will end). If it returns the symbol t the string is returned as-is,
  1701. if some other non-nil value is returned *that* is the value returned by
  1702. the prompt. Default value of `prompt-word-regexps' Vector of two regexps; the values of `word-regexp' and `word-not-regexp'
  1703. for the prompt. Used by the `prompt-complete-from-list' and `prompt-validate-from-list'
  1704. to supply possible completions. Predicate used when prompting for symbols. *AMIGA ONLY*
  1705. When non-nil the normal ASL file requester is used when file names are
  1706. prompted for. The buffer being used for the prompt. Position at which the list of completions should be printed. Prompts for a string using completion. TITLE is the optional title to
  1707. print in the buffer, START the original contents of the buffer.
  1708. The string entered is returned, or nil if the prompt is cancelled (by Ctrl-g). A regexp, if it matches the file being considered for completion, the file
  1709. is rejected. Prompt for a file, if EXISTING is t only files which exist are
  1710. allowed to be entered. Prompt for a directory, if EXISTING is t only files which exist are
  1711. allowed to be entered. Prompt for a buffer, if EXISTING is t the buffer selected must exist,
  1712. otherwise if EXISTING is nil the buffer will be created if it doesn't
  1713. exist already. DEFAULT is the value to return if the user enters the null
  1714. string, if nil the current buffer is returned. Prompt for an existing symbol. If PROMPT-SYMBOL-PREDICATE is given the
  1715. symbol must agree with it. Prompt for a lisp object. Prompt for a function. Prompt for a variable. Prompt for a command. Return a selected choice from the list of options (strings) PROMPT-LIST.
  1716. PROMPT is the title displayed, START the starting choice. List of all major modes which can be enabled by loading a file into
  1717. a buffer. List is made of `(REGEXP . MODE)' cells; the REGEXP is matched
  1718. against the mode specification (i.e. the filename), if it matches the
  1719. function MODE is called to install the mode. The function which was used to initialise the buffer's major mode. The function which should be called to remove the buffer's major mode. Buffer-local variable containing the canonical column number which
  1720. comments should begin at. If the line extends past this column the next
  1721. tab stop after the end of the line is used instead. A function called to indent a specified line in the current buffer. Function like `lisp-forward-sexp'. Function like `lisp-backward-sexp'. Scan the alist `mode-alist' for a mode whose regexp matches NAME,
  1722. returning the initialisation function of that mode (a symbol) or nil. Initialise an edit-mode for buffer BUF, either calls the function named
  1723. in the buffer-local variable `major-mode' or finds a mode in `mode-alist'
  1724. using one of the following to match against:
  1725.   1. NAME
  1726.   2. The word specified on the first line of the buffer surrounded by
  1727.      `-*-...-*-' (ie, -*-texinfo-*-)
  1728.   3. The value of the variable `mode-name'
  1729.   4. The name of the file being edited in the buffer Destroy the mode being used to edit buffer BUF with. List of all minor-modes enabled in this buffer. Buffer-local keymap to be used by minor-modes. This is only created
  1730. the first time a minor mode calls `add-minor-mode' in the buffer. For use by minor-modes. MODE is the mode's function symbol. This sets up the
  1731. current buffer. All minor-modes should call this before doing anything drastic.
  1732. NAME is the string to be displayed in the status-line to show that the mode
  1733. is enabled. For use by minor-modes. MODE is the mode's function symbol. Removes MODE
  1734. from the current buffer. Insert comment delimeters on the current line, place the cursor where the
  1735. comment should be written. This may or not be defined by each major mode. Use the `mode-indent-line' function to indent each line between START and
  1736. END. (newline-and-indent)
  1737. Insert a newline then either call this buffer's `mode-indent-line' function
  1738. or insert a tab. Indent the current line. Move forward NUMBER expressions. Move backwards NUMBER expressions. Kill the next NUMBER expressions. Kills from the start of this NUMBER'th previous expression to the cursor. Move the expression before the cursor COUNT expressions forwards. The root keymap. Default `Ctrl-x' keymap. Default `Ctrl-x 4' keymap. Default `Ctrl-x 5' keymap. Hook to hang major mode `Ctrl-c' keymap from. Keymap for user-defined bindings, hung from `Ctrl-c'. This function can be bound to a key to make it insert its usual character
  1739. sequence. This is usually used to ``hide'' a previously bound definition of
  1740. the key. Add a digit to the prefix-arg. Negate the prefix-arg. Bound to `Meta--'.  A list of symbols definining which ``features'' Jade currently has loaded.
  1741. This is used by the `featurep', `provide' and `require' functions. If FEATURE (a symbol) has not already been loaded, load it. The file
  1742. loaded is either FILE (if given), or the print name of FEATURE. Show that the feature FEATURE (a symbol) has been loaded. Return non-nil if feature FEATURE has already been loaded. Tell the evaluator that the function value of SYMBOL will be initialised
  1743. from a named file. The AUTOLOAD-DEFN is the contents of the SYMBOL's
  1744. autoload definition. Currently two items are used, the first is the name
  1745. of the file to load the value of SYMBOL from. The second says whether or
  1746. not the function SYMBOL may be called interactively (as a command). Arrange it so that FUNCTION-NAME is added to the hook-list stored in
  1747. symbol, HOOK-SYMBOL. It will added at the head of the list unless AT-END
  1748. is non-nil in which case it is added at the end. Remove FUNCTION-NAME from the hook HOOK-SYMBOL. Return a string representing OBJECT. Reads an object from STRING, starting at character number START (default
  1749. is 0). Eval FORM then print its value in the status line. Lisp Mode:
  1750.  
  1751. Major mode for editing Lisp source. Special commands in this mode are,
  1752.  
  1753.   `Ctrl-j'        Evaluate the current s-expression as Jade Lisp code
  1754.             and insert its value into the current buffer.
  1755.   `TAB'            Indent the current line.
  1756.   `Ctrl-Meta-x'        Evaluate the current sexp and print its value in
  1757.             the status line.
  1758.   `Ctrl-Meta-f'        Move to the past the current s-expression.
  1759.   `Ctrl-Meta-b'        Move to the beginning of the current sexp.
  1760.   `Ctrl-Meta-k'        Kill from the cursor to the end of this sexp.
  1761.   `Ctrl-Meta-BS'    Kill from the start of this sexp to the cursor. Evaluates the Lisp expression before the cursor and returns its value. Evaluates the Lisp expression before the cursor, then inserts its value
  1762. into the buffer. Evaluates the Lisp expression before the cursor, then displays its value
  1763. in the status line. Return the position of the NUMBER'th next s-expression from POS. Return the position of the NUMBER'th previous s-expression from ORIG-POS. Number of columns to indent code bodies by. Returns the correct indentation position for the specified line. Non-nil when the Latin-1 character set is being used. Toggles whether or not the characters with numeric values from 160 to 256
  1764. are displayed as octal escape sequences or in the Latin-1 character set. Buffer-local variable, when non-nil case of characters is ignored when
  1765. searching. The last regexp successfully (i.e. entered with RET) found by isearch. Enters the incremental search mode. You are then able to type letters to add
  1766. to the regexp being searched for. Special commands are,
  1767.  
  1768.   `Ctrl-s'     Search forwards for another occurrence
  1769.   `Ctrl-r'     Search backwards 
  1770.   `Ctrl-g'     If the search is failing, backtrack to the first non-failing
  1771.                match, else, cancel the search leaving the cursor at its
  1772.                original position.
  1773.   `Ctrl-w'     Copy the rest of the current word into the search string
  1774.   `Ctrl-y'     Copy the rest of the line to the search string
  1775.   `RET'        Exit isearch leaving the cursor at its current position
  1776.   `BS'         Retrace your movements one step Similar to `isearch-forward' except the first searching is done in the other
  1777. direction. List of directories to search for info files if they can't be found as-is. Keymap for Info. Buffer in which Info nodes are displayed. Buffer for storing the current Info file's tag table. List of `(FILE NODE POS)' showing how we got to the current node. The true name (in the filesystem) of the current Info file. The name of the current Info node. The modtime of file `info-file-name' last time we read something from it. List of `(START-OFFSET . FILE-NAME)' saying where the current Info file
  1778. is split. t when we were able to load a tag table for this Info file. Protection against being loaded multiple times. Start the Info viewer. If START-NODE is given it specifies the node to
  1779. show, otherwise the current node is used (or `(dir)' if this is the first
  1780. time that `info' has been called). Info mode:
  1781.  
  1782. This mode is used to browse through the Info tree of documentation, special
  1783. commands are,
  1784.  
  1785.   `SPC'        Next screen of text
  1786.   `BS'        Previous screen
  1787.   `b'        Move to the start of this node
  1788.   `1' to `9'    Go to the Nth menu item in this node
  1789.   `d'        Find the `(dir)' node -- the root of Info
  1790.   `f'        Find the node of the next cross-reference in this node
  1791.   `g NODE RET'    Go to the node called NODE
  1792.   `h'        Display the Info tutorial, the node `(info)Help'
  1793.   `l'        Backtrack one node
  1794.   `m'        Choose a menu item from this node
  1795.   `n'        Find the `next' node
  1796.   `p'        Go to the `previous' node
  1797.   `u'        Display the parent node of this one
  1798.   `q'        Quit Info
  1799.   `?', `HELP'    Display this command summary
  1800.   `RET',
  1801.   `LMB-CLICK2'    Go to the link (menu item or xref) on this line
  1802.   `TAB'        Put the cursor on the next link in this node
  1803.   `Meta-TAB'    Move to the previous link in this node Entrance to the online-help system. Displays some text describing the options in the help system. Print the full contents of the current keymap (and the keymaps that
  1804. it leads to). Display the documentation of a function, macro or special-form. Print the help text for the current editing mode. Returns the documentation-string for SYMBOL. If IS-VARIABLE is t the
  1805. documentation for the variable stored in SYMBOL is returned, else
  1806. the function doc is provided. Sets the `variable-documentation' property of SYMBOL to DOC-STRING. Add all functions, macros or variables in the BUFFER marked by the magic
  1807. rune `;;;###autoload' to the `autoload.jl' file. Removes all autoload definitions in the buffer BUFFER which are marked by
  1808. the string `;;;###autoload' from the `autoload.jl' file. Position at which the text filling commands break lines. Minor mode for automatically filling lines, i.e. word-wrapping. This makes
  1809. the SPC key checks if the cursor is past the fill-column. If so, the next
  1810. line is started. Sets the column number for filling to (the variable `fill-column') to
  1811. COLUMN or the current column. Regular expression which defines a character in a word. Regular expression which defines anything that is not in a word. Regular expression which matches a paragraph-separating piece of text. Mark which some commands use to track the previous cursor position. Return the position of first character after the end of this word.
  1812. NUMBER is the number of words to move, negative values mean go backwards.
  1813. If MOVE is t then the cursor is moved to the result. Basically `(forward-word -NUMBER POS MOVE)' Kills from the cursor to the end of the word. Kills from the start of the word to the cursor. Returns the position of the start of *this* word. Returns t if POS is inside a word. Marks COUNT words from POS. Move the word at (before) the cursor COUNT words forwards. Returns the position of the start of the next paragraph. If MOVE
  1814. is t then the cursor is set to this position. Returns the start of the previous paragraph. If MOVE is t the cursor is
  1815. set to this position. Set the block-marks to the current paragraph. If a block is marked in the current window, return the text it contains and
  1816. unmark the block. Similar to `copy-block' except the block is cut (copied then deleted) from
  1817. the buffer. Deletes the block marked in the current window (if one exists). If a block is marked in the current window, copy it to position POS, then
  1818. unmark the block. Toggles the state of the flag saying whether blocks in this window are
  1819. marked sequentially (the default) or as rectangles. Kills the block marked in this window. Kills the block marked in this window but doesn't actually delete it from
  1820. the buffer. Mark a block from START to END. This does an extra redraw if there's already
  1821. a block marked to save lots of flicker. Mark a block containing the whole of the buffer. Makes all alpha characters in the specified region of text upper-case. Makes all alpha characters in the specified region of text lower-case. Makes the next COUNT words from the cursor upper-case. The first character of this word (the one under the cursor) is made
  1822. upper-case, the rest lower-case. Makes the word under the cursor lower case. Sets the block-marks to the area between the cursor position and the
  1823. auto-mark Adds STRING to the kill storage. If the last command also kill'ed something
  1824. the string is appended to. Returns the string in the kill-buffer at position DEPTH. Currently only one
  1825. string is stored so DEPTH must be zero or not specified. Kills a region of text in the current buffer from START to END. Copies a region of text in the current buffer (from START to END) to the
  1826. kill storage. If the cursor is not at the end of the line kill the text from the cursor
  1827. to the end of the line, else kill from the end of the line to the start of
  1828. the next line. Kill the whole of the current line. Kill from the cursor to the start of the line. Inserts text before the cursor. If a block is marked in the current buffer
  1829. and DONT-YANK-BLOCK is nil insert the text in the block. Else yank the last
  1830. killed text. Similar to `yank' except that the inserted text is treated as a rectangle. Does a `(yank)' inserting at the current position of the mouse cursor. The
  1831. cursor is left at the end of the inserted text. Transpose the areas defined by the functions FORWARD-ITEM and BACKWARD-
  1832. ITEM (in the style of `forward-word', `backward-word' etc).
  1833. COUNT is the number of items to drag the item at the cursor past.
  1834.  
  1835. What actually happens is that the item before the cursor is dragged forward
  1836. over the COUNT following items. Exits the innermost recursive edit with a value of VALUE (or nil). Abort all recursive-edits. Non-nil when overwrite-mode is enabled. Minor mode to toggle overwrite. Delete COUNT characters preceding the cursor, if the cursor is past the
  1837. end of the line simply move COUNT characters to the left. Delete the character under the cursor. Insert enough spaces before the cursor to move it to the next tab position. Ensure that there are only COUNT spaces around the cursor. Delete all space and tab characters surrounding the cursor. Break the current line creating COUNT new lines, leaving the cursor in
  1838. its original position. Move the character before the cursor COUNT characters forwards. Disassembles the byte code form which is the function value of FUN. If
  1839. STREAM is given all output goes to that stream. Buffer to use for the Lisp debugger. Keymap for debugger's ctrl-c prefix. Debug Mode:
  1840.  
  1841. The major mode controlling the Lisp debugger. Commands available within
  1842. the debugger are,
  1843.  
  1844.   `Ctrl-c Ctrl-s'        Step into this form.
  1845.   `Ctrl-c Ctrl-i'        Ignore this form.
  1846.   `Ctrl-c Ctrl-n'        Continue until the next form.
  1847.   `Ctrl-c Ctrl-r'        Continue execution.
  1848.   `Ctrl-c Ctrl-b'        Print a backtrace of the Lisp call stack.
  1849.   `Ctrl-c Ctrl-x'        Set the value which this form will return. When t all doc-strings are appended to the doc file and replaced with
  1850. their position in that file. List of symbols, when the name of the function called by a top-level form
  1851. is one of these that form is compiled. Compiles the file of jade-lisp code FILE-NAME into a new file called
  1852. `(concat FILE-NAME ?c)' (ie, `foo.jl' => `foo.jlc'). Compiles all jade-lisp files in the directory DIRECTORY-NAME whose object
  1853. files are either older than their source file or don't exist. If FORCE-P
  1854. is non-nil every lisp file is recompiled.
  1855. EXCLUDE-LIST is a list of files which shouldn't be compiled. Recompile all out of date files in the lisp library directory. If FORCE-P
  1856. is non-nil it's as though all files were out of date.
  1857. This makes sure that all doc strings are written to their special file and
  1858. that files which shouldn't be compiled aren't. Compile the Lisp form FORM into a byte code form. String used to match error messages in compilation output. Expansion template for the name of the file in an error matched by
  1859. `compile-error-regexp'. Expansion template for the line number of an error matched by
  1860. `compile-error-regexp'. Expansion template for the error description in an error matched by
  1861. `compile-error-regexp'. List of (ERROR-POS-MARK . ERROR-DESC-LINE) Default command which `(compile)' executes, the value of the last
  1862. command executed by `(compile)'. Buffer-local symbol which contains the command to compile this buffer. If
  1863. nil or unbound use `compile-default-cmd'. The filename of the shell to use to run the compilation in. <UNIX-ONLY>
  1864. Executes SHELL-COMMAND asynchronously in the directory containing the file
  1865. being edited in the current buffer. Output from the process is sent to the
  1866. `*compilation*' buffer. TYPE-STR is a string describing the type of messages
  1867. the command may output (i.e. `errors' for a compilation). <UNIX-ONLY>
  1868. Runs the SHELL-COMMAND in the `*compilation*' buffer. If SHELL-COMMAND isn't
  1869. given you will be prompted for a command. Moves the cursor to the file and line of the next error displayed in the
  1870. `*compilation*' buffer. <UNIX-ONLY>
  1871. Runs the `grep' program with ARGS-STRING (or the result of a prompt) and
  1872. sends its output to the `*compilation*' buffer. The `grep' process may still
  1873. be executing when this function returns. Regular-expression which `grep-buffer' scans for Scans the current buffer for all matches of REGEXP (or the contents of
  1874. variable `grep-buffer-regexp'). All hits are displayed in the `*compilation*'
  1875. buffer in a form that `goto-next-error' understands. Size of indentation for c-mode C Mode:
  1876.  
  1877. Simple mode for editing C source code. Its main feature is to be able to
  1878. indent lines to their (probably) correct depth.
  1879.  
  1880. Special commands are,
  1881.  
  1882.   `{', `}', `:'            Insert the character then indent the line
  1883.   `TAB'                Indent the current line
  1884.   `Ctrl-c Ctrl-\'        Aligns backslash characters at the end
  1885.                 of each line in the current block.
  1886.   `ESC Ctrl-b'            Move backwards one expression.
  1887.   `ESC Ctrl-f'            Move forward one expression. Indent the line at POS (or the cursor) assuming that it's C source code. *Attempts* to guess the correct indentation for this line. Returns the
  1888. position for the first non-space in the line. Returns the position for the first non-space in the line. Bases its guess
  1889. upon the assumption that the line is empty.
  1890. All positions depend on the indentation of the previous line(s). Insert (or align) backslash characters at the end of each line in between
  1891. START and END except for the last line. When t files are auto-save'd regularly. The number of seconds between each auto-save. When non-nil backups of files are made when they are saved. When non-nil all file backups are made by copying the file, not by
  1892. renaming it. Non-nil means make file backups by copying the file if it's not a good
  1893. idea to rename it. If `backup-by-copying' is non-nil this variable has no
  1894. effect. The `*jade*' buffer. Stream that `prin?' writes its output to by default Stream that `read' takes it's input from by default Holds the modification time of the file this buffer was loaded from When a buffer's `special' attribute is set kill-buffer will only kill
  1895. it totally if this variable is non-nil. Tells how to process local variable lists. t means process them
  1896. silently, nil means ignore them, anything else means to query each
  1897. variable being set. Tells how to process the `eval' local variable. Same options as
  1898. with `enable-local-variables'. This variable defines how many of the bottom-most lines in a file are
  1899. searched for a `Local Variables:' section. Switch the current buffer to BUFFER which can either be a buffer-object
  1900. or a string naming an existing buffer. The selected buffer is moved to
  1901. the head of the buffer list. If BUFFER is a string and it doesn't name
  1902. an existing buffer a new one will be created with that name. If no buffer containing file NAME exits try to create one.
  1903. After creating a new buffer (named after the file's (not path) name)
  1904. it first call the hook `read-file-hook' with arguments `(buffer-file-name
  1905. buffer)'.
  1906. If this hook returns nil (ie, no members of the hook decided to read the
  1907. file into memory) the file is read into the buffer verbatim.
  1908.  
  1909. Once the file is in memory, through the hook or otherwise, this function
  1910. then tries to initialise the correct editing mode for the file.
  1911.  
  1912. `open-file' always returns the buffer holding the file, or nil if it
  1913. doesn't exist. Sets the current buffer to that containing the file NAME, if NAME
  1914. is unspecified it will be prompted for. If the file is not already in memory
  1915. `open-file' will be used to load it. Similar to `find-file' except that the buffer is edited in read-only mode. If NAME is unspecified one will be prompted for. The current buffer is
  1916. killed and one editing NAME is found. If necessary make a backup of FILE-NAME. The file called FILE-NAME may or
  1917. may not exist after this function returns. Writes the contents of BUFFER to the file NAME, or to the one
  1918. that it is associated with. Saves the buffer BUFFER, or the current buffer, to the file that it is
  1919. associated with, then sets the number of modifications made to this file
  1920. to zero.
  1921. Note: if no changes have been made to this buffer, it won't be saved. Saves the buffer BUFFER, or the current one, to the file NAME,
  1922. resetting the name of the buffer and the file that it is associated with
  1923. to reflect NAME. Also sets the modification count to zero. Inserts the file NAME into the buffer BUFFER (or the current one) before
  1924. the cursor position. If no buffer called NAME exists, creates one and adds it to the main
  1925. buffer-list. Always returns the buffer. Destroys BUFFER (can be an actual buffer or name of a buffer), first
  1926. checks whether or not we're allowed to with the function `check-changes'.
  1927.   If it can be deleted, all windows displaying this buffer are switched
  1928. to the buffer at the head of the buffer-list, and BUFFER is removed
  1929. from the buffer-list (if it was in it). Puts BUFFER (or the currently displayed buffer) at the end of the current
  1930. window's buffer-list then switch to the buffer at the head of the list.
  1931. If ALL-WINDOWS is non-nil this is done in all windows (the same buffer
  1932. will be buried in each window though). Prompt the user for the name of a buffer, then display it. Moves the buffer at the head of the buffer-list to be last in the list, the
  1933. new head of the buffer-list is displayed in the current window. Returns t if it is ok to kill BUFFER, or the current buffer. If unsaved
  1934. changes have been made to it the user is asked whether (s)he minds losing
  1935. them. Switches (if necessary) to the buffer containing MARK at the position
  1936. of the mark. If the file containing MARK is not in memory then we
  1937. attempt to load it with `open-file'. Sets the mark `auto-mark' to the current position (buffer & cursor-pos). Sets the `auto-mark' to the current position and then sets the current
  1938. position (buffer and cursor-pos) to the old value of `auto-mark'. Inserts a newline at the cursor position and then indents the new line
  1939. created to the indentation of the one above it. Returns a string naming the file used to hold the auto-save'd file for
  1940. file NAME. Automatically called when BUFFER is due to be automatically saved.
  1941. This function calls the hook `auto-save-hook', if this returns nil it then
  1942. saves it to the file specified by `make-auto-save-name' appiled to the
  1943. name of the file stored in BUFFER. Deletes the file used to store the auto-save'd copy of the file stored in
  1944. BUFFER, if such a file exists. Returns t if there exists an automatically saved copy of file NAME which
  1945. is newer than NAME. Loads the auto-saved copy of the file stored in BUFFER into BUFFER
  1946. overwriting its current contents (if any changes are to be lost the user
  1947. will have to agree to this). Restores the contents of BUFFER (or current buffer) to the contents of the
  1948. file it was loaded from. Goto line number LINE. LINE counts from 1. Returns t of FILE1 was modified more recently than FILE2. Asks whether or not to save any modified buffers, returns t if no modified
  1949. buffers are left. Calls `save-some-buffers' and quits (after asking whether it's ok to lose
  1950. any unsaved buffers). When this mode is enabled files are autosaved regularly if
  1951. they've been modified. When non-nil lines are indented after being split in asm-mode. Strings which denotes the start of a comment in asm-mode. Asm Mode:
  1952.  
  1953. Major mode for editing generic assembler source. Special commands are,
  1954.  
  1955.   `RET'        break line and indent (unless asm-indent is nil)
  1956.   `:'        undent line, then insert a tab
  1957.   `.'        if line is not empty, delete its indentation, then insert
  1958.         a dot. Asm-CPP Mode:
  1959.  
  1960. Major mode for editing assembler source which is passed through cpp before
  1961. being assembled. Currently this only differs from asm-mode in the comments
  1962. it inserts. Prompts the user for a yes or no answer to QUESTION, returns t for yes. Prompts the user for a single keypress response, either `y' or `n' to the
  1963. string QUESTION, returns t for `y'. Email address for use in change logs User's proper name, for change logs File name of change logs