Commit | Line | Data |
---|---|---|
15637ed4 RG |
1 | .\" Copyright (c) 1983, 1991 The Regents of the University of California. |
2 | .\" All rights reserved. | |
3 | .\" | |
4 | .\" Redistribution and use in source and binary forms, with or without | |
5 | .\" modification, are permitted provided that the following conditions | |
6 | .\" are met: | |
7 | .\" 1. Redistributions of source code must retain the above copyright | |
8 | .\" notice, this list of conditions and the following disclaimer. | |
9 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
10 | .\" notice, this list of conditions and the following disclaimer in the | |
11 | .\" documentation and/or other materials provided with the distribution. | |
12 | .\" 3. All advertising materials mentioning features or use of this software | |
13 | .\" must display the following acknowledgement: | |
14 | .\" This product includes software developed by the University of | |
15 | .\" California, Berkeley and its contributors. | |
16 | .\" 4. Neither the name of the University nor the names of its contributors | |
17 | .\" may be used to endorse or promote products derived from this software | |
18 | .\" without specific prior written permission. | |
19 | .\" | |
20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
30 | .\" SUCH DAMAGE. | |
31 | .\" | |
32 | .\" @(#)gettytab.5 6.7 (Berkeley) 5/10/91 | |
33 | .\" | |
34 | .Dd May 10, 1991 | |
35 | .Dt GETTYTAB 5 | |
36 | .Os BSD 4.2 | |
37 | .Sh NAME | |
38 | .Nm gettytab | |
39 | .Nd terminal configuration data base | |
40 | .Sh SYNOPSIS | |
41 | .Nm gettytab | |
42 | .Sh DESCRIPTION | |
43 | The | |
44 | .Nm gettytab | |
45 | file | |
46 | is a simplified version of the | |
47 | .Xr termcap 5 | |
48 | data base | |
49 | used to describe terminal lines. | |
50 | The initial terminal login process | |
51 | .Xr getty 8 | |
52 | accesses the | |
53 | .Nm gettytab | |
54 | file each time it starts, allowing simpler | |
55 | reconfiguration of terminal characteristics. | |
56 | Each entry in the data base | |
57 | is used to describe one class of terminals. | |
58 | .Pp | |
59 | There is a default terminal class, | |
60 | .Em default , | |
61 | that is used to set global defaults for all other classes. | |
62 | (That is, the | |
63 | .Em default | |
64 | entry is read, then the entry for the class required | |
65 | is used to override particular settings.) | |
66 | .Sh CAPABILITIES | |
67 | Refer to | |
68 | .Xr termcap 5 | |
69 | for a description of the file layout. | |
70 | The | |
71 | .Em default | |
72 | column below lists defaults obtained if there is | |
73 | no entry in the table obtained, nor one in the special | |
74 | .Em default | |
75 | table. | |
76 | .Bl -column Namexx /usr/bin/login Default | |
77 | .It Sy Name Type Default Description | |
78 | .It "ap bool false terminal uses any parity" | |
79 | .It "bd num 0 backspace delay" | |
80 | .It "bk str 0377 alternate end of line character (input break)" | |
81 | .It "cb bool false use crt backspace mode" | |
82 | .It "cd num 0 carriage-return delay" | |
83 | .It "ce bool false use crt erase algorithm" | |
84 | .It "ck bool false use crt kill algorithm" | |
85 | .It "cl str" Ta Dv NULL Ta | |
86 | .No "screen clear sequence" | |
87 | .It "co bool false console - add" | |
88 | .Ql \en | |
89 | after login prompt | |
90 | .It "ds str" Ta So Li ^Y Sc Ta | |
91 | .No "delayed suspend character" | |
92 | .It "dx bool false set" | |
93 | .Dv DECCTLQ | |
94 | .It "ec bool false leave echo" | |
95 | .Tn OFF | |
96 | .It "ep bool false terminal uses even parity" | |
97 | .It "er str" Ta So Li ^? Sc Ta | |
98 | .No "erase character" | |
99 | .It "et str" Ta So Li ^D Sc Ta | |
100 | .No "end of text" | |
101 | .Pq Dv EOF | |
102 | character | |
103 | .It "ev str" Ta Dv NULL Ta | |
104 | .No "initial enviroment" | |
105 | .It "f0 num unused tty mode flags to write messages" | |
106 | .It "f1 num unused tty mode flags to read login name" | |
107 | .It "f2 num unused tty mode flags to leave terminal as" | |
108 | .It "fd num 0 form-feed (vertical motion) delay" | |
109 | .It "fl str" Ta So Li ^O Sc Ta | |
110 | .No "output flush character" | |
111 | .It "hc bool false do" | |
112 | .Tn NOT | |
113 | hangup line on last close | |
114 | .It "he str" Ta Dv NULL Ta | |
115 | .No "hostname editing string" | |
116 | .It "hn str hostname hostname" | |
117 | .It "ht bool false terminal has real tabs" | |
118 | .It "ig bool false ignore garbage characters in login name" | |
119 | .It "im str" Ta Dv NULL Ta | |
120 | .No "initial (banner) message" | |
121 | .It "in str" Ta So Li ^C Sc Ta | |
122 | .No "interrupt character" | |
123 | .It "is num unused input speed" | |
124 | .It "kl str" Ta So Li ^U Sc Ta | |
125 | .No "kill character" | |
126 | .It "lc bool false terminal has lower case" | |
127 | .It "lm str login: login prompt" | |
128 | .It "ln str" Ta So Li ^V Sc Ta | |
129 | .No "``literal next'' character" | |
130 | .It "lo str" Ta Pa /usr/bin/login Ta | |
131 | .No "program to exec when name obtained" | |
132 | .It "nd num 0 newline (line-feed) delay" | |
133 | .It "nl bool false terminal has (or might have) a newline character" | |
134 | .It "nx str default next table (for auto speed selection)" | |
135 | .It "op bool false terminal uses odd parity" | |
136 | .It "os num unused output speed" | |
137 | .It "pc str" Ta So Li \e0 Sc Ta | |
138 | .No "pad character" | |
139 | .It "pe bool false use printer (hard copy) erase algorithm" | |
140 | .It "pf num 0 delay" | |
141 | between first prompt and following flush (seconds) | |
142 | .It "ps bool false line connected to a" | |
143 | .Tn MICOM | |
144 | port selector | |
145 | .It "qu str" Ta So Li \&^\e Sc Ta | |
146 | .No "quit character" | |
147 | .It "rp str" Ta So Li ^R Sc Ta | |
148 | .No "line retype character" | |
149 | .It "rw bool false do" | |
150 | .Tn NOT | |
151 | use raw for input, use cbreak | |
152 | .It "sp num unused line speed (input and output)" | |
153 | .It "su str" Ta So Li ^Z Sc Ta | |
154 | .No "suspend character" | |
155 | .It "tc str none table continuation" | |
156 | .It "to num 0 timeout (seconds)" | |
157 | .It "tt str" Ta Dv NULL Ta | |
158 | .No "terminal type (for environment)" | |
159 | .It "ub bool false do unbuffered output (of prompts etc)" | |
160 | .It "uc bool false terminal is known upper case only" | |
161 | .It "we str" Ta So Li ^W Sc Ta | |
162 | .No "word erase character" | |
163 | .It "xc bool false do | |
164 | .Tn NOT | |
165 | echo control chars as | |
166 | .Ql ^X | |
167 | .It "xf str" Ta So Li ^S Sc Ta Dv XOFF | |
168 | (stop output) character | |
169 | .It "xn str" Ta So Li ^Q Sc Ta Dv XON | |
170 | (start output) character | |
171 | .El | |
172 | .Pp | |
173 | If no line speed is specified, speed will not be altered | |
174 | from that which prevails when getty is entered. | |
175 | Specifying an input or output speed will override | |
176 | line speed for stated direction only. | |
177 | .Pp | |
178 | Terminal modes to be used for the output of the message, | |
179 | for input of the login name, | |
180 | and to leave the terminal set as upon completion, | |
181 | are derived from the boolean flags specified. | |
182 | If the derivation should prove inadequate, | |
183 | any (or all) of these three may be overriden | |
184 | with one of the | |
185 | .Em \&f0 , | |
186 | .Em \&f1 , | |
187 | or | |
188 | .Em \&f2 | |
189 | numeric specifications, which can be used to specify | |
190 | (usually in octal, with a leading '0') | |
191 | the exact values of the flags. | |
192 | Local (new tty) flags are set in the top 16 bits | |
193 | of this (32 bit) value. | |
194 | .Pp | |
195 | Should | |
196 | .Xr getty | |
197 | receive a null character | |
198 | (presumed to indicate a line break) | |
199 | it will restart using the table indicated by the | |
200 | .Em nx | |
201 | entry. If there is none, it will re-use its original table. | |
202 | .Pp | |
203 | Delays are specified in milliseconds, the nearest possible | |
204 | delay available in the tty driver will be used. | |
205 | Should greater certainty be desired, delays | |
206 | with values 0, 1, 2, and 3 are interpreted as | |
207 | choosing that particular delay algorithm from the driver. | |
208 | .Pp | |
209 | The | |
210 | .Em \&cl | |
211 | screen clear string may be preceded by a (decimal) number | |
212 | of milliseconds of delay required (a la termcap). | |
213 | This delay is simulated by repeated use of the pad character | |
214 | .Em \&pc . | |
215 | .Pp | |
216 | The initial message, and login message, | |
217 | .Em \&im | |
218 | and | |
219 | .Em \&lm | |
220 | may include the character sequence | |
221 | .Em \&%h | |
222 | or | |
223 | .Em \&%t | |
224 | to obtain | |
225 | the hostname or tty name respectively. | |
226 | .Pf ( Em %% | |
227 | obtains a single '%' character.) | |
228 | The hostname is normally obtained from the system, | |
229 | but may be set by the | |
230 | .Em \&hn | |
231 | table entry. | |
232 | In either case it may be edited with | |
233 | .Em \&he . | |
234 | The | |
235 | .Em \&he | |
236 | string is a sequence of characters, each character that | |
237 | is neither '@' nor '#' is copied into the final hostname. | |
238 | A '@' in the | |
239 | .Em \&he | |
240 | string, causes one character from the real hostname to | |
241 | be copied to the final hostname. | |
242 | A '#' in the | |
243 | .Em \&he | |
244 | string, causes the next character of the real hostname | |
245 | to be skipped. | |
246 | Surplus '@' and '#' characters are ignored. | |
247 | .Pp | |
248 | When getty execs the login process, given | |
249 | in the | |
250 | .Em \&lo | |
251 | string (usually | |
252 | .Dq Pa /usr/bin/login ) , | |
253 | it will have set | |
254 | the enviroment to include the terminal type, as indicated | |
255 | by the | |
256 | .Em \&tt | |
257 | string (if it exists). | |
258 | The | |
259 | .Em \&ev | |
260 | string, can be used to enter additional data into | |
261 | the environment. | |
262 | It is a list of comma separated strings, each of which | |
263 | will presumably be of the form | |
264 | .Em name=value . | |
265 | .Pp | |
266 | If a non-zero timeout is specified, with | |
267 | .Em \&to , | |
268 | then getty will exit within the indicated | |
269 | number of seconds, either having | |
270 | received a login name and passed control | |
271 | to | |
272 | .Xr login , | |
273 | or having received an alarm signal, and exited. | |
274 | This may be useful to hangup dial in lines. | |
275 | .Pp | |
276 | Output from | |
277 | .Xr getty | |
278 | is even parity unless | |
279 | .Em \&op | |
280 | is specified. | |
281 | The | |
282 | .Em \&op | |
283 | string | |
284 | may be specified with | |
285 | .Em \&ap | |
286 | to allow any parity on input, but generate odd parity output. | |
287 | Note: this only applies while getty is being run, | |
288 | terminal driver limitations prevent a more complete | |
289 | implementation. | |
290 | .Xr Getty | |
291 | does not check parity of input characters in | |
292 | .Dv RAW | |
293 | mode. | |
294 | .Sh SEE ALSO | |
295 | .Xr login 1 , | |
296 | .Xr termcap 5 , | |
297 | .Xr getty 8 . | |
298 | .Sh BUGS | |
299 | The special characters (erase, kill, etc.) are reset to system defaults | |
300 | by | |
301 | .Xr login 1 . | |
302 | In | |
303 | .Em all | |
304 | cases, '#' or '^H' typed in a login name will be treated as | |
305 | an erase character, and '@' will be treated as a kill character. | |
306 | .Pp | |
307 | The delay stuff is a real crock. | |
308 | Apart form its general lack of flexibility, some | |
309 | of the delay algorithms are not implemented. | |
310 | The terminal driver should support sane delay settings. | |
311 | .Pp | |
312 | The | |
313 | .Em \&he | |
314 | capability is stupid. | |
315 | .Pp | |
316 | The | |
317 | .Xr termcap | |
318 | format is horrid, something more rational should | |
319 | have been chosen. | |
320 | .Sh HISTORY | |
321 | The | |
322 | .Nm gettytab | |
323 | file format appeared in 4.2BSD. |