← Back to branch summary

~ubuntu-branches/ubuntu/edgy/ess/edgy

« back to all changes in this revision

Viewing changes to doc/html/ess_8.html

  • Committer: Bazaar Package Importer
  • Author(s): Camm Maguire
  • Date: 2004-11-11 00:51:43 UTC
  • mfrom: (1.1.2 upstream)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20041111005143-wv1cih1h04xyrxrb
Tags: 5.2.3-3
* repair broken replace-regexp-in-string -> ess-replace-regexp-in-string
  patch
* expand autoload functionality in emacsen-startup

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/ess_8.html
1
 
<HTML>
2
 
<HEAD>
3
 
<!-- Created by texi2html 1.56k from ess.texi on 6 August 2002 -->
4
 
 
5
 
<TITLE>ESS -- Emacs Speaks Statistics - Reading help files in ESS</TITLE>
6
 
</HEAD>
7
 
<BODY>
8
 
Go to the <A HREF="ess_1.html">first</A>, <A HREF="ess_7.html">previous</A>, <A HREF="ess_9.html">next</A>, <A HREF="ess_16.html">last</A> section, <A HREF="ess_toc.html">table of contents</A>.
9
 
<P><HR><P>
10
 
 
11
 
 
12
 
<H1><A NAME="SEC58" HREF="ess_toc.html#TOC58">Reading help files in ESS</A></H1>
13
 
<P>
14
 
<A NAME="IDX194"></A>
15
 
 
16
 
 
17
 
<P>
18
 
ESS provides an easy-to-use facility for reading <B>S</B> help files from
19
 
within Emacs.  From within the <B>ESS</B> process buffer or any ESS edit
20
 
buffer, typing <KBD>C-c C-v</KBD> (<CODE>ess-display-help-on-object</CODE>)
21
 
<A NAME="IDX195"></A>
22
 
will prompt you for the name of an object for which you would like
23
 
documentation.  Completion is provided over all objects which have help
24
 
files.
25
 
 
26
 
 
27
 
<P>
28
 
If the requested object has documentation, you will be popped into a
29
 
buffer (named <CODE>*help(<VAR>obj-name</VAR>)*</CODE>) containing the help file.
30
 
This buffer is placed in a special `S Help' mode which disables the
31
 
usual editing commands but which provides a number of keys for paging
32
 
through the help file:
33
 
 
34
 
 
35
 
 
36
 
<UL>
37
 
Help commands:
38
 
 
39
 
<LI>
40
 
 
41
 
<KBD>?</KBD> (<CODE>ess-describe-help-mode</CODE>) <BR>
42
 
<A NAME="IDX196"></A>
43
 
Pops up a help buffer with a list of the commands available in <B>S</B> help
44
 
mode.
45
 
 
46
 
<LI>
47
 
 
48
 
<KBD>h</KBD> (<CODE>ess-display-help-on-object</CODE>) <BR>
49
 
<A NAME="IDX197"></A>
50
 
Pop up a help buffer for a different object
51
 
 
52
 
Paging commands:
53
 
 
54
 
<A NAME="IDX198"></A>
55
 
<LI>
56
 
 
57
 
<KBD>b</KBD> or <KBD>DEL</KBD> (<CODE>scroll-down</CODE>) <BR>
58
 
Move one page backwards through the help file.
59
 
 
60
 
<LI>
61
 
 
62
 
<KBD>SPC</KBD> (<CODE>scroll-up</CODE>) <BR>
63
 
Move one page forwards through the help file.
64
 
 
65
 
<LI>
66
 
 
67
 
<KBD>&#62;</KBD> (<CODE>beginning-of-buffer</CODE>) and <KBD>&#60;</KBD> (<CODE>end-of-buffer</CODE>)
68
 
<BR>
69
 
Move to the beginning and end of the help file, respectively.
70
 
 
71
 
Section-based motion commands:
72
 
 
73
 
<LI>
74
 
 
75
 
<KBD>n</KBD> (<CODE>ess-skip-to-next-section</CODE>) and <KBD>p</KBD>
76
 
(<CODE>ess-skip-to-previous-section</CODE>) <BR> Move to the next and previous
77
 
<A NAME="IDX199"></A>
78
 
<A NAME="IDX200"></A>
79
 
section header in the help file, respectively.  A section header
80
 
consists of a number of capitalized words, followed by a colon.
81
 
 
82
 
In addition, the <KBD>s</KBD> key followed by one of the following letters
83
 
will jump to a particular section in the help file:
84
 
<A NAME="IDX201"></A>
85
 
<DL COMPACT>
86
 
 
87
 
<DT><SAMP>`a'</SAMP>
88
 
<DD>
89
 
ARGUMENTS:
90
 
 
91
 
<DT><SAMP>`b'</SAMP>
92
 
<DD>
93
 
BACKGROUND:
94
 
 
95
 
<DT><SAMP>`B'</SAMP>
96
 
