home *** CD-ROM | disk | FTP | other *** search
/ Dream 49 / Amiga_Dream_49.iso / beos / emacs / emacs-19.34-bin / emacs-19 / info / emacs-18 (.txt) < prev    next >
GNU Info File  |  1997-09-17  |  45KB  |  800 lines

  1. This is Info file ../info/emacs, produced by Makeinfo-1.63 from the
  2. input file emacs.texi.
  3. File: emacs,  Node: Special Diary Entries,  Prev: Adding to Diary,  Up: Diary
  4. Special Diary Entries
  5. ---------------------
  6.    In addition to entries based on calendar dates, the diary file can
  7. contain "sexp entries" for regular events such as anniversaries.  These
  8. entries are based on Lisp expressions (sexps) that Emacs evaluates as
  9. it scans the diary file.  Instead of a date, a sexp entry contains `%%'
  10. followed by a Lisp expression which must begin and end with
  11. parentheses.  The Lisp expression determines which dates the entry
  12. applies to.
  13.    Calendar mode provides commands to insert certain commonly used sexp
  14. entries:
  15. `i a'
  16.      Add an anniversary diary entry for the selected date
  17.      (`insert-anniversary-diary-entry').
  18. `i b'
  19.      Add a block diary entry for the current region
  20.      (`insert-block-diary-entry').
  21. `i c'
  22.      Add a cyclic diary entry starting at the date
  23.      (`insert-cyclic-diary-entry').
  24.    If you want to make a diary entry that applies to the anniversary of
  25. a specific date, move point to that date and use the `i a' command.
  26. This displays the end of your diary file in another window and inserts
  27. the anniversary description; you can then type the rest of the diary
  28. entry.  The entry looks like this:
  29.      %%(diary-anniversary 10 31 1948) Arthur's birthday
  30. This entry applies to October 31 in any year after 1948; `10 31 1948'
  31. specifies the date.  (If you are using the European calendar style, the
  32. month and day are interchanged.)  The reason this expression requires a
  33. beginning year is that advanced diary functions can use it to calculate
  34. the number of elapsed years.
  35.    A "block" diary entry applies to a specified range of consecutive
  36. dates.  Here is a block diary entry that applies to all dates from June
  37. 24, 1990 through July 10, 1990:
  38.      %%(diary-block 6 24 1990 7 10 1990) Vacation
  39. The `6 24 1990' indicates the starting date and the `7 10 1990'
  40. indicates the stopping date.  (Again, if you are using the European
  41. calendar style, the month and day are interchanged.)
  42.    To insert a block entry, place point and the mark on the two dates
  43. that begin and end the range, and type `i b'.  This command displays
  44. the end of your diary file in another window and inserts the block
  45. description; you can then type the diary entry.
  46.    "Cyclic" diary entries repeat after a fixed interval of days.  To
  47. create one, select the starting date and use the `i c' command.  The
  48. command prompts for the length of interval, then inserts the entry,
  49. which looks like this:
  50.      %%(diary-cyclic 50 3 1 1990) Renew medication
  51. This entry applies to March 1, 1990 and every 50th day following; `3 1
  52. 1990' specifies the starting date.  (If you are using the European
  53. calendar style, the month and day are interchanged.)
  54.    All three of these commands make marking diary entries.  To insert a
  55. nonmarking entry, give a numeric argument to the command.  For example,
  56. `C-u i a' makes a nonmarking anniversary diary entry.
  57.    Marking sexp diary entries in the calendar is *extremely*
  58. time-consuming, since every date visible in the calendar window must be
  59. individually checked.  So it's a good idea to make sexp diary entries
  60. nonmarking (with `&') when possible.
  61.    Another sophisticated kind of sexp entry, a "floating" diary entry,
  62. specifies a regularly-occurring event by offsets specified in days,
  63. weeks, and months.  It is comparable to a crontab entry interpreted by
  64. the `cron' utility.  Here is a nonmarking, floating diary entry that
  65. applies to the last Thursday in November:
  66.      &%%(diary-float 11 4 -1) American Thanksgiving
  67. The 11 specifies November (the eleventh month), the 4 specifies Thursday
  68. (the fourth day of the week, where Sunday is numbered zero), and the -1
  69. specifies "last" (1 would mean "first", 2 would mean "second", -2 would
  70. mean "second-to-last", and so on).  The month can be a single month or
  71. a list of months.  Thus you could change the 11 above to `'(1 2 3)' and
  72. have the entry apply to the last Thursday of January, February, and
  73. March.  If the month is `t', the entry applies to all months of the
  74. year.
  75.    Most generally, sexp diary entries can perform arbitrary
  76. computations to determine when they apply.  *Note Sexp Diary Entries:
  77. (elisp)Sexp Diary Entries.
  78. File: emacs,  Node: Appointments,  Next: Daylight Savings,  Prev: Diary,  Up: Calendar/Diary
  79. Appointments
  80. ============
  81.    If you have a diary entry for an appointment, and that diary entry
  82. begins with a recognizable time of day, Emacs can warn you, several
  83. minutes beforehand, that that appointment is pending.  Emacs alerts you
  84. to the appointment by displaying a message in the mode line.
  85.    To enable appointment notification, you must enable the time display
  86. feature of Emacs, `M-x display-time' (*note Mode Line::.).  You must
  87. also add the function `appt-make-list' to the `diary-hook', like this:
  88.      (add-hook 'diary-hook 'appt-make-list)
  89.    With these preparations done, when you display the diary (either with
  90. the `d' command in the calendar window or with the `M-x diary'
  91. command), it sets up an appointment list of all the diary entries found
  92. with recognizable times of day, and reminds you just before each of
  93. them.
  94.    For example, suppose the diary file contains these lines:
  95.      Monday
  96.        9:30am Coffee break
  97.       12:00pm Lunch
  98. Then on Mondays, after you have displayed the diary, you will be
  99. reminded at 9:20am about your coffee break and at 11:50am about lunch.
  100.    You can write times in am/pm style (with `12:00am' standing for
  101. midnight and `12:00pm' standing for noon), or 24-hour European/military
  102. style.  You need not be consistent; your diary file can have a mixture
  103. of the two styles.
  104.    Emacs updates the appointments list automatically just after
  105. midnight.  This also displays the next day's diary entries in the diary
  106. buffer, unless you set `appt-display-diary' to `nil'.
  107.    You can also use the appointment notification facility like an alarm
  108. clock.  The command `M-x appt-add' adds entries to the appointment list
  109. without affecting your diary file.  You delete entries from the
  110. appointment list with `M-x appt-delete'.
  111.    You can turn off the appointment notification feature at any time by
  112. setting `appt-issue-message' to `nil'.
  113. File: emacs,  Node: Daylight Savings,  Prev: Appointments,  Up: Calendar/Diary
  114. Daylight Savings Time
  115. =====================
  116.    Emacs understands the difference between standard time and daylight
  117. savings time--the times given for sunrise, sunset, solstices,
  118. equinoxes, and the phases of the moon take that into account.  The rules
  119. for daylight savings time vary from place to place and have also varied
  120. historically from year to year.  To do the job properly, Emacs needs to
  121. know which rules to use.
  122.    Some operating systems keep track of the rules that apply to the
  123. place where you are; on these systems, Emacs gets the information it
  124. needs from the system automatically.  If some or all of this
  125. information is missing, Emacs fills in the gaps with the rules
  126. currently used in Cambridge, Massachusetts.  If the resulting rules are
  127. not what you want, you can tell Emacs the rules to use by setting
  128. certain variables.
  129.    These values should be Lisp expressions that refer to the variable
  130. `year', and evaluate to the Gregorian date on which daylight savings
  131. time starts or (respectively) ends, in the form of a list `(MONTH DAY
  132. YEAR)'.  The values should be `nil' if your area does not use daylight
  133. savings time.
  134.    Emacs uses these expressions to determine the starting date of
  135. daylight savings time for the holiday list and for correcting times of
  136. day in the solar and lunar calculations.
  137.    The values for Cambridge, Massachusetts are as follows:
  138.      (calendar-nth-named-day 1 0 4 year)
  139.      (calendar-nth-named-day -1 0 10 year)
  140. That is, the first 0th day (Sunday) of the fourth month (April) in the
  141. year specified by `year', and the last Sunday of the tenth month
  142. (October) of that year.  If daylight savings time were changed to start
  143. on October 1, you would set `calendar-daylight-savings-starts' to this:
  144.      (list 10 1 year)
  145.    If there is no daylight savings time at your location, or if you want
  146. all times in standard time, set `calendar-daylight-savings-starts' and
  147. `calendar-daylight-savings-ends' to `nil'.
  148.    The variable `calendar-daylight-time-offset' specifies the
  149. difference between daylight savings time and standard time, measured in
  150. minutes.  The value for Cambridge, Massachusetts is 60.
  151.    The two variables `calendar-daylight-savings-starts-time' and
  152. `calendar-daylight-savings-ends-time' specify the number of minutes
  153. after midnight local time when the transition to and from daylight
  154. savings time should occur.  For Cambridge, Massachusetts both variables'
  155. values are 120.
  156. File: emacs,  Node: Gnus,  Next: Shell,  Prev: Calendar/Diary,  Up: Top
  157.    Gnus is an Emacs package primarily designed for reading and posting
  158. Usenet news.  It can also be used to read and respond to messages from a
  159. number of other sources--mail, remote directories, digests, and so on.
  160.    Here we introduce Gnus and describe several basic features.  For
  161. full details, see *Note Gnus: (gnus)Top.
  162.    To start Gnus, type `M-x gnus RET'.
  163. * Menu:
  164. * Buffers of Gnus::       The group, summary and article buffers.
  165. * Gnus Startup::       What you should know about starting Gnus.
  166. * Summary of Gnus::       A short description of the basic Gnus commands.
  167. File: emacs,  Node: Buffers of Gnus,  Next: Gnus Startup,  Up: Gnus
  168. Gnus Buffers
  169. ------------
  170.    As opposed to most normal Emacs packages, Gnus uses a number of
  171. different buffers to display information and to receive commands.  The
  172. three buffers users spend most of their time in are the "group buffer",
  173. the "summary buffer" and the "article buffer".
  174.    The "group buffer" contains a list of groups.  This is the first
  175. buffer Gnus displays when it starts up.  It normally displays only the
  176. groups to which you subscribe and that contain unread articles.  Use
  177. this buffer to select a specific group.
  178.    The "summary buffer" lists one line for each article in a single
  179. group.  By default, the author, the subject and the line number are
  180. displayed for each article, but this is customizable, like most aspects
  181. of Gnus display.  The summary buffer is created when you select a group
  182. in the group buffer, and is killed when you exit the group.  Use this
  183. buffer to select an article.
  184.    The "article buffer" displays the article.  In normal Gnus usage,
  185. you don't select this buffer--all useful article-oriented commands work
  186. in the summary buffer.  But you can select the article buffer, and
  187. execute all Gnus commands from that buffer, if you want to.
  188. File: emacs,  Node: Gnus Startup,  Next: Summary of Gnus,  Prev: Buffers of Gnus,  Up: Gnus
  189. When Gnus Starts Up
  190. -------------------
  191.    At startup, Gnus reads your `.newsrc' news initialization file and
  192. attempts to communicate with the local news server, which is a
  193. repository of news articles.  The news server need not be the same
  194. computer you are logged in on.
  195.    If you start Gnus and connect to the server, but do not see any
  196. newsgroups listed in the group buffer, type `L' or `A k' to get a
  197. listing of all the groups.  Then type `u' to toggle subscription to
  198. groups.
  199.    The first time you start Gnus, Gnus subscribes you to a few selected
  200. groups.  All other groups start out as "killed groups" for you; you can
  201. list them with `A k'.  All new groups that subsequently come to exist
  202. at the news server become "zombie groups" for you; type `A z' to list
  203. them.  You can subscribe to a group shown in these lists using the `u'
  204. command.
  205.    When you quit Gnus with `q', it automatically records in your
  206. `.newsrc' and `.newsrc.eld' initialization files the subscribed or
  207. unsubscribed status of all groups.  You should normally not edit these
  208. files manually, but you may if you know how.
  209. File: emacs,  Node: Summary of Gnus,  Prev: Gnus Startup,  Up: Gnus
  210. Summary of Gnus Commands
  211. ------------------------
  212.    Reading news is a two step process:
  213.   1. Choose a group in the group buffer.
  214.   2. Select articles from the summary buffer.  Each article selected is
  215.      displayed in the article buffer in a large window, below the
  216.      summary buffer in its small window.
  217.    Each Gnus buffer has its own special commands; however, the meanings
  218. of any given key in the various Gnus buffers are usually analogous, even
  219. if not identical.  Here are commands for the group and summary buffers:
  220.      In the group buffer, update your `.newsrc' initialization file and
  221.      quit Gnus.
  222.      In the summary buffer, exit the current group and return to the
  223.      group buffer.  Thus, typing `q' twice quits Gnus.
  224.      In the group buffer, list all the groups available on your news
  225.      server (except those you have killed).  This may be a long list!
  226.      In the group buffer, list only the groups to which you subscribe
  227.      and which contain unread articles.
  228.      In the group buffer, unsubscribe from (or subscribe to) the group
  229.      listed in the line that point is on.  When you quit Gnus by typing
  230.      `q', Gnus lists in your `.newsrc' file which groups you have
  231.      subscribed to.  The next time you start Gnus, you won't see this
  232.      group, because Gnus normally displays only subscribed-to groups.
  233. `C-k'
  234.      In the group buffer, "kill" the current line's group--don't even
  235.      list it in `.newsrc' from now on.  This affects future Gnus
  236.      sessions as well as the present session.
  237.      When you quit Gnus by typing `q', Gnus writes information in the
  238.      file `.newsrc' describing all newsgroups except those you have
  239.      "killed."
  240. `SPC'
  241.      In the group buffer, select the group on the line under the cursor
  242.      and display the first unread article in that group.
  243.      In the summary buffer,
  244.         * Select the article on the line under the cursor if none is
  245.           selected.
  246.         * Scroll the text of the selected article (if there is one).
  247.         * Select the next unread article if at the end of the current
  248.           article.
  249.      Thus, you can move through all the articles by repeatedly typing
  250.      SPC.
  251. `DEL'
  252.      In the group buffer, move point to the previous group containing
  253.      unread articles.
  254.      In the summary buffer, scroll the text of the article backwards.
  255.      Move point to the next unread group, or select the next unread
  256.      article.
  257.      Move point to the previous unread group, or select the previous
  258.      unread article.
  259. `C-n'
  260. `C-p'
  261.      Move point to the next or previous item, even if it is marked as
  262.      read.  This does not select the article or group on that line.
  263.      In the summary buffer, do an incremental search of the current
  264.      text in the article buffer, just as if you switched to the article
  265.      buffer and typed `C-s'.
  266. `M-s REGEXP RET'
  267.      In the summary buffer, search forward for articles containing a
  268.      match for REGEXP.
  269. File: emacs,  Node: Shell,  Next: Emacs Server,  Prev: Gnus,  Up: Top
  270. Running Shell Commands from Emacs
  271. =================================
  272.    Emacs has commands for passing single command lines to inferior shell
  273. processes; it can also run a shell interactively with input and output
  274. to an Emacs buffer named `*shell*'.
  275. `M-! CMD RET'
  276.      Run the shell command line CMD and display the output
  277.      (`shell-command').
  278. `M-| CMD RET'
  279.      Run the shell command line CMD with region contents as input;
  280.      optionally replace the region with the output
  281.      (`shell-command-on-region').
  282. `M-x shell'
  283.      Run a subshell with input and output through an Emacs buffer.  You
  284.      can then give commands interactively.
  285. * Menu:
  286. * Single Shell::           How to run one shell command and return.
  287. * Interactive Shell::      Permanent shell taking input via Emacs.
  288. * Shell Mode::             Special Emacs commands used with permanent shell.
  289. * History: Shell History.  Repeating previous commands in a shell buffer.
  290. * Options: Shell Options.  Options for customizing Shell mode.
  291. * Remote Host::            Connecting to another computer.
  292. File: emacs,  Node: Single Shell,  Next: Interactive Shell,  Up: Shell
  293. Single Shell Commands
  294. ---------------------
  295.    `M-!' (`shell-command') reads a line of text using the minibuffer
  296. and executes it as a shell command in a subshell made just for that
  297. command.  Standard input for the command comes from the null device.
  298. If the shell command produces any output, the output goes into an Emacs
  299. buffer named `*Shell Command Output*', which is displayed in another
  300. window but not selected.  A numeric argument, as in `M-1 M-!', directs
  301. this command to insert any output into the current buffer.  In that
  302. case, point is left before the output and the mark is set after the
  303. output.
  304.    If the shell command line ends in `&', it runs asynchronously.
  305.    `M-|' (`shell-command-on-region') is like `M-!' but passes the
  306. contents of the region as the standard input to the shell command,
  307. instead of no input.  If a numeric argument is used, meaning insert the
  308. output in the current buffer, then the old region is deleted first and
  309. the output replaces it as the contents of the region.
  310.    Both `M-!' and `M-|' use `shell-file-name' to specify the shell to
  311. use.  This variable is initialized based on your `SHELL' environment
  312. variable when Emacs is started.  If the file name does not specify a
  313. directory, the directories in the list `exec-path' are searched; this
  314. list is initialized based on the environment variable `PATH' when Emacs
  315. is started.  Your `.emacs' file can override either or both of these
  316. default initializations.
  317.    Both `M-!' and `M-|' wait for the shell command to complete.  To
  318. stop waiting, type `C-g' to quit; that terminates the shell command
  319. with the signal `SIGINT'--the same signal that `C-c' normally generates
  320. in the shell.  Emacs waits until the command actually terminates.  If
  321. the shell command doesn't stop (because it ignores the `SIGINT'
  322. signal), type `C-g' again; this sends the command a `SIGKILL' signal
  323. which is impossible to ignore.
  324. File: emacs,  Node: Interactive Shell,  Next: Shell Mode,  Prev: Single Shell,  Up: Shell
  325. Interactive Inferior Shell
  326. --------------------------
  327.    To run a subshell interactively, putting its typescript in an Emacs
  328. buffer, use `M-x shell'.  This creates (or reuses) a buffer named
  329. `*shell*' and runs a subshell with input coming from and output going
  330. to that buffer.  That is to say, any "terminal output" from the subshell
  331. goes into the buffer, advancing point, and any "terminal input" for the
  332. subshell comes from text in the buffer.  To give input to the subshell,
  333. go to the end of the buffer and type the input, terminated by RET.
  334.    Emacs does not wait for the subshell to do anything.  You can switch
  335. windows or buffers and edit them while the shell is waiting, or while
  336. it is running a command.  Output from the subshell waits until Emacs
  337. has time to process it; this happens whenever Emacs is waiting for
  338. keyboard input or for time to elapse.
  339.    To make multiple subshells, rename the buffer `*shell*' to something
  340. different using `M-x rename-uniquely'.  Then type `M-x shell' again to
  341. create a new buffer `*shell*' with its own subshell.  If you rename
  342. this buffer as well, you can create a third one, and so on.  All the
  343. subshells run independently and in parallel.
  344.    The file name used to load the subshell is the value of the variable
  345. `explicit-shell-file-name', if that is non-`nil'.  Otherwise, the
  346. environment variable `ESHELL' is used, or the environment variable
  347. `SHELL' if there is no `ESHELL'.  If the file name specified is
  348. relative, the directories in the list `exec-path' are searched; this
  349. list is initialized based on the environment variable `PATH' when Emacs
  350. is started.  Your `.emacs' file can override either or both of these
  351. default initializations.
  352.    As soon as the subshell is started, it is sent as input the contents
  353. of the file `~/.emacs_SHELLNAME', if that file exists, where SHELLNAME
  354. is the name of the file that the shell was loaded from.  For example,
  355. if you use bash, the file sent to it is `~/.emacs_bash'.
  356.    `cd', `pushd' and `popd' commands given to the inferior shell are
  357. watched by Emacs so it can keep the `*shell*' buffer's default
  358. directory the same as the shell's working directory.  These commands
  359. are recognized syntactically by examining lines of input that are sent.
  360. If you use aliases for these commands, you can tell Emacs to recognize
  361. them also.  For example, if the value of the variable
  362. `shell-pushd-regexp' matches the beginning of a shell command line,
  363. that line is regarded as a `pushd' command.  Change this variable when
  364. you add aliases for `pushd'.  Likewise, `shell-popd-regexp' and
  365. `shell-cd-regexp' are used to recognize commands with the meaning of
  366. `popd' and `cd'.  These commands are recognized only at the beginning
  367. of a shell command line.
  368.    If Emacs gets an error while trying to handle what it believes is a
  369. `cd', `pushd' or `popd' command, it runs the hook
  370. `shell-set-directory-error-hook' (*note Hooks::.).
  371.    If Emacs does not properly track changes in the current directory of
  372. the subshell, use the command `M-x dirs' to ask the shell what its
  373. current directory is.  This command works for shells that support the
  374. most common command syntax; it may not work for unusual shells.
  375. File: emacs,  Node: Shell Mode,  Next: Shell History,  Prev: Interactive Shell,  Up: Shell
  376. Shell Mode
  377. ----------
  378.    Shell buffers use Shell mode, which defines several special keys
  379. attached to the `C-c' prefix.  They are chosen to resemble the usual
  380. editing and job control characters present in shells that are not under
  381. Emacs, except that you must type `C-c' first.  Here is a complete list
  382. of the special key bindings of Shell mode:
  383. `RET'
  384.      At end of buffer send line as input; otherwise, copy current line
  385.      to end of buffer and send it (`comint-send-input').  When a line is
  386.      copied, any text at the beginning of the line that matches the
  387.      variable `shell-prompt-pattern' is left out; this variable's value
  388.      should be a regexp string that matches the prompts that your shell
  389.      uses.
  390. `TAB'
  391.      Complete the command name or file name before point in the shell
  392.      buffer (`comint-dynamic-complete').  TAB also completes history
  393.      references (*note History References::.) and environment variable
  394.      names.
  395.      The variable `shell-completion-fignore' specifies a list of file
  396.      name extensions to ignore in Shell mode completion.  The default
  397.      setting ignores file names ending in `~', `#' or `%'.  Other
  398.      related Comint modes use the variable `comint-completion-fignore'
  399.      instead.
  400. `M-?'
  401.      Display temporarily a list of the possible completions of the file
  402.      name before point in the shell buffer
  403.      (`comint-dynamic-list-filename-completions').
  404. `C-d'
  405.      Either delete a character or send EOF
  406.      (`comint-delchar-or-maybe-eof').  Typed at the end of the shell
  407.      buffer, `C-d' sends EOF to the subshell.  Typed at any other
  408.      position in the buffer, `C-d' deletes a character as usual.
  409. `C-c C-a'
  410.      Move to the beginning of the line, but after the prompt if any
  411.      (`comint-bol').
  412. `C-c C-u'
  413.      Kill all text pending at end of buffer to be sent as input
  414.      (`comint-kill-input').
  415. `C-c C-w'
  416.      Kill a word before point (`backward-kill-word').
  417. `C-c C-c'
  418.      Interrupt the shell or its current subjob if any
  419.      (`comint-interrupt-subjob').
  420. `C-c C-z'
  421.      Stop the shell or its current subjob if any (`comint-stop-subjob').
  422. `C-c C-\'
  423.      Send quit signal to the shell or its current subjob if any
  424.      (`comint-quit-subjob').
  425. `C-c C-o'
  426.      Kill the last batch of output from a shell command
  427.      (`comint-kill-output').  This is useful if a shell command spews
  428.      out lots of output that just gets in the way.
  429. `C-c C-r'
  430. `C-M-l'
  431.      Scroll to display the beginning of the last batch of output at the
  432.      top of the window; also move the cursor there
  433.      (`comint-show-output').
  434. `C-c C-e'
  435.      Scroll to put the end of the buffer at the bottom of the window
  436.      (`comint-show-maximum-output').
  437. `C-c C-f'
  438.      Move forward across one shell command, but not beyond the current
  439.      line (`shell-forward-command').  The variable
  440.      `shell-command-regexp' specifies how to recognize the end of a
  441.      command.
  442. `C-c C-b'
  443.      Move backward across one shell command, but not beyond the current
  444.      line (`shell-backward-command').
  445. `C-c C-l'
  446.      Display the buffer's history of shell commands in another window
  447.      (`comint-dynamic-list-input-ring').
  448. `M-x dirs'
  449.      Ask the shell what its current directory is, so that Emacs can
  450.      agree with the shell.
  451. `M-x send-invisible RET TEXT RET'
  452.      Send TEXT as input to the shell, after reading it without echoing.
  453.      This is useful when a shell command runs a program that asks for
  454.      a password.
  455.      Alternatively, you can arrange for Emacs to notice password prompts
  456.      and turn off echoing for them, as follows:
  457.           (add-hook 'comint-output-filter-functions
  458.                     'comint-watch-for-password-prompt)
  459. `M-x comint-continue-subjob'
  460.      Continue the shell process.  This is useful if you accidentally
  461.      suspend the shell process.(1)
  462. `M-x comint-strip-ctrl-m'
  463.      Discard all control-m characters from the current group of shell
  464.      output.  The most convenient way to use this command is to make it
  465.      run automatically when you get output from the subshell.  To do
  466.      that, evaluate this Lisp expression:
  467.           (add-hook 'comint-output-filter-functions
  468.                     'comint-strip-ctrl-m)
  469. `M-x comint-truncate-buffer'
  470.      This command truncates the shell buffer to a certain maximum
  471.      number of lines, specified by the variable
  472.      `comint-buffer-maximum-size'.  Here's how to do this automatically
  473.      each time you get output from the subshell:
  474.           (add-hook 'comint-output-filter-functions
  475.                     'comint-truncate-buffer)
  476.    Shell mode also customizes the paragraph commands so that only shell
  477. prompts start new paragraphs.  Thus, a paragraph consists of an input
  478. command plus the output that follows it in the buffer.
  479.    Shell mode is a derivative of Comint mode, a general purpose mode for
  480. communicating with interactive subprocesses.  Most of the features of
  481. Shell mode actually come from Comint mode, as you can see from the
  482. command names listed above.  The special features of Shell mode in
  483. particular include the choice of regular expression for detecting
  484. prompts, the directory tracking feature, and a few user commands.
  485.    Other Emacs features that use variants of Comint mode include GUD
  486. (*note Debuggers::.) and `M-x run-lisp' (*note External Lisp::.).
  487.    You can use `M-x comint-run' to execute any program of your choice
  488. in a subprocess using unmodified Comint mode--without the
  489. specializations of Shell mode.
  490.    ---------- Footnotes ----------
  491.    (1)  You should not suspend the shell process.  Suspending a subjob
  492. of the shell is a completely different matter--that is normal practice,
  493. but you must use the shell to continue the subjob; this command won't
  494. do it.
  495. File: emacs,  Node: Shell History,  Next: Shell Options,  Prev: Shell Mode,  Up: Shell
  496. Shell Command History
  497. ---------------------
  498.    Shell buffers support three ways of repeating earlier commands.  You
  499. can use the same keys used in the minibuffer; these work much as they do
  500. in the minibuffer, inserting text from prior commands while point
  501. remains always at the end of the buffer.  You can move through the
  502. buffer to previous inputs in their original place, then resubmit them or
  503. copy them to the end.  Or you can use a `!'-style history reference.
  504. * Menu:
  505. * Ring: Shell Ring.             Fetching commands from the history list.
  506. * Copy: Shell History Copying.  Moving to a command and then copying it.
  507. * History References::          Expanding `!'-style history references.
  508. File: emacs,  Node: Shell Ring,  Next: Shell History Copying,  Up: Shell History
  509. Shell History Ring
  510. ..................
  511. `M-p'
  512.      Fetch the next earlier old shell command.
  513. `M-n'
  514.      Fetch the next later old shell command.
  515. `M-r REGEXP RET'
  516. `M-s REGEXP RET'
  517.      Search backwards or forwards for old shell commands that match
  518.      REGEXP.
  519.    Shell buffers provide a history of previously entered shell
  520. commands.  To reuse shell commands from the history, use the editing
  521. commands `M-p', `M-n', `M-r' and `M-s'.  These work just like the
  522. minibuffer history commands except that they operate on the text at the
  523. end of the shell buffer, where you would normally insert text to send
  524. to the shell.
  525.    `M-p' fetches an earlier shell command to the end of the shell
  526. buffer.  Successive use of `M-p' fetches successively earlier shell
  527. commands, each replacing any text that was already present as potential
  528. shell input.  `M-n' does likewise except that it finds successively
  529. more recent shell commands from the buffer.
  530.    The history search commands `M-r' and `M-s' read a regular
  531. expression and search through the history for a matching command.  Aside
  532. from the choice of which command to fetch, they work just like `M-p'
  533. and `M-r'.  If you enter an empty regexp, these commands reuse the same
  534. regexp used last time.
  535.    When you find the previous input you want, you can resubmit it by
  536. typing RET, or you can edit it first and then resubmit it if you wish.
  537.    These commands get the text of previous shell commands from a special
  538. history list, not from the shell buffer itself.  Thus, editing the shell
  539. buffer, or even killing large parts of it, does not affect the history
  540. that these commands access.
  541.    Some shells store their command histories in files so that you can
  542. refer to previous commands from previous shell sessions.  Emacs reads
  543. the command history file for your chosen shell, to initialize its own
  544. command history.  The file name is `~/.bash_history' for bash,
  545. `~/.sh_history' for ksh, and `~/.history' for other shells.
  546. File: emacs,  Node: Shell History Copying,  Next: History References,  Prev: Shell Ring,  Up: Shell History
  547. Shell History Copying
  548. .....................
  549. `C-c C-p'
  550.      Move point to the previous prompt (`comint-previous-prompt').
  551. `C-c C-n'
  552.      Move point to the following prompt (`comint-next-prompt').
  553. `C-c RET'
  554.      Copy the input command which point is in, inserting the copy at
  555.      the end of the buffer (`comint-copy-old-input').  This is useful
  556.      if you move point back to a previous command.  After you copy the
  557.      command, you can submit the copy as input with RET.  If you wish,
  558.      you can edit the copy before resubmitting it.
  559.    Moving to a previous input and then copying it with `C-c RET'
  560. produces the same results--the same buffer contents--that you would get
  561. by using `M-p' enough times to fetch that previous input from the
  562. history list.  However, `C-c RET' copies the text from the buffer,
  563. which can be different from what is in the history list if you edit the
  564. input text in the buffer after it has been sent.
  565. File: emacs,  Node: History References,  Prev: Shell History Copying,  Up: Shell History
  566. Shell History References
  567. ........................
  568.    Various shells including csh and bash support "history references"
  569. that begin with `!' and `^'.  Shell mode can understand these
  570. constructs and perform the history substitution for you.  If you insert
  571. a history reference and type TAB, this searches the input history for a
  572. matching command, performs substitution if necessary, and places the
  573. result in the buffer in place of the history reference.  For example,
  574. you can fetch the most recent command beginning with `mv' with `! m v
  575. TAB'.  You can edit the command if you wish, and then resubmit the
  576. command to the shell by typing RET.
  577.    History references take effect only following a shell prompt.  The
  578. variable `shell-prompt-pattern' specifies how to recognize a shell
  579. prompt.  Comint modes in general use the variable
  580. `comint-prompt-regexp' to specify how to find a prompt; Shell mode uses
  581. `shell-prompt-pattern' to set up the local value of
  582. `comint-prompt-regexp'.
  583.    Shell mode can optionally expand history references in the buffer
  584. when you send them to the shell.  To request this, set the variable
  585. `comint-input-autoexpand' to `input'.
  586.    You can make SPC perform history expansion by binding SPC to the
  587. command `comint-magic-space'.
  588. File: emacs,  Node: Shell Options,  Next: Remote Host,  Prev: Shell History,  Up: Shell
  589. Shell Mode Options
  590. ------------------
  591.    If the variable `comint-scroll-to-bottom-on-input' is non-`nil',
  592. insertion and yank commands scroll the selected window to the bottom
  593. before inserting.
  594.    If `comint-scroll-show-maximum-output' is non-`nil', then scrolling
  595. due to arrival of output tries to place the last line of text at the
  596. bottom line of the window, so as to show as much useful text as
  597. possible.  (This mimics the scrolling behavior of many terminals.) The
  598. default is `nil'.
  599.    By setting `comint-scroll-to-bottom-on-output', you can opt for
  600. having point jump to the end of the buffer whenever output arrives--no
  601. matter where in the buffer point was before.  If the value is `this',
  602. point jumps in the selected window.  If the value is `all', point jumps
  603. in each window that shows the comint buffer.  If the value is `other',
  604. point jumps in all nonselected windows that show the current buffer.
  605. The default value is `nil', which means point does not jump to the end.
  606.    The variable `comint-input-ignoredups' controls whether successive
  607. identical inputs are stored in the input history.  A non-`nil' value
  608. means to omit an input that is the same as the previous input.  The
  609. default is `nil', which means to store each input even if it is equal
  610. to the previous input.
  611.    Three variables customize file name completion.  The variable
  612. `comint-completion-addsuffix' controls whether completion inserts a
  613. space or a slash to indicate a fully completed file or directory name
  614. (non-`nil' means do insert a space or slash).
  615. `comint-completion-recexact', if non-`nil', directs TAB to choose the
  616. shortest possible completion if the usual Emacs completion algorithm
  617. cannot add even a single character.  `comint-completion-autolist', if
  618. non-`nil', says to list all the possible completions whenever
  619. completion is not exact.
  620.    The command `comint-dynamic-complete-variable' does variable name
  621. completion using the environment variables as set within Emacs.  The
  622. variables controlling file name completion apply to variable name
  623. completion too.  This command is normally available through the menu
  624.    Command completion normally considers only executable files.  If you
  625. set `shell-command-execonly' to `nil', it considers nonexecutable files
  626. as well.
  627.    You can configure the behavior of `pushd'.  Variables control
  628. whether `pushd' behaves like `cd' if no argument is given
  629. (`shell-pushd-tohome'), pop rather than rotate with a numeric argument
  630. (`shell-pushd-dextract'), and only add directories to the directory
  631. stack if they are not already on it (`shell-pushd-dunique').  The
  632. values you choose should match the underlying shell, of course.
  633. File: emacs,  Node: Remote Host,  Prev: Shell Options,  Up: Shell
  634. Remote Host Shell
  635. -----------------
  636.    Emacs provides two commands for logging in to another computer and
  637. communicating with it through an Emacs buffer.
  638. `M-x telnet RET HOSTNAME RET'
  639.      Set up a Telnet connection to the computer named HOSTNAME.
  640. `M-x rlogin RET HOSTNAME RET'
  641.      Set up an Rlogin connection to the computer named HOSTNAME.
  642.    Use `M-x telnet' to set up a Telnet connection to another computer.
  643. (Telnet is the standard Internet protocol for remote login.) It reads
  644. the host name of the other computer as an argument with the minibuffer.
  645. Once the connection is established, talking to the other computer
  646. works like talking to a subshell: you can edit input with the usual
  647. Emacs commands, and send it a line at a time by typing RET.  The output
  648. is inserted in the Telnet buffer interspersed with the input.
  649.    Use `M-x rlogin' to set up an Rlogin connection.  Rlogin is another
  650. remote login communication protocol, essentially much like the Telnet
  651. protocol but incompatible with it, and supported only by certain
  652. systems.  Rlogin's advantages are that you can arrange not to have to
  653. give your user name and password when communicating between two machines
  654. you frequently use, and that you can make an 8-bit-clean connection.
  655. (To do that in Emacs, set `rlogin-explicit-args' to `("-8")' before you
  656. run Rlogin.)
  657.    `M-x rlogin' sets up the default file directory of the Emacs buffer
  658. to access the remote host via FTP (*note File Names::.), and it tracks
  659. the shell commands that change the current directory just like Shell
  660. mode.
  661.    There are two ways of doing directory tracking in an Rlogin
  662. buffer--either with remote directory names `/HOST:DIR/' or with local
  663. names (that works if the "remote" machine shares file systems with your
  664. machine of origin).  You can use the command
  665. `rlogin-directory-tracking-mode' to switch modes.  No argument means
  666. use remote directory names, a positive argument means use local names,
  667. and a negative argument means turn off directory tracking.
  668. File: emacs,  Node: Emacs Server,  Next: Hardcopy,  Prev: Shell,  Up: Top
  669. Using Emacs as a Server
  670. =======================
  671.    Various programs such as `mail' can invoke your choice of editor to
  672. edit a particular piece of text, such as a message that you are
  673. sending.  By convention, most of these programs use the environment
  674. variable `EDITOR' to specify which editor to run.  If you set `EDITOR'
  675. to `emacs', they invoke Emacs--but in an inconvenient fashion, by
  676. starting a new, separate Emacs process.  This is inconvenient because
  677. it takes time and because the new Emacs process doesn't share the
  678. buffers in the existing Emacs process.
  679.    You can arrange to use your existing Emacs process as the editor for
  680. programs like `mail' by using the Emacs client and Emacs server
  681. programs.  Here is how.
  682.    First, the preparation.  Within Emacs, call the function
  683. `server-start'.  (Your `.emacs' file can do this automatically if you
  684. add the expression `(server-start)' to it.)  Then, outside Emacs, set
  685. the `EDITOR' environment variable to `emacsclient'.  (Note that some
  686. programs use a different environment variable; for example, to make TeX
  687. use `emacsclient', you should set the `TEXEDIT' environment variable to
  688. `emacsclient +%d %s'.)
  689.    Then, whenever any program invokes your specified `EDITOR' program,
  690. the effect is to send a message to your principal Emacs telling it to
  691. visit a file.  (That's what the program `emacsclient' does.) Emacs
  692. displays the buffer immediately and you can immediately begin editing
  693.    When you've finished editing that buffer, type `C-x #'
  694. (`server-edit').  This saves the file and sends a message back to the
  695. `emacsclient' program telling it to exit.  The programs that use
  696. `EDITOR' wait for the "editor" (actually, `emacsclient') to exit.  `C-x
  697. #' also checks for other pending external requests to edit various
  698. files, and selects the next such file.
  699.    You can switch to a server buffer manually if you wish; you don't
  700. have to arrive at it with `C-x #'.  But `C-x #' is the only way to say
  701. that you are "finished" with one.
  702.    If you set the variable `server-window' to a window or a frame, `C-x
  703. #' displays the server buffer in that window or in that frame.
  704.    While `mail' or another application is waiting for `emacsclient' to
  705. finish, `emacsclient' does not read terminal input.  So the terminal
  706. that `mail' was using is effectively blocked for the duration.  In
  707. order to edit with your principal Emacs, you need to be able to use it
  708. without using that terminal.  There are two ways to do this:
  709.    * Using a window system, run `mail' and the principal Emacs in two
  710.      separate windows.  While `mail' is waiting for `emacsclient', the
  711.      window where it was running is blocked, but you can use Emacs by
  712.      switching windows.
  713.    * Use Shell mode in Emacs to run the other program such as `mail';
  714.      then, `emacsclient' blocks only the subshell under Emacs, and you
  715.      can still use Emacs to edit the file.
  716.    Some programs write temporary files for you to edit.  After you edit
  717. the temporary file, the program reads it back and deletes it.  If the
  718. Emacs server is later asked to edit the same file name, it should assume
  719. this has nothing to do with the previous occasion for that file name.
  720. The server accomplishes this by killing the temporary file's buffer when
  721. you finish with the file.  Use the variable `server-temp-file-regexp'
  722. to specify which files are temporary in this sense; its value should be
  723. a regular expression that matches file names that are temporary.
  724. File: emacs,  Node: Hardcopy,  Next: Postscript,  Prev: Emacs Server,  Up: Top
  725. Hardcopy Output
  726. ===============
  727.    The Emacs commands for making hardcopy let you print either an entire
  728. buffer or just part of one, either with or without page headers.  See
  729. also the hardcopy commands of Dired (*note Misc File Ops::.) and the
  730. diary (*note Diary Commands::.).
  731. `M-x print-buffer'
  732.      Print hardcopy of current buffer with page headings containing the
  733.      file name and page number.
  734. `M-x lpr-buffer'
  735.      Print hardcopy of current buffer without page headings.
  736. `M-x print-region'
  737.      Like `print-buffer' but print only the current region.
  738. `M-x lpr-region'
  739.      Like `lpr-buffer' but print only the current region.
  740.    The hardcopy commands (aside from the Postscript commands) pass extra
  741. switches to the `lpr' program based on the value of the variable
  742. `lpr-switches'.  Its value should be a list of strings, each string an
  743. option starting with `-'.  For example, to use a printer named
  744. `nearme', set `lpr-switches' like this:
  745.      (setq lpr-switches '("-Pnearme"))
  746.    The variable `lpr-command' specifies the name of the printer program
  747. to run; the default value depends on your operating system type.  On
  748. most systems, the default is `"lpr"'.  The variable
  749. `lpr-headers-switches' similarly specifies the extra switches to use to
  750. make page headers.  The variable `lpr-add-switches' controls whether to
  751. supply `-T' and `-J' options (suitable for `lpr') to the printer
  752. program: `nil' means don't add them.  `lpr-add-switches' should be
  753. `nil' if your printer program is not compatible with `lpr'.
  754. File: emacs,  Node: Postscript,  Next: Sorting,  Prev: Hardcopy,  Up: Top
  755. Postscript Hardcopy
  756. ===================
  757.    These commands convert buffer contents to Postscript, either
  758. printing it or leaving it in another Emacs buffer.
  759. `M-x ps-print-buffer'
  760.      Print hardcopy of the current buffer in Postscript form.
  761. `M-x ps-print-region'
  762.      Print hardcopy of the current region in Postscript form.
  763. `M-x ps-print-buffer-with-faces'
  764.      Print hardcopy of the current buffer in Postscript form, showing
  765.      the faces used in the text by means of Postscript features.
  766. `M-x ps-print-region-with-faces'
  767.      Print hardcopy of the current region in Postscript form, showing
  768.      the faces used in the text.
  769. `M-x ps-spool-buffer'
  770.      Generate Postscript for the current buffer text.
  771. `M-x ps-spool-region'
  772.      Generate Postscript for the current region.
  773. `M-x ps-spool-buffer-with-faces'
  774.      Generate Postscript for the current buffer, showing the faces used.
  775. `M-x ps-spool-region-with-faces'
  776.      Generate Postscript for the current region, showing the faces used.
  777.    The Postscript commands, `ps-print-buffer' and `ps-print-region',
  778. print buffer contents in Postscript form.  One command prints the
  779. entire buffer; the other, just the region.  The corresponding
  780. `-with-faces' commands, `ps-print-buffer-with-faces' and
  781. `ps-print-region-with-faces', use Postscript features to show the faces
  782. (fonts and colors) in the text properties of the text being printed.
  783.    If you are using a color display, you can print a buffer of program
  784. code with color highlighting by turning on Font-Lock mode in that
  785. buffer, and using `ps-print-buffer-with-faces'.
  786.    All four of the commands above use the variables `ps-lpr-command'
  787. and `ps-lpr-switches' to specify how to print the output.
  788. `ps-lpr-command' specifies the command name to run, and
  789. `ps-lpr-switches' specifies command line options to use.  If you don't
  790. set these variables yourself, they take their initial values from
  791. `lpr-command' and `lpr-switches'.
  792.    The variable `ps-print-header' controls whether these commands add
  793. header lines to each page--set it to `nil' to turn headers off.  You
  794. can turn off color processing by setting `ps-print-color-p' to `nil'.
  795. Many other customization variables for these commands are defined and
  796. described in the Lisp file `ps-print.el'.
  797.    The commands whose names have `spool' instead of `print' generate
  798. the Postscript output in an Emacs buffer instead of sending it to the
  799. printer.
  800.