home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / prgramer / unix / info / elisp.i21 (.txt) < prev    next >
GNU Info File  |  1993-06-14  |  52KB  |  922 lines

  1. This is Info file elisp, produced by Makeinfo-1.47 from the input file
  2. elisp.texi.
  3.    This file documents GNU Emacs Lisp.
  4.    This is edition 1.03 of the GNU Emacs Lisp Reference Manual, for
  5. Emacs Version 18.
  6.    Published by the Free Software Foundation, 675 Massachusetts Avenue,
  7. Cambridge, MA 02139 USA
  8.    Copyright (C) 1990 Free Software Foundation, Inc.
  9.    Permission is granted to make and distribute verbatim copies of this
  10. manual provided the copyright notice and this permission notice are
  11. preserved on all copies.
  12.    Permission is granted to copy and distribute modified versions of
  13. this manual under the conditions for verbatim copying, provided that
  14. the entire resulting derived work is distributed under the terms of a
  15. permission notice identical to this one.
  16.    Permission is granted to copy and distribute translations of this
  17. manual into another language, under the above conditions for modified
  18. versions, except that this permission notice may be stated in a
  19. translation approved by the Foundation.
  20. File: elisp,  Node: Input to Processes,  Next: Signals to Processes,  Prev: Process Information,  Up: Processes
  21. Sending Input to Processes
  22. ==========================
  23.    Asynchronous subprocesses receive input when it is sent to them by
  24. Emacs, which is done with the functions in this section.  You must
  25. specify the process to send input to, and the input data to send.  The
  26. data appears on the "standard input" of the subprocess.
  27.    Some operating systems have limited space for buffered input in a
  28. PTY.  On these systems, the subprocess will cease to read input
  29. correctly if you send an input line longer than the system can handle.
  30. You cannot avoid the problem by breaking the input into pieces and
  31. sending them separately, for the operating system will still have to put
  32. all the pieces together in the input buffer before it lets the
  33. subprocess read the line.  The only solution is to put the input in a
  34. temporary file, and send the process a brief command to read that file.
  35.  -- Function: process-send-string PROCESS-NAME STRING
  36.      This function sends PROCESS-NAME the contents of STRING as
  37.      standard input.  The argument PROCESS-NAME must be a process or
  38.      the name of a process.
  39.      The function returns `nil'.
  40.           (process-send-string "shell<1>" "ls\n")
  41.                => nil
  42.           
  43.           ---------- Buffer: *shell* ----------
  44.           ...
  45.           introduction.texi               syntax-tables.texi~
  46.           introduction.texi~              text.texi
  47.           introduction.txt                text.texi~
  48.           ...
  49.           ---------- Buffer: *shell* ----------
  50.  -- Command: process-send-region PROCESS-NAME START END
  51.      This function sends the text in the region defined by START and
  52.      END as standard input to PROCESS-NAME, which is a process or a
  53.      process name.
  54.      An error is signaled unless both START and END are integers or
  55.      markers that indicate positions in the current buffer.  (It is
  56.      unimportant which number is larger.)
  57.  -- Function: process-send-eof &optional PROCESS-NAME
  58.      This function makes PROCESS-NAME see an end-of-file in its input. 
  59.      The EOF comes after any text already sent to it.
  60.      If PROCESS-NAME is not supplied, or if it is `nil', then this
  61.      function sends the EOF to the current buffer's process.  An error
  62.      is signaled if the current buffer has no process.
  63.      The function returns PROCESS-NAME.
  64.           (process-send-eof "shell")
  65.                => "shell"
  66. File: elisp,  Node: Signals to Processes,  Next: Output from Processes,  Prev: Input to Processes,  Up: Processes
  67. Sending Signals to Processes
  68. ============================
  69.    "Sending a signal" to a subprocess is a way of interrupting its
  70. activities.  There are several different signals, each with its own
  71. meaning.  For example, the signal `SIGINT' means that the user has
  72. typed `C-c', or that some analogous thing has happened.
  73.    Each signal has a standard effect on the subprocess.  Most signals
  74. kill the subprocess, but some stop or resume execution instead.  Most
  75. signals can optionally be handled by programs; if the program handles
  76. the signal, then we can say nothing in general about its effects.
  77.    The set of signals and their names is defined by the operating
  78. system; Emacs has facilities for sending only a few of the signals that
  79. are defined.  Emacs can send signals only to its own subprocesses.
  80.    You can send signals explicitly by calling the function in this
  81. section.  Emacs also sends signals automatically at certain times:
  82. killing a buffer sends a `SIGHUP' signal to all its associated
  83. processes; killing Emacs sends a `SIGHUP' signal to all remaining
  84. processes.  (`SIGHUP' is a signal that usually indicates that the user
  85. hung up the phone.)
  86.    Each of the signal-sending functions takes two optional arguments:
  87. PROCESS-NAME and CURRENT-GROUP.
  88.    The argument PROCESS-NAME must be either a process, the name of one,
  89. or `nil'.  If it is `nil', the process defaults to the process
  90. associated with the current buffer.  An error is signaled if
  91. PROCESS-NAME does not identify a process.
  92.    The argument CURRENT-GROUP is a flag that makes a difference when
  93. you are running a job-control shell as an Emacs subprocess.  If it is
  94. non-`nil', then the signal is sent to the current process-group of the
  95. terminal which Emacs uses to communicate with the subprocess.  If the
  96. process is a job-control shell, this means the shell's current subjob. 
  97. If it is `nil', the signal is sent to the process group of the
  98. immediate subprocess of Emacs.  If the subprocess is a job-control
  99. shell, this is the shell itself.
  100.    The flag CURRENT-GROUP has no effect when a pipe is used to
  101. communicate with the subprocess, because the operating system does not
  102. support the distinction in the case of pipes.  For the same reason,
  103. job-control shells won't work when a pipe is used.  See
  104. `process-connection-type' in *Note Asynchronous Processes::.
  105.  -- Function: interrupt-process &optional PROCESS-NAME CURRENT-GROUP
  106.      This function interrupts the process PROCESS-NAME by sending the
  107.      Unix signal `SIGINT'.  Outside of Emacs, typing the "interrupt
  108.      character" (usually `C-c' on Berkeley Unix) sends this signal.
  109.      When the argument CURRENT-GROUP is non-`nil', you can think of
  110.      this function as "typing `C-c'" on the terminal by which Emacs
  111.      talks to the subprocess.
  112.  -- Function: kill-process &optional PROCESS-NAME CURRENT-GROUP
  113.      This function kills the process PROCESS-NAME by sending the Unix
  114.      signal `SIGKILL'.  This signal kills the subprocess immediately,
  115.      and cannot be handled by the subprocess.
  116.  -- Function: quit-process &optional PROCESS-NAME CURRENT-GROUP
  117.      This function sends the Unix signal `SIGQUIT' to the process
  118.      PROCESS-NAME.  This signal is the one sent by the "quit character"
  119.      (usually `C-b' or `C-\') when you are not inside Emacs.
  120.  -- Function: stop-process &optional PROCESS-NAME CURRENT-GROUP
  121.      This function stops the process PROCESS-NAME by sending the Unix
  122.      signal `SIGTSTP'.  Use `continue-process' to resume its execution.
  123.      On systems with job control, the "stop character" (usually `C-z')
  124.      sends this signal (outside of Emacs).  When CURRENT-GROUP is
  125.      non-`nil', you can think of this function as "typing `C-z'" on the
  126.      terminal Emacs uses to communicate with the subprocess.
  127.  -- Function: continue-process &optional PROCESS-NAME CURRENT-GROUP
  128.      This function resumes execution of the process PROCESS by sending
  129.      it the Unix signal `SIGCONT'.  This presumes that PROCESS-NAME was
  130.      stopped previously.
  131. File: elisp,  Node: Output from Processes,  Next: Sentinels,  Prev: Signals to Processes,  Up: Processes
  132. Receiving Output from Processes
  133. ===============================
  134.    There are two ways to receive the output that a subprocess writes to
  135. its standard output stream.  The output can be inserted in a buffer,
  136. which is called the associated buffer of the process, or a function
  137. called the "filter function" can be called to act on the output.
  138. * Menu:
  139. * Process Buffers::       If no filter, output is put in a buffer.
  140. * Filter Functions::      Filter functions accept output from the process.
  141. * Accepting Output::      Explicitly permitting subprocess output.
  142.                             Waiting for subprocess output.
  143. File: elisp,  Node: Process Buffers,  Next: Filter Functions,  Prev: Output from Processes,  Up: Output from Processes
  144. Process Buffers
  145. ---------------
  146.    A process can (and usually does) have an "associated buffer", which
  147. is an ordinary Emacs buffer that is used for two purposes: storing the
  148. output from the process, and deciding when to kill the process.  You
  149. can also use the buffer to identify a process to operate on, since in
  150. normal practice only one process is associated with any given buffer.
  151. Many applications of processes also use the buffer for editing input to
  152. be sent to the process, but this is not built into Emacs Lisp.
  153.    Unless the process has a filter function (*note Filter Functions::.),
  154. its output is inserted in the associated buffer.  The position to insert
  155. the output is determined by the `process-mark' (*note Process
  156. Information::.), which is then updated to point to the end of the text
  157. just inserted.  Usually, but not always, the `process-mark' is at the
  158. end of the buffer.  If the process has no buffer and no filter
  159. function, its output is discarded.
  160.  -- Function: process-buffer PROCESS
  161.      This function returns the associated buffer of the process PROCESS.
  162.           (process-buffer (get-process "shell"))
  163.                => #<buffer *shell*>
  164.  -- Function: process-mark PROCESS
  165.      This function returns the marker which controls where additional
  166.      output from the process will be inserted in the process buffer
  167.      (*note Process Buffers::.).  When output is inserted, the marker
  168.      is updated to point at the end of the output.  This causes
  169.      successive batches of output to be inserted consecutively.
  170.      If PROCESS does not insert its output into a buffer, then
  171.      `process-mark' returns a marker that points nowhere.
  172.      Filter functions normally should use this marker in the same
  173.      fashion as is done by direct insertion of output in the buffer.  A
  174.      good example of a filter function that uses `process-mark' is
  175.      found at the end of the following section.
  176.      When the user is expected to enter input in the process buffer for
  177.      transmission to the process, the process marker is useful for
  178.      distinguishing the new input from previous output.
  179.  -- Function: set-process-buffer PROCESS BUFFER
  180.      This function sets the buffer associated with PROCESS to BUFFER. 
  181.      If BUFFER is `nil', the process will not be associated with any
  182.      buffer.
  183.  -- Function: get-buffer-process BUFFER-OR-NAME
  184.      This function returns the process associated with BUFFER-OR-NAME.
  185.      If there are several processes associated with it, then one is
  186.      chosen. (Presently, the one chosen is the one most recently
  187.      created.)  It is usually a bad idea to have more than one process
  188.      associated with the same buffer.
  189.           (get-buffer-process "*shell*")
  190.                => #<process shell>
  191.      If the process's buffer is killed, the actual child process is
  192.      killed with a `SIGHUP' signal (*note Signals to Processes::.).
  193. File: elisp,  Node: Filter Functions,  Next: Accepting Output,  Prev: Process Buffers,  Up: Output from Processes
  194. Process Filter Functions
  195. ------------------------
  196.    A process "filter function" is a function that receives the standard
  197. output from the associated process.  If a process has a filter, then
  198. *all* standard output from that process is passed to the filter rather
  199. than be inserted into a buffer or discarded.  The process buffer is
  200. used for output from the process only when there is no filter.
  201.    A filter function must accept two arguments: the associated process
  202. and a string, which is the output.  The function is then free to do
  203. whatever it chooses with the output.
  204.    A filter function runs only while Emacs is waiting (e.g., for
  205. terminal input, or for time to elapse, or for process output).  This
  206. avoids the timing errors that could result from running filters at
  207. random places in the middle of other Lisp programs.  You may explicitly
  208. cause Emacs to wait, so that filter functions will run, by calling
  209. `sit-for', `sleep-for' or `accept-process-output' (*note Accepting
  210. Output::.).  Emacs is also waiting when the command loop is reading
  211. input.
  212.    Quitting is normally inhibited within a filter function--otherwise,
  213. the effect of typing `C-g' at command level or to quit a user command
  214. would be unpredictable.  If you want to permit quitting inside a filter
  215. function, bind `inhibit-quit' to `nil'. *Note Quitting::.
  216.    Many filter functions sometimes or always insert the text in the
  217. process's buffer, mimicking the actions of Emacs when there is no
  218. filter.  Such filter functions need to use `set-buffer' in order to be
  219. sure to insert in that buffer.  To avoid setting the current buffer
  220. semipermanently, these filter functions must use `unwind-protect' to
  221. make sure to restore the previous current buffer.  They should also
  222. update the process marker, and in some cases update the value of point.
  223. Here is how to do these things:
  224.      (defun ordinary-insertion-filter (proc string)
  225.        (let ((old-buffer (current-buffer)))
  226.          (unwind-protect
  227.          (let (moving)
  228.            (set-buffer (process-buffer proc))
  229.            (setq moving (= (point) (process-mark proc)))
  230.            (save-excursion
  231.              ;; Insert the text, moving the process-marker.
  232.              (goto-char (process-mark proc))
  233.              (insert string)
  234.              (set-marker (process-mark proc) (point)))
  235.            (if moving (goto-char (process-mark proc))))
  236.            (set-buffer old-buffer))))
  237. The reason to use an explicit `unwind-protect' rather than letting
  238. `save-excursion' restore the current buffer is so as to preserve the
  239. change in point made by `goto-char'.
  240.    To make the filter force the process buffer to be visible whenever
  241. new text arrives, insert the following line just before the
  242. `unwind-protect':
  243.      (display-buffer (process-buffer proc))
  244.    To force point to move to the end of the new output no matter where
  245. it was previously, eliminate the variable `moving' and call `goto-char'
  246. unconditionally.
  247.    All filter functions that do regexp searching or matching should save
  248. and restore the match data.  Otherwise, a filter function that runs
  249. during a call to `sit-for' might clobber the match data of the program
  250. that called `sit-for'.  *Note Match Data::.
  251.    The output to the function may come in chunks of any size.  A program
  252. that produces the same output twice in a row may send it as one batch
  253. of 200 characters one time, and five batches of 40 characters the next.
  254.  -- Function: set-process-filter PROCESS FILTER
  255.      This function gives PROCESS the filter function FILTER.  If FILTER
  256.      is `nil', then the process will have no filter.
  257.  -- Function: process-filter PROCESS
  258.      This function returns the filter function of PROCESS, or `nil' if
  259.      it has none.
  260.    Here is an example of use of a filter function:
  261.      (defun keep-output (process output)
  262.         (setq kept (cons output kept)))
  263.           => keep-output
  264.      (setq kept nil)
  265.           => nil
  266.      (set-process-filter (get-process "shell") 'keep-output)
  267.           => keep-output
  268.      (process-send-string "shell" "ls ~/other\n")
  269.           => nil
  270.      kept
  271.           => ("lewis@slug[8] % "
  272.      "FINAL-W87-SHORT.MSS    backup.otl              kolstad.mss~
  273.      address.txt             backup.psf              kolstad.psf
  274.      backup.bib~             david.mss               resume-Dec-86.mss~
  275.      backup.err              david.psf               resume-Dec.psf
  276.      backup.mss              dland                   syllabus.mss
  277.      "
  278.      "#backups.mss#          backup.mss~             kolstad.mss
  279.      ")
  280.    Here is another, more realistic example, which demonstrates how to
  281. use the process mark to do insertion in the same fashion as is done when
  282. there is no filter function:
  283.      ;; Insert input in the buffer specified by `my-shell-buffer'
  284.      ;; and make sure that buffer is shown in some window.
  285.      (defun my-process-filter (proc str)
  286.          (let ((cur (selected-window))
  287.                (pop-up-windows t))
  288.            (pop-to-buffer my-shell-buffer)
  289.            (goto-char (point-max))
  290.            (insert str)
  291.            (set-marker (process-mark proc) (point-max))
  292.            (select-window cur)))
  293. File: elisp,  Node: Accepting Output,  Prev: Filter Functions,  Up: Output from Processes
  294. Accepting Output from Processes
  295. -------------------------------
  296.    Output from asynchronous subprocesses normally arrives only while
  297. Emacs is waiting for some sort of external event, such as elapsed time
  298. or terminal input.  Occasionally it is useful in a Lisp program to
  299. explicitly permit output to arrive at a specific point, or even to wait
  300. until output arrives from a process.
  301.  -- Function: accept-process-output &optional PROCESS
  302.      This function allows Emacs to read pending output from processes. 
  303.      The output is inserted in the associated buffers or given to their
  304.      filter functions.  If PROCESS is non-`nil' then this function does
  305.      not return until some output has been received from PROCESS.
  306. File: elisp,  Node: Sentinels,  Next: VMS Subprocesses,  Prev: Output from Processes,  Up: Processes
  307. Sentinels: Detecting Process Status Changes
  308. -------------------------------------------
  309.    A "process sentinel" is a function that is called whenever the
  310. associated process changes status for any reason, including signals
  311. (whether sent by Emacs or caused by the process's own actions) that
  312. terminate, stop, or continue the process.  The process sentinel is also
  313. called if the process exits.  The sentinel receives two arguments: the
  314. process for which the event occurred, and a string describing the type
  315. of event.
  316.    The string describing the event looks like one of the following:
  317.    * `"finished\n"'.
  318.    * `"exited abnormally with code EXITCODE\n"'.
  319.    * `"NAME-OF-SIGNAL\n"'.
  320.    * `"NAME-OF-SIGNAL (core dumped)\n"'.
  321.    A sentinel runs only while Emacs is waiting (e.g., for terminal
  322. input, or for time to elapse, or for process output).  This avoids the
  323. timing errors that could result from running them at random places in
  324. the middle of other Lisp programs.  You may explicitly cause Emacs to
  325. wait, so that sentinels will run, by calling `sit-for', `sleep-for' or
  326. `accept-process-output' (*note Accepting Output::.).  Emacs is also
  327. waiting when the command loop is reading input.
  328.    Quitting is normally inhibited within a sentinel--otherwise, the
  329. effect of typing `C-g' at command level or to quit a user command would
  330. be unpredictable.  If you want to permit quitting inside a sentinel,
  331. bind `inhibit-quit' to `nil'.  *Note Quitting::.
  332.    All sentinels that do regexp searching or matching should save and
  333. restore the match data.  Otherwise, a sentinel that runs during a call
  334. to `sit-for' might clobber the match data of the program that called
  335. `sit-for'.  *Note Match Data::.
  336.  -- Function: set-process-sentinel PROCESS SENTINEL
  337.      This function associates SENTINEL with PROCESS.  If SENTINEL is
  338.      `nil', then the process will have no sentinel. The default
  339.      behavior when there is no sentinel is to insert a message in the
  340.      process's buffer when the process status changes.
  341.           (defun msg-me (process event)
  342.              (princ
  343.                (format "Process: %s had the event `%s'" process event)))
  344.           (set-process-sentinel (get-process "shell") 'msg-me)
  345.                => msg-me
  346.           (kill-process (get-process "shell"))
  347.                -| Process: #<process shell> had the event `killed'
  348.                => #<process shell>
  349.  -- Function: process-sentinel PROCESS
  350.      This function returns the sentinel of PROCESS, or `nil' if it has
  351.      none.
  352.  -- Function: waiting-for-user-input-p
  353.      While a sentinel or filter function is running, this function
  354.      returns non-`nil' if Emacs was waiting for keyboard input from the
  355.      user at the time the sentinel or filter function was called, `nil'
  356.      if it was not.
  357. File: elisp,  Node: VMS Subprocesses,  Next: TCP,  Prev: Sentinels,  Up: Processes
  358. Subprocess Functions for VMS
  359. ============================
  360.    The ordinary subprocess functions do not work on VMS in version 18.
  361. Instead, these functions are available.
  362.  -- Function: default-subprocess-input-handler
  363.      This function is the default input handler for input from spawned
  364.      subprocesses.
  365.  -- Function: spawn-subprocess INTEGER &optional FILTER SENTINEL
  366.      This function spawns an asynchronous VMS subprocess for command
  367.      processing.  The arguments are INTEGER, an integer to identify the
  368.      subprocess in future operations; FILTER, a function to be called
  369.      when output arrives from the subprocess; and SENTINEL, a function
  370.      to be called when the subprocess terminates.
  371.      If FILTER is `nil', output is inserted in the current buffer.  If
  372.      SENTINEL is `nil', nothing special is done when the subprocess
  373.      terminates.
  374.      When the filter is called, it receives two arguments; INTEGER to
  375.      identify the process, and a string containing the output.
  376.      When the sentinel is called, it receives just one argument,
  377.      INTEGER.
  378.  -- Function: send-command-to-subprocess INTEGER COMMAND
  379.      This function sends the string COMMAND to a VMS subprocess
  380.      numbered INTEGER.
  381.  -- Function: stop-subprocess INTEGER
  382.      This function terminates the VMS subprocess numbered INTEGER.
  383.    In version 19, these functions have been eliminated, and the ordinary
  384. subprocess functions are implemented on VMS.
  385. File: elisp,  Node: TCP,  Prev: VMS Subprocesses,  Up: Processes
  386.    Emacs Lisp programs can open TCP connections to other processes on
  387. the same machine or other machines.  A network connection is handled by
  388. Lisp much like a subprocess, and is represented by a process object.
  389. However, the process you are communicating with is not a child of the
  390. Emacs process, so you can't kill it or send it signals.  All you can do
  391. is send and receive data.  `delete-process' closes the connection, but
  392. does not kill the process at the other end of it.
  393.    You can distinguish process objects representing network connections
  394. from those representing subprocesses with the `process-status' function.
  395.  -- Function: open-network-stream NAME BUFFER-OR-NAME HOST SERVICE
  396.      This function opens a TCP connection for a service to a host.  It
  397.      returns a process object to represent the connection.
  398.      The NAME argument specifies the name for the process object.  It
  399.      is modified as necessary to make it unique.
  400.      The BUFFER-OR-NAME argument is the buffer to associate with the
  401.      connection.  Output from the connection is inserted in the buffer,
  402.      unless you specify a filter function to handle the output.  If
  403.      BUFFER-OR-NAME is `nil', it means that the connection is not
  404.      associated with any buffer.
  405.      The arguments HOST and SERVICE specify where to connect to; HOST
  406.      is the host name (a string), and SERVICE is the name of the
  407.      service desired (a string) or an integer specifying a port number
  408.      to connect to.
  409. File: elisp,  Node: System Interface,  Next: Emacs Display,  Prev: Processes,  Up: Top
  410. Operating System Interface
  411. **************************
  412.    This chapter is about starting and getting out of Emacs, access to
  413. values in the operating system environment, and terminal input, output
  414. and flow control.
  415.    *Note Building Emacs::, for related information.  See also *Note
  416. Emacs Display::, for additional operating system status information
  417. which pertain to the terminal and the screen.
  418. * Menu:
  419. * Starting Up::         Customizing Emacs start-up processing.
  420. * Getting Out::         How exiting works (permanent or temporary).
  421. * System Environment::  Distinguish the name and kind of system.
  422. * Terminal Input::      Recording terminal input for debugging.
  423. * Terminal Output::     Recording terminal output for debugging.
  424. * Flow Control::        How to turn output flow control on or off.
  425. * Batch Mode::          Running Emacs without terminal interaction.
  426. File: elisp,  Node: Starting Up,  Next: Getting Out,  Prev: System Interface,  Up: System Interface
  427. Starting Up Emacs
  428. =================
  429.    This section describes what Emacs does when it is started, and how
  430. you can customize these actions.
  431. * Menu:
  432. * Start-up Summary::        Sequence of actions Emacs performs at start-up.
  433. * Init File::               Details on reading the init file (`.emacs').
  434. * Terminal-Specific::       How the terminal-specific Lisp file is read.
  435. * Command Line Arguments::  How command line arguments are processed,
  436.                               and how you can customize them.
  437. File: elisp,  Node: Start-up Summary,  Next: Init File,  Prev: Starting Up,  Up: Starting Up
  438. Summary: Sequence of Actions at Start Up
  439. ----------------------------------------
  440.    The order of operations performed (in `startup.el') by Emacs when it
  441. is started up is as follows:
  442.   1. It loads `.emacs' unless `-q' was specified on command line. (This
  443.      is not done in `-batch' mode.)  `.emacs' is found in the user's
  444.      home directory; the `-u' option can specify the user name whose
  445.      home directory should be used.
  446.   2. It loads `default.el' unless `inhibit-default-init' is non-`nil'. 
  447.      (This is not done in `-batch' mode or if `-q' was specified on
  448.      command line.)
  449.   3. It loads the terminal-specific Lisp file, if any, except when in
  450.      batch mode.
  451.   4. It runs `term-setup-hook'.
  452.   5. It runs `window-setup-hook'.
  453.   6. It displays copyleft and nonwarranty, plus basic use information,
  454.      unless the value of `inhibit-startup-message' is non-`nil'.
  455.      This display is also inhibited in batch mode, and if the current
  456.      buffer is not `*scratch*'.
  457.   7. It processes any remaining command line arguments.
  458.  -- User Option: inhibit-startup-message
  459.      This variable inhibits the initial startup messages (the
  460.      nonwarranty, etc.).  If it is non-`nil', then the messages are not
  461.      printed.
  462.      This variable exists so you can set it in your personal init file,
  463.      once you are familiar with the contents of the startup message. 
  464.      Do not set this variable in the init file of a new user, or in a
  465.      way that affects more than one user, because that would prevent
  466.      new users from receiving the information they are supposed to see.
  467. File: elisp,  Node: Init File,  Next: Terminal-Specific,  Prev: Start-Up Summary,  Up: Starting Up
  468. The Init File: `.emacs'
  469. -----------------------
  470.    When you start Emacs, it normally attempts to load the file `.emacs'
  471. from your home directory.  This file, if it exists, must contain Lisp
  472. code.  It is called your "init file".  The command line switches `-q'
  473. and `-u' can be used to control the use of the init file; `-q' says not
  474. to load an init file, and `-u' says to load a specified user's init
  475. file instead of yours.  *Note Entering Emacs: (emacs)Entering Emacs.
  476.    Emacs may also have a "default init file", which is the library
  477. named `default.el'.  Emacs finds the `default.el' file through the
  478. standard search path for libraries (*note How Programs Do Loading::.). 
  479. The Emacs distribution does not have any such file; you may create one
  480. at your site for local customizations.  If the default init file
  481. exists, it is loaded whenever you start Emacs, except in batch mode or
  482. if `-q' is specified.  But your own personal init file, if any, is
  483. loaded first; if it sets `inhibit-default-init' to a non-`nil' value,
  484. then Emacs will not load the `default.el' file.
  485.    If there is a great deal of code in your `.emacs' file, you should
  486. move it into another file named `SOMETHING.el', byte-compile it (*note
  487. Byte Compilation::.), and make your `.emacs' file load the other file
  488. using `load' (*note Loading::.).
  489.    *Note Init File Examples: (emacs)Init File Examples, for examples of
  490. how to make various commonly desired customizations in your `.emacs'
  491. file.
  492.  -- User Option: inhibit-default-init
  493.      This variable prevents Emacs from loading the default
  494.      initialization library file for your session of Emacs.  If its
  495.      value is non-`nil', then the default library is not loaded.  The
  496.      default value is `nil'.
  497. File: elisp,  Node: Terminal-Specific,  Next: Command Line Arguments,  Prev: Init File,  Up: Starting Up
  498. Terminal-Specific Initialization
  499. --------------------------------
  500.    Each terminal type can have its own Lisp library that Emacs will load
  501. when run on that type of terminal.  For a terminal type named TERMTYPE,
  502. the library is called `term/TERMTYPE'.  Emacs finds the file by
  503. searching the `load-path' directories as it does for other files, and
  504. trying the `.elc' and `.el' suffixes. Normally, terminal-specific Lisp
  505. library is located in `emacs/lisp/term', a subdirectory of the
  506. `emacs/lisp' directory in which most Emacs Lisp libraries are kept.
  507.    The library's name is constructed by concatenating the value of the
  508. variable `term-file-prefix' and the terminal type.  Normally,
  509. `term-file-prefix' has the value `"term/"'; changing this is not
  510. recommended.
  511.    The usual purpose of a terminal-specific library is to define the
  512. escape sequences used by a terminal's function keys.  See the file
  513. `term/vt100.el' for an example of a terminal-specific library.
  514.    Function keys are handled by a two-level procedure.  The first level
  515. is dependent on the specific type of terminal and maps Emacs's input
  516. sequences to the function keys that they represent.  The second level is
  517. independent of terminal type and is customized by users; function keys
  518. are mapped into meanings at this level.  The terminal-specific library
  519. handles the first level of the process and the library `keypad.el'
  520. handles the second level of mapping.
  521.    When the name of the terminal type contains a hyphen, only the part
  522. of the name before the first hyphen is significant in choosing the
  523. library name.  Thus, terminal types `aaa-48' and `aaa-30-rv' both use
  524. the `term/aaa' library.  If necessary, the library can evaluate
  525. `(getenv "TERM")' to find the full name of the terminal type.
  526.    Your `.emacs' file can prevent the loading of the terminal-specific
  527. library by setting `term-file-prefix' to `nil'.  This feature is very
  528. useful when experimenting with your own peculiar customizations.
  529.    You can also arrange to override some of the actions of the
  530. terminal-specific library by setting the variable `term-setup-hook'. 
  531. If it is not `nil', Emacs calls the value of the variable
  532. `term-setup-hook' as a function of no arguments at the end of Emacs
  533. initialization, after Emacs has already loaded both your `.emacs' file
  534. and any terminal-specific libraries.  You can use this variable to
  535. define initializations for terminals that do not have their own
  536. libraries.
  537.  -- Variable: term-file-prefix
  538.      If the `term-file-prefix' variable is non-`nil', Emacs loads a
  539.      terminal-specific initialization file as follows:
  540.           (load (concat term-file-prefix (getenv "TERM")))
  541.      You may set the `term-file-prefix' variable to `nil' in your
  542.      `.emacs' file if you do not wish to load the
  543.      terminal-initialization file.  To do this, put the following in
  544.      your `.emacs' file: `(setq term-file-prefix nil)'.
  545.  -- Variable: term-setup-hook
  546.      The value of this variable is either `nil' or a function to be
  547.      called by Emacs after loading your `.emacs' file, the default
  548.      initialization file (if any) and after loading terminal-specific
  549.      Lisp code.  The function is called with no arguments.
  550.      You can use `term-setup-hook' to override the definitions made by
  551.      a terminal-specific file.
  552.    See also `window-setup-hook' in *Note Window Systems::.
  553. File: elisp,  Node: Command Line Arguments,  Prev: Terminal-Specific,  Up: Starting Up
  554. Command Line Arguments
  555. ----------------------
  556.    You can use command line arguments to request various actions when
  557. you start Emacs.  Since you do not need to start Emacs more than once
  558. per day, and will often leave your Emacs session running longer than
  559. that, command line arguments are hardly ever used.  As a practical
  560. matter, it is best to avoid making the habit of using them, since this
  561. habit would encourage you to kill and restart Emacs unnecessarily
  562. often.  These options exist for two reasons: to be compatible with
  563. other editors (for invocation by other programs) and to enable shell
  564. scripts to run specific Lisp programs.
  565.  -- Function: command-line
  566.      This function parses the command line which Emacs was called with,
  567.      processes it, loads the user's `.emacs' file and displays the
  568.      initial nonwarranty information, etc.
  569.  -- Variable: command-line-processed
  570.      The value of this variable is `t' once the command line has been
  571.      processed.
  572.      If you redump Emacs by calling `dump-emacs', you must set this
  573.      variable to `nil' first in order to cause the new dumped Emacs to
  574.      process its new command line arguments.
  575.  -- Variable: command-switch-alist
  576.      The value of this variable is an alist of user-defined command-line
  577.      options and associated handler functions.  This variable exists so
  578.      you can add elements to it.
  579.      A "command line option" is an argument on the command line of the
  580.      form:
  581.           -OPTION
  582.      The elements of the `command-switch-alist' look like this:
  583.           (OPTION . HANDLER-FUNCTION)
  584.      For each element, the HANDLER-FUNCTION receives the switch name as
  585.      its sole argument.
  586.      In some cases, the option is followed in the command line by an
  587.      argument.  In these cases, the HANDLER-FUNCTION can find all the
  588.      remaining command-line arguments in the variable
  589.      `command-line-args-left'.  (The entire list of command-line
  590.      arguments is in `command-line-args'.)
  591.      The command line arguments are parsed by the `command-line-1'
  592.      function in the `startup.el' file.  See also *Note Command Line
  593.      Switches and Arguments: (emacs)Command Switches.
  594.  -- Variable: command-line-args
  595.      The value of this variable is the arguments passed by the shell to
  596.      Emacs, as a list of strings.
  597. File: elisp,  Node: Getting Out,  Next: System Environment,  Prev: Starting Up,  Up: System Interface
  598. Getting out of Emacs
  599. ====================
  600.    There are two ways to get out of Emacs: you can kill the Emacs job,
  601. which exits permanently, or you can suspend it, which permits you to
  602. reenter the Emacs process later.  As a practical matter, you seldom kill
  603. Emacs--only when you are about to log out.  Suspending is much more
  604. common.
  605. * Menu:
  606. * Killing Emacs::        Exiting Emacs irreversibly.
  607. * Suspending Emacs::     Exiting Emacs reversibly.
  608. File: elisp,  Node: Killing Emacs,  Next: Suspending Emacs,  Prev: Getting Out,  Up: Getting Out
  609. Killing Emacs
  610. -------------
  611.    Killing Emacs means ending the execution of the Emacs process. It
  612. will return to its superior process.
  613.    All the information in the Emacs process, aside from files that have
  614. been saved, is lost when the Emacs is killed.  Because killing Emacs
  615. inadvertently can lose a lot of work, Emacs will query for confirmation
  616. before actually terminating if you have buffers that need saving or
  617. subprocesses that are running.
  618.  -- Function: kill-emacs &optional NO-QUERY
  619.      This function exits the Emacs process and kills it.
  620.      Normally, if there are modified files or if there are running
  621.      processes, `kill-emacs' asks the user for confirmation before
  622.      exiting.  However, if NO-QUERY is supplied and non-`nil', then
  623.      Emacs exits without confirmation.
  624.      If NO-QUERY is an integer, then it is used as the exit status of
  625.      the Emacs process.  (This is useful primarily in batch operation;
  626.      see *Note Batch Mode::.)
  627.      If NO-QUERY is a string, its contents are stuffed into the
  628.      terminal input buffer so that the shell (or whatever program next
  629.      reads input) can read them.
  630.  -- Variable: kill-emacs-hook
  631.      The value of the `kill-emacs-hook' variable is either `nil' or is
  632.      that of a function to be called by `kill-emacs'.  The hook is
  633.      called before anything else is done by `kill-emacs'.
  634. File: elisp,  Node: Suspending Emacs,  Prev: Killing Emacs,  Up: Getting Out
  635. Suspending Emacs
  636. ----------------
  637.    "Suspending Emacs" means stopping Emacs temporarily and returning
  638. control to its superior process, which is usually the shell.  This
  639. allows you to resume editing later in the same Emacs process, with the
  640. same buffers, the same kill ring, the same undo history, and so on.  To
  641. resume Emacs, use the appropriate command in the parent shell--most
  642. likely `fg'.
  643.    Some operating systems do not support suspension of jobs; on these
  644. systems, "suspension" actually creates a new shell temporarily as a
  645. subprocess of Emacs.  Then you would exit the shell to return to Emacs.
  646.    Suspension is not useful with window systems such as X Windows,
  647. because the Emacs job may not have a parent that can resume it again,
  648. and in any case you can give input to some other job such as a shell
  649. merely by moving to a different window.  Therefore, suspending is not
  650. allowed under X Windows.
  651.  -- Function: suspend-emacs STRING
  652.      This function stops Emacs and returns to the superior process.  It
  653.      returns `nil'.
  654.      If STRING is non-`nil', its characters are sent to be read as
  655.      terminal input by Emacs's superior shell.  The characters in STRING
  656.      will not be echoed by the superior shell; just the results will
  657.      appear.
  658.      Before suspending, Emacs examines the symbol `suspend-hook'.  If
  659.      it is bound, and its value is non-`nil', then the value is called
  660.      as a function of no arguments.  If the function returns non-`nil',
  661.      then `suspend-emacs' returns immediately and suspension does not
  662.      occur.
  663.      After Emacs resumes, the symbol `suspend-resume-hook' is examined.
  664.       If it is bound and non-`nil', then the value is called as a
  665.      function of no arguments.
  666.      The next redisplay after resumption will redraw the entire screen,
  667.      unless `no-redraw-on-reenter' is set (*note Screen Attributes::.).
  668.      In the following example, note that `pwd' is not echoed after
  669.      Emacs is suspended.  But it is read and executed by the shell.
  670.           (suspend-emacs)
  671.                => nil
  672.           
  673.           (setq suspend-hook
  674.               (function (lambda ()
  675.                         (not (y-or-n-p "Really suspend? ")))))
  676.                => (lambda nil (not (y-or-n-p "Really suspend? ")))
  677.           (setq suspend-resume-hook
  678.               (function (lambda () (message "Resumed!"))))
  679.                => (lambda nil (message "Resumed!"))
  680.           (suspend-emacs "pwd")
  681.                => nil
  682.           ---------- Buffer: Minibuffer ----------
  683.           Really suspend? `y'
  684.           
  685.           ---------- Parent Shell ----------
  686.           lewis@slug[23] % /user/lewis/manual
  687.           lewis@slug[24] % fg
  688.           
  689.           ---------- Echo Area ----------
  690.           Resumed!
  691.  -- Variable: suspend-hook
  692.      The value of the `suspend-hook' variable, if not `nil', is called
  693.      as a function with no arguments by `suspend-emacs' before Emacs is
  694.      actually suspended.  If the function returns non-`nil', then
  695.      suspension does not take place.
  696.  -- Variable: suspend-resume-hook
  697.      The value of the `suspend-resume-hook' variable, if not `nil', is
  698.      called as a function with no arguments after resumption of an
  699.      Emacs session that was suspended with `suspend-emacs'.
  700. File: elisp,  Node: System Environment,  Next: Terminal Input,  Prev: Getting Out,  Up: System Interface
  701. Operating System Environment
  702. ============================
  703.    Emacs provides access to variables in the operating system
  704. environment through various functions.  These variables include the
  705. name of the system, the user's UID, and so on.
  706.  -- Variable: system-type
  707.      The value of this variable is a symbol indicating the type of
  708.      operating system Emacs is operating on.  Here is a table of the
  709.      symbols for the operating systems that Emacs can run on up to
  710.      version 18.51.
  711.     `berkeley-unix'
  712.           Berkeley BSD 4.1, 4.2, or 4.3.
  713.     `hpux'
  714.           Hewlett-Packard operating system, version 5, 6, or 7.
  715.     `silicon-graphics-unix'
  716.           Silicon Graphics Iris 3.5 or 3.6.
  717.     `rtu'
  718.           RTU 3.0, UCB universe.
  719.     `unisoft-unix'
  720.           UniSoft's UniPlus 5.0 or 5.2.
  721.     `usg-unix-v'
  722.           AT&T's System V.0, System V Release 2.0, 2.2, or 3.
  723.     `vax-vms'
  724.           VMS VMS version 4 or 5.
  725.     `xenix'
  726.           SCO Xenix 386 Release 2.2.
  727.      We do not wish to add new symbols to make finer distinctions
  728.      unless it is absolutely necessary!  In fact, it would be nice to
  729.      eliminate a couple of possibilities in the future.
  730.  -- Function: getenv VAR
  731.      This function returns the value of the environment variable VAR,
  732.      as a string.
  733.           (getenv "USER")
  734.                => "lewis"
  735.           
  736.           lewis@slug[10] % printenv
  737.           PATH=.:/user/lewis/bin:/usr/bin:/usr/local/bin
  738.           USER=lewis
  739.           TERM=ibmapa16
  740.           SHELL=/bin/csh
  741.           HOME=/user/lewis
  742.  -- Function: user-login-name
  743.      This function returns the name under which the user is logged in.
  744.      This is based on the effective UID, not the real UID.
  745.           (user-login-name)
  746.                => "lewis"
  747.  -- Function: user-real-login-name
  748.      This function returns the name under which the user logged in.
  749.      This is based on the real UID, not the effective UID.  This
  750.      differs from `user-login-name' only when running with the setuid
  751.      bit.
  752.  -- Function: user-full-name
  753.      This function returns the full name of the user.
  754.           (user-full-name)
  755.                => "Bil Lewis"
  756.  -- Function: user-real-uid
  757.      This function returns the real UID of the user.
  758.           (user-real-uid)
  759.                => 19
  760.  -- Function: user-uid
  761.      This function returns the effective UID of the user.
  762.  -- Function: system-name
  763.      This function returns the name of the machine you are running on.
  764.           (system-name)
  765.                => "prep.ai.mit.edu"
  766.  -- Function: current-time-string
  767.      This function returns the current time and date as a
  768.      humanly-readable string.  The format of the string is unvarying;
  769.      the number of characters used for each part is always the same, so
  770.      you can reliably use `substring' to extract pieces of it. 
  771.      However, it would be wise to count the characters from the
  772.      beginning of the string rather than from the end, as additional
  773.      information describing the time zone may be added in version 19.
  774.           (current-time-string)
  775.                => "Wed Oct 14 22:21:05 1987"
  776.  -- Function: load-average
  777.      This function returns the current 1 minute, 5 minute and 15 minute
  778.      load averages in a list.  The values are integers that are 100
  779.      times the system load averages.  (The load averages indicate the
  780.      number of processes trying to run.)
  781.           (load-average)
  782.                => (169 48 36)
  783.           
  784.           lewis@rocky[5] % uptime
  785.            11:55am  up 1 day, 19:37,  3 users,  load average: 1.69, 0.48, 0.36
  786.  -- Function: setprv PRIVILEGE-NAME &optional SETP GETPRV
  787.      This function sets or resets a VMS privilege.  (It does not exist
  788.      on Unix.)  The first arg is the privilege name, as a string.  The
  789.      second argument, SETP, is `t' or `nil', indicating whether the
  790.      privilege is to be turned on or off.  Its default is `nil'.  The
  791.      function returns `t' if success, `nil' if not.
  792.      If the third argument, GETPRV, is non-`nil', `setprv' does not
  793.      change the privilege, but returns `t' or `nil' indicating whether
  794.      the privilege is currently enabled.
  795. File: elisp,  Node: Terminal Input,  Next: Terminal Output,  Prev: System Environment,  Up: System Interface
  796. Terminal Input
  797. ==============
  798.    The terminal input functions and variables keep track of or
  799. manipulate terminal input.
  800.    See *Note Emacs Display::, for related functions.
  801.  -- Function: recent-keys
  802.      This function returns a string comprising the last 100 characters
  803.      read from the terminal.  These are the last 100 characters read by
  804.      Emacs, no exceptions.
  805.           (recent-keys)
  806.           => "erminal.  These are the last 100 characters read by Emacs, no
  807.           exceptions.
  808.           
  809.           @example
  810.           (recent-keys)^U^X^E"
  811.      Here the string `@example' is a Texinfo command that was inserted
  812.      in the source file for the manual, and `^U^X^E' are the characters
  813.      that were typed to evaluate the expression `(recent-keys)'.
  814.  -- Command: open-dribble-file FILENAME
  815.      This function opens a "dribble file" named FILENAME.  When a
  816.      dribble file is open, Emacs copies all keyboard input characters
  817.      to that file.  (The contents of keyboard macros are not typed on
  818.      the keyboard so they are not copied to the dribble file.)
  819.      You close the dribble file by calling this function with an
  820.      argument of `""'.  The function always returns `nil'.
  821.      This function is normally used to record the input necessary to
  822.      trigger an Emacs bug, for the sake of a bug report.
  823.           (open-dribble-file "$j/dribble")
  824.                => nil
  825.    See also the `open-termscript' function (*note Terminal Output::.).
  826.  -- Function: set-input-mode INTERRUPT FLOW QUIT-CHAR
  827.      This function sets the mode for reading keyboard input.  If
  828.      INTERRUPT is non-null, then Emacs uses input interrupts.  If it is
  829.      `nil', then it uses CBREAK mode.
  830.      If FLOW is non-`nil', then Emacs uses XON/XOFF (`C-q', `C-s') flow
  831.      control for output to terminal.  This has no effect except in
  832.      CBREAK mode.  *Note Flow Control::.
  833.      The normal setting is system dependent.  Some systems always use
  834.      CBREAK mode regardless of what is specified.
  835.      If QUIT-CHAR is non-`nil', it specifies the character to use for
  836.      quitting.  Normally this is 7, the code for `C-g'. *Note
  837.      Quitting::.
  838.  -- Variable: meta-flag
  839.      This variable tells Emacs whether to treat the 0200 bit in keyboard
  840.      input as the Meta bit.  `nil' means no, and anything else means
  841.      yes.  In version 19, `meta-flag' will be a function instead of a
  842.      variable.
  843.  -- Variable: keyboard-translate-table
  844.      This variable defines the translate table for keyboard input.  This
  845.      allows the user to redefine the keys on the keyboard without
  846.      changing any command bindings.  Its value must be a string or
  847.      `nil'.
  848.      If `keyboard-translate-table' is a string, then each character read
  849.      from the keyboard is looked up in this string and the character in
  850.      the string is used instead.  If the string is of length N,
  851.      character codes N and up are untranslated.
  852.      In the example below, `keyboard-translate-table' is set to a
  853.      string of 128 characters.  Then the characters `C-s' and `C-\' are
  854.      swapped and the characters `C-q' and `C-^' are swapped. After
  855.      executing this function, typing `C-\' has all the usual effects of
  856.      typing `C-s', and vice versa.  (*Note Flow Control:: for more
  857.      information on this subject.)
  858.           (defun evade-flow-control ()
  859.             "Replace C-s with C-\ and C-q with C-^."
  860.             (interactive)
  861.             (let ((the-table (make-string 128 0)))
  862.               (let ((i 0))
  863.                 (while (< i 128)
  864.                   (aset the-table i i)
  865.                   (setq i (1+ i))))
  866.           
  867.               ;; Swap `C-s' and `C-\'.
  868.               (aset the-table ?\034 ?\^s)
  869.               (aset the-table ?\^s ?\034)
  870.               ;; Swap `C-q' and `C-^'.
  871.               (aset the-table ?\036 ?\^q)
  872.               (aset the-table ?\^q ?\036)
  873.           
  874.               (setq keyboard-translate-table the-table)))
  875.      Note that this translation is the first thing that happens after a
  876.      character is read from the terminal.  As a result, record-keeping
  877.      features such as `recent-keys' and `open-dribble-file' record the
  878.      translated characters.
  879. File: elisp,  Node: Terminal Output,  Next: Flow Control,  Prev: Terminal Input,  Up: System Interface
  880. Terminal Output
  881. ===============
  882.    The terminal output functions send or keep track of output sent from
  883. the computer to the terminal.  The `baud-rate' function tells you what
  884. Emacs thinks is the output baud rate of the terminal.
  885.  -- Function: baud-rate
  886.      This function returns the output baud rate of the terminal.
  887.           (baud-rate)
  888.                => 9600
  889.      If you are running across a network, and different parts of the
  890.      network work at different baud rates, the value returned by Emacs
  891.      may be different from the value used by your local terminal.  Some
  892.      network protocols communicate the local terminal speed to the
  893.      remote machine, so that Emacs and other programs can get the
  894.      proper value, but others do not.  If the machine where Emacs is
  895.      running has the wrong speed setting, you can specify the right
  896.      speed using the `stty' program.  However, you will have to start
  897.      Emacs afresh to make this take effect.
  898.      *Note:* In version 19, `baud-rate' is a variable so that you can
  899.      change it conveniently within Emacs.
  900.  -- Function: send-string-to-terminal STRING
  901.      This function sends STRING to the terminal without alteration.
  902.      Control characters in STRING will have terminal-dependent effects.
  903.      One use of this function is to define function keys on terminals
  904.      that have downloadable function key definitions.  For example,
  905.      this is how on certain terminals to define function key 4 to move
  906.      forward four characters (by transmitting the characters `C-u C-f'
  907.      to the computer):
  908.           (send-string-to-terminal "\eF4\^U\^F")
  909.                => nil
  910.  -- Command: open-termscript FILENAME
  911.      This function is used to open a "termscript file" that will record
  912.      all the characters sent by Emacs to the terminal.  It returns
  913.      `nil'.  Termscript files are useful for investigating problems
  914.      where Emacs garbles the screen, problems which are due to incorrect
  915.      termcap entries or to undesirable settings of terminal options more
  916.      often than actual Emacs bugs.  Once you are certain which
  917.      characters were actually output, you can determine reliably
  918.      whether they correspond to the termcap specifications in use.
  919.      See also `open-dribble-file' in *Note Terminal Input::.
  920.           (open-termscript "../junk/termscript")
  921.                => nil
  922.