<DD>
97
 
BUGS:
98
 
 
99
 
<DT><SAMP>`d'</SAMP>
100
 
<DD>
101
 
DETAILS:
102
 
 
103
 
<DT><SAMP>`D'</SAMP>
104
 
<DD>
105
 
DESCRIPTION:
106
 
 
107
 
<DT><SAMP>`e'</SAMP>
108
 
<DD>
109
 
EXAMPLES:
110
 
 
111
 
<DT><SAMP>`n'</SAMP>
112
 
<DD>
113
 
NOTE:
114
 
 
115
 
<DT><SAMP>`o'</SAMP>
116
 
<DD>
117
 
OPTIONAL ARGUMENTS:
118
 
 
119
 
<DT><SAMP>`r'</SAMP>
120
 
<DD>
121
 
REQUIRED ARGUMENTS:
122
 
 
123
 
<DT><SAMP>`R'</SAMP>
124
 
<DD>
125
 
REFERENCES:
126
 
 
127
 
<DT><SAMP>`s'</SAMP>
128
 
<DD>
129
 
SIDE EFFECTS:
130
 
 
131
 
<DT><SAMP>`s'</SAMP>
132
 
<DD>
133
 
SEE ALSO:
134
 
 
135
 
<DT><SAMP>`u'</SAMP>
136
 
<DD>
137
 
USAGE:
138
 
 
139
 
<DT><SAMP>`v'</SAMP>
140
 
<DD>
141
 
VALUE:
142
 
 
143
 
<DT><SAMP>`&#60;'</SAMP>
144
 
<DD>
145
 
Jumps to beginning of file
146
 
 
147
 
<DT><SAMP>`&#62;'</SAMP>
148
 
<DD>
149
 
Jumps to end of file
150
 
 
151
 
<DT><SAMP>`?'</SAMP>
152
 
<DD>
153
 
Pops up a help buffer with a list of the defined section motion keys.
154
 
</DL>
155
 
 
156
 
Miscellaneous:
157
 
 
158
 
<LI>
159
 
 
160
 
<KBD>r</KBD> (<CODE>ess-eval-region</CODE>) <BR>
161
 
<A NAME="IDX202"></A>
162
 
Send the contents of the current region to the <B>ESS</B> process.  Useful
163
 
for running examples in help files.
164
 
 
165
 
<LI>
166
 
 
167
 
<KBD>/</KBD> (<CODE>isearch-forward</CODE>) <BR>
168
 
Same as <KBD>C-s</KBD>.
169
 
 
170
 
Quit commands:
171
 
 
172
 
<LI>
173
 
 
174
 
<KBD>q</KBD> (<CODE>ess-switch-to-end-of-ESS</CODE>) <BR>
175
 
<A NAME="IDX203"></A>
176
 
Returns to the <B>ESS</B> process buffer in another window, leaving the
177
 
help window visible.
178
 
 
179
 
<LI>
180
 
 
181
 
<KBD>k</KBD> (<CODE>kill-buffer</CODE>) <BR>
182
 
Kills the help buffer.
183
 
 
184
 
<LI>
185
 
 
186
 
<KBD>x</KBD> (<CODE>ess-kill-buffer-and-go</CODE>) <BR>
187
 
Return to the <B>ESS</B> process, killing this help buffer.
188
 
</UL>
189
 
 
190
 
<P>
191
 
In addition, all of the ESS commands available in the edit buffers are
192
 
also available in <B>S</B> help mode (see section <A HREF="ess_7.html#SEC50">Creating or modifying <B>S</B> objects</A>).  Of course, the
193
 
usual (non-editing) Emacs commands are available, and for convenience
194
 
the digits and <KBD>-</KBD> act as prefix arguments.
195
 
 
196
 
 
197
 
<P>
198
 
If a help buffer already exists for an object for which help is
199
 
requested, that buffer is popped to immediately; the <B>ESS</B> process is
200
 
not consulted at all.  If the contents of the help file have changed,
201
 
you either need to kill the help buffer first, or pass a prefix argument
202
 
(with <KBD>C-u</KBD>) to <CODE>ess-display-help-on-object</CODE>.
203
 
 
204
 
 
205
 
<P>
206
 
Help buffers are marked as temporary buffers in ESS, and are deleted
207
 
when <CODE>ess-quit</CODE> or <CODE>ess-cleanup</CODE> are called.
208
 
<A NAME="IDX204"></A>
209
 
<A NAME="IDX205"></A>
210
 
<A NAME="IDX206"></A>
211
 
 
212
 
 
213
 
<P><HR><P>
214
 
Go to the <A HREF="ess_1.html">first</A>, <A HREF="ess_7.html">previous</A>, <A HREF="ess_9.html">next</A>, <A HREF="ess_16.html">last</A> section, <A HREF="ess_toc.html">table of contents</A>.
215
 
</BODY>
216
 
</HTML>