summaryrefslogtreecommitdiff
path: root/Net/SSH/Connection/Term.html
blob: caee111b49d6bc3f8c8380b18d92ad8d85c87f71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>module Net::SSH::Connection::Term - net-ssh 6.0.0.beta1</title>

<script type="text/javascript">
  var rdoc_rel_prefix = "../../../";
  var index_rel_prefix = "../../../";
</script>

<script src="../../../js/jquery.js"></script>
<script src="../../../js/darkfish.js"></script>

<link href="../../../css/fonts.css" rel="stylesheet">
<link href="../../../css/rdoc.css" rel="stylesheet">



<body id="top" role="document" class="module">
<nav role="navigation">
  <div id="project-navigation">
    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2>
    <a href="../../../index.html" rel="home">Home</a>
  </h2>

  <div id="table-of-contents-navigation">
    <a href="../../../table_of_contents.html#pages">Pages</a>
    <a href="../../../table_of_contents.html#classes">Classes</a>
    <a href="../../../table_of_contents.html#methods">Methods</a>
  </div>
</div>

    <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

  </div>

  

  <div id="class-metadata">
    
    
    
    
    
  </div>
</nav>

<main role="main" aria-labelledby="module-Net::SSH::Connection::Term">
  <h1 id="module-Net::SSH::Connection::Term" class="module">
    module Net::SSH::Connection::Term
  </h1>

  <section class="description">
    
<p>These constants are used when requesting a pseudo-terminal (via <a
href="Channel.html#method-i-request_pty">Net::SSH::Connection::Channel#request_pty</a>).
The descriptions for each are taken directly from RFC 4254 (“The Secure
Shell (SSH) <a href="../Connection.html">Connection</a> Protocol”), <a
href="http://tools.ietf.org/html/rfc4254">tools.ietf.org/html/rfc4254</a>.</p>

  </section>

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    
    <section class="constants-list">
      <header>
        <h3>Constants</h3>
      </header>
      <dl>
      
        <dt id="CS7">CS7
        
        <dd><p>7 bit mode.</p>
        
      
        <dt id="CS8">CS8
        
        <dd><p>8 bit mode.</p>
        
      
        <dt id="ECHO">ECHO
        
        <dd><p>Enable echoing.</p>
        
      
        <dt id="ECHOCTL">ECHOCTL
        
        <dd><p>Echo control characters as ^(Char).</p>
        
      
        <dt id="ECHOE">ECHOE
        
        <dd><p>Visually erase chars.</p>
        
      
        <dt id="ECHOK">ECHOK
        
        <dd><p>Kill character discards current line.</p>
        
      
        <dt id="ECHOKE">ECHOKE
        
        <dd><p>Visual erase for line kill.</p>
        
      
        <dt id="ECHONL">ECHONL
        
        <dd><p>Echo NL even if <a href="Term.html#ECHO">ECHO</a> is off.</p>
        
      
        <dt id="ICANON">ICANON
        
        <dd><p>Canonicalize input lines.</p>
        
      
        <dt id="ICRNL">ICRNL
        
        <dd><p>Map CR to NL on input.</p>
        
      
        <dt id="IEXTEN">IEXTEN
        
        <dd><p>Enable extensions.</p>
        
      
        <dt id="IGNCR">IGNCR
        
        <dd><p>Ignore CR on input.</p>
        
      
        <dt id="IGNPAR">IGNPAR
        
        <dd><p>The ignore parity flag. The parameter SHOULD be 0 if this flag is FALSE,
and 1 if it is TRUE.</p>
        
      
        <dt id="IMAXBEL">IMAXBEL
        
        <dd><p>Ring bell on input queue full.</p>
        
      
        <dt id="INCLR">INCLR
        
        <dd><p>Map NL into CR on input.</p>
        
      
        <dt id="INPCK">INPCK
        
        <dd><p>Enable checking of parity errors.</p>
        
      
        <dt id="ISIG">ISIG
        
        <dd><p>Enable signals INTR, QUIT, [D]SUSP.</p>
        
      
        <dt id="ISTRIP">ISTRIP
        
        <dd><p>Strip 8th bit off characters.</p>
        
      
        <dt id="IUCLC">IUCLC
        
        <dd><p>Translate uppercase characters to lowercase.</p>
        
      
        <dt id="IXANY">IXANY
        
        <dd><p>Any char will restart after stop.</p>
        
      
        <dt id="IXOFF">IXOFF
        
        <dd><p>Enable input flow control.</p>
        
      
        <dt id="IXON">IXON
        
        <dd><p>Enable output flow control.</p>
        
      
        <dt id="NOFLSH">NOFLSH
        
        <dd><p>Don&#39;t flush after interrupt.</p>
        
      
        <dt id="OCRNL">OCRNL
        
        <dd><p>Translate carriage return to newline (output).</p>
        
      
        <dt id="OLCUC">OLCUC
        
        <dd><p>Convert lowercase to uppercase.</p>
        
      
        <dt id="ONLCR">ONLCR
        
        <dd><p>Map NL to CR-NL.</p>
        
      
        <dt id="ONLRET">ONLRET
        
        <dd><p>Newline performs a carriage return (output).</p>
        
      
        <dt id="ONOCR">ONOCR
        
        <dd><p>Translate newline to carriage return-newline (output).</p>
        
      
        <dt id="OPOST">OPOST
        
        <dd><p>Enable output processing.</p>
        
      
        <dt id="PARENB">PARENB
        
        <dd><p>Parity enable.</p>
        
      
        <dt id="PARMRK">PARMRK
        
        <dd><p>Mark parity and framing errors.</p>
        
      
        <dt id="PARODD">PARODD
        
        <dd><p>Odd parity, else even.</p>
        
      
        <dt id="PENDIN">PENDIN
        
        <dd><p>Retype pending input.</p>
        
      
        <dt id="TOSTOP">TOSTOP
        
        <dd><p>Stop background jobs from output.</p>
        
      
        <dt id="TTY_OP_ISPEED">TTY_OP_ISPEED
        
        <dd><p>Specifies the input baud rate in bits per second.</p>
        
      
        <dt id="TTY_OP_OSPEED">TTY_OP_OSPEED
        
        <dd><p>Specifies the output baud rate in bits per second.</p>
        
      
        <dt id="VDISCARD">VDISCARD
        
        <dd><p>Toggles the flushing of terminal output.</p>
        
      
        <dt id="VDSUSP">VDSUSP
        
        <dd><p>Another suspend character.</p>
        
      
        <dt id="VEOF">VEOF
        
        <dd><p>End-of-file character (sends EOF from the terminal).</p>
        
      
        <dt id="VEOL">VEOL
        
        <dd><p>End-of-line character in addition to carriage return and/or linefeed.</p>
        
      
        <dt id="VEOL2">VEOL2
        
        <dd><p>Additional end-of-line character.</p>
        
      
        <dt id="VERASE">VERASE
        
        <dd><p>Erase the character to left of the cursor.</p>
        
      
        <dt id="VFLUSH">VFLUSH
        
        <dd><p>Character to flush output.</p>
        
      
        <dt id="VINTR">VINTR
        
        <dd><p>Interrupt character; 255 if none. Similarly for the other characters. Not
all of these characters are supported on all systems.</p>
        
      
        <dt id="VKILL">VKILL
        
        <dd><p>Kill the current input line.</p>
        
      
        <dt id="VLNEXT">VLNEXT
        
        <dd><p>Enter the next character typed literally, even if it is a special
character.</p>
        
      
        <dt id="VQUIT">VQUIT
        
        <dd><p>The quit character (sends SIGQUIT signal on POSIX systems).</p>
        
      
        <dt id="VREPRINT">VREPRINT
        
        <dd><p>Reprints the current input line.</p>
        
      
        <dt id="VSTART">VSTART
        
        <dd><p>Continues paused output (normally control-Q).</p>
        
      
        <dt id="VSTATUS">VSTATUS
        
        <dd><p>Prints system status line (load, command, pid, etc).</p>
        
      
        <dt id="VSTOP">VSTOP
        
        <dd><p>Pauses output (normally control-S).</p>
        
      
        <dt id="VSUSP">VSUSP
        
        <dd><p>Suspends the current program.</p>
        
      
        <dt id="VSWITCH">VSWITCH
        
        <dd><p>Switch to a different shell layer.</p>
        
      
        <dt id="VWERASE">VWERASE
        
        <dd><p>Erases a word left of cursor.</p>
        
      
        <dt id="XCASE">XCASE
        
        <dd><p>Enable input and output of uppercase characters by preceding their
lowercase equivalents with “&quot;.</p>
        
      
      </dl>
    </section>
    

    

    
  </section>
</main>


<footer id="validator-badges" role="contentinfo">
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.0.0.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>